pundit 2.4.0 → 2.5.1

data/lib/pundit/cache_store/legacy_store.rb

@@ -2,12 +2,22 @@
 
 module Pundit
   module CacheStore
+    # A cache store that uses only the record as a cache key, and ignores the user.
+    #
+    # The original cache mechanism used by Pundit.
+    #
     # @api private
+    # @since v2.3.2
     class LegacyStore
+      # @since v2.3.2
       def initialize(hash = {})
         @store = hash
       end
 
+      # A cache store that uses only the record as a cache key, and ignores the user.
+      #
+      # @note `nil` results are not cached.
+      # @since v2.3.2
       def fetch(user:, record:)
         _ = user
         @store[record] ||= yield

data/lib/pundit/cache_store/null_store.rb

@@ -2,14 +2,26 @@
 
 module Pundit
   module CacheStore
+    # A cache store that does not cache anything.
+    #
+    # Use `NullStore.instance` to get the singleton instance, it is thread-safe.
+    #
+    # @see Pundit::Context#initialize
     # @api private
+    # @since v2.3.2
     class NullStore
       @instance = new
 
       class << self
+        # @since v2.3.2
+        # @return [NullStore] the singleton instance
         attr_reader :instance
       end
 
+      # Always yields, does not cache anything.
+      # @yield
+      # @return [any] whatever the block returns.
+      # @since v2.3.2
       def fetch(*, **)
         yield
       end

data/lib/pundit/cache_store.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pundit
+  # Namespace for cache store implementations.
+  #
+  # Cache stores are used to cache policy lookups, so you get the same policy
+  # instance for the same record.
+  # @since v2.3.2
+  module CacheStore
+    # @!group Cache Store Interface
+
+    # @!method fetch(user:, record:, &block)
+    #   Looks up a stored policy or generate a new one.
+    #
+    #   @since v2.3.2
+    #   @note This is a method template, but the method does not exist in this module.
+    #   @param user [Object]  the user that initiated the action
+    #   @param record [Object] the object being accessed
+    #   @param block [Proc] the block to execute if missing
+    #   @return [Object] the policy
+
+    # @!endgroup
+  end
+end

data/lib/pundit/context.rb

@@ -1,27 +1,64 @@
 # frozen_string_literal: true
 
 module Pundit
+  # {Pundit::Context} is intended to be created once per request and user, and
+  # it is then used to perform authorization checks throughout the request.
+  #
+  # @example Using Sinatra
+  #   helpers do
+  #     def current_user = ...
+  #
+  #     def pundit
+  #       @pundit ||= Pundit::Context.new(user: current_user)
+  #     end
+  #   end
+  #
+  #   get "/posts/:id" do |id|
+  #     pundit.authorize(Post.find(id), query: :show?)
+  #   end
+  #
+  # @example Using [Roda](https://roda.jeremyevans.net/index.html)
+  #   route do |r|
+  #     context = Pundit::Context.new(user:)
+  #
+  #     r.get "posts", Integer do |id|
+  #       context.authorize(Post.find(id), query: :show?)
+  #     end
+  #   end
+  #
+  # @since v2.3.2
   class Context
+    # @see Pundit::Authorization#pundit
+    # @param user later passed to policies and scopes
+    # @param policy_cache [#fetch] cache store for policies (see e.g. {CacheStore::NullStore})
+    # @since v2.3.2
     def initialize(user:, policy_cache: CacheStore::NullStore.instance)
       @user = user
       @policy_cache = policy_cache
     end
 
+    # @api public
+    # @see #initialize
+    # @since v2.3.2
     attr_reader :user
 
     # @api private
+    # @see #initialize
+    # @since v2.3.2
     attr_reader :policy_cache
 
+    # @!group Policies
+
     # Retrieves the policy for the given record, initializing it with the
     # record and user and finally throwing an error if the user is not
     # authorized to perform the given action.
     #
-    # @param user [Object] the user that initiated the action
     # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of
     # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`)
     # @param policy_class [Class] the policy class we want to force use of
     # @raise [NotAuthorizedError] if the given query method returned false
     # @return [Object] Always returns the passed object record
+    # @since v2.3.2
     def authorize(possibly_namespaced_record, query:, policy_class:)
       record = pundit_model(possibly_namespaced_record)
       policy = if policy_class
@@ -35,13 +72,40 @@ module Pundit
       record
     end
 
+    # Retrieves the policy for the given record.
+    #
+    # @see https://github.com/varvet/pundit#policies
+    # @param record [Object] the object we're retrieving the policy for
+    # @raise [InvalidConstructorError] if the policy constructor called incorrectly
+    # @return [Object, nil] instance of policy class with query methods
+    # @since v2.3.2
+    def policy(record)
+      cached_find(record, &:policy)
+    end
+
+    # Retrieves the policy for the given record, or raises if not found.
+    #
+    # @see https://github.com/varvet/pundit#policies
+    # @param record [Object] the object we're retrieving the policy for
+    # @raise [NotDefinedError] if the policy cannot be found
+    # @raise [InvalidConstructorError] if the policy constructor called incorrectly
+    # @return [Object] instance of policy class with query methods
+    # @since v2.3.2
+    def policy!(record)
+      cached_find(record, &:policy!)
+    end
+
+    # @!endgroup
+
+    # @!group Scopes
+
     # Retrieves the policy scope for the given record.
     #
     # @see https://github.com/varvet/pundit#scopes
-    # @param user [Object] the user that initiated the action
     # @param scope [Object] the object we're retrieving the policy scope for
     # @raise [InvalidConstructorError] if the policy constructor called incorrectly
     # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope
+    # @since v2.3.2
     def policy_scope(scope)
       policy_scope_class = policy_finder(scope).scope
       return unless policy_scope_class
@@ -58,14 +122,13 @@ module Pundit
     # Retrieves the policy scope for the given record. Raises if not found.
     #
     # @see https://github.com/varvet/pundit#scopes
-    # @param user [Object] the user that initiated the action
     # @param scope [Object] the object we're retrieving the policy scope for
     # @raise [NotDefinedError] if the policy scope cannot be found
     # @raise [InvalidConstructorError] if the policy constructor called incorrectly
     # @return [Scope{#resolve}] instance of scope class which can resolve to a scope
+    # @since v2.3.2
     def policy_scope!(scope)
       policy_scope_class = policy_finder(scope).scope!
-      return unless policy_scope_class
 
       begin
         policy_scope = policy_scope_class.new(user, pundit_model(scope))
@@ -76,31 +139,22 @@ module Pundit
       policy_scope.resolve
     end
 
-    # Retrieves the policy for the given record.
-    #
-    # @see https://github.com/varvet/pundit#policies
-    # @param user [Object] the user that initiated the action
-    # @param record [Object] the object we're retrieving the policy for
-    # @raise [InvalidConstructorError] if the policy constructor called incorrectly
-    # @return [Object, nil] instance of policy class with query methods
-    def policy(record)
-      cached_find(record, &:policy)
-    end
-
-    # Retrieves the policy for the given record. Raises if not found.
-    #
-    # @see https://github.com/varvet/pundit#policies
-    # @param user [Object] the user that initiated the action
-    # @param record [Object] the object we're retrieving the policy for
-    # @raise [NotDefinedError] if the policy cannot be found
-    # @raise [InvalidConstructorError] if the policy constructor called incorrectly
-    # @return [Object] instance of policy class with query methods
-    def policy!(record)
-      cached_find(record, &:policy!)
-    end
+    # @!endgroup
 
     private
 
+    # @!group Private Helpers
+
+    # Finds a cached policy for the given record, or yields to find one.
+    #
+    # @api private
+    # @param record [Object] the object we're retrieving the policy for
+    # @yield a policy finder if no policy was cached
+    # @yieldparam [PolicyFinder] policy_finder
+    # @yieldreturn [#new(user, model)]
+    # @return [Policy, nil] an instantiated policy
+    # @raise [InvalidConstructorError] if policy can't be instantated
+    # @since v2.3.2
     def cached_find(record)
       policy_cache.fetch(user: user, record: record) do
         klass = yield policy_finder(record)
@@ -116,10 +170,19 @@ module Pundit
       end
     end
 
+    # Return a policy finder for the given record.
+    #
+    # @api private
+    # @return [PolicyFinder]
+    # @since v2.3.2
     def policy_finder(record)
       PolicyFinder.new(record)
     end
 
+    # Given a possibly namespaced record, return the actual record.
+    #
+    # @api private
+    # @since v2.3.2
     def pundit_model(record)
       record.is_a?(Array) ? record.last : record
     end

data/lib/pundit/error.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Pundit
+  # @api private
+  # @since v1.0.0
+  # To avoid name clashes with common Error naming when mixing in Pundit,
+  # keep it here with compact class style definition.
+  class Error < StandardError; end
+
+  # Error that will be raised when authorization has failed
+  # @since v0.1.0
+  class NotAuthorizedError < Error
+    # @see #initialize
+    # @since v0.2.3
+    attr_reader :query
+    # @see #initialize
+    # @since v0.2.3
+    attr_reader :record
+    # @see #initialize
+    # @since v0.2.3
+    attr_reader :policy
+
+    # @since v1.0.0
+    #
+    # @overload initialize(message)
+    #   Create an error with a simple error message.
+    #   @param [String] message A simple error message string.
+    #
+    # @overload initialize(options)
+    #   Create an error with the specified attributes.
+    #   @param [Hash] options The error options.
+    #   @option options [String] :message Optional custom error message. Will default to a generalized message.
+    #   @option options [Symbol] :query The name of the policy method that was checked.
+    #   @option options [Object] :record The object that was being checked with the policy.
+    #   @option options [Class] :policy The class of policy that was used for the check.
+    def initialize(options = {})
+      if options.is_a? String
+        message = options
+      else
+        @query  = options[:query]
+        @record = options[:record]
+        @policy = options[:policy]
+
+        message = options.fetch(:message) do
+          record_name = record.is_a?(Class) ? record.to_s : "this #{record.class}"
+          "not allowed to #{policy.class}##{query} #{record_name}"
+        end
+      end
+
+      super(message)
+    end
+  end
+
+  # Error that will be raised if a policy or policy scope constructor is not called correctly.
+  # @since v2.0.0
+  class InvalidConstructorError < Error; end
+
+  # Error that will be raised if a controller action has not called the
+  # `authorize` or `skip_authorization` methods.
+  # @since v0.2.3
+  class AuthorizationNotPerformedError < Error; end
+
+  # Error that will be raised if a controller action has not called the
+  # `policy_scope` or `skip_policy_scope` methods.
+  # @since v0.3.0
+  class PolicyScopingNotPerformedError < AuthorizationNotPerformedError; end
+
+  # Error that will be raised if a policy or policy scope is not defined.
+  # @since v0.1.0
+  class NotDefinedError < Error; end
+end

data/lib/pundit/helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pundit
+  # Rails view helpers, to allow a slightly different view-specific
+  # implementation of the methods in {Pundit::Authorization}.
+  #
+  # @api private
+  # @since v1.0.0
+  module Helper
+    # @see Pundit::Authorization#pundit_policy_scope
+    # @since v1.0.0
+    def policy_scope(scope)
+      pundit_policy_scope(scope)
+    end
+  end
+end

data/lib/pundit/policy_finder.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+# String#safe_constantize, String#demodulize, String#underscore, String#camelize
+require "active_support/core_ext/string/inflections"
+
 module Pundit
   # Finds policy and scope classes for given object.
+  # @since v0.1.0
   # @api public
   # @example
   #   user = User.find(params[:id])
@@ -10,10 +14,18 @@ module Pundit
   #   finder.scope #=> UserPolicy::Scope
   #
   class PolicyFinder
+    # A constant applied to the end of the class name to find the policy class.
+    #
+    # @api private
+    # @since v2.5.0
+    SUFFIX = "Policy"
+
+    # @see #initialize
+    # @since v0.1.0
     attr_reader :object
 
     # @param object [any] the object to find policy and scope classes for
-    #
+    # @since v0.1.0
     def initialize(object)
       @object = object
     end
@@ -24,6 +36,7 @@ module Pundit
     #   scope = finder.scope #=> UserPolicy::Scope
     #   scope.resolve #=> <#ActiveRecord::Relation ...>
     #
+    # @since v0.1.0
     def scope
       "#{policy}::Scope".safe_constantize
     end
@@ -35,6 +48,7 @@ module Pundit
     #   policy.show? #=> true
     #   policy.update? #=> false
     #
+    # @since v0.1.0
     def policy
       klass = find(object)
       klass.is_a?(String) ? klass.safe_constantize : klass
@@ -43,6 +57,7 @@ module Pundit
     # @return [Scope{#resolve}] scope class which can resolve to a scope
     # @raise [NotDefinedError] if scope could not be determined
     #
+    # @since v0.1.0
     def scope!
       scope or raise NotDefinedError, "unable to find scope `#{find(object)}::Scope` for `#{object.inspect}`"
     end
@@ -50,12 +65,14 @@ module Pundit
     # @return [Class] policy class with query methods
     # @raise [NotDefinedError] if policy could not be determined
     #
+    # @since v0.1.0
     def policy!
       policy or raise NotDefinedError, "unable to find policy `#{find(object)}` for `#{object.inspect}`"
     end
 
     # @return [String] the name of the key this object would have in a params hash
     #
+    # @since v1.1.0
     def param_key # rubocop:disable Metrics/AbcSize
       model = object.is_a?(Array) ? object.last : object
 
@@ -70,6 +87,12 @@ module Pundit
 
     private
 
+    # Given an object, find the policy class name.
+    #
+    # Uses recursion to handle namespaces.
+    #
+    # @return [String, Class] the policy class, or its name.
+    # @since v0.2.0
     def find(subject)
       if subject.is_a?(Array)
         modules = subject.dup
@@ -86,6 +109,15 @@ module Pundit
       end
     end
 
+    # Given an object, find its' class name.
+    #
+    # - Supports ActiveModel.
+    # - Supports regular classes.
+    # - Supports symbols.
+    # - Supports object instances.
+    #
+    # @return [String, Class] the class, or its name.
+    # @since v1.1.0
     def find_class_name(subject)
       if subject.respond_to?(:model_name)
         subject.model_name

data/lib/pundit/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pundit
+  # @since v2.5.0
+  class Railtie < Rails::Railtie
+    if Rails.version.to_f >= 8.0
+      initializer "pundit.stats_directories" do
+        require "rails/code_statistics"
+
+        if Rails.root.join("app/policies").directory?
+          Rails::CodeStatistics.register_directory("Policies", "app/policies")
+        end
+
+        if Rails.root.join("test/policies").directory?
+          Rails::CodeStatistics.register_directory("Policy tests", "test/policies", test_directory: true)
+        end
+      end
+    end
+  end
+end

data/lib/pundit/rspec.rb

@@ -1,13 +1,31 @@
 # frozen_string_literal: true
 
+require "pundit"
+# Array#to_sentence
+require "active_support/core_ext/array/conversions"
+
 module Pundit
+  # Namespace for Pundit's RSpec integration.
+  # @since v0.1.0
   module RSpec
+    # Namespace for Pundit's RSpec matchers.
     module Matchers
       extend ::RSpec::Matchers::DSL
 
+      # @!method description=(description)
       class << self
+        # Used to build a suitable description for the Pundit `permit` matcher.
+        # @api public
+        # @param value [String, Proc]
+        # @example
+        #   Pundit::RSpec::Matchers.description = ->(user, record) do
+        #     "permit user with role #{user.role} to access record with ID #{record.id}"
+        #   end
         attr_writer :description
 
+        # Used to retrieve a suitable description for the Pundit `permit` matcher.
+        # @api private
+        # @private
         def description(user, record)
           return @description.call(user, record) if defined?(@description) && @description.respond_to?(:call)
 
@@ -32,15 +50,21 @@ module Pundit
         end
 
         failure_message_proc = lambda do |policy|
-          was_were = @violating_permissions.count > 1 ? "were" : "was"
           "Expected #{policy} to grant #{permissions.to_sentence} on " \
-          "#{record} but #{@violating_permissions.to_sentence} #{was_were} not granted"
+          "#{record} but #{@violating_permissions.to_sentence} #{was_or_were} not granted"
         end
 
         failure_message_when_negated_proc = lambda do |policy|
-          was_were = @violating_permissions.count > 1 ? "were" : "was"
           "Expected #{policy} not to grant #{permissions.to_sentence} on " \
-          "#{record} but #{@violating_permissions.to_sentence} #{was_were} granted"
+          "#{record} but #{@violating_permissions.to_sentence} #{was_or_were} granted"
+        end
+
+        def was_or_were
+          if @violating_permissions.count > 1
+            "were"
+          else
+            "was"
+          end
         end
 
         description do
@@ -53,21 +77,57 @@ module Pundit
           failure_message(&failure_message_proc)
           failure_message_when_negated(&failure_message_when_negated_proc)
         else
+          # :nocov:
+          # Compatibility with RSpec < 3.0, released 2014-06-01.
           match_for_should(&match_proc)
           match_for_should_not(&match_when_negated_proc)
           failure_message_for_should(&failure_message_proc)
           failure_message_for_should_not(&failure_message_when_negated_proc)
+          # :nocov:
+        end
+
+        if ::RSpec.respond_to?(:current_example)
+          def current_example
+            ::RSpec.current_example
+          end
+        else
+          # :nocov:
+          # Compatibility with RSpec < 3.0, released 2014-06-01.
+          def current_example
+            example
+          end
+          # :nocov:
         end
 
         def permissions
-          current_example = ::RSpec.respond_to?(:current_example) ? ::RSpec.current_example : example
-          current_example.metadata[:permissions]
+          current_example.metadata.fetch(:permissions) do
+            raise KeyError, <<~ERROR.strip
+              No permissions in example metadata, did you forget to wrap with `permissions :show?, ...`?
+            ERROR
+          end
         end
       end
       # rubocop:enable Metrics/BlockLength
     end
 
+    # Mixed in to all policy example groups to provide a DSL.
     module DSL
+      # @example
+      #   describe PostPolicy do
+      #     permissions :show?, :update? do
+      #       it { is_expected.to permit(user, own_post) }
+      #     end
+      #   end
+      #
+      # @example focused example group
+      #   describe PostPolicy do
+      #     permissions :show?, :update?, :focus do
+      #       it { is_expected.to permit(user, own_post) }
+      #     end
+      #   end
+      #
+      # @param list [Symbol, Array<Symbol>] a permission to describe
+      # @return [void]
       def permissions(*list, &block)
         metadata = { permissions: list, caller: caller }
 
@@ -81,6 +141,9 @@ module Pundit
       end
     end
 
+    # Mixed in to all policy example groups.
+    #
+    # @private not useful
     module PolicyExampleGroup
       include Pundit::RSpec::Matchers
 

data/lib/pundit/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Pundit
-  VERSION = "2.4.0"
+  # The current version of Pundit.
+  VERSION = "2.5.1"
 end