matchi 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aabf9e773ac6210d1170b3a0f3aa19f38845ea0215bb07280d97c35ef66add16
-  data.tar.gz: 2900c9b936d50bfbe50ba31c6418dcb1402c1fbef5cfbb9f7a1ce289ff6450c0
+  metadata.gz: 5596c7ba2d1153eadaa1ba438b009c0cc17954a360b4192bb6419c674d864822
+  data.tar.gz: 0c717e7642961b8707433584c58a1e2369f810c11114caa7530c890563df78a3
 SHA512:
-  metadata.gz: e2cfb5b1c32a01b84c1e2eec84cfc3ad34df2a7a17c91ecb1e6012ef84d5b4ef5b11f24817de7dcea77e08006e72c578d0d88947470436f231efef8fed18f061
-  data.tar.gz: 235a73246185fec310960caf6b8c868cbc2daf7598f29c863def9b560ec66ba7a0f43ab303cd164b04c81b5ebbcbddae3224c5550002f9ab924f8202f58a289f
+  metadata.gz: 8e89b77b4f7fd25fc53ea570b865b3479be5a3291bc437f55b3ea126111fdd120afd907439ec87c565bbb28b4fe6e7be34a932a218e55933bb3d4bb890b0edcf
+  data.tar.gz: f19a1f799d1b8f9c1f40dc747c00863ae1cd9bf1ed545aabdea774e4c658a242a74d2bd6f03709fe124786f327fd7401b104aa9e567496265b966937c61841e3

data/README.md

@@ -114,6 +114,20 @@ matcher.expected           # => "String"
 matcher.matches? { "foo" } # => true
 ```
 
+**Predicate** matcher:
+
+```ruby
+matcher = Matchi::Predicate.new(:be_empty)
+
+matcher.expected        # => [:empty?, [], {}, nil]
+matcher.matches? { [] } # => true
+
+matcher = Matchi::Predicate.new(:have_key, :foo)
+
+matcher.expected                 # => [:has_key?, [:foo], {}, nil]
+matcher.matches? { { foo: 42 } } # => true
+```
+
 **Change** matcher:
 
 ```ruby

data/lib/matchi/predicate.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Matchi
+  # *Predicate* matcher.
+  class Predicate
+    # Initialize the matcher with a name and arguments.
+    #
+    # @example
+    #   require "matchi/predicate"
+    #
+    #   Matchi::Predicate.new(:be_empty)
+    #
+    # @param name   [#to_s] A matcher name.
+    # @param args   [Array] A list of parameters.
+    # @param kwargs [Hash]  A list of keyword parameters.
+    # @param block  [Proc]  A block of code.
+    def initialize(name, *args, **kwargs, &block)
+      @name = String(name)
+
+      raise ::ArgumentError unless valid_name?
+
+      @args   = args
+      @kwargs = kwargs
+      @block  = block
+    end
+
+    # @return [Array] The method name with any arguments to send to the subject.
+    def expected
+      [method_name, @args, @kwargs, @block]
+    end
+
+    # Boolean comparison between the actual value and the expected value.
+    #
+    # @example
+    #   require "matchi/predicate"
+    #
+    #   matcher = Matchi::Predicate.new(:be_empty)
+    #
+    #   matcher.expected        # => [:empty?, [], {}, nil]
+    #   matcher.matches? { [] } # => true
+    #
+    # @example
+    #   require "matchi/predicate"
+    #
+    #   matcher = Matchi::Predicate.new(:have_key, :foo)
+    #
+    #   matcher.expected                 # => [:has_key?, [:foo], {}, nil]
+    #   matcher.matches? { { foo: 42 } } # => true
+    #
+    # @yieldreturn [#object_id] The actual value to receive the method request.
+    #
+    # @return [Boolean] A boolean returned by the actual value being tested.
+    def matches?
+      value = yield.send(method_name, *@args, **@kwargs, &@block)
+      return value if [false, true].include?(value)
+
+      raise ::TypeError, "Boolean expected, but #{value.class} instance returned."
+    end
+
+    # A string containing a human-readable representation of the matcher.
+    def inspect
+      "#{self.class}(#{@name}, *#{@args.inspect}, **#{@kwargs.inspect}, &#{@block.inspect})"
+    end
+
+    # Returns a string representing the matcher.
+    def to_s
+      (
+        "#{@name.tr('_', ' ')} " + [
+          @args.map(&:inspect).join(", "),
+          @kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(", "),
+          (@block.nil? ? "" : "&block")
+        ].reject { |i| i.eql?("") }.join(", ")
+      ).strip
+    end
+
+    private
+
+    # The name of the method to send to the object.
+    def method_name
+      if @name.start_with?("be_")
+        :"#{@name.gsub("be_", "")}?"
+      else
+        :"#{@name.gsub("have_", "has_")}?"
+      end
+    end
+
+    # Verify the matcher name structure.
+    def valid_name?
+      return false if @name.end_with?("?", "!")
+
+      @name.start_with?("be_", "have_")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ files:
 - lib/matchi/change/to.rb
 - lib/matchi/eq.rb
 - lib/matchi/match.rb
+- lib/matchi/predicate.rb
 - lib/matchi/raise_exception.rb
 - lib/matchi/satisfy.rb
 homepage: https://github.com/fixrb/matchi