Merge pull request #47 from mostafamaklad/v1.6

V1.6.0
mostafamaklad · Feb 17, 2018 · f8d99ab · f8d99ab
2 parents 0680024 + c5e5a63
commit f8d99ab
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 42 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 All Notable changes to `laravel-permission-mongodb` will be documented in this file.
 
+## 1.6.0 - 2018-02-17
+
+### Added
+ - Officially support `laravel 5.6`
+ - Improve Lumen support
+
 ## 1.5.3 - 2018-02-07
 
 ### Added

diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@
 [![Laravel 5.3.x][ico-laravel-5.3]][link-laravel-5.3]
 [![Laravel 5.4.x][ico-laravel-5.4]][link-laravel-5.4]
 [![Laravel 5.5.x][ico-laravel-5.5]][link-laravel-5.5]
+[![Laravel 5.6.x][ico-laravel-5.6]][link-laravel-5.6]
 
 This package allows you to manage user permissions and roles in a database.
 It is inspired from [laravel-permission][link-laravel-permission]. Same code same every thing but it is compatible with [laravel-mongodb][link-laravel-mongodb]
@@ -167,13 +168,33 @@ You can install the package via Composer:
 composer require mostafamaklad/laravel-permission-mongodb
 ```
 
-Copy `vendor/mostafamaklad/laravel-permission-mongodb/config/permission.php` to `config/permission.php`.
+Copy the required files:
 
-In `bootstrap/app.php`, add the following code below other services providers:
+```bash
+cp vendor/mostafamaklad/laravel-permission-mongodb/config/permission.php config/permission.php
+```
+
+You will also need to create another configuration file at `config/auth.php`. Get it on the Laravel repository or just run the following command:
+
+```bash
+curl -Ls https://raw.githubusercontent.com/laravel/lumen-framework/5.5/config/auth.php -o config/auth.php
+```
+
+Then, in `bootstrap/app.php`, register the middlewares:
+
+```php
+$app->routeMiddleware([
+    'auth'       => App\Http\Middleware\Authenticate::class,
+    'permission' => Maklad\Permission\Middlewares\PermissionMiddleware::class,
+    'role'       => Maklad\Permission\Middlewares\RoleMiddleware::class,
+]);
+```
+
+As well as the configuration and the service provider:
 
 ```php
-$app->register(Maklad\Permission\PermissionServiceProvider::class);
 $app->configure('permission');
+$app->register(Maklad\Permission\PermissionServiceProvider::class);
 ```
 
 ## Usage
@@ -723,6 +744,8 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 [ico-laravel-5.4]: https://img.shields.io/badge/Laravel-5.4.x-brightgreen.svg?style=flat-square
 [link-laravel-5.5]: https://laravel.com/docs/5.5
 [ico-laravel-5.5]: https://img.shields.io/badge/Laravel-5.5.x-brightgreen.svg?style=flat-square
+[link-laravel-5.6]: https://laravel.com/docs/5.6
+[ico-laravel-5.6]: https://img.shields.io/badge/Laravel-5.6.x-brightgreen.svg?style=flat-square
 
 [link-travis]: https://travis-ci.org/mostafamaklad/laravel-permission-mongodb
 [ico-travis]: https://img.shields.io/travis/mostafamaklad/laravel-permission-mongodb/master.svg?style=flat-square

diff --git a/src/Middlewares/PermissionMiddleware.php b/src/Middlewares/PermissionMiddleware.php
@@ -23,15 +23,15 @@ class PermissionMiddleware
      */
     public function handle($request, Closure $next, $permission)
     {
-        if (auth()->guest()) {
+        if (app('auth')->guest()) {
             $helpers = new Helpers();
             throw new UserNotLoggedIn(403, $helpers->getUserNotLoggedINMessage());
         }
 
         $permissions = \is_array($permission) ? $permission : \explode('|', $permission);
 
 
-        if (! auth()->user()->hasAnyPermission($permissions)) {
+        if (! app('auth')->user()->hasAnyPermission($permissions)) {
             $helpers = new Helpers();
             throw new UserNotLoggedIn(403, $helpers->getUnauthorizedPermissionMessage(implode(', ', $permissions)));
         }

diff --git a/src/Middlewares/RoleMiddleware.php b/src/Middlewares/RoleMiddleware.php
@@ -23,14 +23,14 @@ class RoleMiddleware
      */
     public function handle($request, Closure $next, $role)
     {
-        if (auth()->guest()) {
+        if (app('auth')->guest()) {
             $helpers = new Helpers();
             throw new UserNotLoggedIn(403, $helpers->getUserNotLoggedINMessage());
         }
 
         $roles = \is_array($role) ? $role : \explode('|', $role);
 
-        if (! auth()->user()->hasAnyRole($roles)) {
+        if (! app('auth')->user()->hasAnyRole($roles)) {
             $helpers = new Helpers();
             throw new UserNotLoggedIn(403, $helpers->getUnauthorizedRoleMessage(implode(', ', $roles)));
         }

diff --git a/src/Models/Role.php b/src/Models/Role.php
@@ -4,8 +4,6 @@
 namespace Maklad\Permission\Models;
 
 use Jenssegers\Mongodb\Eloquent\Model;
-use Jenssegers\Mongodb\Relations\BelongsToMany;
-use Maklad\Permission\Contracts\PermissionInterface;
 use Maklad\Permission\Contracts\RoleInterface;
 use Maklad\Permission\Exceptions\GuardDoesNotMatch;
 use Maklad\Permission\Exceptions\RoleAlreadyExists;
@@ -33,13 +31,13 @@ class Role extends Model implements RoleInterface
      */
     public function __construct(array $attributes = [])
     {
-        $attributes['guard_name'] = $attributes['guard_name'] ?? \config('auth.defaults.guard');
+        $attributes['guard_name'] = $attributes['guard_name'] ?? config('auth.defaults.guard');
 
         parent::__construct($attributes);
 
         $this->helpers = new Helpers();
 
-        $this->setTable(\config('permission.collection_names.roles'));
+        $this->setTable(config('permission.collection_names.roles'));
     }
 
     /**
@@ -92,26 +90,6 @@ public static function findOrCreate(string $name, $guardName = null): RoleInterf
         return $role;
     }
 
-    /**
-     * A role may be given various permissions.
-     * @return BelongsToMany
-     */
-    public function permissions(): BelongsToMany
-    {
-        return $this->belongsToMany(
-            \config('permission.models.permission'),
-            \config('permission.collection_names.role_has_permissions')
-        );
-    }
-
-    /**
-     * A role belongs to some users of the model associated with its guard.
-     */
-    public function users(): BelongsToMany
-    {
-        return $this->belongsToMany($this->helpers->getModelForGuard($this->attributes['guard_name']));
-    }
-
     /**
      * Find a role by its name and guard name.
      *
@@ -123,7 +101,7 @@ public function users(): BelongsToMany
      */
     public static function findByName(string $name, $guardName = null): RoleInterface
     {
-        $guardName = $guardName ?? \config('auth.defaults.guard');
+        $guardName = $guardName ?? config('auth.defaults.guard');
 
         $role = static::where('name', $name)
                       ->where('guard_name', $guardName)
@@ -149,7 +127,7 @@ public static function findByName(string $name, $guardName = null): RoleInterfac
     public function hasPermissionTo($permission): bool
     {
         if (\is_string($permission)) {
-            $permission = \app(Permission::class)->findByName($permission, $this->getDefaultGuardName());
+            $permission = app(Permission::class)->findByName($permission, $this->getDefaultGuardName());
         }
 
         if (! $this->getGuardNames()->contains($permission->guard_name)) {

diff --git a/src/Traits/HasPermissions.php b/src/Traits/HasPermissions.php
@@ -5,6 +5,7 @@
 
 use Illuminate\Support\Collection;
 use Jenssegers\Mongodb\Eloquent\Model;
+use Jenssegers\Mongodb\Relations\BelongsToMany;
 use Maklad\Permission\Contracts\PermissionInterface as Permission;
 use Maklad\Permission\Exceptions\GuardDoesNotMatch;
 use Maklad\Permission\Helpers;
@@ -16,6 +17,26 @@
  */
 trait HasPermissions
 {
+    /**
+     * A role may be given various permissions.
+     * @return BelongsToMany
+     */
+    public function permissions(): BelongsToMany
+    {
+        return $this->belongsToMany(
+            config('permission.models.permission'),
+            config('permission.collection_names.role_has_permissions')
+        );
+    }
+
+    /**
+     * A role belongs to some users of the model associated with its guard.
+     */
+    public function users(): BelongsToMany
+    {
+        return $this->belongsToMany($this->helpers->getModelForGuard($this->attributes['guard_name']));
+    }
+
     /**
      * Grant the given permission(s) to a role.
      *
@@ -26,7 +47,7 @@ trait HasPermissions
      */
     public function givePermissionTo(...$permissions)
     {
-        $permissions = \collect($permissions)
+        $permissions = collect($permissions)
             ->flatten()
             ->map(function ($permission) {
                 return $this->getStoredPermission($permission);
@@ -68,7 +89,7 @@ public function syncPermissions(...$permissions)
      */
     public function revokePermissionTo(...$permissions)
     {
-        \collect($permissions)
+        collect($permissions)
             ->flatten()
             ->map(function ($permission) {
                 $permission = $this->getStoredPermission($permission);
@@ -115,12 +136,12 @@ protected function ensureModelSharesGuard(Model $roleOrPermission)
     protected function getGuardNames(): Collection
     {
         if ($this->guard_name) {
-            return \collect($this->guard_name);
+            return collect($this->guard_name);
         }
 
-        return \collect(\config('auth.guards'))
+        return collect(config('auth.guards'))
             ->map(function ($guard) {
-                return \config("auth.providers.{$guard['provider']}.model");
+                return config("auth.providers.{$guard['provider']}.model");
             })
             ->filter(function ($model) {
                 return \get_class($this) === $model;
@@ -130,7 +151,7 @@ protected function getGuardNames(): Collection
 
     protected function getDefaultGuardName(): string
     {
-        $default = \config('auth.defaults.guard');
+        $default = config('auth.defaults.guard');
 
         return $this->getGuardNames()->first() ?: $default;
     }
@@ -140,7 +161,7 @@ protected function getDefaultGuardName(): string
      */
     public function forgetCachedPermissions()
     {
-        \app(PermissionRegistrar::class)->forgetCachedPermissions();
+        app(PermissionRegistrar::class)->forgetCachedPermissions();
     }
 
     /**
@@ -153,11 +174,11 @@ public function forgetCachedPermissions()
     private function convertToPermissionModels($permissions): Collection
     {
         if (\is_array($permissions)) {
-            $permissions = \collect($permissions);
+            $permissions = collect($permissions);
         }
 
         if (! $permissions instanceof Collection) {
-            $permissions = \collect([$permissions]);
+            $permissions = collect([$permissions]);
         }
 
         $permissions = $permissions->map(function ($permission) {