Merge pull request #14 from Jeckel-Lab/feature/php8-version

Upgrade to php8.0

.github/workflows/validate.yml

@@ -0,0 +1,34 @@
+name: validate
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  global-qa-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+        with:
+          php-version: 8.0
+      - name: Get composer cache directory
+        id: composer-cache
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-8.0-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-8.0
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist --dev
+      - name: GrumPHP
+        run: ./vendor/bin/grumphp run
+

README.md

@@ -8,6 +8,11 @@ This contract includes some strong typings, object relation and psalm validation
 
 Require **`php >= 7.2.*`** and **`php >= 8.0`**
 
+| Release name | Branch name | Php Version             |
+|--------------|-------------|-------------------------|
+| 1.x          | release/1.X | php >= 7.2 & php >= 8.0 |
+| 2.x          | master      | php >= 8.0              |
+
 ## Main contracts
 
 ### Core

composer.json

@@ -11,7 +11,7 @@
     }
   ],
   "require": {
-    "php": "^7.2 || ^8.0"
+    "php": "^8.0"
   },
   "autoload": {
     "psr-4": {
@@ -22,7 +22,8 @@
     "vimeo/psalm": "^4.3",
     "squizlabs/php_codesniffer": "^3.5",
     "phpmd/phpmd": "^2.8",
-    "phpro/grumphp": "^0.19 || ^1.2.0"
+    "phpro/grumphp": "^0.19 || ^1.2.0",
+    "phpstan/phpstan": "^0.12.91"
   },
   "suggest": {
     "vimeo/psalm": "Using psalm with this 'contract' will enable immutability and strong typing verification"

grumphp.yml

@@ -13,3 +13,6 @@ grumphp:
             threads: 1
             triggered_by: ['php']
             show_info: true
+        phpstan:
+            configuration: phpstan.neon
+            use_grumphp_paths: true

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+	level: 8
+	paths:
+		- src

ruleset.xml

@@ -7,18 +7,21 @@
          xsi:noNamespaceSchemaLocation="
                      http://pmd.sf.net/ruleset_xml_schema.xsd">
     <description>
-        My custom rule set that checks my code...
+        Jeckel-Lab/Contract PHPMD RuleSet
     </description>
 
-    <rule ref="rulesets/cleancode.xml">
-        <exclude name="IfStatementAssignment" />
-        <exclude name="StaticAccess" />
-    </rule>
-
+    <rule ref="rulesets/cleancode.xml" />
     <rule ref="rulesets/codesize.xml" />
     <rule ref="rulesets/design.xml" />
     <rule ref="rulesets/naming.xml">
         <exclude name="ShortVariable" />
     </rule>
     <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/naming.xml/ShortVariable">
+        <properties>
+            <property name="exceptions">
+                <value>id</value>
+            </property>
+        </properties>
+    </rule>
 </ruleset>

src/Domain/Entity/DomainEventAwareTrait.php

@@ -18,7 +18,7 @@
 trait DomainEventAwareTrait
 {
     /** @var Event[] */
-    private $events = [];
+    private array $events = [];
 
     /**
      * @return Event[]

src/Domain/Equality.php

@@ -14,9 +14,9 @@
 interface Equality
 {
     /**
-     * @param static $object
+     * @param mixed $object
      * @return bool
      * @psalm-mutation-free
      */
-    public function equals($object): bool;
+    public function equals(mixed $object): bool;
 }

src/Domain/Identity/Identity.php

@@ -9,24 +9,20 @@
 
 use JeckelLab\Contract\Domain\Equality;
 use JeckelLab\Contract\Domain\Identity\Exception\InvalidIdException;
+use Stringable;
 
 /**
  * Interface Identity
  * @package JeckelLab\Contract\Domain\Identity
  * @psalm-immutable
  * @template T
  */
-interface Identity extends Equality
+interface Identity extends Equality, Stringable
 {
     /**
      * IdAbstract constructor.
      * @param T $id
      * @throws InvalidIdException
      */
     public function __construct($id);
-
-    /**
-     * @return string
-     */
-    public function __toString(): string;
 }

src/Domain/ValueObject/ValueObject.php

@@ -7,14 +7,12 @@
 
 namespace JeckelLab\Contract\Domain\ValueObject;
 
+use Stringable;
+
 /**
  * Interface ValueObject
  * @psalm-immutable
  */
-interface ValueObject
+interface ValueObject extends Stringable
 {
-    /**
-     * @return string
-     */
-    public function __toString(): string;
 }