effective_roles 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f392991013eeab38fcc7b6092c1014078fc2a356833bd5033b9a268987dc512
-  data.tar.gz: 38bb573be4e391b9cfd6141713bd89d29914e46148705588f1859642a5269bed
+  metadata.gz: 72568face118a2d07b1fb427fe30aacbaf1fcc8d49b1b21c2c9b76c4772b7024
+  data.tar.gz: 9ecf2d813dea46623737893ba9bf28bdbf99b07ab8e2d6637a02f3d3c711e7db
 SHA512:
-  metadata.gz: ef6d332b9c6d93d8e28b61e856c93ec20e8c731b2fd02678fd1dcd8e52c2bcd12e1f5b68c891d82a265054065fe5694cc2bd59baa72ddaf2bb4553af28a93739
-  data.tar.gz: e7f10cde194b45115445a09bd99d0da254c81dd611c97cb9f1c25e8cd33181941449aaa20eb45b5b24d4bea0af8397720cf1156865ef0bf217b1798bf103225a
+  metadata.gz: e61f574d94b7bae5a50d9cca54cd53f9f172fc015cdaf88631758e6cb15c87ce63f2390e712e36b7331596b957b995a236f98f5632fa1ceaaea1c23d81905a0f
+  data.tar.gz: 3a54e2cc622c8bd97fc1f2838132ba55509e1a5a37af91ab618792365570b38acf2c7912596055c98d5938230c142e52fb3878428b40bd059567d7575259576b

data/app/controllers/admin/roles_controller.rb

@@ -5,7 +5,7 @@ module Admin
 
     include Effective::CrudController
 
-    if (config = EffectiveRoles.config.layout)
+    if (config = EffectiveRoles.layout)
       layout(config.kind_of?(Hash) ? config[:admin] : config)
     end
 

data/app/helpers/effective_roles_helper.rb

@@ -2,7 +2,7 @@ module EffectiveRolesHelper
   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)
 
-    descriptions = EffectiveRoles.config.role_descriptions[obj.class.name] || EffectiveRoles.config.role_descriptions || {}
+    descriptions = EffectiveRoles.role_descriptions[obj.class.name] || EffectiveRoles.role_descriptions || {}
     opts = { obj: obj, roles: obj.roles, descriptions: descriptions }.merge(options)
 
     render partial: 'effective/roles/summary', locals: opts
@@ -17,7 +17,7 @@ module EffectiveRolesHelper
     raise 'Expected argument to be a Hash' unless opts.kind_of?(Hash)
 
     roles = Array(opts[:roles]).presence
-    roles ||= [:public, :signed_in] + EffectiveRoles.config.roles
+    roles ||= [:public, :signed_in] + EffectiveRoles.roles
 
     if opts[:only].present?
       klasses = Array(opts[:only])
@@ -103,7 +103,7 @@ module EffectiveRolesHelper
 
   # This is used by the effective_roles_summary_table helper method
   def effective_roles_authorization_level(controller, role, resource)
-    authorization_method = EffectiveRoles.config.authorization_method
+    authorization_method = EffectiveResources.authorization_method
 
     raise('expected an authorization method') unless (authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol))
     return :unknown unless (controller.current_user rescue nil).respond_to?(:roles=)

data/app/models/concerns/acts_as_role_restricted.rb

@@ -29,7 +29,7 @@ module ActsAsRoleRestricted
 
     validates :roles_mask, numericality: true, allow_nil: true
 
-    validate(if: -> { changes.include?(:roles_mask) && EffectiveRoles.assignable_roles_present?(self) }) do
+    validate(if: -> { changes.include?(:roles_mask) && EffectiveRoles.assignable_roles_present?(self) && current_user.present? }) do
       roles_was = EffectiveRoles.roles_for(changes[:roles_mask].first)
       changed = (roles + roles_was) - (roles & roles_was)  # XOR
 
@@ -53,6 +53,8 @@ module ActsAsRoleRestricted
   end
 
   module ClassMethods
+    def acts_as_role_restricted?; true; end
+
     # Call with for_role(:admin) or for_role(@user.roles) or for_role([:admin, :member]) or for_role(:admin, :member, ...)
 
     # Returns all records which have been assigned any of the the given roles
@@ -71,33 +73,58 @@ 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.config.roles)
+      roles = (roles.map { |role| role.to_sym } & EffectiveRoles.roles)
 
-      roles.map { |role| "(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.config.roles.index(role) }.join(' OR ')
+      roles.map { |role| "(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.roles.index(role) }.join(' OR ')
     end
 
     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.config.roles)
+      roles = (roles.map { |role| role.to_sym } & EffectiveRoles.roles)
 
       where(
-        roles.map { |role| "NOT(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.config.roles.index(role) }.join(' AND ')
+        roles.map { |role| "NOT(#{self.table_name}.roles_mask & %d > 0)" % 2**EffectiveRoles.roles.index(role) }.join(' AND ')
       ).or(where(roles_mask: nil))
     end
   end
 
+  def roles
+    EffectiveRoles.roles_for(roles_mask)
+  end
+
   def roles=(roles)
     self.roles_mask = EffectiveRoles.roles_mask_for(roles)
   end
 
-  def roles
-    EffectiveRoles.roles_for(roles_mask)
+  def add_role(role)
+    raise('expected role to be a symbol') unless role.kind_of?(Symbol)
+    raise('unknown role') unless EffectiveRoles.roles_mask_for(role) > 0
+
+    assign_attributes(roles: roles | [role])
+  end
+
+  def add_role!(role)
+    add_role(role); save!
+  end
+
+  def remove_role(role)
+    raise('expected role to be a symbol') unless role.kind_of?(Symbol)
+    raise('unknown role') unless EffectiveRoles.roles_mask_for(role) > 0
+
+    assign_attributes(roles: roles - [role])
+  end
+
+  def remove_role!(role)
+    remove_role(role); save!
   end
 
   # if user.is? :admin
   def is?(role)
-    roles.include?(role.try(:to_sym))
+    raise('expected role to be a symbol') unless role.kind_of?(Symbol)
+    raise('unknown role') unless EffectiveRoles.roles_mask_for(role) > 0
+
+    roles.include?(role)
   end
 
   # if user.is_any?(:admin, :editor)

data/lib/effective_roles/version.rb

@@ -1,3 +1,3 @@
 module EffectiveRoles
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/lib/effective_roles.rb

@@ -3,25 +3,12 @@ require 'effective_roles/engine'
 require 'effective_roles/version'
 
 module EffectiveRoles
-  # mattr_accessor :roles
-  # mattr_accessor :role_descriptions
-  # mattr_accessor :assignable_roles
-  # mattr_accessor :layout
 
-  def self.config(namespace = nil)
-    @config ||= ActiveSupport::OrderedOptions.new
-    namespace ||= Tenant.current if defined?(Tenant)
-
-    if namespace
-      @config[namespace] ||= ActiveSupport::OrderedOptions.new
-    else
-      @config
-    end
+  def self.config_keys
+    [:roles, :role_descriptions, :assignable_roles, :layout]
   end
 
-  def self.setup(namespace = nil, &block)
-    yield(config(namespace))
-  end
+  include EffectiveGem
 
   def self.permitted_params
     { roles: [] }
@@ -33,11 +20,11 @@ module EffectiveRoles
     if obj.respond_to?(:is_role_restricted?)
      obj.roles
     elsif obj.kind_of?(Integer)
-      config.roles.reject { |r| (obj & 2 ** config.roles.index(r)).zero? }
+      roles.reject { |r| (obj & 2 ** config.roles.index(r)).zero? }
     elsif obj.kind_of?(Symbol)
-      Array(config.roles.find { |role| role == obj })
+      Array(roles.find { |role| role == obj })
     elsif obj.kind_of?(String)
-      Array(config.roles.find { |role| role == obj.to_sym })
+      Array(roles.find { |role| role == obj.to_sym })
     elsif obj.kind_of?(Array)
       obj.map { |obj| roles_for(obj) }.flatten.compact
     elsif obj.nil?
@@ -52,8 +39,8 @@ module EffectiveRoles
     roles_for(roles).map { |r| 2 ** config.roles.index(r) }.sum
   end
 
-  def self.roles_collection(resource, current_user = nil, only: nil, except: nil, multiple: nil)
-    if config.assignable_roles.present?
+  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?)
       raise('expected current_user to respond to is_role_restricted?') if current_user && !current_user.respond_to?(:is_role_restricted?)
     end
@@ -62,21 +49,25 @@ module EffectiveRoles
     except = Array(except).compact
     multiple = resource.acts_as_role_restricted_options[:multiple] if multiple.nil?
     assignable = assignable_roles_collection(resource, current_user, multiple: multiple)
+    skip_disabled = assignable_roles.kind_of?(Hash) if skip_disabled.nil?
 
-    config.roles.map do |role|
+    roles.map do |role|
       next if only.present? && !only.include?(role)
       next if except.present? && except.include?(role)
 
+      disabled = !assignable.include?(role)
+      next if disabled && skip_disabled
+
       [
         "#{role}<p class='help-block text-muted'>#{role_description(role, resource)}</p>".html_safe,
         role,
-        ({:disabled => :disabled} unless assignable.include?(role))
+        ({:disabled => :disabled} if disabled)
       ]
     end.compact
   end
 
   def self.assignable_roles_collection(resource, current_user = nil, multiple: nil)
-    return config.roles unless assignable_roles_present?(resource)
+    return roles unless assignable_roles_present?(resource)
 
     if current_user && !current_user.respond_to?(:is_role_restricted?)
       raise('expected current_user to respond to is_role_restricted?')
@@ -86,8 +77,8 @@ module EffectiveRoles
       raise('expected current_user to respond to is_role_restricted?')
     end
 
-    assigned_roles = if config.assignable_roles.kind_of?(Hash)
-      assignable = (config.assignable_roles[resource.class.to_s] || config.assignable_roles || {})
+    assigned_roles = if assignable_roles.kind_of?(Hash)
+      assignable = (assignable_roles[resource.class.to_s] || assignable_roles || {})
       assigned = [] # our return value
 
       if current_user.blank?
@@ -107,8 +98,8 @@ module EffectiveRoles
       end
 
       assigned
-    elsif config.assignable_roles.kind_of?(Array)
-      config.assignable_roles
+    elsif assignable_roles.kind_of?(Array)
+      assignable_roles
     end.uniq
 
     # Check boxes
@@ -120,27 +111,27 @@ module EffectiveRoles
   end
 
   def self.assignable_roles_present?(resource)
-    return false unless config.assignable_roles.present?
+    return false unless assignable_roles.present?
 
-    raise 'EffectiveRoles config.assignable_roles_for must be a Hash or Array' unless [Hash, Array].include?(config.assignable_roles.class)
+    raise 'EffectiveRoles config.assignable_roles_for must be a Hash or Array' unless [Hash, Array].include?(assignable_roles.class)
     raise('expected resource to respond to is_role_restricted?') unless resource.respond_to?(:is_role_restricted?)
 
-    if config.assignable_roles.kind_of?(Array)
-      config.assignable_roles
-    elsif config.assignable_roles.key?(resource.class.to_s)
-      config.assignable_roles[resource.class.to_s]
+    if assignable_roles.kind_of?(Array)
+      assignable_roles
+    elsif assignable_roles.key?(resource.class.to_s)
+      assignable_roles[resource.class.to_s]
     else
-      config.assignable_roles
+      assignable_roles
     end.present?
   end
 
   private
 
   def self.role_description(role, obj = nil)
-    raise 'EffectiveRoles config.role_descriptions must be a Hash' unless config.role_descriptions.kind_of?(Hash)
+    raise 'EffectiveRoles config.role_descriptions must be a Hash' unless role_descriptions.kind_of?(Hash)
 
-    description = config.role_descriptions.dig(obj.class.to_s, role) if obj.present?
-    description ||= config.role_descriptions[role]
+    description = role_descriptions.dig(obj.class.to_s, role) if obj.present?
+    description ||= role_descriptions[role]
     description || ''
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_roles
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails