Ensure that descriptions for RSpec matchers are correct

Author: mcmire

lib/super_diff/rspec/augmented_matcher.rb

@@ -29,33 +29,55 @@ def build_failure_message(negated:)
         matcher_text_builder.call(negated: negated)
       end
 
-      def actual_for_failure_message
+      def matcher_text_builder
+        @_matcher_text_builder ||=
+          matcher_text_builder_class.new(matcher_text_builder_args)
+      end
+
+      def matcher_text_builder_class
+        RSpec::MatcherTextBuilders::Base
+      end
+
+      def matcher_text_builder_args
+        {
+          actual: actual_for_matcher_text,
+          expected_for_failure_message: expected_for_failure_message,
+          expected_for_description: expected_for_description,
+          expected_action_for_failure_message: expected_action_for_failure_message,
+          expected_action_for_description: expected_action_for_description,
+        }
+      end
+
+      def actual_for_matcher_text
         description_of(actual)
       end
 
-      def expected_for_failure_message
+      def expected_for_matcher_text
         description_of(expected)
       end
 
-      def matcher_text_builder
-        @_matcher_text_builder ||=
-          matcher_text_builder_class.new(
-            actual: actual_for_failure_message,
-            expected: expected_for_failure_message,
-            expected_action: expected_action,
-          )
+      def expected_for_failure_message
+        expected_for_matcher_text
       end
 
-      def matcher_text_builder_class
-        MatcherTextBuilders::Base
+      def expected_for_description
+        expected_for_matcher_text
       end
 
       private
 
-      def expected_action
+      def expected_action_for_matcher_text
         ::RSpec::Matchers::EnglishPhrasing.split_words(self.class.matcher_name)
       end
 
+      def expected_action_for_failure_message
+        expected_action_for_matcher_text
+      end
+
+      def expected_action_for_description
+        expected_action_for_matcher_text
+      end
+
       def readable_list_of(things)
         ::RSpec::Matchers::EnglishPhrasing.list(things)
       end

lib/super_diff/rspec/matcher_text_builders/base.rb

@@ -2,10 +2,19 @@ module SuperDiff
   module RSpec
     module MatcherTextBuilders
       class Base
-        def initialize(actual:, expected:, expected_action:)
+        def initialize(
+          actual:,
+          expected_for_failure_message:,
+          expected_for_description:,
+          expected_action_for_failure_message:,
+          expected_action_for_description:
+        )
           @actual = actual
-          @expected = expected
-          @expected_action = expected_action
+          @expected_for_failure_message = expected_for_failure_message
+          @expected_for_description = expected_for_description
+          @expected_action_for_failure_message =
+            expected_action_for_failure_message
+          @expected_action_for_description = expected_action_for_description
 
           @negated = nil
           @template = MatcherTextTemplate.new
@@ -20,16 +29,17 @@ def call(negated:)
 
         def matcher_description
           template = MatcherTextTemplate.new do |t|
-            t.add_text expected_action
-            add_expected_value_to(t)
+            t.add_text expected_action_for_description
+            add_expected_value_to_description(t)
+            add_extra_after_expected_to(t)
           end
 
           Csi.decolorize(template.to_s(as_single_line: true))
         end
 
         protected
 
-        def add_extra_after_expected
+        def add_extra_after_expected_to(template)
         end
 
         def add_extra_after_error
@@ -45,7 +55,14 @@ def expected_color
 
         private
 
-        attr_reader :expected, :actual, :expected_action, :template
+        attr_reader(
+          :actual,
+          :expected_for_failure_message,
+          :expected_for_description,
+          :expected_action_for_failure_message,
+          :expected_action_for_description,
+          :template,
+        )
 
         def negated?
           @negated
@@ -55,7 +72,7 @@ def fill_template
           add_actual_section
           template.add_break
           template.insert expected_section
-          add_extra_after_expected
+          add_extra_after_expected_to(template)
           template.add_text_in_singleline_mode "."
           add_extra_after_error
         end
@@ -83,17 +100,33 @@ def expected_section
             t.add_text_in_multiline_mode do
               expected_phrase.to_s.rjust(phrase_width)
             end
-            add_expected_value_to(t)
+            add_expected_value_to_failure_message(t)
           end
         end
 
-        def add_expected_value_to(template)
-          template.add_text " "
-          template.add_text_in_color(expected_color, expected)
+        def add_expected_value_to_failure_message(template)
+          if respond_to?(:add_expected_value_to, true)
+            add_expected_value_to(template, expected_for_failure_message)
+          else
+            template.add_text " "
+            template.add_text_in_color(
+              expected_color,
+              expected_for_failure_message,
+            )
+          end
+        end
+
+        def add_expected_value_to_description(template)
+          if respond_to?(:add_expected_value_to, true)
+            add_expected_value_to(template, expected_for_description)
+          else
+            template.add_text " "
+            template.add_text_in_color(expected_color, expected_for_description)
+          end
         end
 
         def expected_phrase
-          "#{to_or_not_to} #{expected_action}"
+          "#{to_or_not_to} #{expected_action_for_failure_message}"
         end
 
         def to_or_not_to

lib/super_diff/rspec/matcher_text_builders/be_predicate.rb

@@ -14,18 +14,9 @@ def initialize(
           @expected_predicate_method_name = expected_predicate_method_name
         end
 
-        def matcher_description
-          template = MatcherTextTemplate.new do |t|
-            t.add_text "return true for"
-            add_expected_value_to(t)
-          end
-
-          Csi.decolorize(template.to_s(as_single_line: true))
-        end
-
         protected
 
-        def expected_action
+        def expected_action_for_failure_message
           if predicate_accessible?
             "return true for"
           elsif private_predicate?
@@ -49,7 +40,7 @@ def expected_color
           :magenta
         end
 
-        def add_expected_value_to(template)
+        def add_expected_value_to(template, expected)
           template.add_text " "
           template.add_text_in_color(expected_color, "`#{expected}?`")
           template.add_text " or "

lib/super_diff/rspec/matcher_text_builders/contain_exactly.rb

@@ -4,7 +4,7 @@ module MatcherTextBuilders
       class ContainExactly < Base
         protected
 
-        def add_expected_value_to(template)
+        def add_expected_value_to(template, expected)
           template.add_text " "
           template.add_list_in_color(expected_color, expected)
         end

lib/super_diff/rspec/matcher_text_builders/respond_to.rb

@@ -18,24 +18,24 @@ def initialize(
 
         protected
 
-        def add_expected_value_to(template)
+        def add_expected_value_to(template, expected)
           template.add_text " "
           template.add_list_in_color(expected_color, expected)
         end
 
-        def add_extra_after_expected
+        def add_extra_after_expected_to(template)
           if expected_arity
-            add_arity_clause
+            add_arity_clause_to(template)
           end
 
           if arbitrary_keywords?
-            add_arbitrary_keywords_clause
+            add_arbitrary_keywords_clause_to(template)
           elsif has_expected_keywords?
-            add_keywords_clause
+            add_keywords_clause_to(template)
           end
 
           if unlimited_arguments?
-            add_unlimited_arguments_clause
+            add_unlimited_arguments_clause_to(template)
           end
         end
 
@@ -55,27 +55,27 @@ def unlimited_arguments?
           @unlimited_arguments
         end
 
-        def add_arity_clause
+        def add_arity_clause_to(template)
           template.add_text " with "
           template.add_text_in_color :red, expected_arity
           template.add_text " "
           template.add_text pluralize("argument", expected_arity)
         end
 
-        def add_arbitrary_keywords_clause
+        def add_arbitrary_keywords_clause_to(template)
           template.add_text " with "
           template.add_text_in_color :red, "any"
           template.add_text " keywords"
         end
 
-        def add_keywords_clause
+        def add_keywords_clause_to(template)
           template.add_text " with "
           template.add_text pluralize("keyword", expected_keywords.length)
           template.add_text " "
           template.add_list_in_color :red, expected_keywords
         end
 
-        def add_unlimited_arguments_clause
+        def add_unlimited_arguments_clause_to(template)
           if arbitrary_keywords? || has_expected_keywords?
             template.add_text " and "
           else