pundit-matchers 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f3b354daf4a7619dc0fe63bc65984f0a8390b5fc9a3a2b1c7d2129cb5d12bf0
-  data.tar.gz: c4a47b2387ddcf8541c7fe8f7e7b98067263d312db6a9d3718621d5fb446b115
+  metadata.gz: ca57a9d5fc96cbacd89c5af52106a126fa6cf01d72654c677fa5e1a7a957e139
+  data.tar.gz: 5dd3c52dcf6cc289a76ba40947ff1d46fad538e5b6bfcec5484ba1d87b2092b9
 SHA512:
-  metadata.gz: adac619cd1badd3d0f83ccb535a45f4633f199badb12c6daba7d4b9a2be5f79db321f6268645b6a66d6776f4b048fb2096cb3dd74c850be64a9caf56d3d9bce2
-  data.tar.gz: 25fb9deee8b3779156ea4d6ba26b71a5af47133bd2d4fdb594fe119e2803d85265027c7c8044a2c2ce364d04f5933330e752857617a4fd598c3596f1c2d8e2b2
+  metadata.gz: e965e471adca0f06d4ab84e1d03f426902d5ac79bb69644afc88be3b158defb27bcd36d9170c6f47fbb3cbf7d832884a9b8f1e65bc3e7e0587d4ede6d75f9de5
+  data.tar.gz: e8c47b1311ab7afc3d119714ee12d605d0063dc315f38a70e7fc0b5761e99432cd6f3fceb109a504e82b4c61621147197291dbd59f5d1dceb434e7f6ec346d80

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

@@ -14,7 +14,7 @@ module Pundit
         module ErrorMessageFormatter
           def message
             "#{policy_name} expected to have all actions #{expected_kind}, " \
-            "but #{mismatches_are(missed_expected_actions)} #{opposite_kind}"
+              "but #{mismatches_are(missed_expected_actions)} #{opposite_kind}"
           end
 
           private

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Matchers
+    module Utils
+      module OnlyActions
+        # Parent class for specific only_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, :expected_actions
+
+          def initialize(policy, expected_actions)
+            @policy_info = PolicyInfo.new(policy)
+            @expected_actions = expected_actions
+          end
+
+          def match?
+            missed_expected_actions.empty? &&
+              actual_actions.sort == expected_actions.sort
+          end
+
+          def unexpected_actions
+            @unexpected_actions ||= actual_actions - expected_actions
+          end
+
+          def missed_expected_actions
+            @missed_expected_actions ||= expected_actions - actual_actions
+          end
+
+          def policy
+            policy_info.policy
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Pundit
+  module Matchers
+    module Utils
+      module OnlyActions
+        # Adds #message method which generates failed assertion message
+        # for *_only_actions matchers.
+        #
+        # Expects methods to be defined:
+        # * matcher - instance which has `OnlyActions::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 only actions #{matcher.expected_actions} #{expected_kind}, but " \
+              "#{unless missed_expected_actions.empty?
+                   "#{mismatches_are(missed_expected_actions)} #{opposite_kind} and "
+                 end}" \
+              "#{mismatches_are(unexpected_actions)} #{expected_kind} too"
+          end
+
+          private
+
+          attr_reader :matcher, :expected_kind, :opposite_kind
+
+          def policy
+            matcher.policy
+          end
+
+          def unexpected_actions
+            matcher.unexpected_actions
+          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/only_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 OnlyActions
+        # Error message formatter for `forbid_only_actions` matcher.
+        class ForbiddenActionsErrorFormatter
+          include OnlyActions::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/only_actions/forbidden_actions_matcher.rb

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

data/lib/pundit/matchers/utils/only_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 OnlyActions
+        # Error message formatter for `permit_only_actions` matcher.
+        class PermittedActionsErrorFormatter
+          include OnlyActions::ErrorMessageFormatter
+
+          def initialize(matcher)
+            @expected_kind = 'permitted'
+            @opposite_kind = 'forbidden'
+            @matcher = matcher
+          end
+
+          private
+
+          attr_reader :matcher, :expected_kind, :opposite_kind
+        end
+      end
+    end
+  end
+end

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

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

data/lib/pundit/matchers.rb

@@ -8,6 +8,11 @@ module Pundit
     require_relative 'matchers/utils/all_actions/permitted_actions_error_formatter'
     require_relative 'matchers/utils/all_actions/permitted_actions_matcher'
 
+    require_relative 'matchers/utils/only_actions/forbidden_actions_error_formatter'
+    require_relative 'matchers/utils/only_actions/forbidden_actions_matcher'
+    require_relative 'matchers/utils/only_actions/permitted_actions_error_formatter'
+    require_relative 'matchers/utils/only_actions/permitted_actions_matcher'
+
     class Configuration
       attr_accessor :user_alias
 
@@ -53,6 +58,7 @@ module Pundit
     actions.flatten!
     match do |policy|
       return false if actions.count < 1
+
       @allowed_actions = actions.select do |action|
         policy.public_send("#{action}?")
       end
@@ -62,14 +68,14 @@ module Pundit
     attr_reader :allowed_actions
 
     zero_actions_failure_message = 'At least one action must be ' \
-      'specified when using the forbid_actions matcher.'
+                                   'specified when using the forbid_actions matcher.'
 
     failure_message do |policy|
       if actions.count.zero?
         zero_actions_failure_message
       else
         "#{policy.class} expected to forbid #{actions}, but allowed " \
-          "#{allowed_actions} for " +
+        "#{allowed_actions} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -80,7 +86,7 @@ module Pundit
         zero_actions_failure_message
       else
         "#{policy.class} expected to permit #{actions}, but forbade " \
-          "#{allowed_actions} for " +
+        "#{allowed_actions} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -107,7 +113,7 @@ module Pundit
 
   RSpec::Matchers.define :forbid_mass_assignment_of do |attributes|
     # Map single object argument to an array, if necessary
-    attributes = attributes.is_a?(Array) ? attributes : [attributes]
+    attributes = [attributes] unless attributes.is_a?(Array)
 
     match do |policy|
       return false if attributes.count < 1
@@ -130,22 +136,22 @@ module Pundit
     end
 
     zero_attributes_failure_message = 'At least one attribute must be ' \
-      'specified when using the forbid_mass_assignment_of matcher.'
+                                      'specified when using the forbid_mass_assignment_of matcher.'
 
     failure_message do |policy|
       if attributes.count.zero?
         zero_attributes_failure_message
       elsif defined? @action
         "#{policy.class} expected to forbid the mass assignment of the " \
-          "attributes #{attributes} when authorising the #{@action} action, " \
-          'but allowed the mass assignment of the attributes ' \
-          "#{allowed_attributes} for " +
+        "attributes #{attributes} when authorising the #{@action} action, " \
+        'but allowed the mass assignment of the attributes ' \
+        "#{allowed_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       else
         "#{policy.class} expected to forbid the mass assignment of the " \
-          "attributes #{attributes}, but allowed the mass assignment of " \
-          "the attributes #{allowed_attributes} for " +
+        "attributes #{attributes}, but allowed the mass assignment of " \
+        "the attributes #{allowed_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -156,15 +162,15 @@ module Pundit
         zero_attributes_failure_message
       elsif defined? @action
         "#{policy.class} expected to permit the mass assignment of the " \
-          "attributes #{attributes} when authorising the #{@action} action, " \
-          'but permitted the mass assignment of the attributes ' \
-          "#{allowed_attributes} for " +
+        "attributes #{attributes} when authorising the #{@action} action, " \
+        'but permitted the mass assignment of the attributes ' \
+        "#{allowed_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       else
         "#{policy.class} expected to permit the mass assignment of the " \
-          "attributes #{attributes}, but permitted the mass assignment of " \
-          "the attributes #{allowed_attributes} for " +
+        "attributes #{attributes}, but permitted the mass assignment of " \
+        "the attributes #{allowed_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -215,6 +221,7 @@ module Pundit
     actions.flatten!
     match do |policy|
       return false if actions.count < 1
+
       @forbidden_actions = actions.reject do |action|
         policy.public_send("#{action}?")
       end
@@ -235,6 +242,7 @@ module Pundit
         tests would pass.'
 
       return true if actions.count < 1
+
       @forbidden_actions = actions.reject do |action|
         policy.public_send("#{action}?")
       end
@@ -244,14 +252,14 @@ module Pundit
     attr_reader :forbidden_actions
 
     zero_actions_failure_message = 'At least one action must be specified ' \
-      'when using the permit_actions matcher.'
+                                   'when using the permit_actions matcher.'
 
     failure_message do |policy|
       if actions.count.zero?
         zero_actions_failure_message
       else
         "#{policy.class} expected to permit #{actions}, but forbade " \
-          "#{forbidden_actions} for " +
+        "#{forbidden_actions} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -262,7 +270,7 @@ module Pundit
         zero_actions_failure_message
       else
         "#{policy.class} expected to forbid #{actions}, but allowed " \
-          "#{forbidden_actions} for " +
+        "#{forbidden_actions} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -289,7 +297,7 @@ module Pundit
 
   RSpec::Matchers.define :permit_mass_assignment_of do |attributes|
     # Map single object argument to an array, if necessary
-    attributes = attributes.is_a?(Array) ? attributes : [attributes]
+    attributes = [attributes] unless attributes.is_a?(Array)
 
     match do |policy|
       return false if attributes.count < 1
@@ -312,22 +320,22 @@ module Pundit
     end
 
     zero_attributes_failure_message = 'At least one attribute must be ' \
-      'specified when using the permit_mass_assignment_of matcher.'
+                                      'specified when using the permit_mass_assignment_of matcher.'
 
     failure_message do |policy|
       if attributes.count.zero?
         zero_attributes_failure_message
       elsif defined? @action
         "#{policy.class} expected to permit the mass assignment of the " \
-          "attributes #{attributes} when authorising the #{@action} action, " \
-          'but forbade the mass assignment of the attributes ' \
-          "#{forbidden_attributes} for " +
+        "attributes #{attributes} when authorising the #{@action} action, " \
+        'but forbade the mass assignment of the attributes ' \
+        "#{forbidden_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       else
         "#{policy.class} expected to permit the mass assignment of the " \
-          "attributes #{attributes}, but forbade the mass assignment of the " \
-          "attributes #{forbidden_attributes} for " +
+        "attributes #{attributes}, but forbade the mass assignment of the " \
+        "attributes #{forbidden_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -338,15 +346,15 @@ module Pundit
         zero_attributes_failure_message
       elsif defined? @action
         "#{policy.class} expected to forbid the mass assignment of the " \
-          "attributes #{attributes} when authorising the #{@action} action, " \
-          'but forbade the mass assignment of the attributes ' \
-          "#{forbidden_attributes} for " +
+        "attributes #{attributes} when authorising the #{@action} action, " \
+        'but forbade the mass assignment of the attributes ' \
+        "#{forbidden_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       else
         "#{policy.class} expected to forbid the mass assignment of the " \
-          "attributes #{attributes}, but forbade the mass assignment of the " \
-          "attributes #{forbidden_attributes} for " +
+        "attributes #{attributes}, but forbade the mass assignment of the " \
+        "attributes #{forbidden_attributes} for " +
           policy.public_send(Pundit::Matchers.configuration.user_alias)
                 .inspect + '.'
       end
@@ -383,6 +391,18 @@ module Pundit
     end
   end
 
+  RSpec::Matchers.define :permit_only_actions do |actions|
+    match do |policy|
+      @matcher = Pundit::Matchers::Utils::OnlyActions::PermittedActionsMatcher.new(policy, actions)
+      @matcher.match?
+    end
+
+    failure_message do
+      formatter = Pundit::Matchers::Utils::OnlyActions::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)
@@ -394,6 +414,18 @@ module Pundit
       formatter.message
     end
   end
+
+  RSpec::Matchers.define :forbid_only_actions do |actions|
+    match do |policy|
+      @matcher = Pundit::Matchers::Utils::OnlyActions::ForbiddenActionsMatcher.new(policy, actions)
+      @matcher.match?
+    end
+
+    failure_message do
+      formatter = Pundit::Matchers::Utils::OnlyActions::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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Alley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -57,11 +57,18 @@ files:
 - 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/only_actions/actions_matcher.rb
+- lib/pundit/matchers/utils/only_actions/error_message_formatter.rb
+- lib/pundit/matchers/utils/only_actions/forbidden_actions_error_formatter.rb
+- lib/pundit/matchers/utils/only_actions/forbidden_actions_matcher.rb
+- lib/pundit/matchers/utils/only_actions/permitted_actions_error_formatter.rb
+- lib/pundit/matchers/utils/only_actions/permitted_actions_matcher.rb
 - lib/pundit/matchers/utils/policy_info.rb
 homepage: http://github.com/punditcommunity/pundit-matchers
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -70,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="