add todos

todos

todo

TODOs

todos

Author: enjaku4

README.md

@@ -136,6 +136,8 @@ Rabarber::Role.all_names # All roles grouped by context
 # Get users assigned to a role
 Rabarber::Role.assignees(:admin)
 ```
+<!-- TODO: maybe all these methods should be namespaced under Rabarber, i.e. Rabarber.add_role to hide existence of the model -->
+<!-- TODO: in this case names and all_names will become Rabarber.roles and Rabarber.all_roles respectively, seems more readable -->
 
 ## Controller Authorization
 
@@ -181,11 +183,6 @@ class TicketsController < ApplicationController
   def index
     # Accessible to admin, manager, and support roles
   end
-
-  grant_access action: :destroy, roles: :owner, context: -> { Ticket.find(params[:id]) }
-  def destroy
-    # Accessible to admin and owner of the ticket
-  end
 end
 ```
 
@@ -244,9 +241,7 @@ class ApplicationController < ActionController::Base
   private
 
   def when_unauthorized
-    # Default behavior: redirect back (HTML) or return 403 (other formats)
-    # Custom behavior example:
-    head :not_found # Hide existence of protected resources
+    head :not_found # Custom behavior to hide existence of protected resources
   end
 end
 ```
@@ -288,7 +283,7 @@ end
 
 ## Multi-tenancy / Context
 
-All Rabarber methods accept a `context` parameter, allowing you to work with roles within specific scopes rather than globally.
+All Rabarber methods accept a `context` parameter, allowing you to work with roles within specific scopes. By default, context is `nil`, meaning roles are global.
 
 ### Contextual Role Assignment
 
@@ -304,6 +299,9 @@ user.assign_roles(:admin, context: Project)
 user.has_role?(:owner, context: project)
 user.has_role?(:admin, context: Project)
 
+# Revoke roles within a specific context
+user.revoke_roles(:owner, context: project)
+
 # Get roles within context
 user.roles(context: project)
 Rabarber::Role.names(context: Project)
@@ -341,11 +339,11 @@ end
 Handle context changes when models are renamed or removed. These are irreversible data migrations.
 
 ```rb
-# Rename a context class (e.g., when you rename your Project model to Campaign)
-migrate_authorization_context!("Project", "Campaign")
+# Rename a context class (e.g., when you rename your Ticket model to Task)
+migrate_authorization_context!("Ticket", "Task")
 
-# Remove orphaned context data (e.g., when you delete a model entirely)
-delete_authorization_context!("DeletedModel")
+# Remove orphaned context data (e.g., when you delete Ticket model entirely)
+delete_authorization_context!("Ticket")
 ```
 
 ## View Helpers

lib/rabarber/core/integrity_checker.rb

@@ -20,6 +20,9 @@ def check_for_missing_class_context
         end
       end
 
+      # TODO: maybe context pruning should be a part of public API
+      # TODO: although it would be cool if orphaned instance context roles could be deleted automatically along with the context itself
+      # TODO: maybe integrity checker is not needed at all, and developers should handle all by themselves
       def prune_missing_instance_context
         ids = Rabarber::Role.where.not(context_id: nil).includes(:context).filter_map do |role|
           role.context

lib/rabarber/inputs.rb

@@ -35,6 +35,7 @@ def process(value, as:, optional: false, error: Rabarber::InvalidArgumentError,
 
       result = checker[value]
 
+      # TODO: intuitively doesn't feel right
       [:role_context, :authorization_context].include?(as) ? resolve_context(result) : result
     rescue Dry::Types::CoercionError => e
       raise error, message || e.message
@@ -44,13 +45,15 @@ def process(value, as:, optional: false, error: Rabarber::InvalidArgumentError,
 
     def type_for(name) = self::TYPES.fetch(name)
 
+    # TODO: there should be some separate context resolver or smth
     def resolve_context(value)
       case value
       when nil
         { context_type: nil, context_id: nil }
       when Class
         { context_type: value.to_s, context_id: nil }
       when ActiveRecord::Base
+        # TODO: this should be included in the type definition somehow, or maybe dry-validation?
         raise Dry::Types::CoercionError, "instance context not persisted" unless value.persisted?
 
         { context_type: value.class.to_s, context_id: value.public_send(value.class.primary_key) }

lib/rabarber/models/role.rb

@@ -69,6 +69,7 @@ def assignees(name, context: nil)
       private
 
       def delete_roleables_cache(role, context:)
+        # TODO: maybe in_batches is not really needed
         role.roleables.in_batches(of: 1000) do |batch|
           Rabarber::Core::Cache.delete(*batch.pluck(:id).flat_map { [[_1, context], [_1, :all]] })
         end