Merge pull request #1 from michael-rubel/styling/pint

Use `Laravel Pint` instead of `PHP_CodeSniffer`

Author: michael-rubel

.github/workflows/phpstan.yml

@@ -7,8 +7,8 @@ on:
     branches: [main]
 
 jobs:
-  psalm:
-    name: phpstan
+  larastan:
+    name: "Running Larastan check"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -17,7 +17,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: '8.0'
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv
           coverage: none
 
       - name: Cache composer dependencies

.github/workflows/php-code-sniffer.yml renamed to .github/workflows/pint.yml

@@ -1,25 +1,21 @@
-name: php-code-sniffer
-
+name: "Laravel Pint"
 on:
-  push:
-    branches:
-      - main
   pull_request:
-    branches:
-      - main
+    types: [opened, synchronize, reopened, ready_for_review]
 
 jobs:
-  psalm:
-    name: phpcs
+  pint:
+    name: "Running Laravel Pint check"
     runs-on: ubuntu-latest
+    if: github.event.pull_request.draft == false
     steps:
       - uses: actions/checkout@v2
 
       - 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
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, intl, gd, exif, iconv
           coverage: none
 
       - name: Cache composer dependencies
@@ -31,5 +27,5 @@ jobs:
       - name: Run composer install
         run: composer install -n --prefer-dist
 
-      - name: Run phpcs
-        run: ./vendor/bin/phpcs
+      - name: Run Laravel Pint
+        run: ./vendor/bin/pint --test

composer.json

@@ -21,13 +21,13 @@
         "spatie/laravel-package-tools": "^1.9"
     },
     "require-dev": {
+        "brianium/paratest": "^6.3",
+        "laravel/pint": "^0.2.1",
+        "mockery/mockery": "^1.4.4",
         "nunomaduro/collision": "^5.10|^6.0",
         "nunomaduro/larastan": "^1.0",
-        "phpunit/phpunit": "^9.5",
         "orchestra/testbench": "^6.6|^7.0",
-        "brianium/paratest": "^6.3",
-        "mockery/mockery": "^1.4.4",
-        "squizlabs/php_codesniffer": "^3.6"
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {

phpcs.xml

@@ -0,0 +1,9 @@
+{
+  "preset": "laravel",
+  "rules": {
+    "Laravel/laravel_phpdoc_separation": false,
+    "concat_space": {
+      "spacing": "one"
+    }
+  }
+}

pint.json

@@ -12,7 +12,7 @@ class LoopFunctionServiceProvider extends PackageServiceProvider
     /**
      * Configure the package.
      *
-     * @param Package $package
+     * @param  Package  $package
      *
      * @return void
      */

src/LoopFunctionServiceProvider.php

@@ -9,9 +9,9 @@ trait HelpsLoopFunctions
     /**
      * Assign the value to the property or rescue.
      *
-     * @param int|string $key
-     * @param mixed      $value
-     * @param mixed|null $rescue
+     * @param  int|string  $key
+     * @param  mixed  $value
+     * @param  mixed|null  $rescue
      *
      * @return void
      * @throws \ReflectionException
@@ -28,7 +28,7 @@ private function assignValue(int|string $key, mixed $value, mixed $rescue = null
     }
 
     /**
-     * @param int|string $key
+     * @param  int|string  $key
      *
      * @return bool
      * @throws \ReflectionException
@@ -41,7 +41,7 @@ private function canAssignValue(int|string $key): bool
     }
 
     /**
-     * @param int|string $key
+     * @param  int|string  $key
      *
      * @return bool
      */
@@ -55,7 +55,7 @@ private function checksPropertyExists(int|string $key): bool
     }
 
     /**
-     * @param int|string $key
+     * @param  int|string  $key
      *
      * @return bool
      * @throws \ReflectionException
@@ -69,7 +69,7 @@ private function hasDefaultValue(int|string $key): bool
     }
 
     /**
-     * @param mixed $value
+     * @param  mixed  $value
      *
      * @return bool
      */

src/Traits/HelpsLoopFunctions.php

@@ -14,8 +14,8 @@ trait LoopFunctions
     /**
      * Choose proper strategy to loop over the data.
      *
-     * @param Model|\ArrayAccess|array|null $data
-     * @param mixed|null                    $rescue
+     * @param  Model|\ArrayAccess|array|null  $data
+     * @param  mixed|null  $rescue
      *
      * @return void
      */
@@ -32,8 +32,8 @@ public function propertiesFrom(Model|\ArrayAccess|array|null $data = null, mixed
     /**
      * Maps your model attributes to local class properties.
      *
-     * @param Model|null $model
-     * @param mixed      $rescue
+     * @param  Model|null  $model
+     * @param  mixed  $rescue
      *
      * @return void
      */
@@ -53,8 +53,8 @@ public function attributesToProperties(?Model $model = null, mixed $rescue = nul
     /**
      * Map array data to class properties.
      *
-     * @param array|\ArrayAccess|null $data
-     * @param mixed|null              $rescue
+     * @param  array|\ArrayAccess|null  $data
+     * @param  mixed|null  $rescue
      *
      * @return void
      */
@@ -74,9 +74,9 @@ public function arrayToProperties(array|\ArrayAccess|null $data, mixed $rescue =
     /**
      * Dump class properties as key-valued array.
      *
-     * @param string|object|null $class
-     * @param int|null           $filter
-     * @param bool               $asCollection
+     * @param  string|object|null  $class
+     * @param  int|null  $filter
+     * @param  bool  $asCollection
      *
      * @return array|Collection
      * @throws \ReflectionException

src/Traits/LoopFunctions.php

@@ -5,7 +5,7 @@
 trait WithDynamicProperties
 {
     /**
-     * @param string $name
+     * @param  string  $name
      *
      * @return mixed
      */
@@ -15,8 +15,8 @@ public function __get(string $name): mixed
     }
 
     /**
-     * @param string $name
-     * @param mixed  $value
+     * @param  string  $name
+     * @param  mixed  $value
      *
      * @return void
      */

src/Traits/WithDynamicProperties.php

@@ -11,11 +11,17 @@ class ArrayMappingTest extends TestCase
     use LoopFunctions;
 
     public bool $test = false;
+
     public ?string $name = null;
+
     public ?string $password = null;
+
     public ?array $additional_data = [];
+
     public ?array $array = [];
+
     public ?Collection $supportCollection = null;
+
     public ?EloquentCollection $eloquentCollection = null;
 
     public function setUp(): void
@@ -76,7 +82,6 @@ public function testAlreadyInitializedPropertiesArentOverridenByNestedArrays()
             ],
         ];
 
-
         $this->arrayToProperties($array);
 
         $this->assertStringContainsString('Michael', $this->name);