Adds duster as the linter

.github/workflows/duster-lint.yml

@@ -0,0 +1,17 @@
+name: Duster Lint
+
+on:
+    push:
+        branches: [ main ]
+    pull_request:
+
+jobs:
+  duster:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Duster Lint"
+        uses: tighten/duster-action@v2
+        with:
+          args: lint

.github/workflows/tests.yml

@@ -44,6 +44,7 @@ jobs:
       - name: Install Dependencies
         run: |
           composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "symfony/console:>=4.3.4" --no-interaction --no-update
+          composer remove "tightenco/duster" --dev --no-interaction --no-update
           composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
       - name: Execute Tests
         run: ./vendor/bin/phpunit --testdox

composer.json

@@ -23,7 +23,8 @@
     },
     "require-dev": {
         "orchestra/testbench": "^7.0||^8.0",
-        "phpunit/phpunit": "^9.5.10||^10.0"
+        "phpunit/phpunit": "^9.5.10||^10.0",
+        "tightenco/duster": "^2.7"
     },
     "autoload": {
         "psr-4": {
@@ -35,5 +36,9 @@
             "Parental\\Tests\\": "tests/",
             "Database\\Factories\\": "tests/factories/"
         }
+    },
+    "scripts": {
+        "lint": "vendor/bin/duster lint",
+        "fix": "vendor/bin/duster fix"
     }
 }

src/HasChildren.php

@@ -7,6 +7,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Str;
+use UnitEnum;
 
 trait HasChildren
 {
@@ -24,8 +25,7 @@ trait HasChildren
      * Register a model event with the dispatcher.
      *
      * @param  string  $event
-     * @param Closure|string  $callback
-     * @return void
+     * @param  Closure|string  $callback
      */
     protected static function registerModelEvent($event, $callback): void
     {
@@ -46,16 +46,13 @@ protected static function registerModelEvent($event, $callback): void
         }
     }
 
-    /**
-     * @return bool
-     */
     protected static function parentIsBooting(): bool
     {
         if (! isset(self::$parentBootMethods)) {
             self::$parentBootMethods[] = 'boot';
 
             foreach (class_uses_recursive(self::class) as $trait) {
-                self::$parentBootMethods[] = 'boot'.class_basename($trait);
+                self::$parentBootMethods[] = 'boot' . class_basename($trait);
             }
 
             self::$parentBootMethods = array_flip(self::$parentBootMethods);
@@ -131,14 +128,13 @@ public function newFromBuilder($attributes = [], $connection = null): self
      * @param  string|null  $foreignKey
      * @param  string|null  $ownerKey
      * @param  string|null  $relation
-     * @return BelongsTo
      */
     public function belongsTo($related, $foreignKey = null, $ownerKey = null, $relation = null): BelongsTo
     {
         $instance = $this->newRelatedInstance($related);
 
         if (is_null($foreignKey) && $instance->hasParent) {
-            $foreignKey = Str::snake($instance->getClassNameForRelationships()).'_'.$instance->getKeyName();
+            $foreignKey = Str::snake($instance->getClassNameForRelationships()) . '_' . $instance->getKeyName();
         }
 
         if (is_null($relation)) {
@@ -154,7 +150,6 @@ public function belongsTo($related, $foreignKey = null, $ownerKey = null, $relat
      * @param  string  $related
      * @param  string|null  $foreignKey
      * @param  string|null  $localKey
-     * @return HasMany
      */
     public function hasMany($related, $foreignKey = null, $localKey = null): HasMany
     {
@@ -171,7 +166,6 @@ public function hasMany($related, $foreignKey = null, $localKey = null): HasMany
      * @param  string|null  $parentKey
      * @param  string|null  $relatedKey
      * @param  string|null  $relation
-     * @return BelongsToMany
      */
     public function belongsToMany(
         $related, $table = null,
@@ -198,45 +192,25 @@ public function belongsToMany(
         );
     }
 
-    /**
-     * @return string
-     */
     public function getClassNameForRelationships(): string
     {
         return class_basename($this);
     }
 
-    /**
-     * @return string
-     */
     public function getInheritanceColumn(): string
     {
         return property_exists($this, 'childColumn') ? $this->childColumn : 'type';
     }
 
     /**
-     * @param array $attributes
-     * @return mixed
-     */
-    protected function getChildModel(array $attributes)
-    {
-        $className = $this->classFromAlias(
-            $attributes[$this->getInheritanceColumn()]
-        );
-
-        return new $className((array) $attributes);
-    }
-
-    /**
-     * @param mixed $aliasOrClass
-     * @return string
+     * @param  mixed  $aliasOrClass
      */
     public function classFromAlias($aliasOrClass): string
     {
         $childTypes = $this->getChildTypes();
 
         // Handling Enum casting for `type` column
-        if ($aliasOrClass instanceof \UnitEnum) {
+        if ($aliasOrClass instanceof UnitEnum) {
             $aliasOrClass = $aliasOrClass->value;
         }
 
@@ -247,10 +221,6 @@ public function classFromAlias($aliasOrClass): string
         return $aliasOrClass;
     }
 
-    /**
-     * @param string $className
-     * @return string
-     */
     public function classToAlias(string $className): string
     {
         $childTypes = $this->getChildTypes();
@@ -262,9 +232,6 @@ public function classToAlias(string $className): string
         return $className;
     }
 
-    /**
-     * @return array
-     */
     public function getChildTypes(): array
     {
         if (method_exists($this, 'childTypes')) {
@@ -277,4 +244,16 @@ public function getChildTypes(): array
 
         return [];
     }
+
+    /**
+     * @return mixed
+     */
+    protected function getChildModel(array $attributes)
+    {
+        $className = $this->classFromAlias(
+            $attributes[$this->getInheritanceColumn()]
+        );
+
+        return new $className((array) $attributes);
+    }
 }

src/HasParent.php

@@ -3,9 +3,9 @@
 namespace Parental;
 
 use Illuminate\Database\Eloquent\Model;
-use ReflectionClass;
-use Illuminate\Support\Str;
 use Illuminate\Events\Dispatcher;
+use Illuminate\Support\Str;
+use ReflectionClass;
 use ReflectionException;
 
 trait HasParent
@@ -16,14 +16,13 @@ trait HasParent
     public $hasParent = true;
 
     /**
-     * @return void
      * @throws ReflectionException
      */
     public static function bootHasParent(): void
     {
         // This adds support for using Parental with standalone Eloquent, outside a normal Laravel app.
         if (static::getEventDispatcher() === null) {
-            static::setEventDispatcher(new Dispatcher());
+            static::setEventDispatcher(new Dispatcher);
         }
 
         static::creating(function ($model) {
@@ -38,21 +37,17 @@ public static function bootHasParent(): void
             $instance = new static;
 
             if ($instance->parentHasHasChildrenTrait()) {
-                $query->where($query->getModel()->getTable().'.'.$instance->getInheritanceColumn(), $instance->classToAlias(get_class($instance)));
+                $query->where($query->getModel()->getTable() . '.' . $instance->getInheritanceColumn(), $instance->classToAlias(get_class($instance)));
             }
         });
     }
 
-    /**
-     * @return bool
-     */
     public function parentHasHasChildrenTrait(): bool
     {
         return $this->hasChildren ?? false;
     }
 
     /**
-     * @return string
      * @throws ReflectionException
      */
     public function getTable(): string
@@ -65,18 +60,17 @@ public function getTable(): string
     }
 
     /**
-     * @return string
      * @throws ReflectionException
      */
     public function getForeignKey(): string
     {
-        return Str::snake(class_basename($this->getParentClass())).'_'.$this->primaryKey;
+        return Str::snake(class_basename($this->getParentClass())) . '_' . $this->primaryKey;
     }
 
     /**
-     * @param string $related
-     * @param null|Model $instance
-     * @return string
+     * @param  string  $related
+     * @param  null|Model  $instance
+     *
      * @throws ReflectionException
      */
     public function joiningTable($related, $instance = null): string
@@ -96,7 +90,6 @@ public function joiningTable($related, $instance = null): string
     }
 
     /**
-     * @return string
      * @throws ReflectionException
      */
     public function getClassNameForRelationships(): string
@@ -107,7 +100,6 @@ public function getClassNameForRelationships(): string
     /**
      * Get the class name for polymorphic relations.
      *
-     * @return string
      * @throws ReflectionException
      */
     public function getMorphClass(): string
@@ -120,28 +112,13 @@ public function getMorphClass(): string
     /**
      * Get the class name for poly-type collections
      *
-     * @return string
      * @throws ReflectionException
      */
     public function getClassNameForSerialization(): string
     {
         return $this->getParentClass();
     }
 
-    /**
-     * Get the class name for Parent Class.
-     *
-     * @return string
-     * @throws ReflectionException
-     */
-    protected function getParentClass(): string
-    {
-        static $parentClassName;
-
-        return $parentClassName ?: $parentClassName = (new ReflectionClass($this))->getParentClass()->getName();
-    }
-
-
     /**
      * Merge the fillable attributes for the model with those of its Parent Class
      *
@@ -156,7 +133,19 @@ public function getFillable()
             return $this->fillable;
         }
         $parentFillable = (new $parentClass)->getFillable();
-        
+
         return array_unique(array_merge($parentFillable, $this->fillable));
     }
+
+    /**
+     * Get the class name for Parent Class.
+     *
+     * @throws ReflectionException
+     */
+    protected function getParentClass(): string
+    {
+        static $parentClassName;
+
+        return $parentClassName ?: $parentClassName = (new ReflectionClass($this))->getParentClass()->getName();
+    }
 }

src/Providers/NovaResourceProvider.php

@@ -9,9 +9,6 @@
 
 class NovaResourceProvider extends ServiceProvider
 {
-    /**
-     * @return void
-     */
     public function boot(): void
     {
         if (class_exists(Nova::class)) {
@@ -21,9 +18,6 @@ public function boot(): void
         }
     }
 
-    /**
-     * @return void
-     */
     protected function setNovaResources(): void
     {
         $map = [];

tests/Features/AuthUserMethodReturnsChildModel.php

@@ -2,15 +2,12 @@
 
 namespace Parental\Tests\Features;
 
-use Parental\Tests\Models\Car;
-use Parental\Tests\Models\Plane;
-use Parental\Tests\Models\Vehicle;
 use Parental\Tests\TestCase;
 
 class AuthUserMethodReturnsChildModel extends TestCase
 {
     /** @test */
-    function auth_user_returns_child_model_if_it_exists()
+    public function auth_user_returns_child_model_if_it_exists()
     {
         Admin::create();
         User::create();

tests/Features/ChildModelFillablesMergeWithParentModelFillablesTest.php

@@ -9,7 +9,7 @@
 class ChildModelFillablesMergeWithParentModelFillablesTest extends TestCase
 {
     /** @test */
-    function child_fillables_are_merged_with_parent_fillables()
+    public function child_fillables_are_merged_with_parent_fillables()
     {
         $workshop = Workshop::create([
             'name' => 'Scaling Laravel',