super_diff 0.10.0 → 0.12.1

data/lib/super_diff/equality_matchers/default.rb

@@ -18,14 +18,14 @@ module SuperDiff
       protected
 
       def expected_line
-        Helpers.style(
+        Core::Helpers.style(
           :expected,
           "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
         )
       end
 
       def actual_line
-        Helpers.style(
+        Core::Helpers.style(
           :actual,
           "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
         )
@@ -45,7 +45,12 @@ module SuperDiff
       end
 
       def diff
-        Differs::Main.call(expected, actual, indent_level: 0)
+        SuperDiff.diff(
+          expected,
+          actual,
+          indent_level: 0,
+          raise_if_nothing_applies: false
+        )
       end
     end
   end

data/lib/super_diff/equality_matchers/hash.rb

@@ -10,13 +10,13 @@ module SuperDiff
           Differing hashes.
 
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :expected,
             "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
           )
         }
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :actual,
             "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
           )
@@ -31,7 +31,7 @@ module SuperDiff
       protected
 
       def diff
-        Differs::Hash.call(expected, actual, indent_level: 0)
+        Basic::Differs::Hash.call(expected, actual, indent_level: 0)
       end
     end
   end

data/lib/super_diff/equality_matchers/multiline_string.rb

@@ -11,13 +11,13 @@ module SuperDiff
 
           #{
           # TODO: This whole thing should not be red or green, just the values
-          Helpers.style(
+          Core::Helpers.style(
             :expected,
             "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
           )
         }
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :actual,
             "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
           )
@@ -32,7 +32,7 @@ module SuperDiff
       private
 
       def diff
-        Differs::MultilineString.call(expected, actual, indent_level: 0)
+        Basic::Differs::MultilineString.call(expected, actual, indent_level: 0)
       end
     end
   end

data/lib/super_diff/equality_matchers/primitive.rb

@@ -8,16 +8,16 @@ module SuperDiff
 
       def fail
         <<~OUTPUT.strip
-          Differing #{Helpers.plural_type_for(actual)}.
+          Differing #{Core::Helpers.plural_type_for(actual)}.
 
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :expected,
             "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
           )
         }
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :actual,
             "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
           )

data/lib/super_diff/equality_matchers/singleline_string.rb

@@ -10,13 +10,13 @@ module SuperDiff
           Differing strings.
 
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :expected,
             "Expected: " + SuperDiff.inspect_object(expected, as_lines: false)
           )
         }
           #{
-          Helpers.style(
+          Core::Helpers.style(
             :actual,
             "  Actual: " + SuperDiff.inspect_object(actual, as_lines: false)
           )

data/lib/super_diff/errors.rb

@@ -1,16 +1,16 @@
 module SuperDiff
   module Errors
-    autoload(
-      :NoDiffFormatterAvailableError,
-      "super_diff/errors/no_diff_formatter_available_error"
-    )
-    autoload(
-      :NoDifferAvailableError,
-      "super_diff/errors/no_differ_available_error"
-    )
-    autoload(
-      :NoOperationTreeBuilderAvailableError,
-      "super_diff/errors/no_operation_tree_builder_available_error"
-    )
+    def self.const_missing(missing_const_name)
+      if Core.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::Errors::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end

data/lib/super_diff/object_inspection.rb

@@ -1,18 +1,67 @@
 module SuperDiff
   module ObjectInspection
-    autoload :InspectionTree, "super_diff/object_inspection/inspection_tree"
-    autoload(
-      :InspectionTreeBuilders,
-      "super_diff/object_inspection/inspection_tree_builders"
-    )
-    autoload :Nodes, "super_diff/object_inspection/nodes"
-    autoload(
-      :PrefixForNextNode,
-      "super_diff/object_inspection/prefix_for_next_node"
-    )
-    autoload(
-      :PreludeForNextNode,
-      "super_diff/object_inspection/prelude_for_next_node"
-    )
+    module InspectionTreeBuilders
+      def self.const_missing(missing_const_name)
+        if missing_const_name == :Base
+          warn <<~EOT
+            WARNING: SuperDiff::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+            Please use SuperDiff::Core::AbstractInspectionTreeBuilder instead.
+            #{caller_locations.join("\n")}
+          EOT
+          Core::AbstractInspectionTreeBuilder
+        elsif Basic::InspectionTreeBuilders.const_defined?(missing_const_name)
+          warn <<~EOT
+          WARNING: SuperDiff::ObjectInspection::InspectionTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Basic::InspectionTreeBuilders::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+          Basic::InspectionTreeBuilders.const_get(missing_const_name)
+        else
+          super
+        end
+      end
+    end
+
+    module Nodes
+      def self.const_missing(missing_const_name)
+        if Core::InspectionTreeNodes.const_defined?(missing_const_name)
+          warn <<~EOT
+            WARNING: SuperDiff::ObjectInspection::Nodes::#{missing_const_name} is deprecated and will be removed in the next major release.
+            Please use SuperDiff::Core::InspectionTreeNodes::#{missing_const_name} instead.
+            #{caller_locations.join("\n")}
+          EOT
+          Core::InspectionTreeNodes.const_get(missing_const_name)
+        else
+          super
+        end
+      end
+    end
+
+    def self.const_missing(missing_const_name)
+      if missing_const_name == :PrefixForNextNode
+        warn <<~EOT
+          WARNING: SuperDiff::ObjectInspection::PrefixForNextNode is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::PrefixForNextInspectionTreeNode instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core::PrefixForNextInspectionTreeNode
+      elsif missing_const_name == :PreludeForNextNode
+        warn <<~EOT
+          WARNING: SuperDiff::ObjectInspection::PreludeForNextNode is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::PreludeForNextInspectionTreeNode instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core::PreludeForNextInspectionTreeNode
+      elsif Core.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::ObjectInspection::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end

data/lib/super_diff/operation_tree_builders.rb

@@ -1,18 +1,23 @@
 module SuperDiff
   module OperationTreeBuilders
-    autoload :Array, "super_diff/operation_tree_builders/array"
-    autoload :Base, "super_diff/operation_tree_builders/base"
-    autoload :CustomObject, "super_diff/operation_tree_builders/custom_object"
-    autoload :DefaultObject, "super_diff/operation_tree_builders/default_object"
-    autoload :Hash, "super_diff/operation_tree_builders/hash"
-    autoload :Main, "super_diff/operation_tree_builders/main"
-    # TODO: Where is this used?
-    autoload(
-      :MultilineString,
-      "super_diff/operation_tree_builders/multiline_string"
-    )
-    autoload :TimeLike, "super_diff/operation_tree_builders/time_like"
+    def self.const_missing(missing_const_name)
+      if missing_const_name == :Base
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::AbstractOperationTreeBuilder instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core::AbstractOperationTreeBuilder
+      elsif Basic::OperationTreeBuilders.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTreeBuilders::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Basic::OperationTreeBuilders::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Basic::OperationTreeBuilders.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end
-
-require "super_diff/operation_tree_builders/defaults"

data/lib/super_diff/operation_tree_flatteners.rb

@@ -1,20 +1,23 @@
 module SuperDiff
   module OperationTreeFlatteners
-    autoload :Array, "super_diff/operation_tree_flatteners/array"
-    autoload :Base, "super_diff/operation_tree_flatteners/base"
-    autoload :Collection, "super_diff/operation_tree_flatteners/collection"
-    autoload(
-      :CustomObject,
-      "super_diff/operation_tree_flatteners/custom_object"
-    )
-    autoload(
-      :DefaultObject,
-      "super_diff/operation_tree_flatteners/default_object"
-    )
-    autoload :Hash, "super_diff/operation_tree_flatteners/hash"
-    autoload(
-      :MultilineString,
-      "super_diff/operation_tree_flatteners/multiline_string"
-    )
+    def self.const_missing(missing_const_name)
+      if missing_const_name == :Base
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTreeFlatteners::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::AbstractOperationTreeFlattener instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core::AbstractOperationTreeFlattener
+      elsif Basic::OperationTreeFlatteners.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTreeFlatteners::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Basic::OperationTreeFlatteners::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Basic::OperationTreeFlatteners.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end

data/lib/super_diff/operation_trees.rb

@@ -1,13 +1,23 @@
 module SuperDiff
   module OperationTrees
-    autoload :Array, "super_diff/operation_trees/array"
-    autoload :Base, "super_diff/operation_trees/base"
-    autoload :CustomObject, "super_diff/operation_trees/custom_object"
-    autoload :DefaultObject, "super_diff/operation_trees/default_object"
-    autoload :Hash, "super_diff/operation_trees/hash"
-    autoload :Main, "super_diff/operation_trees/main"
-    autoload :MultilineString, "super_diff/operation_trees/multiline_string"
+    def self.const_missing(missing_const_name)
+      if missing_const_name == :Base
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTrees::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::AbstractOperationTree instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core::AbstractOperationTree
+      elsif Basic::OperationTrees.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::OperationTrees::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Basic::OperationTrees::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Basic::OperationTrees.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end
-
-require "super_diff/operation_trees/defaults"

data/lib/super_diff/operations.rb

@@ -1,6 +1,16 @@
 module SuperDiff
   module Operations
-    autoload :BinaryOperation, "super_diff/operations/binary_operation"
-    autoload :UnaryOperation, "super_diff/operations/unary_operation"
+    def self.const_missing(missing_const_name)
+      if Core.const_defined?(missing_const_name)
+        warn <<~EOT
+          WARNING: SuperDiff::Operations::#{missing_const_name} is deprecated and will be removed in the next major release.
+          Please use SuperDiff::Core::#{missing_const_name} instead.
+          #{caller_locations.join("\n")}
+        EOT
+        Core.const_get(missing_const_name)
+      else
+        super
+      end
+    end
   end
 end

data/lib/super_diff/rspec/augmented_matcher.rb

@@ -35,7 +35,7 @@ module SuperDiff
       end
 
       def matcher_text_builder_class
-        RSpec::MatcherTextBuilders::Base
+        MatcherTextBuilders::Base
       end
 
       def matcher_text_builder_args

data/lib/super_diff/rspec/differ.rb

@@ -7,13 +7,12 @@ module SuperDiff
 
       def diff
         if worth_diffing?
-          diff =
-            SuperDiff::Differs::Main.call(expected, actual, omit_empty: true)
+          diff = SuperDiff.diff(expected, actual)
           "\n\n" + diff
         else
           ""
         end
-      rescue SuperDiff::Errors::NoDifferAvailableError
+      rescue Core::NoDifferAvailableError
         ""
       end
 
@@ -39,10 +38,10 @@ module SuperDiff
       end
 
       def helpers
-        @_helpers ||= Helpers.new
+        @_helpers ||= RSpecHelpers.new
       end
 
-      class Helpers
+      class RSpecHelpers
         include ::RSpec::Matchers::Composable
 
         public :values_match?

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module Differs
-      class CollectionContainingExactly < SuperDiff::Differs::Array
+      class CollectionContainingExactly < Basic::Differs::Array
         def self.applies_to?(expected, actual)
           SuperDiff::RSpec.a_collection_containing_exactly_something?(
             expected

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module Differs
-      class CollectionIncluding < SuperDiff::Differs::Array
+      class CollectionIncluding < Basic::Differs::Array
         def self.applies_to?(expected, actual)
           (
             SuperDiff::RSpec.a_collection_including_something?(expected) ||

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module Differs
-      class HashIncluding < SuperDiff::Differs::Hash
+      class HashIncluding < Basic::Differs::Hash
         def self.applies_to?(expected, actual)
           (
             SuperDiff::RSpec.a_hash_including_something?(expected) ||

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

@@ -1,7 +1,7 @@
 module SuperDiff
   module RSpec
     module Differs
-      class ObjectHavingAttributes < SuperDiff::Differs::DefaultObject
+      class ObjectHavingAttributes < Basic::Differs::DefaultObject
         def self.applies_to?(expected, _actual)
           SuperDiff::RSpec.an_object_having_some_attributes?(expected)
         end

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

@@ -0,0 +1,34 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class CollectionContainingExactly < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.a_collection_containing_exactly_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<a collection containing exactly ("
+              end
+
+            # stree-ignore
+            t1.nested do |t2|
+                t2.insert_array_inspection_of(object.expected)
+              end
+
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/collection_including.rb

@@ -0,0 +1,40 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class CollectionIncluding < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::RSpec.a_collection_including_something?(value) ||
+            SuperDiff::RSpec.array_including_something?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t2|
+                t2.add_text "#<a collection including ("
+              end
+
+            t1.nested do |t2|
+              if SuperDiff::RSpec.a_collection_including_something?(object)
+                t2.insert_array_inspection_of(object.expecteds)
+              else
+                t2.insert_array_inspection_of(
+                  object.instance_variable_get(:@expected)
+                )
+              end
+            end
+
+            # stree-ignore
+            t1.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t2|
+                t2.add_text ")>"
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/double.rb

@@ -0,0 +1,100 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class Double < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          value.is_a?(::RSpec::Mocks::Double)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            t1.only_when method(:empty?) do |t2|
+              t2.as_lines_when_rendering_to_lines do |t3|
+                t3.add_text("#<#{inspected_class} #{inspected_name}>")
+              end
+            end
+
+            t1.only_when method(:nonempty?) do |t2|
+              t2.as_lines_when_rendering_to_lines(
+                collection_bookend: :open
+              ) do |t3|
+                t3.add_text("#<#{inspected_class} #{inspected_name}")
+
+                # stree-ignore
+                t3.when_rendering_to_lines do |t4|
+                    t4.add_text " {"
+                  end
+              end
+
+              # stree-ignore
+              t2.when_rendering_to_string do |t3|
+                  t3.add_text " "
+                end
+
+              # stree-ignore
+              t2.nested do |t3|
+                  t3.insert_hash_inspection_of doubled_methods
+                end
+
+              t2.as_lines_when_rendering_to_lines(
+                collection_bookend: :close
+              ) do |t3|
+                # stree-ignore
+                t3.when_rendering_to_lines do |t4|
+                    t4.add_text "}"
+                  end
+
+                t3.add_text ">"
+              end
+            end
+          end
+        end
+
+        private
+
+        def empty?
+          doubled_methods.empty?
+        end
+
+        def nonempty?
+          !empty?
+        end
+
+        def inspected_class
+          case object
+          when ::RSpec::Mocks::InstanceVerifyingDouble
+            "InstanceDouble"
+          when ::RSpec::Mocks::ClassVerifyingDouble
+            "ClassDouble"
+          when ::RSpec::Mocks::ObjectVerifyingDouble
+            "ObjectDouble"
+          else
+            "Double"
+          end
+        end
+
+        def inspected_name
+          if object.instance_variable_get("@name")
+            object.instance_variable_get("@name").inspect
+          else
+            "(anonymous)"
+          end
+        end
+
+        def doubled_methods
+          @_doubled_methods ||=
+            doubled_method_names.reduce({}) do |hash, key|
+              hash.merge(key => object.public_send(key))
+            end
+        end
+
+        def doubled_method_names
+          object
+            .__send__(:__mock_proxy)
+            .instance_variable_get("@method_doubles")
+            .keys
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/rspec/inspection_tree_builders/generic_describable_matcher.rb

@@ -0,0 +1,17 @@
+module SuperDiff
+  module RSpec
+    module InspectionTreeBuilders
+      class GenericDescribableMatcher < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          ::RSpec::Matchers.is_a_describable_matcher?(value)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            t1.add_text "#<#{object.description}>"
+          end
+        end
+      end
+    end
+  end
+end