matchi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1580f1d31d1d682c906abafebc1ef9b19580940
-  data.tar.gz: 43036c78b950d882b82419bec640b6dc3ffb1953
+  metadata.gz: f5bdd9213799cfeb48e7ecf65f25b19f126c3c12
+  data.tar.gz: 0ac41824d9ba957e356af42d09c19fb87c5269a8
 SHA512:
-  metadata.gz: 5769d1b7cfcaaaf032bfbd72430414ccd77c9feb9f5cab17b3ae6da1bfe097cf17182f6f2f0dae089191ab2695c30a94750a3fd23dd3440bb371332ba67190b9
-  data.tar.gz: a54b61bf4c92e8ec79557864bb72be5cf0e0ccc39eafe65d20300175957ea4ac5ee3fe628ae74de6a5566b5b10e5d8cb892a5fa0ef69e0297915ffac3f711b31
+  metadata.gz: 7f6d64db6e7fdb44b2aeaca890f427420ad1ff4b7f678ea18f57f4d96d97a4a0e8f8c4287ad5562d63e09017de537bc64b09b70c97556f652169097c3732a5a6
+  data.tar.gz: c23052d210261ef309e1d13c785ae5b8adaf92795e82a5fbf435ccc5261f99436f18177ff120ce04b0a4503f303960a606b05eadfaf7c79031d0b7c87dd237dd

data/README.md

@@ -68,6 +68,27 @@ raise_exception = Matchi::RaiseException.new(NameError)
 raise_exception.matches? { Boom } # => true
 ```
 
+**Truth** matcher:
+
+```ruby
+be_true = Matchi::BeTrue.new
+be_true.matches? { true } # => true
+```
+
+**Untruth** matcher:
+
+```ruby
+be_false = Matchi::BeFalse.new
+be_false.matches? { false } # => true
+```
+
+**Nil** matcher:
+
+```ruby
+be_nil = Matchi::BeNil.new
+be_nil.matches? { nil } # => true
+```
+
 ### Custom matchers
 
 Custom matchers can easily be defined for expressing expectations.

data/VERSION.semver

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/matchi.rb

@@ -2,6 +2,9 @@ require_relative File.join 'matchi', 'eql'
 require_relative File.join 'matchi', 'equal'
 require_relative File.join 'matchi', 'match'
 require_relative File.join 'matchi', 'raise_exception'
+require_relative File.join 'matchi', 'be_true'
+require_relative File.join 'matchi', 'be_false'
+require_relative File.join 'matchi', 'be_nil'
 
 # Namespace for the Matchi library.
 #

data/lib/matchi/be_false.rb

@@ -1,6 +1,10 @@
 module Matchi
   # **Untruth** matcher.
   class BeFalse < BasicObject
+    # @example Is it false?
+    #   be_false = Matchi::BeFalse.new
+    #   be_false.matches? { false } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       false.equal?(yield)

data/lib/matchi/be_nil.rb

@@ -1,6 +1,10 @@
 module Matchi
   # **Nil** matcher.
   class BeNil < BasicObject
+    # @example Is it nil?
+    #   be_nil = Matchi::BeNil.new
+    #   be_nil.matches? { nil } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       nil.equal?(yield)

data/lib/matchi/be_true.rb

@@ -1,6 +1,10 @@
 module Matchi
   # **Truth** matcher.
   class BeTrue < BasicObject
+    # @example Is it true?
+    #   be_true = Matchi::BeTrue.new
+    #   be_true.matches? { true } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       true.equal?(yield)

data/lib/matchi/eql.rb

@@ -5,6 +5,10 @@ module Matchi
       @expected = expected
     end
 
+    # @example Is it equivalent to 'foo'?
+    #   eql = Matchi::Eql.new('foo')
+    #   eql.matches? { 'foo' } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       @expected.eql?(yield)

data/lib/matchi/equal.rb

@@ -5,6 +5,10 @@ module Matchi
       @expected = expected
     end
 
+    # @example Is it equal to :foo?
+    #   equal = Matchi::Equal.new(:foo)
+    #   equal.matches? { :foo } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       @expected.equal?(yield)

data/lib/matchi/match.rb

@@ -5,6 +5,10 @@ module Matchi
       @expected = expected
     end
 
+    # @example Is it matching /^foo$/ regex?
+    #   match = Matchi::Match.new(/^foo$/)
+    #   match.matches? { 'foo' } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       @expected.match(yield).nil?.equal?(false)

data/lib/matchi/raise_exception.rb

@@ -5,6 +5,10 @@ module Matchi
       @expected = expected
     end
 
+    # @example Is it raising NameError?
+    #   raise_exception = Matchi::RaiseException.new(NameError)
+    #   raise_exception.matches? { Boom } # => true
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       yield

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cyril Wack