fix incompatibility with BelongsToField

milewski · milewski · commit a6c74d248786 · 2019-11-16T20:41:51.000+08:00
diff --git a/dist/js/field.js b/dist/js/field.js
diff --git a/resources/js/components/FormField.vue b/resources/js/components/FormField.vue
@@ -176,18 +176,18 @@
                     /**
                      * Initialize bag with initial value
                      */
-                    this.setBagValue(attribute, component[watchableAttribute])
+                    this.setBagValue(component, attribute, component[watchableAttribute])
 
                     component.$once('hook:beforeDestroy', () => this.deleteBagAttribute(attribute))
-                    component.$watch(watchableAttribute, value => this.setBagValue(attribute, this.parseComponentValue(component, value)))
+                    component.$watch(watchableAttribute, value => this.setBagValue(component, attribute, value))
 
                 }
 
             },
 
-            setBagValue(attribute, value) {
+            setBagValue(component, attribute, value) {
 
-                valueBag[attribute] = value
+                valueBag[attribute] = this.parseComponentValue(component, value)
 
                 this.$root.$emit('update-conditional-container')
 
@@ -286,12 +286,11 @@
 
                 switch (component.field.component) {
 
-                    /**
-                     * For some unknown reason this component stringify the value
-                     * https://github.com/dillingham/nova-attach-many/blob/2d461048d3e85de54795f6c03ae0bdad3356df6b/resources/js/components/FormField.vue#L210
-                     */
                     case 'nova-attach-many':
-                        return JSON.parse(value)
+                        return JSON.parse(value || '[]')
+
+                    case 'BelongsToManyField':
+                        return (value || []).map(({id}) => id)
 
                 }
 
diff --git a/src/ConditionalContainer.php b/src/ConditionalContainer.php
@@ -2,14 +2,14 @@
 
 namespace DigitalCreative\ConditionalContainer;
 
-use Laravel\Nova\Resource;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Laravel\Nova\Fields\Field;
 use Laravel\Nova\Http\Controllers\ResourceUpdateController;
 use Laravel\Nova\Http\Controllers\UpdateFieldController;
 use Laravel\Nova\Http\Requests\NovaRequest;
+use Laravel\Nova\Resource;
 use logipar\Logipar;
 
 class ConditionalContainer extends Field
@@ -34,7 +34,14 @@ class ConditionalContainer extends Field
     /**
      * @var Collection
      */
-    private $operators;
+    const OPERATORS = [
+        '===', '==', '=',
+        '!==', '!=',
+        '>=', '<=', '<', '>',
+        'includes', 'contains',
+        'ends with', 'starts with', 'startsWith', 'endsWith',
+        'boolean', 'truthy'
+    ];
 
     /**
      * ConditionalContainer constructor.
@@ -48,14 +55,6 @@ public function __construct(array $fields)
 
         $this->fields = collect($fields);
         $this->expressions = collect();
-        $this->operators = collect([
-            '===', '==', '=',
-            '!==', '!=',
-            '>=', '<=', '<', '>',
-            'includes', 'contains',
-            'ends with', 'starts with', 'startsWith', 'endsWith',
-            'boolean', 'truthy'
-        ]);
 
         $this->withMeta([ 'operation' => 'some' ]);
 
@@ -163,35 +162,14 @@ private function executeCondition($attributeValue, string $operator, $conditionV
 
         $conditionValue = trim($conditionValue, '"\'');
 
-        if (in_array($operator, [ '<', '>', '<=', '>=' ]) && $conditionValue) {
+        if (in_array($operator, [ '<', '>', '<=', '>=' ]) && $conditionValue ||
+            (is_numeric($attributeValue) && is_numeric($conditionValue))) {
 
             $conditionValue = (int) $conditionValue;
             $attributeValue = (int) $attributeValue;
 
         }
 
-        /**
-         * This is due that sometimes this function is call with data that comes
-         * directly from the request, therefore there may be occasion that the "model" casts
-         * may not be applied, if it doesnt cause any unforeseen issue it`s safe to keep this in here
-         */
-        if (is_string($attributeValue)) {
-
-            $attributeValue = json_decode($attributeValue, true) ?? $attributeValue;
-
-        }
-
-        /**
-         * If $attributeValue is an array and $operator contains/includes
-         * assumes user is trying to match id of a belongsToMany relationship
-         */
-        if (is_array($attributeValue) && in_array($operator, [ 'contains', 'includes' ])) {
-
-            $attributeValue = collect($attributeValue);
-            $conditionValue = (int) $conditionValue;
-
-        }
-
         if (in_array($conditionValue, [ 'true', 'false' ])) {
 
             $conditionValue = $conditionValue === 'true';
@@ -247,10 +225,10 @@ private function executeCondition($attributeValue, string $operator, $conditionV
 
     }
 
-    private function splitLiteral(string $literal): array
+    public static function splitLiteral(string $literal): array
     {
 
-        $operator = $this->operators
+        $operator = collect(self::OPERATORS)
             ->filter(function ($operator) use ($literal) {
                 return strpos($literal, $operator) !== false;
             })
@@ -341,6 +319,7 @@ public function resolveDependencyFieldUsingResource($resource): array
 
     /**
      * @param Model|Resource $resource
+     *
      * @return Collection
      */
     private function flattenRelationships($resource): Collection
diff --git a/src/HasConditionalContainer.php b/src/HasConditionalContainer.php
@@ -4,13 +4,15 @@
 
 use Illuminate\Http\Resources\MergeValue;
 use Illuminate\Support\Collection;
+use Laravel\Nova\Contracts\RelatableField;
+use Laravel\Nova\Fields\Field;
 use Laravel\Nova\Fields\FieldCollection;
 use Laravel\Nova\Http\Controllers\ActionController;
-use Laravel\Nova\Http\Controllers\AssociatableController;
 use Laravel\Nova\Http\Controllers\CreationFieldController;
 use Laravel\Nova\Http\Controllers\FieldController;
 use Laravel\Nova\Http\Controllers\MorphableController;
 use Laravel\Nova\Http\Controllers\ResourceAttachController;
+use Laravel\Nova\Http\Controllers\ResourceIndexController;
 use Laravel\Nova\Http\Controllers\ResourceStoreController;
 use Laravel\Nova\Http\Controllers\ResourceUpdateController;
 use Laravel\Nova\Http\Controllers\UpdateFieldController;
@@ -23,7 +25,7 @@ trait HasConditionalContainer
     /**
      * Get the panels that are available for the given detail request.
      *
-     * @param \Laravel\Nova\Http\Requests\NovaRequest $request
+     * @param NovaRequest $request
      * @return array
      */
     public function availablePanelsForDetail($request)
@@ -37,7 +39,7 @@ public function availablePanelsForDetail($request)
     /**
      * Get the panels that are available for the given create request.
      *
-     * @param \Laravel\Nova\Http\Requests\NovaRequest $request
+     * @param NovaRequest $request
      * @return array
      */
     public function availablePanelsForCreate($request)
@@ -51,7 +53,7 @@ public function availablePanelsForCreate($request)
     /**
      * Get the panels that are available for the given update request.
      *
-     * @param \Laravel\Nova\Http\Requests\NovaRequest $request
+     * @param NovaRequest $request
      * @return array
      */
     public function availablePanelsForUpdate($request)
@@ -78,18 +80,30 @@ public function availableFields(NovaRequest $request)
 
         $controller = $request->route()->controller;
 
+        /**
+         * Exclude all instance of conditional container from index views
+         */
+        if ($controller instanceof ResourceIndexController) {
+
+            return parent::availableFields($request)->filter(function ($field) {
+
+                return !($field instanceof ConditionalContainer);
+
+            });
+
+        }
+
         if ($controller instanceof CreationFieldController ||
             $controller instanceof UpdateFieldController) {
 
             $fields = parent::availableFields($request);
             $containers = $this->findAllContainers($fields);
+            $expressionsMap = $containers->flatMap->expressions;
 
             $cleanUpMethodName = $controller instanceof UpdateFieldController ?
                 'removeNonUpdateFields' :
                 'removeNonCreationFields';
 
-            $expressionsMap = $containers->flatMap->expressions;
-
             /**
              * @var ConditionalContainer $container
              */
@@ -107,7 +121,7 @@ public function availableFields(NovaRequest $request)
 
             }
 
-            return $fields;
+            return $this->preloadRelationships($expressionsMap, $fields);
 
         }
 
@@ -120,12 +134,56 @@ public function availableFields(NovaRequest $request)
 
         }
 
-        $fields = $this->flattenDependencies($request, $this->fields($request));
+        $allFields = $this->fields($request);
+        $containers = $this->findAllContainers($allFields);
+        $expressionsMap = $containers->flatMap->expressions;
+
+        $fields = $this->flattenDependencies(
+            $request, $this->preloadRelationships($expressionsMap, $allFields)
+        );
 
         return new FieldCollection(array_values($this->filter($fields->toArray())));
 
     }
 
+    private function preloadRelationships(Collection $expressionsMap, $fields)
+    {
+
+        $relations = collect();
+
+        foreach ($fields as $field) {
+
+            if ($field instanceof RelatableField ||
+                $field instanceof \NovaAttachMany\AttachMany ||
+                $field instanceof \Benjacho\BelongsToManyField\BelongsToManyField) {
+
+                $relations->push($field->attribute);
+
+            }
+
+        }
+
+        $expressionsMap = $expressionsMap->map(function (string $expression) {
+            return ConditionalContainer::splitLiteral($expression)[ 0 ];
+        });
+
+        /**
+         * Only load the relations that are necessary
+         */
+        $relations = $relations->filter(function ($relation) use ($expressionsMap) {
+            return $expressionsMap->contains($relation);
+        });
+
+        if ($relations->isNotEmpty()) {
+
+            $this->loadMissing($relations);
+
+        }
+
+        return $fields;
+
+    }
+
     private function flattenDependencies(NovaRequest $request, array $fields)
     {
 
@@ -139,7 +197,11 @@ private function flattenDependencies(NovaRequest $request, array $fields)
 
         }
 
-        return $fields->flatMap(function ($field) use ($fields, $request, $controller) {
+        $fakeRequest = $request->duplicate();
+
+        return $fields->flatMap(function ($field) use ($fields, $fakeRequest, $controller) {
+
+            $this->parseThirdPartyPackageFieldValue($field, $fakeRequest);
 
             if ($field instanceof ConditionalContainer) {
 
@@ -157,24 +219,26 @@ private function flattenDependencies(NovaRequest $request, array $fields)
                     $controller instanceof ResourceAttachController ||
                     $controller instanceof FieldController) {
 
-                    return $this->flattenDependencies($request, $field->fields->toArray());
+                    return $this->flattenDependencies($fakeRequest, $field->fields->toArray());
 
                 }
 
                 if ($controller instanceof ResourceUpdateController ||
                     $controller instanceof ResourceStoreController) {
 
-                    return $this->flattenDependencies($request, $field->resolveDependencyFieldUsingRequest($this, $request));
+                    return $this->flattenDependencies(
+                        $fakeRequest, $field->resolveDependencyFieldUsingRequest($this, $fakeRequest)
+                    );
 
                 }
 
-                return $this->flattenDependencies($request, $field->resolveDependencyFieldUsingResource($this));
+                return $this->flattenDependencies($fakeRequest, $field->resolveDependencyFieldUsingResource($this));
 
             }
 
             if ($field instanceof MergeValue) {
 
-                return $this->flattenDependencies($request, $field->data);
+                return $this->flattenDependencies($fakeRequest, $field->data);
 
             }
 
@@ -184,6 +248,35 @@ private function flattenDependencies(NovaRequest $request, array $fields)
 
     }
 
+    /**
+     * Intended to minimize the incompatibility with third part package
+     *
+     * @param Field $field
+     * @param NovaRequest $request
+     */
+    private function parseThirdPartyPackageFieldValue(Field $field, NovaRequest $request)
+    {
+
+        $value = $request->get($field->attribute);
+
+        if ($field instanceof \Benjacho\BelongsToManyField\BelongsToManyField) {
+
+            $request->offsetSet(
+                $field->attribute, collect(json_decode($value, true))->map->id
+            );
+
+        }
+
+        if ($field instanceof \NovaAttachMany\AttachMany) {
+
+            $request->offsetSet(
+                $field->attribute, collect(json_decode($value, true))
+            );
+
+        }
+
+    }
+
     private function findAllActiveContainers(Collection $fields, $resource): Collection
     {
         return $this->findAllContainers($fields)
@@ -193,9 +286,9 @@ private function findAllActiveContainers(Collection $fields, $resource): Collect
                     ->values();
     }
 
-    private function findAllContainers(Collection $fields): Collection
+    private function findAllContainers($fields): Collection
     {
-        return $fields->flatMap(function ($field) {
+        return collect($fields)->flatMap(function ($field) {
 
             if ($field instanceof ConditionalContainer) {
 
@@ -205,7 +298,7 @@ private function findAllContainers(Collection $fields): Collection
 
             if ($field instanceof MergeValue) {
 
-                return $this->findAllContainers(collect($field->data));
+                return $this->findAllContainers($field->data);
 
             }
 
