deep_merge 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5334ff55416ba9f5edd6e9dca8152561b6e360ac
-  data.tar.gz: 9fa6638a3ffe2ae4733cc861259aced469018b21
+SHA256:
+  metadata.gz: 5e190853b33fb89d42881c6615a17c4fc50757ab261bae87e2639d553cf07dbe
+  data.tar.gz: 3c2d1e368cbc141220ab2a1c2ec7a346d085f7d6f3306f34da16027f08ef6825
 SHA512:
-  metadata.gz: 2f43b30b9fbfed2f10bdde1cfa5b48b3522de796ac13dbdf06632fb89d73fe6e6dbd505c351f9426fe284196cd314e34ace28db15d7d0c115f6181a214d835ee
-  data.tar.gz: 93ba0c97793fa2dbe457b0adae4823d94a1c065cb300de7e01f583154e5a937737d6d224d73823f66b9070c710904a0579a4e5cb844e026766136b9fbe4adcf7
+  metadata.gz: c71ee77b10d24d27d0814d5d23441855b6e1fc226a842f734919622e707aaffa0063e7cdaec7b1591bf5d6a0a1910260b727462074f655cb3a486419d9086165
+  data.tar.gz: 7ed27c1eaa73425856fedc0379c0ecec51d6636ea5abe5f9cf2c48e7d7f36f7ffafc579eca8b3d1b42486a6e2f27ceb2cd99bdfbb27df3d7596f13ad7543482e

data/CHANGELOG

@@ -1,3 +1,26 @@
+2022-01-07 Jason Frey <fryguy9@gmail.com>
+  * Ship version 1.2.2
+
+  * Switched to GitHub actions and add testing of Rubies up to Ruby 3.0
+  * Fixed issue with keep_duplicate_arrays when merging into a nil array. Thanks ALTinners!
+  * Added documentation for keep_duplicate_arrays
+
+2017-11-16 Jason Frey <fryguy9@gmail.com>
+  * Ship version 1.2.1
+
+  * Fixed release date in the gemspec.
+
+2017-11-16 Jason Frey <fryguy9@gmail.com>
+  * Ship version 1.2.0
+
+2017-04-25 Joe Rafaniello <jrafanie@redhat.com>
+  * Merge nil values or keep the original via an option
+
+2016-08-01 Jason Frey <fryguy9@gmail.com>
+  * Ship version 1.1.1
+
+  * Fixed release date in the gemspec.
+
 2016-08-01 Jason Frey <fryguy9@gmail.com>
   * Ship version 1.1.0
 

data/README.md

@@ -1,5 +1,8 @@
-DeepMerge Overview
-==================
+DeepMerge
+=========
+
+[![Gem Version](https://badge.fury.io/rb/deep_merge.svg)](http://badge.fury.io/rb/deep_merge)
+[![CI](https://github.com/danielsdeleo/deep_merge/actions/workflows/ci.yaml/badge.svg)](https://github.com/danielsdeleo/deep_merge/actions/workflows/ci.yaml)
 
 Deep Merge is a simple set of utility functions for Hash. It permits you to merge elements inside a hash together recursively. The manner by which it does this is somewhat arbitrary (since there is no defining standard for this) but it should end up being pretty intuitive and do what you expect.
 
@@ -39,6 +42,10 @@ Options are specified in the last parameter passed, which should be in hash form
       Set to true to merge hashes within arrays
     :extend_existing_arrays DEFAULT: false
       Set to true to extend existing arrays, instead of overwriting them
+    :keep_array_duplicates  DEFAULT: false
+      Set to true to keep duplicate entries in arrays, instead of coalescing them
+    :merge_nil_values       DEFAULT: false
+      Set to true to merge nil hash values, overwriting a possibly non-nil value
     :merge_debug            DEFAULT: false
       Set to true to get console output of merge process for debugging
 
@@ -62,7 +69,6 @@ Additionally, if the knockout_prefix is passed alone as a string, it will cause
     Results: {:x => ""}
 
 **:overwrite_arrays**
-
 The purpose of this is to provide a way to replace Arrays instead of having them merge together.
 
     source = {:x => ['1', '2']}
@@ -71,7 +77,6 @@ The purpose of this is to provide a way to replace Arrays instead of having them
     Results: {:x => ['1', '2']}
 
 **:unpack_arrays**
-
 The purpose of this is to permit compound elements to be passed in as strings and to be converted into discrete array elements
 
     irsource = {:x => ['1,2,3', '4']}
@@ -99,6 +104,33 @@ Push src elements to existing arrays, instead of overwriting them.
     dest.deep_merge!(source, {:extend_existing_arrays => true})
     Results: {"property" => ["1", "2", "3", "4"]}
 
+**:keep_array_duplicates**
+
+Keeps duplicate entries in arrays, instead of coalescing them.
+
+Without this setting:
+
+    source = { "property" => ["2", "3"] }
+    dest   = { "property" => ["1", "2"] }
+    dest.deep_merge!(source)
+    Results: {"property" => ["1", "2", "3"]}
+
+With this setting:
+
+    source = { "property" => ["1", "2"] }
+    dest   = { "property" => ["2", "3"] }
+    dest.deep_merge!(source, {:keep_array_duplicates => true})
+    Results: {"property" => ["1", "2", "2", "3"]}
+
+**:merge_nil_values**
+
+The purpose of this option is to allow nil hash values to be merged.  The prior behavior was to discard nil hash values and remains the default if not specified.
+
+    source = {"item" => nil}
+    dest   = {"item" => "existing"}
+    dest.deep_merge!(source, {:merge_nil_values => true})
+    Results: {"item" => nil}
+
 There are many tests for this library - and you can learn more about the features and usages of deep_merge! by just browsing the test examples.
 
 Using deep_merge in Rails
@@ -127,8 +159,8 @@ Simple Example Code
     y.deep_merge!(x)
     # results: y = {:x => [1,2,3,4,5]}
 
-Availablility
-=============
+Availability
+============
 
 `deep_merge` was written by Steve Midgley, and is now maintained by Daniel DeLeo. The official home of `deep_merge` on the internet is now https://github.com/danielsdeleo/deep_merge
 

data/lib/deep_merge/core.rb

@@ -34,6 +34,8 @@ module DeepMerge
   #      Set to string value to run "Array::join" then "String::split" against all arrays
   #   :merge_hash_arrays      DEFAULT: false
   #      Set to true to merge hashes within arrays
+  #   :keep_array_duplicates  DEFAULT: false
+  #      Set to true to preserve duplicate array entries
   #   :merge_debug            DEFAULT: false
   #      Set to true to get console output of merge process for debugging
   #
@@ -64,7 +66,13 @@ module DeepMerge
   #   dest   = {:x => [{:z => 2}]}
   #   dest.deep_merge!(source, {:merge_hash_arrays => true})
   #   Results: {:x => [{:y => 1, :z => 2}]}
-  # 
+  #
+  # :keep_array_duplicates => merges arrays within hashes but keeps duplicate elements
+  #   source = {:x => {:y => [1,2,2,2,3]}}
+  #   dest   = {:x => {:y => [4,5,6]}}
+  #   dest.deep_merge!(source, {:keep_array_duplicates => true})
+  #   Results: {:x => {:y => [1,2,2,2,3,4,5,6]}}
+  #
   # There are many tests for this library - and you can learn more about the features
   # and usages of deep_merge! by just browsing the test examples
   def self.deep_merge!(source, dest, options = {})
@@ -84,10 +92,14 @@ module DeepMerge
     merge_hash_arrays = options[:merge_hash_arrays] || false
     # request to extend existing arrays, instead of overwriting them
     extend_existing_arrays = options[:extend_existing_arrays] || false
+    # request that arrays keep duplicate elements
+    keep_array_duplicates = options[:keep_array_duplicates] || false
+    # request that nil values are merged or skipped (Skipped/false by default)
+    merge_nil_values = options[:merge_nil_values] || false
 
     di = options[:debug_indent] || ''
     # do nothing if source is nil
-    return dest if source.nil?
+    return dest if !merge_nil_values && source.nil?
     # if dest doesn't exist, then simply copy source to it
     if !(dest) && overwrite_unmergeable
       dest = source; return dest
@@ -110,6 +122,11 @@ module DeepMerge
             rescue TypeError
               src_dup = src_value
             end
+            if src_dup.kind_of?(Array) && keep_array_duplicates
+              # note: in this case the merge will be additive, rather than a bounded set, so we can't simply merge src with itself
+              # We need to merge src with an empty array
+              src_dup = []
+            end
             dest[src_key] = deep_merge!(src_value, src_dup, options.merge(:debug_indent => di + '  '))
           end
         elsif dest.kind_of?(Array) && extend_existing_arrays
@@ -168,6 +185,8 @@ module DeepMerge
             end
             list += source[dest.count..-1] if source.count > dest.count
             dest = list
+          elsif keep_array_duplicates
+            dest = dest.concat(source)
           else
             dest = dest | source
           end

data/test/test_deep_merge.rb

@@ -622,5 +622,30 @@ class TestDeepMerge < Test::Unit::TestCase
     hash_src = {"item" => s2 }
     DeepMerge::deep_merge!(hash_src, hash_dst)
     assert_equal({"item" => ""}, hash_dst)
+
+    ######################################
+    # tests for "keep_array_duplicates" option
+    hash_src = {"item" => ["2", "3"]}
+    hash_dst = {"item" => ["1", "2"]}
+    DeepMerge::deep_merge!(hash_src, hash_dst, {:keep_array_duplicates => true})
+    assert_equal({"item" => ["1", "2", "2", "3"]}, hash_dst)
+
+    # For Issue 34 - keep_array_duplicates against a nil src doesn't do a recursive merge
+    hash_src = {"item" => ["2", "3"]}
+    hash_dst = { }
+    DeepMerge::deep_merge!(hash_src, hash_dst, {:keep_array_duplicates => true})
+    assert_equal({"item" => ["2", "3"]}, hash_dst)
+
+    # Don't merge nil values by default
+    hash_src = {"item" => nil}
+    hash_dst = {"item" => "existing"}
+    DeepMerge::deep_merge!(hash_src, hash_dst)
+    assert_equal({"item" => "existing"}, hash_dst)
+
+    # Merge nil values via an explicit: :merge_nil_values => true
+    hash_src = {"item" => nil}
+    hash_dst = {"item" => "existing"}
+    DeepMerge::deep_merge!(hash_src, hash_dst, {:merge_nil_values => true})
+    assert_equal({"item" => nil}, hash_dst)
   end # test_deep_merge
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_merge
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Steve Midgley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-07-28 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,7 +59,7 @@ homepage: https://github.com/danielsdeleo/deep_merge
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,9 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Merge Deeply Nested Hashes
 test_files: