super_diff 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bdda657427ecef6cf2c8d65b9485b73da6c1ab64dbc0f608ce185028ca8bd6a
-  data.tar.gz: 7476633c6bf06aee6087fc9156743ac56d83507380f44b2236e6c32710088d9f
+  metadata.gz: be7fd08d833b19c6a99401a1c7b80c448903c315d198b09e55baf70ee663dcfc
+  data.tar.gz: ea79d7bb6469e711058b71716c9ce1a23d6353381a8ae876c6bb180a57e78e2a
 SHA512:
-  metadata.gz: 45059e4f3d8932f71d6a7f76afe1694e20687a453a9bacb82b1bc0e7c4ed4ec3fc5db20639a9d799b718761a1f053787ed83a867e9adba1d661cc0c03e26b06d
-  data.tar.gz: 7efd5ddfd5e753e569ba126eb214657250234c4e3968a92cd6e87ca01907dcb6feb71aaa5491b7938f38e8a7a634355ece2533fb7a30252e4ad93613f5e0eb2e
+  metadata.gz: 75a1258f1d15d4a830a89ad898cefed4d6379d012fd7aa50d61f82672f10d0acacbf32e88177970fe46afa977dbce42c30212194867eefa1a72eb874417a1156
+  data.tar.gz: eb40c7881a21263fc89c6c2cfd1e54c5277449f98a32fb266bc720c43177772480d9834b61c4614102c236942d46ffcea82bc4e5090ad5f70dfc6d15f1d9e184

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
@@ -11,7 +11,7 @@
 SuperDiff is a gem that hooks into RSpec
 to intelligently display the differences between two data structures of any type.
 
-📢 **[See what's changed in recent versions.][changelog].**
+📢 **[See what's changed in recent versions.][changelog]**
 
 [changelog]: CHANGELOG.md
 
@@ -155,14 +155,47 @@ 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|
@@ -173,12 +206,6 @@ SuperDiff.configure do |config|
 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.
@@ -199,17 +226,17 @@ Please see the [contributing](./CONTRIBUTING.md) document for more on how to do
 If there's a change you want implemented, you can choose to sponsor that change!
 `super_diff` is set up on IssueHunt,
 so feel free to search for an existing issue (or make your own)
-and [add a bounty](https://issuehunt.io/r/mcmire/super_diff/issues).
+and [add a bounty](https://issuehunt.io/r/mcmire/super_diff).
 I'll get notified right away!
 
 ## Compatibility
 
-`super_diff` is [tested][travis] to work with
-Ruby >= 2.4.x,
+`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 +259,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

@@ -13,6 +13,7 @@ module SuperDiff
   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 :ObjectInspection, "super_diff/object_inspection"
@@ -21,13 +22,6 @@ module SuperDiff
   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
   end
@@ -36,10 +30,34 @@ module SuperDiff
     @_configuration ||= Configuration.new
   end
 
+  def self.inspect_object(object, as_single_line:, indent_level: 0)
+    ObjectInspection::Inspectors::Main.call(
+      object,
+      as_single_line: as_single_line,
+      indent_level: indent_level,
+    )
+  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.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/colorized_document_extensions.rb

@@ -6,12 +6,12 @@ module SuperDiff
       end
     end
 
-    def alpha(*args, **opts, &block)
-      colorize(*args, **opts, fg: SuperDiff::COLORS.fetch(:alpha), &block)
+    def expected(*args, **opts, &block)
+      colorize(*args, **opts, fg: SuperDiff.configuration.expected_color, &block)
     end
 
-    def beta(*args, **opts, &block)
-      colorize(*args, **opts, fg: SuperDiff::COLORS.fetch(:beta), &block)
+    def actual(*args, **opts, &block)
+      colorize(*args, **opts, fg: SuperDiff.configuration.actual_color, &block)
     end
   end
 end

data/lib/super_diff/configuration.rb

@@ -1,26 +1,54 @@
 module SuperDiff
   class Configuration
     attr_reader(
+      :extra_diff_formatter_classes,
       :extra_differ_classes,
+      :extra_inspector_classes,
       :extra_operation_tree_builder_classes,
       :extra_operation_tree_classes,
-      :extra_diff_formatter_classes,
-      :extra_inspector_classes,
+    )
+    attr_accessor(
+      :actual_color,
+      :border_color,
+      :expected_color,
+      :header_color,
     )
 
     def initialize
+      @actual_color = :yellow
+      @border_color = :blue
+      @expected_color = :magenta
+      @extra_diff_formatter_classes = [].freeze
       @extra_differ_classes = [].freeze
+      @extra_inspector_classes = [].freeze
       @extra_operation_tree_builder_classes = [].freeze
       @extra_operation_tree_classes = [].freeze
-      @extra_diff_formatter_classes = [].freeze
-      @extra_inspector_classes = [].freeze
+      @header_color = :white
     end
 
+    def add_extra_diff_formatter_classes(*classes)
+      @extra_diff_formatter_classes =
+        (@extra_diff_formatter_classes + classes).freeze
+    end
+    alias_method(
+      :add_extra_diff_formatter_class,
+      :add_extra_diff_formatter_classes,
+    )
+
     def add_extra_differ_classes(*classes)
       @extra_differ_classes = (@extra_differ_classes + classes).freeze
     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
+    end
+    alias_method(
+      :add_extra_inspector_class,
+      :add_extra_inspector_classes,
+    )
+
     def add_extra_operation_tree_builder_classes(*classes)
       @extra_operation_tree_builder_classes =
         (@extra_operation_tree_builder_classes + classes).freeze
@@ -38,23 +66,5 @@ module SuperDiff
       :add_extra_operation_tree_class,
       :add_extra_operation_tree_classes,
     )
-
-    def add_extra_diff_formatter_classes(*classes)
-      @extra_diff_formatter_classes =
-        (@extra_diff_formatter_classes + classes).freeze
-    end
-    alias_method(
-      :add_extra_diff_formatter_class,
-      :add_extra_diff_formatter_classes,
-    )
-
-    def add_extra_inspector_classes(*classes)
-      @extra_inspector_classes =
-        (@extra_inspector_classes + classes).freeze
-    end
-    alias_method(
-      :add_extra_inspector_class,
-      :add_extra_inspector_classes,
-    )
   end
 end

data/lib/super_diff/csi.rb

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

data/lib/super_diff/diff_formatters/collection.rb

@@ -4,7 +4,7 @@ module SuperDiff
       extend AttrExtras.mixin
 
       ICONS = { delete: "-", insert: "+" }.freeze
-      STYLES = { insert: :beta, delete: :alpha, noop: :plain }.freeze
+      STYLES = { insert: :actual, delete: :expected, noop: :plain }.freeze
 
       method_object(
         [
@@ -94,7 +94,7 @@ module SuperDiff
       end
 
       def build_chunk_by_inspecting(value, prefix:, icon:)
-        inspection = ObjectInspection.inspect(
+        inspection = SuperDiff.inspect_object(
           value,
           as_single_line: false,
         )

data/lib/super_diff/diff_formatters/multiline_string.rb

@@ -15,12 +15,12 @@ module SuperDiff
         operation_tree.reduce([]) do |array, operation|
           case operation.name
           when :change
-            array << Helpers.style(:alpha, "- #{operation.left_value}")
-            array << Helpers.style(:beta, "+ #{operation.right_value}")
+            array << Helpers.style(:expected, "- #{operation.left_value}")
+            array << Helpers.style(:actual, "+ #{operation.right_value}")
           when :delete
-            array << Helpers.style(:alpha, "- #{operation.value}")
+            array << Helpers.style(:expected, "- #{operation.value}")
           when :insert
-            array << Helpers.style(:beta, "+ #{operation.value}")
+            array << Helpers.style(:actual, "+ #{operation.value}")
           else
             array << Helpers.style(:plain, "  #{operation.value}")
           end

data/lib/super_diff/equality_matchers/array.rb

@@ -11,16 +11,16 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_single_line: true),
             )
           }
 

data/lib/super_diff/equality_matchers/default.rb

@@ -19,17 +19,17 @@ module SuperDiff
 
       def expected_line
         Helpers.style(
-          :alpha,
+          :expected,
           "Expected: " +
-          ObjectInspection.inspect(expected, as_single_line: true),
+          SuperDiff.inspect_object(expected, as_single_line: true),
         )
       end
 
       def actual_line
         Helpers.style(
-          :beta,
+          :actual,
           "  Actual: " +
-          ObjectInspection.inspect(actual, as_single_line: true),
+          SuperDiff.inspect_object(actual, as_single_line: true),
         )
       end
 

data/lib/super_diff/equality_matchers/hash.rb

@@ -11,16 +11,16 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_single_line: true),
             )
           }
 

data/lib/super_diff/equality_matchers/multiline_string.rb

@@ -12,16 +12,16 @@ module SuperDiff
           #{
             # TODO: This whole thing should not be red or green, just the values
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_single_line: true),
             )
           }
 

data/lib/super_diff/equality_matchers/primitive.rb

@@ -15,16 +15,16 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_single_line: true),
             )
           }
         OUTPUT

data/lib/super_diff/equality_matchers/singleline_string.rb

@@ -11,16 +11,16 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_single_line: true),
             )
           }
         OUTPUT