matchi 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9afc0e3e02c4150637f3d1080cf6eacd470ad7dec335417bda0e79ee60ecdea
-  data.tar.gz: d62e283556fc4f9d4a6d93bde1efb518861d482dba734786f00b57a166f4ade6
+  metadata.gz: 5a3c186895362318fd2c0497d3fb4b124b291a582d37ff16d02cb454f9dd52ca
+  data.tar.gz: 2fff123c60074a43feb8b81428d1dd61cb0d9e736e223531499113e794c2a2d0
 SHA512:
-  metadata.gz: 50d45962387971730773221e8756fa543457ebd1375f7205538040d2fb115eb1fae0784c1e9949794e9c990efc7788fda49ce03f8096918005eae384ed460a13
-  data.tar.gz: 12071d2d5462243d42eac25ca3d70fc5a236cd79b8cbdd20a608e4d2ceeacdbdddbaeeba06f30218c30d1cbf0c6f16279be655eead7a42dcf6b9cecdf1c645cf
+  metadata.gz: 95e61bb5d94221542d1b3c95e67d5616f90ffbb08a501edc997ed29bf57795a5ab398f2cb6f7edc59a32c9ed3482738246028e3ae35394c84788268fefc4b049
+  data.tar.gz: bec13c5814a7e007bbff9ae3f47ed3a3b162bc4fe26e5bf941a668fbb9310b7ef9de021dd85fa4fa89d4ef68f1c35bbf7572de0f6bcd799a951c115b6ed6f345

data/README.md

@@ -1,12 +1,14 @@
 # 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.
+> 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
 
@@ -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:
 
@@ -88,7 +114,7 @@ module Matchi
   module Matcher
     class BeTheAnswer < ::Matchi::Matcher::Base
       def matches?
-        42.equal? yield
+        42.equal?(yield)
       end
     end
   end
@@ -107,7 +133,7 @@ module Matchi
   module Matcher
     class BePrime < ::Matchi::Matcher::Base
       def matches?
-        Prime.prime? yield
+        Prime.prime?(yield)
       end
     end
   end
@@ -129,7 +155,7 @@ module Matchi
       end
 
       def matches?
-        !Regexp.new("^#{expected}").match(yield).nil?
+        Regexp.new(/\A#{expected}/).match?(yield)
       end
     end
   end
@@ -139,24 +165,39 @@ 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
 * Bugs/issues: https://github.com/fixrb/matchi/issues
 
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
-
 ## Versioning
 
 __Matchi__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The [gem](https://rubygems.org/gems/matchi) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ***
 
@@ -166,9 +207,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
     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/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,41 @@
+# 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 string matcher
+      #   Matchi::Matcher::BeAnInstanceOf.new(String)
+      #
+      # @param expected [#to_s] The name of a module.
+      def initialize(expected)
+        super()
+        @expected = self.class.const_get String(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?(*, **)
+        expected.equal?(yield.class)
+      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,14 +21,14 @@ 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.
       #
       # @return [Boolean] Comparison between actual and expected values.
       def matches?(*, **)
-        expected.match(yield).nil?.equal?(false)
+        expected.match?(yield)
       end
     end
   end

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.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Collection of expectation matchers for Ruby.
+description: "Collection of expectation matchers for Ruby \U0001F939"
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -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
@@ -160,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Collection of expectation matchers for Ruby.
+summary: "Collection of expectation matchers for Ruby \U0001F939"
 test_files: []