deep_merge 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f913722448f3e72d18adb80b86afbb4a003c10de
-  data.tar.gz: f3823fab6b9906a8149f7b17325043ff84be3e17
+  metadata.gz: 5334ff55416ba9f5edd6e9dca8152561b6e360ac
+  data.tar.gz: 9fa6638a3ffe2ae4733cc861259aced469018b21
 SHA512:
-  metadata.gz: 6aac94519acdebed405367cec544ca627e95523b9662d75bcf87f68b391f14d9c7f41c4ff6caca8b760eb4fa4fecc10686762c9c4ee5f54a5aa323e97172e2cf
-  data.tar.gz: f03e7183467b02ee60a4dfacbc056e107c449ca4d74d20a10481bc2e619ceb03eafdf27056563b846272a8ecdfd98e64fd17c5ee7e5bfb89d9d726bb45d6d5bb
+  metadata.gz: 2f43b30b9fbfed2f10bdde1cfa5b48b3522de796ac13dbdf06632fb89d73fe6e6dbd505c351f9426fe284196cd314e34ace28db15d7d0c115f6181a214d835ee
+  data.tar.gz: 93ba0c97793fa2dbe457b0adae4823d94a1c065cb300de7e01f583154e5a937737d6d224d73823f66b9070c710904a0579a4e5cb844e026766136b9fbe4adcf7

data/CHANGELOG

@@ -1,4 +1,20 @@
+2016-08-01 Jason Frey <fryguy9@gmail.com>
+  * Ship version 1.1.0
+
+  * Add testing for newer Ruby 2.2, 2.3, head, and jruby-head.
+
+2016-06-14 Michael Sievers <michael_sievers@web.de>
+  * Add extend_existing_arrays option
+
+2016-06-07 Jason Frey <fryguy9@gmail.com>
+  * Add overwrite_arrays option
+
+2016-04-08 Dan Deleo <dan@kallistec.com>
+  * Remove support for old Ruby 1.8 and 1.9
+
 2014-01-21 Dan DeLeo <dan@kallistec.com>
+  * Ship version 1.0.1
+
   * Update knockout behavior to better handle nil (b7de40b5)
 
 2011-08-15 Dan DeLeo <dan@kallistec.com>

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2008-2016 Steve Midgley, Daniel DeLeo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -29,12 +29,16 @@ Options are specified in the last parameter passed, which should be in hash form
       Set to true to skip any unmergeable elements from source
     :knockout_prefix        DEFAULT: nil
       Set to string value to signify prefix which deletes elements from existing element
+    :overwrite_arrays       DEFAULT: false
+      Set to true if you want to avoid merging arrays
     :sort_merged_arrays     DEFAULT: false
       Set to true to sort all arrays that are merged together
     :unpack_arrays          DEFAULT: nil
       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
+    :extend_existing_arrays DEFAULT: false
+      Set to true to extend existing arrays, instead of overwriting them
     :merge_debug            DEFAULT: false
       Set to true to get console output of merge process for debugging
 
@@ -57,6 +61,15 @@ Additionally, if the knockout_prefix is passed alone as a string, it will cause
     dest.ko_deep_merge!(source)
     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']}
+    dest   = {:x => ['3', '4']}
+    dest.deep_merge!(source, {:overwrite_arrays => true})
+    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
@@ -77,6 +90,15 @@ merge hashes within arrays
     dest.deep_merge!(source, {:merge_hash_arrays => true})
     Results: {:x => [{:y => 1, :z => 2}]}
 
+**:extend_existing_arrays**
+
+Push src elements to existing arrays, instead of overwriting them.
+
+    source = { "property" => "4" }
+    dest   = { "property" => ["1", "2", "3"] }
+    dest.deep_merge!(source, {:extend_existing_arrays => true})
+    Results: {"property" => ["1", "2", "3", "4"]}
+
 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
@@ -110,4 +132,4 @@ Availablility
 
 `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
 
-Copyright (c) 2008 Steve Midgley, released under the MIT license
+Copyright (c) 2008-2016 Steve Midgley, released under the MIT license

data/lib/deep_merge/core.rb

@@ -26,6 +26,8 @@ module DeepMerge
   #      Set to true to skip any unmergeable elements from source
   #   :knockout_prefix        DEFAULT: nil
   #      Set to string value to signify prefix which deletes elements from existing element
+  #   :overwrite_arrays       DEFAULT: false
+  #      Set to true if you want to avoid merging arrays
   #   :sort_merged_arrays     DEFAULT: false
   #      Set to true to sort all arrays that are merged together
   #   :unpack_arrays          DEFAULT: nil
@@ -74,10 +76,15 @@ module DeepMerge
     raise InvalidParameter, "overwrite_unmergeable must be true if knockout_prefix is specified in deep_merge!" if knockout_prefix && !overwrite_unmergeable
     # if present: we will split and join arrays on this char before merging
     array_split_char = options[:unpack_arrays] || false
+    # request that we avoid merging arrays
+    overwrite_arrays = options[:overwrite_arrays] || false
     # request that we sort together any arrays when they are merged
     sort_merged_arrays = options[:sort_merged_arrays] || false
     # request that arrays of hashes are merged together
     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
+
     di = options[:debug_indent] || ''
     # do nothing if source is nil
     return dest if source.nil?
@@ -105,6 +112,8 @@ module DeepMerge
             end
             dest[src_key] = deep_merge!(src_value, src_dup, options.merge(:debug_indent => di + '  '))
           end
+        elsif dest.kind_of?(Array) && extend_existing_arrays
+          dest.push(source)
         else # dest isn't a hash, so we overwrite it completely (if permitted)
           if overwrite_unmergeable
             puts "#{di}  overwriting dest: #{src_key.inspect} => #{src_value.inspect} -over->  #{dest.inspect}" if merge_debug
@@ -114,58 +123,67 @@ module DeepMerge
       end
     elsif source.kind_of?(Array)
       puts "#{di}Arrays: #{source.inspect} :: #{dest.inspect}" if merge_debug
-      # if we are instructed, join/split any source arrays before processing
-      if array_split_char
-        puts "#{di} split/join on source: #{source.inspect}" if merge_debug
-        source = source.join(array_split_char).split(array_split_char)
-        if dest.kind_of?(Array)
-          dest = dest.join(array_split_char).split(array_split_char)
+      if overwrite_arrays
+        puts "#{di} overwrite arrays" if merge_debug
+        dest = source
+      else
+        # if we are instructed, join/split any source arrays before processing
+        if array_split_char
+          puts "#{di} split/join on source: #{source.inspect}" if merge_debug
+          source = source.join(array_split_char).split(array_split_char)
+          if dest.kind_of?(Array)
+            dest = dest.join(array_split_char).split(array_split_char)
+          end
         end
-      end
-      # if there's a naked knockout_prefix in source, that means we are to truncate dest
-      if knockout_prefix && source.index(knockout_prefix)
-        dest = clear_or_nil(dest); source.delete(knockout_prefix)
-      end
-      if dest.kind_of?(Array)
-        if knockout_prefix
-          print "#{di} knocking out: " if merge_debug
-          # remove knockout prefix items from both source and dest
-          source.delete_if do |ko_item|
-            retval = false
-            item = ko_item.respond_to?(:gsub) ? ko_item.gsub(%r{^#{knockout_prefix}}, "") : ko_item
-            if item != ko_item
-              print "#{ko_item} - " if merge_debug
-              dest.delete(item)
-              dest.delete(ko_item)
-              retval = true
+        # if there's a naked knockout_prefix in source, that means we are to truncate dest
+        if knockout_prefix && source.index(knockout_prefix)
+          dest = clear_or_nil(dest); source.delete(knockout_prefix)
+        end
+        if dest.kind_of?(Array)
+          if knockout_prefix
+            print "#{di} knocking out: " if merge_debug
+            # remove knockout prefix items from both source and dest
+            source.delete_if do |ko_item|
+              retval = false
+              item = ko_item.respond_to?(:gsub) ? ko_item.gsub(%r{^#{knockout_prefix}}, "") : ko_item
+              if item != ko_item
+                print "#{ko_item} - " if merge_debug
+                dest.delete(item)
+                dest.delete(ko_item)
+                retval = true
+              end
+              retval
             end
-            retval
+            puts if merge_debug
           end
-          puts if merge_debug
-        end
-        puts "#{di} merging arrays: #{source.inspect} :: #{dest.inspect}" if merge_debug
-        source_all_hashes = source.all? { |i| i.kind_of?(Hash) }
-        dest_all_hashes = dest.all? { |i| i.kind_of?(Hash) }
-        if merge_hash_arrays && source_all_hashes && dest_all_hashes
-          # merge hashes in lists
-          list = []
-          dest.each_index do |i|
-            list[i] = deep_merge!(source[i] || {}, dest[i],
-                                  options.merge(:debug_indent => di + '  '))
+          puts "#{di} merging arrays: #{source.inspect} :: #{dest.inspect}" if merge_debug
+          source_all_hashes = source.all? { |i| i.kind_of?(Hash) }
+          dest_all_hashes = dest.all? { |i| i.kind_of?(Hash) }
+          if merge_hash_arrays && source_all_hashes && dest_all_hashes
+            # merge hashes in lists
+            list = []
+            dest.each_index do |i|
+              list[i] = deep_merge!(source[i] || {}, dest[i],
+                                    options.merge(:debug_indent => di + '  '))
+            end
+            list += source[dest.count..-1] if source.count > dest.count
+            dest = list
+          else
+            dest = dest | source
           end
-          list += source[dest.count..-1] if source.count > dest.count
-          dest = list
-        else
-          dest = dest | source
+          dest.sort! if sort_merged_arrays
+        elsif overwrite_unmergeable
+          puts "#{di} overwriting dest: #{source.inspect} -over-> #{dest.inspect}" if merge_debug
+          dest = overwrite_unmergeables(source, dest, options)
         end
-        dest.sort! if sort_merged_arrays
-      elsif overwrite_unmergeable
-        puts "#{di} overwriting dest: #{source.inspect} -over-> #{dest.inspect}" if merge_debug
-        dest = overwrite_unmergeables(source, dest, options)
       end
     else # src_hash is not an array or hash, so we'll have to overwrite dest
-      puts "#{di}Others: #{source.inspect} :: #{dest.inspect}" if merge_debug
-      dest = overwrite_unmergeables(source, dest, options)
+      if dest.kind_of?(Array) && extend_existing_arrays
+        dest.push(source)
+      else
+        puts "#{di}Others: #{source.inspect} :: #{dest.inspect}" if merge_debug
+        dest = overwrite_unmergeables(source, dest, options)
+      end
     end
     puts "#{di}Returning #{dest.inspect}" if merge_debug
     dest

data/test/test_deep_merge.rb

@@ -87,6 +87,12 @@ class TestDeepMerge < Test::Unit::TestCase
     DeepMerge::deep_merge!(hash_src, hash_dst)
     assert_equal(["2","4","1","3"], hash_dst['property'])
 
+    # hashes holding array (overwrite)
+    hash_src = {"property" => ["1","3"]}
+    hash_dst = {"property" => ["2","4"]}
+    DeepMerge::deep_merge!(hash_src, hash_dst, {:overwrite_arrays => true})
+    assert_equal(["1","3"], hash_dst['property'])
+
     # hashes holding array (sorted)
     hash_src = {"property" => ["1","3"]}
     hash_dst = {"property" => ["2","4"]}
@@ -213,6 +219,18 @@ class TestDeepMerge < Test::Unit::TestCase
     DeepMerge::deep_merge!(hash_src, hash_dst)
     assert_equal({"property" => {"bedroom_count" => {"king_bed" => [nil, 3], "queen_bed" => [4, nil, 1]}, "bathroom_count" => [nil, "2", "1"]}}, hash_dst)
 
+    # if extend_existig_arrays == true && destination.kind_of?(Array) && source element is neither array nor hash, push source to destionation
+    hash_src = { "property" => "4" }
+    hash_dst = { "property" => ["1", "2", "3"] }
+    DeepMerge::deep_merge!(hash_src, hash_dst, :extend_existing_arrays => true)
+    assert_equal({"property" => ["1", "2", "3", "4"]}, hash_dst)
+
+    # if extend_existig_arrays == true && destination.kind_of?(Array) && source.kind_of(Hash), push source to destionation
+    hash_src = { "property" => {:number => "3"} }
+    hash_dst = { "property" => [{:number => "1"}, {:number => "2"}] }
+    DeepMerge::deep_merge!(hash_src, hash_dst, :extend_existing_arrays => true)
+    assert_equal({"property"=>[{:number=>"1"}, {:number=>"2"}, {:number=>"3"}]}, hash_dst)
+
     # test parameter management for knockout_prefix and overwrite unmergable
     assert_raise(DeepMerge::InvalidParameter) {DeepMerge::deep_merge!(hash_src, hash_dst, {:knockout_prefix => ""})}
     assert_raise(DeepMerge::InvalidParameter) {DeepMerge::deep_merge!(hash_src, hash_dst, {:preserve_unmergeables => true, :knockout_prefix => ""})}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep_merge
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Midgley
@@ -24,14 +24,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-description: Recursively merge hashes. Now works with Ruby 1.9 and ActiveSupport
+- !ruby/object:Gem::Dependency
+  name: test-unit-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Recursively merge hashes.
 email: dan@kallistec.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- LICENSE
 - README.md
 files:
 - CHANGELOG
+- LICENSE
 - README.md
 - Rakefile
 - lib/deep_merge.rb
@@ -39,7 +55,7 @@ files:
 - lib/deep_merge/deep_merge_hash.rb
 - lib/deep_merge/rails_compat.rb
 - test/test_deep_merge.rb
-homepage: http://github.com/danielsdeleo/deep_merge
+homepage: https://github.com/danielsdeleo/deep_merge
 licenses:
 - MIT
 metadata: {}
@@ -59,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Merge Deeply Nested Hashes