From bc66016c42a17673e3f01cf829dd9e3df81a0226 Mon Sep 17 00:00:00 2001
From: Michael Miller <icy.arctic.fox@gmail.com>
Date: Thu, 18 Oct 2018 13:46:12 -0600
Subject: [PATCH] Add specs for equality matcher

---
 spec/matchers/equality_matcher_spec.cr | 114 +++++++++++++++++++++++++
 spec/spec_helper.cr                    |  13 +++
 2 files changed, 127 insertions(+)
 create mode 100644 spec/matchers/equality_matcher_spec.cr

diff --git a/spec/matchers/equality_matcher_spec.cr b/spec/matchers/equality_matcher_spec.cr
new file mode 100644
index 0000000..0b1187c
--- /dev/null
+++ b/spec/matchers/equality_matcher_spec.cr
@@ -0,0 +1,114 @@
+require "../spec_helper"
+
+describe Spectator::Matchers::EqualityMatcher do
+  describe "#match?" do
+    it "compares using #==" do
+      spy = SpySUT.new
+      partial = Spectator::Expectations::ValueExpectationPartial.new("", spy)
+      matcher = Spectator::Matchers::EqualityMatcher.new("", 42)
+      matcher.match?(partial).should be_true
+      spy.eq_call_count.should be > 0
+    end
+
+    context "with identical values" do
+      it "is true" do
+        value = 42
+        partial = Spectator::Expectations::ValueExpectationPartial.new(value.to_s, value)
+        matcher = Spectator::Matchers::EqualityMatcher.new(value.to_s, value)
+        matcher.match?(partial).should be_true
+      end
+    end
+
+    context "with different values" do
+      it "is false" do
+        value1 = 42
+        value2 = 777
+        partial = Spectator::Expectations::ValueExpectationPartial.new(value1.to_s, value1)
+        matcher = Spectator::Matchers::EqualityMatcher.new(value2.to_s, value2)
+        matcher.match?(partial).should be_false
+      end
+    end
+
+    context "with the same instance" do
+      it "is true" do
+        # Box is used because it is a reference type and doesn't override the == method.
+        ref = Box.new([] of Int32)
+        partial = Spectator::Expectations::ValueExpectationPartial.new(ref.to_s, ref)
+        matcher = Spectator::Matchers::EqualityMatcher.new(ref.to_s, ref)
+        matcher.match?(partial).should be_true
+      end
+    end
+
+    context "with different instances" do
+      context "with same contents" do
+        it "is true" do
+          array1 = [1, 2, 3]
+          array2 = [1, 2, 3]
+          partial = Spectator::Expectations::ValueExpectationPartial.new(array1.to_s, array1)
+          matcher = Spectator::Matchers::EqualityMatcher.new(array2.to_s, array2)
+          matcher.match?(partial).should be_true
+        end
+      end
+
+      context "with different contents" do
+        it "is false" do
+          array1 = [1, 2, 3]
+          array2 = [4, 5, 6]
+          partial = Spectator::Expectations::ValueExpectationPartial.new(array1.to_s, array1)
+          matcher = Spectator::Matchers::EqualityMatcher.new(array2.to_s, array2)
+          matcher.match?(partial).should be_false
+        end
+      end
+    end
+  end
+
+  describe "#message" do
+    it "mentions ==" do
+      value = 42
+      partial = Spectator::Expectations::ValueExpectationPartial.new(value.to_s, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(value.to_s, value)
+      matcher.message(partial).should contain("==")
+    end
+
+    it "contains the actual label" do
+      value = 42
+      label = "everything"
+      partial = Spectator::Expectations::ValueExpectationPartial.new(label, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(value.to_s, value)
+      matcher.message(partial).should contain(label)
+    end
+
+    it "contains the expected label" do
+      value = 42
+      label = "everything"
+      partial = Spectator::Expectations::ValueExpectationPartial.new(value.to_s, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(label, value)
+      matcher.message(partial).should contain(label)
+    end
+  end
+
+  describe "#negated_message" do
+    it "mentions ==" do
+      value = 42
+      partial = Spectator::Expectations::ValueExpectationPartial.new(value.to_s, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(value.to_s, value)
+      matcher.negated_message(partial).should contain("==")
+    end
+
+    it "contains the actual label" do
+      value = 42
+      label = "everything"
+      partial = Spectator::Expectations::ValueExpectationPartial.new(label, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(value.to_s, value)
+      matcher.message(partial).should contain(label)
+    end
+
+    it "contains the expected label" do
+      value = 42
+      label = "everything"
+      partial = Spectator::Expectations::ValueExpectationPartial.new(value.to_s, value)
+      matcher = Spectator::Matchers::EqualityMatcher.new(label, value)
+      matcher.message(partial).should contain(label)
+    end
+  end
+end
diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr
index 60eee62..2a4f0dd 100644
--- a/spec/spec_helper.cr
+++ b/spec/spec_helper.cr
@@ -3,3 +3,16 @@ require "../src/spectator"
 
 # Prevent Spectator from trying to run tests.
 Spectator.autorun = false
+
+# Example system to test that doubles as a spy.
+# This class tracks calls made to it.
+class SpySUT
+  # Number of times the `#==` method was called.
+  getter eq_call_count = 0
+
+  # Returns true and increments `#eq_call_count`.
+  def ==(other : T) forall T
+    @eq_call_count += 1
+    true
+  end
+end