super_diff 0.5.3 → 0.8.0

data/lib/super_diff/differs/base.rb

@@ -9,29 +9,14 @@ module SuperDiff
       extend AttrExtras.mixin
       include ImplementationChecks
 
-      method_object(
-        :expected,
-        :actual,
-        [
-          :indent_level!,
-          index_in_collection: nil,
-        ],
-      )
+      method_object :expected, :actual, [:indent_level!]
 
       def call
-        operation_tree.to_diff(
-          indent_level: indent_level,
-          collection_prefix: nil,
-          add_comma: false,
-        )
+        operation_tree.to_diff(indentation_level: indent_level)
       end
 
       protected
 
-      def indentation
-        " " * (indent_level * 2)
-      end
-
       def operation_tree_builder_class
         unimplemented_instance_method!
       end
@@ -39,10 +24,7 @@ module SuperDiff
       private
 
       def operation_tree
-        operation_tree_builder_class.call(
-          expected: expected,
-          actual: actual,
-        )
+        operation_tree_builder_class.call(expected: expected, actual: actual)
       end
     end
   end

data/lib/super_diff/differs/custom_object.rb

@@ -7,7 +7,7 @@ module SuperDiff
           actual.respond_to?(:attributes_for_super_diff)
       end
 
-      private
+      protected
 
       def operation_tree_builder_class
         OperationTreeBuilders::CustomObject

data/lib/super_diff/differs/default_object.rb

@@ -5,7 +5,7 @@ module SuperDiff
         expected.class == actual.class
       end
 
-      private
+      protected
 
       def operation_tree
         OperationTreeBuilders::Main.call(

data/lib/super_diff/differs/hash.rb

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

data/lib/super_diff/differs/main.rb

@@ -8,19 +8,13 @@ module SuperDiff
         :actual,
         [
           indent_level: 0,
-          index_in_collection: nil,
           omit_empty: false,
         ],
       )
 
       def call
         if resolved_class
-          resolved_class.call(
-            expected,
-            actual,
-            indent_level: indent_level,
-            index_in_collection: index_in_collection,
-          )
+          resolved_class.call(expected, actual, indent_level: indent_level)
         else
           raise Errors::NoDifferAvailableError.create(expected, actual)
         end

data/lib/super_diff/differs/multiline_string.rb

@@ -6,7 +6,7 @@ module SuperDiff
           (expected.include?("\n") || actual.include?("\n"))
       end
 
-      private
+      protected
 
       def operation_tree_builder_class
         OperationTreeBuilders::MultilineString

data/lib/super_diff/differs/time_like.rb

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

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_lines: false),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_lines: false),
             )
           }
 

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_lines: false),
         )
       end
 
       def actual_line
         Helpers.style(
-          :beta,
+          :actual,
           "  Actual: " +
-          ObjectInspection.inspect(actual, as_single_line: true),
+          SuperDiff.inspect_object(actual, as_lines: false),
         )
       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_lines: false),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_lines: false),
             )
           }
 

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_lines: false),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_lines: false),
             )
           }
 

data/lib/super_diff/equality_matchers/primitive.rb

@@ -2,11 +2,8 @@ module SuperDiff
   module EqualityMatchers
     class Primitive < Base
       def self.applies_to?(value)
-        value.is_a?(Symbol) ||
-          value.is_a?(Numeric) ||
-          # TODO: Test this
-          value == true ||
-          value == false
+        # TODO: Test all of these options
+        SuperDiff.primitive?(value)
       end
 
       def fail
@@ -15,16 +12,16 @@ module SuperDiff
 
           #{
             Helpers.style(
-              :alpha,
+              :expected,
               "Expected: " +
-              ObjectInspection.inspect(expected, as_single_line: true),
+              SuperDiff.inspect_object(expected, as_lines: false),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_lines: false),
             )
           }
         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_lines: false),
             )
           }
           #{
             Helpers.style(
-              :beta,
+              :actual,
               "  Actual: " +
-              ObjectInspection.inspect(actual, as_single_line: true),
+              SuperDiff.inspect_object(actual, as_lines: false),
             )
           }
         OUTPUT

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/helpers.rb

@@ -1,7 +1,9 @@
 module SuperDiff
   module Helpers
+    extend self
+
     # TODO: Simplify this
-    def self.style(*args, color_enabled: true, **opts, &block)
+    def style(*args, color_enabled: true, **opts, &block)
       klass =
         if color_enabled && Csi.color_enabled?
           Csi::ColorizedDocument
@@ -20,7 +22,7 @@ module SuperDiff
       document
     end
 
-    def self.plural_type_for(value)
+    def plural_type_for(value)
       case value
       when Numeric then "numbers"
       when String then "strings"
@@ -28,5 +30,53 @@ module SuperDiff
       else "objects"
       end
     end
+
+    def jruby?
+      defined?(JRUBY_VERSION)
+    end
+
+    def ruby_version_matches?(version_string)
+      Gem::Requirement.new(version_string).satisfied_by?(
+        Gem::Version.new(RUBY_VERSION),
+      )
+    end
+
+    if jruby?
+      def object_address_for(object)
+        # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
+        "0x%x" % object.hash
+      end
+    elsif ruby_version_matches?(">= 2.7.0")
+      require "json"
+      require "objspace"
+
+      def object_address_for(object)
+        # Sources: <https://bugs.ruby-lang.org/issues/15408> and <https://bugs.ruby-lang.org/issues/15626#Object-ID>
+        address = JSON.parse(ObjectSpace.dump(object))["address"]
+        "0x%016x" % Integer(address, 16)
+      end
+    else
+      def object_address_for(object)
+        "0x%016x" % (object.object_id * 2)
+      end
+    end
+
+    def with_slice_of_array_replaced(array, range, replacement)
+      beginning =
+        if range.begin > 0
+          array[Range.new(0, range.begin - 1)]
+        else
+          []
+        end
+
+      ending =
+        if range.end <= array.length - 1
+          array[Range.new(range.end + 1, array.length - 1)]
+        else
+          []
+        end
+
+      beginning + [replacement] + ending
+    end
   end
 end

data/lib/super_diff/line.rb

@@ -0,0 +1,83 @@
+module SuperDiff
+  class Line
+    extend AttrExtras.mixin
+
+    ICONS = { delete: "-", insert: "+", noop: " " }.freeze
+    COLORS = { insert: :actual, delete: :expected, noop: :plain }.freeze
+
+    rattr_initialize(
+      [
+        :type!,
+        :indentation_level!,
+        :value!,
+        prefix: "",
+        add_comma: false,
+        children: [],
+        elided: false,
+        collection_bookend: nil,
+        complete_bookend: nil,
+      ],
+    )
+    attr_query :add_comma?
+    attr_query :elided?
+
+    def clone_with(overrides = {})
+      self.class.new(
+        type: type,
+        indentation_level: indentation_level,
+        prefix: prefix,
+        value: value,
+        add_comma: add_comma?,
+        children: children,
+        elided: elided?,
+        collection_bookend: collection_bookend,
+        complete_bookend: complete_bookend,
+        **overrides,
+      )
+    end
+
+    def icon
+      ICONS.fetch(type)
+    end
+
+    def color
+      COLORS.fetch(type)
+    end
+
+    def with_comma
+      clone_with(add_comma: true)
+    end
+
+    def as_elided
+      clone_with(elided: true)
+    end
+
+    def with_value_prepended(prelude)
+      clone_with(value: prelude + value)
+    end
+
+    def with_value_appended(suffix)
+      clone_with(value: value + suffix)
+    end
+
+    def prefixed_with(prefix)
+      clone_with(prefix: prefix + self.prefix)
+    end
+
+    def with_complete_bookend(complete_bookend)
+      clone_with(complete_bookend: complete_bookend)
+    end
+
+    def opens_collection?
+      collection_bookend == :open
+    end
+
+    def closes_collection?
+      collection_bookend == :close
+    end
+
+    def complete_bookend?
+      complete_bookend != nil
+    end
+  end
+end