pundit-plus 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e24b7b92951d89eacea12daeb0883a4210e1f900d3dd472fd069119f197a978
-  data.tar.gz: 2de203579d764e39b71c72c3bc3dc0c13138ae7d97d87f0b0676ee0925156fd7
+  metadata.gz: 03ec5ae53181cd9cdd6292e90d86510d4e9f4ae6830b855f008653cab5f39589
+  data.tar.gz: '08c9991f40b92bdee66f747f58c8fd3b7ef3722c58e1c0264cae8811706b89fc'
 SHA512:
-  metadata.gz: f6fa345e74e3a2dd1a3756782226fab68a0d1e005f9f993b0273132c18648fe8616c938a2fce78df2ed3d26b3744fe42e08a7ff80876ad3ca0e755f3e9ab3a80
-  data.tar.gz: 29c5545f4294059194b327dbbc7f3b8ff81463e97dcfcc767a30d053ed29e782d7c53bdfe9a67f69e9ed92a4790ec59ebe432510eaff2d62a5b34aafdee7a13e
+  metadata.gz: eb3a022d9c0c68afe59ec8faa4ed96be129f8397139597bc6776463b6a06dae05b279dd0a82e1294e3a6df2bfd02ed231f8c1b7695d8610970ccdfe463823eff
+  data.tar.gz: a88a2245f2a68f102d1cecdcb813fc8437520cfb90f83b8a645cf928543ce00cbdc3bdb321ceeeb5db7d07879d7c93df788bf78c4e910006c6eb4036817351ab

data/README.md

@@ -42,6 +42,18 @@ class MyPolicy < ApplicationPolicy
       super
     end
   end
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  # Return the params for the action but require a special key
+  def params_for_create(params)
+    params_for(@record, params, :create).tap do |params|
+      params.require(:special_key)
+    end
+  end
 end
 ```
 

data/lib/pundit/plus/authorization.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pundit"
+
+module Pundit
+  module Plus
+    # This module adds to the Pundit::Authorization module so that anywhere it is
+    # included will also receive the methods added in this.
+    module Authorization
+      # Return the params that are required or permitted for the given action.
+      #
+      # Define a method in your policy class called `params_for_#{action}` to
+      # return the params for that action. If no such method exists, then
+      # `permitted_attributes` is called to return the params.
+      #
+      # In your policy, define the relevant method to receive parameters and
+      # specify permitted or required parameters.
+      #
+      # @example
+      #   class MyPolicy < ApplicationPolicy
+      #      def params_for_create(params)
+      #        params.require(:user).permit(*permitted_attributes_for_create).tap do |permitted|
+      #          permitted.require(:special_value)
+      #        end
+      #      end
+      #    end
+      def params_for_action(record, action = action_name)
+        if policy(record).respond_to?(:"params_for_#{action}")
+          policy(record).send(:"params_for_#{action}", params)
+        else
+          permitted_attributes(record, action)
+        end
+      end
+    end
+  end
+end
+Pundit::Authorization.include(Pundit::Plus::Authorization)

data/lib/pundit/plus/version.rb

@@ -2,6 +2,6 @@
 
 module Pundit
   module Plus
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/pundit/plus.rb

@@ -2,11 +2,33 @@
 
 require_relative "plus/version"
 require_relative "plus/custom_exception"
+require_relative "plus/authorization"
 
 module Pundit
   module Plus
+    # The default exception to raise when authorization fails.
     def exception_from(query:)
       Pundit::NotAuthorizedError
     end
+
+    # Return the params that are required or permitted for the given action.
+    #
+    # This assumes that you will define a `permitted_attributes` method in your
+    # policy class to return the permitted attributes for the record. Or you may
+    # define a method called `permitted_attributes_for_#{action}` to return the
+    # permitted attributes for that action.
+    protected def params_for(record, params, action_name)
+      param_method = if respond_to?(:"permitted_attributes_for_#{action_name}")
+        "permitted_attributes_for_#{action_name}"
+      else
+        "permitted_attributes"
+      end
+
+      required = params.require(
+        PolicyFinder.new(record).param_key
+      ).permit(
+        *send(param_method)
+      )
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pundit-plus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pundit
@@ -50,6 +50,7 @@ files:
 - README.md
 - Rakefile
 - lib/pundit/plus.rb
+- lib/pundit/plus/authorization.rb
 - lib/pundit/plus/custom_exception.rb
 - lib/pundit/plus/version.rb
 homepage: https://github.com/SOFware/pundit-plus