+name: ci

+

+on:

+ - pull_request

+ - push

+

+jobs:

+ build:

+ strategy:

+ fail-fast: false

+ matrix:

+ ruby:

+ - 2.7

+ - '3.0'

+ - 3.1

+ - 3.2

+ - 3.3

+ runs-on: ubuntu-latest

+ steps:

+ - uses: actions/checkout@v4

+ - name: Set up Ruby

+ uses: ruby/setup-ruby@v1

+ with:

+ ruby-version: ${{ matrix.ruby }}

+ bundler-cache: true # 'bundle install' and cache gems

+ - name: Run rake

+ run: bundle exec rake

+Layout/LineLength:

+RSpec/SpecFilePathFormat:

+ Enabled: false

+RSpec/NoExpectationExample:

+source 'https://rubygems.org'

+# Hashdiff [](https://github.com/liufengyun/hashdiff/actions?query=workflow%3Aci) [](http://badge.fury.io/rb/hashdiff)

+`:indifferent`, `:numeric_tolerance`, `:strip`, `:case_insensitive`, `:array_path`,

+`:use_lcs`, and `:preserve_key_order`

+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 in both hashes. For example:

+a = { a: 4, g: 0, b: { a: 5, c: 6, e: 1 } }

+b = { b: { a: 7, c: 3, f: 1 }, d: 8 }

+diff = Hashdiff.diff(a, b, ignore_keys: %i[a f])

+diff.should == [['-', 'g', 0], ['-', 'b.e', 1], ['~', 'b.c', 6, 3], ['+', 'd', 8]]

+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 to diff only at the 2nd level of both hashes:

+a = { a: 4, g: 0, b: { a: 5, c: 6, e: 1 } }

+b = { b: { a: 7, c: 3, f: 1 }, d: 8 }

+diff = Hashdiff.diff(a, b) do |path, _e, _a|

+ arr = path.split('.')

+ true if %w[a f].include?(arr.last) && arr.size == 2 # note '.' is the default delimiter

+end

+diff.should == [['-', 'a', 4], ['-', 'g', 0], ['-', 'b.e', 1], ['~', 'b.c', 6, 3], ['+', 'd', 8]]

+```

+#### `:preserve_key_order`

+

+By default, the change set is ordered by operation type: deletions (-) first, then updates (~), and finally additions (+).

+Within each operation group, keys are sorted alphabetically:

+

+```ruby

+a = {d: 1, c: 1, a: 1}

+b = {d: 2, b: 2, a: 2}

+

+diff = Hashdiff.diff(a, b)

+diff.should == [["-", "c", 1], ["~", "a", 1, 2], ["~", "d", 1, 2], ["+", "b", 2]]

+```

+

+Setting :preserve_key_order to true processes keys in the order they appear in the first hash.

+Keys that only exist in the second hash are appended in their original order:

+

+```ruby

+a = {d: 1, c: 1, a: 1}

+b = {d: 2, b: 2, a: 2}

+

+diff = Hashdiff.diff(a, b, preserve_key_order: true)

+diff.should == [["~", "d", 1, 2], ["-", "c", 1], ["~", "a", 1, 2], ["+", "b", 2]]

+```

+

+## v1.2.1 2025-09-06

+* Use HTTPS for the source in the Gemfile [#101](https://github.com/liufengyun/hashdiff/issues/101) ([@krzysiek1507](https://github.com/krzysiek1507))

+

+## v1.2.0 2025-5-20

+

+* Added :preserve_key_order option to maintain original hash key order [#99](https://github.com/liufengyun/hashdiff/issues/99) ([@robkiessling](https://github.com/robkiessling))

+

+## v1.1.2 2024-11-12

+

+* Fix bundler cache [#96](https://github.com/liufengyun/hashdiff/issues/96) ([@olleolleolle](https://github.com/olleolleolle))

+* Quote the '3.0' in YAML [#95](https://github.com/liufengyun/hashdiff/issues/95) ([@olleolleolle](https://github.com/olleolleolle))

+* Fix version in source code [#97](https://github.com/liufengyun/hashdiff/issues/97) ([@liufengyun](https://github.com/liufengyun))

+

+## v1.1.1 2024-08-02

+

+* Fix bug in ignore_keys option [#88](https://github.com/liufengyun/hashdiff/issues/88) ([@Matzfan](https://github.com/Matzfan))

+* Exclude spec files from gem package [#94](https://github.com/liufengyun/hashdiff/issues/94) ([@amatsuda](https://github.com/amatsuda))

+

+## v1.1.0 2023-12-14

+

+* Add ignore_keys option ([#86](https://github.com/liufengyun/hashdiff/issues/86) [@Matzfan](https://github.com/Matzfan))

+* Fix typo in readme ([#72](https://github.com/liufengyun/hashdiff/issues/72) [@koic](https://github.com/koic))

+* Fix Rubocop offence ([#73](https://github.com/liufengyun/hashdiff/issues/73) [@koic](https://github.com/koic))

+* Bumps version to v1.0.0 ([#74](https://github.com/liufengyun/hashdiff/issues/74) [@jfelchner](https://github.com/jfelchner))

+* fix warnings in ci ([#69](https://github.com/liufengyun/hashdiff/issues/69) [@y-yagi](https://github.com/y-yagi))

+* drop warnings of the constant change ([#70](https://github.com/liufengyun/hashdiff/issues/70) [@jfelchner](https://github.com/jfelchner))

+* refactoring ([#56](https://github.com/liufengyun/hashdiff/issues/56) [#57](https://github.com/liufengyun/hashdiff/issues/57) [#59](https://github.com/liufengyun/hashdiff/issues/59) [#61](https://github.com/liufengyun/hashdiff/issues/61) [@krzysiek1507](https://github.com/krzysiek1507))

+* fix typo in README ([#64](https://github.com/liufengyun/hashdiff/issues/64) [@pboling](https://github.com/pboling))

+* change HashDiff to Hashdiff ([#65](https://github.com/liufengyun/hashdiff/issues/65) [@jfelchner](https://github.com/jfelchner))

+* Performance tweak (thanks [@krzysiek1507](https://github.com/krzysiek1507): [#51](https://github.com/liufengyun/hashdiff/issues/51) [#52](https://github.com/liufengyun/hashdiff/issues/52) [#53](https://github.com/liufengyun/hashdiff/issues/53))

+* Add Rubocop and drops Ruby 1.9 support [#47](https://github.com/liufengyun/hashdiff/issues/47)

+* remove 1.8.7 support from gemspec [#39](https://github.com/liufengyun/hashdiff/issues/39)

+* add option `use_lcs` [#35](https://github.com/liufengyun/hashdiff/issues/35)

+* add option `array_path` [#34](https://github.com/liufengyun/hashdiff/issues/34)

+* performance improvement of `#similar?` [#31](https://github.com/liufengyun/hashdiff/issues/31)

+* replace `Fixnum` by `Integer` [#28](https://github.com/liufengyun/hashdiff/issues/28)

+* fix an error when a hash has mixed types [#26](https://github.com/liufengyun/hashdiff/issues/26)

+* improve performance of LCS algorithm [#12](https://github.com/liufengyun/hashdiff/issues/12)

+ruby-hashdiff (1.2.1-1) unstable; urgency=medium

+

+ * Team upload.

+ * Use GitHub in watch to include tests.

+ * New upstream release.

+ * Update Standards-Version to 4.7.2, no changes needed.

+

+ -- Simon Quigley <tsimonq2@debian.org> Tue, 04 Nov 2025 09:05:46 -0600

+

+Standards-Version: 4.7.2

+[DEFAULT]

+debian-branch = debian/latest

+upstream-branch = upstream/latest

+pristine-tar = True

+---

+include:

+ - https://salsa.debian.org/ruby-team/meta/raw/master/salsa-ci.yml

+https://github.com/liufengyun/hashdiff/tags .*/v?(\d.*)@ARCHIVE_EXT@

+ s.files = `git ls-files`.split("\n").grep_v(%r{^spec/})

+ added_keys = obj2_keys - obj1_keys

+ common_keys = obj1_keys & obj2_keys

+ deleted_keys = obj1_keys - obj2_keys

+ opts[:ignore_keys].each do |k|

+ added_keys.delete k

+ common_keys.delete k

+ deleted_keys.delete k

+ handle_key = lambda do |k, type|

+ case type

+ when :deleted

+ # add deleted properties

+ 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)

+ if custom_result

+ result.concat(custom_result)

+ else

+ result << ['-', change_key, obj1[k]]

+ end

+ when :common

+ # recursive comparison for common keys

+ prefix = Hashdiff.prefix_append_key(opts[:prefix], k, opts)

+ 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)))

+ when :added

+ # added properties

+ 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

+ result.concat(custom_result)

+ else

+ result << ['+', change_key, obj2[k]]

+ end

+ raise "Invalid type: #{type}"

+ end

+ end

+

+ if opts[:preserve_key_order]

+ # Building lookups to speed up key classification

+ added_keys_lookup = added_keys.each_with_object({}) { |k, h| h[k] = true }

+ common_keys_lookup = common_keys.each_with_object({}) { |k, h| h[k] = true }

+ deleted_keys_lookup = deleted_keys.each_with_object({}) { |k, h| h[k] = true }

+

+ # Iterate through all keys, preserving obj1's key order and appending any new keys from obj2. Shared keys

+ # (found in both obj1 and obj2) follow obj1's order since uniq only keeps the first occurrence.

+ (obj1_keys + obj2_keys).uniq.each do |k|

+ if added_keys_lookup[k]

+ handle_key.call(k, :added)

+ elsif common_keys_lookup[k]

+ handle_key.call(k, :common)

+ elsif deleted_keys_lookup[k]

+ handle_key.call(k, :deleted)

+ end

+ else

+ # Keys are first grouped by operation type (deletions first, then changes, then additions), and then sorted

+ # alphabetically within each group.

+ deleted_keys.sort_by(&:to_s).each { |k| handle_key.call(k, :deleted) }

+ common_keys.sort_by(&:to_s).each { |k| handle_key.call(k, :common) }

+ added_keys.sort_by(&:to_s).each { |k| handle_key.call(k, :added) }

+ # * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s) in either hash

+ # * :preserve_key_order (Boolean) [false] If false, operations are grouped by type (-, ~, then +) then by hash key alphabetically. If true, preserves the original key order from the first hash and appends new keys from the second hash in order.

+ # * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s) in either hash

+ # * :preserve_key_order (Boolean) [false] If false, operations are grouped by type (-, ~, then +) then by hash key alphabetically. If true, preserves the original key order from the first hash and appends new keys from the second hash in order.

+ use_lcs: true,

+ preserve_key_order: false

+ opts[:ignore_keys] = [*opts[:ignore_keys]]

+ VERSION = '1.2.1'.freeze

+ a = { a: 4, g: 0, b: { a: 5, c: 6, e: 1 } }

+ b = { b: { a: 7, c: 3, f: 1 }, d: 8 }

+ it 'ignores a single key at first level' do

+ diff = described_class.diff(a, b, ignore_keys: :d)

+ diff.should == [['-', 'a', 4], ['-', 'g', 0], ['-', 'b.e', 1], ['~', 'b.a', 5, 7], ['~', 'b.c', 6, 3], ['+', 'b.f', 1]]

+ end

+

+ it 'ignores a single key in nested hash' do

+ diff = described_class.diff(a, b, ignore_keys: :e)

+ diff.should == [['-', 'a', 4], ['-', 'g', 0], ['~', 'b.a', 5, 7], ['~', 'b.c', 6, 3], ['+', 'b.f', 1], ['+', 'd', 8]]

+ end

+

+ it 'ignores a single key at all levels' do

+ diff.should == [['-', 'g', 0], ['-', 'b.e', 1], ['~', 'b.c', 6, 3], ['+', 'b.f', 1], ['+', 'd', 8]]

+ it 'ignores an array of keys at first level' do

+ diff = described_class.diff(a, b, ignore_keys: %i[g b])

+ diff.should == [['-', 'a', 4], ['+', 'd', 8]]

+ end

+

+ it 'ignores an array of keys in nested hash' do

+ diff = described_class.diff(a, b, ignore_keys: %i[c e])

+ diff.should == [['-', 'a', 4], ['-', 'g', 0], ['~', 'b.a', 5, 7], ['+', 'b.f', 1], ['+', 'd', 8]]

+ end

+

+ it 'ignores an array of keys at all levels' do

+ diff = described_class.diff(a, b, ignore_keys: %i[a f])

+ diff.should == [['-', 'g', 0], ['-', 'b.e', 1], ['~', 'b.c', 6, 3], ['+', 'd', 8]]

+

+ context 'when :preserve_key_order is nil or false' do

+ # rubocop:disable Layout/ExtraSpacing

+ it 'sorts hash changes by operation type (-, ~, +), then alphabetically by key' do

+ a = { 'f' => 1, 'd' => 1, 'c' => 1, 'a' => 1 }

+ b = { 'e' => 2, 'd' => 2, 'b' => 2, 'a' => 2 }

+

+ diff = described_class.diff(a, b)

+ expect(diff).to eq([['-', 'c', 1], ['-', 'f', 1], ['~', 'a', 1, 2], ['~', 'd', 1, 2], ['+', 'b', 2], ['+', 'e', 2]])

+ end

+

+ it 'sorts changes at each level of a nested hash by operation type, then alphabetically by key' do

+ a = { 'y' => { 'c' => 1, 'b' => 1, 'a' => 1 }, 'x' => { 'b' => 1 } }

+ b = { 'y' => { 'b' => 2 }, 'x' => { 'c' => 2, 'b' => 2, 'a' => 2 } }

+

+ diff = described_class.diff(a, b)

+ expect(diff).to eq([['~', 'x.b', 1, 2], ['+', 'x.a', 2], ['+', 'x.c', 2], ['-', 'y.a', 1], ['-', 'y.c', 1], ['~', 'y.b', 1, 2]])

+ end

+ # rubocop:enable Layout/ExtraSpacing

+ end

+

+ context 'when :preserve_key_order is true' do

+ # rubocop:disable Layout/ExtraSpacing

+ it 'preserves the key order from the first hash and appends new keys from the second hash in their original order' do

+ a = { 'f' => 1, 'd' => 1, 'c' => 1, 'a' => 1 }

+ b = { 'e' => 2, 'd' => 2, 'b' => 2, 'a' => 2 }

+

+ diff = described_class.diff(a, b, preserve_key_order: true)

+ expect(diff).to eq([['-', 'f', 1], ['~', 'd', 1, 2], ['-', 'c', 1], ['~', 'a', 1, 2], ['+', 'e', 2], ['+', 'b', 2]])

+ end

+

+ it 'preserves the key order at each level of a nested hash and appends new keys from the second hash in their original order' do

+ a = { 'y' => { 'c' => 1, 'b' => 1, 'a' => 1 }, 'x' => { 'b' => 1 } }

+ b = { 'y' => { 'b' => 2 }, 'x' => { 'c' => 2, 'b' => 2, 'a' => 2 } }

+

+ diff = described_class.diff(a, b, preserve_key_order: true)

+ expect(diff).to eq([['-', 'y.c', 1], ['~', 'y.b', 1, 2], ['-', 'y.a', 1], ['~', 'x.b', 1, 2], ['+', 'x.c', 2], ['+', 'x.a', 2]])

+ end

+ # rubocop:enable Layout/ExtraSpacing

+ end