resource based permission generator added, permission from routes move to a generator class, permission class refactored

Nur Alam · Nur Alam · commit a1f09f697cb7 · 2022-11-10T02:13:34.000+06:00
diff --git a/README.md b/README.md
@@ -23,6 +23,19 @@ Publish default permission view files (optional)
 
 # Usage
 
+Here are some defined routes for department
+
+![Stats](img/department-rouets.png)
+### Now get permissions names from defined routes
+
+    RadiateCode\PermissionNameGenerator\Permissions::make()->get();
+
+**Output**
+
+![Stats](img/permissions.png)
+
+> Notice the key `department-permissions` it generated from `DepartmentController` and permissions are generated from DepartmentController's routes.
+
 ## PermissionGenerator trait [Optional]
 While this package generate permission names from route names, in some cases we might need to exclude some routes so that it won't generate as permission names. To do so implement the **WithPermissionGenerator** contracts in the controller, then use the **PermissionGenerator** trait. 
 
@@ -50,16 +63,6 @@ class OfficeController extends Controller implements WithPermissionGenerator
 
 > **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/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
 
@@ -77,7 +80,7 @@ The package comes with predefined a view with permission names
 >   $request->get('permissions');  // array of permissions
 > ```
 
-## Example
+### Example
 **In controller:**
 
 ```php
@@ -184,7 +187,7 @@ Config the **config/permission-generator.php** file.
 > Note: notice the `user-permission` key which contains only permission name, the package dynamically make a title for the permission name.
 >
 
-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.
+3. 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 defined controllers.
 
 ```php
 /**
diff --git a/config/permission-generator.php b/config/permission-generator.php
@@ -57,5 +57,14 @@
      *
      * [NT: Predefined permission cards works on bootstrap]
      */
-    'card-size-class'               => 'col-md-3 col-lg-3 col-sm-12',
+    'card-size-class' => 'col-md-3 col-lg-3 col-sm-12',
+
+
+    'resource-permission-tags' => [
+        'create',
+        'edit',
+        'show',
+        'delete',
+        'view-list'
+    ],
 ];
diff --git a/img/department-rouets.png b/img/department-rouets.png
diff --git a/resources/views/permission.blade.php b/resources/views/permission.blade.php
@@ -10,7 +10,7 @@
         </div>
     </div>
 
-    @foreach($routes as $key => $values)
+    @foreach($permissions as $key => $values)
     <div class="{{ config('permission-generator.card-size-class') }}">
         <div class="card permission-card">
             <div class="card-header permission-header">
@@ -25,7 +25,7 @@
             </div>
             <div class="card-body">
                 <div class="row">
-                    <div class="{{ $key }}-routes-checkbox">
+                    <div class="{{ $key }}-permissions-checkbox">
                         <ul style="list-style-type: none">
                            @foreach($values as $route)
                                 <li>
diff --git a/resources/views/scripts.blade.php b/resources/views/scripts.blade.php
@@ -3,7 +3,7 @@
         var permission_id = $(this).attr('id');
         var isChecked = $(this).is(':checked');
 
-        $('.' + permission_id + '-routes-checkbox ul li').each(function () {
+        $('.' + permission_id + '-permissions-checkbox ul li').each(function () {
             $(this).find(':checkbox').prop('checked', isChecked);
         });
     });
diff --git a/src/Html/Builder.php b/src/Html/Builder.php
@@ -50,14 +50,12 @@ public function view(string $view, array $data = [])
             ->with('permissionScripts', $this->scripts());
     }
 
-    protected function render(): string
+    protected function render(array $permissions = []): string
     {
-        dd(Permissions::make()->get());
-        
         return View::make(
             'permission-generator::permission',
             [
-                'routes'          => Permissions::make()->get(),
+                'permissions'     => Permissions::make()->fromRoutes()->get(),
                 'roleName'        => $this->roleName,
                 'rolePermissions' => $this->rolePermissions,
             ]
@@ -68,4 +66,4 @@ protected function scripts(): string
     {
         return View::make('permission-generator::scripts', ['url' => $this->url])->render();
     }
-}
+}
diff --git a/src/Permissions.php b/src/Permissions.php
@@ -3,21 +3,15 @@
 
 namespace RadiateCode\PermissionNameGenerator;
 
-
-use Illuminate\Support\Arr;
-use Illuminate\Support\Str;
+use Closure;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Facades\Route;
-use RadiateCode\PermissionNameGenerator\Contracts\WithPermissionGenerator;
 use RadiateCode\PermissionNameGenerator\Enums\Constant;
+use RadiateCode\PermissionNameGenerator\Services\ResourcePermissionGenerator;
+use RadiateCode\PermissionNameGenerator\Services\RoutePermissionGenerator;
 
 class Permissions
 {
-    private $controllerNamespacePrefixes = [];
-
-    private $globalExcludeControllers = [];
-
-    protected $onlyPermissions = [];
+    protected $onlyPermissionsNames = [];
 
     protected $permissions = [];
 
@@ -26,115 +20,63 @@ class Permissions
     public function __construct()
     {
         $this->splitter = config('permission-generator.route-name-splitter-needle');
-
-        $this->generate();
     }
 
     public static function make(): Permissions
     {
         return new self();
     }
 
-    public function get(): array
-    {
-        return $this->getCachedPermissions();
-    }
-
-    public function getOnlyPermissions()
-    {
-        if (!$this->hasCachedPermissions()) {
-            return $this->onlyPermissions;
-        }
-
-        return Cache::get(Constant::CACHE_ONLY_PERMISSIONS);
+    public function fromAttributes(){
+        
     }
 
-    protected function generate(): Permissions
+    public function fromResources(array $resources)
     {
         if ($this->hasCachedPermissions()) {
             return $this;
         }
 
-        $this->controllerNamespacePrefixes = config(
-            'permission-generator.controller-namespace-prefixes'
-        );
-
-        $this->globalExcludeControllers = config(
-            'permission-generator.exclude-controllers'
-        );
+        $resourceGenerator = (new ResourcePermissionGenerator($resources))->generate();
 
-        $globalExcludedRoutes = config('permission-generator.exclude-routes');
-
-        $routes = Route::getRoutes();
-
-        $tempRoutes = [];
-
-        foreach ($routes as $route) {
-            $routeName = $route->getName();
-
-            // exclude routes which defined in the config
-            if (in_array($routeName, $globalExcludedRoutes)) {
-                continue;
-            }
+        $this->permissions = $resourceGenerator['permissions'];
+        $this->onlyPermissionsNames = $resourceGenerator['only_permission_names'];
 
-            $actionName = $route->getActionName();
-
-            $actionExtract = explode('@', $actionName);
-
-            $controller = $actionExtract[0];
-
-            // $routeMiddlewares = $route->gatherMiddleware();
-
-            if (
-                $controller == 'Closure'
-                || !$this->isControllerValid($controller)
-                || $this->isExcludedController($controller)
-            ) {
-                continue;
-            }
-
-
-            $controllerInstance = app('\\' . $controller);
-
-            // if the controller use the WithPermissible interface then find the excluded routes
-            if ($controllerInstance instanceof WithPermissionGenerator) {
-                $controllerMethod = $actionExtract[1];
+        $this->customPermissions();
+       // $this->cachePermissions();
 
-                $excludeMethods = $controllerInstance->getExcludeMethods();
+        return $this;
+    }
 
-                if (in_array($controllerMethod, $excludeMethods)) {
-                    continue;
-                }
-            }
+    public function fromRoutes()
+    {
+        if ($this->hasCachedPermissions()) {
+            return $this;
+        }
 
-            $tempPluckRoutes = Arr::pluck($tempRoutes, 'slug');
+        $routePermissionGenerator = (new RoutePermissionGenerator())->generate();
 
-            // check is the current route store in temp routes in order to avoid duplicacy
-            if (in_array($routeName, $tempPluckRoutes)) {
-                continue;
-            }
+        $this->permissions = $routePermissionGenerator['permissions'];
+        $this->onlyPermissionsNames = $routePermissionGenerator['only_permission_names'];
 
-            // permission group title
-            $title = $this->generatePermissionTitle($controllerInstance);
-
-            $key = strtolower(Str::slug($title, "-"));
+        $this->customPermissions();
+        //$this->cachePermissions();
 
-            $this->permissions[$key][] = [
-                'name' => $routeName, // permission name
-                'title' => ucwords(str_replace($this->splitter, ' ', $routeName)), // permission title
-            ];
+        return $this;
+    }
 
-            $this->onlyPermissions[] = $routeName;
+    public function get(): array
+    {
+        return $this->getCachedPermissions();
+    }
 
-            $tempRoutes = $this->permissions[$key];
+    public function getOnlyPermissionsNames()
+    {
+        if (!$this->hasCachedPermissions()) {
+            return $this->onlyPermissionsNames;
         }
 
-        // add custom permissions to rendered permissions
-        $this->customPermissions();
-
-        $this->cachePermissions();
-
-        return $this;
+        return Cache::get(Constant::CACHE_ONLY_PERMISSIONS);
     }
 
     protected function customPermissions(): Permissions
@@ -144,7 +86,7 @@ protected function customPermissions(): Permissions
         if (is_array($customPermissions) && !empty($customPermissions)) {
             foreach ($customPermissions as $key => $permission) {
                 // when the permission only contains permission name
-                if (array_key_exists(0, $permission) && is_array($permission)) { 
+                if (array_key_exists(0, $permission) && is_array($permission)) {
                     foreach ($permission as $item) {
                         $this->permissions[$key][] = [
                             'name' => $item,
@@ -163,52 +105,6 @@ protected function customPermissions(): Permissions
         return $this;
     }
 
-    protected function generatePermissionTitle($controllerInstance)
-    {
-        // if the controller use the WithPermissible interface then get the title
-        if ($controllerInstance instanceof WithPermissionGenerator) {
-            $title = $controllerInstance->getPermissionTitle();
-
-            if (!empty($title)) {
-                return $title;
-            }
-        }
-
-        // Or, generate permission title from controller name
-        $controllerName = class_basename($controllerInstance);
-
-        // place white space between controller (PascalCase) name
-        $name = preg_replace('/([a-z])([A-Z])/s', '$1 $2', $controllerName);
-
-        if (Str::contains($controllerName, 'Controller')) {
-            return str_replace('Controller', 'Permissions', $name);
-        }
-
-        return $name . ' Permissions';
-    }
-
-    protected function isExcludedController($controller): bool
-    {
-        foreach ($this->globalExcludeControllers as $prefix) {
-            if (Str::contains($controller, $prefix)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    protected function isControllerValid($controller): bool
-    {
-        foreach ($this->controllerNamespacePrefixes as $prefix) {
-            if (Str::contains($controller, $prefix)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
     protected function getCachedPermissions()
     {
         if (!$this->hasCachedPermissions()) {
@@ -235,7 +131,7 @@ protected function cachePermissions()
 
             Cache::put(
                 Constant::CACHE_ONLY_PERMISSIONS,
-                $this->onlyPermissions,
+                $this->onlyPermissionsNames,
                 now()->addDay()
             );
         }
diff --git a/src/Services/AttributePermissionGenerator.php b/src/Services/AttributePermissionGenerator.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace RadiateCode\PermissionNameGenerator\Services;
+
+class AttributePermissionGenerator
+{
+    
+}
diff --git a/src/Services/ResourcePermissionGenerator.php b/src/Services/ResourcePermissionGenerator.php
diff --git a/src/Services/RoutePermissionGenerator.php b/src/Services/RoutePermissionGenerator.php

Original file line number	Diff line number	Diff line change
`@@ -50,14 +50,12 @@ public function view(string $view, array $data = [])`
`50`	`50`	`->with('permissionScripts', $this->scripts());`
`51`	`51`	`}`
`52`	`52`
`53`		`- protected function render(): string`
	`53`	`+ protected function render(array $permissions = []): string`
`54`	`54`	`{`
`55`		`- dd(Permissions::make()->get());`
`56`		`-`
`57`	`55`	`return View::make(`
`58`	`56`	`'permission-generator::permission',`
`59`	`57`	`[`
`60`		`- 'routes' => Permissions::make()->get(),`
	`58`	`+ 'permissions' => Permissions::make()->fromRoutes()->get(),`
`61`	`59`	`'roleName' => $this->roleName,`
`62`	`60`	`'rolePermissions' => $this->rolePermissions,`
`63`	`61`	`]`
`@@ -68,4 +66,4 @@ protected function scripts(): string`
`68`	`66`	`{`
`69`	`67`	`return View::make('permission-generator::scripts', ['url' => $this->url])->render();`
`70`	`68`	`}`
`71`		`-}`
	`69`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<?php
++
 +namespace RadiateCode\PermissionNameGenerator\Services;
++
 +class AttributePermissionGenerator
 +{
++
 +}