matchi 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 659f29a670790e63d96ab4d838e3978b767e5a07
-  data.tar.gz: 035aaf2bd805b1018ab474e374b3245f267f9c83
+  metadata.gz: 72d138a4f3f6057acdd0aad92c3c72fdc2cd955c
+  data.tar.gz: 6f045b969f91670bc966b2f90b45888a749cbb2a
 SHA512:
-  metadata.gz: ccd2e3cef44f95a92b93c383421dd1d03821ae77c84607880383338ada5fc2fa1cf2c91af084b2a11e5a2c1d5fd2f47aede844cea74a3083233d00e3bb29d16a
-  data.tar.gz: 670b8aaf1192527270fd656132547d2e75127dfed51a3b2dc0d9d7151091e571689643bb4b54d3dd812ec56fd0f5e3f6ec25b7e66e2269a08991faa603ee36c2
+  metadata.gz: 0b676b06bcfdb7f12af040df4dae8bf33c5094b8c9ed26a705e4c6978ebd768c5a1b43aa8a589e208c8fc31ba8dfe79dc078ee598766219bc3e0c5884aff4281
+  data.tar.gz: b125380c5114e9a295cd79b6dec2be4c4f120c023ef2ea70045227caba9bb0da3a4f67b247a3847e24f9e9de6954ccc4e20c695632737b6d2c5aa9a32cf20a31

data/README.md

@@ -32,68 +32,72 @@ To be sure the gem you install hasn't been tampered with, add my public key
 The `HighSecurity` trust profile will verify all gems.  All of __Matchi__'s
 dependencies are signed.
 
-## Usage
-
-### List all matchers
+Or add this line to your application's Gemfile:
 
 ```ruby
-Matchi.constants # => [:BeFalse, :BeNil, :BeTrue, :Eql, :Equal, :Match, :RaiseException]
+gem 'matchi'
 ```
 
+And then execute:
+
+    $ bundle
+
+## Usage
+
 ### Built-in matchers
 
 **Equivalence** matcher:
 
 ```ruby
-eql = Matchi.fetch(:Eql, 'foo')
+eql = Matchi::Eql.new('foo')
 eql.matches? { 'foo' } # => true
 ```
 
 **Identity** matcher:
 
 ```ruby
-equal = Matchi.fetch(:Equal, :foo)
+equal = Matchi::Equal.new(:foo)
 equal.matches? { :foo } # => true
 ```
 
 **Regular expressions** matcher:
 
 ```ruby
-match = Matchi.fetch(:Match, /^foo$/)
+match = Matchi::Match.new(/^foo$/)
 match.matches? { 'foo' } # => true
 ```
 
 **Expecting errors** matcher:
 
 ```ruby
-raise_exception = Matchi.fetch(:RaiseException, NameError)
+raise_exception = Matchi::RaiseException.new(NameError)
 raise_exception.matches? { Boom } # => true
 ```
 
 **Truth** matcher:
 
 ```ruby
-be_true = Matchi.fetch(:BeTrue)
+be_true = Matchi::BeTrue.new
 be_true.matches? { true } # => true
 ```
 
 **Untruth** matcher:
 
 ```ruby
-be_false = Matchi.fetch(:BeFalse)
+be_false = Matchi::BeFalse.new
 be_false.matches? { false } # => true
 ```
 
 **Nil** matcher:
 
 ```ruby
-be_nil = Matchi.fetch(:BeNil)
+be_nil = Matchi::BeNil.new
 be_nil.matches? { nil } # => true
 ```
 
 ### Custom matchers
 
-Custom matchers can easily be defined for expressing expectations.
+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.
 
 **Be the answer** matcher:
 
@@ -103,10 +107,18 @@ module Matchi
     def matches?
       42.equal? yield
     end
+
+    def to_s
+      'be_the_answer'
+    end
+
+    def to_h
+      { BeTheAnswer: [] }
+    end
   end
 end
 
-be_the_answer = Matchi.fetch(:BeTheAnswer)
+be_the_answer = Matchi::BeTheAnswer.new
 be_the_answer.matches? { 42 } # => true
 ```
 
@@ -120,10 +132,18 @@ module Matchi
     def matches?
       Prime.prime? yield
     end
+
+    def to_s
+      'be_prime'
+    end
+
+    def to_h
+      { BePrime: [] }
+    end
   end
 end
 
-be_prime = Matchi.fetch(:BePrime)
+be_prime = Matchi::BePrime.new
 be_prime.matches? { 42 } # => false
 ```
 
@@ -132,17 +152,25 @@ be_prime.matches? { 42 } # => false
 ```ruby
 module Matchi
   class StartWith
-    def initialize expected
+    def initialize(expected)
       @expected = expected
     end
 
     def matches?
       !Regexp.new("^#{@expected}").match(yield).nil?
     end
+
+    def to_s
+      'start_with'
+    end
+
+    def to_h
+      { StartWith: [@expected] }
+    end
   end
 end
 
-start_with = Matchi.fetch(:StartWith, 'foo')
+start_with = Matchi::StartWith.new('foo')
 start_with.matches? { 'foobar' } # => true
 ```
 

data/VERSION.semver

@@ -1 +1 @@
-0.0.9
+0.1.0

data/checksum/matchi-0.0.9.gem.sha512

@@ -1 +1 @@
-2fec09a07ba40a3a78fbf475f84fd8f620d90e3bd4596ca05b828d379302aef5c748543bb585c78b5ee536be68e9b444f92e4b99fc39eed50165ad1b3561da31
+e09fc68126ef7683b72d98b0ac7aa198b451442ecace0b1c2d0843ca53873abee397ba1aa1e42ced97f03f6c1be18221f856b50a089a87878edc70a4ad90bd61

data/lib/matchi.rb

@@ -1,22 +1,7 @@
-Dir[File.join File.dirname(__FILE__), 'matchi', '*.rb'].each do |fname|
-  require_relative fname
-end
-
 # Namespace for the Matchi library.
-#
-# @api public
-#
-# @example Match that 42 is equal to 42
-#   matcher = Matchi.fetch(:Equal, 42)
-#   matcher.matches? { 42 } # => true
 module Matchi
-  # Select a matcher from those available.
-  #
-  # @param matcher_id [Symbol] The name of the constant of the matcher to fetch.
-  # @param args       [Array] Parameters to initialize the class of the matcher.
-  #
-  # @return [#matches?] the matcher
-  def self.fetch(matcher_id, *args)
-    const_get(matcher_id, false).new(*args)
-  end
+end
+
+Dir[File.join File.dirname(__FILE__), 'matchi', '*.rb'].each do |fname|
+  require_relative fname
 end

data/lib/matchi/be_false.rb

@@ -1,6 +1,8 @@
 module Matchi
   # **Untruth** matcher.
-  class BeFalse < BasicObject
+  class BeFalse
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it false?
     #   be_false = Matchi::BeFalse.new
     #   be_false.matches? { false } # => true
@@ -11,5 +13,28 @@ module Matchi
     def matches?
       false.equal?(yield)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      'be_false'
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { BeFalse: [] }
+    end
   end
 end

data/lib/matchi/be_nil.rb

@@ -1,6 +1,8 @@
 module Matchi
   # **Nil** matcher.
   class BeNil < BasicObject
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it nil?
     #   be_nil = Matchi::BeNil.new
     #   be_nil.matches? { nil } # => true
@@ -11,5 +13,28 @@ module Matchi
     def matches?
       nil.equal?(yield)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      'be_nil'
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { BeNil: [] }
+    end
   end
 end

data/lib/matchi/be_true.rb

@@ -1,6 +1,8 @@
 module Matchi
   # **Truth** matcher.
   class BeTrue < BasicObject
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it true?
     #   be_true = Matchi::BeTrue.new
     #   be_true.matches? { true } # => true
@@ -11,5 +13,28 @@ module Matchi
     def matches?
       true.equal?(yield)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      'be_true'
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { BeTrue: [] }
+    end
   end
 end

data/lib/matchi/eql.rb

@@ -3,7 +3,7 @@ module Matchi
   class Eql < BasicObject
     # Initialize the matcher with an object.
     #
-    # @example The string 'foo' matcher
+    # @example The string 'foo' matcher.
     #   Matchi::Eql.new('foo')
     #
     # @param expected [#eql?] An expected equivalent object.
@@ -11,6 +11,8 @@ module Matchi
       @expected = expected
     end
 
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it equivalent to 'foo'?
     #   eql = Matchi::Eql.new('foo')
     #   eql.matches? { 'foo' } # => true
@@ -21,5 +23,28 @@ module Matchi
     def matches?
       @expected.eql?(yield)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      "eql #{@expected.inspect}"
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { Eql: [@expected] }
+    end
   end
 end

data/lib/matchi/equal.rb

@@ -3,7 +3,7 @@ module Matchi
   class Equal < BasicObject
     # Initialize the matcher with an object.
     #
-    # @example The number 42 matcher
+    # @example The number 42 matcher.
     #   Matchi::Equal.new(42)
     #
     # @param expected [#equal?] An expected object.
@@ -11,6 +11,8 @@ module Matchi
       @expected = expected
     end
 
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it equal to :foo?
     #   equal = Matchi::Equal.new(:foo)
     #   equal.matches? { :foo } # => true
@@ -21,5 +23,28 @@ module Matchi
     def matches?
       @expected.equal?(yield)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      "equal #{@expected.inspect}"
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { Equal: [@expected] }
+    end
   end
 end

data/lib/matchi/match.rb

@@ -3,7 +3,7 @@ module Matchi
   class Match < BasicObject
     # Initialize the matcher with an instance of Regexp.
     #
-    # @example Username matcher
+    # @example Username matcher.
     #   Matchi::Match.new(/^[a-z0-9_-]{3,16}$/)
     #
     # @param expected [#match] A regular expression.
@@ -11,6 +11,8 @@ module Matchi
       @expected = expected
     end
 
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it matching /^foo$/ regex?
     #   match = Matchi::Match.new(/^foo$/)
     #   match.matches? { 'foo' } # => true
@@ -21,5 +23,28 @@ module Matchi
     def matches?
       @expected.match(yield).nil?.equal?(false)
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      "match #{@expected.inspect}"
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { Match: [@expected] }
+    end
   end
 end

data/lib/matchi/raise_exception.rb

@@ -3,7 +3,7 @@ module Matchi
   class RaiseException < BasicObject
     # Initialize the matcher with a descendant of class Exception.
     #
-    # @example Divided by 0 matcher
+    # @example Divided by 0 matcher.
     #   Matchi::RaiseException.new(ZeroDivisionError)
     #
     # @param expected [.exception] The class of the expected exception.
@@ -11,6 +11,8 @@ module Matchi
       @expected = expected
     end
 
+    # Boolean comparison between the actual value and the expected value.
+    #
     # @example Is it raising NameError?
     #   raise_exception = Matchi::RaiseException.new(NameError)
     #   raise_exception.matches? { Boom } # => true
@@ -25,5 +27,28 @@ module Matchi
     else
       false
     end
+
+    # Returns a string representing the matcher.
+    #
+    # @example The readable definition of a FooBar matcher.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_s # => "foo_bar 42"
+    #
+    # @return [String] A string representing the matcher.
+    def to_s
+      "raise_exception #{@expected.inspect}"
+    end
+
+    # Returns a hash of one key-value pair with a key corresponding to the
+    #   matcher and a value corresponding to its initialize parameters.
+    #
+    # @example A FooBar matcher serialized into a hash.
+    #   matcher = Matchi::FooBar.new(42)
+    #   matcher.to_h # => { FooBar: 42 }
+    #
+    # @return [Hash] A hash of one key-value pair.
+    def to_h
+      { RaiseException: [@expected] }
+    end
   end
 end

data/matchi.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~> 10.4'
   spec.add_development_dependency 'yard',       '~> 0.8'
   spec.add_development_dependency 'simplecov',  '~> 0.10'
-  spec.add_development_dependency 'rubocop',    '~> 0.32'
+  spec.add_development_dependency 'rubocop',    '~> 0.34'
 
   spec.cert_chain   = ['certs/gem-fixrb-public_cert.pem']
   private_key       = File.expand_path('~/.ssh/gem-fixrb-private_key.pem')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Cyril Wack
@@ -30,7 +30,7 @@ cert_chain:
   dzJvWzQ1+dJU6WQv75E9ddSkaQrK3nhdgQVu+/wgvGSrsMvOGNz+LXaSDxQqZuwX
   0KNQFuIukfrdk8URwRnHoAnvx4U93iUw
   -----END CERTIFICATE-----
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,14 +94,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.34'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.34'
 description: Collection of expectation matchers for Ruby.
 email:
 - contact@cyril.email
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Collection of matchers.