Update HaveValueMatcher to use MatchData

This commit is contained in:
Michael Miller 2019-03-06 02:19:12 -07:00
parent 3f1d8751fe
commit 76d09a22ff
2 changed files with 154 additions and 82 deletions

View file

@ -1,14 +1,23 @@
require "../spec_helper" require "../spec_helper"
private struct FakeValueSet
def has_value?(value)
true
end
end
describe Spectator::Matchers::HaveValueMatcher do describe Spectator::Matchers::HaveValueMatcher do
describe "#match?" do describe "#match" do
context "returned MatchData" do
describe "#matched?" do
context "with an existing value" do context "with an existing value" do
it "is true" do it "is true" do
hash = Hash{"foo" => "bar"} hash = Hash{"foo" => "bar"}
value = "bar" value = "bar"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.match?(partial).should be_true match_data = matcher.match(partial)
match_data.matched?.should be_true
end end
end end
@ -18,7 +27,45 @@ describe Spectator::Matchers::HaveValueMatcher do
value = "baz" value = "baz"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.match?(partial).should be_false match_data = matcher.match(partial)
match_data.matched?.should be_false
end
end
end
describe "#values" do
context "value" do
it "is the expected value" do
hash = {"foo" => "bar"}
value = "baz"
partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value)
match_data = matcher.match(partial)
match_data.values[:value].should eq(value)
end
end
context "actual" do
context "when #values is available" do
it "is the list of values" do
hash = Hash{"foo" => "bar"}
value = "baz"
partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value)
match_data = matcher.match(partial)
match_data.values[:actual].should eq(hash.values)
end
end
context "when #values isn't available" do
it "is the actual value" do
actual = FakeValueSet.new
value = "baz"
partial = new_partial(actual)
matcher = Spectator::Matchers::HaveValueMatcher.new(value)
match_data = matcher.match(partial)
match_data.values[:actual].should eq(actual)
end
end end
end end
end end
@ -30,7 +77,8 @@ describe Spectator::Matchers::HaveValueMatcher do
label = "blah" label = "blah"
partial = new_partial(hash, label) partial = new_partial(hash, label)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.message(partial).should contain(label) match_data = matcher.match(partial)
match_data.message.should contain(label)
end end
it "contains the expected label" do it "contains the expected label" do
@ -39,7 +87,8 @@ describe Spectator::Matchers::HaveValueMatcher do
label = "blah" label = "blah"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value, label) matcher = Spectator::Matchers::HaveValueMatcher.new(value, label)
matcher.message(partial).should contain(label) match_data = matcher.match(partial)
match_data.message.should contain(label)
end end
context "when the expected label is omitted" do context "when the expected label is omitted" do
@ -48,7 +97,8 @@ describe Spectator::Matchers::HaveValueMatcher do
value = "bar" value = "bar"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.message(partial).should contain(value.to_s) match_data = matcher.match(partial)
match_data.message.should contain(value.to_s)
end end
end end
end end
@ -60,7 +110,8 @@ describe Spectator::Matchers::HaveValueMatcher do
label = "blah" label = "blah"
partial = new_partial(hash, label) partial = new_partial(hash, label)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.negated_message(partial).should contain(label) match_data = matcher.match(partial)
match_data.negated_message.should contain(label)
end end
it "contains the expected label" do it "contains the expected label" do
@ -69,7 +120,8 @@ describe Spectator::Matchers::HaveValueMatcher do
label = "blah" label = "blah"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value, label) matcher = Spectator::Matchers::HaveValueMatcher.new(value, label)
matcher.negated_message(partial).should contain(label) match_data = matcher.match(partial)
match_data.negated_message.should contain(label)
end end
context "when the expected label is omitted" do context "when the expected label is omitted" do
@ -78,7 +130,10 @@ describe Spectator::Matchers::HaveValueMatcher do
value = "bar" value = "bar"
partial = new_partial(hash) partial = new_partial(hash)
matcher = Spectator::Matchers::HaveValueMatcher.new(value) matcher = Spectator::Matchers::HaveValueMatcher.new(value)
matcher.negated_message(partial).should contain(value.to_s) match_data = matcher.match(partial)
match_data.negated_message.should contain(value.to_s)
end
end
end end
end end
end end

View file

@ -5,27 +5,44 @@ module Spectator::Matchers
# The set is checked with the `has_value?` method. # The set is checked with the `has_value?` method.
struct HaveValueMatcher(ExpectedType) < ValueMatcher(ExpectedType) struct HaveValueMatcher(ExpectedType) < ValueMatcher(ExpectedType)
# Determines whether the matcher is satisfied with the value given to it. # Determines whether the matcher is satisfied with the value given to it.
# True is returned if the match was successful, false otherwise. private def match?(actual)
def match?(partial) actual.has_value?(expected)
partial.actual.has_value?(expected)
end end
# Determines whether the matcher is satisfied with the partial given to it. # Determines whether the matcher is satisfied with the partial given to it.
# `MatchData` is returned that contains information about the match. # `MatchData` is returned that contains information about the match.
def match(partial) : MatchData def match(partial)
raise NotImplementedError.new("#match") values = ExpectedActual.new(partial, self)
MatchData.new(match?(values.actual), values)
end
# Match data specific to this matcher.
private struct MatchData(ExpectedType, ActualType) < MatchData
# Creates the match data.
def initialize(matched, @values : ExpectedActual(ExpectedType, ActualType))
super(matched)
end
# Information about the match.
def values
actual = @values.actual
{
value: @values.expected,
actual: actual.responds_to?(:values) ? actual.values : actual,
}
end end
# Describes the condition that satisfies the matcher. # Describes the condition that satisfies the matcher.
# This is informational and displayed to the end-user. # This is informational and displayed to the end-user.
def message(partial) def message
"Expected #{partial.label} to have value #{label}" "#{@values.actual_label} has value #{@values.expected_label}"
end end
# Describes the condition that won't satsify the matcher. # Describes the condition that won't satsify the matcher.
# This is informational and displayed to the end-user. # This is informational and displayed to the end-user.
def negated_message(partial) def negated_message
"Expected #{partial.label} to not have value #{label}" "#{@values.actual_label} does not have value #{@values.expected_label}"
end
end end
end end
end end