super_diff 0.5.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5427cb2217992c9dffd57826837caaa750ddcd422625498c3bca9cf40ae8e32
-  data.tar.gz: 540a3e3ea47bc98c4abf45ff6ff216563f70f1492bb2c06a54525b6414b306ae
+  metadata.gz: 0fc8e5b83b3b02559e96bbd06f8703b688d56b32588639f7d49a4774d6869433
+  data.tar.gz: 5f0c9d472aa1170df1a52cc41eab384c4526342cf336e380cdbd01f9e95a3b61
 SHA512:
-  metadata.gz: 1bf06c03ce556532384242e0193628bae55134e3edf65003e1d0b7a1015e25af6f9ce68bd23a7ca2ebadddb0093103a643f9bb742116d2456f20146bb948f380
-  data.tar.gz: c32489d6915ac9f7fc3cf1c0427683977b3a569a99e36a7d8e47f1209e74efcf3f86b3986b1e40ed51d2321d89f1e8530bdda79352c1d53fd94798370f2261de
+  metadata.gz: 24306d1fba59520092a8a446e0a9219a3e9e89813fd3818f2769f737084cc8f6565b12497c86bacb4b9a8f9c5a4b13bafe0479e330cc8169a6c574e11cc74a56
+  data.tar.gz: 514af50e6272ae3095b752d778b7f3bc776923bccb87a2ab8a50c2f8019c9aba991e129d2dad88248c621594ab5972029a798ada0e64eb8f8a27acc0e7cde496

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,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.
@@ -204,12 +231,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 +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

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(
         [

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,14 +11,14 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
               ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )

data/lib/super_diff/equality_matchers/default.rb

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

data/lib/super_diff/equality_matchers/hash.rb

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

data/lib/super_diff/equality_matchers/multiline_string.rb

@@ -12,14 +12,14 @@ 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),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
               ObjectInspection.inspect(actual, as_single_line: true),
             )

data/lib/super_diff/equality_matchers/primitive.rb

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

data/lib/super_diff/equality_matchers/singleline_string.rb

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

data/lib/super_diff/gem_version.rb

@@ -0,0 +1,45 @@
+module SuperDiff
+  class GemVersion
+    def initialize(version)
+      @version = Gem::Version.new(version.to_s)
+    end
+
+    def <(other)
+      compare?(:<, other)
+    end
+
+    def <=(other)
+      compare?(:<=, other)
+    end
+
+    def ==(other)
+      compare?(:==, other)
+    end
+
+    def >=(other)
+      compare?(:>=, other)
+    end
+
+    def >(other)
+      compare?(:>, other)
+    end
+
+    def =~(other)
+      Gem::Requirement.new(other).satisfied_by?(version)
+    end
+
+    def to_s
+      version.to_s
+    end
+
+    private
+
+    attr_reader :version
+
+    def compare?(operator, other_version)
+      Gem::Requirement.
+        new("#{operator} #{other_version}").
+        satisfied_by?(version)
+    end
+  end
+end

data/lib/super_diff/rspec.rb

@@ -61,6 +61,13 @@ module SuperDiff
       value.is_a?(::RSpec::Matchers::AliasedMatcher)
     end
 
+    def self.rspec_version
+      @_rspec_version ||= begin
+        require "rspec/core/version"
+        GemVersion.new(::RSpec::Core::Version::STRING)
+      end
+    end
+
     SuperDiff.configuration.tap do |config|
       config.add_extra_differ_classes(
         Differs::CollectionContainingExactly,

data/lib/super_diff/rspec/matcher_text_builders/base.rb

@@ -45,12 +45,12 @@ module SuperDiff
         def add_extra_after_error
         end
 
-        def beta_color
-          SuperDiff::COLORS.fetch(:beta)
+        def actual_color
+          SuperDiff.configuration.actual_color
         end
 
-        def alpha_color
-          SuperDiff::COLORS.fetch(:alpha)
+        def expected_color
+          SuperDiff.configuration.expected_color
         end
 
         private
@@ -91,7 +91,7 @@ module SuperDiff
         end
 
         def add_actual_value
-          template.add_text_in_color(beta_color) { actual }
+          template.add_text_in_color(actual_color) { actual }
         end
 
         def expected_section
@@ -110,7 +110,7 @@ module SuperDiff
           else
             template.add_text " "
             template.add_text_in_color(
-              alpha_color,
+              expected_color,
               expected_for_failure_message,
             )
           end
@@ -121,7 +121,7 @@ module SuperDiff
             add_expected_value_to(template, expected_for_description)
           else
             template.add_text " "
-            template.add_text_in_color(alpha_color, expected_for_description)
+            template.add_text_in_color(expected_color, expected_for_description)
           end
         end