matchi 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd646c1f880291334b1f98426cfdedab736a2f87bbb44e149e81bcb5f8affce
-  data.tar.gz: 9e285052b96848df8be1c22c2033032d2dcbe143ac4d84fa26e9e61b42ac8ee4
+  metadata.gz: c15a21ea2bcdc3ea9c43344bb1ff12216a384bc3d19a996c39a1138c28d18150
+  data.tar.gz: d023d2472ced57399fd14aea2a35cd36b75f7a9ac3705efd48985ccc03a6b9df
 SHA512:
-  metadata.gz: d81a615fca3627cf424226c015e63ab09419be15059b83e926afa3d99819153ced25afca5adfe1421d85bbffcaf4048f2c36531b14b6a9f4920a1f7edf9efd61
-  data.tar.gz: e80cd7a69eef70a3ca0fc80bb4bf94468c14de22a9309d4bf736ea050e5feeeadf69216eadddc6e4ee678c08ccf64949729a3ef830ed9e1b4b3ca3d5ba23d0f7
+  metadata.gz: be27946a8a1aa3d24b978603be5efc2ce29eea9a18455dba435276329388fd1448c8e0f770b649ca34ad0cfce711a4b34939d665254741406f4bfa7602342475
+  data.tar.gz: dcdf2ece3a08c3dd266a9f01ebcb76013f3ab6e699b2bb8205656f7e3cd3ba76f786921c68516efc940404e72862a0bd5df9a021bb8c0c0b80720048e2738cc8

data/README.md

@@ -3,7 +3,6 @@
 [![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]
 
 > Collection of expectation matchers for Ruby 🤹
@@ -18,11 +17,15 @@ gem "matchi"
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install matchi
+```sh
+gem install matchi
+```
 
 ## Usage
 
@@ -77,6 +80,13 @@ 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.
@@ -164,5 +174,4 @@ The [gem](https://rubygems.org/gems/matchi) is available as open source under th
 [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/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

@@ -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,7 +4,7 @@ require_relative "base"
 
 module Matchi
   module Matcher
-    # **Equivalence** matcher.
+    # *Equivalence* matcher.
     class Eql < ::Matchi::Matcher::Base
       # Initialize the matcher with an object.
       #

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.
       #

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.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-06-16 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