Replaced chartable function by inbuilt resolve method (#30)

* Replaced Chartable function by inbuilt resolve method

* Add hideFromIndex to InlinePanel

* Removed Chartable from MetricValue Resource

* Updated Readme

* StyleCI fix

* Added deprication warning to chartable readme

* Style CI fix

* Added deprecated annotation

* Updated changelog

* Spelling Fixes

Author: navneetrai

CHANGELOG.md

@@ -4,3 +4,7 @@ This document is meant for tracking notable changes to `nova-chartjs`
 ## 0.1.0 
 1. Chart metric values can now directly be added while creating new Chartable model. 
 2. Deprecated `RedirectsOnCreate` Trait
+
+# 0.2.0
+1. Deprecated `chartable` method on `NovaChartjs`
+2. Added `hideFromIndex` option to `InlinePanel`

README.md

@@ -167,7 +167,7 @@ class Employee extends Resource
 ``` 
 **_NOTE:_** You must pass the `Resource` (i.e. `$this`) and `$request` to the `InlinePanel` component. 
 
-As an optional argument you can pass a chart name as the third argument, `showLabel` as fourth argument and `notEditable` as the fifth argument.
+As an optional argument you can pass a chart name as the third argument, `showLabel` as fourth argument, `notEditable` as the fifth argument and `hideFromIndex` as the sixth argument.
 
 ![Panel with Label](screenshots/PanelWithLabel.jpg "Panel with Label")
 
@@ -189,7 +189,7 @@ class Employee extends Resource
 
             NovaChartjs::make('Panel Name', 'novaChartjsMetricValue', function () {
                 return $this->novaChartjsMetricValue->metric_values;
-            })->chartable($this->resource ?? App::make($request->viaResource()::$model)),
+            }),
         ];
     }
 }

src/InlinePanel.php

@@ -4,7 +4,6 @@
 
 use Laravel\Nova\Panel;
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\App;
 use App\Nova\Resource as NovaResource;
 use KirschbaumDevelopment\NovaChartjs\Contracts\Chartable;
 
@@ -18,12 +17,13 @@ class InlinePanel extends Panel
      * @param string $panelTitle
      * @param bool $showLabel
      * @param bool $notEditable
+     * @param bool $hideFromIndex
      */
-    public function __construct(NovaResource $resource, Request $request, $panelTitle = 'Chart Metric Values', $showLabel = false, $notEditable = false)
+    public function __construct(NovaResource $resource, Request $request, $panelTitle = 'Chart Metric Values', $showLabel = false, $notEditable = false, $hideFromIndex = false)
     {
         parent::__construct(
             $panelTitle,
-            $this->prepareFields($this->fields($resource->resource, $request, $panelTitle, $showLabel, $notEditable))
+            $this->prepareFields($this->fields($resource->resource, $request, $panelTitle, $showLabel, $notEditable, $hideFromIndex))
         );
     }
 
@@ -35,14 +35,15 @@ public function __construct(NovaResource $resource, Request $request, $panelTitl
      * @param mixed $panelTitle
      * @param bool $showLabel
      * @param bool $notEditable
+     * @param bool $hideFromIndex
      *
      * @return array
      */
-    protected function fields(Chartable $chartable, Request $request, $panelTitle = 'Chart Metric Values', $showLabel = false, $notEditable = false): array
+    protected function fields(Chartable $chartable, Request $request, $panelTitle = 'Chart Metric Values', $showLabel = false, $notEditable = false, $hideFromIndex = false): array
     {
         $field = NovaChartjs::make($panelTitle, 'novaChartjsMetricValue', function () use ($chartable) {
             return $chartable->novaChartjsMetricValue->metric_values ?? [];
-        })->chartable($chartable ?? App::make($request->viaResource()::$model));
+        });
 
         if ($showLabel) {
             $field->showLabel();
@@ -52,6 +53,10 @@ protected function fields(Chartable $chartable, Request $request, $panelTitle =
             $field->notEditable();
         }
 
+        if ($hideFromIndex) {
+            $field->hideFromIndex();
+        }
+
         return [
             $field,
         ];

src/Nova/MetricValue.php

@@ -5,7 +5,6 @@
 use App\Nova\Resource;
 use Illuminate\Http\Request;
 use Laravel\Nova\Fields\MorphTo;
-use Illuminate\Support\Facades\App;
 use KirschbaumDevelopment\NovaChartjs\NovaChartjs;
 use KirschbaumDevelopment\NovaChartjs\Models\NovaChartjsMetricValue;
 
@@ -42,7 +41,6 @@ class MetricValue extends Resource
     public function fields(Request $request)
     {
         $field = NovaChartjs::make('Metric Values', 'metric_values')
-            ->chartable($this->resource->chartable ?? App::make($request->viaResource()::$model))
             ->rules('required', 'json');
         $field->showOnCreation = true;
 

src/NovaChartjs.php

@@ -6,6 +6,7 @@
 use Laravel\Nova\Fields\Field;
 use Laravel\Nova\Http\Requests\NovaRequest;
 use KirschbaumDevelopment\NovaChartjs\Contracts\Chartable;
+use KirschbaumDevelopment\NovaChartjs\Models\NovaChartjsMetricValue;
 
 class NovaChartjs extends Field
 {
@@ -34,6 +35,8 @@ public function __construct($name, $attribute = null, callable $resolveCallback
     }
 
     /**
+     * @deprecated This method has been deprecated and will be removed in next major update.
+     *
      * Pass chartable model to NovaChartjs to fetch settings.
      *
      * @param Chartable|null $chartable
@@ -42,18 +45,35 @@ public function __construct($name, $attribute = null, callable $resolveCallback
      */
     public function chartable(Chartable $chartable): self
     {
-        $chartableClass = get_class($chartable);
+        return $this;
+    }
+
+    /**
+     * Resolve the field's value.
+     *
+     * @param  mixed  $resource
+     * @param  string|null  $attribute
+     */
+    public function resolve($resource, $attribute = null)
+    {
+        parent::resolve($resource, $attribute);
 
-        $settings = $chartableClass::getNovaChartjsSettings();
+        if ($resource instanceof NovaChartjsMetricValue) {
+            $resource = $resource->chartable;
+        }
 
-        return $this->withMeta([
-            'settings' => $settings,
-            'comparison' => $chartableClass::getNovaChartjsComparisonData(),
-            'additionalDatasets' => $chartable->getAdditionalDatasets() ?? [],
-            'model' => Str::singular(Str::title(Str::snake(class_basename($chartableClass), ' '))),
-            'title' => $this->getChartableProp($chartable, $settings['titleProp'] ?? $chartable->getKeyName()),
-            'ident' => $this->getChartableProp($chartable, $settings['identProp'] ?? $chartable->getKeyName()),
-        ]);
+        if (! empty($resource)) {
+            $settings = $resource::getNovaChartjsSettings();
+
+            $this->withMeta([
+                'settings' => $settings,
+                'comparison' => $resource::getNovaChartjsComparisonData(),
+                'additionalDatasets' => $resource->getAdditionalDatasets() ?? [],
+                'model' => Str::singular(Str::title(Str::snake(class_basename($resource), ' '))),
+                'title' => $this->getChartableProp($resource, $settings['titleProp'] ?? $resource->getKeyName()),
+                'ident' => $this->getChartableProp($resource, $settings['identProp'] ?? $resource->getKeyName()),
+            ]);
+        }
     }
 
     /**