Merge pull request #8 from maartenpaauw/develop

maartenpaauw · web-flow · commit b0d519c8b80b · 2023-03-21T22:41:56.000+01:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,12 +1,32 @@
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
 version: 2
+
 updates:
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "07:00"
+      timezone: "Europe/Amsterdam"
+    labels:
+      - "dependencies"
+      - "composer"
+    assignees:
+      - "maartenpaauw"
+    reviewers:
+      - "maartenpaauw"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+      day: "monday"
+      time: "07:00"
+      timezone: "Europe/Amsterdam"
     labels:
-      - "dependencies"
+      - "dependencies"
+      - "github-actions"
+    assignees:
+      - "maartenpaauw"
+    reviewers:
+      - "maarten"
diff --git a/.github/workflows/code-coverage.yml b/.github/workflows/code-coverage.yml
@@ -0,0 +1,44 @@
+name: code-coverage
+
+on:
+  push:
+    branches:
+      - develop
+      - main
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Code coverage
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: xdebug
+
+      - name: Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: vendor/bin/pest --coverage --coverage-clover coverage.xml
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          files: coverage.xml
+          fail_ci_if_error: true
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.head_ref }}
 
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -11,7 +11,7 @@ jobs:
     name: phpstan
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -13,20 +13,20 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [8.0, 8.1]
-        laravel: [8.*, 9.*]
+        php: [8.1, 8.2]
+        laravel: [9.*, 10.*]
         stability: [prefer-lowest, prefer-stable]
         include:
-          - laravel: 8.*
-            testbench: ^6.23
           - laravel: 9.*
             testbench: ^7.1
+          - laravel: 10.*
+            testbench: ^8.0.10
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ testbench.yaml
 vendor
 node_modules
 .php-cs-fixer.cache
+coverage.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 All notable changes to `laravel-specification-pattern` will be documented in this file.
 
+## [v2.0.0] - 2023-03-21
+
+### Added
+
+- Support from Laravel 10.
+
+### Changed
+
+- Renamed `SpecificationException` to `DissatisfiedSpecification` and extend from `DomainException`.
+- Marked the following classes as final:
+  - `AndSpecification`.
+  - `NotSpecification`.
+  - `OrSpecification`.
+  - `VerboseSpecification`.
+
+### Removed
+
+- Support for PHP 8.
+- Support for Laravel 8.
+
 ## [v1.1.0] - 2022-03-07
 
 ### Added
@@ -12,5 +32,6 @@ All notable changes to `laravel-specification-pattern` will be documented in thi
 
 - initial release
 
+[v2.0.0]: https://github.com/maartenpaauw/laravel-specification-pattern/compare/v1.1.0...v2.0.0
 [v1.1.0]: https://github.com/maartenpaauw/laravel-specification-pattern/compare/v1.0.0...v1.1.0
 [v1.0.0]: https://github.com/maartenpaauw/laravel-specification-pattern/releases/tag/v1.0.0
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # Laravel specification pattern
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/maartenpaauw/laravel-specification-pattern.svg?style=flat-square)](https://packagist.org/packages/maartenpaauw/laravel-specification-pattern)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/maartenpaauw/laravel-specification-pattern/run-tests?label=tests)](https://github.com/maartenpaauw/laravel-specification-pattern/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/maartenpaauw/laravel-specification-pattern/Check%20&%20fix%20styling?label=code%20style)](https://github.com/maartenpaauw/laravel-specification-pattern/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/maartenpaauw/laravel-specification-pattern/run-tests.yml?label=tests)](https://github.com/maartenpaauw/laravel-specification-pattern/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/maartenpaauw/laravel-specification-pattern/php-cs-fixer.yml?label=code%20style)](https://github.com/maartenpaauw/laravel-specification-pattern/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![Codecov](https://codecov.io/gh/maartenpaauw/laravel-specification-pattern/branch/develop/graph/badge.svg?token=YM9A0DUA4R)](https://codecov.io/gh/maartenpaauw/laravel-specification-pattern)
 [![Total Downloads](https://img.shields.io/packagist/dt/maartenpaauw/laravel-specification-pattern.svg?style=flat-square)](https://packagist.org/packages/maartenpaauw/laravel-specification-pattern)
 
 Filter an Illuminate collection with specifications.
diff --git a/composer.json b/composer.json
@@ -18,12 +18,12 @@
     "require": {
         "php": "^8.0",
         "spatie/laravel-package-tools": "^1.9.2",
-        "illuminate/contracts": "^8.83|^9.2"
+        "illuminate/contracts": "^9.33|^10.4"
     },
     "require-dev": {
         "nunomaduro/collision": "^5.11|^6.1",
-        "nunomaduro/larastan": "^1.0",
-        "orchestra/testbench": "^6.22",
+        "nunomaduro/larastan": "^1.0|^2.1",
+        "orchestra/testbench": "^6.22|^7.0",
         "pestphp/pest": "^1.21",
         "pestphp/pest-plugin-laravel": "^1.1",
         "phpstan/extension-installer": "^1.1",
@@ -46,7 +46,7 @@
     "scripts": {
         "analyse": "vendor/bin/phpstan analyse",
         "test": "vendor/bin/pest",
-        "test-coverage": "vendor/bin/pest coverage"
+        "test-coverage": "vendor/bin/pest --coverage"
     },
     "config": {
         "sort-packages": true,
diff --git a/config/specification-pattern.php b/config/specification-pattern.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     'collection-method' => 'matching',
 ];
diff --git a/src/AndSpecification.php b/src/AndSpecification.php
@@ -6,21 +6,19 @@
 
 /**
  * @template TCandidate
+ *
  * @extends CompositeSpecification<TCandidate>
  */
-class AndSpecification extends CompositeSpecification
+final class AndSpecification extends CompositeSpecification
 {
     /**
-     * @param array<Specification<TCandidate>> $specifications
+     * @param array<array-key, Specification<TCandidate>> $specifications
      */
     public function __construct(
         private array $specifications,
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function isSatisfiedBy(mixed $candidate): bool
     {
         foreach ($this->specifications as $specification) {
diff --git a/src/Commands/MakeSpecificationCommand.php b/src/Commands/MakeSpecificationCommand.php
@@ -7,28 +7,47 @@
 use Illuminate\Console\GeneratorCommand;
 use Symfony\Component\Console\Input\InputOption;
 
-class MakeSpecificationCommand extends GeneratorCommand
+final class MakeSpecificationCommand extends GeneratorCommand
 {
-    public $name = 'make:specification';
-
-    public $description = 'Create a new specification class';
-
+    /**
+     * @var string
+     */
+    protected $name = 'make:specification';
+
+    /**
+     * @var string
+     */
+    protected $description = 'Create a new specification class';
+
+    /**
+     * @var string
+     */
     protected $type = 'Specification';
 
     protected function getStub(): string
     {
         if ($this->option('composite')) {
-            return $this->resolveStubPath('/stubs/specification-composite.stub');
+            return $this->resolveStubPath(
+                '/stubs/specification-composite.stub',
+            );
         }
 
-        return $this->resolveStubPath('/stubs/specification.stub');
+        return $this->resolveStubPath(
+            '/stubs/specification.stub',
+        );
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function getDefaultNamespace($rootNamespace): string
     {
         return sprintf('%s\Specifications', $rootNamespace);
     }
 
+    /**
+     * @inheritDoc
+     */
     protected function buildClass($name): string
     {
         $replacements = [
@@ -42,6 +61,9 @@ protected function buildClass($name): string
         );
     }
 
+    /**
+     * @return array<int, InputOption>
+     */
     protected function getOptions(): array
     {
         $composite = new InputOption(
diff --git a/src/CompositeSpecification.php b/src/CompositeSpecification.php
@@ -6,6 +6,7 @@
 
 /**
  * @template TCandidate
+ *
  * @implements Specification<TCandidate>
  */
 abstract class CompositeSpecification implements Specification
diff --git a/src/DissatisfiedSpecification.php b/src/DissatisfiedSpecification.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Maartenpaauw\Specifications;
+
+use DomainException;
+
+final class DissatisfiedSpecification extends DomainException
+{
+}
diff --git a/src/Laravel/CollectionMatchingMacro.php b/src/Laravel/CollectionMatchingMacro.php
@@ -9,16 +9,21 @@
 use Maartenpaauw\Specifications\Specification;
 
 /**
- * @mixin Collection
+ * @template TKey of array-key
+ * @template TValue
+ *
+ * @mixin Collection<TKey, TValue>
  */
-class CollectionMatchingMacro
+final class CollectionMatchingMacro
 {
     public function __invoke(): Closure
     {
         return function (Specification $specification) {
-            return $this->filter(static function ($candidate) use ($specification): bool {
-                return $specification->isSatisfiedBy($candidate);
-            });
+            return $this->filter(
+                static function ($candidate) use ($specification): bool {
+                    return $specification->isSatisfiedBy($candidate);
+                },
+            );
         };
     }
 }
diff --git a/src/NotSpecification.php b/src/NotSpecification.php
@@ -6,9 +6,10 @@
 
 /**
  * @template TCandidate
+ *
  * @extends CompositeSpecification<TCandidate>
  */
-class NotSpecification extends CompositeSpecification
+final class NotSpecification extends CompositeSpecification
 {
     /**
      * @param Specification<TCandidate> $specification
@@ -18,9 +19,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function isSatisfiedBy(mixed $candidate): bool
     {
         return ! $this->specification->isSatisfiedBy($candidate);
diff --git a/src/OrSpecification.php b/src/OrSpecification.php
@@ -6,21 +6,19 @@
 
 /**
  * @template TCandidate
+ *
  * @extends CompositeSpecification<TCandidate>
  */
-class OrSpecification extends CompositeSpecification
+final class OrSpecification extends CompositeSpecification
 {
     /**
-     * @param array<Specification<TCandidate>> $specifications
+     * @param array<array-key, Specification<TCandidate>> $specifications
      */
     public function __construct(
         private array $specifications,
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function isSatisfiedBy(mixed $candidate): bool
     {
         foreach ($this->specifications as $specification) {
diff --git a/src/SpecificationException.php b/src/SpecificationException.php
diff --git a/src/SpecificationsServiceProvider.php b/src/SpecificationsServiceProvider.php
diff --git a/src/VerboseSpecification.php b/src/VerboseSpecification.php
diff --git a/tests/Dummy/LengthSpecification.php b/tests/Dummy/LengthSpecification.php
diff --git a/tests/VerboseSpecificationTest.php b/tests/VerboseSpecificationTest.php

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,10 @@`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* @template TCandidate`
	`9`	`+ *`
`9`	`10`	`* @extends CompositeSpecification<TCandidate>`
`10`	`11`	`*/`
`11`		`-class NotSpecification extends CompositeSpecification`
	`12`	`+final class NotSpecification extends CompositeSpecification`
`12`	`13`	`{`
`13`	`14`	`/**`
`14`	`15`	`* @param Specification<TCandidate> $specification`
`@@ -18,9 +19,6 @@ public function __construct(`
`18`	`19`	`) {`
`19`	`20`	`}`
`20`	`21`
`21`		`- /**`
`22`		`- * @inheritDoc`
`23`		`- */`
`24`	`22`	`public function isSatisfiedBy(mixed $candidate): bool`
`25`	`23`	`{`
`26`	`24`	`return ! $this->specification->isSatisfiedBy($candidate);`