pundit-matchers 1.4.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa9d9639180168e0aa248c00f916e8711b0e82a3
-  data.tar.gz: 2e70263fd7ca377531a0c34e6136dc0e4ed9f80d
+SHA256:
+  metadata.gz: b0da80bb866c35b8ab6548d017a9bc022831e3da0c5493b99aac0ba5c8c79cad
+  data.tar.gz: 24bfacd140e3976e30c88204db5e33566c42dbd5e45d568c8d857a7a4205951d
 SHA512:
-  metadata.gz: 5a5ebc0298d666b8b19884710386fe194f114acd2e7724468286032f516f9a522a13418baba5c5b0e93294000dbbe1f190a0b20e5a1646537ffe5aed28eab0fd
-  data.tar.gz: c2e2e029245a9e6d52b200905653a9acb092ba23abe481bc1f686364bae5171eeeebc580dc379cad9004f93db9925864579d862f9b551971bc8e43c3f019e67b
+  metadata.gz: 5c1fbddf259fce9fa65c6f0613ec5d46e271ab0c7212380bc86cb5fef6fb85a2f74b6c20a4fb6b4c0e1dacc6b8ad11e1c963f8827c997e88bb319cce157d305b
+  data.tar.gz: a2363786904df0631c54b8d84094179b61607e300a16ba53cd6406b02272e51f1e21060832f5b64a3eeaaba1ff6dba7c8462d3308732f335dc363df666058120

data/lib/pundit/matchers.rb

@@ -2,6 +2,24 @@ require 'rspec/core'
 
 module Pundit
   module Matchers
+    class Configuration
+      attr_accessor :user_alias
+
+      def initialize
+        @user_alias = :user
+      end
+    end
+
+    class << self
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Pundit::Matchers::Configuration.new
+      end
+    end
+
     RSpec::Matchers.define :forbid_action do |action, *args|
       match do |policy|
         if args.any?
@@ -12,20 +30,23 @@ module Pundit
       end
 
       failure_message do |policy|
-        "#{policy.class} does not forbid #{action} for " \
-          "#{policy.user.inspect}."
+        "#{policy.class} does not forbid #{action} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
 
       failure_message_when_negated do |policy|
-        "#{policy.class} does not permit #{action} for " \
-          "#{policy.user.inspect}."
+        "#{policy.class} does not permit #{action} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
   end
 
-  RSpec::Matchers.define :forbid_actions do |actions|
+  RSpec::Matchers.define :forbid_actions do |*actions|
+    actions.flatten!
     match do |policy|
-      return false if actions.count < 2
+      return false if actions.count < 1
       @allowed_actions = actions.select do |action|
         policy.public_send("#{action}?")
       end
@@ -34,26 +55,28 @@ module Pundit
 
     attr_reader :allowed_actions
 
-    zero_actions_failure_message = 'At least two actions must be ' \
+    zero_actions_failure_message = 'At least one action must be ' \
       'specified when using the forbid_actions matcher.'
 
     failure_message do |policy|
-      case actions.count
-      when 0
+      if actions.count.zero?
         zero_actions_failure_message
       else
         "#{policy.class} expected to forbid #{actions}, but allowed " \
-          "#{allowed_actions} for #{policy.user.inspect}."
+          "#{allowed_actions} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
 
     failure_message_when_negated do |policy|
-      case actions.count
-      when 0
+      if actions.count.zero?
         zero_actions_failure_message
       else
         "#{policy.class} expected to permit #{actions}, but forbade " \
-          "#{allowed_actions} for #{policy.user.inspect}."
+          "#{allowed_actions} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
   end
@@ -64,48 +87,80 @@ module Pundit
     end
 
     failure_message do |policy|
-      "#{policy.class} does not forbid the edit or update action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not forbid the edit or update action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
 
     failure_message_when_negated do |policy|
-      "#{policy.class} does not permit the edit or update action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not permit the edit or update action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
   end
 
-  RSpec::Matchers.define :forbid_mass_assignment_of do |attribute|
+  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]
+
     match do |policy|
-      if defined? @action
-        !policy.send("permitted_attributes_for_#{@action}").include? attribute
-      else
-        !policy.permitted_attributes.include? attribute
+      return false if attributes.count < 1
+
+      @allowed_attributes = attributes.select do |attribute|
+        if defined? @action
+          policy.send("permitted_attributes_for_#{@action}").include? attribute
+        else
+          policy.permitted_attributes.include? attribute
+        end
       end
+
+      @allowed_attributes.empty?
     end
 
+    attr_reader :allowed_attributes
+
     chain :for_action do |action|
       @action = action
     end
 
+    zero_attributes_failure_message = 'At least one attribute must be ' \
+      'specified when using the forbid_mass_assignment_of matcher.'
+
     failure_message do |policy|
-      if defined? @action
-        "#{policy.class} does not forbid the mass assignment of the " \
-          "#{attribute} attribute, when authorising the #{@action} action, " \
-          "for #{policy.user.inspect}."
+      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 " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       else
-        "#{policy.class} does not forbid the mass assignment of the " \
-          "#{attribute} attribute for #{policy.user.inspect}."
+        "#{policy.class} expected to forbid the mass assignment of the " \
+          "attributes #{attributes}, but allowed the mass assignment of " \
+          "the attributes #{allowed_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
 
     failure_message_when_negated do |policy|
-      if defined? @action
-        "#{policy.class} does not permit the mass assignment of the " \
-          "#{attribute} attribute, when authorising the #{@action} action, " \
-          "for #{policy.user.inspect}."
+      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 permitted the mass assignment of the attributes ' \
+          "#{allowed_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       else
-        "#{policy.class} does not permit the mass assignment of the " \
-          "#{attribute} attribute for #{policy.user.inspect}."
+        "#{policy.class} expected to permit the mass assignment of the " \
+          "attributes #{attributes}, but permitted the mass assignment of " \
+          "the attributes #{allowed_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
   end
@@ -116,13 +171,15 @@ module Pundit
     end
 
     failure_message do |policy|
-      "#{policy.class} does not forbid the new or create action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not forbid the new or create action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
 
     failure_message_when_negated do |policy|
-      "#{policy.class} does not permit the new or create action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not permit the new or create action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
   end
 
@@ -136,49 +193,72 @@ module Pundit
     end
 
     failure_message do |policy|
-      "#{policy.class} does not permit #{action} for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not permit #{action} for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
 
     failure_message_when_negated do |policy|
-      "#{policy.class} does not forbid #{action} for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not forbid #{action} for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
   end
 
-  RSpec::Matchers.define :permit_actions do |actions|
+  RSpec::Matchers.define :permit_actions do |*actions|
+    actions.flatten!
     match do |policy|
-      return false if actions.count < 2
+      return false if actions.count < 1
       @forbidden_actions = actions.reject do |action|
         policy.public_send("#{action}?")
       end
       @forbidden_actions.empty?
     end
 
+    match_when_negated do |policy|
+      ::Kernel.warn 'Using expect { }.not_to permit_actions could produce \
+        confusing results. Please use `.to forbid_actions` instead. To \
+        clarify, `.not_to permit_actions` will look at all of the actions and \
+        checks if ANY actions fail, not if all actions fail. Therefore, you \
+        could result in something like this: \
+
+        it { is_expected.to permit_actions([:new, :create, :edit]) } \
+        it { is_expected.not_to permit_actions([:edit, :destroy]) } \
+
+        In this case, edit would be true and destroy would be false, but both \
+        tests would pass.'
+
+      return true if actions.count < 1
+      @forbidden_actions = actions.reject do |action|
+        policy.public_send("#{action}?")
+      end
+      !@forbidden_actions.empty?
+    end
+
     attr_reader :forbidden_actions
 
-    zero_actions_failure_message = 'At least two actions must be ' \
-      'specified when using the permit_actions matcher.'
+    zero_actions_failure_message = 'At least one action must be specified ' \
+      'when using the permit_actions matcher.'
 
     failure_message do |policy|
-      case actions.count
-      when 0
+      if actions.count.zero?
         zero_actions_failure_message
       else
         "#{policy.class} expected to permit #{actions}, but forbade " \
-          "#{forbidden_actions} for #{policy.user.inspect}."
+          "#{forbidden_actions} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
 
     failure_message_when_negated do |policy|
-      case actions.count
-      when 0
+      if actions.count.zero?
         zero_actions_failure_message
-      when 1
-        one_action_failure_message
       else
         "#{policy.class} expected to forbid #{actions}, but allowed " \
-          "#{forbidden_actions} for #{policy.user.inspect}."
+          "#{forbidden_actions} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
   end
@@ -189,48 +269,80 @@ module Pundit
     end
 
     failure_message do |policy|
-      "#{policy.class} does not permit the edit or update action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not permit the edit or update action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
 
     failure_message_when_negated do |policy|
-      "#{policy.class} does not forbid the edit or update action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not forbid the edit or update action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
   end
 
-  RSpec::Matchers.define :permit_mass_assignment_of do |attribute|
+  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]
+
     match do |policy|
-      if defined? @action
-        policy.send("permitted_attributes_for_#{@action}").include? attribute
-      else
-        policy.permitted_attributes.include? attribute
+      return false if attributes.count < 1
+
+      @forbidden_attributes = attributes.select do |attribute|
+        if defined? @action
+          !policy.send("permitted_attributes_for_#{@action}").include? attribute
+        else
+          !policy.permitted_attributes.include? attribute
+        end
       end
+
+      @forbidden_attributes.empty?
     end
 
+    attr_reader :forbidden_attributes
+
     chain :for_action do |action|
       @action = action
     end
 
+    zero_attributes_failure_message = 'At least one attribute must be ' \
+      'specified when using the permit_mass_assignment_of matcher.'
+
     failure_message do |policy|
-      if defined? @action
-        "#{policy.class} does not permit the mass assignment of the " \
-          "#{attribute} attribute, when authorising the #{@action} action, " \
-          "for #{policy.user.inspect}."
+      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 " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       else
-        "#{policy.class} does not permit the mass assignment of the " \
-          "#{attribute} attribute for #{policy.user.inspect}."
+        "#{policy.class} expected to permit the mass assignment of the " \
+          "attributes #{attributes}, but forbade the mass assignment of the " \
+          "attributes #{forbidden_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
 
     failure_message_when_negated do |policy|
-      if defined? @action
-        "#{policy.class} does not forbid the mass assignment of the " \
-          "#{attribute} attribute, when authorising the #{@action} action, " \
-          "for #{policy.user.inspect}."
+      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 forbade the mass assignment of the attributes ' \
+          "#{forbidden_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       else
-        "#{policy.class} does not forbid the mass assignment of the " \
-          "#{attribute} attribute for #{policy.user.inspect}."
+        "#{policy.class} expected to forbid the mass assignment of the " \
+          "attributes #{attributes}, but forbade the mass assignment of the " \
+          "attributes #{forbidden_attributes} for " +
+          policy.public_send(Pundit::Matchers.configuration.user_alias)
+                .inspect + '.'
       end
     end
   end
@@ -241,13 +353,15 @@ module Pundit
     end
 
     failure_message do |policy|
-      "#{policy.class} does not permit the new or create action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not permit the new or create action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
 
     failure_message_when_negated do |policy|
-      "#{policy.class} does not forbid the new or create action for " \
-        "#{policy.user.inspect}."
+      "#{policy.class} does not forbid the new or create action for " +
+        policy.public_send(Pundit::Matchers.configuration.user_alias)
+              .inspect + '.'
     end
   end
 end

metadata

@@ -1,49 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: pundit-matchers
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Chris Alley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pundit
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: pundit
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: 1.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.1.0
 description: A set of RSpec matchers for testing Pundit authorisation policies
 email: chris@chrisalley.info
 executables: []
@@ -55,7 +55,7 @@ homepage: http://github.com/chrisalley/pundit-matchers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: RSpec matchers for Pundit policies
 test_files: []