Version 1.x (#29)

- drop support php < 7.2
- update phpunit to 7.5
- add strict types in all files
- add return type and argument type hinting in all files
- bump copyright to 2019

Author: icanhazstring

.gitattributes

@@ -0,0 +1,8 @@
+.gitattributes export-ignore
+.gitignore export-ignore
+.scrutinizer.yml export-ignore
+.travis.coverage.sh export-ignore
+.travis.yml export-ignore
+phpcs.xml.dist export-ignore
+phpunit.xml.dist export-ignore
+phpstan.xml.dist export-ignore

.gitignore

@@ -1,4 +1,12 @@
-/vendor/
+# Composer
+vendor/
 composer.lock
+
+# Cache
 /tests/cache/
 /demo/cache/
+
+# Code quality
+/phpunit.xml
+/phpcs.xml
+/phpstan.neon

.scrutinizer.yml

@@ -9,7 +9,7 @@ tools:
     php_code_sniffer:
         enabled: true
         config:
-            standard: PSR2
+            standard: PSR12
         filter:
             paths: ["src/*"]
     php_cpd:

.travis.coverage.sh

@@ -1,5 +1,5 @@
 set -x
-if [ "$TRAVIS_PHP_VERSION" = '7.0' ] ; then
+if [ "$TRAVIS_PHP_VERSION" = '7.2' ] ; then
     wget https://scrutinizer-ci.com/ocular.phar
     php ocular.phar code-coverage:upload --format=php-clover ./clover.xml
 fi

.travis.yml

@@ -1,15 +1,16 @@
 language: php
 
 php:
-  - 7.0
-  - 7.1
   - 7.2
+  - 7.3
 
 before_script:
   - composer install
 
 script:
   - vendor/bin/phpunit --verbose --coverage-text --coverage-clover=clover.xml --colors
+  - vendor/bin/phpcs src/ tests/
+  - vendor/bin/phpstan analyze
 
 after_script:
   - sh .travis.coverage.sh

README.md

@@ -23,11 +23,11 @@ break a caller, C++ FAQs uses the memorable phrase "require no more, promise no
 does not require more from the caller than before, and if it does not promise to deliver less than before,
 then the new specification is compatible with the old, and will not break the caller.
 
-[![Build Status](https://api.travis-ci.org/php-deal/framework.png?branch=master)](https://travis-ci.org/php-deal/framework)
+[![Build Status](https://api.travis-ci.org/php-deal/framework.png?branch=1.x)](https://travis-ci.org/php-deal/framework)
 [![GitHub release](https://img.shields.io/github/release/php-deal/framework.svg)](https://github.com/php-deal/framework/releases/latest)
-[![Code Coverage](https://scrutinizer-ci.com/g/php-deal/framework/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/php-deal/framework/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-deal/framework/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/php-deal/framework/?branch=master)
-[![Minimum PHP Version](http://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg)](https://php.net/)
+[![Code Coverage](https://scrutinizer-ci.com/g/php-deal/framework/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/php-deal/framework/?branch=1.x)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-deal/framework/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/php-deal/framework/?branch=1.x)
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D7.2-blue.svg)](https://php.net/)
 [![License](https://img.shields.io/packagist/l/php-deal/framework.svg)](https://packagist.org/packages/php-deal/framework)
 
 Installation
@@ -148,16 +148,16 @@ There a some differences in inheritance of the contracts:
   - if provided `Ensure` will automatically inherit all contracts from parent class or interface
 2. Verify
   - if provided `Verify` will _not_ inherit contracts from parent class or interface
-  - to inherit contracts you will ne to provide `@inheritdoc` or the `Inherit` contract
+  - to inherit contracts you will need to provide `@inheritdoc` or the `Inherit` contract
 3. Invariant
   - if provided `Invariant` will inherit all contracts from parent class or interface
 4. Inherit
-  - if provided `Inherit` will inherit all contracts from the given leven (class, method) without the
+  - if provided `Inherit` will inherit all contracts from the given level (class, method) without the
   need to provide a contract on your current class or method
 
 __Notes__: 
 - The parsing of a contract only happens __IF__ you provide any given annotation from this package.
-Without it your contracts won't work!
+Without it, your contracts won't work!
 - The annotation __must not__ have curly braces (`{}`) otherwise the annotation reader can't find them.
 
 ```php

composer.json

@@ -2,13 +2,17 @@
     "name": "php-deal/framework",
     "description": "Design by Contract framework for PHP",
     "require": {
-        "php": "~7.0",
-        "goaop/framework": "~2.0"
+        "php": "^7.2",
+        "goaop/framework": "^2.3"
     },
     "require-dev": {
-        "symfony/console": "~2.7|~3.0",
-        "phpunit/phpunit": "^5.7",
-        "beberlei/assert": "~3.0"
+        "beberlei/assert": "~3.0",
+        "phpstan/phpstan": "^0.11.0",
+        "phpunit/phpunit": "^7.5",
+        "roave/security-advisories": "dev-master",
+        "slevomat/coding-standard": "^4.8",
+        "squizlabs/php_codesniffer": "^3.4",
+        "symfony/console": "~2.7|~3.0|~4.0"
     },
     "license": "MIT",
     "authors": [
@@ -19,21 +23,44 @@
         {
             "name": "Piotr Dawidiuk",
             "email": "[email protected]"
+        },
+        {
+            "name": "Andreas Frömer",
+            "email": "[email protected]"
         }
     ],
     "autoload": {
-        "psr-4": {"PhpDeal\\": "src/"}
+        "psr-4": {
+            "PhpDeal\\": "src/"
+        }
     },
     "autoload-dev": {
-        "psr-0": {"Demo\\": "demo/"},
-        "psr-4": {"PhpDeal\\": "tests/"}
+        "psr-0": {
+            "Demo\\": "demo/"
+        },
+        "psr-4": {
+            "PhpDeal\\": "tests/"
+        }
+    },
+    "scripts": {
+        "phpstan": "phpstan analyze",
+        "phpcs": "phpcs src tests -sp --colors",
+        "phpunit": "phpunit --verbose --colors=always",
+        "test": [
+            "@phpstan",
+            "@phpcs",
+            "@phpunit"
+        ]
+    },
+    "config": {
+        "sort-packages": true
     },
     "suggest": {
-      "beberlei/assert": "Thin assertion library for input validation in business models. Used for tests."
+        "beberlei/assert": "Thin assertion library for input validation in business models. Used for tests."
     },
     "support": {
-      "issues": "https://github.com/php-deal/framework/issues",
-      "source": "https://github.com/php-deal/framework",
-      "docs": "https://github.com/php-deal/framework/blob/master/README.md"
+        "issues": "https://github.com/php-deal/framework/issues",
+        "source": "https://github.com/php-deal/framework",
+        "docs": "https://github.com/php-deal/framework/blob/master/README.md"
     }
 }

demo/Demo/Account.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.

demo/Demo/AccountContractInterface.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.

demo/aspect_bootstrap.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.

demo/demo.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.
@@ -18,6 +20,6 @@
 $account->deposit(100);
 echo 'Current balance: ' . $account->getBalance();
 echo PHP_EOL;
-echo 'Withdraw: 100' . PHP_EOL;
+echo 'Withdraw: 50' . PHP_EOL;
 $account->withdraw(50);
 echo 'Current balance: ' . $account->getBalance();

phpcs.xml.dist

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="PSR12-phpdeal">
+    <description>PSR-12 with native function invocation</description>
+    <!-- Add slevomat/coding-standard to installed_paths so we can use a single sniff -->
+    <config name="installed_paths" value="../../slevomat/coding-standard"/>
+
+    <exclude-pattern>*/cache</exclude-pattern>
+
+    <rule ref="PSR12"/>
+    <rule ref="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions"/>
+</ruleset>

phpstan.neon.dist

@@ -0,0 +1,7 @@
+parameters:
+    excludes_analyse:
+        - %rootDir%/../../../tests/cache
+    level: max
+    paths:
+        - src/
+        - tests/

phpunit.xml.dist

@@ -8,7 +8,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="./tests/bootstrap.php"
         >
     <php>

src/Annotation/Ensure.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.
@@ -19,7 +21,7 @@
  */
 class Ensure extends BaseAnnotation
 {
-    public function __toString()
+    public function __toString(): string
     {
         return $this->value;
     }

src/Annotation/Invariant.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.
@@ -19,7 +21,7 @@
  */
 class Invariant extends BaseAnnotation
 {
-    public function __toString()
+    public function __toString(): string
     {
         return $this->value;
     }

src/Annotation/Verify.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.

src/Aspect/AbstractContractAspect.php

@@ -1,8 +1,10 @@
 <?php
+declare(strict_types=1);
+
 /**
  * PHP Deal framework
  *
- * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
+ * @copyright Copyright 2019, Lisachenko Alexander <[email protected]>
  *
  * This source file is subject to the license that is bundled
  * with this source code in the file LICENSE.
@@ -36,22 +38,22 @@ public function __construct(Reader $reader)
      *
      * @param MethodInvocation $invocation
      * @return array
+     * @throws \ReflectionException
      */
-    protected function fetchMethodArguments(MethodInvocation $invocation)
+    protected function fetchMethodArguments(MethodInvocation $invocation): array
     {
         $result         = [];
         $parameters     = $invocation->getMethod()->getParameters();
         $argumentValues = $invocation->getArguments();
 
         // Number of arguments can be less than number of parameters because of default values
         foreach ($parameters as $parameterIndex => $reflectionParameter) {
-            $hasArgumentValue = array_key_exists($parameterIndex, $argumentValues);
+            $hasArgumentValue = \array_key_exists($parameterIndex, $argumentValues);
             $argumentValue    = $hasArgumentValue ? $argumentValues[$parameterIndex] : null;
             if (!$hasArgumentValue && $reflectionParameter->isDefaultValueAvailable()) {
                 $argumentValue = $reflectionParameter->getDefaultValue();
             }
             $result[$reflectionParameter->name] = $argumentValue;
-
         }
 
         return $result;
@@ -69,28 +71,34 @@ protected function fetchMethodArguments(MethodInvocation $invocation)
      * @throws DomainException
      * @throws ContractViolation
      */
-    protected function ensureContracts(MethodInvocation $invocation, array $contracts, $instance, $scope, array $args)
-    {
+    protected function ensureContracts(
+        MethodInvocation $invocation,
+        array $contracts,
+        $instance,
+        string $scope,
+        array $args
+    ): void {
         static $invoker = null;
         if (!$invoker) {
             $invoker = function () {
-                extract(func_get_arg(0));
+                $args = \func_get_arg(0);
+                \extract($args, EXTR_OVERWRITE);
 
-                return eval('return ' . func_get_arg(1) . '; ?>');
+                return eval('return ' . \func_get_arg(1) . '; ?>');
             };
         }
 
-        $instance     = is_object($instance) ? $instance : null;
+        $instance     = \is_object($instance) ? $instance : null;
         $boundInvoker = $invoker->bindTo($instance, $scope);
 
         foreach ($contracts as $contract) {
             $contractExpression = $contract->value;
             try {
                 $invocationResult = $boundInvoker->__invoke($args, $contractExpression);
 
-//                if ($invocationResult === false) {
-//                    throw new ContractViolation($invocation, $contractExpression);
-//                }
+                if ($invocationResult === false) {
+                    throw new ContractViolation($invocation, $contractExpression);
+                }
 
                 // we accept as a result only true or null
                 // null may be a result of assertions from beberlei/assert which passed
@@ -99,7 +107,6 @@ protected function ensureContracts(MethodInvocation $invocation, array $contract
                         . ' only boolean or void can be returned';
                     throw new DomainException($errorMessage);
                 }
-
             } catch (\Error $internalError) {
                 // PHP-7 friendly interceptor for fatal errors
                 throw new ContractViolation($invocation, $contractExpression, $internalError);