matchi 2.0.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd646c1f880291334b1f98426cfdedab736a2f87bbb44e149e81bcb5f8affce
-  data.tar.gz: 9e285052b96848df8be1c22c2033032d2dcbe143ac4d84fa26e9e61b42ac8ee4
+  metadata.gz: 43879fd564f4fe9dfab4116b3e59e452edd5e700dd4cd0f71164965214a17f47
+  data.tar.gz: c4f2eda14d387063449b71e42ea80af8a61888a676b986106c40062735c19342
 SHA512:
-  metadata.gz: d81a615fca3627cf424226c015e63ab09419be15059b83e926afa3d99819153ced25afca5adfe1421d85bbffcaf4048f2c36531b14b6a9f4920a1f7edf9efd61
-  data.tar.gz: e80cd7a69eef70a3ca0fc80bb4bf94468c14de22a9309d4bf736ea050e5feeeadf69216eadddc6e4ee678c08ccf64949729a3ef830ed9e1b4b3ca3d5ba23d0f7
+  metadata.gz: fd575e3e83c363e04d34ea37ed2f66cb5d7a84dfb63c4b18752347ad105bea9074a0c1489a598a9904295d06e5bf051d5126a0d785231ca9df2762f188db7c1d
+  data.tar.gz: b9e90e939b96c10c27796d58577e2c8db4269233e689bb17e1845526da2c5e83668b1608a478ffdec4321d7852750eec9f21b92bd5f4932d6190a85caa11c491

data/README.md

@@ -1,13 +1,15 @@
 # Matchi
 
-[![Build Status](https://api.travis-ci.org/fixrb/matchi.svg?branch=main)][travis]
-[![Code Climate](https://codeclimate.com/github/fixrb/matchi/badges/gpa.svg)][codeclimate]
-[![Gem Version](https://badge.fury.io/rb/matchi.svg)][gem]
-[![Inline docs](https://inch-ci.org/github/fixrb/matchi.svg?branch=main)][inchpages]
-[![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![Version](https://img.shields.io/github/v/tag/fixrb/matchi?label=Version&logo=github)](https://github.com/fixrb/matchi/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/matchi/main)
+[![CI](https://github.com/fixrb/matchi/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/matchi/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/fixrb/matchi/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/matchi/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/fixrb/matchi?label=License&logo=github)](https://github.com/fixrb/matchi/raw/main/LICENSE.md)
 
 > Collection of expectation matchers for Ruby 🤹
 
+![A rubyist juggling between colored balls representing expectation matchers](https://github.com/fixrb/matchi/raw/main/img/matchi.jpg)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,14 +20,30 @@ gem "matchi"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install matchi
+```sh
+gem install matchi
+```
+
+## Overview
+
+__Matchi__ provides a collection of damn simple expectation matchers.
 
 ## Usage
 
+To make __Matchi__ available:
+
+```ruby
+require "matchi"
+```
+
+All examples here assume that this has been done.
+
 ### Built-in matchers
 
 **Equivalence** matcher:
@@ -77,9 +95,17 @@ be_nil = Matchi::Matcher::BeNil.new
 be_nil.matches? { nil } # => true
 ```
 
+**Type/class** matcher:
+
+```ruby
+be_an_instance_of = Matchi::Matcher::BeAnInstanceOf.new(:String)
+be_an_instance_of.matches? { "foo" } # => true
+```
+
 ### Custom matchers
 
-Custom matchers can easily be defined for expressing expectations.  They can be any Ruby class that responds to `matches?`, `to_s` and `to_h` instance methods.
+Custom matchers can easily be defined for expressing expectations.
+They can be any Ruby class that responds to `matches?` instance method with a block.
 
 A **Be the answer** matcher:
 
@@ -139,6 +165,27 @@ start_with = Matchi::Matcher::StartWith.new("foo")
 start_with.matches? { "foobar" } # => true
 ```
 
+### Helper methods
+
+For convenience, it is possible to instantiate a matcher with a method rather than with its class.
+To do so, the `Helper` module can be included like this:
+
+```ruby
+require "matchi/helper"
+
+class MatcherCollection
+  include ::Matchi::Helper
+end
+```
+
+The set of loaded matcher then becomes accessible via a dynamically generated instance method, like these:
+
+```ruby
+matcher = MatcherCollection.new
+matcher.equal(42).matches? { 44 } # => false
+matcher.be_an_instance_of(:String).matches? { "안녕하세요" } # => true
+```
+
 ## Contact
 
 * Home page: https://github.com/fixrb/matchi
@@ -160,9 +207,3 @@ The [gem](https://rubygems.org/gems/matchi) is available as open source under th
     src="https://github.com/fixrb/matchi/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>
-
-[gem]: https://rubygems.org/gems/matchi
-[travis]: https://travis-ci.org/fixrb/matchi
-[codeclimate]: https://codeclimate.com/github/fixrb/matchi
-[inchpages]: https://inch-ci.org/github/fixrb/matchi
-[rubydoc]: https://rubydoc.info/gems/matchi/frames

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

@@ -3,23 +3,35 @@
 require_relative "matcher"
 
 module Matchi
-  # Collection of helper methods.
+  # When included, this module defines a helper instance method per matcher.
+  #
+  # @example Define and use the dynamic helper instance method of a custom matcher
+  #   require "matchi/matcher/base"
+  #
+  #   module Matchi
+  #     module Matcher
+  #       class BeTheAnswer < ::Matchi::Matcher::Base
+  #         def matches?
+  #           42.equal?(yield)
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  #   require "matchi/helper"
+  #
+  #   class MatcherBase
+  #     include ::Matchi::Helper
+  #   end
+  #
+  #   matcher_base = MatcherBase.new
+  #   matcher_base.be_the_answer.matches? { 42 } # => true
   module Helper
     ::Matchi::Matcher.constants.each do |matcher_const|
       next if matcher_const.equal?(:Base)
 
       matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
 
-      # Define a method for the given matcher.
-      #
-      # @example Given the `Matchi::Matchers::Equal::Matcher` matcher, its
-      #   method would be:
-      #
-      #   def equal(expected)
-      #     Matchi::Matchers::Equal::Matcher.new(expected)
-      #   end
-      #
-      # @return [#matches?] The matcher.
       define_method(matcher_klass.to_sym) do |*args|
         matcher_klass.new(*args)
       end

data/lib/matchi/matcher/base.rb

@@ -4,9 +4,16 @@ module Matchi
   module Matcher
     # Abstract matcher class.
     class Base
+      # Returns a symbol identifying the matcher.
+      #
+      # @example The readable definition of a FooBar matcher class.
+      #   matcher_class = Matchi::Matcher::FooBar
+      #   matcher_class.to_sym # => "foo_bar"
+      #
       # @return [Symbol] A symbol identifying the matcher.
       def self.to_sym
-        name.delete_prefix("Matchi::Matcher::")
+        name.split("::")
+            .fetch(-1)
             .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .downcase
@@ -18,6 +25,10 @@ module Matchi
 
       # A string containing a human-readable representation of the matcher.
       #
+      # @example The human-readable representation of a FooBar matcher instance.
+      #   matcher = Matchi::Matcher::FooBar.new(42)
+      #   matcher.inspect # => "Matchi::Matcher::FooBar(42)"
+      #
       # @return [String] The human-readable representation of the matcher.
       def inspect
         "#{self.class}(#{expected&.inspect})"
@@ -25,18 +36,25 @@ module Matchi
 
       # Abstract matcher class.
       #
-      # @raise [NotImplementedError] Override me inside a matcher.
+      # @example Test the equivalence between two "foo" strings.
+      #   eql = Matchi::Matcher::Eql.new("foo")
+      #   eql.matches? { "foo" } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @raise [NotImplementedError] Override this method inside a matcher.
       def matches?
         raise ::NotImplementedError, "matcher MUST respond to this method."
       end
 
-      # Returns a string representing the matcher.
+      # Returns a string representing the matcher instance.
       #
-      # @example The readable definition of a FooBar matcher.
+      # @example The readable definition of a FooBar matcher instance.
       #   matcher = Matchi::Matcher::FooBar.new(42)
       #   matcher.to_s # => "foo_bar 42"
       #
-      # @return [String] A string representing the matcher.
+      # @return [String] A string representing the matcher instance.
       def to_s
         [self.class.to_sym, expected&.inspect].compact.join(" ")
       end

data/lib/matchi/matcher/be_an_instance_of.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # *Type/class* matcher.
+    class BeAnInstanceOf < ::Matchi::Matcher::Base
+      # Initialize the matcher with an object.
+      #
+      # @example A duck matcher
+      #   Matchi::Matcher::BeAnInstanceOf.new(:Duck)
+      #
+      # @param expected [#to_s] The name of a module.
+      def initialize(expected)
+        super()
+        @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
+      # expected class.
+      #
+      # @example Is it an instance of string?
+      #   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?(*, **)
+        self.class.const_get(expected).equal?(yield.class)
+      end
+
+      # (see Base#to_s)
+      def to_s
+        "#{self.class.to_sym} #{expected}"
+      end
+    end
+  end
+end

data/lib/matchi/matcher/be_false.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Untruth** matcher.
+    # *Untruth* matcher.
     class BeFalse < ::Matchi::Matcher::Base
       # Boolean comparison between the actual value and the expected value.
       #

data/lib/matchi/matcher/be_nil.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Nil** matcher.
+    # *Nil* matcher.
     class BeNil < ::Matchi::Matcher::Base
       # Boolean comparison between the actual value and the expected value.
       #

data/lib/matchi/matcher/be_true.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Truth** matcher.
+    # *Truth* matcher.
     class BeTrue < ::Matchi::Matcher::Base
       # Boolean comparison between the actual value and the expected value.
       #

data/lib/matchi/matcher/eql.rb

@@ -4,12 +4,12 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Equivalence** matcher.
+    # *Equivalence* matcher.
     class Eql < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #
-      # @example The string 'foo' matcher.
-      #   Matchi::Matcher::Eql.new('foo')
+      # @example The string "foo" matcher.
+      #   Matchi::Matcher::Eql.new("foo")
       #
       # @param expected [#eql?] An expected equivalent object.
       def initialize(expected)
@@ -19,9 +19,9 @@ module Matchi
 
       # Boolean comparison between the actual value and the expected value.
       #
-      # @example Is it equivalent to 'foo'?
-      #   eql = Matchi::Matcher::Eql.new('foo')
-      #   eql.matches? { 'foo' } # => true
+      # @example Is it equivalent to "foo"?
+      #   eql = Matchi::Matcher::Eql.new("foo")
+      #   eql.matches? { "foo" } # => true
       #
       # @yieldreturn [#object_id] The actual value to compare to the expected
       #   one.

data/lib/matchi/matcher/equal.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Identity** matcher.
+    # *Identity* matcher.
     class Equal < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #

data/lib/matchi/matcher/match.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Regular expressions** matcher.
+    # *Regular expressions* matcher.
     class Match < ::Matchi::Matcher::Base
       # Initialize the matcher with an instance of Regexp.
       #
@@ -21,7 +21,7 @@ module Matchi
       #
       # @example Is it matching /^foo$/ regex?
       #   match = Matchi::Matcher::Match.new(/^foo$/)
-      #   match.matches? { 'foo' } # => true
+      #   match.matches? { "foo" } # => true
       #
       # @yieldreturn [#object_id] The actual value to compare to the expected
       #   one.

data/lib/matchi/matcher/raise_exception.rb

@@ -4,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Expecting errors** matcher.
+    # *Expecting errors* matcher.
     class RaiseException < ::Matchi::Matcher::Base
       # Initialize the matcher with a descendant of class Exception.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - lib/matchi/helper.rb
 - lib/matchi/matcher.rb
 - lib/matchi/matcher/base.rb
+- lib/matchi/matcher/be_an_instance_of.rb
 - lib/matchi/matcher/be_false.rb
 - lib/matchi/matcher/be_nil.rb
 - lib/matchi/matcher/be_true.rb