From f8464088480eef9d68fdf331e57d580b073f36ea Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Tue, 5 Mar 2019 16:37:51 -0700 Subject: [PATCH] Update LessThanEqualMatcher to use MatchData --- spec/matchers/less_than_equal_matcher_spec.cr | 250 +++++++++++------- .../matchers/less_than_equal_matcher.cr | 49 +++- 2 files changed, 196 insertions(+), 103 deletions(-) diff --git a/spec/matchers/less_than_equal_matcher_spec.cr b/spec/matchers/less_than_equal_matcher_spec.cr index c6fe661..9a94f14 100644 --- a/spec/matchers/less_than_equal_matcher_spec.cr +++ b/spec/matchers/less_than_equal_matcher_spec.cr @@ -1,111 +1,183 @@ require "../spec_helper" describe Spectator::Matchers::LessThanEqualMatcher do - describe "#match?" do + describe "#match" do it "compares using #<=" do spy = SpySUT.new partial = new_partial(spy) matcher = Spectator::Matchers::LessThanEqualMatcher.new(42) - matcher.match?(partial).should be_true + matcher.match(partial) spy.le_call_count.should be > 0 end - context "with a larger value" do - it "is true" do - actual = 42 - expected = 777 - partial = new_partial(actual) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) - matcher.match?(partial).should be_true + context "returned MatchData" do + describe "#matched?" do + context "with a larger value" do + it "is true" do + actual = 42 + expected = 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.matched?.should be_true + end + end + + context "with a smaller value" do + it "is false" do + actual = 777 + expected = 42 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.matched?.should be_false + end + end + + context "with an equal value" do + it "is true" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(value) + match_data = matcher.match(partial) + match_data.matched?.should be_true + end + end end - end - context "with a smaller value" do - it "is false" do - actual = 777 - expected = 42 - partial = new_partial(actual) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) - matcher.match?(partial).should be_false + describe "#values" do + context "expected" do + it "is the expected value" do + actual = 42 + expected = 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:expected].value.should eq(expected) + end + + it "is prefixed with <=" do + actual = 42 + expected = 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:expected].to_s.should start_with("<=") + end + end + + context "actual" do + it "is the actual value" do + actual = 42 + expected = 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.values[:actual].value.should eq(actual) + end + + context "when #matched? is true" do + it "is prefixed with <=" do + actual = 42 + expected = 777 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.matched?.should be_true # Sanity check. + match_data.values[:actual].to_s.should start_with("<=") + end + end + + context "when #matched? is false" do + it "is prefixed with >" do + actual = 777 + expected = 42 + partial = new_partial(actual) + matcher = Spectator::Matchers::LessThanEqualMatcher.new(expected) + match_data = matcher.match(partial) + match_data.matched?.should be_false # Sanity check. + match_data.values[:actual].to_s.should start_with(">") + end + end + end end - end - context "with an equal value" do - it "is true" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(value) - matcher.match?(partial).should be_true + describe "#message" do + it "mentions <=" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.new(value2) + match_data = matcher.match(partial) + match_data.message.should contain(value2.to_s) + end + end end - end - end - describe "#message" do - it "mentions <=" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(value) - matcher.message(partial).should contain("<=") - end + describe "#negated_message" do + it "mentions <=" do + value = 42 + partial = new_partial(value) + matcher = Spectator::Matchers::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.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::LessThanEqualMatcher.new(value2) - matcher.message(partial).should contain(value2.to_s) - end - end - end - - describe "#negated_message" do - it "mentions <=" do - value = 42 - partial = new_partial(value) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(value) - matcher.negated_message(partial).should contain("<=") - end - - it "contains the actual label" do - value = 42 - label = "everything" - partial = new_partial(value, label) - matcher = Spectator::Matchers::LessThanEqualMatcher.new(value) - 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::LessThanEqualMatcher.new(value, label) - matcher.negated_message(partial).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::LessThanEqualMatcher.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::LessThanEqualMatcher.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/less_than_equal_matcher.cr b/src/spectator/matchers/less_than_equal_matcher.cr index 8910eda..3b8bb12 100644 --- a/src/spectator/matchers/less_than_equal_matcher.cr +++ b/src/spectator/matchers/less_than_equal_matcher.cr @@ -5,27 +5,48 @@ module Spectator::Matchers # The values are compared with the <= operator. struct LessThanEqualMatcher(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 be less than or equal to #{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 not be less than or equal to #{label} (using <=)" + # Information about the match. + def values + { + expected: PrefixedValue.new("<=", @values.expected), + actual: PrefixedValue.new(actual_operator, @values.actual), + } + end + + # Textual operator for the actual value. + private def actual_operator + matched? ? "<=" : ">" + end + + # Describes the condition that satisfies the matcher. + # This is informational and displayed to the end-user. + def message + "#{@values.actual_label} is less than or equal to #{@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 greater than #{@values.expected_label} (using <=)" + end end end end