hash_deep_diff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ba7f377f6c2d53dd22518acfe0a285ed4d4614f9bf03c1c32f1775358a01188
-  data.tar.gz: 827fbbd1133ff72fd11475d0c5001894c27a6e71c125ccc5da891c159538beae
+  metadata.gz: f27828ee0fbf8a3d07505ed475c3117d2734dd9505e57e3e12d0a360eab4df08
+  data.tar.gz: b23a5ef94237454e5a50cac7a59e1624a3d8e6f29d249c6d5836ddd596fe097c
 SHA512:
-  metadata.gz: 12eb5aa92de1f7c6d43473bf6858278ffafca368537e7e9f4fd9d2dd945493c4760c9daaee03724e5699c7acd067b06e6bf3162beb38923fe9f218addbae2742
-  data.tar.gz: f61820a61aeac40a63431a392a3352f79ae278016b2e0238e16b690f8c0a72ea26fbc0c1351face859a71683e61dab720c0cccc55953eac6759101dc4822edc3
+  metadata.gz: e83d2e0c8e2843f084aa82ea3e246659b6e078a7c3183f03c236bea8e4ac7848d39ed18bc2f81dfa4aecc005af4149372b5d2da28d87760ee4ff1c330f67f54a
+  data.tar.gz: b56714d24122c5cf9ab11616257cb75a2c2c4cb17225f2b0ad8665cbb64c1b49a6fb0d0f544a6961d5db236ef2e8896ebed8fa0d461479be24629cf6d2ecbf71

data/Guardfile

@@ -26,6 +26,8 @@ end
 guard :minitest do
   # with Minitest::Unit
   watch(%r{^test/(.*)/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { 'test' }
   watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^test/support/.*$})           { 'test' }
 end

data/README.md

@@ -1,10 +1,3 @@
-Ideas
-- if not equal use sets to diff keys
-- use to_ary to_hash for values to find if further recursion needed
-- use to_a.flatten to figure out if any unacceptable classes present
-- do not use respond_to?(:each) in first version
-
-
 # HashDeepDiff
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hash_deep_diff`. To experiment with that code, run `bin/console` for an interactive prompt.

data/hash_deep_diff.gemspec

@@ -39,14 +39,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'guard-rubocop'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-reporters'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-minitest'
-  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'bundler', '~> 1.17.2'
+  spec.add_development_dependency 'guard', '~> 2.18.0'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4.6'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.5.0'
+  spec.add_development_dependency 'minitest', '~> 5.15.0'
+  spec.add_development_dependency 'minitest-focus', '~> 1.3.1'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.5.0'
+  spec.add_development_dependency 'rake', '~> 10.5.0'
+  spec.add_development_dependency 'rubocop', '~> 1.26.1'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.18.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
 end

data/lib/hash_deep_diff/comparison.rb

@@ -1,77 +1,99 @@
 # frozen_string_literal: true
 
+require_relative 'delta/left'
+require_relative 'delta/inner'
+require_relative 'delta/right'
+
 # :nodoc:
 module HashDeepDiff
   # :nodoc:
   class Comparison
-    attr_reader :left, :right
+    attr_reader :left, :right, :path
 
     def diff(&block)
-      return [{}, {}, {}] if left == right  # this is order-sensitive comparison
-      return [left, {}, {}] if right.empty?
-      return [{}, {}, right] if left.empty?
-      return first_level_delta(&block) if one_level_deep?
+      left_delta + deep_delta(&block) + right_delta
+    end
 
-      return [left_delta, deep_delta(&block), right_delta]
+    def report
+      diff.join("\n")
     end
 
     private
 
-    def initialize(left, right)
+    def initialize(left, right, path = [])
       @left = left.to_hash
       @right = right.to_hash
+      @path = path.to_ary
     end
 
-    def deep_delta(&block)
-      result = delta(&block)
-      result.keys.each_with_object({}) do |key, memo|
-        memo[key] = result[key] && next unless left[key].instance_of?(Hash)
+    def extra_report(memo, keys, value)
+      if value.respond_to?(:to_hash)
+        value.each_key { |key| extra_report(memo, keys + [key], value[key]) }
+      else
+        memo << Delta::Left.new(path: keys, value: value)
+      end
+    end
 
-        memo[key] = self.class.new(left[key], right[key]).diff
+    def missing_report(memo, keys, value)
+      if value.respond_to?(:to_hash)
+        value.each_key { |key| missing_report(memo, keys + [key], value[key]) }
+      else
+        memo << Delta::Right.new(path: keys, value: value)
       end
     end
 
-    def first_level_delta(&block)
-      [
-        left_delta,
-        delta(&block),
-        right_delta
-      ]
+    def delta_report(memo, keys, value)
+      if value.respond_to?(:to_hash) && value.keys != %i[left right]
+        value.each_key { |key| delta_report(memo, keys + [key], value[key]) }
+      elsif value.instance_of?(Array) && value.size == 3 && value.all? { |el| el.respond_to?(:to_hash) }
+        # [{}, {}, {:i=>:i}]
+        extra_report(memo, keys, value[0]) unless value[0].empty?
+        delta_report(memo, keys, value[1]) unless value[1].empty?
+        missing_report(memo, keys, value[2]) unless value[2].empty?
+      else
+        memo << Delta::Inner.new(path: keys, value: value)
+      end
+    end
+
+    def deep_delta(&block)
+      result = delta(&block)
+
+      result.each_with_object([]) do |diff, memo|
+        if left.dig(*diff.path).respond_to?(:to_hash) && right.dig(*diff.path).respond_to?(:to_hash)
+          self.class.new(left.dig(*diff.path), right.dig(*diff.path), path + diff.path).diff.each do |diff|
+            memo << diff
+          end
+        else
+          memo << diff
+        end
+      end
     end
 
     def right_delta
-      right_diff_keys.each_with_object({}) do |key, memo|
-        memo[key] = right[key]
+      right_diff_keys.each_with_object([]) do |key, memo|
+        memo << Delta::Right.new(path: path + [key], value: right[key])
       end
     end
 
     def delta(&block)
       block ||= ->(val) { val }
 
-      common_keys.each_with_object({}) do |key, memo|
+      common_keys.each_with_object([]) do |key, memo|
         value_left = block.call(left[key])
         value_right = block.call(right[key])
 
         next if value_right.instance_of?(value_left.class) && (value_right == value_left)
 
-        memo[key] = {
-          left: value_left,
-          right: value_right
-        }
+        memo << Delta::Inner.new(path: path + [key], value: { left: value_left, right: value_right })
       end
     end
 
     def left_delta
-      left_diff_keys.each_with_object({}) do |key, memo|
-        memo[key] = left[key]
+      left_diff_keys.each_with_object([]) do |key, memo|
+        memo << Delta::Left.new(path: path + [key], value: left[key])
       end
     end
 
-    def one_level_deep?
-      left.values.none? { |value| value.respond_to?(:to_hash) } &&
-        right.values.none? { |value| value.respond_to?(:to_hash) }
-    end
-
     def common_keys
       left.keys & right.keys
     end

data/lib/hash_deep_diff/delta/acts_as_delta.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module HashDeepDiff
+  module Delta
+    # This module includes behavior that is needed to use deltas instead of Hash inside this gem
+    module ActsAsDelta
+      def self.included(base)
+        base.prepend(Initialize)
+        base.include(InstanceMethods)
+        base.extend(Forwardable)
+        base.def_delegators :@delta, :==, :each_with_object, :each_key, :[],
+                            :to_a, :empty?, :keys
+      end
+
+      # Assumes that the class will include method delta that will return a representation of an
+      # instance of a class as a Hash
+      module InstanceMethods
+        # TOFIX poor naming
+        def diff_prefix
+          path.map { |key| "[#{key}]" }.join
+        end
+
+        # TOFIX poor naming
+        def path
+          @prefix + [@delta.keys.first]
+        end
+
+        def to_h
+          @delta
+        end
+
+        def to_hash
+          @delta
+        end
+
+        def to_s
+          to_str
+        end
+
+        def to_str
+          raise NoMethodError, "expected #{self.class} to implement #to_str"
+        end
+      end
+
+      # Override #initialize method
+      module Initialize
+        def initialize(path:, value:)
+          # TOFIX this may prohibit usage of hashes with Array keys
+          if path.respond_to?(:to_ary)
+            @delta = { path[-1] => value }
+            @prefix = path[0..-2]
+          else
+            @delta = { path => value }
+            @prefix = []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hash_deep_diff/delta/inner.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'acts_as_delta'
+
+module HashDeepDiff
+  module Delta
+    # Representation of the pure left diff
+    # i.e element that are missing in the hash on the right of the comparison
+    # for example left diff of { a: a } and {} is { a: a }
+    class Inner
+      include Delta::ActsAsDelta
+
+      def to_str
+        if @delta.values.first.respond_to?(:to_hash)
+          if @delta.values.first.keys == %i[left right]
+            if @delta.values.first[:left].respond_to?(:to_hash) && @delta.values.first[:right].respond_to?(:to_hash)
+              HashDeepDiff::Comparison.new(
+                @delta.values.first[:left],
+                @delta.values.first[:right],
+                path
+              ).report
+            else
+              lines = <<~Q
+                -left#{diff_prefix} = #{@delta.values.first[:left]}
+                +right#{diff_prefix} = #{@delta.values.first[:right]}
+              Q
+              lines.strip
+            end
+          else
+            @delta.values.first.keys.map do |key|
+              self.class.new(path: path + [key], value: @delta.values.first[key])
+            end.join("\n").strip
+          end
+        else
+          lines = <<~Q
+            -left#{diff_prefix} = #{@delta.values.first[:left]}
+            +right#{diff_prefix} = #{@delta.values.first[:right]}
+          Q
+          lines.strip
+        end
+      end
+    end
+  end
+end

data/lib/hash_deep_diff/delta/left.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'acts_as_delta'
+
+module HashDeepDiff
+  module Delta
+    # Representation of the pure left diff
+    # i.e element that are missing in the hash on the right of the comparison
+    # for example left diff of { a: a } and {} is { a: a }
+    class Left
+      include Delta::ActsAsDelta
+
+      def to_str
+        if @delta.values.first.respond_to?(:to_hash)
+          @delta.values.first.keys.map do |key|
+            self.class.new(path: path + [key], value: @delta.values.first[key])
+          end.join("\n").strip
+        else
+          "+left#{diff_prefix} = #{@delta.values.first}"
+        end
+      end
+    end
+  end
+end

data/lib/hash_deep_diff/delta/right.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'acts_as_delta'
+
+module HashDeepDiff
+  module Delta
+    # Representation of the pure right diff
+    # i.e element that are missing in the hash on the right of the comparison
+    # for example right diff of {} and { a: a } is { a: a }
+    class Right
+      include Delta::ActsAsDelta
+
+      def to_str
+        if @delta.values.first.respond_to?(:to_hash)
+          @delta.values.first.keys.map do |key|
+            self.class.new(path: path + [key], value: @delta.values.first[key])
+          end.join("\n").strip
+        else
+          "-left#{diff_prefix} = #{@delta.values.first}"
+        end
+      end
+    end
+  end
+end

data/lib/hash_deep_diff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HashDeepDiff
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/hash_deep_diff.rb

@@ -5,5 +5,4 @@ require 'hash_deep_diff/comparison'
 
 module HashDeepDiff
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,155 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: hash_deep_diff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bohdan Pohorilets
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.2
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.6
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.15.0
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 description: Find the exact difference between two Hash objects
 email:
 - bohdan.pohorilets@gmail.com
@@ -175,6 +189,10 @@ files:
 - hash_deep_diff.gemspec
 - lib/hash_deep_diff.rb
 - lib/hash_deep_diff/comparison.rb
+- lib/hash_deep_diff/delta/acts_as_delta.rb
+- lib/hash_deep_diff/delta/inner.rb
+- lib/hash_deep_diff/delta/left.rb
+- lib/hash_deep_diff/delta/right.rb
 - lib/hash_deep_diff/version.rb
 homepage: https://github.com/bpohoriletz/hash_deep_diff
 licenses: