Merge pull request #10 from Lendable/merge-upstream

Author: pamil

.github/workflows/architectural-rules.yml

@@ -0,0 +1,19 @@
+name: Architectural test
+
+on:
+    push:
+
+jobs:
+    phparkitect:
+        name: PHPArkitect
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: "Checkout"
+              uses: actions/checkout@v2
+
+            - name: PHPArkitect
+              uses: docker://phparkitect/arkitect-github-actions:latest
+              with:
+                  args: check

.github/workflows/build.yml

@@ -11,8 +11,9 @@ jobs:
   build:
     runs-on: "ubuntu-22.04"
     strategy:
+      fail-fast: false
       matrix:
-        php-versions: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
+        php-versions: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
         coverage-driver: [ 'pcov' ]
 
     steps:
@@ -55,4 +56,3 @@ jobs:
       uses: codecov/codecov-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
-

CONTRIBUTORS.md

@@ -4,24 +4,30 @@ Shout out to our top contributors!
 
 - [AlessandroMinoccheri](https://api.github.com/users/AlessandroMinoccheri)
 - [fain182](https://api.github.com/users/fain182)
-- [micheleorselli](https://api.github.com/users/micheleorselli)
 - [pfazzi](https://api.github.com/users/pfazzi)
 - [github-actions[bot]](https://api.github.com/users/github-actions%5Bbot%5D)
-- [ricfio](https://api.github.com/users/ricfio)
+- [micheleorselli](https://api.github.com/users/micheleorselli)
 - [sebastianstucke87](https://api.github.com/users/sebastianstucke87)
+- [ricfio](https://api.github.com/users/ricfio)
 - [szepeviktor](https://api.github.com/users/szepeviktor)
 - [JulienRAVIA](https://api.github.com/users/JulienRAVIA)
+- [helyakin](https://api.github.com/users/helyakin)
+- [ben-challis](https://api.github.com/users/ben-challis)
 - [LuigiCardamone](https://api.github.com/users/LuigiCardamone)
 - [annervisser](https://api.github.com/users/annervisser)
 - [simivar](https://api.github.com/users/simivar)
-- [stephpy](https://api.github.com/users/stephpy)
-- [dbu](https://api.github.com/users/dbu)
 - [jdomenechbLendable](https://api.github.com/users/jdomenechbLendable)
+- [dbu](https://api.github.com/users/dbu)
+- [stephpy](https://api.github.com/users/stephpy)
+- [marmichalski](https://api.github.com/users/marmichalski)
+- [hgraca](https://api.github.com/users/hgraca)
 - [frankverhoeven](https://api.github.com/users/frankverhoeven)
 - [hectorespert](https://api.github.com/users/hectorespert)
 - [jerowork](https://api.github.com/users/jerowork)
 - [jkrzefski](https://api.github.com/users/jkrzefski)
 - [mloru](https://api.github.com/users/mloru)
+- [nikow13](https://api.github.com/users/nikow13)
 - [OskarStark](https://api.github.com/users/OskarStark)
 - [smortexa](https://api.github.com/users/smortexa)
 - [DonCallisto](https://api.github.com/users/DonCallisto)
+- [notcgi](https://api.github.com/users/notcgi)

README.md

@@ -236,6 +236,8 @@ $rules[] = Rule::allClasses()
     ->that(new ResideInOneOfTheseNamespaces('App\Controller'))
     ->should(new Extend('App\Controller\AbstractController'))
     ->because('we want to be sure that all controllers extend AbstractController');
+
+You can add multiple parameters, the violation will happen when none of them match
 ```
 
 ### Has an attribute (requires PHP >= 8.0)
@@ -301,6 +303,15 @@ $rules[] = Rule::allClasses()
     ->because('we want to be sure that aggregates are final classes');
 ```
 
+### Is readonly
+
+```php
+$rules[] = Rule::allClasses()
+    ->that(new ResideInOneOfTheseNamespaces('App\Domain\ValueObjects'))
+    ->should(new IsReadonly())
+    ->because('we want to be sure that value objects are readonly classes');
+```
+
 ### Is interface
 
 ```php
@@ -346,6 +357,15 @@ $rules[] = Rule::allClasses()
     ->because('we want to be sure that our adapters are not final classes');
 ```
 
+### Is not readonly
+
+```php
+$rules[] = Rule::allClasses()
+    ->that(new ResideInOneOfTheseNamespaces('App\Domain\Entity'))
+    ->should(new IsNotReadonly())
+    ->because('we want to be sure that there are no readonly entities');
+```
+
 ### Is not interface
 
 ```php
@@ -380,14 +400,16 @@ $rules[] = Rule::allClasses()
     ->that(new ResideInOneOfTheseNamespaces('App\Controller\Admin'))
     ->should(new NotExtend('App\Controller\AbstractController'))
     ->because('we want to be sure that all admin controllers not extend AbstractController for security reasons');
+
+You can add multiple parameters, the violation will happen when one of them match
 ```
 
 ### Don't have dependency outside a namespace
 
 ```php
 $rules[] = Rule::allClasses()
     ->that(new ResideInOneOfTheseNamespaces('App\Domain'))
-    ->should(new NotHaveDependencyOutsideNamespace('App\Domain', ['Ramsey\Uuid']))
+    ->should(new NotHaveDependencyOutsideNamespace('App\Domain', ['Ramsey\Uuid'], true))
     ->because('we want protect our domain except for Ramsey\Uuid');
 ```