fix the inconsistent naming of the -method

spatie · Sep 30, 2015 · eb7a455 · eb7a455
1 parent a85e8f1
commit eb7a455
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All Notable changes to `laravel-permission` will be documented in this file
 
+## 1.0.1 - 2015-09-30
+
+### Fixed
+- Fixed the inconsistent naming of the `hasPermission`-method.
+
 ## 1.0.0 - 2015-09-16
 
 ### Added

diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ $user->revokePermissionTo('edit articles');
 
 You can test if a user has a permission:
 ```php
-$user->hasPermission('edit articles');
+$user->hasPermissionTo('edit articles');
 ```
 
 Saved permissions will be registered with the `Illuminate\Auth\Access\Gate`-class. So you can

diff --git a/src/Models/Permission.php b/src/Models/Permission.php
@@ -33,7 +33,9 @@ public static function findByName($name)
     {
         $permission = static::where('name', $name)->first();
 
-        if (!$permission) throw new PermissionDoesNotExist();
+        if (!$permission) {
+            throw new PermissionDoesNotExist();
+        }
 
         return $permission;
     }

diff --git a/src/Models/Role.php b/src/Models/Role.php
@@ -35,7 +35,9 @@ public static function findByName($name)
     {
         $role = static::where('name', $name)->first();
 
-        if (!$role) throw new RoleDoesNotExist();
+        if (!$role) {
+            throw new RoleDoesNotExist();
+        }
 
         return $role;
     }

diff --git a/src/PermissionRegistrar.php b/src/PermissionRegistrar.php
@@ -46,7 +46,7 @@ public function registerPermissions()
             $this->getPermissions()->map(function ($permission) {
 
                 $this->gate->define($permission->name, function ($user) use ($permission) {
-                    return $user->hasPermission($permission);
+                    return $user->hasPermissionTo($permission);
                 });
 
             });

diff --git a/src/Traits/HasRoles.php b/src/Traits/HasRoles.php
@@ -81,7 +81,7 @@ public function hasRole($roles)
      *
      * @return bool
      */
-    public function hasPermission($permission)
+    public function hasPermissionTo($permission)
     {
         if (is_string($permission)) {
             $permission = Permission::findByName($permission);
@@ -90,11 +90,39 @@ public function hasPermission($permission)
         return $this->hasDirectPermission($permission) || $this->hasPermissionViaRole($permission);
     }
 
+    /**
+     * @deprecated deprecated since version 1.0.1, use hasPermissionTo instead
+     *
+     * Determine if the user may perform the given permission.
+     *
+     * @param Permission $permission
+     *
+     * @return bool
+     */
+    public function hasPermission($permission)
+    {
+        return $this->hasPermissionTo($permission);
+    }
+
+    /**
+     * Determine if the user has, via roles, has the given permission.
+     *
+     * @param Permission $permission
+     *
+     * @return bool
+     */
     protected function hasPermissionViaRole(Permission $permission)
     {
         return $this->hasRole($permission->roles);
     }
 
+    /**
+     * Determine if the user has has the given permission.
+     *
+     * @param Permission $permission
+     *
+     * @return bool
+     */
     protected function hasDirectPermission(Permission $permission)
     {
         if (is_string($permission)) {

diff --git a/tests/GateTest.php b/tests/GateTest.php
@@ -16,7 +16,7 @@ public function it_can_determine_if_a_user_has_a_permission_when_using_roles()
 
         $this->testUser->assignRole($this->testRole);
 
-        $this->assertTrue($this->testUser->hasPermission($this->testPermission));
+        $this->assertTrue($this->testUser->hasPermissionTo($this->testPermission));
 
         $this->assertTrue($this->reloadPermissions());
 

diff --git a/tests/HasRolesTest.php b/tests/HasRolesTest.php
@@ -63,7 +63,7 @@ public function it_can_determine_if_a_user_has_one_of_the_given_roles()
      */
     public function it_can_determine_that_the_user_does_not_have_a_permission()
     {
-        $this->assertFalse($this->testUser->hasPermission('edit-articles'));
+        $this->assertFalse($this->testUser->hasPermissionTo('edit-articles'));
     }
 
     /**
@@ -75,7 +75,7 @@ public function it_can_assign_a_permission_to_a_role()
 
         $this->testUser->assignRole('testRole');
 
-        $this->assertTrue($this->testUser->hasPermission('edit-articles'));
+        $this->assertTrue($this->testUser->hasPermissionTo('edit-articles'));
     }
 
     /**
@@ -87,11 +87,11 @@ public function it_can_revoke_a_permission_from_a_role()
 
         $this->testUser->assignRole('testRole');
 
-        $this->assertTrue($this->testUser->hasPermission('edit-articles'));
+        $this->assertTrue($this->testUser->hasPermissionTo('edit-articles'));
 
         $this->testRole->revokePermissionTo('edit-articles');
 
-        $this->assertFalse($this->testUser->hasPermission('edit-articles'));
+        $this->assertFalse($this->testUser->hasPermissionTo('edit-articles'));
     }
 
     /**
@@ -103,7 +103,7 @@ public function it_can_assign_a_permission_to_a_role_using_objects()
 
         $this->testUser->assignRole($this->testRole);
 
-        $this->assertTrue($this->testUser->hasPermission($this->testPermission));
+        $this->assertTrue($this->testUser->hasPermissionTo($this->testPermission));
     }
 
     /**
@@ -115,7 +115,7 @@ public function it_can_assign_a_permission_to_a_user()
 
         $this->refreshTestUser();
 
-        $this->assertTrue($this->testUser->hasPermission($this->testPermission));
+        $this->assertTrue($this->testUser->hasPermissionTo($this->testPermission));
     }
 
     /**
@@ -127,12 +127,34 @@ public function it_can_revoke_a_permission_from_a_user()
 
         $this->refreshTestUser();
 
-        $this->assertTrue($this->testUser->hasPermission($this->testPermission));
+        $this->assertTrue($this->testUser->hasPermissionTo($this->testPermission));
 
         $this->testUser->revokePermissionTo($this->testPermission);
 
         $this->refreshTestUser();
 
-        $this->assertFalse($this->testUser->hasPermission($this->testPermission));
+        $this->assertFalse($this->testUser->hasPermissionTo($this->testPermission));
+    }
+
+    /**
+     * @test
+     *
+     * @deprecated
+     */
+    public function it_can_check_permissions_with_the_deprecated_has_permission_method()
+    {
+        $this->assertSame(
+            $this->testUser->hasPermissionTo($this->testPermission),
+            $this->testUser->hasPermission($this->testPermission)
+        );
+
+        $this->testUser->givePermissionTo($this->testPermission);
+
+        $this->refreshTestUser();
+
+        $this->assertSame(
+            $this->testUser->hasPermissionTo($this->testPermission),
+            $this->testUser->hasPermission($this->testPermission)
+        );
     }
 }