(Chore): Alter data type of status in permissions and roles

(Chore): Index for `status` columns (Cleanup): Migration constants to a `Constants` (Refactor): Refactor classes to use string constants for statuses
CottaCush · Sep 14, 2017 · 8ee46f2 · 8ee46f2
1 parent c9b1e6e
commit 8ee46f2
Show file tree

Hide file tree

Showing 14 changed files with 221 additions and 46 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 # Created by .ignore support plugin (hsz.mobi)
+/composer.lock
+/vendor
+/runtime
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,25 @@
+# Changelog
+
+All Notable changes to `yii2-permission-ext` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## 1.0.0 - 2017-09-14
+
+### Added
+- Alter data type of `status` in `permissions` and `roles`
+- Index for `status` columns
+- Migration constants to a `Constants`
+- Refactor classes to use string constants for statuses
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Nothing
+
+### Security
+- Nothing
diff --git a/README.md b/README.md
@@ -48,6 +48,7 @@ If you discover any security related issues, please email <developers@cottacush.
 ## Credits
 
 - Adegoke Obasa [email protected]
+- Olawale Lawal <[email protected]>
 - [All Contributors][link-contributors]
 
 ## License

diff --git a/composer.json b/composer.json
@@ -9,6 +9,10 @@
         {
             "name": "Adegoke Obasa",
             "email": "[email protected]"
+        },
+        {
+            "name": "Olawale Lawal",
+            "email": "[email protected]"
         }
     ],
     "require": {

diff --git a/config/console.php b/config/console.php
@@ -0,0 +1,31 @@
+<?php
+
+return [
+    'id' => 'yii2_permission_extension',
+    'name' => 'Custom Role Based Access Control Implementation',
+    'basePath' => dirname(__DIR__),
+    'bootstrap' => ['log'],
+    'controllerNamespace' => 'app\commands',
+    'components' => [
+        'cache' => [
+            'class' => 'yii\caching\FileCache',
+        ],
+        'log' => [
+            'targets' => [
+                [
+                    'class' => 'yii\log\FileTarget',
+                    'levels' => ['error', 'warning'],
+                ],
+            ],
+        ],
+        'db' => [
+            'class' => 'yii\db\Connection',
+            'dsn' => 'mysql:host=' . getenv('DB_HOST') . ';dbname=' . getenv('DB_NAME'),
+            'username' => getenv('DB_USERNAME'),
+            'password' => getenv('DB_PASSWORD'),
+            'charset' => 'utf8',
+        ]
+    ],
+    'params' => [],
+    'vendorPath' => dirname(__DIR__) . "/../vendor",
+];
diff --git a/migrations/m151005_151946_install.php b/migrations/m151005_151946_install.php
@@ -1,6 +1,6 @@
 <?php
 
-use yii\db\Schema;
+use cottacush\rbac\libs\Constants;
 use yii\db\Migration;
 
 /**
@@ -9,6 +9,7 @@
  */
 class m151005_151946_install extends Migration
 {
+
     public function up()
     {
         $tableOptions = null;
@@ -17,7 +18,7 @@ public function up()
         }
 
         // Create permissions table
-        $this->createTable('permissions', [
+        $this->createTable(Constants::TABLE_PERMISSIONS, [
             'id' => $this->primaryKey(),
             'key' => $this->string(150)->notNull(),
             'label' => $this->string(255)->notNull(),
@@ -27,10 +28,10 @@ public function up()
         ], $tableOptions);
 
         // Add Indexes for performance optimization
-        $this->createIndex('permissions_unique_key', 'permissions', 'key', true);
+        $this->createIndex('permissions_unique_key', Constants::TABLE_PERMISSIONS, 'key', true);
 
         // Create Roles Table
-        $this->createTable('roles', [
+        $this->createTable(Constants::TABLE_ROLES, [
             'id' => $this->primaryKey(),
             'key' => $this->string(150)->notNull(),
             'label' => $this->string(255)->notNull(),
@@ -40,39 +41,28 @@ public function up()
         ], $tableOptions);
 
         // Add Indexes for performance optimization
-        $this->createIndex('roles_unique_key', 'roles', 'key', true);
+        $this->createIndex('roles_unique_key', Constants::TABLE_ROLES, 'key', true);
 
         // Create role permissions mapping table
-        $this->createTable('role_permissions', [
+        $this->createTable(Constants::TABLE_ROLE_PERMISSIONS, [
             'id' => $this->primaryKey(),
             'role_id' => $this->integer()->notNull(),
             'permission_id' => $this->integer()->notNull(),
             'created_at' => $this->dateTime()->notNull()
         ], $tableOptions);
 
         // Add Indexes for performance optimization
-        $this->createIndex('rp_role_id_composite', 'role_permissions', ['role_id', 'permission_id'], true);
+        $this->createIndex('rp_role_id_composite', Constants::TABLE_ROLE_PERMISSIONS, ['role_id', 'permission_id'], true);
 
         // Add Foreign Keys
-        $this->addForeignKey('rp_roles_role_id', 'role_permissions', 'role_id', 'roles', 'id');
-        $this->addForeignKey('rp_roles_permission_id', 'role_permissions', 'permission_id', 'permissions', 'id');
+        $this->addForeignKey('rp_roles_role_id', Constants::TABLE_ROLE_PERMISSIONS, 'role_id', Constants::TABLE_ROLES, 'id');
+        $this->addForeignKey('rp_roles_permission_id', Constants::TABLE_ROLE_PERMISSIONS, 'permission_id', Constants::TABLE_PERMISSIONS, 'id');
     }
 
     public function down()
     {
-        $this->dropTable("role_permissions");
-        $this->dropTable("permissions");
-        $this->dropTable("roles");
-    }
-
-    /*
-    // Use safeUp/safeDown to run migration code within a transaction
-    public function safeUp()
-    {
-    }
-
-    public function safeDown()
-    {
+        $this->dropTable(Constants::TABLE_ROLE_PERMISSIONS);
+        $this->dropTable(Constants::TABLE_PERMISSIONS);
+        $this->dropTable(Constants::TABLE_ROLES);
     }
-    */
 }
diff --git a/migrations/m170914_110639_alter_roles_permissions.php b/migrations/m170914_110639_alter_roles_permissions.php
@@ -0,0 +1,66 @@
+<?php
+
+use cottacush\rbac\libs\Constants;
+use yii\db\Migration;
+
+/**
+ * Class m170914_110639_alter_user_credentials
+ * @author Olawale Lawal <[email protected]>
+ */
+class m170914_110639_alter_roles_permissions extends Migration
+{
+    public function up()
+    {
+        //PERMISSIONS
+        $this->alterColumn(
+            Constants::TABLE_PERMISSIONS,
+            'status',
+            $this->string(100)->notNull()->defaultValue(Constants::STATUS_ACTIVE)
+        );
+
+        $this->createIndex(
+            'k_' . Constants::TABLE_PERMISSIONS . '_status',
+            Constants::TABLE_PERMISSIONS,
+            'status'
+        );
+
+        //ROLES
+        $this->alterColumn(
+            Constants::TABLE_ROLES,
+            'status',
+            $this->string(100)->notNull()->defaultValue(Constants::STATUS_ACTIVE)
+        );
+
+        $this->createIndex(
+            'k_' . Constants::TABLE_ROLES . '_status',
+            Constants::TABLE_ROLES,
+            'status'
+        );
+    }
+
+    public function down()
+    {
+        $this->dropIndex(
+            'k_' . Constants::TABLE_ROLES . '_status',
+            Constants::TABLE_ROLES
+        );
+
+        $this->alterColumn(
+            Constants::TABLE_ROLES,
+            'status',
+            $this->boolean()->defaultValue(1)
+        );
+
+
+        $this->dropIndex(
+            'k_' . Constants::TABLE_PERMISSIONS . '_status',
+            Constants::TABLE_PERMISSIONS
+        );
+
+        $this->alterColumn(
+            Constants::TABLE_PERMISSIONS,
+            'status',
+            $this->boolean()->defaultValue(1)
+        );
+    }
+}
diff --git a/src/BasePermissionManager.php b/src/BasePermissionManager.php
@@ -5,23 +5,23 @@
 
 namespace cottacush\rbac;
 
-use cottacush\rbac\models\Role;
 use Yii;
 use yii\base\Component;
 use yii\helpers\ArrayHelper;
 
 abstract class BasePermissionManager extends Component implements ManagerInterface
 {
     protected $sessionPrefix = 'cottacush_rbac';
+
     /**
      * @author Adegoke Obasa <[email protected]>
      * @inheritdoc
      */
     public function canAccess($permissionKey)
     {
         $permissions = $this->getPermissions();
-        foreach($permissions as $permission) {
-            if(ArrayHelper::getValue($permission, 'key') === $permissionKey) {
+        foreach ($permissions as $permission) {
+            if (ArrayHelper::getValue($permission, 'key') === $permissionKey) {
                 return true;
             }
         }
@@ -30,8 +30,6 @@ public function canAccess($permissionKey)
 
     /**
      * @author Adegoke Obasa <[email protected]>
-     * @param $roleKey
-     * @return mixed
      */
     public function setRoleByKey($roleKey)
     {
@@ -42,11 +40,11 @@ public function setRoleByKey($roleKey)
     /**
      * @author Adegoke Obasa <[email protected]>
      * @param $roleId
-     * @return mixed
+     * @return void
      */
     public function setRoleById($roleId)
     {
         $role = $this->getRoleById($roleId);
         Yii::$app->session->set($this->sessionPrefix . '::user_role', $role);
     }
-}
+}
diff --git a/src/DbPermissionManager.php b/src/DbPermissionManager.php
@@ -5,12 +5,12 @@
 
 namespace cottacush\rbac;
 
+use cottacush\rbac\libs\Constants;
 use cottacush\rbac\models\Permission;
 use cottacush\rbac\models\Role;
 
 class DbPermissionManager extends BasePermissionManager
 {
-
     /**
      * @author Adegoke Obasa <[email protected]>
      * @return mixed
@@ -27,7 +27,7 @@ public function getRoles()
      */
     public function getRole($key)
     {
-        return Role::find()->where(['key' => $key, 'status' => 1])->one();
+        return Role::find()->where(['key' => $key, 'status' => Constants::STATUS_ACTIVE])->limit(1)->one();
     }
 
     /**
@@ -37,7 +37,7 @@ public function getRole($key)
      */
     public function getRoleById($roleId)
     {
-        return Role::find()->where(['id' => $roleId, 'status' => 1])->one();
+        return Role::find()->where(['id' => $roleId, 'status' => Constants::STATUS_ACTIVE])->limit(1)->one();
     }
 
     /**
@@ -56,7 +56,7 @@ public function getPermissions()
      */
     public function getPermission($key)
     {
-        return Permission::find()->where(['key' => $key, 'status' => 1])->one();
+        return Permission::find()->where(['key' => $key, 'status' => Constants::STATUS_ACTIVE])->limit(1)->one();
     }
 
     /**
@@ -66,7 +66,7 @@ public function getPermission($key)
      */
     public function getPermissionById($permissionId)
     {
-        return Permission::find()->where(['id' => $permissionId, 'status' => 1])->one();
+        return Permission::find()->where(['id' => $permissionId, 'status' => Constants::STATUS_ACTIVE])->limit(1)->one();
     }
 
     /**
@@ -92,4 +92,4 @@ public function getUserPermissions()
 
         return $role->getPermissions();
     }
-}
+}
diff --git a/src/libs/Constants.php b/src/libs/Constants.php
@@ -0,0 +1,20 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Lawale
+ * Date: 14/09/2017
+ * Time: 12:07
+ */
+
+namespace cottacush\rbac\libs;
+
+
+class Constants
+{
+    const STATUS_ACTIVE = 'active';
+    const STATUS_INACTIVE = 'inactive';
+
+    const TABLE_PERMISSIONS = "permissions";
+    const TABLE_ROLE_PERMISSIONS = "role_permissions";
+    const TABLE_ROLES = "roles";
+}
diff --git a/src/models/Permission.php b/src/models/Permission.php
@@ -2,7 +2,7 @@
 
 namespace cottacush\rbac\models;
 
-use Yii;
+use yii\db\ActiveRecord;
 
 /**
  * This is the model class for table "permissions".
@@ -17,7 +17,7 @@
  *
  * @property RolePermission[] $rolePermissions
  */
-class Permission extends \yii\db\ActiveRecord
+class Permission extends ActiveRecord
 {
     /**
      * @inheritdoc
@@ -35,7 +35,7 @@ public function rules()
         return [
             [['key', 'label', 'created_at', 'updated_at'], 'required'],
             [['created_at', 'updated_at'], 'safe'],
-            [['status'], 'integer'],
+            [['status'], 'string', 'max' => 100],
             [['key'], 'string', 'max' => 150],
             [['label'], 'string', 'max' => 255],
             [['key'], 'unique']