Matchi
Collection of expectation matchers for Ruby.
Contact
- Home page: https://github.com/fixrb/matchi
- Bugs/issues: https://github.com/fixrb/matchi/issues
Rubies
Installation
Add this line to your application's Gemfile:
gem 'matchi'
And then execute:
$ bundle
Or install it yourself as:
$ gem install matchi
Usage
Built-in matchers
Equivalence matcher:
eql = Matchi::Matcher::Eql.new('foo')
eql.matches? { 'foo' } # => true
Identity matcher:
equal = Matchi::Matcher::Equal.new(:foo)
equal.matches? { :foo } # => true
Regular expressions matcher:
match = Matchi::Matcher::Match.new(/^foo$/)
match.matches? { 'foo' } # => true
Expecting errors matcher:
raise_exception = Matchi::Matcher::RaiseException.new(NameError)
raise_exception.matches? { Boom } # => true
Truth matcher:
be_true = Matchi::Matcher::BeTrue.new
be_true.matches? { true } # => true
Untruth matcher:
be_false = Matchi::Matcher::BeFalse.new
be_false.matches? { false } # => true
Nil matcher:
be_nil = Matchi::Matcher::BeNil.new
be_nil.matches? { nil } # => 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.
A Be the answer matcher:
module Matchi
module Matcher
class BeTheAnswer < ::Matchi::Matcher::Base
def matches?
42.equal? yield
end
end
end
end
be_the_answer = Matchi::Matcher::BeTheAnswer.new
be_the_answer.matches? { 42 } # => true
A Be prime matcher:
require 'prime'
module Matchi
module Matcher
class BePrime < ::Matchi::Matcher::Base
def matches?
Prime.prime? yield
end
end
end
end
be_prime = Matchi::Matcher::BePrime.new
be_prime.matches? { 42 } # => false
A Start with matcher:
module Matchi
module Matcher
class StartWith < ::Matchi::Matcher::Base
def initialize(expected)
@expected = expected
end
def matches?
!Regexp.new("^#{expected}").match(yield).nil?
end
end
end
end
start_with = Matchi::Matcher::StartWith.new('foo')
start_with.matches? { 'foobar' } # => true
Security
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.
The checksum of a file can be checked using the sha512sum
command. For
example:
$ sha512sum pkg/matchi-0.0.1.gem
548d9f669ded4e622182791a5390aaceae0bf2e557b0864f05a842b0be2c65e10e1fb8499f49a3b9efd0e8eaeb691351b1c670d6316ce49965a99683b1071389 pkg/matchi-0.0.1.gem
Versioning
Matchi follows Semantic Versioning 2.0.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License
See LICENSE.md
file.