pundit-matchers 1.8.1 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7c0cd982bed7811a5fd87db4fd0dbc5c18c1503ee59e808946103b15c924e9
-  data.tar.gz: 461b744c49929c543a8cdd9e7dc4d06ff5465a506b26f4ef1744c6d93a9af414
+  metadata.gz: e7ac5ee799eb2a2f3064a84b07e309ff249e2f0cd8a98895da2922ee09c0ce39
+  data.tar.gz: b8de8ec8ecece032ee5144733ff9d7225430b61b0ef983758d4204370e9ff582
 SHA512:
-  metadata.gz: 2e10a191199743912fa76c85c3cfdcd1ae97b555ba1ddb65c0d41877977b15e5c5724b392491cf713b23d175da46ea2bf976e4c7ced2d3043798f2c33e4bb37d
-  data.tar.gz: a925f3138bac77363d62c813def360cb45573b321513c305327bffb2746d517f68765ff5c36b84525e2ee7e8e134a6de36c349777dcd97cdbd685147fba6c890
+  metadata.gz: 1370ebade318121ba43fada2826d6796af2b3c0529fb93440557929175b6fd52f5d2bb65cc5ca692158f3351ab105eee685202c0660e415f47d64bb723743855
+  data.tar.gz: 1805f3272434c2a26e49e407db6ce45f8c4b8a95445e023d32bb2f710281b26eefcabb933a4afeb3a6707a861b3cf103d625b5442365441c7acb2ee8245eb02e

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,11 +2,11 @@ require 'rspec/core'
 
 module Pundit
   module Matchers
-    require 'pundit/matchers/utils/policy_info'
-    require 'pundit/matchers/utils/all_actions/forbidden_actions_error_formatter'
-    require 'pundit/matchers/utils/all_actions/forbidden_actions_matcher'
-    require 'pundit/matchers/utils/all_actions/permitted_actions_error_formatter'
-    require 'pundit/matchers/utils/all_actions/permitted_actions_matcher'
+    require './matchers/utils/policy_info'
+    require './matchers/utils/all_actions/forbidden_actions_error_formatter'
+    require './matchers/utils/all_actions/forbidden_actions_matcher'
+    require './matchers/utils/all_actions/permitted_actions_error_formatter'
+    require './matchers/utils/all_actions/permitted_actions_matcher'
 
     class Configuration
       attr_accessor :user_alias

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pundit-matchers
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.3
 platform: ruby
 authors:
 - Chris Alley
@@ -51,6 +51,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/pundit/matchers.rb
+- 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