matchi 2.1.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 168258c942f6e9390a6bc6ad65112de3acbcd835438a750dd1dc4692e256db6d
-  data.tar.gz: 8b64c5cbdf54f665f1982cb9e8d44a16685904b626680e22cab80969304108be
+  metadata.gz: d0160e87dd2bb35e34120f11d16c0ebb5a5d4b4c984612e37a8139cb65814ed6
+  data.tar.gz: 10ce199e0511fda23304b1f8b64bf1c7911512e77c2af6b2d90ad078d56caed0
 SHA512:
-  metadata.gz: 40d8993bb7bae28eff3ef0d86d4d8e9dc51f36195466fa3f3016c4f1c52dfccac27e0eb02c18c1f34a4c4f2df16a8ba566c89633e2da7d595ad433ac4e03563f
-  data.tar.gz: d2e8b2cbb554f76cf9a0e25dbbf41e591d962ed3e1af7c64d5de84d823e86fc317e3d76e174d4f559f526022aa6afcf1e1411200b4789821d7ffc8917b7e4e3d
+  metadata.gz: 5bb3da470e32e8332b4fb4106ebec65d06f23c92f9fdc18ce6de655b0fdc3408142210aebfcfe45d30e79ce0b3856488658f3c107c5dab7164125561e2a44bd0
+  data.tar.gz: 55dce8aca5a1b3aeacb396da47e41e008bde7c189b9acc389a39ba03beb9a3eb883732b5dfaf476158662d1c396fd7a454f0b0a10cd8ed87489b88440771158c

data/README.md

@@ -98,10 +98,17 @@ be_nil.matches? { nil } # => true
 **Type/class** matcher:
 
 ```ruby
-be_an_instance_of = Matchi::Matcher::BeAnInstanceOf.new(String)
+be_an_instance_of = Matchi::Matcher::BeAnInstanceOf.new(:String)
 be_an_instance_of.matches? { "foo" } # => true
 ```
 
+**Satisfy** matcher:
+
+```ruby
+satisfy = Matchi::Matcher::Satisfy.new { |value| value == 42 }
+satisfy.matches? { 42 } # => true
+```
+
 ### Custom matchers
 
 Custom matchers can easily be defined for expressing expectations.
@@ -183,7 +190,7 @@ The set of loaded matcher then becomes accessible via a dynamically generated in
 ```ruby
 matcher = MatcherCollection.new
 matcher.equal(42).matches? { 44 } # => false
-matcher.be_an_instance_of(String).matches? { "안녕하세요" } # => true
+matcher.be_an_instance_of(:String).matches? { "안녕하세요" } # => true
 ```
 
 ## Contact

data/lib/matchi.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 # Namespace for the Matchi library.
+#
+# @api public
 module Matchi
 end
 

data/lib/matchi/helper.rb

@@ -32,8 +32,8 @@ module Matchi
 
       matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
 
-      define_method(matcher_klass.to_sym) do |*args|
-        matcher_klass.new(*args)
+      define_method(matcher_klass.to_sym) do |*args, **kwargs, &block|
+        matcher_klass.new(*args, **kwargs, &block)
       end
     end
   end

data/lib/matchi/matcher/be_an_instance_of.rb

@@ -8,13 +8,18 @@ module Matchi
     class BeAnInstanceOf < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #
-      # @example A string matcher
-      #   Matchi::Matcher::BeAnInstanceOf.new(String)
+      # @example A duck matcher
+      #   Matchi::Matcher::BeAnInstanceOf.new(:Duck)
       #
-      # @param expected [Class] An expected class.
+      # @param expected [#to_s] The name of a module.
       def initialize(expected)
         super()
-        @expected = expected
+        @expected = String(expected).to_sym
+      end
+
+      # (see Base#inspect)
+      def inspect
+        "#{self.class}(#{expected})"
       end
 
       # Boolean comparison between the class of the actual value and the
@@ -24,11 +29,22 @@ module Matchi
       #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new(String)
       #   be_an_instance_of.matches? { "foo" } # => true
       #
+      #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new(:String)
+      #   be_an_instance_of.matches? { "foo" } # => true
+      #
+      #   be_an_instance_of = Matchi::Matcher::BeInstanceOf.new("String")
+      #   be_an_instance_of.matches? { "foo" } # => true
+      #
       # @yieldreturn [#class] the actual value to compare to the expected one.
       #
       # @return [Boolean] Comparison between actual and expected values.
       def matches?(*, **)
-        expected.equal?(yield.class)
+        self.class.const_get(expected).equal?(yield.class)
+      end
+
+      # (see Base#to_s)
+      def to_s
+        "#{self.class.to_sym} #{expected}"
       end
     end
   end

data/lib/matchi/matcher/satisfy.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # *Satisfy* matcher.
+    class Satisfy < ::Matchi::Matcher::Base
+      # Initialize the matcher with a block.
+      #
+      # @example The number 42 matcher.
+      #   Matchi::Matcher::Satisfy.new { |value| value == 42 }
+      #
+      # @param block [Proc] A block of code.
+      def initialize(&block)
+        super()
+        @expected = block
+      end
+
+      # (see Base#inspect)
+      def inspect
+        "#{self.class}(&block)"
+      end
+
+      # Boolean comparison between the actual value and the expected value.
+      #
+      # @example Is it equal to 42
+      #   equal = Matchi::Matcher::Satisfy.new { |value| value == 42 }
+      #   equal.matches? { 42 } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?(*, **)
+        expected.call(yield)
+      end
+
+      # (see Base#to_s)
+      def to_s
+        "#{self.class.to_sym} &block"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,7 @@ files:
 - lib/matchi/matcher/equal.rb
 - lib/matchi/matcher/match.rb
 - lib/matchi/matcher/raise_exception.rb
+- lib/matchi/matcher/satisfy.rb
 homepage: https://github.com/fixrb/matchi
 licenses:
 - MIT