Skip to content

Update the RSpec matcher example #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rehevkor5 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the RSpec matcher example #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 31 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,34 +353,40 @@ do pattern matching and also looks like a good alternative to diff_matcher, it h

Use with rspec
---
To use with rspec create the following custom matcher:
To use with rspec, create a custom matcher. The following example matcher works with rspec-1.2.4 and up.

``` ruby
require 'diff_matcher'

module RSpec
module Matchers
class BeMatching
include BaseMatcher

def initialize(expected, opts)
@expected = expected
@opts = opts.update(:color_enabled=>RSpec::configuration.color_enabled?)
end

def matches?(actual)
@difference = DiffMatcher::Difference.new(expected, actual, @opts)
@difference.matching?
end

def failure_message_for_should
@difference.to_s
end
end

def be_matching(expected, opts={})
Matchers::BeMatching.new(expected, opts)
end
# Uses the diff_matcher gem to provide advanced matching abilities, along with nice visual representation of the
# diff between actual and expected. The functionality set is very helpful for comparing hashes.
#
# Usage examples:
# it { should be_matching(my_var) }
# it { should be_matching(my_var).with_options(ignore_additional: true) }
#
# Options: by default, color_enabled is controlled by Rspec, and quiet is set to true.
RSpec::Matchers.define :be_matching do |expected|
match do |actual|
options = { color_enabled: RSpec::configuration.color_enabled?, quiet: true }.merge(@options || {})
@difference = DiffMatcher::Difference.new(expected, actual, options)
@difference.matching?
end

chain :with_options do |options|
@options = options
end

failure_message_for_should do |actual|
"diff is:\n" + @difference.to_s
end

failure_message_for_should_not do |actual|
"diff is:\n" + @difference.to_s
end

description do
"match via DiffMatcher #{expected}" + (@options.blank? ? '' : " with options: #{@options}")
end
end
```
Expand All @@ -392,7 +398,7 @@ describe "hash matcher" do
subject { { :a=>1, :b=>2, :c=>'3', :d=>4, :e=>"additional stuff" } }
let(:expected) { { :a=>1, :b=>Fixnum, :c=>/[0-9]/, :d=>lambda { |x| (3..5).include?(x) } } }

it { should be_matching(expected, :ignore_additional=>true) }
it { should be_matching(expected).with_options(:ignore_additional=>true) }
it { should be_matching(expected) }
end
```
Expand Down