action_policy 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '095ceaf3dffeb28e23d1b89a20108ad23e6ddfb48e3fc317cf481151cdf82d66'
-  data.tar.gz: a1cac52b3641e0e3e9709a42a409324f348b13a037342cc004a4b51b99bc15ab
+  metadata.gz: af8c6d335ea62aa35058c7dd1bf14273df990b9dca7daa461ca8df28af10047e
+  data.tar.gz: 1ba13e5562e5b26042a956a63e5f79f59e7590ee7da787f217a3eff1f946857b
 SHA512:
-  metadata.gz: 3a4b4c4b40036ca59122dfa6c3623b542525b7e663ddfaacec4fe93fdadb0a85fc2c12d73f6a58c89cba8d0e647bf5ff8dbf094f6bc181db93a44a004fd07284
-  data.tar.gz: 28bbda81d9a149ad339558cc7f6b6d175f8385e3be2f0c8118df5491b8152e271382aed6d60235f3de73d73b92406d6442dcf25b24296e73af74d29054890af4
+  metadata.gz: e202eb13aaf0fca9d361ab3be099de48a138e7771aa8978e1e35edf87cc1ae77670b80f11f8972c292cbcf6d85c58ebc32ad426fc25357631dc5ee77ecf1efba
+  data.tar.gz: eb4eedf9c06006fe60417eb4cf37a657826bc118cd21f97c734d9372287c81254d98369dd120edf9ddeeab3d2f4df95bf9049ae8927107c1a0b7aefcd33eb5c0

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 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).
+
 ## 0.6.4 (2022-01-17)
 
 - Fix loading of Rails scope matchers. ([@palkan][])

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,30 +57,25 @@ 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"
+      if ::Rails.application.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
 
       ActiveSupport.on_load(:action_controller) do
+        require "action_policy/rails/scope_matchers/action_controller_params"
+
         next unless ::Rails.application.config.action_policy.auto_inject_into_controller
 
         ActionController::Base.include ActionPolicy::Controller
@@ -110,6 +97,19 @@ module ActionPolicy # :nodoc:
 
       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.4"
+  VERSION = "0.6.6"
 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?

data/lib/generators/rspec/templates/policy_spec.rb.tt

@@ -1,4 +1,4 @@
-require "<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>"
+require "<%= File.exist?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>"
 
 RSpec.describe <%= class_name %>Policy, type: :policy do
   # See https://actionpolicy.evilmartians.io/#/testing?id=rspec-dsl

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-09-12 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.3.11
+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