bullet_train-roles 0.1.10 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e682f8f5469478a7c827332cb3c922a3c7657ef48e2e53d15abaf98b4ea8e7ac
-  data.tar.gz: 15ca75ffc2ebacabebc3632ecc18ce5f20348ad434df094de2ee14eaa05c031e
+  metadata.gz: 30730d97710a95ccb3a1607d68ec6e41316d421555be035900fbb7e112546bd1
+  data.tar.gz: f22d482d9382f630b7fb200f48469644bca171d12535fef117880a69cfcca5e3
 SHA512:
-  metadata.gz: 4a525dc712139149ea12932af58932a3a8ec11ab582c6a5924b88035ea0c67563fb5ea9958cb9dc581b2045b46ff7add98a164383034ae6e3cb03a50f089076f
-  data.tar.gz: 544e1c9ddbde15bd1945529af7d0ae136ff22fc8c2d12a0d8b91c148a61a2bbfa2f4296890ec0e235d1353bbff0394f811e588675e42c56e3b254c4ec6d7abcb
+  metadata.gz: bf8243e967c09351262fbc615f2b61f3d78d72d741a5c6c18ba62cfe8a0c3621ad4219a65768e640d91eaea4b52c930652ecf94323c31861d5222b5738e71790
+  data.tar.gz: 6a8048e3d64762d1578f25b202660606768d38ba6508e89cc7ec33812878d87e139b015286840360d66f04a248b87c2dc3d6b7ef05b76bda70bc1905aa57491b

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    bullet_train-roles (0.1.10)
+    bullet_train-roles (1.2.0)
       active_hash
       activesupport
       cancancan

data/README.md

@@ -142,6 +142,31 @@ permit user, through: :projects_collaborators, parent: :project
 
 In this example, `permit` is smart enough to only apply the permissions granted by a `Projects::Collaborator` record at the level of the `Project` it belongs to. You can turn any model into a grant model by adding `include Roles::Support` and adding a `role_ids:jsonb` attribute. You can look at `Scaffolding::AbsolutelyAbstract::CreativeConcepts::Collaborator` for an example.
 
+
+## Restricting Available Roles
+
+In some situations, you don't want all roles to be available to all Grant Models.  For example, you might have a `project_editor` role that only makes sense when applied at the Project level.  Note that this is only necessary if you want your project_editor to have more limited permissions than an admin user.  If a `project_editor` has full control of their project, you should probably just use the `admin` role.
+
+By default all Grant Models will show all roles as options.  If you want to limit the roles available to a model, use the `roles_only` class method:
+
+```
+class Membership < ApplicationRecord
+  include Roles::Support
+  roles_only :admin, :editor, :reader # Add this line to restrict the Membership model to only these roles
+end
+```
+
+To access the array of all roles available for a particular model, use the `assignable_roles` class method.  For example, in your Membership form, you probably _only_ want to show the assignable_roles as options.  Your view could look like this:
+
+```
+<% Membership.assignable_roles.each do |role| %>
+  <% if role.manageable_by?(current_membership.roles) %>
+    <!-- View component for showing a role option. Probably a checkbox -->
+  <% end %>
+<% end %>
+```
+
+
 ## Debugging
 If you want to see what CanCanCan directives are being created by your permit calls, you can add the `debug: true` option to your `permit` statement in `app/models/ability.rb`.
 

data/bullet_train-roles.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Yaml-backed ApplicationHash for CanCan Roles"
   spec.homepage = "https://github.com/bullet-train-co/bullet_train-roles"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/bullet-train-co/bullet_train-roles"

data/lib/bullet_train/roles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roles
-  VERSION = "0.1.10"
+  VERSION = "1.2.0"
 end

data/lib/roles/permit.rb

@@ -2,11 +2,11 @@
 
 module Roles
   module Permit
-    def permit(user, through:, parent:, debug: false, intermediary: nil, cache_key: nil)
+    def permit(user, through:, parent:, debug: false, intermediary: nil, rails_cache_key: nil)
       # When changing permissions during development, you may also want to do this on each request:
       # User.update_all ability_cache: nil if Rails.env.development?
-      permissions = if cache_key
-        Rails.cache.fetch(cache_key) do
+      permissions = if rails_cache_key
+        Rails.cache.fetch(rails_cache_key) do
           build_permissions(user, through, parent, intermediary)
         end
       else
@@ -16,10 +16,10 @@ module Roles
       begin
         assign_permissions(permissions)
       rescue NameError => e
-        if cache_key
+        if rails_cache_key
           # Cache has become stale with model classes that no longer exist
           Rails.logger.info "Found missing models in cache - #{e.message.squish} - building fresh permissions"
-          Rails.cache.delete(cache_key)
+          Rails.cache.delete(rails_cache_key)
           permissions = build_permissions(user, through, parent, intermediary)
           assign_permissions(permissions)
         else
@@ -31,10 +31,10 @@ module Roles
         puts "###########################"
         puts "Auto generated `ability.rb` content:"
         permissions.map do |permission|
-          if permission.is_debug
-            puts permission.info
+          if permission[:is_debug]
+            puts permission[:info]
           else
-            puts "can #{permission.actions}, #{permission.model}, #{permission.condition}"
+            puts "can #{permission[:actions]}, #{permission[:model]}, #{permission[:condition]}"
           end
         end
         puts "############################"
@@ -43,7 +43,7 @@ module Roles
 
     def assign_permissions(permissions)
       permissions.each do |permission|
-        can(permission.actions, permission.model.constantize, permission.condition) unless permission.is_debug
+        can(permission[:actions], permission[:model].constantize, permission[:condition]) unless permission[:is_debug]
       end
     end
 
@@ -52,14 +52,14 @@ module Roles
       permissions = []
       user.send(through).map(&:roles).flatten.uniq.each do |role|
         unless added_roles.include?(role)
-          permissions << OpenStruct.new(is_debug: true, info: "########### ROLE: #{role.key}")
+          permissions << {is_debug: true, info: "########### ROLE: #{role.key}"}
           permissions += add_abilities_for(role, user, through, parent, intermediary)
           added_roles << role
         end
 
         role.included_roles.each do |included_role|
           unless added_roles.include?(included_role)
-            permissions << OpenStruct.new(is_debug: true, info: "############# INCLUDED ROLE: #{included_role.key}")
+            permissions << {is_debug: true, info: "############# INCLUDED ROLE: #{included_role.key}"}
             permissions += add_abilities_for(included_role, user, through, parent, intermediary)
           end
         end
@@ -72,9 +72,9 @@ module Roles
       permissions = []
       role.ability_generator(user, through, parent, intermediary) do |ag|
         permissions << if ag.valid?
-          OpenStruct.new(is_debug: false, actions: ag.actions, model: ag.model.to_s, condition: ag.condition)
+          {is_debug: false, actions: ag.actions, model: ag.model.to_s, condition: ag.condition}
         else
-          OpenStruct.new(is_debug: true, info: "# #{ag.model} does not respond to #{parent} so we're not going to add an ability for the #{through} context")
+          {is_debug: true, info: "# #{ag.model} does not respond to #{parent} so we're not going to add an ability for the #{through} context"}
         end
       end
       permissions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-roles
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 1.2.0
 platform: ruby
 authors:
 - Prabin Poudel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -209,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="