Updated Docs

Author: yubarajshrestha

README.md

@@ -54,28 +54,109 @@ Then you can publish the package resources (if needed) by doing:
 python craft package:publish masonite-permission
 ```
 
+Finally, extend `User` model class with `HasRoles`.
+
+```python
+from masoniteorm.models import Model
+from masoniteorm.scopes import SoftDeletesMixin
+from masonite.authentication import Authenticates
+from masonite_permission.models.has_roles import HasRoles
+
+class User(Model, SoftDeletesMixin, Authenticates, HasRoles):
+    """User Model."""
+
+    __fillable__ = ["name", "email", "password"]
+    __hidden__ = ["password"]
+    __auth__ = "email"
+```
+
 ## Usage
 
+**Role**
+Methods that can be used in role model object:
+
 ```python
-""" Permission Syncing """
-permissions = Permission.all()
-role.sync_permissions(permissions) # sync permissions to role
-role.sync_permissions([]) # remove all permissions from role
+""" collection can be synced """
+permission_collection = Permission.all()
+role = Role.find(1)
+
+role.sync_permissions(permission_collection)
+
+""" id will also work """
+permission_ids = [1,2,3,4,5]
+role.sync_permissions(permission_ids)
+
+""" clear related data """
+role.sync_permissions([])
+
 
 """ Attach/Detatch Permission """
 permission = Permission.first()
 role.attach_permission(permission) # add permission to role, ignores if permission already exists
 role.detach_permission(permission) # remove permission from role, ignores if permission doesn't exist
 
-""" Role Syncing """
-roles = Role.all()
-permission.sync_roles(roles) # sync roles to role
-permissioin.sync_roles([]) # remove all roles from role
+""" this can also be done """
+role.attach_permission(1) # passing permission id instead of object, ignores if permission already exists
+role.detatch_permission(1) # passing permission id instead of object, ignores if permission doesn't exist
+```
+
+**Permission**
+Methods that can be used in permission model object:
+
+```python
+""" collection can be synced """
+roles_collection = Role.all()
+permission = Permission.find(1)
+
+permission.sync_roles(role_collection)
+
+""" id will also work """
+role_ids = [1,2,3,4,5]
+permission.sync_roles(role_ids)
+
+""" clear related data """
+permissioin.sync_roles([])
+
 
 """ Attach/Detatch Role """
 role = Role.first()
 permission.attach_role(role) # add role to permission, ignores if role already exists
 permission.detach_role(role) # remove role from permission, ignores if role doesn't exist
+
+""" this can also be done """
+permission.attach_role(1) # passing role id instead of object, ignores if role already exists
+permission.detatch_role(1) # passing role id instead of object, ignores if role doesn't exist
+```
+
+**User**
+Methods that can be used in user model object:
+
+```python
+user = User.first()
+
+# Add/Remove single role
+role = Role.first()
+
+user.attach_role(role) # or you can pass role id
+user.detatch_role(role) # or you can pass role id
+
+# if you want to add multiple roles
+roles = Role.all()
+
+user.sync_roles(roles) # or you can also pass list of ids...
+
+# remove all roles from user at once
+user.sync_roles([])
+
+# check if user has role
+user.has_role("role-slug") # returns boolean
+
+# check if user has any of the roles
+user.has_any_role(["role-1", "role-2"]) # returns boolean
+
+# check if user has all of the roles
+user.has_all_roles(["role-1", "role-2"]) # returns boolean
+
 ```
 
 ## Contributing
@@ -89,3 +170,7 @@ Please read the [Contributing Documentation](CONTRIBUTING.md) here.
 ## License
 
 Masonite Permission is open-sourced software licensed under the [MIT license](LICENSE).
+
+```
+
+```

masonite.sqlite3

@@ -10,8 +10,19 @@ class HasRoles:
     def roles(self):
         """User can have multiple roles"""
         from ..models.role import Role
-
         return Role
+    
+    def permissions(self):
+        """User can have multiple permissions"""
+        from ..models.permission import Permission
+        
+        roles = self.roles.pluck('id')
+        return (
+            Permission.join("permission_role as pr", "pr.permission_id", "=", "id")
+            .where_in("pr.role_id", roles)
+            .select_raw("permissions.*")
+            .get()
+        )
 
     def has_role(self, role):
         """Check if user has a role"""
@@ -102,4 +113,4 @@ def detatch_role(self, role):
         )
 
         if exists:
-            self.detach("roles", role)
+            self.detach("roles", role)

src/masonite_permission/models/has_roles.py

@@ -2,10 +2,10 @@
 from masonite.views import View
 from masonite.controllers import Controller
 
-# from masoniteorm.query import QueryBuilder
-# from src.masonite_permission.models.permission import Permission
-# from src.masonite_permission.models.role import Role
-# from tests.integrations.app.models.User import User
+from masoniteorm.query import QueryBuilder
+from src.masonite_permission.models.permission import Permission
+from src.masonite_permission.models.role import Role
+from tests.integrations.app.models.User import User
 
 
 class WelcomeController(Controller):
@@ -59,10 +59,11 @@ def test(self):
         QueryBuilder().table("users").bulk_create(users)
         QueryBuilder().table("roles").bulk_create(roles)
         QueryBuilder().table("permissions").bulk_create(permissions)
+        """
 
         user = User.first()
         role = Role.where("slug", "admin").first()
-        permission = Permission.where("slug", "create-user").first()"""
+        permission = Permission.where("slug", "create-user").first()
 
         """Role related methods
         Methods:
@@ -89,5 +90,7 @@ def test(self):
             user.has_any_role(roles)
             user.has_all_roles(roles)
         """
-
-        return "OK"
+        # role.sync_permissions(Permission.all())
+        # return role.permissions
+        # user.attach_role(role)
+        return user.permissions().pluck('name')