Initial import

Author: proggeler

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+.idea

.scrutinizer.yml

@@ -0,0 +1,28 @@
+build:
+    tests:
+        override:
+            -
+                command: 'vendor/bin/phpunit tests --configuration phpunit.xml.dist --coverage-clover=code-coverage'
+                coverage:
+                    file: 'code-coverage'
+                    format: 'clover'
+    nodes:
+        tests: true
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
+                    -
+                        command: phpcs-run
+                        use_website_config: true
+
+filter:
+    excluded_paths:
+        - 'tests/*'
+coding_style:
+    php:
+        spaces:
+            around_operators:
+                concatenation: true
+checks:
+    php: true

.travis.yml

@@ -0,0 +1,8 @@
+language: php
+php:
+  - '7.1'
+  - '7.2'
+  - hhvm
+  - nightly
+install: composer install
+script: ./vendor/bin/phpunit --configuration phpunit.xml.dist

LICENSE.md

@@ -0,0 +1,22 @@
+
+# The MIT License (MIT)
+
+Copyright (c) 2018 DMT-software <bas@dmt-software.nl>
+
+> 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.

README.md

@@ -0,0 +1,79 @@
+# Command-Bus-Validator
+
+## Install
+`composer require dmt-software/command-bus-validator`
+
+## Usage
+
+### Default usage
+
+By default this middleware uses the StaticMethodLoader of the [Symfony Validator](https://symfony.com/doc/current/components/validator.html) component. 
+If you have installed both `doctrine/annotations` and `doctrine/cache`, this default behaviour is extended with the AnnotationLoader.
+
+Configure and adding this middleware to the commandBus:
+```php
+<?php // src/CommandBus/builder.php
+      
+use DMT\CommandBus\Validator\ValidationMiddleware;
+use League\Tactician\CommandBus;
+use League\Tactician\Handler\CommandHandlerMiddleware;
+
+/** @var CommandHandlerMiddleware $commandHandlerMiddleware */
+$commandBus = new CommandBus(
+  [
+      new ValidationMiddleware(),
+      $commandHandlerMiddleware 
+  ]
+);
+```
+After the CommandBus is added, the commands it receives will be validated when the `handle` method is called:
+```php
+<?php
+ 
+use DMT\CommandBus\Validator\ValidationException;
+use League\Tactician\CommandBus;
+ 
+try {
+    /** @var object $command */
+    /** @var CommandBus $commandBus */
+    $result = $commandBus->handle($command);
+} catch (ValidationException $exception) {
+    $violations = $exception->getViolations();
+    foreach ($violations as $violation) {
+        echo $violation->getMessage(); // outputs: the violation message(s)
+    }
+}
+```
+
+### Using custom configured validator 
+
+The validator can also be plugged unto the middleware by providing it to the middleware constructor.
+
+This example uses a FileLoader to determine the constraints for a command.
+```php
+<?php // src/CommandBus/builder.php
+ 
+use DMT\CommandBus\Validator\ValidationMiddleware;
+use League\Tactician\CommandBus;
+use League\Tactician\Handler\CommandHandlerMiddleware;
+use Symfony\Component\Validator\ValidatorBuilder;
+ 
+$validator = (new ValidatorBuilder())
+    ->addYamlMapping('config/validation.yaml')
+    ->getValidator();
+
+/** @var CommandHandlerMiddleware $commandHandlerMiddleware */
+$commandBus = new CommandBus(
+    [
+        new ValidationMiddleware($validator),
+        $commandHandlerMiddleware 
+    ]
+);
+
+```
+
+## Further reading
+
+- [Tactician CommandBus](http://tactician.thephpleague.com/)
+- [Validator Loaders](https://symfony.com/doc/current/components/validator/resources.html)
+

composer.json

@@ -0,0 +1,36 @@
+{
+    "name": "dmt-software/command-bus-validator",
+    "description": "A CommandBus middleware to validate commands using the Symfony Validator",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Bas de Mes",
+            "email": "bas@dmt-software.nl"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "league/tactician": "^1.0",
+        "symfony/validator": "^4.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "DMT\\CommandBus\\": "src/"
+        }
+    },
+    "suggest": {
+        "doctrine/annotations": "Enables adding constraints using annotations",
+        "doctrine/cache": "Enables adding constraints using annotations"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.1",
+        "doctrine/annotations": "^1.6",
+        "doctrine/cache": "^1.7"
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "DMT\\Test\\CommandBus\\": "tests/"
+        }
+    }
+}