[Refactor] Update new to-one and to-many rule objects

Author: lindyhopchris

docs/basics/validators.md

@@ -245,11 +245,22 @@ protected function rules($record = null): array
 }
 ```
 
-The `Rule::hasOne()` and `Rule::hasMany()` methods accept a list of resource types for polymorphic relationships.
-They also return rule objects that have methods to determine whether empty relationships are acceptable.
-Use the `required()` method to indicate that an empty value is not acceptable, or use the `allowEmpty($bool)`
-method to toggle whether empty values are allowed. If neither method is called, the rule *will* accept
-an empty value.
+The `HasOne` and `HasMany` rules accept a list of resource types for polymorphic relationships. If no
+type is provided to the constructor, then the plural form of the attribute name will be used. For
+example:
+
+```php
+protected function rules($record = null): array
+{
+    return [
+        'author' => [
+            'required',
+            new HasOne(), // expects 'authors' resources
+        ],
+        'tags' => new HasMany(), // expects 'tags' resources
+    ];
+}
+```
 
 ### Updating Resources
 

src/Rules/HasMany.php

@@ -16,10 +16,8 @@ protected function accept(?array $data): bool
             return false;
         }
 
-        if (empty($data) && $this->acceptsNone()) {
+        if (empty($data)) {
             return true;
-        } else if (empty($data)) {
-            return false;
         }
 
         if (Arr::isAssoc($data)) {

src/Rules/HasOne.php

@@ -2,8 +2,8 @@
 
 namespace CloudCreativity\LaravelJsonApi\Rules;
 
-use CloudCreativity\LaravelJsonApi\Utils\Str;
 use Illuminate\Contracts\Validation\Rule;
+use Illuminate\Support\Str;
 
 class HasOne implements Rule
 {
@@ -13,11 +13,6 @@ class HasOne implements Rule
      */
     private $types;
 
-    /**
-     * @var bool
-     */
-    private $allowEmpty;
-
     /**
      * HasOne constructor.
      *
@@ -27,30 +22,6 @@ class HasOne implements Rule
     public function __construct(string ...$types)
     {
         $this->types = $types;
-        $this->allowEmpty();
-    }
-
-    /**
-     * Set whether an empty `has-one` relationship is allowed.
-     *
-     * @param bool $bool
-     * @return $this
-     */
-    public function allowEmpty(bool $bool = true): self
-    {
-        $this->allowEmpty = $bool;
-
-        return $this;
-    }
-
-    /**
-     * Set a related resource to always be required.
-     *
-     * @return $this
-     */
-    public function required(): self
-    {
-        return $this->allowEmpty(false);
     }
 
     /**
@@ -62,6 +33,10 @@ public function passes($attribute, $value)
             return false;
         }
 
+        if (empty($this->types)) {
+            $this->types = [Str::plural($attribute)];
+        }
+
         return $this->accept($value);
     }
 
@@ -70,7 +45,7 @@ public function passes($attribute, $value)
      */
     public function message()
     {
-        $key = 'jsonapi::validation.' . Str::underscore(class_basename($this));;
+        $key = 'jsonapi::validation.' . Str::snake(class_basename($this));;
 
         return trans($key, [
             'types' => collect($this->types)->implode(', '),
@@ -85,7 +60,7 @@ public function message()
      */
     protected function accept(?array $data): bool
     {
-        if (is_null($data) && $this->acceptsNone()) {
+        if (is_null($data)) {
             return true;
         }
 
@@ -103,12 +78,4 @@ protected function acceptType($data): bool
         );
     }
 
-    /**
-     * @return bool
-     */
-    protected function acceptsNone(): bool
-    {
-        return $this->allowEmpty;
-    }
-
 }

src/Validation/Rule.php

@@ -17,8 +17,8 @@
 
 namespace CloudCreativity\LaravelJsonApi\Tests\Unit\Validation\Rules;
 
+use CloudCreativity\LaravelJsonApi\Rules\HasMany;
 use CloudCreativity\LaravelJsonApi\Tests\Unit\TestCase;
-use CloudCreativity\LaravelJsonApi\Validation\Rule;
 
 class HasManyTest extends TestCase
 {
@@ -102,11 +102,24 @@ public function invalidProvider(): array
     public function testValid($types, $value): void
     {
         $types = (array) $types;
-        $rule = Rule::hasMany(...$types);
+        $rule = new HasMany(...$types);
 
         $this->assertTrue($rule->passes('authors', $value));
     }
 
+    public function testValidWithAttributeName(): void
+    {
+        $rule = new HasMany();
+
+        $this->assertTrue($rule->passes('tags', [
+            ['type' => 'tags', 'id' => '1'],
+        ]));
+
+        $this->assertFalse($rule->passes('tags', [
+            ['type' => 'users', 'id' => '1'],
+        ]));
+    }
+
     /**
      * @param $types
      * @param $value
@@ -115,31 +128,9 @@ public function testValid($types, $value): void
     public function testInvalid($types, $value): void
     {
         $types = (array) $types;
-        $rule = Rule::hasMany(...$types);
+        $rule = new HasMany(...$types);
 
         $this->assertFalse($rule->passes('authors', $value));
     }
 
-    public function testAllowEmpty(): void
-    {
-        $this->assertFalse(
-            Rule::hasMany('users')->required()->passes('authors', []),
-            'required'
-        );
-
-        $this->assertTrue(
-            Rule::hasMany('users')->allowEmpty(true)->passes('authors', []),
-            'allows empty'
-        );
-
-        $this->assertFalse(
-            Rule::hasMany('users')->allowEmpty(false)->passes('authors', []),
-            'does not allow empty'
-        );
-
-        $this->assertFalse(
-            Rule::hasMany('users')->allowEmpty(true)->passes('authors', null),
-            'rejects empty has-one when empty allowed'
-        );
-    }
 }

tests/lib/Unit/Validation/Rules/HasManyTest.php

@@ -2,8 +2,8 @@
 
 namespace CloudCreativity\LaravelJsonApi\Tests\Unit\Validation\Rules;
 
+use CloudCreativity\LaravelJsonApi\Rules\HasOne;
 use CloudCreativity\LaravelJsonApi\Tests\Unit\TestCase;
-use CloudCreativity\LaravelJsonApi\Validation\Rule;
 
 class HasOneTest extends TestCase
 {
@@ -72,11 +72,19 @@ public function invalidProvider(): array
     public function testValid($types, $value): void
     {
         $types = (array) $types;
-        $rule = Rule::hasOne(...$types);
+        $rule = new HasOne(...$types);
 
         $this->assertTrue($rule->passes('author', $value));
     }
 
+    public function testValidWithAttributeName(): void
+    {
+        $rule = new HasOne();
+
+        $this->assertTrue($rule->passes('author', ['type' => 'authors', 'id' => '1']));
+        $this->assertFalse($rule->passes('author', ['type' => 'users', 'id' => '1']));
+    }
+
     /**
      * @param $types
      * @param $value
@@ -85,31 +93,8 @@ public function testValid($types, $value): void
     public function testInvalid($types, $value): void
     {
         $types = (array) $types;
-        $rule = Rule::hasOne(...$types);
+        $rule = new HasOne(...$types);
 
         $this->assertFalse($rule->passes('author', $value));
     }
-
-    public function testAllowEmpty(): void
-    {
-        $this->assertFalse(
-            Rule::hasOne('users')->required()->passes('author', null),
-            'required'
-        );
-
-        $this->assertTrue(
-            Rule::hasOne('users')->allowEmpty(true)->passes('author', null),
-            'allows empty'
-        );
-
-        $this->assertFalse(
-            Rule::hasOne('users')->allowEmpty(false)->passes('author', null),
-            'does not allow empty'
-        );
-
-        $this->assertFalse(
-            Rule::hasOne('users')->allowEmpty(true)->passes('author', []),
-            'rejects empty has-many when empty allowed'
-        );
-    }
 }