super_diff 0.6.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be7fd08d833b19c6a99401a1c7b80c448903c315d198b09e55baf70ee663dcfc
-  data.tar.gz: ea79d7bb6469e711058b71716c9ce1a23d6353381a8ae876c6bb180a57e78e2a
+  metadata.gz: 3338e91a7e03a6c0447a56b0c612653bd8f56f27a95ebeba081546dea8fdc7da
+  data.tar.gz: c840b79a7dd98e31cce823df4bdb67b704dec07ae340c889c86d38bae735ea41
 SHA512:
-  metadata.gz: 75a1258f1d15d4a830a89ad898cefed4d6379d012fd7aa50d61f82672f10d0acacbf32e88177970fe46afa977dbce42c30212194867eefa1a72eb874417a1156
-  data.tar.gz: eb40c7881a21263fc89c6c2cfd1e54c5277449f98a32fb266bc720c43177772480d9834b61c4614102c236942d46ffcea82bc4e5090ad5f70dfc6d15f1d9e184
+  metadata.gz: 78535779a6e462100afb0ec019ea0b1241e5f6710c40005150d3d8784d34227dc0b549de20fe3dbbc453b6563903df78fc21925701f8d5c7f0d3d466c8345641
+  data.tar.gz: 5a049b0606ae5ff5ac18978e8591ede3edcdcecf6e48eb58ced6655527b481bf2f4a17623c981b902c5ea86295e3dc9bd633905502113edbc162724edd475389

data/README.md

@@ -202,7 +202,6 @@ SuperDiff.configure do |config|
   config.add_extra_differ_class(YourDiffer)
   config.add_extra_operation_tree_builder_class(YourOperationTreeBuilder)
   config.add_extra_operation_tree_class(YourOperationTree)
-  config.add_extra_diff_formatter_class(YourDiffFormatter)
 end
 ```
 

data/lib/super_diff/active_record/differs/active_record_relation.rb

@@ -7,20 +7,10 @@ module SuperDiff
             actual.is_a?(::ActiveRecord::Relation)
         end
 
-        def call
-          DiffFormatters::ActiveRecordRelation.call(
-            operation_tree,
-            indent_level: indent_level,
-          )
-        end
-
-        private
+        protected
 
-        def operation_tree
-          OperationTreeBuilders::ActiveRecordRelation.call(
-            expected: expected,
-            actual: actual,
-          )
+        def operation_tree_builder_class
+          OperationTreeBuilders::ActiveRecordRelation
         end
       end
     end

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

@@ -1,44 +1,43 @@
 module SuperDiff
   module ActiveRecord
     module ObjectInspection
-      module Inspectors
-        class ActiveRecordModel < SuperDiff::ObjectInspection::Inspectors::Base
+      module InspectionTreeBuilders
+        class ActiveRecordModel < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
             value.is_a?(::ActiveRecord::Base)
           end
 
-          protected
-
-          def inspection_tree
+          def call
             SuperDiff::ObjectInspection::InspectionTree.new do
-              add_text do |object|
-                "#<#{object.class} "
-              end
+              as_lines_when_rendering_to_lines(collection_bookend: :open) do
+                add_text do |object|
+                  "#<#{object.class} "
+                end
 
-              when_multiline do
-                add_text "{"
+                when_rendering_to_lines do
+                  add_text "{"
+                end
               end
 
               nested do |object|
-                add_break
-
                 insert_separated_list(
                   ["id"] + (object.attributes.keys.sort - ["id"]),
-                  separator: ",",
                 ) do |name|
-                  add_text name
-                  add_text ": "
+                  as_prefix_when_rendering_to_lines do
+                    add_text "#{name}: "
+                  end
+
                   add_inspection_of object.read_attribute(name)
                 end
               end
 
-              add_break
+              as_lines_when_rendering_to_lines(collection_bookend: :close) do
+                when_rendering_to_lines do
+                  add_text "}"
+                end
 
-              when_multiline do
-                add_text "}"
+                add_text ">"
               end
-
-              add_text ">"
             end
           end
         end

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

@@ -1,24 +1,25 @@
 module SuperDiff
   module ActiveRecord
     module ObjectInspection
-      module Inspectors
-        class ActiveRecordRelation < SuperDiff::ObjectInspection::Inspectors::Base
+      module InspectionTreeBuilders
+        class ActiveRecordRelation < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
           def self.applies_to?(value)
             value.is_a?(::ActiveRecord::Relation)
           end
 
-          protected
-
-          def inspection_tree
+          def call
             SuperDiff::ObjectInspection::InspectionTree.new do
-              add_text "#<ActiveRecord::Relation ["
+              as_lines_when_rendering_to_lines(collection_bookend: :open) do
+                add_text "#<ActiveRecord::Relation ["
+              end
 
               nested do |array|
                 insert_array_inspection_of(array)
               end
 
-              add_break
-              add_text "]>"
+              as_lines_when_rendering_to_lines(collection_bookend: :close) do
+                add_text "]>"
+              end
             end
           end
         end

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

@@ -0,0 +1,16 @@
+module SuperDiff
+  module ActiveRecord
+    module ObjectInspection
+      module InspectionTreeBuilders
+        autoload(
+          :ActiveRecordModel,
+          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_model",
+        )
+        autoload(
+          :ActiveRecordRelation,
+          "super_diff/active_record/object_inspection/inspection_tree_builders/active_record_relation",
+        )
+      end
+    end
+  end
+end

data/lib/super_diff/active_record/object_inspection.rb

@@ -2,12 +2,8 @@ module SuperDiff
   module ActiveRecord
     module ObjectInspection
       autoload(
-        :Inspectors,
-        "super_diff/active_record/object_inspection/inspectors",
-      )
-      autoload(
-        :MapExtension,
-        "super_diff/active_record/object_inspection/map_extension",
+        :InspectionTreeBuilders,
+        "super_diff/active_record/object_inspection/inspection_tree_builders",
       )
     end
   end

data/lib/super_diff/active_record/operation_tree_flatteners/active_record_relation.rb

@@ -0,0 +1,17 @@
+module SuperDiff
+  module ActiveRecord
+    module OperationTreeFlatteners
+      class ActiveRecordRelation < SuperDiff::OperationTreeFlatteners::Collection
+        protected
+
+        def open_token
+          "#<ActiveRecord::Relation ["
+        end
+
+        def close_token
+          "]>"
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/active_record/operation_tree_flatteners.rb

@@ -0,0 +1,10 @@
+module SuperDiff
+  module ActiveRecord
+    module OperationTreeFlatteners
+      autoload(
+        :ActiveRecordRelation,
+        "super_diff/active_record/operation_tree_flatteners/active_record_relation",
+      )
+    end
+  end
+end

data/lib/super_diff/active_record/operation_trees/active_record_relation.rb

@@ -2,13 +2,14 @@ module SuperDiff
   module ActiveRecord
     module OperationTrees
       class ActiveRecordRelation < SuperDiff::OperationTrees::Array
-        def to_diff(indent_level:, collection_prefix:, add_comma:)
-          DiffFormatters::ActiveRecordRelation.call(
-            self,
-            indent_level: indent_level,
-            collection_prefix: collection_prefix,
-            add_comma: add_comma,
-          )
+        def self.applies_to?(value)
+          value.is_a?(ActiveRecord::Relation)
+        end
+
+        protected
+
+        def operation_tree_flattener_class
+          OperationTreeFlatteners::ActiveRecordRelation
         end
       end
     end

data/lib/super_diff/active_record.rb

@@ -2,7 +2,6 @@ require "super_diff/active_support"
 
 module SuperDiff
   module ActiveRecord
-    autoload :DiffFormatters, "super_diff/active_record/diff_formatters"
     autoload :Differs, "super_diff/active_record/differs"
     autoload(
       :ObjectInspection,
@@ -16,6 +15,10 @@ module SuperDiff
       :OperationTreeBuilders,
       "super_diff/active_record/operation_tree_builders",
     )
+    autoload(
+      :OperationTreeFlatteners,
+      "super_diff/active_record/operation_tree_flatteners",
+    )
 
     SuperDiff.configure do |config|
       config.add_extra_differ_classes(
@@ -25,12 +28,9 @@ module SuperDiff
         OperationTreeBuilders::ActiveRecordModel,
         OperationTreeBuilders::ActiveRecordRelation,
       )
-      config.add_extra_diff_formatter_classes(
-        DiffFormatters::ActiveRecordRelation,
-      )
-      config.add_extra_inspector_classes(
-        ObjectInspection::Inspectors::ActiveRecordModel,
-        ObjectInspection::Inspectors::ActiveRecordRelation,
+      config.add_extra_inspection_tree_builder_classes(
+        ObjectInspection::InspectionTreeBuilders::ActiveRecordModel,
+        ObjectInspection::InspectionTreeBuilders::ActiveRecordRelation,
       )
     end
   end

data/lib/super_diff/active_support/differs/hash_with_indifferent_access.rb

@@ -13,20 +13,10 @@ module SuperDiff
           )
         end
 
-        def call
-          DiffFormatters::HashWithIndifferentAccess.call(
-            operation_tree,
-            indent_level: indent_level,
-          )
-        end
+        protected
 
-        private
-
-        def operation_tree
-          OperationTreeBuilders::HashWithIndifferentAccess.call(
-            expected: expected,
-            actual: actual,
-          )
+        def operation_tree_builder_class
+          OperationTreeBuilders::HashWithIndifferentAccess
         end
       end
     end

data/lib/super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access.rb

@@ -0,0 +1,37 @@
+module SuperDiff
+  module ActiveSupport
+    module ObjectInspection
+      module InspectionTreeBuilders
+        class HashWithIndifferentAccess < SuperDiff::ObjectInspection::InspectionTreeBuilders::Base
+          def self.applies_to?(value)
+            value.is_a?(::HashWithIndifferentAccess)
+          end
+
+          def call
+            SuperDiff::ObjectInspection::InspectionTree.new do
+              as_lines_when_rendering_to_lines(collection_bookend: :open) do
+                add_text "#<HashWithIndifferentAccess {"
+              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/active_support/object_inspection/{inspectors.rb → inspection_tree_builders.rb}

@@ -1,10 +1,10 @@
 module SuperDiff
   module ActiveSupport
     module ObjectInspection
-      module Inspectors
+      module InspectionTreeBuilders
         autoload(
           :HashWithIndifferentAccess,
-          "super_diff/active_support/object_inspection/inspectors/hash_with_indifferent_access",
+          "super_diff/active_support/object_inspection/inspection_tree_builders/hash_with_indifferent_access",
         )
       end
     end

data/lib/super_diff/active_support/object_inspection.rb

@@ -2,12 +2,8 @@ module SuperDiff
   module ActiveSupport
     module ObjectInspection
       autoload(
-        :Inspectors,
-        "super_diff/active_support/object_inspection/inspectors",
-      )
-      autoload(
-        :MapExtension,
-        "super_diff/active_support/object_inspection/map_extension",
+        :InspectionTreeBuilders,
+        "super_diff/active_support/object_inspection/inspection_tree_builders",
       )
     end
   end

data/lib/super_diff/active_support/operation_tree_builders/hash_with_indifferent_access.rb

@@ -2,6 +2,17 @@ module SuperDiff
   module ActiveSupport
     module OperationTreeBuilders
       class HashWithIndifferentAccess < SuperDiff::OperationTreeBuilders::Hash
+        def self.applies_to?(expected, actual)
+          (
+            expected.is_a?(::HashWithIndifferentAccess) &&
+              actual.is_a?(::Hash)
+          ) ||
+          (
+            expected.is_a?(::Hash) &&
+              actual.is_a?(::HashWithIndifferentAccess)
+          )
+        end
+
         def initialize(expected:, actual:, **rest)
           super
 
@@ -15,6 +26,12 @@ module SuperDiff
             @actual = actual.to_h
           end
         end
+
+        protected
+
+        def build_operation_tree
+          OperationTrees::HashWithIndifferentAccess.new([])
+        end
       end
     end
   end

data/lib/super_diff/active_support/operation_tree_flatteners/hash_with_indifferent_access.rb

@@ -0,0 +1,17 @@
+module SuperDiff
+  module ActiveSupport
+    module OperationTreeFlatteners
+      class HashWithIndifferentAccess < SuperDiff::OperationTreeFlatteners::Hash
+        protected
+
+        def open_token
+          "#<HashWithIndifferentAccess {"
+        end
+
+        def close_token
+          "}>"
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/active_support/operation_tree_flatteners.rb

@@ -0,0 +1,10 @@
+module SuperDiff
+  module ActiveSupport
+    module OperationTreeFlatteners
+      autoload(
+        :HashWithIndifferentAccess,
+        "super_diff/active_support/operation_tree_flatteners/hash_with_indifferent_access",
+      )
+    end
+  end
+end

data/lib/super_diff/active_support/operation_trees/hash_with_indifferent_access.rb

@@ -2,13 +2,10 @@ module SuperDiff
   module ActiveSupport
     module OperationTrees
       class HashWithIndifferentAccess < SuperDiff::OperationTrees::Base
-        def to_diff(indent_level:, collection_prefix:, add_comma:)
-          DiffFormatters::HashWithIndifferentAccess.call(
-            self,
-            indent_level: indent_level,
-            collection_prefix: collection_prefix,
-            add_comma: add_comma,
-          )
+        protected
+
+        def operation_tree_flattener_class
+          OperationTreeFlatteners::HashWithIndifferentAccess
         end
       end
     end

data/lib/super_diff/active_support.rb

@@ -1,15 +1,18 @@
 module SuperDiff
   module ActiveSupport
-    autoload :DiffFormatters, "super_diff/active_support/diff_formatters"
     autoload :Differs, "super_diff/active_support/differs"
     autoload :ObjectInspection, "super_diff/active_support/object_inspection"
+    autoload(
+      :OperationTrees,
+      "super_diff/active_support/operation_trees",
+    )
     autoload(
       :OperationTreeBuilders,
       "super_diff/active_support/operation_tree_builders",
     )
     autoload(
-      :OperationalSequences,
-      "super_diff/active_support/operational_sequences",
+      :OperationTreeFlatteners,
+      "super_diff/active_support/operation_tree_flatteners",
     )
 
     SuperDiff.configure do |config|
@@ -19,11 +22,8 @@ module SuperDiff
       config.add_extra_operation_tree_builder_classes(
         OperationTreeBuilders::HashWithIndifferentAccess,
       )
-      config.add_extra_diff_formatter_classes(
-        DiffFormatters::HashWithIndifferentAccess,
-      )
-      config.add_extra_inspector_classes(
-        ObjectInspection::Inspectors::HashWithIndifferentAccess,
+      config.add_extra_inspection_tree_builder_classes(
+        ObjectInspection::InspectionTreeBuilders::HashWithIndifferentAccess,
       )
     end
   end

data/lib/super_diff/colorized_document_extensions.rb

@@ -6,12 +6,15 @@ module SuperDiff
       end
     end
 
-    def expected(*args, **opts, &block)
-      colorize(*args, **opts, fg: SuperDiff.configuration.expected_color, &block)
-    end
-
-    def actual(*args, **opts, &block)
-      colorize(*args, **opts, fg: SuperDiff.configuration.actual_color, &block)
+    [:actual, :border, :elision_marker, :expected, :header].each do |method_name|
+      define_method(method_name) do |*args, **opts, &block|
+        colorize(
+          *args,
+          **opts,
+          fg: SuperDiff.configuration.public_send("#{method_name}_color"),
+          &block
+        )
+      end
     end
   end
 end

data/lib/super_diff/configuration.rb

@@ -3,27 +3,74 @@ module SuperDiff
     attr_reader(
       :extra_diff_formatter_classes,
       :extra_differ_classes,
-      :extra_inspector_classes,
+      :extra_inspection_tree_builder_classes,
       :extra_operation_tree_builder_classes,
       :extra_operation_tree_classes,
     )
     attr_accessor(
       :actual_color,
       :border_color,
+      :diff_elision_enabled,
+      :diff_elision_maximum,
+      :elision_marker_color,
       :expected_color,
       :header_color,
     )
 
-    def initialize
+    def initialize(options = {})
       @actual_color = :yellow
       @border_color = :blue
+      @color_enabled = color_enabled_by_default?
+      @diff_elision_enabled = false
+      @diff_elision_maximum = 0
+      @elision_marker_color = :cyan
       @expected_color = :magenta
       @extra_diff_formatter_classes = [].freeze
       @extra_differ_classes = [].freeze
-      @extra_inspector_classes = [].freeze
+      @extra_inspection_tree_builder_classes = [].freeze
       @extra_operation_tree_builder_classes = [].freeze
       @extra_operation_tree_classes = [].freeze
       @header_color = :white
+
+      merge!(options)
+    end
+
+    def initialize_dup(original)
+      super
+      @extra_differ_classes = original.extra_differ_classes.dup.freeze
+      @extra_operation_tree_builder_classes =
+        original.extra_operation_tree_builder_classes.dup.freeze
+      @extra_operation_tree_classes =
+        original.extra_operation_tree_classes.dup.freeze
+      @extra_inspection_tree_builder_classes =
+        original.extra_inspection_tree_builder_classes.dup.freeze
+    end
+
+    def color_enabled?
+      @color_enabled
+    end
+
+    def diff_elision_enabled?
+      @diff_elision_enabled
+    end
+
+    def merge!(configuration_or_options)
+      options =
+        if configuration_or_options.is_a?(self.class)
+          configuration_or_options.to_h
+        else
+          configuration_or_options
+        end
+
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      updated
+    end
+
+    def updated
+      SuperDiff::Csi.color_enabled = color_enabled?
     end
 
     def add_extra_diff_formatter_classes(*classes)
@@ -40,13 +87,13 @@ module SuperDiff
     end
     alias_method :add_extra_differ_class, :add_extra_differ_classes
 
-    def add_extra_inspector_classes(*classes)
-      @extra_inspector_classes =
-        (@extra_inspector_classes + classes).freeze
+    def add_extra_inspection_tree_builder_classes(*classes)
+      @extra_inspection_tree_builder_classes =
+        (@extra_inspection_tree_builder_classes + classes).freeze
     end
     alias_method(
-      :add_extra_inspector_class,
-      :add_extra_inspector_classes,
+      :add_extra_inspection_tree_builder_class,
+      :add_extra_inspection_tree_builder_classes,
     )
 
     def add_extra_operation_tree_builder_classes(*classes)
@@ -66,5 +113,31 @@ module SuperDiff
       :add_extra_operation_tree_class,
       :add_extra_operation_tree_classes,
     )
+
+    def to_h
+      {
+        actual_color: actual_color,
+        border_color: border_color,
+        color_enabled: color_enabled?,
+        diff_elision_enabled: diff_elision_enabled?,
+        diff_elision_maximum: diff_elision_maximum,
+        elision_marker_color: elision_marker_color,
+        expected_color: expected_color,
+        extra_diff_formatter_classes: extra_diff_formatter_classes.dup,
+        extra_differ_classes: extra_differ_classes.dup,
+        extra_inspection_tree_builder_classes:
+          extra_inspection_tree_builder_classes.dup,
+        extra_operation_tree_builder_classes:
+          extra_operation_tree_builder_classes.dup,
+        extra_operation_tree_classes: extra_operation_tree_classes.dup,
+        header_color: header_color,
+      }
+    end
+
+    private
+
+    def color_enabled_by_default?
+      ENV["CI"] == "true" || $stdout.respond_to?(:tty?) && $stdout.tty?
+    end
   end
 end

data/lib/super_diff/csi/four_bit_color.rb

@@ -87,8 +87,6 @@ module SuperDiff
       def interpret_sequence!(sequence)
         match = sequence.match(OPENING_REGEX)
 
-        # binding.pry
-
         if match
           interpret_code!(match[1].to_i)
         end

data/lib/super_diff/csi.rb

@@ -58,7 +58,6 @@ module SuperDiff
         end
     end
 
-    self.color_enabled = ENV["CI"] == "true" || STDOUT.tty?
-    # puts "(SuperDiff::Csi) Super::Csi.color_enabled: #{color_enabled?}"
+    self.color_enabled = false
   end
 end

data/lib/super_diff/differs/array.rb

@@ -5,7 +5,7 @@ module SuperDiff
         expected.is_a?(::Array) && actual.is_a?(::Array)
       end
 
-      private
+      protected
 
       def operation_tree_builder_class
         OperationTreeBuilders::Array