rabarber 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b43bb0c28c871575c4e723415cd3df577a2fa715b07178c4a8a21102183791
-  data.tar.gz: 7cf707c61a560d271345162834a0557f51519a0fbfe9d1e81eb3d74cfb401cff
+  metadata.gz: 5450b60dd272da8e0b78af00e44a3e82b29c7b9a9e8b510c68efccbba30ba150
+  data.tar.gz: 7bbdd6de4ed8f2e33be07363c9c9d4e099170099ca7cb32a50df217373503284
 SHA512:
-  metadata.gz: '09d9897bdd2df705e37bf9800a10f30904b102d8d33773e35cec4ed0c7ceebeca78fc47ce038cc6b617f698ee89cebc7d34da7d0cd3ef67685cc2d61ed022ebb'
-  data.tar.gz: 610d8700782cc500bfa83d62de0816c2b6253f6fcb42d5c233213675da9e4c7d9b0b7e9b07287514d48cae68b0cc56440cb0e225147487f2f15d02ea5a8e7aab
+  metadata.gz: 8c9aa4a196f99dbb5250dd1b625fed829418843f5de8f35a4b2cde5f933f8780be0865f8c23e90c57490a3358f004fd1168dc28bcc9be9f66f0bb56b9ebcfddf
+  data.tar.gz: 3ddc04e91777a31631d4e9db9a54d6d1e23f588935e09c9d9691f8c607fffbabe18a49553cc9bad22ed8944dbec8b6cb58ecaf6a432c7ac7da59c1aca27a334f

data/CHANGELOG.md

@@ -1,8 +1,26 @@
+## v4.1.0
+
+### Features:
+
+- Added `Rabarber::Role.all_names` method to retrieve all roles available in the application, grouped by context
+- Added `Rabarber::HasRoles#all_roles` method to retrieve all roles assigned to a user, grouped by context
+
+### Bugs:
+
+- Fixed potential bug in role revocation caused by checking for the presence of a role in the cache instead of the database
+
+## v4.0.2
+
+### Misc:
+
+- Added support for Ruby 3.4
+- Updated some error messages for clarity
+
 ## v4.0.1
 
 ### Bugs:
 
-- Resolved an issue preventing the gem from being used with rbs_rails
+- Resolved an issue preventing Rabarber from being used with the RBS Rails gem
 
 ## v4.0.0
 

data/README.md

@@ -158,6 +158,14 @@ To get the list of roles assigned to the user, use:
 user.roles
 ```
 
+**`#all_roles`**
+
+To get all roles assigned to the user, grouped by context, use:
+
+```rb
+user.all_roles
+```
+
 ---
 
 To manipulate roles directly, you can use `Rabarber::Role` methods:
@@ -203,12 +211,20 @@ Rabarber::Role.remove(:admin, force: true)
 
 **`.names(context: nil)`**
 
-If you need to list the role names available in your application, use:
+If you need to list the roles available in your application, use:
 
 ```rb
 Rabarber::Role.names
 ```
 
+**`.all_names`**
+
+If you need list all roles available in your application, grouped by context, use:
+
+```rb
+Rabarber::Role.all_names
+```
+
 **`.assignees(role_name, context: nil)`**
 
 To get all the users to whom the role is assigned, use:
@@ -475,7 +491,7 @@ This method accepts the same options as `skip_before_action` method in Rails.
 
 ## View Helpers
 
-Rabarber also provides a couple of helpers that can be used in views: `visible_to(*roles, &block)` and `hidden_from(*roles, &block)`. To use them, simply include `Rabarber::Helpers` in the desired helper. Usually it is `ApplicationHelper`, but it can be any helper of your choice.
+Rabarber also provides a couple of helpers that can be used in views: `visible_to(*roles, context: nil, &block)` and `hidden_from(*roles, context: nil, &block)`. To use them, simply include `Rabarber::Helpers` in the desired helper. Usually it is `ApplicationHelper`, but it can be any helper of your choice.
 
 ```rb
 module ApplicationHelper

data/lib/rabarber/audit/events/base.rb

@@ -40,7 +40,7 @@ module Rabarber
           in { context_type: nil, context_id: nil } then "Global"
           in { context_type:, context_id: nil } then context_type
           in { context_type:, context_id: } then "#{context_type}##{context_id}"
-          else raise "Unexpected context: #{context}"
+          else raise Rabarber::Error, "Unexpected context: #{context.inspect}"
           end
         end
       end

data/lib/rabarber/core/cache.rb

@@ -32,7 +32,7 @@ module Rabarber
       end
 
       def key_for(id, context)
-        "#{CACHE_PREFIX}:#{Digest::SHA2.hexdigest("#{id}#{context}")}"
+        "#{CACHE_PREFIX}:#{Digest::SHA2.hexdigest("#{id}#{context.fetch(:context_type)}#{context.fetch(:context_id)}")}"
       end
     end
   end

data/lib/rabarber/core/permissions_integrity_checker.rb

@@ -14,7 +14,7 @@ module Rabarber
 
         raise(
           Rabarber::Error,
-          "Following actions were passed to 'grant_access' method but are not defined in the controller: #{missing_list}"
+          "Following actions were passed to 'grant_access' method but are not defined in the controller:\n#{missing_list.to_yaml}"
         )
       end
 

data/lib/rabarber/models/concerns/has_roles.rb

@@ -19,6 +19,10 @@ module Rabarber
       Rabarber::Core::Cache.fetch(roleable_id, context: processed_context) { rabarber_roles.names(context: processed_context) }
     end
 
+    def all_roles
+      rabarber_roles.all_names
+    end
+
     def has_role?(*role_names, context: nil)
       processed_context = process_context(context)
       processed_roles = process_role_names(role_names)
@@ -55,7 +59,7 @@ module Rabarber
       processed_context = process_context(context)
 
       roles_to_revoke = Rabarber::Role.where(
-        name: processed_role_names.intersection(roles(context: processed_context)), **processed_context
+        name: processed_role_names.intersection(rabarber_roles.names(context: processed_context)), **processed_context
       )
 
       if roles_to_revoke.any?

data/lib/rabarber/models/role.rb

@@ -9,6 +9,8 @@ module Rabarber
                      format: { with: Rabarber::Input::Role::REGEX },
                      strict: true
 
+    belongs_to :context, polymorphic: true, optional: true
+
     before_destroy :delete_assignments
 
     class << self
@@ -16,6 +18,14 @@ module Rabarber
         where(process_context(context)).pluck(:name).map(&:to_sym)
       end
 
+      def all_names
+        includes(:context).group_by(&:context).transform_values { |roles| roles.map { _1.name.to_sym } }
+      rescue ActiveRecord::RecordNotFound => e
+        raise Rabarber::Error, "Context not found: #{e.model}##{e.id}"
+      rescue NameError => e
+        raise Rabarber::Error, "Context not found: #{e.name}"
+      end
+
       def add(name, context: nil)
         name = process_role_name(name)
         processed_context = process_context(context)
@@ -77,6 +87,16 @@ module Rabarber
       end
     end
 
+    def context
+      return context_type.constantize if context_type.present? && context_id.blank?
+
+      record = super
+
+      raise ActiveRecord::RecordNotFound.new(nil, context_type, nil, context_id) if context_id.present? && !record
+
+      record
+    end
+
     private
 
     def delete_assignments

data/lib/rabarber/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rabarber
-  VERSION = "4.0.1"
+  VERSION = "4.1.0"
 end

data/rabarber.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.summary = "Simple role-based authorization library for Ruby on Rails"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1", "< 3.4"
+  spec.required_ruby_version = ">= 3.1", "< 3.5"
 
   spec.files = [
     "rabarber.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabarber
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - enjaku4
 - trafium
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,7 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
-description:
 email:
 - rabarber_gem@icloud.com
 executables: []
@@ -82,7 +80,6 @@ metadata:
   source_code_uri: https://github.com/enjaku4/rabarber
   changelog_uri: https://github.com/enjaku4/rabarber/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Simple role-based authorization library for Ruby on Rails
 test_files: []