super_diff 0.5.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5427cb2217992c9dffd57826837caaa750ddcd422625498c3bca9cf40ae8e32
-  data.tar.gz: 540a3e3ea47bc98c4abf45ff6ff216563f70f1492bb2c06a54525b6414b306ae
+  metadata.gz: 7d1ad189acadc1bcdf4ad4e63ca6b9d946b7a66f8d1544887389d7f093153b31
+  data.tar.gz: f96fb6488cf55e679b3ce8953c26eea0a5c5c6113c35dc30c7d19eb5e3b65ae2
 SHA512:
-  metadata.gz: 1bf06c03ce556532384242e0193628bae55134e3edf65003e1d0b7a1015e25af6f9ce68bd23a7ca2ebadddb0093103a643f9bb742116d2456f20146bb948f380
-  data.tar.gz: c32489d6915ac9f7fc3cf1c0427683977b3a569a99e36a7d8e47f1209e74efcf3f86b3986b1e40ed51d2321d89f1e8530bdda79352c1d53fd94798370f2261de
+  metadata.gz: 5eaeee5249d8cc865ff1fbef12b0c306607bba7f0224ac906c8bbfac0ad4cc196660fed461a3efcbdd69a557cb8dc7aca925351bd9acae5761d4af25d7bac19e
+  data.tar.gz: 0bdd31dada209126940d0e55c1a3b0970b1c17b8c22eecb685aa59ea518bb28456b902bd81256a4b13132d3c9ad88cd115dabe1a1796edd90afeee65568a0c74

data/README.md

@@ -1,8 +1,8 @@
-# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![IssueHunt][issuehunt-badge]][issuehunt]
+# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][gh-actions-badge]][gh-actions] ![Downloads][downloads-badge] [![IssueHunt][issuehunt-badge]][issuehunt]
 
 [version-badge]: http://img.shields.io/gem/v/super_diff.svg
 [rubygems]: http://rubygems.org/gems/super_diff
-[travis-badge]: http://img.shields.io/travis/mcmire/super_diff/master.svg
+[gh-actions-badge]: http://img.shields.io/github/workflow/status/mcmire/super_diff/SuperDiff/master
 [downloads-badge]: http://img.shields.io/gem/dtv/super_diff.svg
 [hound]: https://houndci.com
 [issuehunt-badge]: https://img.shields.io/badge/sponsored_through-IssueHunt-2EC28C
@@ -155,30 +155,56 @@ require "super_diff/rspec"
 
 ## Configuration
 
-As capable as this library is,
-it doesn't know how to deal with every kind of object out there.
-If you have a custom class,
-and instances of your class aren't appearing in diffs like you like,
-you might find it necessary to instruct the gem on how to handle them.
-In that case
-you would add something like this to your test helper file
-(`rails_helper` or `spec_helper`):
+You can customize the behavior of the gem
+by adding a configuration block
+to your test helper file
+(`rails_helper` or `spec_helper`)
+which looks something like this:
+
+``` ruby
+SuperDiff.configure do |config|
+  # ...
+end
+```
+
+### Customizing colors
+
+If you don't like the colors that SuperDiff uses,
+you can change them like this:
+
+``` ruby
+SuperDiff.configure do |config|
+  config.actual_color = :green
+  config.expected_color = :red
+  config.border_color = :yellow
+  config.header_color = :yellow
+end
+```
+
+See [eight_bit_color.rb](lib/super_diff/csi/eight_bit_color.rb)
+for the list of available colors.
+
+### Diffing custom objects
+
+If you are comparing two data structures
+that involve a class that is specific to your project,
+the resulting diff may not look as good as diffs involving native or primitive objects.
+This happens because if SuperDiff doesn't recognize a class,
+it will fall back to a generic representation when diffing instances of that class.
+Fortunately, the gem has a pluggable interface
+that allows you to insert your own implementations
+of key pieces involved in the diffing process.
+I'll have more about how that works soon,
+but here is what such a configuration would look like:
 
 ``` ruby
 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
 ```
 
-*(More info here in the future on adding a custom differ,
-operation tree builder,
-operation tree,
-and diff formatter.
-Also explanations on what these are.)*
-
 ## Support
 
 My goal for this library is to improve your development experience.
@@ -204,12 +230,12 @@ I'll get notified right away!
 
 ## Compatibility
 
-`super_diff` is [tested][travis] to work with
+`super_diff` is [tested][gh-actions] to work with
 Ruby >= 2.5.x,
 RSpec 3.x,
 and Rails >= 5.x.
 
-[travis]: http://travis-ci.org/mcmire/super_diff
+[gh-actions]: https://github.com/mcmire/super_diff/actions?query=workflow%3ASuperDiff
 
 ## Inspiration/Thanks
 
@@ -232,5 +258,5 @@ Thank you to the authors of these libraries!
 
 ## Author/License
 
-`super_diff` was created and is maintained by Elliot Winkler.
+SuperDiff was created and is maintained by Elliot Winkler.
 It is released under the [MIT license](LICENSE).

data/lib/super_diff.rb

@@ -7,39 +7,78 @@ module SuperDiff
     :ColorizedDocumentExtensions,
     "super_diff/colorized_document_extensions",
   )
+  autoload :OperationTreeFlatteners, "super_diff/operation_tree_flatteners"
   autoload :Configuration, "super_diff/configuration"
   autoload :Csi, "super_diff/csi"
   autoload :DiffFormatters, "super_diff/diff_formatters"
   autoload :Differs, "super_diff/differs"
   autoload :EqualityMatchers, "super_diff/equality_matchers"
   autoload :Errors, "super_diff/errors"
+  autoload :GemVersion, "super_diff/gem_version"
   autoload :Helpers, "super_diff/helpers"
   autoload :ImplementationChecks, "super_diff/implementation_checks"
+  autoload :Line, "super_diff/line"
+  autoload :TieredLines, "super_diff/tiered_lines"
+  autoload :TieredLinesElider, "super_diff/tiered_lines_elider"
+  autoload :TieredLinesFormatter, "super_diff/tiered_lines_formatter"
   autoload :ObjectInspection, "super_diff/object_inspection"
   autoload :OperationTrees, "super_diff/operation_trees"
   autoload :OperationTreeBuilders, "super_diff/operation_tree_builders"
   autoload :Operations, "super_diff/operations"
   autoload :RecursionGuard, "super_diff/recursion_guard"
 
-  COLORS = {
-    alpha: :magenta,
-    beta: :yellow,
-    border: :blue,
-    header: :white,
-  }.freeze
-
   def self.configure
     yield configuration
+    configuration.updated
   end
 
   def self.configuration
     @_configuration ||= Configuration.new
   end
 
+  def self.inspect_object(object, as_lines:, **rest)
+    SuperDiff::RecursionGuard.guarding_recursion_of(object) do
+      inspection_tree = ObjectInspection::InspectionTreeBuilders::Main.call(
+        object
+      )
+
+      if as_lines
+        inspection_tree.render_to_lines(object, **rest)
+      else
+        inspection_tree.render_to_string(object)
+      end
+    end
+  end
+
   def self.time_like?(value)
     # Check for ActiveSupport's #acts_like_time? for their time-like objects
     # (like ActiveSupport::TimeWithZone).
     (value.respond_to?(:acts_like_time?) && value.acts_like_time?) ||
       value.is_a?(Time)
   end
+
+  def self.primitive?(value)
+    case value
+    when true, false, nil, Symbol, Numeric, Regexp, Class
+      true
+    else
+      false
+    end
+  end
+
+  def self.insert_overrides(target_module, mod = nil, &block)
+    if mod
+      target_module.prepend(mod)
+    else
+      target_module.prepend(Module.new(&block))
+    end
+  end
+
+  def self.insert_singleton_overrides(target_module, mod = nil, &block)
+    if mod
+      target_module.singleton_class.prepend(mod)
+    else
+      target_module.singleton_class.prepend(Module.new(&block))
+    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_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.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/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/{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/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_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_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