matchi 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2112c16da9d008dbe0c5ff3b62756b0fdebd2b4
-  data.tar.gz: 91fcdf7bac95139ea1c5ae149c54e12902c85fe5
+  metadata.gz: 5226fc19f2e63316899fb88819e4a2b676706067
+  data.tar.gz: e384838e1758ff5ea04813a13c860fdbabcbd6e8
 SHA512:
-  metadata.gz: 492a24a9cf62fd1ddbcd50dfec9e9ec304c75dc0aee3eec40324a890b42491b9c0448aa07c2287c9fbcb4685be6b05bd24d0305ae15b68f5030d0d243ead6ee9
-  data.tar.gz: a46f7f36dc216905c76048d03cdd2a01ac1151fd26ee592e62b691ab3c07c2c55a6cac86304975588f00f6d6c6d7b15f613f62a6d1c86b6a409199aa8d9bf6be
+  metadata.gz: 0f768ac33f6d8cd00f7bcca104463f7ea377a4291300971d96b79bb1e1fb40421c267aa497c07dd74d98cbc5ccb144a8f6a4dca76f7f587549411434e30af329
+  data.tar.gz: 912d5c53cc20d09270bdd928d67251e744983ce4d69c2b88eff996b1d179c622fd2be84344a688c0a9e6e6434479a1b92fb108e1e12cf3214516507447d77294

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.ruby-version
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/README.md

@@ -38,7 +38,7 @@ Or install it yourself as:
 
 ## Usage
 
-List all available matchers:
+### List all matchers
 
 ```ruby
 Matchi.constants # => [:BeFalse, :BeNil, :BeTrue, :Eql, :Equal, :Match, :RaiseException]
@@ -161,3 +161,7 @@ __Matchi__ follows [Semantic Versioning 2.0](http://semver.org/).
 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
+
+## License
+
+See `LICENSE.md` file.

data/Rakefile

@@ -2,7 +2,6 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = File.join 'test', '**', 'test_*.rb'
   t.verbose = true
   t.warning = true
 end

data/VERSION.semver

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/matchi.rb

@@ -12,8 +12,8 @@ end
 module Matchi
   # Select a matcher from those available.
   #
-  # @param [Symbol] matcher_id the name of the constant of the matcher to fetch
-  # @param [Array] args parameters to initialize the class of the matcher
+  # @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)

data/lib/matchi/be_false.rb

@@ -5,6 +5,8 @@ module Matchi
     #   be_false = Matchi::BeFalse.new
     #   be_false.matches? { false } # => true
     #
+    # @yieldreturn [#object_id] the actual value to compare to the expected one.
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       false.equal?(yield)

data/lib/matchi/be_nil.rb

@@ -5,6 +5,8 @@ module Matchi
     #   be_nil = Matchi::BeNil.new
     #   be_nil.matches? { nil } # => true
     #
+    # @yieldreturn [#object_id] the actual value to compare to the expected one.
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       nil.equal?(yield)

data/lib/matchi/be_true.rb

@@ -5,6 +5,8 @@ module Matchi
     #   be_true = Matchi::BeTrue.new
     #   be_true.matches? { true } # => true
     #
+    # @yieldreturn [#object_id] the actual value to compare to the expected one.
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       true.equal?(yield)

data/lib/matchi/eql.rb

@@ -6,7 +6,7 @@ module Matchi
     # @example The string 'foo' matcher
     #   Matchi::Eql.new('foo')
     #
-    # @param [#eql?] expected an expected equivalent object
+    # @param expected [#eql?] An expected equivalent object.
     def initialize(expected)
       @expected = expected
     end
@@ -15,6 +15,8 @@ module Matchi
     #   eql = Matchi::Eql.new('foo')
     #   eql.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.eql?(yield)

data/lib/matchi/equal.rb

@@ -6,7 +6,7 @@ module Matchi
     # @example The number 42 matcher
     #   Matchi::Equal.new(42)
     #
-    # @param [#equal?] expected an expected object
+    # @param expected [#equal?] An expected object.
     def initialize(expected)
       @expected = expected
     end
@@ -15,6 +15,8 @@ module Matchi
     #   equal = Matchi::Equal.new(:foo)
     #   equal.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.equal?(yield)

data/lib/matchi/match.rb

@@ -6,7 +6,7 @@ module Matchi
     # @example Username matcher
     #   Matchi::Match.new(/^[a-z0-9_-]{3,16}$/)
     #
-    # @param [#match] expected a regular expression
+    # @param expected [#match] A regular expression.
     def initialize(expected)
       @expected = expected
     end
@@ -15,6 +15,8 @@ module Matchi
     #   match = Matchi::Match.new(/^foo$/)
     #   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)

data/lib/matchi/raise_exception.rb

@@ -6,7 +6,7 @@ module Matchi
     # @example Divided by 0 matcher
     #   Matchi::RaiseException.new(ZeroDivisionError)
     #
-    # @param [.exception] expected the class of the expected exception
+    # @param expected [.exception] The class of the expected exception.
     def initialize(expected)
       @expected = expected
     end
@@ -15,6 +15,8 @@ module Matchi
     #   raise_exception = Matchi::RaiseException.new(NameError)
     #   raise_exception.matches? { Boom } # => true
     #
+    # @yieldreturn [#object_id] the actual value to compare to the expected one.
+    #
     # @return [Boolean] Comparison between actual and expected values.
     def matches?
       yield

data/matchi.gemspec

@@ -9,13 +9,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/fixrb/matchi'
   spec.license       = 'MIT'
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(/^test\//) }
-  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(/%r{^test}/) }
+  spec.executables   = spec.files.grep(/%r{^exe}/) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',    '~> 1.8'
-  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'bundler',    '~> 1.9'
+  spec.add_development_dependency 'rake',       '~> 10.4'
   spec.add_development_dependency 'yard',       '~> 0.8'
-  spec.add_development_dependency 'simplecov',  '~> 0.9.1'
-  spec.add_development_dependency 'rubocop',    '~> 0.29'
+  spec.add_development_dependency 'simplecov',  '~> 0.10'
+  spec.add_development_dependency 'rubocop',    '~> 0.31'
 end

data/test/support/coverage.rb

@@ -0,0 +1,3 @@
+require 'simplecov'
+
+SimpleCov.start

data/test/test_be_false.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:BeFalse).matches? { false }
+
+# It is expected to be false
+fail if Matchi.fetch(:BeFalse).matches? { 'foo' }

data/test/test_be_nil.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:BeNil).matches? { nil }
+
+# It is expected to be false
+fail if Matchi.fetch(:BeNil).matches? { 'foo' }

data/test/test_be_the_answer.rb

@@ -0,0 +1,25 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+module Matchi
+  # **Answer to the Ultimate Question of Life, The Universe, and Everything**
+  # matcher.
+  class BeTheAnswer
+    # @example Is it 42?
+    #   be_the_answer = Matchi::BeTheAnswer.new
+    #   be_the_answer.matches? { 42 } # => true
+    #
+    # @yieldreturn [#object_id] the actual value to compare to the expected one.
+    #
+    # @return [Boolean] Comparison between actual and expected values.
+    def matches?
+      42.equal? yield
+    end
+  end
+end
+
+# It is expected to be true
+fail unless Matchi.fetch(:BeTheAnswer).matches? { 42 }
+
+# It is expected to be false
+fail if Matchi.fetch(:BeTheAnswer).matches? { 4 }

data/test/test_be_true.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:BeTrue).matches? { true }
+
+# It is expected to be false
+fail if Matchi.fetch(:BeTrue).matches? { 'foo' }

data/test/test_constants.rb

@@ -0,0 +1,11 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+module Matchi
+  class Foo; end
+end
+
+fail unless Matchi.constants.to_set.superset? [
+  :BeFalse, :BeNil, :BeTrue, :Eql, :Equal, :Match, :RaiseException
+].to_set

data/test/test_eql.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:Eql, 'foo').matches? { 'foo' }
+
+# It is expected to be false
+fail if Matchi.fetch(:Eql, 'foo').matches? { 'bar' }

data/test/test_equal.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:Equal, :foo).matches? { :foo }
+
+# It is expected to be false
+fail if Matchi.fetch(:Equal, :foo).matches? { :bar }

data/test/test_match.rb

@@ -0,0 +1,8 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:Match, /^foo/).matches? { 'foobar' }
+
+# It is expected to be false
+fail if Matchi.fetch(:Match, /^foo/).matches? { 'bar' }

data/test/test_raise_exception.rb

@@ -0,0 +1,15 @@
+require_relative File.join 'support', 'coverage'
+require_relative File.join '..', 'lib', 'matchi'
+
+# It is expected to be true
+fail unless Matchi.fetch(:RaiseException, ZeroDivisionError).matches? { 0 / 0 }
+
+# It is expected to be false
+fail if Matchi.fetch(:RaiseException, ZeroDivisionError).matches? { 'bar' }
+
+# It is expected to raise
+begin
+  Matchi.fetch(:RaiseException, ZeroDivisionError).matches? { BOOM }
+rescue NameError
+  true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matchi
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Cyril Wack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '0.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '0.31'
 description: Collection of expectation matchers for Ruby.
 email:
 - contact@cyril.email
@@ -107,6 +107,16 @@ files:
 - lib/matchi/match.rb
 - lib/matchi/raise_exception.rb
 - matchi.gemspec
+- test/support/coverage.rb
+- test/test_be_false.rb
+- test/test_be_nil.rb
+- test/test_be_the_answer.rb
+- test/test_be_true.rb
+- test/test_constants.rb
+- test/test_eql.rb
+- test/test_equal.rb
+- test/test_match.rb
+- test/test_raise_exception.rb
 homepage: https://github.com/fixrb/matchi
 licenses:
 - MIT