controller_policies 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa53cf4c7f5bfddf09fdf955300af7495177f5d3410983a43202733504d6169b
-  data.tar.gz: 68c2cc086cb3cf7c49cc711a08f39ffa3ef3708bdb18add637a76e2e562b6e80
+  metadata.gz: 77ea62355c4991dfc6d3aa1da19d75bbb231e170c6451ed11cc43cb38d53f158
+  data.tar.gz: be3d3097f5385f681016c8fd7ee415fc3a6fbdf21acc1320ce6d8891c4f723d7
 SHA512:
-  metadata.gz: c36da060a6497a6655e4affc6404142d29055830819a67ffd441aabe401b4ce6fb3c72061b9905e5a7485c9ebfc68cb1451caf5fef64a3ea7dc333d8c4ef4839
-  data.tar.gz: c37a343a64bacc653e06420be3e1c3e5f1563692d996326de1112da645770dca5258cd145038d456c41705b2e79bc4110cc6ae3683db83647a540b72d8acaa69
+  metadata.gz: 289d8b06bca9542f79799779f2fba6444434ce41b85725e0c89cea6a182f5add24c5a32dbfbd9ed52aae4607cd36c9cd830db4b780fecf050075d1c15b94bd4a
+  data.tar.gz: 0d06f4170f6d708f487ce08e4533b93aaaac9916e342fa7a58eaeae3a86be0fde188459ea2299819cc6cc4c553402fc8d80373a00d2c98a3136f6a86ffc3513d

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'controller_policies', '~> 0.1'
+gem 'controller_policies', '~> 1.0'
 ```
 
 ## Usage
@@ -29,13 +29,15 @@ The `actions` key is an array of strings that contain a list of supported contro
 For example, you have this definition:
 
 ```ruby
-module Base
-  DEFINITIONS = {
-    code: 'policy_code',
-    name: 'Policy Name',
-    description: 'I am a policy.',
-    actions: ['feature_app/users', 'data_app/products#index', 'subscriptions']
-  }
+module Policies
+  module Base
+    DEFINITIONS = {
+      code: 'policy_code',
+      name: 'Policy Name',
+      description: 'I am a policy.',
+      actions: ['feature_app/users', 'data_app/products#index', 'subscriptions']
+    }
+  end
 end
 ```
 
@@ -122,7 +124,11 @@ Ability.all_codes
 Filter abilities based on namespace. `queries` can be an array of Strings, Modules or Classes.
 
 ```ruby
-Ability.where(FeatureOne, FeatureTwo, FeatureOne::SubFeatureA)
+Ability.where(Policies::FeatureOne, Policies::FeatureTwo, Policies::FeatureOne::SubFeatureA)
+```
+
+```ruby
+Ability.where('/feature_one', '/feature_two', '/feature_one/sub_feature_a')
 ```
 
 #### #match(expression)
@@ -130,7 +136,7 @@ Ability.where(FeatureOne, FeatureTwo, FeatureOne::SubFeatureA)
 Match abilities based on a matching string or regex. The matcher is based on the namespace. `expression` can be a Regexp or String.
 
 ```ruby
-Ability.match(/FeatureOne(::)?(.)*/)
+Ability.match(/Policies::FeatureOne(::)?(.)*/)
 ```
 
 ### Instance Methods

data/lib/ability.rb

@@ -38,7 +38,7 @@ class Ability
       queries.each do |query|
         case query.class.to_s
         when 'String'
-          results += all.select { |ability| ability.namespace.to_s == trim(query).camelize }
+          results += all.select { |ability| ability.namespace.to_s == "Policies::#{trim(query).camelize}" }
         when 'Module', 'Class'
           results += all.select { |ability| ability.namespace == query }
         end
@@ -82,7 +82,7 @@ class Ability
     end
 
     def definition_files_post_processing(file_path)
-      module_constant = convert_namespace(file_path)
+      module_constant = "Policies::#{convert_namespace(file_path)}".constantize
       policy_definitions = module_constant::DEFINITIONS
       policy_definitions.map do |policy_definition|
         policy_definition[:namespace] = module_constant
@@ -101,7 +101,7 @@ class Ability
     end
 
     def convert_namespace(file_path)
-      trim(file_path[policy_path.to_s.length..-4].split('/')[0...-1].join('/')).camelize.constantize
+      trim(file_path[policy_path.to_s.length..-4].split('/')[0...-1].join('/')).camelize
     end
   end
 end

data/lib/controller_policies/action_controller_patch.rb

@@ -10,5 +10,9 @@ module ControllerPolicies
 
       define_method(:ability?, &block)
     end
+
+    def no_enforced_policies(arguments = {})
+      skip_before_action :check_abilities_by_definition, arguments
+    end
   end
 end

data/lib/controller_policies/version.rb

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

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

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
-module <%= name.camelize %>
-  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: ['feature_app/users', 'data_app/products#index', 'subscriptions']
-    },
-    {
-      code: 'Another-Policy-Code',
-      name: 'Another Policy',
-      description: 'Long description.',
-    }
-  ].freeze
+module Policies
+  module <%= name.camelize %>
+    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: ['feature_app/users', 'data_app/products#index', 'subscriptions']
+      },
+      {
+        code: 'Another-Policy-Code',
+        name: 'Another Policy',
+        description: 'Long description.',
+      }
+    ].freeze
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controller_policies
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Allows the developer to define policies for controllers.