role_fu 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d75b379be1f3096ca3580d3b5f545c7e10e96a76ade4e1ea8ddf9df11272cf61
-  data.tar.gz: 9dda6cef944474db4c9fa70979f0a633a3ad90f51bee73faa6cc7ed2e13bfa68
+  metadata.gz: b2b6f0598619d72c54eff632b24395808c2e830c1742ae072e5c977ae183f31e
+  data.tar.gz: 90b6b655d0858fe2876a530055bc5a4bb27e6f0552b1ad2a4dba4fbc8fedb0e7
 SHA512:
-  metadata.gz: 51e073987c36ffd2c6faa06256362a75f79f1a83931fe2bc82e5f4d6750c4a355df4324c3f33dc1dcbe298d3d060b787b6d819da1b693f63edb9d4ed4dc008c5
-  data.tar.gz: 9e1b6a068bce303db00d70f538a311321fbc2ea1d1032b1522b028d0cf71835c7107589b3f194b48a0c242ba9afab49755a1213ab4a6ce2ba195a06fef8f9a10
+  metadata.gz: 46c110643a2838ce274b0041f27c2c47b37a279265e96114f2e4cacd1f7c0964e143575ed171fc4d416c998718392dcd103c0d97d0003330506f240c826fb019
+  data.tar.gz: cae97d08a68d4db3700c3801d464ea4369029239eeb3181461043c367cba0f967275a38a80309503a6a994095432530a3204dd257acfa1fff48c6947fd768831

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.1] - 2026-02-06
+
+### Improved
+
+- **Generator Flexibility**: `role_fu` generator now supports 0, 1, or 2 arguments for easier setup (e.g., `rails g role_fu Group Account`).
+- **Documentation**: Enhanced CLI help output for all generators, placing usage examples and descriptions prominently above options.
+- **Audit & Ability Generators**: Explicitly documented the `NAME` argument in help banners.
+
 ## [0.3.0] - 2026-02-03
 
 ### BREAKING CHANGES

data/README.md

@@ -2,13 +2,16 @@
 
 RoleFu is a modern, explicit role management gem for Ruby on Rails. It is designed as a cleaner, more performant alternative to legacy role gems, providing full control over role assignments and granular permissions.
 
+[![Gem Version](https://badge.fury.io/rb/role_fu.svg)](https://badge.fury.io/rb/role_fu)
+[![Build Status](https://github.com/alec-c4/role_fu/actions/workflows/main.yml/badge.svg)](https://github.com/alec-c4/role_fu/actions)
+
 ## Why RoleFu?
 
 - **Explicit Models**: Uses an explicit `RoleAssignment` join model instead of hidden tables, making it easy to add metadata or audit trails.
 - **N+1 Prevention**: Built-in support for `has_cached_role?` and optimized scopes.
 - **Strict by Default**: Resource-specific checks are strict, ensuring global roles don't accidentally leak permissions unless configured otherwise.
 - **Advanced Features**: Supports temporal (expiring) roles, metadata, audit logging, and granular abilities.
-- **Modern Infrastructure**: Fully compatible with Rails 7.0 through 8.1, includes Lefthook and Appraisal support.
+- **Modern Infrastructure**: Fully compatible with Rails 7.2 through 8.1, includes Lefthook and Appraisal support.
 
 ## Installation
 
@@ -27,17 +30,33 @@ bundle install
 ### Setup
 
 1. **Install Configuration:**
+
 ```bash
 rails generate role_fu:install
 ```
 
 2. **Generate Models:**
-Default names are `Role` and `RoleAssignment`, linked to the `User` model.
-```bash
-rails generate role_fu Role User
-```
+
+   You can generate the role models with flexible arguments:
+
+   *   **Default (Role & User):**
+       ```bash
+       rails generate role_fu
+       # Generates 'Role' and 'RoleAssignment', linked to 'User'
+       ```
+   *   **Custom Role Name:**
+       ```bash
+       rails generate role_fu Group
+       # Generates 'Group' and 'GroupAssignment', linked to 'User'
+       ```
+   *   **Custom Role & User Names:**
+       ```bash
+       rails generate role_fu Group Account
+       # Generates 'Group' and 'GroupAssignment', linked to 'Account'
+       ```
 
 3. **Run Migrations:**
+
 ```bash
 rails db:migrate
 ```
@@ -95,6 +114,7 @@ User.with_all_roles(:admin, :manager)
 ### Advanced Features
 
 #### 1. Temporal Roles (Expiration)
+
 Roles can be assigned with an expiration time. They are automatically filtered out from queries once expired.
 
 ```ruby
@@ -108,6 +128,7 @@ user.grant(:manager, org, expires_at: 1.week.from_now)
 ```
 
 #### 2. Metadata
+
 Attach arbitrary metadata to a role assignment.
 
 ```ruby
@@ -115,16 +136,21 @@ user.grant(:manager, org, meta: { assigned_by: current_user.id, reason: "Project
 ```
 
 #### 3. Audit Log
+
 Track every grant, revoke, and update (e.g., expiration extensions).
 
 **Setup:**
+
 ```bash
 rails generate role_fu:audit
+# OR with a custom name:
+# rails generate role_fu:audit MyAudit
 rails db:migrate
 ```
 
 **Usage:**
 Wrap changes in `with_actor` to capture the responsible user:
+
 ```ruby
 RoleFu.with_actor(current_user) do
   user.grant(:manager, org)
@@ -136,15 +162,20 @@ RoleAssignmentAudit.where(user: user).last
 ```
 
 #### 4. Role Abilities (Permissions)
+
 Attach granular permissions to roles.
 
 **Setup:**
+
 ```bash
 rails generate role_fu:abilities
+# OR with a custom name:
+# rails generate role_fu:abilities MyPermission
 rails db:migrate
 ```
 
 **Usage:**
+
 ```ruby
 # Setup permissions
 manager_role = Role.find_by(name: "manager")
@@ -159,6 +190,7 @@ user.role_fu_can?("posts.edit") # => true
 ### Adapters (Pundit & CanCanCan)
 
 #### CanCanCan
+
 ```ruby
 class Ability
   include CanCan::Ability
@@ -171,12 +203,14 @@ end
 ```
 
 #### Pundit
+
 ```ruby
 class ApplicationPolicy
   include RoleFu::Adapters::Pundit
 end
 ```
-*`PostPolicy#update?` will automatically check `user.role_fu_can?('posts.update')`.*
+
+_`PostPolicy#update?` will automatically check `user.role_fu_can?('posts.update')`._
 
 ---
 
@@ -217,7 +251,7 @@ Customize your model names in `config/initializers/role_fu.rb`:
 RoleFu.configure do |config|
   config.user_class_name = "Account"
   config.role_class_name = "Group"
-  
+
   # Enable Rolify-style permissive checks (Global roles override resource checks)
   config.global_roles_override = true
 end
@@ -244,11 +278,13 @@ User.not_in_group(:admin)  # Alias for without_group/without_role
 
 1. **Code Changes**: Replace `rolify` with `include RoleFu::Roleable` and `resourcify` with `include RoleFu::Resourceable`.
 2. **Data Migration**:
+
 ```sql
 INSERT INTO role_assignments (user_id, role_id, created_at, updated_at)
 SELECT user_id, role_id, NOW(), NOW()
 FROM users_roles;
 ```
+
 3. **Behavior**: Set `config.global_roles_override = true` if you rely on global roles satisfying resource checks.
 
 ## License

data/gemfiles/rails_7.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    role_fu (0.3.0)
+    role_fu (0.3.1)
       activerecord (>= 7.2)
 
 GEM
@@ -389,7 +389,7 @@ CHECKSUMS
   rdoc (7.1.0) sha256=494899df0706c178596ca6e1d50f1b7eb285a9b2aae715be5abd742734f17363
   regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
   reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
-  role_fu (0.3.0)
+  role_fu (0.3.1)
   rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836

data/gemfiles/rails_8.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    role_fu (0.3.0)
+    role_fu (0.3.1)
       activerecord (>= 7.2)
 
 GEM
@@ -385,7 +385,7 @@ CHECKSUMS
   rdoc (7.1.0) sha256=494899df0706c178596ca6e1d50f1b7eb285a9b2aae715be5abd742734f17363
   regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
   reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
-  role_fu (0.3.0)
+  role_fu (0.3.1)
   rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836

data/gemfiles/rails_8.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    role_fu (0.3.0)
+    role_fu (0.3.1)
       activerecord (>= 7.2)
 
 GEM
@@ -387,7 +387,7 @@ CHECKSUMS
   rdoc (7.1.0) sha256=494899df0706c178596ca6e1d50f1b7eb285a9b2aae715be5abd742734f17363
   regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
   reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
-  role_fu (0.3.0)
+  role_fu (0.3.1)
   rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
   rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836

data/lib/generators/role_fu/abilities_generator.rb

@@ -7,11 +7,21 @@ module RoleFu
     class AbilitiesGenerator < ActiveRecord::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
+      argument :name, type: :string, default: "abilities"
+
+      def self.banner
+        "bin/rails generate role_fu:abilities [NAME] [options]\n\n" \
+        "Generates the permission model and migration.\n" \
+        "  NAME is the name of the permission model (default: 'abilities')."
+      end
+
+      desc ""
+
       def generate_permission_model
         template "permission.rb.erb", "app/models/permission.rb"
       end
 
-      def create_migration
+      def create_abilities_migration
         migration_template "abilities_migration.rb.erb", "db/migrate/role_fu_create_permissions.rb", migration_version: migration_version
       end
 

data/lib/generators/role_fu/audit_generator.rb

@@ -7,7 +7,17 @@ module RoleFu
     class AuditGenerator < ActiveRecord::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
-      def create_migration
+      argument :name, type: :string, default: "audit"
+
+      def self.banner
+        "bin/rails generate role_fu:audit [NAME] [options]\n\n" \
+        "Generates the audit model and migration.\n" \
+        "  NAME is the name of the audit model (default: 'audit')."
+      end
+
+      desc "" # Empty desc to avoid duplication at the bottom
+
+      def create_audit_migration
         migration_template "audit_migration.rb.erb", "db/migrate/role_fu_create_audits.rb", migration_version: migration_version
       end
 

data/lib/generators/role_fu/role_fu_generator.rb

@@ -7,8 +7,22 @@ module RoleFu
     class RoleFuGenerator < ActiveRecord::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
+      # Override the default 'name' argument to be optional with default "Role"
+      remove_argument :name
+      argument :name, type: :string, default: "Role", banner: "Role"
       argument :user_cname, type: :string, default: "User", banner: "User"
 
+      def self.banner
+        "bin/rails generate role_fu [Role] [User] [options]\n\n" \
+        "Generates the Role model and the assignment join model, then links them to the User model.\n" \
+        "  Usage:\n" \
+        "    rails g role_fu                # Generates 'Role' and links to 'User' (default)\n" \
+        "    rails g role_fu Group          # Generates 'Group' and links to 'User'\n" \
+        "    rails g role_fu Group Account  # Generates 'Group' and links to 'Account'"
+      end
+
+      desc ""
+
       def generate_models
         # Generate Role model
         template "role.rb.erb", "app/models/#{name.underscore}.rb"
@@ -29,7 +43,7 @@ module RoleFu
             "  include RoleFu::Roleable\n"
           end
         else
-          print_notes "User model #{user_cname} not found at #{user_path}. Please add 'include RoleFu::Roleable' manually."
+          say "User model #{user_cname} not found at #{user_path}. Please add 'include RoleFu::Roleable' manually."
         end
       end
 

data/lib/role_fu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RoleFu
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: role_fu
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexey Poimtsev
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.5
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A modern role management gem for Rails, replacing rolify.
 test_files: []