docs: Content SEO updates (#2990)

* update yaml frontmatter format * update abstract document * update abstract factory * use the new pattern template * acyclic visitor seo * adapter seo * ambassador seo * acl seo * aaa seo * async method invocation seo * balking seo * bridge seo * builder seo * business delegate and bytecode seo * caching seo * callback seo * chain seo * update headings * circuit breaker seo * client session + collecting parameter seo * collection pipeline seo * combinator SEO * command seo * cqrs seo * commander seo * component seo * composite seo * composite entity seo * composite view seo * context object seo * converter seo * crtp seo * currying seo * dao seo * data bus seo * data locality seo * data mapper seo * dto seo * decorator seo * delegation seo * di seo * dirty flag seo * domain model seo * double buffer seo * double checked locking seo * double dispatch seo * dynamic proxy seo * event aggregator seo * event-based asynchronous seo * eda seo * event queue seo * event sourcing seo * execute around seo * extension objects seo * facade seo * factory seo * factory kit seo * factory method seo * fanout/fanin seo * feature toggle seo * filterer seo * fluent interface seo * flux seo * flyweight seo * front controller seo * function composition seo * game loop seo * gateway seo * guarded suspension seo * half-sync/half-async seo * health check seo * hexagonal seo * identity map seo * intercepting filter seo * interpreter seo * iterator seo * layers seo * lazy loading seo * leader election seo * leader/followers seo * lockable object seo * rename and add seo for marker interface * master-worker seo * mediator seo * memento seo * metadata mapping seo * microservice aggregator seo * api gw seo * microservices log aggregration seo * mvc seo * mvi seo * mvp seo * mvvm seo * monad seo * monitor seo * monostate seo * multiton seo * mute idiom seo * naked objects & notification seo * null object seo * object mother seo * object pool seo * observer seo * optimistic locking seo * page controller seo * page object seo * parameter object seo * partial response seo * pipeline seo * poison pill seo * presentation model seo * private class data seo * producer-consumer seo * promise seo * property seo * prototype seo * proxy seo * queue-based load leveling seo * reactor seo * registry seo * repository seo * RAII seo * retry seo * role object seo * saga seo * separated interface seo * serialized entity seo * serialized lob seo * servant seo * server session seo * service layer seo * service locator seo * service to worker seo * sharding seo * single table inheritance seo * singleton seo * spatial partition seo * special case seo * specification seo * state seo * step builder seo * strangler seo * strategy seo * subclass sandbox seo * table module seo * template method seo * throttling seo * tolerant reader seo * trampoline seo * transaction script seo * twin seo * type object seo * unit of work seo * update method seo * value object seo * version number seo * virtual proxy seo * visitor seo * seo enhancements * seo improvements * SEO enhancements * SEO improvements * SEO additions * SEO improvements * more SEO improvements * rename hexagonal + SEO improvements * SEO improvements * more SEO stuff * SEO improvements * SEO optimizations * SEO enhancements * enchance SEO * improve SEO * SEO improvements * update headers
2026-05-19 07:26:31 +00:00 · 2024-06-08 19:54:44 +03:00
parent cb946c0cdc
commit 6cd2d0353a
219 changed files with 3308 additions and 2819 deletions
@@ -0,0 +1,70 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.Set;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Unit tests for {@link LotteryNumbers}
+ */
+class LotteryNumbersTest {
+
+  @Test
+  void testGivenNumbers() {
+    var numbers = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    assertEquals(numbers.getNumbers().size(), 4);
+    assertTrue(numbers.getNumbers().contains(1));
+    assertTrue(numbers.getNumbers().contains(2));
+    assertTrue(numbers.getNumbers().contains(3));
+    assertTrue(numbers.getNumbers().contains(4));
+  }
+
+  @Test
+  void testNumbersCantBeModified() {
+    var numbers = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    assertThrows(UnsupportedOperationException.class, () -> numbers.getNumbers().add(5));
+  }
+
+  @Test
+  void testRandomNumbers() {
+    var numbers = LotteryNumbers.createRandom();
+    assertEquals(numbers.getNumbers().size(), LotteryNumbers.NUM_NUMBERS);
+  }
+
+  @Test
+  void testEquals() {
+    var numbers1 = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    var numbers2 = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    assertEquals(numbers1, numbers2);
+    var numbers3 = LotteryNumbers.create(Set.of(11, 12, 13, 14));
+    assertNotEquals(numbers1, numbers3);
+  }
+}
@@ -0,0 +1,110 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import com.google.inject.Guice;
+import com.google.inject.Inject;
+import com.google.inject.Injector;
+import com.iluwatar.hexagonal.banking.WireTransfers;
+import com.iluwatar.hexagonal.domain.LotteryTicketCheckResult.CheckResult;
+import com.iluwatar.hexagonal.module.LotteryTestingModule;
+import com.iluwatar.hexagonal.test.LotteryTestUtils;
+import java.util.Set;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test the lottery system
+ */
+class LotteryTest {
+
+  private final Injector injector;
+  @Inject
+  private LotteryAdministration administration;
+  @Inject
+  private LotteryService service;
+  @Inject
+  private WireTransfers wireTransfers;
+
+  LotteryTest() {
+    this.injector = Guice.createInjector(new LotteryTestingModule());
+  }
+
+  @BeforeEach
+  void setup() {
+    injector.injectMembers(this);
+    // add funds to the test player's bank account
+    wireTransfers.setFunds("123-12312", 100);
+  }
+
+  @Test
+  void testLottery() {
+    // admin resets the lottery
+    administration.resetLottery();
+    assertEquals(0, administration.getAllSubmittedTickets().size());
+
+    // players submit the lottery tickets
+    var ticket1 = service.submitTicket(LotteryTestUtils.createLotteryTicket("cvt@bbb.com",
+        "123-12312", "+32425255", Set.of(1, 2, 3, 4)));
+    assertTrue(ticket1.isPresent());
+    var ticket2 = service.submitTicket(LotteryTestUtils.createLotteryTicket("ant@bac.com",
+        "123-12312", "+32423455", Set.of(11, 12, 13, 14)));
+    assertTrue(ticket2.isPresent());
+    var ticket3 = service.submitTicket(LotteryTestUtils.createLotteryTicket("arg@boo.com",
+        "123-12312", "+32421255", Set.of(6, 8, 13, 19)));
+    assertTrue(ticket3.isPresent());
+    assertEquals(3, administration.getAllSubmittedTickets().size());
+
+    // perform lottery
+    var winningNumbers = administration.performLottery();
+
+    // cheat a bit for testing sake, use winning numbers to submit another ticket
+    var ticket4 = service.submitTicket(LotteryTestUtils.createLotteryTicket("lucky@orb.com",
+        "123-12312", "+12421255", winningNumbers.getNumbers()));
+    assertTrue(ticket4.isPresent());
+    assertEquals(4, administration.getAllSubmittedTickets().size());
+
+    // check winners
+    var tickets = administration.getAllSubmittedTickets();
+    for (var id : tickets.keySet()) {
+      var checkResult = service.checkTicketForPrize(id, winningNumbers);
+      assertNotEquals(CheckResult.TICKET_NOT_SUBMITTED, checkResult.getResult());
+      if (checkResult.getResult().equals(CheckResult.WIN_PRIZE)) {
+        assertTrue(checkResult.getPrizeAmount() > 0);
+      } else {
+        assertEquals(0, checkResult.getPrizeAmount());
+      }
+    }
+
+    // check another ticket that has not been submitted
+    var checkResult = service.checkTicketForPrize(new LotteryTicketId(), winningNumbers);
+    assertEquals(CheckResult.TICKET_NOT_SUBMITTED, checkResult.getResult());
+    assertEquals(0, checkResult.getPrizeAmount());
+  }
+}
@@ -0,0 +1,46 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import com.iluwatar.hexagonal.domain.LotteryTicketCheckResult.CheckResult;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Unit tests for {@link LotteryTicketCheckResult}
+ */
+class LotteryTicketCheckResultTest {
+
+  @Test
+  void testEquals() {
+    var result1 = new LotteryTicketCheckResult(CheckResult.NO_PRIZE);
+    var result2 = new LotteryTicketCheckResult(CheckResult.NO_PRIZE);
+    assertEquals(result1, result2);
+    var result3 = new LotteryTicketCheckResult(CheckResult.WIN_PRIZE, 300000);
+    assertNotEquals(result1, result3);
+  }
+}
@@ -0,0 +1,47 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests for lottery ticket id
+ */
+class LotteryTicketIdTest {
+
+  @Test
+  void testEquals() {
+    var ticketId1 = new LotteryTicketId();
+    var ticketId2 = new LotteryTicketId();
+    var ticketId3 = new LotteryTicketId();
+    assertNotEquals(ticketId1, ticketId2);
+    assertNotEquals(ticketId2, ticketId3);
+    var ticketId4 = new LotteryTicketId(ticketId1.getId());
+    assertEquals(ticketId1, ticketId4);
+  }
+}
@@ -0,0 +1,52 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import java.util.Set;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test Lottery Tickets for equality
+ */
+class LotteryTicketTest {
+
+  @Test
+  void testEquals() {
+    var details1 = new PlayerDetails("bob@foo.bar", "1212-121212", "+34332322");
+    var numbers1 = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    var ticket1 = new LotteryTicket(new LotteryTicketId(), details1, numbers1);
+    var details2 = new PlayerDetails("bob@foo.bar", "1212-121212", "+34332322");
+    var numbers2 = LotteryNumbers.create(Set.of(1, 2, 3, 4));
+    var ticket2 = new LotteryTicket(new LotteryTicketId(), details2, numbers2);
+    assertEquals(ticket1, ticket2);
+    var details3 = new PlayerDetails("elsa@foo.bar", "1223-121212", "+49332322");
+    var numbers3 = LotteryNumbers.create(Set.of(1, 2, 3, 8));
+    var ticket3 = new LotteryTicket(new LotteryTicketId(), details3, numbers3);
+    assertNotEquals(ticket1, ticket3);
+  }
+}
@@ -0,0 +1,45 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.hexagonal.domain;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * Unit tests for {@link PlayerDetails}
+ */
+class PlayerDetailsTest {
+
+  @Test
+  void testEquals() {
+    var details1 = new PlayerDetails("tom@foo.bar", "11212-123434", "+12323425");
+    var details2 = new PlayerDetails("tom@foo.bar", "11212-123434", "+12323425");
+    assertEquals(details1, details2);
+    var details3 = new PlayerDetails("john@foo.bar", "16412-123439", "+34323432");
+    assertNotEquals(details1, details3);
+  }
+}