super_diff 0.5.3 → 0.8.0

data/lib/super_diff/object_inspection/inspection_tree_builders/custom_object.rb

@@ -0,0 +1,37 @@
+module SuperDiff
+  module ObjectInspection
+    module InspectionTreeBuilders
+      class CustomObject < Base
+        def self.applies_to?(value)
+          value.respond_to?(:attributes_for_super_diff)
+        end
+
+        def call
+          InspectionTree.new do
+            as_lines_when_rendering_to_lines(collection_bookend: :open) do
+              add_text do |object|
+                "#<#{object.class} "
+              end
+
+              when_rendering_to_lines do
+                add_text "{"
+              end
+            end
+
+            nested do |object|
+              insert_hash_inspection_of(object.attributes_for_super_diff)
+            end
+
+            as_lines_when_rendering_to_lines(collection_bookend: :close) do
+              when_rendering_to_lines do
+                add_text "}"
+              end
+
+              add_text ">"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/inspection_tree_builders/default_object.rb

@@ -0,0 +1,63 @@
+module SuperDiff
+  module ObjectInspection
+    module InspectionTreeBuilders
+      class DefaultObject < Base
+        def self.applies_to?(_value)
+          true
+        end
+
+        def call
+          empty = -> { object.instance_variables.empty? }
+          nonempty = -> { !object.instance_variables.empty? }
+
+          InspectionTree.new do
+            only_when empty do
+              as_lines_when_rendering_to_lines do
+                add_text do |object|
+                  "#<#{object.class.name}:" +
+                    SuperDiff::Helpers.object_address_for(object) +
+                    ">"
+                end
+              end
+            end
+
+            only_when nonempty do
+              as_lines_when_rendering_to_lines(collection_bookend: :open) do
+                add_text do |object|
+                  "#<#{object.class.name}:" +
+                    SuperDiff::Helpers.object_address_for(object)
+                end
+
+                when_rendering_to_lines do
+                  add_text " {"
+                end
+              end
+
+              when_rendering_to_string do
+                add_text " "
+              end
+
+              nested do |object|
+                insert_separated_list(object.instance_variables.sort) do |name|
+                  as_prefix_when_rendering_to_lines do
+                    add_text "#{name}="
+                  end
+
+                  add_inspection_of object.instance_variable_get(name)
+                end
+              end
+
+              as_lines_when_rendering_to_lines(collection_bookend: :close) do
+                when_rendering_to_lines do
+                  add_text "}"
+                end
+
+                add_text ">"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/{inspectors → inspection_tree_builders}/defaults.rb

@@ -1,12 +1,11 @@
 module SuperDiff
   module ObjectInspection
-    module Inspectors
+    module InspectionTreeBuilders
       DEFAULTS = [
         CustomObject,
         Array,
         Hash,
         Primitive,
-        String,
         TimeLike,
         DefaultObject,
       ].freeze

data/lib/super_diff/object_inspection/inspection_tree_builders/hash.rb

@@ -0,0 +1,46 @@
+module SuperDiff
+  module ObjectInspection
+    module InspectionTreeBuilders
+      class Hash < Base
+        def self.applies_to?(value)
+          value.is_a?(::Hash)
+        end
+
+        def call
+          empty = -> { object.empty? }
+          nonempty = -> { !object.empty? }
+
+          InspectionTree.new do
+            only_when empty do
+              as_lines_when_rendering_to_lines do
+                add_text "{}"
+              end
+            end
+
+            only_when nonempty do
+              as_lines_when_rendering_to_lines(collection_bookend: :open) do
+                add_text "{"
+              end
+
+              when_rendering_to_string do
+                add_text " "
+              end
+
+              nested do |hash|
+                insert_hash_inspection_of(hash)
+              end
+
+              when_rendering_to_string do
+                add_text " "
+              end
+
+              as_lines_when_rendering_to_lines(collection_bookend: :close) do
+                add_text "}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/{inspectors → inspection_tree_builders}/main.rb

@@ -1,18 +1,14 @@
 module SuperDiff
   module ObjectInspection
-    module Inspectors
+    module InspectionTreeBuilders
       class Main
         extend AttrExtras.mixin
 
-        method_object :object, [:as_single_line!, :indent_level!]
+        method_object :object
 
         def call
           if resolved_class
-            resolved_class.call(
-              object,
-              as_single_line: as_single_line?,
-              indent_level: indent_level,
-            )
+            resolved_class.call(object)
           else
             raise NoInspectorAvailableError.create(object)
           end
@@ -20,14 +16,13 @@ module SuperDiff
 
         private
 
-        attr_query :as_single_line?
-
         def resolved_class
           available_classes.find { |klass| klass.applies_to?(object) }
         end
 
         def available_classes
-          SuperDiff.configuration.extra_inspector_classes + DEFAULTS
+          SuperDiff.configuration.extra_inspection_tree_builder_classes +
+            DEFAULTS
         end
       end
     end

data/lib/super_diff/object_inspection/inspection_tree_builders/primitive.rb

@@ -0,0 +1,21 @@
+module SuperDiff
+  module ObjectInspection
+    module InspectionTreeBuilders
+      class Primitive < Base
+        def self.applies_to?(value)
+          SuperDiff.primitive?(value) || value.is_a?(::String)
+        end
+
+        def call
+          InspectionTree.new do
+            as_lines_when_rendering_to_lines do
+              # rubocop:disable Style/SymbolProc
+              add_text { |object| object.inspect }
+              # rubocop:enable Style/SymbolProc
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/inspection_tree_builders/time_like.rb

@@ -0,0 +1,64 @@
+module SuperDiff
+  module ObjectInspection
+    module InspectionTreeBuilders
+      class TimeLike < Base
+        def self.applies_to?(value)
+          SuperDiff.time_like?(value)
+        end
+
+        def call
+          InspectionTree.new do
+            as_lines_when_rendering_to_lines(collection_bookend: :open) do
+              add_text do |time|
+                "#<#{time.class} "
+              end
+
+              when_rendering_to_lines do
+                add_text "{"
+              end
+            end
+
+            when_rendering_to_string do
+              add_text do |time|
+                time.strftime("%Y-%m-%d %H:%M:%S") +
+                  (time.subsec == 0 ? "" : "+#{time.subsec.inspect}") +
+                  " " + time.strftime("%:z") +
+                  (time.zone ? " (#{time.zone})" : "")
+              end
+            end
+
+            when_rendering_to_lines do
+              nested do |time|
+                insert_separated_list(
+                  [
+                    :year,
+                    :month,
+                    :day,
+                    :hour,
+                    :min,
+                    :sec,
+                    :subsec,
+                    :zone,
+                    :utc_offset
+                  ]
+                ) do |name|
+                  add_text name.to_s
+                  add_text ": "
+                  add_inspection_of time.public_send(name)
+                end
+              end
+            end
+
+            as_lines_when_rendering_to_lines(collection_bookend: :close) do
+              when_rendering_to_lines do
+                add_text "}"
+              end
+
+              add_text ">"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/object_inspection/nodes.rb

@@ -1,48 +1,49 @@
 module SuperDiff
   module ObjectInspection
     module Nodes
-      autoload :Base, "super_diff/object_inspection/nodes/base"
-      autoload :Break, "super_diff/object_inspection/nodes/break"
-      autoload :Inspection, "super_diff/object_inspection/nodes/inspection"
-      autoload :Nesting, "super_diff/object_inspection/nodes/nesting"
-      autoload :Text, "super_diff/object_inspection/nodes/text"
       autoload(
-        :WhenEmpty,
-        "super_diff/object_inspection/nodes/when_empty",
+        :AsLinesWhenRenderingToLines,
+        "super_diff/object_inspection/nodes/as_lines_when_rendering_to_lines",
       )
       autoload(
-        :WhenMultiline,
-        "super_diff/object_inspection/nodes/when_multiline",
+        :AsPrefixWhenRenderingToLines,
+        "super_diff/object_inspection/nodes/as_prefix_when_rendering_to_lines",
       )
       autoload(
-        :WhenNonEmpty,
-        "super_diff/object_inspection/nodes/when_non_empty",
+        :AsPreludeWhenRenderingToLines,
+        "super_diff/object_inspection/nodes/as_prelude_when_rendering_to_lines",
       )
       autoload(
-        :WhenSingleline,
-        "super_diff/object_inspection/nodes/when_singleline",
+        :AsSingleLine,
+        "super_diff/object_inspection/nodes/as_single_line",
+      )
+      autoload :Base, "super_diff/object_inspection/nodes/base"
+      autoload :Inspection, "super_diff/object_inspection/nodes/inspection"
+      autoload :Nesting, "super_diff/object_inspection/nodes/nesting"
+      autoload :OnlyWhen, "super_diff/object_inspection/nodes/only_when"
+      autoload :Text, "super_diff/object_inspection/nodes/text"
+      autoload(
+        :WhenRenderingToLines,
+        "super_diff/object_inspection/nodes/when_rendering_to_lines",
+      )
+      autoload(
+        :WhenRenderingToString,
+        "super_diff/object_inspection/nodes/when_rendering_to_string",
       )
-
-      def self.fetch(type)
-        registry.fetch(type) do
-          raise(
-            KeyError,
-            "#{type.inspect} is not included in ObjectInspection::Nodes.registry!",
-          )
-        end
-      end
 
       def self.registry
-        @_registry ||= {
-          break: Break,
-          inspection: Inspection,
-          nesting: Nesting,
-          text: Text,
-          when_empty: WhenEmpty,
-          when_multiline: WhenMultiline,
-          when_non_empty: WhenNonEmpty,
-          when_singleline: WhenSingleline,
-        }
+        @_registry ||= [
+          AsLinesWhenRenderingToLines,
+          AsPrefixWhenRenderingToLines,
+          AsPreludeWhenRenderingToLines,
+          AsSingleLine,
+          Inspection,
+          Nesting,
+          OnlyWhen,
+          Text,
+          WhenRenderingToLines,
+          WhenRenderingToString,
+        ]
       end
     end
   end

data/lib/super_diff/object_inspection/nodes/as_lines_when_rendering_to_lines.rb

@@ -0,0 +1,97 @@
+module SuperDiff
+  module ObjectInspection
+    module Nodes
+      class AsLinesWhenRenderingToLines < Base
+        def self.node_name
+          :as_lines_when_rendering_to_lines
+        end
+
+        def self.method_name
+          :as_lines_when_rendering_to_lines
+        end
+
+        def initialize(
+          tree,
+          *args,
+          add_comma: false,
+          collection_bookend: nil,
+          **rest
+        )
+          super(tree, *args, **rest)
+
+          @add_comma = add_comma
+          @collection_bookend = collection_bookend
+        end
+
+        def render_to_string(object)
+          # TODO: This happens a lot, can we simplify this?
+          string =
+            if block
+              render_to_string_in_subtree(object)
+            else
+              immediate_value.to_s
+            end
+
+          if add_comma?
+            string + ","
+          else
+            string
+          end
+        end
+
+        def render_to_lines(object, type:, indentation_level:)
+          lines =
+            if block
+              render_to_lines_in_subtree(
+                object,
+                type: type,
+                indentation_level: indentation_level,
+                disallowed_node_names: [
+                  :line,
+                  :as_lines_when_rendering_to_lines,
+                ],
+              )
+            else
+              [
+                SuperDiff::Line.new(
+                  type: type,
+                  indentation_level: indentation_level,
+                  value: immediate_value.to_s,
+                ),
+              ]
+            end
+
+          with_collection_bookend_added_to_last_line_in(
+            with_add_comma_added_to_last_line_in(lines),
+          )
+        end
+
+        private
+
+        attr_reader :collection_bookend
+
+        def add_comma?
+          @add_comma
+        end
+
+        def with_collection_bookend_added_to_last_line_in(lines)
+          if collection_bookend
+            lines[0..-2] + [
+              lines[-1].clone_with(collection_bookend: collection_bookend),
+            ]
+          else
+            lines
+          end
+        end
+
+        def with_add_comma_added_to_last_line_in(lines)
+          if add_comma?
+            lines[0..-2] + [lines[-1].clone_with(add_comma: add_comma?)]
+          else
+            lines
+          end
+        end
+      end
+    end
+  end
+end