Update CaseMatcher to use MatchData

spec/matchers/case_matcher_spec.cr

@@ -1,21 +1,24 @@
 require "../spec_helper"
 
 describe Spectator::Matchers::CaseMatcher do
-  describe "#match?" do
+  describe "#match" do
     it "compares using #===" do
       spy = SpySUT.new
       partial = new_partial(42)
       matcher = Spectator::Matchers::CaseMatcher.new(spy)
-      matcher.match?(partial).should be_true
+      matcher.match(partial)
       spy.case_eq_call_count.should be > 0
     end
 
+    context "returned MatchData" do
+      describe "#matched?" do
         context "with identical values" do
           it "is true" do
             value = 42
             partial = new_partial(value)
             matcher = Spectator::Matchers::CaseMatcher.new(value)
-        matcher.match?(partial).should be_true
+            match_data = matcher.match(partial)
+            match_data.matched?.should be_true
           end
         end
 
@@ -25,7 +28,8 @@ describe Spectator::Matchers::CaseMatcher do
             value2 = 777
             partial = new_partial(value1)
             matcher = Spectator::Matchers::CaseMatcher.new(value2)
-        matcher.match?(partial).should be_false
+            match_data = matcher.match(partial)
+            match_data.matched?.should be_false
           end
         end
 
@@ -35,7 +39,8 @@ describe Spectator::Matchers::CaseMatcher do
             ref = Box.new([] of Int32)
             partial = new_partial(ref)
             matcher = Spectator::Matchers::CaseMatcher.new(ref)
-        matcher.match?(partial).should be_true
+            match_data = matcher.match(partial)
+            match_data.matched?.should be_true
           end
         end
 
@@ -46,7 +51,8 @@ describe Spectator::Matchers::CaseMatcher do
               array2 = [1, 2, 3]
               partial = new_partial(array1)
               matcher = Spectator::Matchers::CaseMatcher.new(array2)
-          matcher.match?(partial).should be_true
+              match_data = matcher.match(partial)
+              match_data.matched?.should be_true
             end
           end
 
@@ -56,7 +62,8 @@ describe Spectator::Matchers::CaseMatcher do
               array2 = [4, 5, 6]
               partial = new_partial(array1)
               matcher = Spectator::Matchers::CaseMatcher.new(array2)
-          matcher.match?(partial).should be_false
+              match_data = matcher.match(partial)
+              match_data.matched?.should be_false
             end
           end
 
@@ -66,7 +73,8 @@ describe Spectator::Matchers::CaseMatcher do
               value2 = String
               partial = new_partial(value1)
               matcher = Spectator::Matchers::CaseMatcher.new(value2)
-          matcher.match?(partial).should be_true
+              match_data = matcher.match(partial)
+              match_data.matched?.should be_true
             end
           end
 
@@ -76,7 +84,8 @@ describe Spectator::Matchers::CaseMatcher do
               value2 = Array
               partial = new_partial(value1)
               matcher = Spectator::Matchers::CaseMatcher.new(value2)
-          matcher.match?(partial).should be_false
+              match_data = matcher.match(partial)
+              match_data.matched?.should be_false
             end
           end
         end
@@ -87,7 +96,8 @@ describe Spectator::Matchers::CaseMatcher do
           value = 42
           partial = new_partial(value)
           matcher = Spectator::Matchers::CaseMatcher.new(value)
-      matcher.message(partial).should contain("===")
+          match_data = matcher.match(partial)
+          match_data.message.should contain("===")
         end
 
         it "contains the actual label" do
@@ -95,7 +105,8 @@ describe Spectator::Matchers::CaseMatcher do
           label = "everything"
           partial = new_partial(value, label)
           matcher = Spectator::Matchers::CaseMatcher.new(value)
-      matcher.message(partial).should contain(label)
+          match_data = matcher.match(partial)
+          match_data.message.should contain(label)
         end
 
         it "contains the expected label" do
@@ -103,7 +114,8 @@ describe Spectator::Matchers::CaseMatcher do
           label = "everything"
           partial = new_partial(value)
           matcher = Spectator::Matchers::CaseMatcher.new(value, label)
-      matcher.message(partial).should contain(label)
+          match_data = matcher.match(partial)
+          match_data.message.should contain(label)
         end
 
         context "when expected label is omitted" do
@@ -112,7 +124,8 @@ describe Spectator::Matchers::CaseMatcher do
             value2 = 777
             partial = new_partial(value1)
             matcher = Spectator::Matchers::CaseMatcher.new(value2)
-        matcher.message(partial).should contain(value2.to_s)
+            match_data = matcher.match(partial)
+            match_data.message.should contain(value2.to_s)
           end
         end
       end
@@ -122,7 +135,8 @@ describe Spectator::Matchers::CaseMatcher do
           value = 42
           partial = new_partial(value)
           matcher = Spectator::Matchers::CaseMatcher.new(value)
-      matcher.negated_message(partial).should contain("===")
+          match_data = matcher.match(partial)
+          match_data.negated_message.should contain("===")
         end
 
         it "contains the actual label" do
@@ -130,7 +144,8 @@ describe Spectator::Matchers::CaseMatcher do
           label = "everything"
           partial = new_partial(value, label)
           matcher = Spectator::Matchers::CaseMatcher.new(value)
-      matcher.negated_message(partial).should contain(label)
+          match_data = matcher.match(partial)
+          match_data.negated_message.should contain(label)
         end
 
         it "contains the expected label" do
@@ -138,7 +153,8 @@ describe Spectator::Matchers::CaseMatcher do
           label = "everything"
           partial = new_partial(value)
           matcher = Spectator::Matchers::CaseMatcher.new(value, label)
-      matcher.negated_message(partial).should contain(label)
+          match_data = matcher.match(partial)
+          match_data.negated_message.should contain(label)
         end
 
         context "when expected label is omitted" do
@@ -147,7 +163,10 @@ describe Spectator::Matchers::CaseMatcher do
             value2 = 777
             partial = new_partial(value1)
             matcher = Spectator::Matchers::CaseMatcher.new(value2)
-        matcher.negated_message(partial).should contain(value2.to_s)
+            match_data = matcher.match(partial)
+            match_data.negated_message.should contain(value2.to_s)
+          end
+        end
       end
     end
   end

src/spectator/matchers/case_matcher.cr

@@ -5,27 +5,43 @@ module Spectator::Matchers
   # The values are compared with the === operator.
   struct CaseMatcher(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)
-      expected === partial.actual
+    private def match?(actual)
+      expected === actual
     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
+
+    # 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
+        {
+          expected: @values.expected,
+          actual:   @values.actual,
+        }
       end
 
       # Describes the condition that satisfies the matcher.
       # This is informational and displayed to the end-user.
-    def message(partial)
-      "Expected #{partial.label} to semantically equal #{label} (using ===)"
+      def message
+        "#{@values.actual_label} equals #{@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(partial)
-      "Expected #{partial.label} to not semantically equal #{label} (using ===)"
+      def negated_message
+        "#{@values.actual_label} does not equal #{@values.expected_label} (using ===)"
+      end
     end
   end
 end