super_diff 0.1.0 → 0.2.0

data/lib/super_diff/rspec/differs.rb

@@ -0,0 +1,13 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      autoload(
+        :CollectionContainingExactly,
+        "super_diff/rspec/differs/collection_containing_exactly",
+      )
+      autoload :PartialArray, "super_diff/rspec/differs/partial_array"
+      autoload :PartialHash, "super_diff/rspec/differs/partial_hash"
+      autoload :PartialObject, "super_diff/rspec/differs/partial_object"
+    end
+  end
+end

data/lib/super_diff/rspec/differs/collection_containing_exactly.rb

@@ -0,0 +1,23 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class CollectionContainingExactly < SuperDiff::Differs::Array
+        def self.applies_to?(expected, actual)
+          SuperDiff::RSpec.collection_containing_exactly?(expected) &&
+            actual.is_a?(::Array)
+        end
+
+        private
+
+        def operations
+          OperationalSequencers::CollectionContainingExactly.call(
+            expected: expected,
+            actual: actual,
+            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
+            extra_diff_formatter_classes: extra_diff_formatter_classes,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/differs/partial_array.rb

@@ -0,0 +1,22 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class PartialArray < SuperDiff::Differs::Array
+        def self.applies_to?(expected, actual)
+          SuperDiff::RSpec.partial_array?(expected) && actual.is_a?(::Array)
+        end
+
+        private
+
+        def operations
+          OperationalSequencers::PartialArray.call(
+            expected: expected,
+            actual: actual,
+            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
+            extra_diff_formatter_classes: extra_diff_formatter_classes,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/differs/partial_hash.rb

@@ -0,0 +1,22 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class PartialHash < SuperDiff::Differs::Hash
+        def self.applies_to?(expected, actual)
+          SuperDiff::RSpec.partial_hash?(expected) && actual.is_a?(::Hash)
+        end
+
+        private
+
+        def operations
+          OperationalSequencers::PartialHash.call(
+            expected: expected,
+            actual: actual,
+            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
+            extra_diff_formatter_classes: extra_diff_formatter_classes,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/differs/partial_object.rb

@@ -0,0 +1,22 @@
+module SuperDiff
+  module RSpec
+    module Differs
+      class PartialObject < SuperDiff::Differs::DefaultObject
+        def self.applies_to?(expected, _actual)
+          SuperDiff::RSpec.partial_object?(expected)
+        end
+
+        private
+
+        def operations
+          OperationalSequencers::PartialObject.call(
+            expected: expected,
+            actual: actual,
+            extra_operational_sequencer_classes: extra_operational_sequencer_classes,
+            extra_diff_formatter_classes: extra_diff_formatter_classes,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders.rb

@@ -0,0 +1,24 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      autoload :Base, "super_diff/rspec/matcher_text_builders/base"
+      autoload(
+        :BePredicate,
+        "super_diff/rspec/matcher_text_builders/be_predicate",
+      )
+      autoload(
+        :ContainExactly,
+        "super_diff/rspec/matcher_text_builders/contain_exactly",
+      )
+      autoload :Match, "super_diff/rspec/matcher_text_builders/match"
+      autoload(
+        :RaiseError,
+        "super_diff/rspec/matcher_text_builders/raise_error",
+      )
+      autoload(
+        :RespondTo,
+        "super_diff/rspec/matcher_text_builders/respond_to",
+      )
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders/base.rb

@@ -0,0 +1,155 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class Base
+        def initialize(
+          actual:,
+          expected_for_failure_message:,
+          expected_for_description:,
+          expected_action_for_failure_message:,
+          expected_action_for_description:
+        )
+          @actual = actual
+          @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
+        end
+
+        def call(negated:)
+          @negated = negated
+
+          fill_template
+          template.to_s
+        end
+
+        def matcher_description
+          template = MatcherTextTemplate.new do |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_to(template)
+        end
+
+        def add_extra_after_error
+        end
+
+        def beta_color
+          SuperDiff::COLORS.fetch(:beta)
+        end
+
+        def alpha_color
+          SuperDiff::COLORS.fetch(:alpha)
+        end
+
+        private
+
+        attr_reader(
+          :actual,
+          :expected_for_failure_message,
+          :expected_for_description,
+          :expected_action_for_failure_message,
+          :expected_action_for_description,
+          :template,
+        )
+
+        def negated?
+          @negated
+        end
+
+        def fill_template
+          add_actual_section
+          template.add_break
+          template.insert expected_section
+          add_extra_after_expected_to(template)
+          template.add_text_in_singleline_mode "."
+          add_extra_after_error
+        end
+
+        def add_actual_section
+          template.add_text_in_singleline_mode actual_phrase
+          template.add_text_in_multiline_mode do
+            actual_phrase.rjust(phrase_width)
+          end
+          template.add_text " "
+          add_actual_value
+        end
+
+        def actual_phrase
+          "Expected"
+        end
+
+        def add_actual_value
+          template.add_text_in_color(beta_color) { actual }
+        end
+
+        def expected_section
+          MatcherTextTemplate.new do |t|
+            t.add_text_in_singleline_mode expected_phrase
+            t.add_text_in_multiline_mode do
+              expected_phrase.to_s.rjust(phrase_width)
+            end
+            add_expected_value_to_failure_message(t)
+          end
+        end
+
+        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(
+              alpha_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(alpha_color, expected_for_description)
+          end
+        end
+
+        def expected_phrase
+          "#{to_or_not_to} #{expected_action_for_failure_message}"
+        end
+
+        def to_or_not_to
+          if negated?
+            "not to"
+          else
+            "to"
+          end
+        end
+
+        def phrase_width
+          [actual_phrase, expected_phrase].
+            map { |text| Csi.decolorize(text.to_s).length }.
+            max
+        end
+
+        # TODO: Should this be applied to expected and actual automatically
+        # instead of expecting the caller to pass in already formatted versions
+        # of those objects?
+        def description_of(object)
+          ::RSpec::Support::ObjectFormatter.format(object)
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders/be_predicate.rb

@@ -0,0 +1,78 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      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
+
+        protected
+
+        def expected_action_for_failure_message
+          if predicate_accessible?
+            "return a truthy result for"
+          elsif private_predicate?
+            "have a public method"
+          else
+            "respond to"
+          end
+        end
+
+        def beta_color
+          :yellow
+        end
+
+        def add_actual_value
+          template.add_text_in_color(beta_color) do
+            description_of(actual)
+          end
+        end
+
+        def add_expected_value_to(template, expected)
+          template.add_text " "
+          template.add_text_in_color(alpha_color, "`#{expected}?`")
+          template.add_text " or "
+          template.add_text_in_color(alpha_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

data/lib/super_diff/rspec/matcher_text_builders/contain_exactly.rb

@@ -0,0 +1,14 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class ContainExactly < Base
+        protected
+
+        def add_expected_value_to(template, expected)
+          template.add_text " "
+          template.add_list_in_color(alpha_color, expected)
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders/match.rb

@@ -0,0 +1,23 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class Match < Base
+        def initialize(expected_captures:, **rest)
+          super(rest)
+          @expected_captures = expected_captures
+        end
+
+        def add_extra
+          if expected_captures
+            template.add_text "with captures "
+            template.add_text_in_color :blue, description_of(expected_captures)
+          end
+        end
+
+        private
+
+        attr_reader :expected_captures
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders/raise_error.rb

@@ -0,0 +1,13 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class RaiseError < Base
+        protected
+
+        def actual_phrase
+          "Expected raised exception"
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/matcher_text_builders/respond_to.rb

@@ -0,0 +1,99 @@
+module SuperDiff
+  module RSpec
+    module MatcherTextBuilders
+      class RespondTo < Base
+        def initialize(
+          expected_arity:,
+          arbitrary_keywords:,
+          expected_keywords:,
+          unlimited_arguments:,
+          **rest
+        )
+          super(rest)
+          @expected_arity = expected_arity
+          @arbitrary_keywords = arbitrary_keywords
+          @expected_keywords = expected_keywords
+          @unlimited_arguments = unlimited_arguments
+        end
+
+        protected
+
+        def add_expected_value_to(template, expected)
+          template.add_text " "
+          template.add_list_in_color(alpha_color, expected)
+        end
+
+        def add_extra_after_expected_to(template)
+          if expected_arity
+            add_arity_clause_to(template)
+          end
+
+          if arbitrary_keywords?
+            add_arbitrary_keywords_clause_to(template)
+          elsif has_expected_keywords?
+            add_keywords_clause_to(template)
+          end
+
+          if unlimited_arguments?
+            add_unlimited_arguments_clause_to(template)
+          end
+        end
+
+        private
+
+        attr_reader :expected_arity, :expected_keywords
+
+        def arbitrary_keywords?
+          @arbitrary_keywords
+        end
+
+        def has_expected_keywords?
+          expected_keywords && expected_keywords.count > 0
+        end
+
+        def unlimited_arguments?
+          @unlimited_arguments
+        end
+
+        def add_arity_clause_to(template)
+          template.add_text " with "
+          template.add_text_in_color alpha_color, expected_arity
+          template.add_text " "
+          template.add_text pluralize("argument", expected_arity)
+        end
+
+        def add_arbitrary_keywords_clause_to(template)
+          template.add_text " with "
+          template.add_text_in_color alpha_color, "any"
+          template.add_text " keywords"
+        end
+
+        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 alpha_color, expected_keywords
+        end
+
+        def add_unlimited_arguments_clause_to(template)
+          if arbitrary_keywords? || has_expected_keywords?
+            template.add_text " and "
+          else
+            template.add_text " with "
+          end
+
+          template.add_text_in_color alpha_color, "unlimited"
+          template.add_text " arguments"
+        end
+
+        def pluralize(word, count)
+          if count == 1
+            word
+          else
+            "#{word}s"
+          end
+        end
+      end
+    end
+  end
+end