refactor - entity to VO

src/Deck/Factories/VO.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace Roliod\TexasHUPoker\Deck\Factories;
+
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+
+class VO
+{
+    /**
+     * @param string $sequence
+     *
+     * @return HandVO
+     */
+    public static function buildHandVO(
+        string $sequence
+    ): HandVO {
+        return new HandVO($sequence);
+    }
+}

src/Deck/Entities/Hand.php → src/Deck/VOs/Hand.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Roliod\TexasHUPoker\Deck\Entities;
+namespace Roliod\TexasHUPoker\Deck\VOs;
 
 class Hand
 {

src/Evaluate.php

@@ -6,7 +6,7 @@
 use Exception;
 use Roliod\TexasHUPoker\Deck\Suite;
 use Roliod\TexasHUPoker\Rules\Contracts\Rule as RuleContract;
-use Roliod\TexasHUPoker\Deck\Factories\Entity as EntityFactory;
+use Roliod\TexasHUPoker\Deck\Factories\VO as VOFactory;
 use Roliod\TexasHUPoker\Exceptions\FileDoesNotExist as FileDoesNotExistException;
 use Roliod\TexasHUPoker\Exceptions\InvalidFileContent as InvalidFileContentException;
 
@@ -81,7 +81,7 @@ private function reorderBasedOnHierarchy(array $hands): array
     {
         $deckHierarchy = [];
         foreach ($hands as $hand) {
-            $hand = EntityFactory::buildHandEntity($hand);
+            $hand = VOFactory::buildHandVO($hand);
 
             foreach (Config::RULES as $rule) {
                 /** @var RuleContract $rule */

src/Rules/AbstractRule.php

@@ -6,8 +6,8 @@
 use Roliod\TexasHUPoker\Rules\Contracts\Rule as RuleContract;
 use Roliod\TexasHUPoker\Rules\Concerns\CanGetRanksFromSequence;
 use Roliod\TexasHUPoker\Rules\Concerns\CanGetSuitsFromSequence;
-use Roliod\TexasHUPoker\Rules\Factories\Entity as EntityFactory;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Rules\Factories\VO as VOFactory;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 abstract class AbstractRule implements RuleContract
 {
@@ -18,14 +18,14 @@ abstract class AbstractRule implements RuleContract
      * @param int    $rank
      * @param bool   $matches
      *
-     * @return RuleResponseEntity
+     * @return RuleResponseVO
      */
     protected function buildRuleResponse(
         string $sequence,
         int $rank,
         bool $matches
-    ): RuleResponseEntity {
-        return EntityFactory::buildRuleResponseEntity(
+    ): RuleResponseVO {
+        return VOFactory::buildRuleResponseVO(
             $sequence,
             $rank,
             $matches

src/Rules/Contracts/Rule.php

@@ -3,15 +3,15 @@
 
 namespace Roliod\TexasHUPoker\Rules\Contracts;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 interface Rule
 {
     /**
-     * @param HandEntity $handEntity
+     * @param HandVO $handVO
      *
-     * @return RuleResponseEntity
+     * @return RuleResponseVO
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity;
+    public function validate(HandVO $handVO): RuleResponseVO;
 }

src/Rules/Factories/Entity.php → src/Rules/Factories/VO.php

@@ -3,23 +3,23 @@
 
 namespace Roliod\TexasHUPoker\Rules\Factories;
 
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
-class Entity
+class VO
 {
     /**
      * @param string $hand
      * @param int    $rank
      * @param bool   $matches
      *
-     * @return RuleResponseEntity
+     * @return RuleResponseVO
      */
-    public static function buildRuleResponseEntity(
+    public static function buildRuleResponseVO(
         string $hand,
         int $rank,
         bool $matches = false
-    ): RuleResponseEntity {
-        return new RuleResponseEntity(
+    ): RuleResponseVO {
+        return new RuleResponseVO(
             $hand,
             $rank,
             $matches

src/Rules/Flush.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class Flush extends AbstractRule
 {
@@ -16,9 +16,9 @@ class Flush extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isFlush = $this->isFlush($sequence);
 
         return $this->buildRuleResponse(

src/Rules/FourOfAKind.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class FourOfAKind extends AbstractRule
 {
@@ -16,9 +16,9 @@ class FourOfAKind extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isFourAKind = $this->isFourOfAKind($sequence);
 
         return $this->buildRuleResponse(

src/Rules/FullHouse.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class FullHouse extends AbstractRule
 {
@@ -16,9 +16,9 @@ class FullHouse extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isFullHouse = $this->isFullHouse($sequence);
 
         return $this->buildRuleResponse(

src/Rules/HighCard.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class HighCard extends AbstractRule
 {
@@ -16,9 +16,9 @@ class HighCard extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isHighCard = $this->isHighCard($sequence);
 
         return $this->buildRuleResponse(

src/Rules/Pair.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class Pair extends AbstractRule
 {
@@ -16,9 +16,9 @@ class Pair extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isPair = $this->isPair($sequence);
 
         return $this->buildRuleResponse(

src/Rules/RoyalFlush.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class RoyalFlush extends AbstractRule
 {
@@ -16,9 +16,9 @@ class RoyalFlush extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isRoyalSequence = $this->isRoyalFlushSequence($sequence);
 
         return $this->buildRuleResponse(

src/Rules/Straight.php

@@ -4,8 +4,8 @@
 namespace Roliod\TexasHUPoker\Rules;
 
 use Roliod\TexasHUPoker\Deck\Rank;
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class Straight extends AbstractRule
 {
@@ -17,9 +17,9 @@ class Straight extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isStraight = $this->isStraight($sequence);
 
         return $this->buildRuleResponse(

src/Rules/StraightFlush.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class StraightFlush extends AbstractRule
 {
@@ -16,10 +16,10 @@ class StraightFlush extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
-        $isStraightFlush = $this->isStraightFlush($handEntity);
+        $sequence = $handVO->getSequence();
+        $isStraightFlush = $this->isStraightFlush($handVO);
 
         return $this->buildRuleResponse(
             $sequence,
@@ -29,14 +29,14 @@ public function validate(HandEntity $handEntity): RuleResponseEntity
     }
 
     /**
-     * @param HandEntity $handEntity
+     * @param HandVO $handVO
      *
      * @return bool
      */
-    private function isStraightFlush(HandEntity $handEntity): bool
+    private function isStraightFlush(HandVO $handVO): bool
     {
-        $flush = (new Flush())->validate($handEntity);
-        $straight = (new Straight())->validate($handEntity);
+        $flush = (new Flush())->validate($handVO);
+        $straight = (new Straight())->validate($handVO);
 
         return $flush->getMatches() && $straight->getMatches();
     }

src/Rules/ThreeOfAKind.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class ThreeOfAKind extends AbstractRule
 {
@@ -16,9 +16,9 @@ class ThreeOfAKind extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isThreeAKind = $this->isThreeOfAKind($sequence);
 
         return $this->buildRuleResponse(

src/Rules/TwoPair.php

@@ -3,8 +3,8 @@
 
 namespace Roliod\TexasHUPoker\Rules;
 
-use Roliod\TexasHUPoker\Deck\Entities\Hand as HandEntity;
-use Roliod\TexasHUPoker\Rules\Entities\RuleResponse as RuleResponseEntity;
+use Roliod\TexasHUPoker\Deck\VOs\Hand as HandVO;
+use Roliod\TexasHUPoker\Rules\VOs\RuleResponse as RuleResponseVO;
 
 class TwoPair extends AbstractRule
 {
@@ -16,9 +16,9 @@ class TwoPair extends AbstractRule
     /**
      * {@inheritDoc}
      */
-    public function validate(HandEntity $handEntity): RuleResponseEntity
+    public function validate(HandVO $handVO): RuleResponseVO
     {
-        $sequence = $handEntity->getSequence();
+        $sequence = $handVO->getSequence();
         $isTwoPair = $this->isTwoPair($sequence);
 
         return $this->buildRuleResponse(