hashdiff 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad62d6aa698e908203a17f40c7660c49d8707cd0
-  data.tar.gz: 34b23305366867798029b696354f0197571d3106
+SHA256:
+  metadata.gz: 56a70b8fb995b7d778a1840400c42303c34648a9205055b11157a5b69208afa1
+  data.tar.gz: 410e1bea7bc27e43f4580c42ff17054e1ce57dc3c3f486fe570269e366c7ecb4
 SHA512:
-  metadata.gz: 38621cceb7b659ec8a338edf712de931d06ea59aa18e8d9991262ed4f0b54bf1890c395d7a4391d325e82b05cdb7aa735cca2ef3a9aac1a991ec1f74a283e6b4
-  data.tar.gz: 909dd874ea50b69bd74183e7df1cb0fd1c36e68b46810b0fbca32bc62111c5b2ff3899e5a7f72001c00df9b538195a7ecb57942d9c9fd640eb9bc639fd8358af
+  metadata.gz: 30e90e14ee676c7b035a20d01f5f8cf5dfcdae7319f652bd828c6fcc8d66a4e6b0cb8fd046937ce09a38aac8e7c3eba92dfc60b8ea2e09674eb9c8ea35256e9a
+  data.tar.gz: 146cc4564d22ee6c6ef47b09032e4e171cd2682ecd941e798bd729bea7d3e8a10974356e39500886bd6ec4d0d3d6c109d2e6556bbe47abc7b79a9c9d45db66e4

data/.rubocop.yml

@@ -1,4 +1,6 @@
 require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.0 # always the lowest version we support
 Metrics/PerceivedComplexity:
   Enabled: false
 Metrics/CyclomaticComplexity:
@@ -15,14 +17,24 @@ Metrics/BlockLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+Style/CaseLikeIf:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: true
   EnforcedStyle: always
+Style/OptionalBooleanParameter:
+  Enabled: false
 Style/NumericPredicate:
   Enabled: false
 Style/RedundantFreeze:
   Enabled: false
+Style/RedundantReturn:
+  Enabled: false
 RSpec/ExampleLength:
   Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/FilePath:
+  Enabled: false

data/Gemfile

@@ -4,5 +4,5 @@ source 'http://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rake', '< 11'
+  gem 'rake'
 end

data/README.md

@@ -32,7 +32,7 @@ Hashdiff answers the question above using an opinionated approach:
 
 To use the gem, add the following to your Gemfile:
 
-```ruby
+```Ruby
 gem 'hashdiff'
 ```
 
@@ -94,9 +94,8 @@ Hashdiff.unpatch!(b, diff).should == a
 
 ### Options
 
-There are eight options available: `:delimiter`, `:similarity`,
-`:strict`, `:numeric_tolerance`, `:strip`, `:case_insensitive`, `:array_path`
-and `:use_lcs`
+The following options are available: `:delimiter`, `:similarity`, `:strict`, `:ignore_keys`,
+`:indifferent`, `:numeric_tolerance`, `:strip`, `:case_insensitive`, `:array_path` and `:use_lcs`
 
 #### `:delimiter`
 
@@ -106,7 +105,7 @@ You can specify `:delimiter` to be something other than the default dot. For exa
 a = {a:{x:2, y:3, z:4}, b:{x:3, z:45}}
 b = {a:{y:3}, b:{y:3, z:30}}
 
-diff = Hashdiff.diff(a, b, :delimiter => '\t')
+diff = Hashdiff.diff(a, b, delimiter: '\t')
 diff.should == [['-', 'a\tx', 2], ['-', 'a\tz', 4], ['-', 'b\tx', 3], ['~', 'b\tz', 45, 30], ['+', 'b\ty', 3]]
 ```
 
@@ -118,6 +117,30 @@ In cases where you have similar hash objects in arrays, you can pass a custom va
 
 The `:strict` option, which defaults to `true`, specifies whether numeric types are compared on type as well as value.  By default, an Integer will never be equal to a Float (e.g. 4 != 4.0).  Setting `:strict` to false makes the comparison looser (e.g. 4 == 4.0).
 
+#### `:ignore_keys`
+
+The `:ignore_keys` option allows you to specify one or more keys to ignore, which defaults to `[]` (none). Ignored keys are ignored at all levels. For example:
+
+```ruby
+a = { a: 1, b: { d: 2, a: 3 }, c: 4 }
+b = { a: 2, b: { d: 2, a: 7 }, c: 5 }
+diff = Hashdiff.diff(a, b, ignore_keys: :a)
+diff.should == [['~', 'c', 4, 5]]
+```
+If you wish instead to ignore keys at a particlar level you should 
+use a [custom comparison method](https://github.com/liufengyun/hashdiff#specifying-a-custom-comparison-method) instead. For example:
+
+```ruby
+a = { a: 1, b: { d: 2, a: 3 }, c: 4 }
+b = { a: 2, b: { d: 2, a: 7 }, c: 5 }
+diff = Hashdiff.diff(a, b) { |path, _e, _a| true if path == 'b.a' } # note '.' is the default delimiter
+diff.should == [['~', 'a', 1, 2], ['~', 'c', 4, 5]]
+``` 
+
+#### `:indifferent`
+
+The `:indifferent` option, which defaults to `false`, specifies whether to treat hash keys indifferently.  Setting `:indifferent` to true has the effect of ignoring differences between symbol keys (ie. {a: 1} ~= {'a' => 1})
+
 #### `:numeric_tolerance`
 
 The :numeric_tolerance option allows for a small numeric tolerance.
@@ -126,7 +149,7 @@ The :numeric_tolerance option allows for a small numeric tolerance.
 a = {x:5, y:3.75, z:7}
 b = {x:6, y:3.76, z:7}
 
-diff = Hashdiff.diff(a, b, :numeric_tolerance => 0.1)
+diff = Hashdiff.diff(a, b, numeric_tolerance: 0.1)
 diff.should == [["~", "x", 5, 6]]
 ```
 
@@ -138,7 +161,7 @@ The :strip option strips all strings before comparing.
 a = {x:5, s:'foo '}
 b = {x:6, s:'foo'}
 
-diff = Hashdiff.diff(a, b, :comparison => { :numeric_tolerance => 0.1, :strip => true })
+diff = Hashdiff.diff(a, b, numeric_tolerance: 0.1, strip: true)
 diff.should == [["~", "x", 5, 6]]
 ```
 
@@ -150,7 +173,7 @@ The :case_insensitive option makes string comparisons ignore case.
 a = {x:5, s:'FooBar'}
 b = {x:6, s:'foobar'}
 
-diff = Hashdiff.diff(a, b, :comparison => { :numeric_tolerance => 0.1, :case_insensitive => true })
+diff = Hashdiff.diff(a, b, numeric_tolerance: 0.1, case_insensitive: true)
 diff.should == [["~", "x", 5, 6]]
 ```
 
@@ -164,7 +187,7 @@ is useful for `patch!` when used on hashes without string keys.
 a = {x:5}
 b = {'x'=>6}
 
-diff = Hashdiff.diff(a, b, :array_path => true)
+diff = Hashdiff.diff(a, b, array_path: true)
 diff.should == [['-', [:x], 5], ['+', ['x'], 6]]
 ```
 
@@ -173,7 +196,7 @@ For cases where there are arrays in paths their index will be added to the path.
 a = {x:[0,1]}
 b = {x:[0,2]}
 
-diff = Hashdiff.diff(a, b, :array_path => true)
+diff = Hashdiff.diff(a, b, array_path: true)
 diff.should == [["-", [:x, 1], 1], ["+", [:x, 1], 2]]
 ```
 
@@ -183,7 +206,7 @@ This shouldn't cause problems if you are comparing an array with a hash:
 a = {x:{0=>1}}
 b = {x:[1]}
 
-diff = Hashdiff.diff(a, b, :array_path => true)
+diff = Hashdiff.diff(a, b, array_path: true)
 diff.should == [["~", [:x], {0=>1}, [1]]]
 ```
 
@@ -205,7 +228,7 @@ Note, currently the :similarity option has no effect when :use_lcs is false.
 a = {x: [0, 1, 2]}
 b = {x: [0, 2, 2, 3]}
 
-diff = Hashdiff.diff(a, b, :use_lcs => false)
+diff = Hashdiff.diff(a, b, use_lcs: false)
 diff.should == [["~", "x[1]", 1, 2], ["+", "x[3]", 3]]
 ```
 
@@ -255,11 +278,11 @@ An order difference alone between two arrays can create too many diffs to be use
 a = {a:'car', b:['boat', 'plane'] }
 b = {a:'car', b:['plane', 'boat'] }
 
-Hashdiff.diff(a, b) => [["+", "b[0]", "plane"], ["-", "b[2]", "plane"]]
+Hashdiff.diff(a, b).should == [["+", "b[0]", "plane"], ["-", "b[2]", "plane"]]
 
 b[:b].sort!
 
-Hashdiff.diff(a, b) => []
+Hashdiff.diff(a, b).should == []
 ```
 
 ## Maintainers

data/changelog.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## v1.1.0 2020-02-25
+
+* Add ignore_keys option (#86 @Matzfan)
+* Remove pinned version of rake < 11
+* Bump rspec dep ~> 3.5
+* Bump rubocop dep >= 1.52.1
+* Bump rubocop-rspec dep > 1.16.0
+
+## v1.0.1 2020-02-25
+
+* Add indifferent option
+
 ## v1.0.0 2019-06-06
 
 * Fix typo in readme (#72 @koic)

data/hashdiff.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/liufengyun/hashdiff'
 
   s.add_development_dependency('bluecloth')
-  s.add_development_dependency('rspec', '~> 2.0')
-  s.add_development_dependency('rubocop')
-  s.add_development_dependency('rubocop-rspec')
+  s.add_development_dependency('rspec', '~> 3.5')
+  s.add_development_dependency('rubocop', '>= 1.52.1') # earliest version that works with Ruby 3.3
+  s.add_development_dependency('rubocop-rspec', '> 1.16.0') # https://github.com/rubocop/rubocop-rspec/issues/461
   s.add_development_dependency('yard')
 
   if s.respond_to?(:metadata)

data/lib/hashdiff/compare_hashes.rb

@@ -10,6 +10,15 @@ module Hashdiff
 
         obj1_keys = obj1.keys
         obj2_keys = obj2.keys
+        obj1_lookup = {}
+        obj2_lookup = {}
+
+        if opts[:indifferent]
+          obj1_lookup = obj1_keys.each_with_object({}) { |k, h| h[k.to_s] = k }
+          obj2_lookup = obj2_keys.each_with_object({}) { |k, h| h[k.to_s] = k }
+          obj1_keys = obj1_keys.map { |k| k.is_a?(Symbol) ? k.to_s : k }
+          obj2_keys = obj2_keys.map { |k| k.is_a?(Symbol) ? k.to_s : k }
+        end
 
         added_keys = (obj2_keys - obj1_keys).sort_by(&:to_s)
         common_keys = (obj1_keys & obj2_keys).sort_by(&:to_s)
@@ -17,8 +26,11 @@ module Hashdiff
 
         result = []
 
+        opts[:ignore_keys].each { |k| common_keys.delete k }
+
         # add deleted properties
         deleted_keys.each do |k|
+          k = opts[:indifferent] ? obj1_lookup[k] : k
           change_key = Hashdiff.prefix_append_key(opts[:prefix], k, opts)
           custom_result = Hashdiff.custom_compare(opts[:comparison], change_key, obj1[k], nil)
 
@@ -33,13 +45,16 @@ module Hashdiff
         common_keys.each do |k|
           prefix = Hashdiff.prefix_append_key(opts[:prefix], k, opts)
 
-          result.concat(Hashdiff.diff(obj1[k], obj2[k], opts.merge(prefix: prefix)))
+          k1 = opts[:indifferent] ? obj1_lookup[k] : k
+          k2 = opts[:indifferent] ? obj2_lookup[k] : k
+          result.concat(Hashdiff.diff(obj1[k1], obj2[k2], opts.merge(prefix: prefix)))
         end
 
         # added properties
         added_keys.each do |k|
           change_key = Hashdiff.prefix_append_key(opts[:prefix], k, opts)
 
+          k = opts[:indifferent] ? obj2_lookup[k] : k
           custom_result = Hashdiff.custom_compare(opts[:comparison], change_key, nil, obj2[k])
 
           if custom_result

data/lib/hashdiff/diff.rb

@@ -9,6 +9,8 @@ module Hashdiff
   # @param [Array, Hash] obj2
   # @param [Hash] options the options to use when comparing
   #   * :strict (Boolean) [true] whether numeric values will be compared on type as well as value.  Set to false to allow comparing Integer, Float, BigDecimal to each other
+  #   * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s)
+  #   * :indifferent (Boolean) [false] whether to treat hash keys indifferently.  Set to true to ignore differences between symbol keys (ie. {a: 1} ~= {'a' => 1})
   #   * :delimiter (String) ['.'] the delimiter used when returning nested key references
   #   * :numeric_tolerance (Numeric) [0] should be a positive numeric value.  Value by which numeric differences must be greater than.  By default, numeric values are compared exactly; with the :tolerance option, the difference between numeric values must be greater than the given value.
   #   * :strip (Boolean) [false] whether or not to call #strip on strings before comparing
@@ -52,6 +54,8 @@ module Hashdiff
   # @param [Array, Hash] obj2
   # @param [Hash] options the options to use when comparing
   #   * :strict (Boolean) [true] whether numeric values will be compared on type as well as value.  Set to false to allow comparing Integer, Float, BigDecimal to each other
+  #   * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s)
+  #   * :indifferent (Boolean) [false] whether to treat hash keys indifferently.  Set to true to ignore differences between symbol keys (ie. {a: 1} ~= {'a' => 1})
   #   * :similarity (Numeric) [0.8] should be between (0, 1]. Meaningful if there are similar hashes in arrays. See {best_diff}.
   #   * :delimiter (String) ['.'] the delimiter used when returning nested key references
   #   * :numeric_tolerance (Numeric) [0] should be a positive numeric value.  Value by which numeric differences must be greater than.  By default, numeric values are compared exactly; with the :tolerance option, the difference between numeric values must be greater than the given value.
@@ -79,6 +83,8 @@ module Hashdiff
       similarity: 0.8,
       delimiter: '.',
       strict: true,
+      ignore_keys: [],
+      indifferent: false,
       strip: false,
       numeric_tolerance: 0,
       array_path: false,
@@ -87,6 +93,8 @@ module Hashdiff
 
     opts[:prefix] = [] if opts[:array_path] && opts[:prefix] == ''
 
+    opts[:ignore_keys] = [*opts[:ignore_keys]] # splat covers single sym/string case
+
     opts[:comparison] = block if block_given?
 
     # prefer to compare with provided block

data/lib/hashdiff/util.rb

@@ -16,7 +16,7 @@ module Hashdiff
 
     diffs = count_diff diff(obja, objb, opts)
 
-    (1 - diffs.to_f / (count_a + count_b).to_f) >= opts[:similarity]
+    (1 - diffs / (count_a + count_b).to_f) >= opts[:similarity]
   end
 
   # @private
@@ -107,6 +107,7 @@ module Hashdiff
   # check if objects are comparable
   def self.comparable?(obj1, obj2, strict = true)
     return true if (obj1.is_a?(Array) || obj1.is_a?(Hash)) && obj2.is_a?(obj1.class)
+    return true if (obj2.is_a?(Array) || obj2.is_a?(Hash)) && obj1.is_a?(obj2.class)
     return true if !strict && obj1.is_a?(Numeric) && obj2.is_a?(Numeric)
 
     obj1.is_a?(obj2.class) && obj2.is_a?(obj1.class)

data/lib/hashdiff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hashdiff
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/hashdiff/diff_spec.rb

@@ -49,6 +49,26 @@ describe Hashdiff do
     diff.should == []
   end
 
+  context 'with the ignore_keys option' do
+    a = { a: 1, b: { d: 2, a: 3 }, c: 4 }
+    b = { a: 2, b: { d: 2, a: 7 }, c: 5 }
+
+    it 'ignores a single key' do
+      diff = described_class.diff(a, b, ignore_keys: :a)
+      diff.should == [['~', 'c', 4, 5]]
+    end
+
+    it 'ignores an array of keys' do
+      diff = described_class.diff(a, b, ignore_keys: %i[a c])
+      diff.should == []
+    end
+  end
+
+  it 'ignores string vs symbol differences, when indifferent is true' do
+    diff = described_class.diff({ 'a' => 2, :b => 2 }, { :a => 2, 'b' => 2, :c => 3 }, indifferent: true)
+    diff.should == [['+', 'c', 3]]
+  end
+
   it 'is able to diff changes in hash value' do
     diff = described_class.diff({ 'a' => 2, 'b' => 3, 'c' => ' hello' }, 'a' => 2, 'b' => 4, 'c' => 'hello')
     diff.should == [['~', 'b', 3, 4], ['~', 'c', ' hello', 'hello']]

data/spec/hashdiff/readme_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'README.md' do
+  it 'has correct examples' do
+    File.read('README.md').scan(/```ruby(.*?)```/m).flatten(1).each do |block|
+      begin
+        eval block # rubocop:disable Security/Eval
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        raise "README.md code block:\n#{block}\n\nhas error:\n#{e}"
+      end
+    end
+  end
+end

data/spec/hashdiff/util_spec.rb

@@ -68,6 +68,7 @@ describe Hashdiff do
     it 'compares different objects without tolerance' do
       expect(described_class.compare_values('hats', 'ninjas')).to be false
     end
+
     it 'compares other objects with tolerance' do
       expect(described_class.compare_values('hats', 'ninjas', numeric_tolerance: 0.01)).to be false
     end
@@ -92,4 +93,24 @@ describe Hashdiff do
       expect(described_class.compare_values('horse', 'Horse', case_insensitive: true)).to be true
     end
   end
+
+  describe '.comparable?' do
+    it 'identifies hashes as comparable' do
+      expect(described_class.comparable?({}, {})).to be true
+    end
+
+    it 'identifies a subclass of Hash to be comparable with a Hash' do
+      other = Class.new(Hash)
+      expect(described_class.comparable?(other.new, {})).to be true
+    end
+
+    it 'identifies a Hash to be comparable with a subclass of Hash' do
+      other = Class.new(Hash)
+      expect(described_class.comparable?({}, other.new)).to be true
+    end
+
+    it 'does not identify a Numeric as comparable with a Hash' do
+      expect(described_class.comparable?(1, {})).to be false
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashdiff
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Liu Fengyun
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bluecloth
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.52.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.52.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - spec/hashdiff/lcs_spec.rb
 - spec/hashdiff/linear_compare_array_spec.rb
 - spec/hashdiff/patch_spec.rb
+- spec/hashdiff/readme_spec.rb
 - spec/hashdiff/util_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/liufengyun/hashdiff
@@ -125,7 +126,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/hashdiff
   homepage_uri: https://github.com/liufengyun/hashdiff
   source_code_uri: https://github.com/liufengyun/hashdiff
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Hashdiff is a diff lib to compute the smallest difference between two hashes.
 test_files: []