matchi 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511594a89eee8989ff8fda9fb3a2b372a794681788a5835a757f4f754a187626
-  data.tar.gz: 974f20880b56d14b292f4c48873c5464c557236356aa46272b58b27a61aea4b2
+  metadata.gz: 168258c942f6e9390a6bc6ad65112de3acbcd835438a750dd1dc4692e256db6d
+  data.tar.gz: 8b64c5cbdf54f665f1982cb9e8d44a16685904b626680e22cab80969304108be
 SHA512:
-  metadata.gz: 87062a4f55243e204ea9f1eb39c3213d3772e8c5cee2684031c267881b0482b12ef705eeb133b8b3e62bcd328e670c7b55271a8ef31dcb8c72942d7934360d11
-  data.tar.gz: d8dc438ed8523e3ae7b6273ee91e3f91485054195dafc2d466884e6a7a608c03be39e6fc7e7e944dd26223b91fedc8fbabe7695506eb22e167d65ed45b7d5f2a
+  metadata.gz: 40d8993bb7bae28eff3ef0d86d4d8e9dc51f36195466fa3f3016c4f1c52dfccac27e0eb02c18c1f34a4c4f2df16a8ba566c89633e2da7d595ad433ac4e03563f
+  data.tar.gz: d2e8b2cbb554f76cf9a0e25dbbf41e591d962ed3e1af7c64d5de84d823e86fc317e3d76e174d4f559f526022aa6afcf1e1411200b4789821d7ffc8917b7e4e3d

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 Cyril Kato
+Copyright (c) 2015-2021 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,49 +1,56 @@
 # Matchi
 
-[![Build Status](https://api.travis-ci.org/fixrb/matchi.svg?branch=master)][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=master)][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 🤹
 
-## 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/)
+![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:
 
 ```ruby
-gem 'matchi'
+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:
 
 ```ruby
-eql = Matchi::Matcher::Eql.new('foo')
-eql.matches? { 'foo' } # => true
+eql = Matchi::Matcher::Eql.new("foo")
+eql.matches? { "foo" } # => true
 ```
 
 **Identity** matcher:
@@ -57,7 +64,7 @@ equal.matches? { :foo } # => true
 
 ```ruby
 match = Matchi::Matcher::Match.new(/^foo$/)
-match.matches? { 'foo' } # => true
+match.matches? { "foo" } # => true
 ```
 
 **Expecting errors** matcher:
@@ -88,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:
 
@@ -99,7 +114,7 @@ module Matchi
   module Matcher
     class BeTheAnswer < ::Matchi::Matcher::Base
       def matches?
-        42.equal? yield
+        42.equal?(yield)
       end
     end
   end
@@ -112,13 +127,13 @@ be_the_answer.matches? { 42 } # => true
 A **Be prime** matcher:
 
 ```ruby
-require 'prime'
+require "prime"
 
 module Matchi
   module Matcher
     class BePrime < ::Matchi::Matcher::Base
       def matches?
-        Prime.prime? yield
+        Prime.prime?(yield)
       end
     end
   end
@@ -135,60 +150,60 @@ module Matchi
   module Matcher
     class StartWith < ::Matchi::Matcher::Base
       def initialize(expected)
+        super()
         @expected = expected
       end
 
       def matches?
-        !Regexp.new("^#{expected}").match(yield).nil?
+        Regexp.new(/\A#{expected}/).match?(yield)
       end
     end
   end
 end
 
-start_with = Matchi::Matcher::StartWith.new('foo')
-start_with.matches? { 'foobar' } # => true
+start_with = Matchi::Matcher::StartWith.new("foo")
+start_with.matches? { "foobar" } # => true
 ```
 
-## Security
+### Helper methods
 
-As a basic form of security __Matchi__ provides a set of SHA512 checksums for
-every Gem release.  These checksums can be found in the `checksum/` directory.
-Although these checksums do not prevent malicious users from tampering with a
-built Gem they can be used for basic integrity verification purposes.
+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:
 
-The checksum of a file can be checked using the `sha512sum` command.  For
-example:
+```ruby
+require "matchi/helper"
 
-    $ sha512sum pkg/matchi-0.0.1.gem
-    548d9f669ded4e622182791a5390aaceae0bf2e557b0864f05a842b0be2c65e10e1fb8499f49a3b9efd0e8eaeb691351b1c670d6316ce49965a99683b1071389  pkg/matchi-0.0.1.gem
+class MatcherCollection
+  include ::Matchi::Helper
+end
+```
 
-## Versioning
+The set of loaded matcher then becomes accessible via a dynamically generated instance method, like these:
 
-__Matchi__ follows [Semantic Versioning 2.0](https://semver.org/).
+```ruby
+matcher = MatcherCollection.new
+matcher.equal(42).matches? { 44 } # => false
+matcher.be_an_instance_of(String).matches? { "안녕하세요" } # => true
+```
 
-## Contributing
+## Contact
 
-1. [Fork it](https://github.com/fixrb/matchi/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+* Home page: https://github.com/fixrb/matchi
+* Bugs/issues: https://github.com/fixrb/matchi/issues
 
-## License
+## Versioning
+
+__Matchi__ follows [Semantic Versioning 2.0](https://semver.org/).
 
-See `LICENSE.md` file.
+## License
 
-[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
+The [gem](https://rubygems.org/gems/matchi) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ***
 
 <p>
   This project is sponsored by:<br />
   <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/matchi/raw/master/img/sashite.png"
+    src="https://github.com/fixrb/matchi/raw/main/img/sashite.png"
     alt="Sashite" /></a>
 </p>

data/lib/matchi.rb

@@ -4,4 +4,4 @@
 module Matchi
 end
 
-require_relative File.join('matchi', 'matcher')
+require_relative File.join("matchi", "matcher")

data/lib/matchi/helper.rb

@@ -1,25 +1,37 @@
 # frozen_string_literal: true
 
-require_relative 'matcher'
+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.rb

@@ -6,6 +6,6 @@ module Matchi
   end
 end
 
-Dir[File.join(File.dirname(__FILE__), 'matcher', '*.rb')].each do |fname|
+Dir[File.join(File.dirname(__FILE__), "matcher", "*.rb")].each do |fname|
   require_relative fname
 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.gsub(/\AMatchi::Matcher::/, '')
+        name.split("::")
+            .fetch(-1)
             .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .downcase
@@ -16,15 +23,12 @@ module Matchi
       # @return [#object_id] Any value to give to the matcher.
       attr_reader :expected
 
-      # Initialize the matcher with the nil expected value by default.
-      #
-      # @param expected [#object_id] Any object.  It is `nil` unless present.
-      def initialize(expected = nil)
-        @expected = expected
-      end
-
       # 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})"
@@ -32,20 +36,27 @@ 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.'
+        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(' ')
+        [self.class.to_sym, expected&.inspect].compact.join(" ")
       end
     end
   end

data/lib/matchi/matcher/be_an_instance_of.rb

@@ -0,0 +1,35 @@
+# 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 [Class] An expected class.
+      def initialize(expected)
+        super()
+        @expected = 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
+      #
+      # @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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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)
+        super()
         @expected = expected
       end
 
       # 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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+require_relative "base"
 
 module Matchi
   module Matcher
-    # **Identity** matcher.
+    # *Identity* matcher.
     class Equal < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #
@@ -13,6 +13,7 @@ module Matchi
       #
       # @param expected [#equal?] An expected object.
       def initialize(expected)
+        super()
         @expected = expected
       end
 

data/lib/matchi/matcher/match.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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.
       #
@@ -13,6 +13,7 @@ module Matchi
       #
       # @param expected [#match] A regular expression.
       def initialize(expected)
+        super()
         @expected = expected
       end
 
@@ -20,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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'base'
+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.
       #
@@ -13,6 +13,7 @@ module Matchi
       #
       # @param expected [Exception] The class of the expected exception.
       def initialize(expected)
+        super()
         @expected = expected
       end
 

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,35 +66,63 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-description: Collection of expectation matchers for Ruby.
+        version: '0'
+description: "Collection of expectation matchers for Ruby \U0001F939"
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -106,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
@@ -125,15 +154,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Collection of matchers.
+summary: "Collection of expectation matchers for Ruby \U0001F939"
 test_files: []