action_policy 0.6.5 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1a880286222813e707251f1bc1a71960beba873add57ac2e02ee0bb2ed091b
-  data.tar.gz: 812e8ac32298907ff10377d6bfa5622283c4ce7061cc41eb7f08049f2b3c7f41
+  metadata.gz: df57cf926c648dc59ed1a1afc44b352eb998f5bf03a9405127105611e641ffdb
+  data.tar.gz: 51a8e81c6479bf06894da3a2f8fa83c98ed25da678e73bf2462f029a75c55ec4
 SHA512:
-  metadata.gz: 85b1471722b869ca0a486efd293d28edc5e5852f4c98c0c9ba1413d83d6c088933032c61d4f15562ed3321593e06a8d7251bc4481cc9476cd11c01ccda8c9c64
-  data.tar.gz: c8fa5920657c5d7cc1101dd79efd63cc8c80095464de912c768b78b0a2676b247bf715e05f0484d28ac6ee6b8158da1b1cb9423eaca251f2fa17119f79a0088a
+  metadata.gz: 6c55e23ffeff3a1d9800512759105e509abb6b51dabee1a984c56f04daa04e661ef37e056e2fee64b86a17bff8fab8167b557d8f5fe6bd9118febf0b116f7b3a
+  data.tar.gz: 8c1459872bb8daa8bca216c1ee342b9c8c4b4b6fb5654301765ec4d2c7f8ff6612ab784269a89920c29f575ee9ecd79b2a470a415f92246db70c0b9d7a3631b1

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 0.6.7 (2023-09-13)
+
+- Fix loading Rails extensions during eager load. ([@palkan][])
+
+## 0.6.6 (2023-09-11)
+
+- Fix loading Active Record and Action Controller scope matchers. ([@palkan][])
+
+- Add `--parent` option for policy generator ([@matsales28][])
+
+Example:
+
+`bin/rails g action_policy:policy user --parent=base_policy` generates:
+
+```ruby
+class UserPolicy < BasePolicy
+# ...
+end
+```
+
 ## 0.6.5 (2023-02-16)
 
 - Fix generated policies' outdated Ruby API (to work with Ruby 3.2).

data/README.md

@@ -2,9 +2,13 @@
 ![Build](https://github.com/palkan/action_policy/workflows/Build/badge.svg)
 ![JRuby Build](https://github.com/palkan/action_policy/workflows/JRuby%20Build/badge.svg)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://actionpolicy.evilmartians.io)
+[![Coverage Status](https://coveralls.io/repos/github/palkan/action_policy/badge.svg)](https://coveralls.io/github/palkan/action_policy)
 
 # Action Policy
 
+<img align="right" height="150" width="129"
+     title="Action Policy logo" src="./docs/assets/images/logo.svg">
+
 Authorization framework for Ruby and Rails applications.
 
 Composable. Extensible. Performant.
@@ -25,6 +29,7 @@ Composable. Extensible. Performant.
 ## Integrations
 
 - GraphQL Ruby ([`action_policy-graphql`](https://github.com/palkan/action_policy-graphql))
+- Graphiti (JSON:API) ([`action_policy-graphiti`](https://github.com/shrimple-tech/action_policy-graphiti))
 
 ## Installation
 
@@ -71,6 +76,8 @@ end
 ```
 
 This may be done with `rails generate action_policy:policy Post` generator.
+You can also use `rails generate action_policy:policy Post --parent=BasePolicy` to make the generated policy inherits
+from `BasePolicy`.
 
 Now you can easily add authorization to your Rails\* controller:
 

data/lib/.rbnext/2.7/action_policy/rails/scope_matchers/action_controller_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActionPolicy
+  module ScopeMatchers
+    # Adds `params_filter` method as an alias
+    # for `scope_for :action_controller_params`
+    module ActionControllerParams
+      def params_filter(*__rest__, &__block__)
+        scope_for(:action_controller_params, *__rest__, &__block__)
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :params_filter)
+    end
+  end
+end
+
+# Register params scope matcher
+ActionPolicy::Base.scope_matcher :action_controller_params, ActionController::Parameters
+
+# Add alias to base policy
+ActionPolicy::Base.extend ActionPolicy::ScopeMatchers::ActionControllerParams

data/lib/.rbnext/2.7/action_policy/rails/scope_matchers/active_record.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActionPolicy
+  module ScopeMatchers
+    # Adds `relation_scope` method as an alias
+    # for `scope_for :active_record_relation`
+    module ActiveRecord
+      def relation_scope(*__rest__, &__block__)
+        scope_for(:active_record_relation, *__rest__, &__block__)
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :relation_scope)
+    end
+  end
+end
+
+# Register relation scope matcher
+ActionPolicy::Base.scope_matcher :active_record_relation, ActiveRecord::Relation
+
+# Add alias to base policy
+ActionPolicy::Base.extend ActionPolicy::ScopeMatchers::ActiveRecord
+
+ActiveRecord::Relation.include(Module.new do
+  def policy_name
+    if model.respond_to?(:policy_name)
+      model.policy_name.to_s
+    else
+      "#{model}Policy"
+    end
+  end
+end)

data/lib/action_policy/ext/string_underscore.rb

@@ -6,7 +6,7 @@ module ActionPolicy
     module StringUnderscore
       refine String do
         def underscore
-          word = gsub(/::/, "/")
+          word = gsub("::", "/")
           word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
           word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
           word.downcase!

data/lib/action_policy/rails/scope_matchers/action_controller_params.rb

@@ -5,8 +5,8 @@ module ActionPolicy
     # Adds `params_filter` method as an alias
     # for `scope_for :action_controller_params`
     module ActionControllerParams
-      def params_filter(*args, &block)
-        scope_for :action_controller_params, *args, &block
+      def params_filter(...)
+        scope_for(:action_controller_params, ...)
       end
     end
   end

data/lib/action_policy/rails/scope_matchers/active_record.rb

@@ -5,8 +5,8 @@ module ActionPolicy
     # Adds `relation_scope` method as an alias
     # for `scope_for :active_record_relation`
     module ActiveRecord
-      def relation_scope(*args, &block)
-        scope_for :active_record_relation, *args, &block
+      def relation_scope(...)
+        scope_for(:active_record_relation, ...)
       end
     end
   end

data/lib/action_policy/railtie.rb

@@ -4,14 +4,6 @@ module ActionPolicy # :nodoc:
   require "action_policy/rails/controller"
   require "action_policy/rails/channel"
 
-  if defined?(::ActionController)
-    require "action_policy/rails/scope_matchers/action_controller_params"
-  end
-
-  if defined?(::ActiveRecord)
-    require "action_policy/rails/scope_matchers/active_record"
-  end
-
   class Railtie < ::Rails::Railtie # :nodoc:
     # Provides Rails-specific configuration,
     # accessible through `Rails.application.config.action_policy`
@@ -65,51 +57,59 @@ module ActionPolicy # :nodoc:
     config.action_policy = Config
 
     initializer "action_policy.clear_per_thread_cache" do |app|
-      if ::Rails::VERSION::MAJOR >= 5
-        app.executor.to_run { ActionPolicy::PerThreadCache.clear_all }
-        app.executor.to_complete { ActionPolicy::PerThreadCache.clear_all }
-      else
-        require "action_policy/cache_middleware"
-        app.middleware.use ActionPolicy::CacheMiddleware
-      end
+      app.executor.to_run { ActionPolicy::PerThreadCache.clear_all }
+      app.executor.to_complete { ActionPolicy::PerThreadCache.clear_all }
     end
 
-    config.after_initialize do
-      next unless ::Rails.application.config.action_policy.instrumentation_enabled
-
-      require "action_policy/rails/policy/instrumentation"
-      require "action_policy/rails/authorizer"
+    initializer "action_policy.extensions" do |app|
+      if app.config.action_policy.instrumentation_enabled
+        require "action_policy/rails/policy/instrumentation"
+        require "action_policy/rails/authorizer"
 
-      ActionPolicy::Base.prepend ActionPolicy::Policy::Rails::Instrumentation
-      ActionPolicy::Authorizer.singleton_class.prepend ActionPolicy::Rails::Authorizer
-    end
+        ActionPolicy::Base.prepend ActionPolicy::Policy::Rails::Instrumentation
+        ActionPolicy::Authorizer.singleton_class.prepend ActionPolicy::Rails::Authorizer
+      end
 
-    config.to_prepare do |_app|
       ActionPolicy::LookupChain.namespace_cache_enabled =
-        ::Rails.application.config.action_policy.namespace_cache_enabled
+        app.config.action_policy.namespace_cache_enabled
 
       ActiveSupport.on_load(:action_controller) do
-        next unless ::Rails.application.config.action_policy.auto_inject_into_controller
+        require "action_policy/rails/scope_matchers/action_controller_params"
+
+        next unless app.config.action_policy.auto_inject_into_controller
 
         ActionController::Base.include ActionPolicy::Controller
 
-        next unless ::Rails.application.config.action_policy.controller_authorize_current_user
+        next unless app.config.action_policy.controller_authorize_current_user
 
         ActionController::Base.authorize :user, through: :current_user
       end
 
       ActiveSupport.on_load(:action_cable) do
-        next unless ::Rails.application.config.action_policy.auto_inject_into_channel
+        next unless app.config.action_policy.auto_inject_into_channel
 
         ActionCable::Channel::Base.include ActionPolicy::Channel
 
-        next unless ::Rails.application.config.action_policy.channel_authorize_current_user
+        next unless app.config.action_policy.channel_authorize_current_user
 
         ActionCable::Channel::Base.authorize :user, through: :current_user
       end
 
       ActiveSupport.on_load(:active_record) do
         require "action_policy/rails/ext/active_record"
+        require "action_policy/rails/scope_matchers/active_record"
+      end
+
+      # Trigger load hooks of the components that extend ActionPolicy itself
+      # (e.g., scope matchers)
+      begin
+        ::ActionController::Base
+      rescue NameError
+      end
+
+      begin
+        ::ActiveRecord::Base
+      rescue NameError
       end
     end
   end

data/lib/action_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionPolicy
-  VERSION = "0.6.5"
+  VERSION = "0.6.7"
 end

data/lib/generators/action_policy/policy/USAGE

@@ -2,7 +2,14 @@ Description:
     Generates a policy for a model with the given name.
 
 Example:
-    rails generate action_policy:policy user
+    rails generate action_policy:policy user --parent=base_policy
 
     This will create:
         app/policies/user_policy.rb
+
+	```ruby
+	class UserPolicy < BasePolicy
+	  # ...
+	end
+	```
+

data/lib/generators/action_policy/policy/policy_generator.rb

@@ -7,6 +7,8 @@ module ActionPolicy
     class PolicyGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
 
+      class_option :parent, type: :string, desc: "The parent class for the generated policy"
+
       def run_install_if_needed
         in_root do
           return if File.exist?("app/policies/application_policy.rb")
@@ -20,6 +22,16 @@ module ActionPolicy
       end
 
       hook_for :test_framework
+
+      private
+
+      def parent_class_name
+        parent || "ApplicationPolicy"
+      end
+
+      def parent
+        options[:parent]
+      end
     end
   end
 end

data/lib/generators/action_policy/policy/templates/policy.rb.tt

@@ -1,5 +1,5 @@
 <% module_namespacing do -%>
-class <%= class_name %>Policy < ApplicationPolicy
+class <%= class_name %>Policy < <%= parent_class_name.classify %>
   # See https://actionpolicy.evilmartians.io/#/writing_policies
   #
   # def index?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.7
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
@@ -138,6 +138,8 @@ files:
 - lib/.rbnext/2.7/action_policy/i18n.rb
 - lib/.rbnext/2.7/action_policy/policy/cache.rb
 - lib/.rbnext/2.7/action_policy/policy/pre_check.rb
+- lib/.rbnext/2.7/action_policy/rails/scope_matchers/action_controller_params.rb
+- lib/.rbnext/2.7/action_policy/rails/scope_matchers/active_record.rb
 - lib/.rbnext/2.7/action_policy/rspec/be_authorized_to.rb
 - lib/.rbnext/2.7/action_policy/rspec/have_authorized_scope.rb
 - lib/.rbnext/2.7/action_policy/utils/pretty_print.rb
@@ -169,7 +171,6 @@ files:
 - lib/action_policy/behaviours/policy_for.rb
 - lib/action_policy/behaviours/scoping.rb
 - lib/action_policy/behaviours/thread_memoized.rb
-- lib/action_policy/cache_middleware.rb
 - lib/action_policy/ext/hash_transform_keys.rb
 - lib/action_policy/ext/module_namespace.rb
 - lib/action_policy/ext/policy_cache_key.rb
@@ -241,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: Authorization framework for Ruby/Rails application

data/lib/action_policy/cache_middleware.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ActionPolicy # :nodoc:
-  class CacheMiddleware # :nodoc:
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      ActionPolicy::PerThreadCache.clear_all
-      result = @app.call(env)
-      ActionPolicy::PerThreadCache.clear_all
-
-      result
-    end
-  end
-end