super_diff 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b261fa1a942123632f87e74d6b123826571840e9d779d21424ca590b6a646f8f
-  data.tar.gz: a2a780bc9752ec935edfd34bfb7588aa13c8a2357f1422037102e1c7774c31db
+  metadata.gz: 343438b938b014502f7af0df76fc22ff73f3eaada655081b994b8c4d77bd3618
+  data.tar.gz: 2738da41f517ecfcd1e068e03256cd37aa5436fd984856a2c958518596bd58bf
 SHA512:
-  metadata.gz: 45a49cec47615c6c82e1cbae577c1bd9ad57852469f7a69d13c7daa8425971f8fdb109de7991db7b3f810dfcd9eb58d0cd1635c9497b913496ef8e5ab9e0f73b
-  data.tar.gz: 8bf439969e3e15fe39661e25e65abca5a442a055efad43089d16bdd0a383c36c0ff02c67a6f73644d04c5581c8cf2a0c72b50f5a67d543046acd875a8c081e64
+  metadata.gz: 522481e293667b16bf0d2c752fc02ebce5c6b8c607d23d53b009d52eec34e9a0d429fa410cb8dc4802c5b9b3dffd20632f9671024e3ba009e591179a6cb155dc
+  data.tar.gz: c08edc9460956e59f391249f26b508c944797ceda4db80d36b2119415322ef00210cd57817e74f24b6d13cc3b869bf7de1ca50276cd75e01288b1733c4c48b43

data/README.md

@@ -1,12 +1,10 @@
-# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][gh-actions-badge]][gh-actions] ![Downloads][downloads-badge] [![IssueHunt][issuehunt-badge]][issuehunt]
+# SuperDiff [![Gem Version][version-badge]][rubygems] [![Build Status][gh-actions-badge]][gh-actions] ![Downloads][downloads-badge]
 
 [version-badge]: http://img.shields.io/gem/v/super_diff.svg
 [rubygems]: http://rubygems.org/gems/super_diff
-[gh-actions-badge]: https://img.shields.io/github/actions/workflow/status/mcmire/super_diff/super_diff.yml?branch=master
+[gh-actions-badge]: https://img.shields.io/github/actions/workflow/status/splitwise/super_diff/super_diff.yml?branch=main
 [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
-[issuehunt]: https://issuehunt.io/r/mcmire/super_diff
 
 **SuperDiff** is a Ruby gem
 which is designed to display the differences between two objects of any type
@@ -102,7 +100,7 @@ and you encounter a bug or have a suggestion,
 feel free to [create an issue][issues-list].
 I'll try to respond to it as soon as I can!
 
-[issues-list]: https://github.com/mcmire/super_diff/issues
+[issues-list]: https://github.com/splitwise/super_diff/issues
 
 ## Contributing
 
@@ -110,16 +108,6 @@ Any code contributions to improve this library are welcome!
 Please see the [contributing](./docs/contributors/index.md) document
 for more on how to do that.
 
-## Sponsoring
-
-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][issuehunt].
-I'll get notified right away!
-
-[issuehunt]: https://issuehunt.io/r/mcmire/super_diff
-
 ## Compatibility
 
 `super_diff` is [tested][gh-actions] to work with
@@ -127,7 +115,7 @@ Ruby >= 3.x,
 RSpec 3.x,
 and Rails >= 6.x.
 
-[gh-actions]: https://github.com/mcmire/super_diff/actions?query=workflow%3ASuperDiff
+[gh-actions]: https://github.com/splitwise/super_diff/actions?query=workflow%3ASuperDiff
 
 ## Inspiration/Thanks
 
@@ -142,13 +130,13 @@ I made use of or was heavily inspired by these libraries:
 
 Thank you to the authors of these libraries!
 
-[original-version]: https://github.com/mcmire/super_diff/tree/old-master
+[original-version]: https://github.com/splitwise/super_diff/tree/old-master
 [diff-lcs]: https://github.com/halostatue/diff-lcs
 [pretty-printer]: https://github.com/ruby/ruby/tree/master/lib/prettyprint.rb
 [awesome-print]: https://github.com/awesome-print/awesome_print
-[inspection-tree]: https://github.com/mcmire/super_diff/blob/master/lib/super_diff/object_inspection/inspection_tree.rb
+[inspection-tree]: https://github.com/splitwise/super_diff/blob/main/lib/super_diff/object_inspection/inspection_tree.rb
 
 ## Author/License
 
-SuperDiff was created and is maintained by Elliot Winkler.
+SuperDiff was created by Elliot Winkler and is maintained by Splitwise, Inc.
 It is released under the [MIT license](LICENSE).

data/lib/super_diff/basic/inspection_tree_builders/data_object.rb

@@ -0,0 +1,40 @@
+module SuperDiff
+  module Basic
+    module InspectionTreeBuilders
+      class DataObject < Core::AbstractInspectionTreeBuilder
+        def self.applies_to?(value)
+          SuperDiff::Core::Helpers.ruby_version_matches?("~> 3.2") &&
+            value.is_a?(Data)
+        end
+
+        def call
+          Core::InspectionTree.new do |t1|
+            t1.as_lines_when_rendering_to_lines(
+              collection_bookend: :open
+            ) do |t2|
+              t2.add_text "#<data #{object.class.name} "
+
+              # stree-ignore
+              t2.when_rendering_to_lines do |t3|
+                t3.add_text "{"
+              end
+            end
+
+            t1.nested { |t2| t2.insert_hash_inspection_of(object.to_h) }
+
+            t1.as_lines_when_rendering_to_lines(
+              collection_bookend: :close
+            ) do |t2|
+              # stree-ignore
+              t2.when_rendering_to_lines do |t3|
+                t3.add_text "}"
+              end
+
+              t2.add_text ">"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module SuperDiff
     module InspectionTreeBuilders
       class Primitive < Core::AbstractInspectionTreeBuilder
         def self.applies_to?(value)
-          SuperDiff.primitive?(value) || value.is_a?(::String)
+          SuperDiff.primitive?(value)
         end
 
         def call

data/lib/super_diff/basic/inspection_tree_builders.rb

@@ -6,6 +6,10 @@ module SuperDiff
         :CustomObject,
         "super_diff/basic/inspection_tree_builders/custom_object"
       )
+      autoload(
+        :DataObject,
+        "super_diff/basic/inspection_tree_builders/data_object"
+      )
       autoload(
         :DefaultObject,
         "super_diff/basic/inspection_tree_builders/default_object"

data/lib/super_diff/basic/operation_tree_builders/data_object.rb

@@ -0,0 +1,18 @@
+module SuperDiff
+  module Basic
+    module OperationTreeBuilders
+      class DataObject < CustomObject
+        def self.applies_to?(expected, actual)
+          SuperDiff::Core::Helpers.ruby_version_matches?("~> 3.2") &&
+            expected.class == actual.class && expected.is_a?(Data)
+        end
+
+        protected
+
+        def attribute_names
+          expected.members & actual.members
+        end
+      end
+    end
+  end
+end

data/lib/super_diff/basic/operation_tree_builders.rb

@@ -6,6 +6,10 @@ module SuperDiff
         :CustomObject,
         "super_diff/basic/operation_tree_builders/custom_object"
       )
+      autoload(
+        :DataObject,
+        "super_diff/basic/operation_tree_builders/data_object"
+      )
       autoload(
         :DefaultObject,
         "super_diff/basic/operation_tree_builders/default_object"

data/lib/super_diff/basic.rb

@@ -26,6 +26,7 @@ module SuperDiff
         InspectionTreeBuilders::Primitive,
         InspectionTreeBuilders::TimeLike,
         InspectionTreeBuilders::DateLike,
+        InspectionTreeBuilders::DataObject,
         InspectionTreeBuilders::DefaultObject
       )
 
@@ -34,7 +35,8 @@ module SuperDiff
         OperationTreeBuilders::Hash,
         OperationTreeBuilders::TimeLike,
         OperationTreeBuilders::DateLike,
-        OperationTreeBuilders::CustomObject
+        OperationTreeBuilders::CustomObject,
+        OperationTreeBuilders::DataObject
       )
 
       config.add_extra_operation_tree_classes(

data/lib/super_diff/core/configuration.rb

@@ -23,7 +23,7 @@ module SuperDiff
       def initialize(options = {})
         @actual_color = :yellow
         @border_color = :blue
-        @color_enabled = color_enabled_by_default?
+        @color_enabled = nil
         @diff_elision_enabled = false
         @diff_elision_maximum = 0
         @elision_marker_color = :cyan
@@ -41,6 +41,8 @@ module SuperDiff
 
       def initialize_dup(original)
         super
+        @extra_diff_formatter_classes =
+          original.extra_diff_formatter_classes.dup.freeze
         @extra_differ_classes = original.extra_differ_classes.dup.freeze
         @extra_operation_tree_builder_classes =
           original.extra_operation_tree_builder_classes.dup.freeze
@@ -51,6 +53,8 @@ module SuperDiff
       end
 
       def color_enabled?
+        return color_enabled_by_default? if @color_enabled.nil?
+
         @color_enabled
       end
 
@@ -71,12 +75,6 @@ module SuperDiff
           end
 
         options.each { |key, value| instance_variable_set("@#{key}", value) }
-
-        updated
-      end
-
-      def updated
-        SuperDiff::Csi.color_enabled = color_enabled?
       end
 
       def add_extra_diff_formatter_classes(*classes)
@@ -165,7 +163,7 @@ module SuperDiff
         {
           actual_color: actual_color,
           border_color: border_color,
-          color_enabled: color_enabled?,
+          color_enabled: @color_enabled,
           diff_elision_enabled: diff_elision_enabled?,
           diff_elision_maximum: diff_elision_maximum,
           elision_marker_color: elision_marker_color,
@@ -185,7 +183,13 @@ module SuperDiff
       private
 
       def color_enabled_by_default?
-        ENV["CI"] == "true" || $stdout.respond_to?(:tty?) && $stdout.tty?
+        return true if ENV["CI"] == "true"
+
+        if defined?(::SuperDiff::RSpec)
+          return ::RSpec.configuration.color_enabled?
+        end
+
+        $stdout.respond_to?(:tty?) && $stdout.tty?
       end
     end
   end

data/lib/super_diff/core/helpers.rb

@@ -6,7 +6,7 @@ module SuperDiff
       # TODO: Simplify this
       def style(*args, color_enabled: true, **opts, &block)
         klass =
-          if color_enabled && Csi.color_enabled?
+          if color_enabled && SuperDiff.configuration.color_enabled?
             Csi::ColorizedDocument
           else
             Csi::UncolorizedDocument

data/lib/super_diff/csi.rb

@@ -12,26 +12,10 @@ module SuperDiff
     autoload :TwentyFourBitColor, "super_diff/csi/twenty_four_bit_color"
     autoload :UncolorizedDocument, "super_diff/csi/uncolorized_document"
 
-    class << self
-      attr_writer :color_enabled
-    end
-
     def self.reset_sequence
       ResetSequence.new
     end
 
-    def self.color_enabled?
-      @color_enabled
-    end
-
-    def self.colorize(*args, **opts, &block)
-      if color_enabled?
-        ColorizedDocument.new(*args, **opts, &block)
-      else
-        UncolorizedDocument.new(*args, **opts, &block)
-      end
-    end
-
     def self.decolorize(text)
       text.gsub(/\e\[\d+(?:;\d+)*m(.+?)\e\[0m/, '\1')
     end
@@ -39,21 +23,5 @@ module SuperDiff
     def self.already_colorized?(text)
       text.match?(/\e\[\d+m/)
     end
-
-    def self.inspect_colors_in(text)
-      [FourBitColor, EightBitColor, TwentyFourBitColor].reduce(
-        text
-      ) do |str, klass|
-        klass.sub_colorized_areas_in(str) do |area, color|
-          color_block = colorize("◼︎", color.to_foreground)
-
-          layer_indicator = (color.foreground? ? "(fg)" : "(bg)")
-
-          "#{color_block} #{layer_indicator} ❮#{area}❯"
-        end
-      end
-    end
-
-    self.color_enabled = false
   end
 end

data/lib/super_diff/equality_matchers/defaults.rb

@@ -1,11 +1,11 @@
 module SuperDiff
   module EqualityMatchers
     DEFAULTS = [
-      Primitive,
       Array,
       Hash,
       MultilineString,
       SinglelineString,
+      Primitive,
       Default
     ].freeze
   end

data/lib/super_diff/version.rb

@@ -1,3 +1,3 @@
 module SuperDiff
-  VERSION = "0.12.1".freeze
+  VERSION = "0.13.0".freeze
 end

data/lib/super_diff.rb

@@ -36,7 +36,6 @@ module SuperDiff
 
   def self.configure
     yield configuration
-    configuration.updated
   end
 
   def self.configuration
@@ -114,7 +113,7 @@ module SuperDiff
 
   def self.primitive?(value)
     case value
-    when true, false, nil, Symbol, Numeric, Regexp, Class
+    when true, false, nil, Symbol, Numeric, Regexp, Class, String
       true
     else
       false