Merge pull request #54 from kirschbaum-development/enable-method

New enable method, instead of disable

Author: brandonferens

CHANGELOG.md

@@ -41,6 +41,10 @@ All notable changes to `nova-inline-select` will be documented in this file
 - Github Actions now doing the heavy lifting for tests. Thanks [@luisdalmolin](https://github.com/luisdalmolin) [#19](https://github.com/kirschbaum-development/nova-inline-select/issues/19).
 - Added pretty printing results for PHPUnit tests
 
-## 2.0.0 - 2022-5-22
+## 2.0.0 - 2022-4-22
 
 - Upgraded and ready for Nova 4!
+
+## 2.0.1 - 2022-5-23
+
+- Added `enableOneStepOn...()` methods to eventually replace `disableTwoStepOn...()` methods.

readme.md

@@ -54,7 +54,7 @@ class User extends Resource
 }
 ```
 
-Now you can use the `InlineSelect` field just like Nova's `Select` field. Now for the magic...
+Use the `InlineSelect` field just like Nova's `Select` field. But now for the magic...
 
 ### Inline editing
 
@@ -66,22 +66,22 @@ InlineSelect::make('Status')->options($options)
     ->inlineOnDetail(),
 ```
 
-Now the above inline select field will show up on both the index and detail views. When making a change to the select field, a button will display next to the field allowing you to commit the change. If you would prefer the field to auto-submit the change, just add `disableTwoStepOnIndex()` or `disableTwoStepOnDetail()`.
+The above inline select field will show up on both the index and detail views. When making a change to the select field, a button will display next to the field allowing you to commit the change. If you would rather the field auto-submits the change, simply add `enableOneStepOnIndex()` or `enableOneStepOnDetail()`.
 
 ```php
 InlineSelect::make('Status')->options($options)
     ->inlineOnIndex()
-    ->disableTwoStepOnIndex(),
+    ->enableOneStepOnIndex(),
 ```
 
-Now changing the select field on the index view will auto-submit the changed value.
+The inline select field on the index view now will auto-submit the changed value. You can also continue to use the old `disableTwoStepOnIndex()` method if you choose, which just calls `enableOneStepOnIndex()` under the hood.
 
-You can also add the inline select to Lenses. Use the `inlineOnLens()` method. Auto-submitting works the same as well with `disableTwoStepOnLens()`.
+You can also add the inline select to Lenses. Use the `inlineOnLens()` method. Auto-submitting works the same as well with `enableOneStepOnLens()`.
 
 ```php
 InlineSelect::make('Status')->options($options)
     ->inlineOnLens()
-    ->disableTwoStepOnLens(),
+    ->enableOneStepOnLens(),
 ```
 
 ### Display using labels

src/InlineSelect.php

@@ -15,60 +15,72 @@ class InlineSelect extends Select
 
     /**
      * Allow inline select to auto-update field value on change on detail view.
-     *
-     * @return $this
      */
-    public function disableTwoStepOnDetail()
+    public function enableOneStepOnDetail(): InlineSelect
     {
         return $this->withMeta(['detailTwoStepDisabled' => true]);
     }
 
+    /**
+     * Allow inline select to auto-update field value on change on detail view.
+     */
+    public function disableTwoStepOnDetail(): InlineSelect
+    {
+        return $this->enableOneStepOnDetail();
+    }
+
     /**
      * Allow inline select to auto-update field value on change on index view.
-     *
-     * @return $this
      */
-    public function disableTwoStepOnIndex()
+    public function enableOneStepOnIndex(): InlineSelect
     {
         return $this->withMeta(['indexTwoStepDisabled' => true]);
     }
 
     /**
      * Allow inline select to auto-update field value on change on index view.
-     *
-     * @return $this
      */
-    public function disableTwoStepOnLens()
+    public function disableTwoStepOnIndex(): InlineSelect
+    {
+        return $this->enableOneStepOnIndex();
+    }
+
+    /**
+     * Allow inline select to auto-update field value on change on index view.
+     */
+    public function enableOneStepOnLens(): InlineSelect
+    {
+        return $this->enableOneStepOnIndex();
+    }
+
+    /**
+     * Allow inline select to auto-update field value on change on index view.
+     */
+    public function disableTwoStepOnLens(): InlineSelect
     {
-        return $this->disableTwoStepOnIndex();
+        return $this->enableOneStepOnIndex();
     }
 
     /**
      * Enable inline editing on detail view.
-     *
-     * @return $this
      */
-    public function inlineOnDetail()
+    public function inlineOnDetail(): InlineSelect
     {
         return $this->withMeta(['inlineDetail' => true]);
     }
 
     /**
      * Enable inline editing on index view.
-     *
-     * @return $this
      */
-    public function inlineOnIndex()
+    public function inlineOnIndex(): InlineSelect
     {
         return $this->withMeta(['inlineIndex' => true]);
     }
 
     /**
      * Enable inline editing on index view.
-     *
-     * @return $this
      */
-    public function inlineOnLens()
+    public function inlineOnLens(): InlineSelect
     {
         return $this->inlineOnIndex();
     }

tests/Unit/InlineSelectDetailTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Tests\Unit;
+
+use Tests\TestCase;
+use Illuminate\Foundation\Testing\WithFaker;
+use KirschbaumDevelopment\Nova\InlineSelect;
+
+class InlineSelectDetailTest extends TestCase
+{
+    use WithFaker;
+
+    /**
+     * @var InlineSelect
+     */
+    protected InlineSelect $inlineSelect;
+
+    /**
+     * @before
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->inlineSelect = new InlineSelect('inline-select');
+    }
+
+    public function testThatItInlinesOnDetail()
+    {
+        $this->inlineSelect->inlineOnDetail();
+
+        $this->assertTrue($this->inlineSelect->meta['inlineDetail']);
+    }
+
+    public function testThatItEnablesOneStepOnDetail()
+    {
+        $this->inlineSelect->enableOneStepOnDetail();
+
+        $this->assertTrue($this->inlineSelect->meta['detailTwoStepDisabled']);
+    }
+
+    public function testThatItDisablesTwoStepOnDetail()
+    {
+        $this->inlineSelect->disableTwoStepOnDetail();
+
+        $this->assertTrue($this->inlineSelect->meta['detailTwoStepDisabled']);
+    }
+}

tests/InlineSelectFieldTest.php tests/Unit/InlineSelectIndexTest.phptests/InlineSelectFieldTest.php renamed to tests/Unit/InlineSelectIndexTest.php

@@ -1,11 +1,12 @@
 <?php
 
-namespace Tests;
+namespace Tests\Unit;
 
+use Tests\TestCase;
 use Illuminate\Foundation\Testing\WithFaker;
 use KirschbaumDevelopment\Nova\InlineSelect;
 
-class InlineSelectFieldTest extends TestCase
+class InlineSelectIndexTest extends TestCase
 {
     use WithFaker;
 
@@ -24,45 +25,24 @@ public function setUp(): void
         $this->inlineSelect = new InlineSelect('inline-select');
     }
 
-    public function testThatItDisablesTwoStepOnDetail()
-    {
-        $this->inlineSelect->disableTwoStepOnDetail();
-
-        $this->assertTrue($this->inlineSelect->meta['detailTwoStepDisabled']);
-    }
-
-    public function testThatItDisablesTwoStepOnIndex()
-    {
-        $this->inlineSelect->disableTwoStepOnIndex();
-
-        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
-    }
-
-    public function testThatItDisablesTwoStepOnLens()
-    {
-        $this->inlineSelect->disableTwoStepOnLens();
-
-        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
-    }
-
     public function testThatItInlinesOnIndex()
     {
         $this->inlineSelect->inlineOnIndex();
 
         $this->assertTrue($this->inlineSelect->meta['inlineIndex']);
     }
 
-    public function testThatItInlinesOnLens()
+    public function testThatItEnablesOneStepOnIndex()
     {
-        $this->inlineSelect->inlineOnIndex();
+        $this->inlineSelect->enableOneStepOnIndex();
 
-        $this->assertTrue($this->inlineSelect->meta['inlineIndex']);
+        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
     }
 
-    public function testThatItInlinesOnDetail()
+    public function testThatItDisablesTwoStepOnIndex()
     {
-        $this->inlineSelect->inlineOnDetail();
+        $this->inlineSelect->disableTwoStepOnIndex();
 
-        $this->assertTrue($this->inlineSelect->meta['inlineDetail']);
+        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
     }
 }

tests/Unit/InlineSelectLensTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Tests\Unit;
+
+use Tests\TestCase;
+use Illuminate\Foundation\Testing\WithFaker;
+use KirschbaumDevelopment\Nova\InlineSelect;
+
+class InlineSelectLensTest extends TestCase
+{
+    use WithFaker;
+
+    /**
+     * @var InlineSelect
+     */
+    protected InlineSelect $inlineSelect;
+
+    /**
+     * @before
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->inlineSelect = new InlineSelect('inline-select');
+    }
+
+    public function testThatItInlinesOnLens()
+    {
+        $this->inlineSelect->inlineOnIndex();
+
+        $this->assertTrue($this->inlineSelect->meta['inlineIndex']);
+    }
+
+    public function testThatItEnablesOneStepOnLens()
+    {
+        $this->inlineSelect->enableOneStepOnLens();
+
+        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
+    }
+
+    public function testThatItDisablesTwoStepOnLens()
+    {
+        $this->inlineSelect->disableTwoStepOnLens();
+
+        $this->assertTrue($this->inlineSelect->meta['indexTwoStepDisabled']);
+    }
+}