Support be_* matcher (and its variants)

Author: mcmire

lib/super_diff/rspec/augmented_matcher.rb

@@ -4,7 +4,7 @@ module AugmentedMatcher
       # Update to use expected_for_description instead of @expected
       # TODO: Test
       def description
-        failure_message_builder.matcher_description
+        failure_message_template_builder.matcher_description
       end
 
       # Colorize the 'actual' value
@@ -42,7 +42,7 @@ def failure_message_template_builder
           failure_message_template_builder_class.new(
             actual: actual_for_failure_message,
             expected: expected_for_failure_message,
-            description_as_phrase: description_as_phrase,
+            expected_action: expected_action,
           )
       end
 
@@ -52,7 +52,7 @@ def failure_message_template_builder_class
 
       private
 
-      def description_as_phrase
+      def expected_action
         ::RSpec::Matchers::EnglishPhrasing.split_words(self.class.matcher_name)
       end
 

lib/super_diff/rspec/failure_message_builders.rb

@@ -2,6 +2,10 @@ module SuperDiff
   module RSpec
     module FailureMessageBuilders
       autoload :Base, "super_diff/rspec/failure_message_builders/base"
+      autoload(
+        :BePredicate,
+        "super_diff/rspec/failure_message_builders/be_predicate",
+      )
       autoload(
         :ContainExactly,
         "super_diff/rspec/failure_message_builders/contain_exactly",

lib/super_diff/rspec/failure_message_builders/base.rb

@@ -2,11 +2,12 @@ module SuperDiff
   module RSpec
     module FailureMessageBuilders
       class Base
-        def initialize(actual:, expected:, description_as_phrase:)
+        def initialize(actual:, expected:, expected_action:)
           @actual = actual
           @expected = expected
-          @description_as_phrase = description_as_phrase
+          @expected_action = expected_action
 
+          @negated = nil
           @template = FailureMessageTemplate.new
         end
 
@@ -18,12 +19,20 @@ def call(negated:)
         end
 
         def matcher_description
-          Csi.decolorize(expected_section.to_s(as_single_line: true))
+          template = FailureMessageTemplate.new do |t|
+            t.add_text expected_action
+            add_expected_value_to(t)
+          end
+
+          Csi.decolorize(template.to_s(as_single_line: true))
         end
 
         protected
 
-        def add_extra
+        def add_extra_after_expected
+        end
+
+        def add_extra_after_error
         end
 
         def actual_color
@@ -36,7 +45,7 @@ def expected_color
 
         private
 
-        attr_reader :expected, :actual, :description_as_phrase, :template
+        attr_reader :expected, :actual, :expected_action, :template
 
         def negated?
           @negated
@@ -46,8 +55,9 @@ def fill_template
           add_actual_section
           template.add_break
           template.insert expected_section
-          add_extra
+          add_extra_after_expected
           template.add_text_in_singleline_mode "."
+          add_extra_after_error
         end
 
         def add_actual_section
@@ -71,23 +81,19 @@ def expected_section
           FailureMessageTemplate.new do |t|
             t.add_text_in_singleline_mode expected_phrase
             t.add_text_in_multiline_mode do
-              if phrase_width
-                expected_phrase.to_s.rjust(phrase_width)
-              else
-                expected_phrase
-              end
+              expected_phrase.to_s.rjust(phrase_width)
             end
-            t.add_text " "
             add_expected_value_to(t)
           end
         end
 
-        def expected_phrase
-          "#{to_or_not_to} #{description_as_phrase}"
+        def add_expected_value_to(template)
+          template.add_text " "
+          template.add_text_in_color(expected_color, expected)
         end
 
-        def add_expected_value_to(template)
-          template.add_text_in_color(expected_color) { expected }
+        def expected_phrase
+          "#{to_or_not_to} #{expected_action}"
         end
 
         def to_or_not_to

lib/super_diff/rspec/failure_message_builders/be_predicate.rb

@@ -0,0 +1,91 @@
+module SuperDiff
+  module RSpec
+    module FailureMessageBuilders
+      class BePredicate < Base
+        def initialize(
+          predicate_accessible:,
+          private_predicate:,
+          expected_predicate_method_name:,
+          **rest
+        )
+          super(**rest)
+          @predicate_accessible = predicate_accessible
+          @private_predicate = private_predicate
+          @expected_predicate_method_name = expected_predicate_method_name
+        end
+
+        def matcher_description
+          template = FailureMessageTemplate.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
+          if predicate_accessible?
+            "return true for"
+          elsif private_predicate?
+            "have a public method"
+          else
+            "respond to"
+          end
+        end
+
+        def actual_color
+          :yellow
+        end
+
+        def add_actual_value
+          template.add_text_in_color(actual_color) do
+            description_of(actual)
+          end
+        end
+
+        def expected_color
+          :magenta
+        end
+
+        def add_expected_value_to(template)
+          template.add_text " "
+          template.add_text_in_color(expected_color, "`#{expected}?`")
+          template.add_text " or "
+          template.add_text_in_color(expected_color, "`#{expected}s?`")
+        end
+
+        def add_extra_after_error
+          if expected_predicate_method_name == :true?
+            template.add_text "\n\n"
+            template.add_text "(Perhaps you want to use "
+            template.add_text_in_color(:blue, "`be(true)`")
+            template.add_text " or "
+            template.add_text_in_color(:blue, "`be_truthy`")
+            template.add_text " instead?)"
+          elsif expected_predicate_method_name == :false?
+            template.add_text "\n\n"
+            template.add_text "(Perhaps you want to use "
+            template.add_text_in_color(:blue, "`be(false)`")
+            template.add_text " or "
+            template.add_text_in_color(:blue, "`be_falsey`")
+            template.add_text " instead?)"
+          end
+        end
+
+        private
+
+        attr_reader :expected_predicate_method_name
+
+        def predicate_accessible?
+          @predicate_accessible
+        end
+
+        def private_predicate?
+          @private_predicate
+        end
+      end
+    end
+  end
+end

lib/super_diff/rspec/failure_message_builders/contain_exactly.rb

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

lib/super_diff/rspec/failure_message_builders/respond_to.rb

@@ -19,10 +19,11 @@ def initialize(
         protected
 
         def add_expected_value_to(template)
+          template.add_text " "
           template.add_list_in_color(expected_color, expected)
         end
 
-        def add_extra
+        def add_extra_after_expected
           if expected_arity
             add_arity_clause
           end

lib/super_diff/rspec/failure_message_template.rb

@@ -43,14 +43,17 @@ def insert(*args, &block)
         add_token(Insertion, *args, &block)
       end
 
-      def length
-        tokens.sum(&:length)
+      def length_of_first_paragraph
+        Csi.decolorize(to_string_in_singleline_mode).
+          split(/\n\n/).
+          first.
+          length
       end
 
       def to_s(as_single_line: nil)
-        if length > MAX_LINE_LENGTH || as_single_line == false
+        if length_of_first_paragraph > MAX_LINE_LENGTH || as_single_line == false
           to_string_in_multiline_mode
-        elsif length <= MAX_LINE_LENGTH || as_single_line == true
+        elsif length_of_first_paragraph <= MAX_LINE_LENGTH || as_single_line == true
           to_string_in_singleline_mode
         end
       end