Update RegexMatcher to use MatchData

spec/matchers/regex_matcher_spec.cr

@@ -1,108 +1,146 @@
 require "../spec_helper"
 
 describe Spectator::Matchers::RegexMatcher do
-  describe "#match?" do
+  describe "#match" do
     it "compares using #=~" do
       spy = SpySUT.new
       partial = new_partial(spy)
       matcher = Spectator::Matchers::RegexMatcher.new(/foobar/)
-      matcher.match?(partial).should be_true
+      matcher.match(partial)
       spy.match_call_count.should be > 0
     end
 
-    context "with a matching pattern" do
-      it "is true" do
-        value = "foobar"
-        pattern = /foo/
-        partial = new_partial(value)
-        matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-        matcher.match?(partial).should be_true
+    context "returned MatchData" do
+      describe "#matched?" do
+        context "with a matching pattern" do
+          it "is true" do
+            value = "foobar"
+            pattern = /foo/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.matched?.should be_true
+          end
+        end
+
+        context "with a non-matching pattern" do
+          it "is false" do
+            value = "foo"
+            pattern = /bar/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.matched?.should be_false
+          end
+        end
       end
-    end
 
-    context "with a non-matching pattern" do
-      it "is false" do
-        value = "foo"
-        pattern = /bar/
-        partial = new_partial(value)
-        matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-        matcher.match?(partial).should be_false
+      describe "#values" do
+        context "expected" do
+          it "is the expected value" do
+            value = "foo"
+            pattern = /bar/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.values[:expected].should eq(pattern)
+          end
+        end
+
+        context "actual" do
+          it "is the actual value" do
+            value = "foo"
+            pattern = /bar/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.values[:actual].should eq(value)
+          end
+        end
       end
-    end
-  end
 
-  describe "#message" do
-    it "mentions =~" do
-      value = "foobar"
-      pattern = /foo/
-      partial = new_partial(value)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-      matcher.message(partial).should contain("=~")
-    end
+      describe "#message" do
+        it "mentions =~" do
+          value = "foobar"
+          pattern = /foo/
+          partial = new_partial(value)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+          match_data = matcher.match(partial)
+          match_data.message.should contain("=~")
+        end
 
-    it "contains the actual label" do
-      value = "foobar"
-      label = "different"
-      pattern = /foo/
-      partial = new_partial(value, label)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-      matcher.message(partial).should contain(label)
-    end
+        it "contains the actual label" do
+          value = "foobar"
+          label = "different"
+          pattern = /foo/
+          partial = new_partial(value, label)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+          match_data = matcher.match(partial)
+          match_data.message.should contain(label)
+        end
 
-    it "contains the expected label" do
-      value = "foobar"
-      label = "different"
-      pattern = /foo/
-      partial = new_partial(value)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern, label)
-      matcher.message(partial).should contain(label)
-    end
+        it "contains the expected label" do
+          value = "foobar"
+          label = "different"
+          pattern = /foo/
+          partial = new_partial(value)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern, 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
-        value = "foobar"
-        pattern = /foo/
-        partial = new_partial(value)
-        matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-        matcher.message(partial).should contain(pattern.to_s)
+        context "when expected label is omitted" do
+          it "contains stringified form of expected value" do
+            value = "foobar"
+            pattern = /foo/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.message.should contain(pattern.to_s)
+          end
+        end
       end
-    end
-  end
 
-  describe "#negated_message" do
-    it "mentions =~" do
-      value = "foobar"
-      pattern = /foo/
-      partial = new_partial(value)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-      matcher.negated_message(partial).should contain("=~")
-    end
+      describe "#negated_message" do
+        it "mentions =~" do
+          value = "foobar"
+          pattern = /foo/
+          partial = new_partial(value)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+          match_data = matcher.match(partial)
+          match_data.negated_message.should contain("=~")
+        end
 
-    it "contains the actual label" do
-      value = "foobar"
-      label = "different"
-      pattern = /foo/
-      partial = new_partial(value, label)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-      matcher.negated_message(partial).should contain(label)
-    end
+        it "contains the actual label" do
+          value = "foobar"
+          label = "different"
+          pattern = /foo/
+          partial = new_partial(value, label)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+          match_data = matcher.match(partial)
+          match_data.negated_message.should contain(label)
+        end
 
-    it "contains the expected label" do
-      value = "foobar"
-      label = "different"
-      pattern = /foo/
-      partial = new_partial(value)
-      matcher = Spectator::Matchers::RegexMatcher.new(pattern, label)
-      matcher.negated_message(partial).should contain(label)
-    end
+        it "contains the expected label" do
+          value = "foobar"
+          label = "different"
+          pattern = /foo/
+          partial = new_partial(value)
+          matcher = Spectator::Matchers::RegexMatcher.new(pattern, 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
-        value = "foobar"
-        pattern = /foo/
-        partial = new_partial(value)
-        matcher = Spectator::Matchers::RegexMatcher.new(pattern)
-        matcher.negated_message(partial).should contain(pattern.to_s)
+        context "when expected label is omitted" do
+          it "contains stringified form of expected value" do
+            value = "foobar"
+            pattern = /foo/
+            partial = new_partial(value)
+            matcher = Spectator::Matchers::RegexMatcher.new(pattern)
+            match_data = matcher.match(partial)
+            match_data.negated_message.should contain(pattern.to_s)
+          end
+        end
       end
     end
   end

src/spectator/matchers/regex_matcher.cr

@@ -5,27 +5,43 @@ module Spectator::Matchers
   # The value is compared with the =~ operator.
   struct RegexMatcher(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 match #{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 match #{label} (using =~)"
+      # 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
+        "#{@values.actual_label} matches #{@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} does not match #{@values.expected_label} (using =~)"
+      end
     end
   end
 end