Use laravel helpers

Author: JacobFitzp

README.md

@@ -35,90 +35,80 @@ You can install the package via composer:
 composer require jacobfitzp/laravel-tiptap-validation
 ```
 
-And then add the below service provider to `config/app.php`
+And then add the service provider to `config/app.php`
 ```php
-JacobFitzp\LaravelTiptapValidation\TiptapValidationServiceProvider::class
+JacobFitzp\LaravelTiptapValidation\TiptapValidationServiceProvider::class,
 ```
 
 ## Usage
 
-### TiptapContent
+### Content
 
 The `TiptapContent` rule is used to validate the basic structure and format, as well as limit what nodes and marks are allowed.
 
 Simply call `TiptapValidation::content()` within your rules.
 
 ```php
-Validator::make($data, [
-    'content' => TiptapValidation::content(),
-])
+TiptapValidation::content()
 ```
 
-You can also specify the nodes and marks you want to whitelist or blacklist:
+<details>
+  <summary>Blacklisting</summary>
 
-#### Blacklist nodes / marks
+Only nodes and marks which are not specified in the blacklist will be allowed, anything else will fail validation.
 
 ```php
-Validator::make($data, [
-    'content' => TiptapValidation::content()
-        ->blacklist()
-        // The node types you want to blacklist
-        ->nodes([ ... ])
-        // The mark types you want to blacklist
-        ->marks([ ... ]),
-])
+TiptapValidation::content()
+    ->blacklist()
+    ->nodes('orderedList', 'listItem')
+    ->marks('italic', 'link')
 ```
+</details>
 
-#### Whitelist nodes / marks
+
+<details>
+  <summary>Whitelisting</summary>
+
+Only specified nodes and marks are allowed, anything not in the whitelist will fail validation.
 
 ```php
-Validator::make($data, [
-    'content' => TiptapValidation::content()
-        ->whitelist()
-        // The node types you want to whitelist
-        ->nodes([ ... ])
-        // The mark types you want to whitelist
-        ->marks([ ... ]),
-])
+TiptapValidation::content()
+    ->whitelist()
+    ->nodes('text', 'paragraph')
+    ->marks('bold')
 ```
+</details>
 
-####  Extension
+<details>
+  <summary>Extension</summary>
 
 Instead of having to configure the rule each time, you can create an extension that has your default preferences set.
 
 ```php
 class MyCustomTiptapValidationRule extends TiptapContent
 {
     protected TiptapValidationRuleMode $mode = TiptapValidationRuleMode::WHITELIST;
-    
     protected array $nodes = ['text', 'paragraph', 'table'];
-    
     protected array $marks = ['italic', 'link'];
 }
 ```
 
 This can then be used without the need for further configuration:
 
 ```php
-Validator::make($data, [
-    'content' => MyCustomTiptapValidationRule::create(),
-])
+MyCustomTiptapValidationRule::create(),
 ```
+</details>
 
-### TiptapContainsText 
+### Contains Text 
 
 The `TiptapContainsText` rule is used for verifying that the content contains text, and meets an optional character count requirements.
 
 ```php
-Validator::make($data, [
-    'content' => TiptapValidation::containsText()
-        // Minimum character requirement
-        ->minimum(12)
-        // Maximum character requirement
-        ->maximum(156)
-        // Minimum and maximum character requirement
-        ->between(12, 156),
-])
+TiptapValidation::containsText()
+    ->minimum(12) // Minimum character requirement
+    ->maximum(156) // Maximum character requirement
+    ->between(12, 156) // Minimum and maximum character requirement
 ```
 
 ### Configuration

composer.json

@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": "^8.1",
+        "laravel/helpers": "^1.6",
         "spatie/laravel-package-tools": "^1.15.0"
     },
     "require-dev": {

src/Helpers/TiptapContentHelper.php

@@ -16,7 +16,7 @@ public static function attemptDecode(mixed $value): ?array
             try {
                 $value = json_decode($value, true, 512, JSON_THROW_ON_ERROR);
 
-                if (! empty($value) && is_array($value)) {
+                if (is_array($value) && filled($value)) {
                     return $value;
                 }
             } catch (\Exception $exception) {

src/Helpers/TiptapTextHelper.php

@@ -14,15 +14,15 @@ public static function countCharacters(array $nodes): int
                 $characters += strlen($node[$textProperty] ?? '');
             }
 
-            foreach ($node['marks'] ?? [] as $mark) {
+            foreach (array_get($node, 'marks', []) as $mark) {
                 foreach ($textProperties as $textProperty) {
                     $characters += strlen($mark[$textProperty] ?? '');
                 }
             }
 
             // Nested content
-            if (! empty($node['content'])) {
-                $characters += self::countCharacters($node['content']);
+            if (filled(array_get($node, 'content'))) {
+                $characters += self::countCharacters(array_get($node, 'content'));
             }
         }
 

src/Rules/TiptapContainsText.php

@@ -65,14 +65,14 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         $value = TiptapContentHelper::attemptDecode($value);
 
         // Invalid content
-        if (empty($value) || ! is_array($value)) {
+        if (! is_array($value) || blank($value)) {
             $fail(trans('tiptap-validation::messages.tiptapContainsText.noText'));
 
             return;
         }
 
         // Count text characters in content
-        $length = TiptapTextHelper::countCharacters($value['content'] ?? []);
+        $length = TiptapTextHelper::countCharacters(array_get($value, 'content', []));
 
         // No text found
         if ($length === 0) {

src/Rules/TiptapContent.php

@@ -91,7 +91,7 @@ public function blacklist(): TiptapContent
     public function validate(string $attribute, mixed $value, Closure $fail): void
     {
         // Skip empty values
-        if (empty($value)) {
+        if (blank($value)) {
             return;
         }
 
@@ -116,8 +116,8 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
 
         // Begin content validation
         if (
-            ! empty($value['content']) &&
-            ! $this->validateNodes($value['content'])
+            filled(array_get($value, 'content')) &&
+            ! $this->validateNodes(array_get($value, 'content'))
         ) {
             $fail(trans('tiptap-validation::messages.tiptapContent'));
         }
@@ -145,13 +145,15 @@ protected function validateNodes(array $nodes): bool
         collect($nodes)
             ->each(function (array $node) use (&$passes) {
                 if (
-                    ! empty($node['content']) &&
-                    ! $this->validateNodes($node['content'])
+                    filled(array_get($node, 'content')) &&
+                    ! $this->validateNodes(array_get($node, 'content'))
                 ) {
                     $passes = false;
 
                     return false;
                 }
+
+                return true;
             });
 
         return $passes;