effective_roles 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5863e0c337f0188827f98f64036bfc3750a722756922e1bba2e78e560a3f3c86
-  data.tar.gz: 856fdc2b51de291936a16b593a538d77b419b9fb1a18cdbb0c4f432cabf884e7
+  metadata.gz: ff6ad1f95215dd736ce5bd90f0754ea6504a1227acaec9941fd18a7734cedd29
+  data.tar.gz: 21ae8733e66d032ad5079bbf61877f968f2f6b036d1c69be1114500750a15cea
 SHA512:
-  metadata.gz: f3a4376eefee3efc1479fe86480b0b80196b45e57a173db955d3bb8d2ea32566a9b541be765de98005a6d0c96c40aaba16b59ef5e66d9e852a315298f59d377f
-  data.tar.gz: c0f838015be8b4ea637557be7abcebbd5cc0ab5220a1e776fc2a4520c12971fd7d92a9dfbbb0ad556c5a53989345676984c5a1dcdc4a488c0d08a2e9cac99bfa
+  metadata.gz: ab959b54a62a9d139532fba9051e49dcbc0b614dcb6421ca856377544c2a36bf085438f8df56d1179a3b2b948d90cfdbb73fea29f806e341df474792178e1565
+  data.tar.gz: 675002338facfd196544a287588d2693ff617afddd506ea9b04122128edc34f2af3f087331d2fcff689f41a762c0522f1ce859bcb7915c053dad4b48c638faa6

data/app/helpers/effective_roles_helper.rb

@@ -1,4 +1,21 @@
 module EffectiveRolesHelper
+
+  def roles_badges(obj)
+    roles = Array(obj.try(:roles) || obj) - [nil, '']
+
+    if (unexpected = roles - EffectiveRoles.roles).present?
+      raise "Unexpected value: #{unexpected}. Expected an acts_as_roleable object or an array of roles."
+    end
+
+    badges = roles.map do |role|
+      color = EffectiveRoles.color(role)
+
+      content_tag(:span, role, class: ("badge badge-#{color}" if color.present?), title: role.to_s.titleize)
+    end
+
+    badges.join(' ').html_safe
+  end
+
   def effective_roles_summary(obj, options = {}) # User or a Post, any acts_as_roleable
     raise 'expected an acts_as_roleable object' unless obj.respond_to?(:roles)
 

data/app/models/concerns/acts_as_role_restricted.rb

@@ -73,7 +73,11 @@ module ActsAsRoleRestricted
     def with_role_sql(*roles)
       roles = roles.flatten.compact
       roles = roles.first.roles if roles.length == 1 && roles.first.respond_to?(:roles)
-      roles = (roles.map { |role| role.to_sym } & EffectiveRoles.roles)
+      roles = roles.map { |role| role.to_sym }
+
+      if(invalid = (roles - EffectiveRoles.roles)).present?
+        raise("unknown role :#{invalid.to_sentence}")
+      end
 
       roles.map { |role| "(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.roles.index(role) }.join(' OR ')
     end
@@ -81,7 +85,11 @@ module ActsAsRoleRestricted
     def without_role(*roles)
       roles = roles.flatten.compact
       roles = roles.first.roles if roles.length == 1 && roles.first.respond_to?(:roles)
-      roles = (roles.map { |role| role.to_sym } & EffectiveRoles.roles)
+      roles = roles.map { |role| role.to_sym }
+
+      if(invalid = (roles - EffectiveRoles.roles)).present?
+        raise("unknown role :#{invalid.to_sentence}")
+      end
 
       where(
         roles.map { |role| "NOT(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.roles.index(role) }.join(' AND ')

data/config/effective_roles.rb

@@ -23,11 +23,17 @@ EffectiveRoles.setup do |config|
   # Or just keep it simple, and use this Hash syntax of permissions for every resource
   #
   config.role_descriptions = {
-    :superadmin => 'full access to everything. Can manage users and all website content.',
-    :admin => 'full access to website content.  Cannot manage users.',
-    :member => 'cannot access admin area.  Can see all content in members-only sections of the website.'
+    superadmin: 'full access to everything. Can manage users and all website content.',
+    admin: 'full access to website content.  Cannot manage users.',
+    member: 'cannot access admin area.  Can see all content in members-only sections of the website.'
   }
 
+  # config.role_colors
+  # ========================
+  # Assign a bootstrap color to a role. Optional.
+  # Used by the roles_badges() helper to display this role as a badge
+  # config.role_colors = { superadmin: :primary, admin: :secondary, member: :light }
+
   # config.assignable_roles
   # Which roles can be assigned by whom
   # =======================

data/lib/effective_roles/version.rb

@@ -1,3 +1,3 @@
 module EffectiveRoles
-  VERSION = '2.5.0'.freeze
+  VERSION = '2.7.0'.freeze
 end

data/lib/effective_roles.rb

@@ -5,7 +5,7 @@ require 'effective_roles/version'
 module EffectiveRoles
 
   def self.config_keys
-    [:roles, :role_descriptions, :assignable_roles, :layout]
+    [:roles, :role_descriptions, :role_colors, :assignable_roles, :layout]
   end
 
   include EffectiveGem
@@ -39,6 +39,11 @@ module EffectiveRoles
     roles_for(roles).map { |r| 2 ** config.roles.index(r) }.sum
   end
 
+  def self.color(role)
+    raise('expected a role') unless role.kind_of?(Symbol)
+    (role_colors || {})[role]
+  end
+
   def self.roles_collection(resource, current_user = nil, only: nil, except: nil, multiple: nil, skip_disabled: nil)
     if assignable_roles.present?
       raise('expected object to respond to is_role_restricted?') unless resource.respond_to?(:is_role_restricted?)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_roles
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails