controller_policies 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ea62355c4991dfc6d3aa1da19d75bbb231e170c6451ed11cc43cb38d53f158
-  data.tar.gz: be3d3097f5385f681016c8fd7ee415fc3a6fbdf21acc1320ce6d8891c4f723d7
+  metadata.gz: 876b65cbe173231e141e578fd2e650dcbbcbbba02b0ece615c3ddf80395ba96f
+  data.tar.gz: bcf69abce9066f2b99fa99d21481ecca033e2408d2ed0ec752f2b5cf080a482f
 SHA512:
-  metadata.gz: 289d8b06bca9542f79799779f2fba6444434ce41b85725e0c89cea6a182f5add24c5a32dbfbd9ed52aae4607cd36c9cd830db4b780fecf050075d1c15b94bd4a
-  data.tar.gz: 0d06f4170f6d708f487ce08e4533b93aaaac9916e342fa7a58eaeae3a86be0fde188459ea2299819cc6cc4c553402fc8d80373a00d2c98a3136f6a86ffc3513d
+  metadata.gz: 8031665a97f07ab1e47534f38376eb4b5170538ffa9da42bc69d7e6c2de847e855d64acfdc2db32bbe5fbaee6d1f709e4be147fba9912e39c0089d3d72cecd24
+  data.tar.gz: 2b30ca3aae95937a5625268853a9caa5697c460f1b24b7cffa5dc8dd875d5dee6005e367fb8029627227f7829b808c5f1485914869159e18e9d6545dccc1682f

data/README.md

@@ -20,6 +20,16 @@ rails g policy_definition my/namespace
 
 This will generate a file: `app/policies/my/namespace/definitions.rb`
 
+For controllers without a namespace (root-level controllers), you can generate a root-level definitions file:
+
+```sh
+rails g policy_definition root
+# or simply
+rails g policy_definition
+```
+
+This will generate a file: `app/policies/definitions.rb`
+
 The developer should edit this file and add the policies for the app. **It is important to note that the location of the definitions file should reflect the namespace of the associated controllers.**
 
 ### `actions` key
@@ -43,16 +53,35 @@ end
 
 The above definition will have enforced policies on `Base::FeatureApp::UsersController` (all actions), `Base::DataApp::ProductsController` (`index` action) and `Base::SubscriptionController`.
 
+For root-level controllers (controllers without a namespace), you can define policies directly in the `Policies` module:
+
+```ruby
+module Policies
+  DEFINITIONS = [
+    {
+      code: 'user_management',
+      name: 'User Management',
+      description: 'Allows user management operations',
+      actions: ['users', 'profiles#show', 'dashboard']
+    }
+  ]
+end
+```
+
+The above definition will have enforced policies on `UsersController` (all actions), `ProfilesController` (`show` action) and `DashboardController`.
+
 **Do note that the `actions` array implement *Regular Expression Matching*. That means that if you have multiple controllers with the same name on their parent namespace, the parent will be matched first.** To avoid this problem, simply add the namespace to match the intended child instead.
 
 ```ruby
-module Base
-  DEFINITIONS = {
-    code: 'policy_code',
-    name: 'Policy Name',
-    description: 'I am a policy.',
-    actions: ['feature_app/users', 'another_base/data_app/products#index', 'base/subscriptions']
-  }
+module Policies
+  module Base
+    DEFINITIONS = {
+      code: 'policy_code',
+      name: 'Policy Name',
+      description: 'I am a policy.',
+      actions: ['feature_app/users', 'another_base/data_app/products#index', 'base/subscriptions']
+    }
+  end
 end
 ```
 

data/controller_policies.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'rails', '~> 7'
+  spec.add_dependency 'rails', '>= 7', '< 9'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/ability.rb

@@ -38,7 +38,12 @@ class Ability
       queries.each do |query|
         case query.class.to_s
         when 'String'
-          results += all.select { |ability| ability.namespace.to_s == "Policies::#{trim(query).camelize}" }
+          # Handle empty string or root namespace
+          if query.empty? || query == '/'
+            results += all.select { |ability| ability.namespace == Policies }
+          else
+            results += all.select { |ability| ability.namespace.to_s == "Policies::#{trim(query).camelize}" }
+          end
         when 'Module', 'Class'
           results += all.select { |ability| ability.namespace == query }
         end
@@ -82,7 +87,15 @@ class Ability
     end
 
     def definition_files_post_processing(file_path)
-      module_constant = "Policies::#{convert_namespace(file_path)}".constantize
+      namespace_path = convert_namespace(file_path)
+
+      if namespace_path.empty?
+        # Handle root-level definitions.rb file
+        module_constant = Policies
+      else
+        module_constant = "Policies::#{namespace_path}".constantize
+      end
+
       policy_definitions = module_constant::DEFINITIONS
       policy_definitions.map do |policy_definition|
         policy_definition[:namespace] = module_constant

data/lib/controller_policies/enforcement.rb

@@ -34,9 +34,18 @@ module ControllerPolicies
       # Method that attempts to go through policy definitions and check if it matches the current controller.
       # If it finds a match, it will be an applicable definition to check abilities for.
       def applicable_abilities
-        @applicable_abilities ||= Ability.where(controller_namespace).select do |ability|
-          matching_actions = ability.actions.select { |action| /#{action}/.match?("#{controller_path}##{action_name}") }
-          matching_actions.present?
+        @applicable_abilities ||= begin
+          # Get abilities for the current controller namespace, or root if no namespace
+          namespace_abilities = if controller_namespace.empty?
+            Ability.where('')  # This will get root-level policies
+          else
+            Ability.where(controller_namespace)
+          end
+
+          namespace_abilities.select do |ability|
+            matching_actions = ability.actions.select { |action| /#{action}/.match?("#{controller_path}##{action_name}") }
+            matching_actions.present?
+          end
         end
       end
     end

data/lib/controller_policies/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ControllerPolicies
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/generators/policy_definition_generator.rb

@@ -3,18 +3,22 @@
 # Generates a definition file for a namespace.
 class PolicyDefinitionGenerator < Rails::Generators::Base
   source_root File.expand_path('templates', __dir__)
-  desc 'Generates a policy definition file based on given namespace.'
-  argument :name, type: :string, required: true, desc: 'The namespace for the definition file.'
+  desc 'Generates a policy definition file based on given namespace. Leave empty for root-level definitions.'
+  argument :name, type: :string, required: false, default: '',
+                  desc: 'The namespace for the definition file. Leave empty for root-level definitions.'
 
   def create_policy_definition_file
-    return if processed_name.blank?
-
-    template 'definitions.rb', "app/policies/#{processed_name}/definitions.rb"
+    if processed_name.blank?
+      # Generate root-level definitions.rb
+      template 'root_definitions.rb', 'app/policies/definitions.rb'
+    else
+      template 'modular_definitions.rb', "app/policies/#{processed_name}/definitions.rb"
+    end
   end
 
   private
 
   def processed_name
-    @processed_name ||= name.strip.delete_prefix('/').delete_suffix('/')
+    @processed_name ||= name.strip.delete_prefix('/').delete_suffix('/') || ''
   end
 end

data/lib/generators/templates/{definitions.rb.tt → modular_definitions.rb.tt}

@@ -17,7 +17,7 @@ module Policies
       {
         code: 'Another-Policy-Code',
         name: 'Another Policy',
-        description: 'Long description.',
+        description: 'Long description.'
       }
     ].freeze
   end

data/lib/generators/templates/root_definitions.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Policies
+  DEFINITIONS = [
+    {
+      # Used as identifier for the policy.
+      code: 'Policy-Code',
+      # Readable name for the policy.
+      name: 'Readable Policy Name',
+      # Readable description for the policy.
+      description: 'Short description of what this policy allows',
+      # Controller actions the policy applies to. It works as matchers based on routes.
+      # It can be empty for manual policy checking.
+      actions: ['users', 'products#index', 'dashboard']
+    },
+    {
+      code: 'Another-Policy-Code',
+      name: 'Another Policy',
+      description: 'Long description.'
+    }
+  ].freeze
+end

metadata

@@ -1,30 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: controller_policies
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tien
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-description:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 email:
 - tieeeeen1994@gmail.com
 executables: []
@@ -43,14 +47,14 @@ files:
 - lib/controller_policies/railtie.rb
 - lib/controller_policies/version.rb
 - lib/generators/policy_definition_generator.rb
-- lib/generators/templates/definitions.rb.tt
+- lib/generators/templates/modular_definitions.rb.tt
+- lib/generators/templates/root_definitions.rb.tt
 homepage: https://github.com/tieeeeen1994/rails-controller-policies
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/tieeeeen1994/rails-controller-policies
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Allows the developer to define policies for controllers.
 test_files: []