Feature/PHP 8.1 Upgrade

.gitattributes

@@ -2,4 +2,5 @@
 /.gitattributes export-ignore
 /phpunit.xml    export-ignore
 /tests          export-ignore
+/wiki          export-ignore
 /README.md

.github/workflows/documentation.yml

@@ -1,18 +1,16 @@
 name: Documentation
 
 on:
-  pull_request:
-    types: [ closed ]
+  push:
+    branches: [ 'main' ]
 
 jobs:
   publish:
-    if: github.event.pull_request.merged == true
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        php-version:
-          - "7.4"
+        php-version: [ '8.1' ]
 
     steps:
       - name: Checkout source code
@@ -39,7 +37,7 @@ jobs:
       - name: Install Dependencies
         run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
 
-      - name: Pusblish documentation to Wiki
+      - name: Publish documentation to Wiki
         uses: SwiftDocOrg/github-wiki-publish-action@v1
         with:
           path: "wiki/"

.github/workflows/test.yml

@@ -2,22 +2,23 @@ name: Test
 
 on:
   push:
-    branches:
-      - main
+    branches: [ 'main' ]
   pull_request:
-    types: [ opened, synchronize, reopened ]
+    types: [ 'opened', 'synchronize', 'reopened' ]
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        php-version: [ "8.0", "8.1" ]
+        php-version: [ '8.1' ]
 
     steps:
       - name: Checkout source code
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Set up PHP ${{ matrix.php-version }}
         uses: shivammathur/setup-php@v2
@@ -36,8 +37,9 @@ jobs:
       - name: Validate composer.json and composer.lock
         run: composer validate
 
-      - name: Install Dependencies
-        run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer install --prefer-dist --no-progress --no-suggest
 
       - name: Execute Static Code analysis
         run: composer analyse

composer.json

@@ -11,7 +11,7 @@
   ],
   "minimum-stability": "stable",
   "require": {
-    "php": "^8.0",
+    "php": "^8.1.0",
     "ext-json": "*",
     "ramsey/uuid": "^4.1",
     "nesbot/carbon": "^2.40",
@@ -21,20 +21,29 @@
     "complex-heart/contracts": "^1.0.0"
   },
   "require-dev": {
-    "mockery/mockery": "^1.4",
-    "phpunit/phpunit": "^9.3",
-    "fakerphp/faker": "^1.9.1",
-    "phpstan/phpstan": "^1.6.8",
-    "pestphp/pest": "^1.4"
+    "pestphp/pest": "^1.22.3",
+    "pestphp/pest-plugin-mock": "^1.0.0",
+    "pestphp/pest-plugin-faker": "^1.0.0",
+    "phpstan/phpstan": "^1.9.0"
   },
   "autoload": {
     "psr-4": {
       "ComplexHeart\\Domain\\Model\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "ComplexHeart\\Domain\\Model\\Test\\": "tests/"
+    }
+  },
   "scripts": {
     "test": "vendor/bin/pest --configuration=phpunit.xml --coverage-clover=coverage.xml --log-junit=test.xml",
-    "analyse": "vendor/bin/phpstan analyse src --no-progress --level=5"
+    "test-cov": "vendor/bin/pest --configuration=phpunit.xml --coverage-html=coverage",
+    "analyse": "vendor/bin/phpstan analyse src --no-progress --level=5",
+    "check": [
+      "@analyse",
+      "@test"
+    ]
   },
   "config": {
     "allow-plugins": {

src/Exceptions/ImmutableException.php

@@ -15,4 +15,4 @@
 class ImmutableException extends RuntimeException
 {
 
-}
+}

src/Exceptions/InstantiationException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ComplexHeart\Domain\Model\Exceptions;
+
+use RuntimeException;
+
+/**
+ * Class InstantiationException
+ *
+ * @author Unay Santisteban <usantisteban@othercode.es>
+ * @package ComplexHeart\Domain\Model\Exceptions
+ */
+class InstantiationException extends RuntimeException
+{
+
+}

src/Traits/HasAttributes.php

@@ -24,7 +24,7 @@ final public static function attributes(): array
     {
         return array_filter(
             array_keys(get_class_vars(static::class)),
-            fn(string $item): bool => strpos($item, '_') !== 0
+            fn(string $item): bool => !str_starts_with($item, '_')
         );
     }
 
@@ -63,7 +63,7 @@ final protected function hydrate(iterable $source): void
      *
      * @return mixed|null
      */
-    final protected function get(string $attribute)
+    final protected function get(string $attribute): mixed
     {
         if (in_array($attribute, static::attributes())) {
             $method = $this->getStringKey($attribute, 'get', 'Value');
@@ -82,7 +82,7 @@ final protected function get(string $attribute)
      * @param  string  $attribute
      * @param  mixed  $value
      */
-    final protected function set(string $attribute, $value): void
+    final protected function set(string $attribute, mixed $value): void
     {
         if (in_array($attribute, $this->attributes())) {
             $method = $this->getStringKey($attribute, 'set', 'Value');

src/Traits/HasEquality.php

@@ -46,5 +46,5 @@ protected function hash(): string
      *
      * @return string
      */
-    abstract function __toString();
+    abstract function __toString(): string;
 }

src/Traits/HasInvariants.php

@@ -24,7 +24,7 @@ final public static function invariants(): array
     {
         $invariants = [];
         foreach (get_class_methods(static::class) as $invariant) {
-            if (strpos($invariant, 'invariant') === 0 && $invariant !== 'invariants') {
+            if (str_starts_with($invariant, 'invariant') && $invariant !== 'invariants') {
                 $invariants[$invariant] = str_replace(
                     'invariant ',
                     '',
@@ -52,7 +52,7 @@ final public static function invariants(): array
      *
      * If exception is thrown the error message will be the exception message.
      *
-     * $onFail function must have following signature:
+     * $onFail function must have the following signature:
      *  fn(array<string, string>) => void
      *
      * @param  callable|null  $onFail
@@ -74,7 +74,7 @@ private function check(callable $onFail = null): void
             }
         }
 
-        if (count($violations) > 0) {
+        if (!empty($violations)) {
             if (is_null($onFail)) {
                 $customizedHandler = function (array $violations) use ($handler): void {
                     call_user_func_array([$this, $handler], [$violations]);

src/Traits/HasTypeCheck.php

@@ -20,7 +20,7 @@ trait HasTypeCheck
      *
      * @return bool
      */
-    protected function isValueTypeValid($value, string $validType): bool
+    protected function isValueTypeValid(mixed $value, string $validType): bool
     {
         if ($validType === 'mixed') {
             return true;
@@ -42,8 +42,8 @@ protected function isValueTypeValid($value, string $validType): bool
      *
      * @return bool
      */
-    protected function isValueTypeNotValid($value, string $validType): bool
+    protected function isValueTypeNotValid(mixed $value, string $validType): bool
     {
         return !$this->isValueTypeValid($value, $validType);
     }
-}
+}

src/Traits/IsAggregate.php

@@ -31,7 +31,7 @@ trait IsAggregate
      *
      * @return static
      */
-    protected function withOverrides(array $overrides)
+    protected function withOverrides(array $overrides): static
     {
         $new = $this->overrideEntity($overrides);
 

src/Traits/IsEntity.php

@@ -36,7 +36,7 @@ trait IsEntity
      *
      * @return static
      */
-    protected function withOverrides(array $overrides)
+    protected function withOverrides(array $overrides): static
     {
         return $this->overrideAttributes(
             filter(fn($value, string $key): bool => $key !== 'id', $overrides)

src/Traits/IsModel.php

@@ -4,6 +4,7 @@
 
 namespace ComplexHeart\Domain\Model\Traits;
 
+use ComplexHeart\Domain\Model\Exceptions\InstantiationException;
 use RuntimeException;
 use Doctrine\Instantiator\Instantiator;
 use Doctrine\Instantiator\Exception\ExceptionInterface;
@@ -27,7 +28,7 @@ trait IsModel
      *
      * @return static
      */
-    protected function initialize(array $source, callable $onFail = null)
+    protected function initialize(array $source, callable $onFail = null): static
     {
         $this->hydrate($this->mapSource($source));
         $this->check($onFail);
@@ -42,14 +43,14 @@ protected function initialize(array $source, callable $onFail = null)
      *
      * @throws RuntimeException
      */
-    final public static function make()
+    final public static function make(): static
     {
         try {
             return (new Instantiator())
                 ->instantiate(static::class)
                 ->initialize(func_get_args());
         } catch (ExceptionInterface $e) {
-            throw new RuntimeException($e->getMessage(), $e->getCode(), $e);
+            throw new InstantiationException($e->getMessage(), $e->getCode(), $e);
         }
     }
 
@@ -60,7 +61,7 @@ final public static function make()
      *
      * @return static
      */
-    protected function withOverrides(array $overrides)
+    protected function withOverrides(array $overrides): static
     {
         return self::make(...array_values(array_merge($this->values(), $overrides)));
     }

src/TypedCollection.php

@@ -52,7 +52,7 @@ public function __construct(array $items = [])
      *
      * @throws InvariantViolation
      */
-    protected function checkKeyType($key): void
+    protected function checkKeyType(mixed $key): void
     {
         $supported = ['string', 'integer'];
         if (!in_array($this->keyType, $supported)) {
@@ -73,7 +73,7 @@ protected function checkKeyType($key): void
      *
      * @throws InvariantViolation
      */
-    protected function checkValueType($item): void
+    protected function checkValueType(mixed $item): void
     {
         if ($this->isValueTypeNotValid($item, $this->valueType)) {
             throw new InvariantViolation("All items in the collection must be type of $this->valueType");
@@ -121,7 +121,7 @@ protected function invariantKeysAndValuesMustMatchTheRequiredType(): bool
      * @return static
      * @throws InvariantViolation
      */
-    public function push(...$values)
+    public function push(...$values): static
     {
         foreach ($values as $value) {
             $this->checkValueType($value);
@@ -138,7 +138,7 @@ public function push(...$values)
      *
      * @throws InvariantViolation
      */
-    public function offsetSet($key, $value): void
+    public function offsetSet(mixed $key, mixed $value): void
     {
         if ($this->keyType !== 'mixed') {
             $this->checkKeyType($key);
@@ -158,7 +158,7 @@ public function offsetSet($key, $value): void
      * @return static
      * @throws InvariantViolation
      */
-    public function prepend($value, $key = null)
+    public function prepend($value, $key = null): static
     {
         if ($this->keyType !== 'mixed') {
             $this->checkKeyType($key);
@@ -177,7 +177,7 @@ public function prepend($value, $key = null)
      * @return static
      * @throws InvariantViolation
      */
-    public function add($item)
+    public function add(mixed $item): static
     {
         $this->checkValueType($item);
 
@@ -192,7 +192,7 @@ public function add($item)
      *
      * @return Collection
      */
-    public function pluck($value, $key = null)
+    public function pluck($value, $key = null): Collection
     {
         return $this->toBase()->pluck($value, $key);
     }