Merge pull request #7 from nzesalem/revert-6-feature/allow-any-column…

…-for-status Revert "Allow another column for status"
nzesalem · Oct 13, 2020 · 96419a2 · 96419a2
2 parents b07622b + b4ec85d
commit 96419a2
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 121 deletions.
diff --git a/README.md b/README.md
@@ -136,13 +136,6 @@ $user = User::whereRaw('status = ' . User::getStatusCode('suspended'))->first();
 $user->status == 'suspended' // true
 ```
 
-To use a custom field in your model for status, add the `$statusFieldName` Property to the model. Example:
-```php
-class User {
-    protected $statusFieldName = 'sent_status';
-}
-```
-
 Getting all the defined statuses for a given model is also easy as the snippet below. We get all the defined statuses for the `User` model and display them in a select element:
 
 ```php

diff --git a/src/Traits/LastusTrait.php b/src/Traits/LastusTrait.php
@@ -2,72 +2,10 @@
 
 namespace Nzesalem\Lastus\Traits;
 
-use ErrorException;
 use Nzesalem\Lastus\Lastus;
 
 trait LastusTrait
 {
-    /**
-     * Return the status field name set in Model or return status (by default)
-     *
-     * @return string
-     */
-    protected function getStatusFieldName() {
-        try {
-            return $this->statusFieldName;
-        } catch(ErrorException $ex) {
-            return 'status';
-        }
-    }
-
-    /**
-     * Set status field name
-     *
-     * @param string $fieldName
-     * @return void
-     */
-    public function setStatusFieldName($fieldName) {
-        $this->statusFieldName = $fieldName;
-    }
-
-    /**
-     * Dynamically retrieve attributes on the model.
-     *
-     * @param  string  $key
-     * @return mixed
-     */
-    public function getAttribute($key, $defaultVal=null)
-    {
-        if ($key === $this->getStatusFieldName()) {
-            $value = parent::getAttribute($key, 1);
-            return $this->getLastusStatus($value);
-        }
-
-        return parent::getAttribute($key, $defaultVal);
-    }
-
-    /**
-     * Dynamically retrieve attributes on the model.
-     *
-     * @param  string  $key
-     * @return mixed
-     */
-    /**
-     * Dynamically set attributes on the model.
-     *
-     * @param  string  $key
-     * @param  mixed  $value
-     * @return void
-     */
-    public function setAttribute($key, $value)
-    {
-        if ($key === $this->getStatusFieldName()) {            
-            $this->setLastusStatus($key, $value);
-        } else {
-            parent::setAttribute($key, $value);
-        }
-    }
-
     /**
      * Status accessor
      *
@@ -76,12 +14,11 @@ public function setAttribute($key, $value)
      *
      * @throws \InvalidArgumentException
      */
-    public function getLastusStatus($value)
+    public function getStatusAttribute($value)
     {
         if (! is_numeric($value)) {
-            throw new \InvalidArgumentException(sprintf('Model %s should be stored as an integer, %s given', $this->getStatusFieldName(), $value));
+            throw new \InvalidArgumentException('Model status should be stored as an integer');
         }
-
         return Lastus::statusName(static::class, $value);
     }
 
@@ -93,13 +30,12 @@ public function getLastusStatus($value)
      *
      * @throws \InvalidArgumentException
      */
-    public function setLastusStatus($statusField, $value)
+    public function setStatusAttribute($value)
     {
         if (! is_string(($value))) {
-            throw new \InvalidArgumentException(sprintf('Expecting a string for model %s', $this->getStatusFieldName()));
+            throw new \InvalidArgumentException('Expecting a string for model status');
         }
-
-        $this->attributes[$statusField] = Lastus::getStatusCode(static::class, $value);
+        $this->attributes['status'] = Lastus::getStatusCode(static::class, $value);
     }
 
     /**

diff --git a/tests/BaseTest.php b/tests/BaseTest.php
@@ -6,7 +6,6 @@
 use Nzesalem\Lastus\Lastus;
 use Illuminate\Support\Facades\DB;
 use Nzesalem\Lastus\Tests\Models\User;
-use Nzesalem\Lastus\Tests\Models\Email;
 
 /**
  * Class BaseTest
@@ -15,7 +14,6 @@
  */
 class BaseTest extends TestCase
 {
-    protected $statusFieldName = 'status';
     /**
      * Test basic Lastus functionality.
      */
@@ -32,47 +30,6 @@ public function testStatusMutatorAndAccessor()
         $this->assertEquals('active', $user->status);
     }
 
-    /**
-     * Test basic Lastus functionality.
-     */
-    public function testMutatorAndAccessorWithCustomStatusField()
-    {
-        $user = new User();
-        $user->setStatusFieldName('email');
-
-        $user->fill([
-            'name' => 'Salem Nzeukwu',
-            'email' => 'blocked',
-            'password' => bcrypt('secret'),
-            'custom_status' => 'blocked',
-        ]);
-
-        $user->save();
-
-        $this->assertEquals('blocked', $user->email);
-    }
-
-    /**
-     * Test basic Lastus functionality.
-     */
-    public function testUpdateWithCustomStatusField()
-    {
-        $user = new User([
-            'name' => 'Salem Nzeukwu',
-            'email' => 'blocked',
-            'password' => bcrypt('secret'),
-            'custom_status' => 'blocked',
-        ]);
-
-        $user->setStatusFieldName('email');
-        $user->save();
-
-        $user->email = 'active';
-
-        $this->assertEquals('active', $user->email);
-        $this->assertEquals(1, $user->getAttributes()['email']);
-    }
-
     public function testModelStatusCodeMethod()
     {
         $now = Carbon::now();

diff --git a/tests/Models/User.php b/tests/Models/User.php
@@ -37,6 +37,4 @@ class User extends Authenticatable
     protected $hidden = [
         'password', 'remember_token',
     ];
-
-    protected $statusFieldName = 'status';
 }