Updated code do fix phpcs checks

italolelis · italolelis · commit fbee62c05e89 · 2016-07-06T14:35:14.000+02:00
diff --git a/composer.json b/composer.json
@@ -17,8 +17,9 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^5.3",
-    "symfony/var-dumper": "^3.0",
     "codacy/coverage": "dev-master",
+    "squizlabs/php_codesniffer": "^2.0",
+    "symfony/var-dumper": "^3.0",
     "jms/serializer": "^1.1",
     "predis/predis": "^1.0",
     "mongodb/mongodb": "^1.0.0",
diff --git a/ruleset.xml b/ruleset.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<ruleset name="HelloFresh">
+    <description>Coding standard based on PSR-2 with some additions.</description>
+
+    <!-- Include the whole PSR-2 standard -->
+    <rule ref="PSR2"/>
+</ruleset>
diff --git a/src/CommandBus/Exception/MissingHandlerException.php b/src/CommandBus/Exception/MissingHandlerException.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: ilelis
- * Date: 20/06/16
- * Time: 14:53
- */
 
 namespace HelloFresh\Engine\CommandBus\Exception;
 
diff --git a/src/Domain/DomainMessage.php b/src/Domain/DomainMessage.php
@@ -42,7 +42,7 @@ public function __construct($id, $version, $payload, \DateTimeImmutable $recorde
     }
 
     /**
-     * {@inheritDoc}
+     * @return AggregateIdInterface
      */
     public function getId()
     {
diff --git a/src/Domain/StreamName.php b/src/Domain/StreamName.php
@@ -4,7 +4,6 @@
 
 use Assert\Assertion;
 
-
 /**
  * Class StreamName
  *
diff --git a/src/EventDispatcher/EventListenerInterface.php b/src/EventDispatcher/EventListenerInterface.php
@@ -13,4 +13,4 @@ interface EventListenerInterface
      * @param callable $callable The callable that will be called when the event happens
      */
     public function addListener($eventName, callable $callable);
-}
+}
diff --git a/src/EventSourcing/AggregateRepository.php b/src/EventSourcing/AggregateRepository.php
@@ -125,5 +125,4 @@ protected function determineStreamName(StreamName $streamName = null)
 
         return $streamName;
     }
-
 }
diff --git a/src/EventSourcing/AggregateRootTrait.php b/src/EventSourcing/AggregateRootTrait.php
@@ -39,7 +39,7 @@ public function getUncommittedEvents()
      *
      * @param EventStream $historyEvents
      *
-     * @throws \RuntimeException
+     * @param null $version
      */
     public function replay(EventStream $historyEvents, $version = null)
     {
diff --git a/src/EventStore/Adapter/MongoAdapter.php b/src/EventStore/Adapter/MongoAdapter.php
@@ -57,7 +57,9 @@ public function fromVersion(StreamName $streamName, AggregateIdInterface $aggreg
         }
 
         $collection = $this->getCollection($streamName);
-        $serializedEvents = $collection->find($query)->sort(['version' => \MongoCollection::ASCENDING]);;
+        $serializedEvents = $collection
+            ->find($query)
+            ->sort(['version' => \MongoCollection::ASCENDING]);
 
         return $this->processEvents($serializedEvents);
     }
diff --git a/src/EventStore/Adapter/Schema/DbalSchema.php b/src/EventStore/Adapter/Schema/DbalSchema.php
@@ -30,7 +30,9 @@ public static function createSchema(Connection $connection)
     }
 
     /**
+     * @param Schema $schema
      * @param string $table
+     * @throws \Doctrine\DBAL\Schema\SchemaException
      */
     public static function addToSchema(Schema $schema, $table)
     {
diff --git a/src/EventStore/Snapshot/Adapter/DbalSnapshotAdapter.php b/src/EventStore/Snapshot/Adapter/DbalSnapshotAdapter.php
@@ -82,4 +82,4 @@ private function getQueryBuilder()
             ->select('*')
             ->from($this->tableName);
     }
-}
+}
diff --git a/src/EventStore/Snapshot/Adapter/RedisSnapshotAdapter.php b/src/EventStore/Snapshot/Adapter/RedisSnapshotAdapter.php
@@ -103,4 +103,4 @@ public function has(AggregateIdInterface $id, $version)
 
         return $snapshot['version'] === $version;
     }
-}
+}
diff --git a/src/EventStore/Snapshot/Adapter/Schema/SnapshotSchema.php b/src/EventStore/Snapshot/Adapter/Schema/SnapshotSchema.php
@@ -30,7 +30,9 @@ public static function createSchema(Connection $connection)
     }
 
     /**
+     * @param Schema $schema
      * @param string $table
+     * @throws \Doctrine\DBAL\Schema\SchemaException
      */
     public static function addToSchema(Schema $schema, $table)
     {
diff --git a/src/EventStore/Snapshot/Snapshotter.php b/src/EventStore/Snapshot/Snapshotter.php
@@ -31,6 +31,13 @@ public function __construct(SnapshotStoreInterface $snapshotStore, SnapshotStrat
         $this->strategy = $strategy;
     }
 
+    /**
+     * Takes a snapshot
+     * @param StreamName $streamName
+     * @param AggregateRootInterface $aggregate
+     * @param DomainMessage $message - The domain message
+     * @return bool
+     */
     public function take(StreamName $streamName, AggregateRootInterface $aggregate, DomainMessage $message)
     {
         $id = $aggregate->getAggregateRootId();
@@ -42,6 +49,8 @@ public function take(StreamName $streamName, AggregateRootInterface $aggregate,
         if (!$this->snapshotStore->has($id, $message->getVersion())) {
             $this->snapshotStore->save(Snapshot::take($id, $aggregate, $message->getVersion()));
         }
+
+        return true;
     }
 
     /**
diff --git a/src/Provider/EngineServiceProvider.php b/src/Provider/EngineServiceProvider.php
@@ -1,8 +1,10 @@
 <?php
 
-namespace HelloFresh\Engine\Provider;
+namespace HelloFresh\Provider;
 
+use HelloFresh\Engine\CommandBus\Handler\InMemoryLocator;
 use HelloFresh\Engine\CommandBus\SimpleCommandBus;
+use HelloFresh\Engine\CommandBus\TacticianCommandBus;
 use HelloFresh\Engine\EventBus\SimpleEventBus;
 use HelloFresh\Engine\EventSourcing\AggregateRepository;
 use HelloFresh\Engine\EventStore\Adapter\DbalAdapter;
@@ -22,7 +24,6 @@
 use HelloFresh\Engine\Serializer\Adapter\PhpSerializerAdapter;
 use Pimple\Container;
 use Pimple\ServiceProviderInterface;
-use Predis\Client;
 
 class EngineServiceProvider implements ServiceProviderInterface
 {
@@ -50,7 +51,7 @@ public function __construct($prefix = 'engine')
     public function register(Container $pimple)
     {
         $pimple["$this->prefix.config"] = $this->defineDefaultConfig();
-        $pimple["$this->prefix.command_bus"] = $this->setUpCommandBus();
+        $pimple["$this->prefix.command_bus"] = $this->setUpCommandBus($pimple);
         $pimple["$this->prefix.event_bus"] = $this->setUpEventBus();
         $pimple["$this->prefix.event_store"] = $this->setUpEventStore($pimple);
         $pimple["$this->prefix.snapshot_store"] = $this->setUpSnapshotStore($pimple);
@@ -62,6 +63,9 @@ public function register(Container $pimple)
     private function defineDefaultConfig()
     {
         return [
+            'command_bus' => [
+                'adapter' => 'simple'
+            ],
             'event_store' => [
                 'adapter' => 'in_memory'
             ],
@@ -82,17 +86,43 @@ private function defineDefaultConfig()
         ];
     }
 
-    private function setUpCommandBus()
+    private function setUpCommandBus(Container $pimple)
     {
-        return function (Container $c) {
-            $commandBus = new SimpleCommandBus();
+        $pimple["$this->prefix.command_bus.locator"] = function () {
+            return new InMemoryLocator();
+        };
+
+        $pimple["$this->prefix.command_bus.simple"] = function (Container $c) {
+            $locator = $c["$this->prefix.command_bus.locator"];
+            $mapper = $c["$this->prefix.command_bus.handlers"];
+
+            foreach ($mapper as $commandName => $handler) {
+                $locator->addHandler($handler, $commandName);
+            }
+
+            return new SimpleCommandBus($c["$this->prefix.command_bus.locator"]);
+        };
+
+        $pimple["$this->prefix.command_bus.tactician"] = function (Container $c) {
+            $locator = $c['tactician.locator'];
             $mapper = $c["$this->prefix.command_bus.handlers"];
 
             foreach ($mapper as $commandName => $handler) {
-                $commandBus->subscribe($commandName, $handler);
+                $locator->addHandler($handler, $commandName);
+            }
+
+            return new TacticianCommandBus($c['tactician.command_bus']);
+        };
+
+        return function (Container $c) {
+            $adapterName = $c["$this->prefix.config"]['command_bus']['adapter'];
+            $service = "$this->prefix.command_bus.$adapterName";
+
+            if (!isset($c[$service])) {
+                throw new \InvalidArgumentException('Invalid event store adapter provided');
             }
 
-            return $commandBus;
+            return $c[$service];
         };
     }
 
diff --git a/src/Serializer/Adapter/PhpJsonSerializerAdapter.php b/src/Serializer/Adapter/PhpJsonSerializerAdapter.php
@@ -3,9 +3,6 @@
 namespace HelloFresh\Engine\Serializer\Adapter;
 
 use HelloFresh\Engine\Serializer\SerializerInterface;
-use JMS\Serializer\DeserializationContext;
-use JMS\Serializer\SerializationContext;
-use JMS\Serializer\SerializerInterface as JmsSerializerInterface;
 
 class PhpJsonSerializerAdapter implements SerializerInterface
 {
diff --git a/src/Serializer/Adapter/PhpSerializerAdapter.php b/src/Serializer/Adapter/PhpSerializerAdapter.php
@@ -3,9 +3,6 @@
 namespace HelloFresh\Engine\Serializer\Adapter;
 
 use HelloFresh\Engine\Serializer\SerializerInterface;
-use JMS\Serializer\DeserializationContext;
-use JMS\Serializer\SerializationContext;
-use JMS\Serializer\SerializerInterface as JmsSerializerInterface;
 
 class PhpSerializerAdapter implements SerializerInterface
 {
diff --git a/src/Serializer/Adapter/SymfonySerializerAdapter.php b/src/Serializer/Adapter/SymfonySerializerAdapter.php
@@ -3,8 +3,6 @@
 namespace HelloFresh\Engine\Serializer\Adapter;
 
 use HelloFresh\Engine\Serializer\SerializerInterface;
-use JMS\Serializer\DeserializationContext;
-use JMS\Serializer\SerializationContext;
 use JMS\Serializer\SerializerInterface as JmsSerializerInterface;
 use Symfony\Component\Serializer\Serializer;
 
diff --git a/src/Serializer/SerializerInterface.php b/src/Serializer/SerializerInterface.php
@@ -7,7 +7,7 @@ interface SerializerInterface
     /**
      * Serializes the given data to the specified output format.
      *
-     * @param object|array|scalar $data
+     * @param object|array $data
      * @param string $format
      * @param null $groups
      * @return string
@@ -22,7 +22,7 @@ public function serialize($data, $format, $groups = null);
      * @param string $type
      * @param string $format
      * @param null $groups
-     * @return array|scalar|object
+     * @return array|object
      *
      */
     public function deserialize($data, $type, $format, $groups = null);
diff --git a/src/Serializer/Type/DateTimeImmutableHandler.php b/src/Serializer/Type/DateTimeImmutableHandler.php
@@ -101,4 +101,4 @@ private function getFormat(array $type)
     {
         return isset($type['params'][0]) ? $type['params'][0] : $this->defaultFormat;
     }
-}
+}
diff --git a/src/Serializer/Type/LocalizedDateTimeHandler.php b/src/Serializer/Type/LocalizedDateTimeHandler.php
@@ -2,10 +2,10 @@
 
 namespace HelloFresh\Engine\Serializer\Type;
 
-use JMS\Serializer\Handler\SubscribingHandlerInterface;
+use JMS\Serializer\Context;
 use JMS\Serializer\GraphNavigator;
+use JMS\Serializer\Handler\SubscribingHandlerInterface;
 use JMS\Serializer\JsonSerializationVisitor;
-use JMS\Serializer\Context;
 
 class LocalizedDateTimeHandler implements SubscribingHandlerInterface
 {
@@ -21,8 +21,12 @@ public static function getSubscribingMethods()
         );
     }
 
-    public function serializeLocalizedDateTimeToJson(JsonSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)
-    {
+    public function serializeLocalizedDateTimeToJson(
+        JsonSerializationVisitor $visitor,
+        \DateTime $date,
+        array $type,
+        Context $context
+    ) {
         $df = new \IntlDateFormatter(\Locale::getDefault(), \IntlDateFormatter::MEDIUM, \IntlDateFormatter::SHORT);
 
         return $df->format($date);
diff --git a/src/Serializer/Type/MoneyHandler.php b/src/Serializer/Type/MoneyHandler.php
@@ -2,17 +2,14 @@
 
 namespace HelloFresh\Engine\Serializer\Type;
 
-use JMS\Serializer\AbstractVisitor;
 use JMS\Serializer\Context;
 use JMS\Serializer\GraphNavigator;
-use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Handler\SubscribingHandlerInterface;
 use JMS\Serializer\VisitorInterface;
 use Money\Currency;
 use Money\Money;
-use Ramsey\Uuid\Uuid;
-use Ramsey\Uuid\UuidInterface;
 
-class MoneyHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
+class MoneyHandler implements SubscribingHandlerInterface
 {
     const TYPE_MONEY = 'money';
 
diff --git a/src/Serializer/Type/UuidSerializerHandler.php b/src/Serializer/Type/UuidSerializerHandler.php
@@ -7,12 +7,13 @@
 use JMS\Serializer\AbstractVisitor;
 use JMS\Serializer\Context;
 use JMS\Serializer\GraphNavigator;
+use JMS\Serializer\Handler\SubscribingHandlerInterface;
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\VisitorInterface;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
 
-class UuidSerializerHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
+class UuidSerializerHandler implements SubscribingHandlerInterface
 {
     const PATH_FIELD_SEPARATOR = '.';
     const TYPE_UUID = 'uuid';

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function __construct($id, $version, $payload, \DateTimeImmutable $recorde`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * {@inheritDoc}`
	`45`	`+ * @return AggregateIdInterface`
`46`	`46`	`*/`
`47`	`47`	`public function getId()`
`48`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`use Assert\Assertion;`
`6`	`6`
`7`		`-`
`8`	`7`	`/**`
`9`	`8`	`* Class StreamName`
`10`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -125,5 +125,4 @@ protected function determineStreamName(StreamName $streamName = null)`
`125`	`125`
`126`	`126`	`return $streamName;`
`127`	`127`	`}`
`128`		`-`
`129`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function getUncommittedEvents()`
`39`	`39`	`*`
`40`	`40`	`* @param EventStream $historyEvents`
`41`	`41`	`*`
`42`		`- * @throws \RuntimeException`
	`42`	`+ * @param null $version`
`43`	`43`	`*/`
`44`	`44`	`public function replay(EventStream $historyEvents, $version = null)`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,9 @@ public function fromVersion(StreamName $streamName, AggregateIdInterface $aggreg`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`$collection = $this->getCollection($streamName);`
`60`		`- $serializedEvents = $collection->find($query)->sort(['version' => \MongoCollection::ASCENDING]);;`
	`60`	`+ $serializedEvents = $collection`
	`61`	`+ ->find($query)`
	`62`	`+ ->sort(['version' => \MongoCollection::ASCENDING]);`
`61`	`63`
`62`	`64`	`return $this->processEvents($serializedEvents);`
`63`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@ public static function createSchema(Connection $connection)`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`
	`33`	`+ * @param Schema $schema`
`33`	`34`	`* @param string $table`
	`35`	`+ * @throws \Doctrine\DBAL\Schema\SchemaException`
`34`	`36`	`*/`
`35`	`37`	`public static function addToSchema(Schema $schema, $table)`
`36`	`38`	`{`