deep_merge 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbf83a5b4939c61c6e047604df652c2757f3fc1d
-  data.tar.gz: 1cbf2d97322c4d3da88528653b520ea35a42b102
+  metadata.gz: 27ed5e6b4d266ffa2bd3b8dee28813b8325a3a5e
+  data.tar.gz: ae7c33aafbf1277c947f35562638470218612feb
 SHA512:
-  metadata.gz: 8e7fd07ea0293556a89e121499fb30aa7c28dbb31b342c068ebce541bc8a8542585acd0536bf926a5b528c8d8f250ae64237687e76fbad455617042a1b903fbd
-  data.tar.gz: 0d8016b92e27482840907e39faad22d030930c369d333271c27eddcd0472af79aee971f2d8cc5e5a4f842b61fd785cc006d948a8c95b0a46ec83c2e69f322667
+  metadata.gz: 8f5c7e78852559834b2d72fa919c563af40dcf6d77b8e9e04f39128b59630d582fdee9d9544f0dfb2f2ccfa05b70ebb3deb3a2505ec0a56ff0c316e2930b792e
+  data.tar.gz: 8c3ac59055a9165e8e30b79df3800eca340bd781ecebe3c13592327c4e57dca1400ce7fd5e57497e88a40258e32183062a92074f517007762e1f292bf7554d07

data/CHANGELOG

@@ -1,3 +1,9 @@
+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
 

data/README.md

@@ -39,6 +39,8 @@ 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
+    :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
 
@@ -99,6 +101,15 @@ Push src elements to existing arrays, instead of overwriting them.
     dest.deep_merge!(source, {:extend_existing_arrays => true})
     Results: {"property" => ["1", "2", "3", "4"]}
 
+**: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

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
@@ -168,6 +180,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,24 @@ 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)
+
+    # 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep_merge
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Steve Midgley
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Merge Deeply Nested Hashes