bug fixed, read me updated

Author: Nur Alam

README.md

@@ -2,7 +2,7 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/radiatecode/laravel-permission-name-generator.svg?style=flat-square)](https://packagist.org/packages/radiatecode/laravel-permission-name-generator)
 [![Total Downloads](https://img.shields.io/packagist/dt/radiatecode/laravel-permission-name-generator.svg?style=flat-square)](https://packagist.org/packages/radiatecode/laravel-permission-name-generator)
 
-This package will generate permission names from routes. In many application we create static permission names (ex: create-post, edit-post, delete-post) to check user's accessability, using the package can helps you to generate permission names dynamically.
+This package will generate permission names from route names. In many application we create static permission names (ex: create-post, edit-post, delete-post) to check user's accessability, using the package can helps you to generate permission names dynamically.
 # Requirements
 - [PHP >= 7.1](https://www.php.net/)
 - [Laravel 5.7|6.x|7.x|8.x](https://github.com/laravel/framework)
@@ -48,15 +48,17 @@ class OfficeController extends Controller implements WithPermissionGenerator
 }
 ```
 
-> **PermissionGenerator** trait is optional. Because if no permissible title defined, then this package dynamically generate a title based on controller name, And routes can be excluded in the config file.
+> **PermissionGenerator** trait is optional. Because if no group permission title defined, then this package dynamically generate a title based on controller name. Routes can be excluded in the config file in order to tell the package not to generate those routes as permission names.
 
 ## Get permissions names
 
     RadiateCode\PermissionNameGenerator\Permissions::make()->get();
 
 **Output**
 
-![Stats](img/permissible-routes-output.png)
+![Stats](img/permissions.png)
+
+> Notice the key `department-permissions` it generated from `DepartmentController` and permissions are generated from DepartmentController's routes.
 
 ## Permission View Builder Facade
 The package comes with predefined a view with permission names
@@ -76,9 +78,6 @@ The package comes with predefined a view with permission names
 > ```
 
 ## Example
-### Permissions view
-![Stats](img/permission-view.png)
-
 **In controller:**
 
 ```php
@@ -99,27 +98,6 @@ class RoleController extends Controller
     }
 }
 ```
-**Create the permission savings route**
-
-```php
-Route::post('/role/{id}/permissions/create',[RoleController::class,'permissionStore'])->name('create-role-permission');
-```
-```php
-use \Illuminate\Http\Request;
-class RoleController extends Controller
-{
-     public function permissionStore(Request $request,$id)
-    {
-        $role = Role::find($id);
-
-        $role->role_permissions = json_encode($request->get('permissions')); // get the submitted permissions
-        $role->save();
-
-        return response()->json('success',201);
-    }
-}
-```
-
 **In app/role/permissions.blade.php file:**
 ```html
 @extends('layouts.app')
@@ -147,12 +125,35 @@ class RoleController extends Controller
 ```
 
 > The layout is only for demo purpose, you should only notice the `$permissionCards` and `$permissionScripts` variables, and put those acording to your view layout. 
+### Permissions view
+![Stats](img/permission-view.png)
+
+**Create the permission savings route**
+
+```php
+Route::post('/role/{id}/permissions/create',[RoleController::class,'permissionStore'])->name('create-role-permission');
+```
+```php
+use \Illuminate\Http\Request;
+class RoleController extends Controller
+{
+     public function permissionStore(Request $request,$id)
+    {
+        $role = Role::find($id);
+
+        $role->role_permissions = json_encode($request->get('permissions')); // get the submitted permissions
+        $role->save();
+
+        return response()->json('success',201);
+    }
+}
+```
 
 ## Configuration
 
 Config the **config/permission-generator.php** file.
 
-1. If route name contains any special char then split the the name by that char. It will use to generate route title. For example if route name is **create.post** then it's title would be **Create Post**
+1. If route name contains any special char then split the name by that char. It will use to generate permission title. For example if route name is **create.post** then permission title would be **Create Post**
 ```php
 /**
  * Split route name by defined needle
@@ -172,18 +173,26 @@ Config the **config/permission-generator.php** file.
 > Example 
 > ```php
 > 'custom-permissions' = [
->    'post-permission' => 'approve-permission',
->    'user-permission' => ['active-user','inactive-user']
+>    'user-permission' => ['active-user','inactive-user'],
+>    'bonus-permission' => [
+>       'name' => 'approve-own-department',
+>       'title' => 'Approve Own Department'
+>     ]
 > ]
+>
 >```
+> Note: notice the `user-permission` key which contains only permission name, the package dynamically make a title for the permission name.
+>
 
-3. Each route associate with controllers, so you have to define the controller namespace so that the generator can generate permission names from those route associate controllers. By default all the controllers associate routes will be generated as permission names.
+3. We can define controller by it's namespace, it could be whole namespace or it could be sub/prefix of controller namespace. This config play vital role to generate permissions because permissions will be generated only for our defined controllers.
 
 ```php
 /**
  * Define controller namespace
  *
- * [NT: permissions will be generated from those controller which contains the defined prefix]
+ * By Default permissions will be generated from all controller's routes
+ * 
+ * [Note: permissions will be generated from those controller which contains the defined prefix]
  */
 'controller-namespace-prefixes' => [
     'App\Http\Controllers',
@@ -193,14 +202,14 @@ Config the **config/permission-generator.php** file.
 
 ```php
  /**
- * Exclude routes by controller or controller namespace-prefix
+ * Exclude routes by controller whole namespace or sub/prefix of controller namespace
  *
- * [NT: We can exclude routes by defining controller name or namespace-prefix. All the routes associated with controller will be excluded]
+ * By default all auth controller's routes will be excluded from being generated as permission names
+ * 
+ * [Note: We can exclude routes by defining controller name or namespace-prefix. All the routes associated with controller will be excluded]
  */
 'exclude-controllers'           => [
-    /*
-        * exclude every route which associate with the prefix namespace
-        */
+    // exclude every route which associate with the namespace-prefix of controller 
     'App\Http\Controllers\Auth',
 ],
 ```

config/permission-generator.php

@@ -17,7 +17,9 @@
     /**
      * Define controller namespace
      *
-     * [NT: permissions will be generated from those controller which contains the defined prefix]
+     * By Default permissions will be generated from all controller's routes
+     * 
+     * [Note: permissions will be generated from those controller which contains the defined whole or prefix of controller namespace]
      */
     'controller-namespace-prefixes' => [
         'App\Http\Controllers',
@@ -31,14 +33,14 @@
     ],
 
     /**
-     * Exclude routes by controller or controller namespace-prefix
+     * Exclude routes by controller whole namespace or sub/prefix of controller namespace
      *
-     * [NT: We can exclude routes by defining controller name or namespace-prefix. All the routes associated with controller will be excluded]
+     * By default all auth controller's routes will be excluded from being generated as permission names
+     * 
+     * [Note: We can exclude routes by defining controller name or namespace-prefix. All the routes associated with controller will be excluded]
      */
     'exclude-controllers'           => [
-        /*
-         * exclude every route which associate with the prefix namespace
-         */
+        // exclude every route which associate with the prefix of controller namespace 
         'App\Http\Controllers\Auth',
     ],
 
@@ -56,4 +58,4 @@
      * [NT: Predefined permission cards works on bootstrap]
      */
     'card-size-class'               => 'col-md-3 col-lg-3 col-sm-12',
-];
+];

img/permissions.png

@@ -29,8 +29,8 @@
                         <ul style="list-style-type: none">
                            @foreach($values as $route)
                                 <li>
-                                    <input type="checkbox" name="permissions[]" value="{{ $route['slug'] }}" id="{{ $route['slug'] }}" {{ in_array($route['slug'],$rolePermissions) ? 'checked' : '' }}>
-                                    <label class="form-check-label" for="{{ $route['slug'] }}">{{ $route['name'] }}</label>
+                                    <input type="checkbox" name="permissions[]" value="{{ $route['name'] }}" id="{{ $route['name'] }}" {{ in_array($route['name'],$rolePermissions) ? 'checked' : '' }}>
+                                    <label class="form-check-label" for="{{ $route['name'] }}">{{ $route['title'] }}</label>
                                 </li>
                             @endforeach
                         </ul>

resources/views/permission.blade.php

@@ -52,6 +52,8 @@ public function view(string $view, array $data = [])
 
     protected function render(): string
     {
+        dd(Permissions::make()->get());
+        
         return View::make(
             'permission-generator::permission',
             [

src/Html/Builder.php

@@ -21,8 +21,12 @@ class Permissions
 
     protected $permissions = [];
 
+    protected $splitter;
+
     public function __construct()
     {
+        $this->splitter = config('permission-generator.route-name-splitter-needle');
+
         $this->generate();
     }
 
@@ -38,7 +42,7 @@ public function get(): array
 
     public function getOnlyPermissions()
     {
-        if (! $this->hasCachedPermissions()) {
+        if (!$this->hasCachedPermissions()) {
             return $this->onlyPermissions;
         }
 
@@ -61,8 +65,6 @@ protected function generate(): Permissions
 
         $globalExcludedRoutes = config('permission-generator.exclude-routes');
 
-        $splitter = config('permission-generator.route-name-splitter-needle');
-
         $routes = Route::getRoutes();
 
         $tempRoutes = [];
@@ -83,15 +85,16 @@ protected function generate(): Permissions
 
             // $routeMiddlewares = $route->gatherMiddleware();
 
-            if ($controller == 'Closure'
-                || ! $this->isControllerValid($controller)
+            if (
+                $controller == 'Closure'
+                || !$this->isControllerValid($controller)
                 || $this->isExcludedController($controller)
             ) {
                 continue;
             }
 
 
-            $controllerInstance = app('\\'.$controller);
+            $controllerInstance = app('\\' . $controller);
 
             // if the controller use the WithPermissible interface then find the excluded routes
             if ($controllerInstance instanceof WithPermissionGenerator) {
@@ -111,13 +114,14 @@ protected function generate(): Permissions
                 continue;
             }
 
+            // permission group title
             $title = $this->generatePermissionTitle($controllerInstance);
 
             $key = strtolower(Str::slug($title, "-"));
 
             $this->permissions[$key][] = [
-                'slug' => $routeName,
-                'name' => ucwords(str_replace($splitter, ' ', $routeName)),
+                'name' => $routeName, // permission name
+                'title' => ucwords(str_replace($this->splitter, ' ', $routeName)), // permission title
             ];
 
             $this->onlyPermissions[] = $routeName;
@@ -137,18 +141,21 @@ protected function customPermissions(): Permissions
     {
         $customPermissions = config('permission-generator.custom-permissions');
 
-        if (is_array($customPermissions) && ! empty($customPermissions)) {
+        if (is_array($customPermissions) && !empty($customPermissions)) {
             foreach ($customPermissions as $key => $permission) {
-                if (array_key_exists(0, $permission)
-                    && is_array($permission[0])
-                ) {
+                // when the permission only contains permission name
+                if (array_key_exists(0, $permission) && is_array($permission)) { 
                     foreach ($permission as $item) {
-                        $this->permissions[$key][] = $item;
+                        $this->permissions[$key][] = [
+                            'name' => $item,
+                            'title' => ucwords(str_replace($this->splitter, ' ', $item)),
+                        ];
                     }
 
                     continue;
                 }
 
+                // when permission has valid permission structure (ex: slug, name key available)   
                 $this->permissions[$key][] = $permission;
             }
         }
@@ -162,7 +169,7 @@ protected function generatePermissionTitle($controllerInstance)
         if ($controllerInstance instanceof WithPermissionGenerator) {
             $title = $controllerInstance->getPermissionTitle();
 
-            if ( ! empty($title)) {
+            if (!empty($title)) {
                 return $title;
             }
         }
@@ -174,10 +181,10 @@ protected function generatePermissionTitle($controllerInstance)
         $name = preg_replace('/([a-z])([A-Z])/s', '$1 $2', $controllerName);
 
         if (Str::contains($controllerName, 'Controller')) {
-            return str_replace('Controller', 'Permission', $name);
+            return str_replace('Controller', 'Permissions', $name);
         }
 
-        return $name.' Permission';
+        return $name . ' Permissions';
     }
 
     protected function isExcludedController($controller): bool
@@ -204,7 +211,7 @@ protected function isControllerValid($controller): bool
 
     protected function getCachedPermissions()
     {
-        if ( ! $this->hasCachedPermissions()) {
+        if (!$this->hasCachedPermissions()) {
             return $this->permissions;
         }
 
@@ -219,7 +226,7 @@ protected function hasCachedPermissions(): bool
 
     protected function cachePermissions()
     {
-        if (! $this->hasCachedPermissions() && ! empty($this->permissions)) {
+        if (!$this->hasCachedPermissions() && !empty($this->permissions)) {
             Cache::put(
                 Constant::CACHE_PERMISSIONS,
                 $this->permissions,
@@ -233,4 +240,4 @@ protected function cachePermissions()
             );
         }
     }
-}
+}