pundit-matchers 3.0.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deb38560b2277878e0a13f7f7a6fb510e257c5f84b625a387424e08cb5e8708b
-  data.tar.gz: '084e0cb2b93b0e27f1bb710666b3d9c1aadd9fac71ffef0ca178b025a531cafe'
+  metadata.gz: 141abfa7ebc01c34b65ed5231dd3b66d7453d49a0797f2d8f8cf3c79058f4e4c
+  data.tar.gz: bd9508d4a9f95d60e4239ab0f96a9f210ca8137c907f846ecefcc35a062fcfae
 SHA512:
-  metadata.gz: b219dfc3fbc0a1283f0c87627b5615947f97b449ce299d65be5106e0a46b06d9a0ed40f1f86a84830cc567a74d75da9b597136f1c563cebcce3752eb2a581d45
-  data.tar.gz: ce6b7c6a259a6a4e22f673985c3154e334f87acf2f856b9340f97dd62d5d56945cfc16191bfb503bbce24b12c002394e0994554a29376bbe82849a690926fb19
+  metadata.gz: 7f9c778c08f01c7ffe3060480d55570d18c37358db1c87016bf66608028690764b8a4ac53419ef162fcce71b345dd05c8a617aa1f0598cbeb6d554033b0c1c0a
+  data.tar.gz: f68b63d3155d1fd806c3dd061e5e330fcf656a14bf51ada7d25d856e161b5324822913114328e01d5bd76c99d2198e69a415fdfb21137793bab6ec5815ec741a

data/lib/pundit/matchers/attributes_matcher.rb

@@ -8,6 +8,8 @@ module Pundit
     class AttributesMatcher < BaseMatcher
       # Error message to be raised when no attributes are specified.
       ARGUMENTS_REQUIRED_ERROR = 'At least one attribute must be specified'
+      # Error message to be raised when only one attribute may be specified.
+      ONE_ARGUMENT_REQUIRED_ERROR = 'Only one attribute may be specified'
 
       # Initializes a new instance of the AttributesMatcher class.
       #
@@ -29,6 +31,17 @@ module Pundit
         self
       end
 
+      # Ensures that only one attribute is specified.
+      #
+      # @raise [ArgumentError] If more than one attribute is specified.
+      #
+      # @return [AttributesMatcher] The object itself.
+      def ensure_single_attribute!
+        raise ArgumentError, ONE_ARGUMENT_REQUIRED_ERROR if expected_attributes.size > 1
+
+        self
+      end
+
       private
 
       attr_reader :expected_attributes, :options

data/lib/pundit/matchers/base_matcher.rb

@@ -6,6 +6,8 @@ module Pundit
   module Matchers
     # This is the base class for all matchers in the Pundit Matchers library.
     class BaseMatcher
+      include RSpec::Matchers::Composable
+
       # Error message when an ambiguous negated matcher is used.
       AMBIGUOUS_NEGATED_MATCHER_ERROR = <<~MSG
         `expect().not_to %<name>s` is not supported since it creates ambiguity.

data/lib/pundit/matchers.rb

@@ -152,15 +152,32 @@ module Pundit
       ForbidOnlyActionsMatcher.new(*actions)
     end
 
+    # Creates a matcher that tests if the policy permits mass assignment of an attribute.
+    #
+    # @param [String, Symbol, Hash] attribute the attribute to be tested.
+    # @return [PermitAttributesMatcher] the matcher object.
+    def permit_attribute(attribute)
+      PermitAttributesMatcher.new(attribute).ensure_single_attribute!
+    end
+
+    RSpec::Matchers.define_negated_matcher :forbid_attribute, :permit_attribute, &NEGATED_DESCRIPTION
+
     # Creates a matcher that tests if the policy permits mass assignment of a set of attributes.
     #
     # @param [Array<String, Symbol, Hash>] attributes the attributes to be tested.
     # @return [PermitAttributesMatcher] the matcher object.
-    def permit_mass_assignment_of(*attributes)
+    def permit_attributes(*attributes)
       PermitAttributesMatcher.new(*attributes)
     end
 
-    RSpec::Matchers.define_negated_matcher :forbid_mass_assignment_of, :permit_mass_assignment_of, &NEGATED_DESCRIPTION
+    RSpec::Matchers.define_negated_matcher :forbid_attributes, :permit_attributes, &NEGATED_DESCRIPTION
+
+    # @!macro [attach] RSpec::Matchers.alias_matcher
+    #   @!method $1
+    #
+    #   An alias matcher for {$2}.
+    RSpec::Matchers.alias_matcher :permit_mass_assignment_of, :permit_attributes
+    RSpec::Matchers.alias_matcher :forbid_mass_assignment_of, :forbid_attributes
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pundit-matchers
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.1
 platform: ruby
 authors:
 - Chris Alley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core