pundit-matchers 1.7.0 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0da80bb866c35b8ab6548d017a9bc022831e3da0c5493b99aac0ba5c8c79cad
-  data.tar.gz: 24bfacd140e3976e30c88204db5e33566c42dbd5e45d568c8d857a7a4205951d
+  metadata.gz: e82fc8f2d6caff46e84825de52194c6d349bb4e8b892b1d0cc2d89aeca3e098d
+  data.tar.gz: 4c3d25e6babeca67e96ba7a74f51c137a49f51fb78788ad6472f88fb72cb9990
 SHA512:
-  metadata.gz: 5c1fbddf259fce9fa65c6f0613ec5d46e271ab0c7212380bc86cb5fef6fb85a2f74b6c20a4fb6b4c0e1dacc6b8ad11e1c963f8827c997e88bb319cce157d305b
-  data.tar.gz: a2363786904df0631c54b8d84094179b61607e300a16ba53cd6406b02272e51f1e21060832f5b64a3eeaaba1ff6dba7c8462d3308732f335dc363df666058120
+  metadata.gz: 54ee9f992e7c90438a6613b98e3b9877b0510097e5711e2dc1f5aa3b550ceb8b40ffda1925547088f1da8bd2eeca1d195ae826127f427afb56dadff71375aa23
+  data.tar.gz: 4d6a0da772460ee2cbfe4721cbb7b14dc9fb9ef2d96335aabb88f3694b8a8bb7db49fd73eeb2b3b2105a4a3c89a3c3319dfef48258d4bb7ba51ffdfd7e80b99f

data/lib/pundit/matchers/utils/all_actions/actions_matcher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Parent class for specific all_action matcher. Should not be used directly.
+        #
+        # Expects methods in child class:
+        # * actual_actions - list of actions which actually matches expected type.
+        class ActionsMatcher
+          attr_reader :policy_info
+
+          def initialize(policy)
+            @policy_info = PolicyInfo.new(policy)
+          end
+
+          def match?
+            missed_expected_actions.empty?
+          end
+
+          def missed_expected_actions
+            @missed_expected_actions ||= expected_actions - actual_actions
+          end
+
+          def policy
+            policy_info.policy
+          end
+
+          private
+
+          def expected_actions
+            policy_info.actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/all_actions/error_message_formatter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Adds #message method which generates failed assertion message
+        # for *_all_actions matchers.
+        #
+        # Expects methods to be defined:
+        # * matcher - instance which has `AllActions::ActionsMatcher` as a parent class
+        # * expected_kind - string with expected actions type (can be "forbidden" or "permitted")
+        # * opposite_kind - string with oposite then expected actions type (can be "permitted" or "forbidden")
+        module ErrorMessageFormatter
+          def message
+            "#{policy_name} expected to have all actions #{expected_kind}, " \
+            "but #{mismatches_are(missed_expected_actions)} #{opposite_kind}"
+          end
+
+          private
+
+          attr_reader :matcher, :expected_kind, :opposite_kind
+
+          def policy
+            matcher.policy
+          end
+
+          def missed_expected_actions
+            matcher.missed_expected_actions
+          end
+
+          def policy_name
+            policy.class.name
+          end
+
+          def mismatches_are(mismatches)
+            if mismatches.count == 1
+              "#{mismatches} is"
+            else
+              "#{mismatches} are"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/all_actions/forbidden_actions_error_formatter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'error_message_formatter'
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Error message formatter for `forbid_all_actions` matcher.
+        class ForbiddenActionsErrorFormatter
+          include AllActions::ErrorMessageFormatter
+
+          def initialize(matcher)
+            @expected_kind = 'forbidden'
+            @opposite_kind = 'permitted'
+            @matcher = matcher
+          end
+
+          private
+
+          attr_reader :matcher, :expected_kind, :opposite_kind
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/all_actions/forbidden_actions_matcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'actions_matcher'
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Handles all the checks in `forbid_all_actions` matcher.
+        class ForbiddenActionsMatcher < AllActions::ActionsMatcher
+          private
+
+          def actual_actions
+            policy_info.forbidden_actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/all_actions/permitted_actions_error_formatter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'error_message_formatter'
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Error message formatter for `permit_all_actions` matcher.
+        class PermittedActionsErrorFormatter
+          include AllActions::ErrorMessageFormatter
+
+          def initialize(matcher)
+            @expected_kind = 'permitted'
+            @opposite_kind = 'forbidden'
+            @matcher = matcher
+          end
+
+          private
+
+          attr_reader :matcher, :expected_kind, :actual_kind
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/all_actions/permitted_actions_matcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'actions_matcher'
+
+module Pundit
+  module Matchers
+    module Utils
+      module AllActions
+        # Handles all the checks in `permit_all_actions` matcher.
+        class PermittedActionsMatcher < AllActions::ActionsMatcher
+          private
+
+          def actual_actions
+            policy_info.permitted_actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers/utils/policy_info.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Matchers
+    module Utils
+      # Collects all details about given policy class.
+      class PolicyInfo
+        attr_reader :policy
+
+        def initialize(policy)
+          @policy = policy
+        end
+
+        def actions
+          @actions ||= begin
+            policy_methods = @policy.public_methods - Object.instance_methods
+            policy_methods.grep(/\?$/).map { |policy_method| policy_method.to_s.sub(/\?$/, '').to_sym }
+          end
+        end
+
+        def permitted_actions
+          @permitted_actions ||= actions.select { |action| policy.public_send("#{action}?") }
+        end
+
+        def forbidden_actions
+          actions - permitted_actions
+        end
+      end
+    end
+  end
+end

data/lib/pundit/matchers.rb

@@ -2,6 +2,12 @@ require 'rspec/core'
 
 module Pundit
   module Matchers
+    require_relative 'matchers/utils/policy_info'
+    require_relative 'matchers/utils/all_actions/forbidden_actions_error_formatter'
+    require_relative 'matchers/utils/all_actions/forbidden_actions_matcher'
+    require_relative 'matchers/utils/all_actions/permitted_actions_error_formatter'
+    require_relative 'matchers/utils/all_actions/permitted_actions_matcher'
+
     class Configuration
       attr_accessor :user_alias
 
@@ -364,6 +370,30 @@ module Pundit
               .inspect + '.'
     end
   end
+
+  RSpec::Matchers.define :permit_all_actions do
+    match do |policy|
+      @matcher = Pundit::Matchers::Utils::AllActions::PermittedActionsMatcher.new(policy)
+      @matcher.match?
+    end
+
+    failure_message do
+      formatter = Pundit::Matchers::Utils::AllActions::PermittedActionsErrorFormatter.new(@matcher)
+      formatter.message
+    end
+  end
+
+  RSpec::Matchers.define :forbid_all_actions do
+    match do |policy|
+      @matcher = Pundit::Matchers::Utils::AllActions::ForbiddenActionsMatcher.new(policy)
+      @matcher.match?
+    end
+
+    failure_message do
+      formatter = Pundit::Matchers::Utils::AllActions::ForbiddenActionsErrorFormatter.new(@matcher)
+      formatter.message
+    end
+  end
 end
 
 if defined?(Pundit)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pundit-matchers
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.4
 platform: ruby
 authors:
 - Chris Alley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-04 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -51,7 +51,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/pundit/matchers.rb
-homepage: http://github.com/chrisalley/pundit-matchers
+- lib/pundit/matchers/utils/all_actions/actions_matcher.rb
+- lib/pundit/matchers/utils/all_actions/error_message_formatter.rb
+- lib/pundit/matchers/utils/all_actions/forbidden_actions_error_formatter.rb
+- lib/pundit/matchers/utils/all_actions/forbidden_actions_matcher.rb
+- lib/pundit/matchers/utils/all_actions/permitted_actions_error_formatter.rb
+- lib/pundit/matchers/utils/all_actions/permitted_actions_matcher.rb
+- lib/pundit/matchers/utils/policy_info.rb
+homepage: http://github.com/punditcommunity/pundit-matchers
 licenses:
 - MIT
 metadata: {}
@@ -70,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: RSpec matchers for Pundit policies