From 95b4a349da08daf7ae97d7281de3cc57f5757d2c Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Tue, 5 Mar 2019 19:00:49 -0700 Subject: [PATCH] Update InequalityMatcher to use MatchData --- spec/matchers/inequality_matcher_spec.cr | 253 +++++++++++-------- src/spectator/matchers/inequality_matcher.cr | 44 +++- 2 files changed, 180 insertions(+), 117 deletions(-) diff --git a/spec/matchers/inequality_matcher_spec.cr b/spec/matchers/inequality_matcher_spec.cr index 19a2b0f..a4085ff 100644 --- a/spec/matchers/inequality_matcher_spec.cr +++ b/spec/matchers/inequality_matcher_spec.cr @@ -1,133 +1,180 @@ require "../spec_helper" describe Spectator::Matchers::InequalityMatcher do - describe "#match?" do + describe "#match" do it "compares using #!=" do spy = SpySUT.new partial = new_partial(spy) matcher = Spectator::Matchers::InequalityMatcher.new(42) - matcher.match?(partial).should be_true + matcher.match(partial) spy.ne_call_count.should be > 0 end - context "with identical values" do - it "is false" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::InequalityMatcher.new(value) - matcher.match?(partial).should be_false - end - end + context "returned MatchData" do + describe "#matched?" do + context "with identical values" do + it "is false" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::InequalityMatcher.new(value) + match_data = matcher.match(partial) + match_data.matched?.should be_false + end + end - context "with different values" do - it "is true" do - value1 = 42 - value2 = 777 - partial = new_partial(value1) - matcher = Spectator::Matchers::InequalityMatcher.new(value2) - matcher.match?(partial).should be_true - end - end + context "with different values" do + it "is true" do + value1 = 42 + value2 = 777 + partial = new_partial(value1) + matcher = Spectator::Matchers::InequalityMatcher.new(value2) + match_data = matcher.match(partial) + match_data.matched?.should be_true + end + end - context "with the same instance" do - it "is false" do - # Box is used because it is a reference type and doesn't override the == method. - ref = Box.new([] of Int32) - partial = new_partial(ref) - matcher = Spectator::Matchers::InequalityMatcher.new(ref) - matcher.match?(partial).should be_false - end - end + context "with the same instance" do + it "is false" do + # Box is used because it is a reference type and doesn't override the == method. + ref = Box.new([] of Int32) + partial = new_partial(ref) + matcher = Spectator::Matchers::InequalityMatcher.new(ref) + match_data = matcher.match(partial) + match_data.matched?.should be_false + end + end - context "with different instances" do - context "with same contents" do - it "is false" do - array1 = [1, 2, 3] - array2 = [1, 2, 3] - partial = new_partial(array1) - matcher = Spectator::Matchers::InequalityMatcher.new(array2) - matcher.match?(partial).should be_false + context "with different instances" do + context "with same contents" do + it "is false" do + array1 = [1, 2, 3] + array2 = [1, 2, 3] + partial = new_partial(array1) + matcher = Spectator::Matchers::InequalityMatcher.new(array2) + match_data = matcher.match(partial) + match_data.matched?.should be_false + end + end + + context "with different contents" do + it "is true" do + array1 = [1, 2, 3] + array2 = [4, 5, 6] + partial = new_partial(array1) + matcher = Spectator::Matchers::InequalityMatcher.new(array2) + match_data = matcher.match(partial) + match_data.matched?.should be_true + end + end end end - context "with different contents" do - it "is true" do - array1 = [1, 2, 3] - array2 = [4, 5, 6] - partial = new_partial(array1) - matcher = Spectator::Matchers::InequalityMatcher.new(array2) - matcher.match?(partial).should be_true + describe "#values" do + context "expected" do + it "is the expected value" do + expected, actual = 42, 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::InequalityMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:expected].value.should eq(expected) + end + + it "is prefixed with 'Not'" do + expected, actual = 42, 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::InequalityMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:expected].to_s.should start_with("Not") + end + end + + context "actual" do + it "is the actual value" do + expected, actual = 42, 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::InequalityMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:actual].should eq(actual) + end end end - end - end - describe "#message" do - it "mentions !=" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::InequalityMatcher.new(value) - matcher.message(partial).should contain("!=") - end + describe "#message" do + it "mentions !=" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::InequalityMatcher.new(value) + match_data = matcher.match(partial) + match_data.message.should contain("!=") + end - it "contains the actual label" do - value = 42 - label = "everything" - partial = new_partial(value, label) - matcher = Spectator::Matchers::InequalityMatcher.new(value) - matcher.message(partial).should contain(label) - end + it "contains the actual label" do + value = 42 + label = "everything" + partial = new_partial(value, label) + matcher = Spectator::Matchers::InequalityMatcher.new(value) + match_data = matcher.match(partial) + match_data.message.should contain(label) + end - it "contains the expected label" do - value = 42 - label = "everything" - partial = new_partial(value) - matcher = Spectator::Matchers::InequalityMatcher.new(value, label) - matcher.message(partial).should contain(label) - end + it "contains the expected label" do + value = 42 + label = "everything" + partial = new_partial(value) + matcher = Spectator::Matchers::InequalityMatcher.new(value, label) + match_data = matcher.match(partial) + match_data.message.should contain(label) + end - context "when expected label is omitted" do - it "contains stringified form of expected value" do - value1 = 42 - value2 = 777 - partial = new_partial(value1) - matcher = Spectator::Matchers::InequalityMatcher.new(value2) - matcher.message(partial).should contain(value2.to_s) + context "when expected label is omitted" do + it "contains stringified form of expected value" do + value1 = 42 + value2 = 777 + partial = new_partial(value1) + matcher = Spectator::Matchers::InequalityMatcher.new(value2) + match_data = matcher.match(partial) + match_data.message.should contain(value2.to_s) + end + end end - end - end - describe "#negated_message" do - it "mentions !=" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::InequalityMatcher.new(value) - matcher.negated_message(partial).should contain("!=") - end + describe "#negated_message" do + it "mentions !=" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::InequalityMatcher.new(value) + match_data = matcher.match(partial) + match_data.negated_message.should contain("!=") + end - it "contains the actual label" do - value = 42 - label = "everything" - partial = new_partial(value, label) - matcher = Spectator::Matchers::InequalityMatcher.new(value) - matcher.negated_message(partial).should contain(label) - end + it "contains the actual label" do + value = 42 + label = "everything" + partial = new_partial(value, label) + matcher = Spectator::Matchers::InequalityMatcher.new(value) + match_data = matcher.match(partial) + match_data.negated_message.should contain(label) + end - it "contains the expected label" do - value = 42 - label = "everything" - partial = new_partial(value) - matcher = Spectator::Matchers::InequalityMatcher.new(value, label) - matcher.negated_message(partial).should contain(label) - end + it "contains the expected label" do + value = 42 + label = "everything" + partial = new_partial(value) + matcher = Spectator::Matchers::InequalityMatcher.new(value, label) + match_data = matcher.match(partial) + match_data.negated_message.should contain(label) + end - context "when expected label is omitted" do - it "contains stringified form of expected value" do - value1 = 42 - value2 = 777 - partial = new_partial(value1) - matcher = Spectator::Matchers::InequalityMatcher.new(value2) - matcher.negated_message(partial).should contain(value2.to_s) + context "when expected label is omitted" do + it "contains stringified form of expected value" do + value1 = 42 + value2 = 777 + partial = new_partial(value1) + matcher = Spectator::Matchers::InequalityMatcher.new(value2) + match_data = matcher.match(partial) + match_data.negated_message.should contain(value2.to_s) + end + end end end end diff --git a/src/spectator/matchers/inequality_matcher.cr b/src/spectator/matchers/inequality_matcher.cr index 836764d..51d7aa1 100644 --- a/src/spectator/matchers/inequality_matcher.cr +++ b/src/spectator/matchers/inequality_matcher.cr @@ -5,27 +5,43 @@ module Spectator::Matchers # The values are compared with the != operator. struct InequalityMatcher(ExpectedType) < ValueMatcher(ExpectedType) # Determines whether the matcher is satisfied with the value given to it. - # True is returned if the match was successful, false otherwise. - def match?(partial) - partial.actual != expected + private def match?(actual) + actual != expected end # Determines whether the matcher is satisfied with the partial given to it. # `MatchData` is returned that contains information about the match. - def match(partial) : MatchData - raise NotImplementedError.new("#match") + def match(partial) + values = ExpectedActual.new(partial, self) + MatchData.new(match?(values.actual), values) end - # Describes the condition that satisfies the matcher. - # This is informational and displayed to the end-user. - def message(partial) - "Expected #{partial.label} to not equal #{label} (using !=)" - 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 - # Describes the condition that won't satsify the matcher. - # This is informational and displayed to the end-user. - def negated_message(partial) - "Expected #{partial.label} to equal #{label} (using !=)" + # Information about the match. + def values + { + expected: PrefixedValue.new("Not", @values.expected), + actual: @values.actual, + } + end + + # Describes the condition that satisfies the matcher. + # This is informational and displayed to the end-user. + def message + "#{@values.actual_label} is not #{@values.expected_label} (using !=)" + end + + # Describes the condition that won't satsify the matcher. + # This is informational and displayed to the end-user. + def negated_message + "#{@values.actual_label} is #{@values.expected_label} (using !=)" + end end end end