deep_merge 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f913722448f3e72d18adb80b86afbb4a003c10de
+  data.tar.gz: f3823fab6b9906a8149f7b17325043ff84be3e17
+SHA512:
+  metadata.gz: 6aac94519acdebed405367cec544ca627e95523b9662d75bcf87f68b391f14d9c7f41c4ff6caca8b760eb4fa4fecc10686762c9c4ee5f54a5aa323e97172e2cf
+  data.tar.gz: f03e7183467b02ee60a4dfacbc056e107c449ca4d74d20a10481bc2e619ceb03eafdf27056563b846272a8ecdfd98e64fd17c5ee7e5bfb89d9d726bb45d6d5bb

data/CHANGELOG

@@ -1,3 +1,14 @@
+2014-01-21 Dan DeLeo <dan@kallistec.com>
+  * Update knockout behavior to better handle nil (b7de40b5)
+
+2011-08-15 Dan DeLeo <dan@kallistec.com>
+  * Document how to use w/ Rails 3 via Bundler
+
+2011-07-28 Dan DeLeo <dan@kallistec.com>
+  * Use a plain ol' gemspec and Rakefile for gem creation
+
+  * Ship version 1.0.0
+
 2011-05-23  Joe Van Dyk <joe@fixieconsulting.com>
 
   * Added Changelog
@@ -10,12 +21,12 @@
 
   * Removing extra whitespace
 
-2010-01-11  Dan DeLeo <danielsdeleo@mac.com>
+2010-01-11  Dan DeLeo <dan@kallistec.com>
 
   * fix boolean merging according to mdkent's patch explicitly test 
     for nils w/ #nil? instead of negating. Thanks mdkent!
 
-2009-12-25  Dan DeLeo <danielsdeleo@mac.com>
+2009-12-25  Dan DeLeo <dan@kallistec.com>
 
   * miscellaneous cleanup
 
@@ -23,7 +34,7 @@
 
   * add jeweler rake task for gemability
 
-2009-12-24  Dan DeLeo <danielsdeleo@mac.com>
+2009-12-24  Dan DeLeo <dan@kallistec.com>
 
   * VERSION: Version bump to 0.0.1
 

data/README.md

@@ -0,0 +1,113 @@
+DeepMerge Overview
+==================
+
+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.
+
+You can learn a lot more about this by reading the test file. It's pretty well documented and has many examples of various merges from very simple to pretty complex.
+
+The primary need that caused me to write this library is the merging of elements coming from HTTP parameters and related stored parameters in session. This lets a user build up a set of parameters over time, modifying individual items.
+
+Deep Merge Core Documentation
+=============================
+
+`deep_merge!` method permits merging of arbitrary child elements. The two top level elements must be hashes. These hashes can contain unlimited (to stack limit) levels of child elements. These child elements to not have to be of the same types. Where child elements are of the same type, `deep_merge` will attempt to merge them together. Where child elements are not of the same type, `deep_merge` will skip or optionally overwrite the destination element with the contents of the source element at that level. So if you have two hashes like this:
+
+    source = {:x => [1,2,3], :y => 2}
+    dest =   {:x => [4,5,'6'], :y => [7,8,9]}
+    dest.deep_merge!(source)
+    Results: {:x => [1,2,3,4,5,'6'], :y => 2}
+
+By default, `deep_merge!` will overwrite any unmergeables and merge everything else. To avoid this, use `deep_merge` (no bang/exclamation mark)
+
+Options
+-------
+
+Options are specified in the last parameter passed, which should be in hash format:
+
+    hash.deep_merge!({:x => [1,2]}, {:knockout_prefix => '--'})
+    :preserve_unmergeables  DEFAULT: false
+      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
+    :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
+    :merge_debug            DEFAULT: false
+      Set to true to get console output of merge process for debugging
+
+Selected Options Details
+------------------------
+
+**:knockout_prefix**
+
+The purpose of this is to provide a way to remove elements from existing Hash by specifying them in a special way in incoming hash
+
+    source = {:x => ['--1', '2']}
+    dest   = {:x => ['1', '3']}
+    dest.ko_deep_merge!(source)
+    Results: {:x => ['2','3']}
+
+Additionally, if the knockout_prefix is passed alone as a string, it will cause the entire element to be removed:
+
+    source = {:x => '--'}
+    dest   = {:x => [1,2,3]}
+    dest.ko_deep_merge!(source)
+    Results: {:x => ""}
+
+**: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']}
+    dest   = {:x => ['5','6','7,8']}
+    dest.deep_merge!(source, {:unpack_arrays => ','})
+    Results: {:x => ['1','2','3','4','5','6','7','8'}
+
+Why: If receiving data from an HTML form, this makes it easy for a checkbox to pass multiple values from within a single HTML element
+
+**:merge_hash_arrays**
+
+merge hashes within arrays
+
+    source = {:x => [{:y => 1}]}
+    dest   = {:x => [{:z => 2}]}
+    dest.deep_merge!(source, {:merge_hash_arrays => true})
+    Results: {:x => [{:y => 1, :z => 2}]}
+
+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
+=========================
+
+To avoid conflict with ActiveSupport, load deep_merge via:
+
+    require 'deep_merge/rails_compat'
+
+In a Gemfile:
+
+    gem "deep_merge", :require => 'deep_merge/rails_compat'
+
+The deep_merge methods will then be defined as
+
+    Hash#deeper_merge
+    Hash#deeper_merge!
+    Hash#ko_deeper_merge!
+
+Simple Example Code
+===================
+
+    require 'deep_merge'
+    x = {:x => [3,4,5]}
+    y = {:x => [1,2,3]}
+    y.deep_merge!(x)
+    # results: y = {:x => [1,2,3,4,5]}
+
+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

data/lib/deep_merge/core.rb

@@ -123,7 +123,7 @@ module DeepMerge
         end
       end
       # if there's a naked knockout_prefix in source, that means we are to truncate dest
-      if source.index(knockout_prefix)
+      if knockout_prefix && source.index(knockout_prefix)
         dest = clear_or_nil(dest); source.delete(knockout_prefix)
       end
       if dest.kind_of?(Array)

data/test/test_deep_merge.rb

@@ -201,6 +201,18 @@ class TestDeepMerge < Test::Unit::TestCase
     DeepMerge::deep_merge!(hash_src, hash_dst)
     assert_equal({"property" => {"bedroom_count" => {2=>3, "king_bed" => [3]}, "bathroom_count" => ["1"]}}, hash_dst)
 
+    # 3 hash layers holding arrays of int, but source includes a nil in the array
+    hash_src = {"property" => {"bedroom_count" => {"king_bed" => [nil], "queen_bed" => [1, nil]}, "bathroom_count" => [nil, "1"]}}
+    hash_dst = {"property" => {"bedroom_count" => {"king_bed" => [2], "queen_bed" => [4]}, "bathroom_count" => ["2"]}}
+    DeepMerge::deep_merge!(hash_src, hash_dst)
+    assert_equal({"property" => {"bedroom_count" => {"king_bed" => [2,nil], "queen_bed" => [4, 1, nil]}, "bathroom_count" => ["2", nil, "1"]}}, hash_dst)
+
+    # 3 hash layers holding arrays of int, but destination includes a nil in the array
+    hash_src = {"property" => {"bedroom_count" => {"king_bed" => [3], "queen_bed" => [1]}, "bathroom_count" => ["1"]}}
+    hash_dst = {"property" => {"bedroom_count" => {"king_bed" => [nil], "queen_bed" => [4, nil]}, "bathroom_count" => [nil,"2"]}}
+    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)
+
     # 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,64 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: deep_merge
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Steve Midgley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-28 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
+date: 2011-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
 description: Recursively merge hashes. Now works with Ruby 1.9 and ActiveSupport
 email: dan@kallistec.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - CHANGELOG
-- README
+- README.md
 - Rakefile
-- VERSION
 - lib/deep_merge.rb
 - lib/deep_merge/core.rb
 - lib/deep_merge/deep_merge_hash.rb
 - lib/deep_merge/rails_compat.rb
 - test/test_deep_merge.rb
-has_rdoc: true
 homepage: http://github.com/danielsdeleo/deep_merge
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Merge Deeply Nested Hashes
-test_files: 
+test_files:
 - test/test_deep_merge.rb

data/README

@@ -1,95 +0,0 @@
-DeepMerge Overview
-==================
-
-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.
-
-You can learn a lot more about this by reading the test file. It's pretty
-well documented and has many examples of various merges from very simple
-to pretty complex.
-
-The primary need that caused me to write this library is the merging of elements
-coming from HTTP parameters and related stored parameters in session. This lets
-a user build up a set of parameters over time, modifying individual items.
-
-Deep Merge Core Documentation
-=============================
- deep_merge! method permits merging of arbitrary child elements. The two top level
- elements must be hashes. These hashes can contain unlimited (to stack limit) levels
- of child elements. These child elements to not have to be of the same types.
- Where child elements are of the same type, deep_merge will attempt to merge them together.
- Where child elements are not of the same type, deep_merge will skip or optionally overwrite
- the destination element with the contents of the source element at that level.
- So if you have two hashes like this:
-   source = {:x => [1,2,3], :y => 2}
-   dest =   {:x => [4,5,'6'], :y => [7,8,9]}
-   dest.deep_merge!(source)
-   Results: {:x => [1,2,3,4,5,'6'], :y => 2}
- By default, "deep_merge!" will overwrite any unmergeables and merge everything else.
- To avoid this, use "deep_merge" (no bang/exclamation mark)
- 
- Options:
-   Options are specified in the last parameter passed, which should be in hash format:
-   hash.deep_merge!({:x => [1,2]}, {:knockout_prefix => '--'})
-   :preserve_unmergeables  DEFAULT: false
-      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
-   :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
-   :merge_debug            DEFAULT: false
-      Set to true to get console output of merge process for debugging
-
- Selected Options Details:
- :knockout_prefix => The purpose of this is to provide a way to remove elements 
-   from existing Hash by specifying them in a special way in incoming hash
-    source = {:x => ['--1', '2']}
-    dest   = {:x => ['1', '3']}
-    dest.ko_deep_merge!(source)
-    Results: {:x => ['2','3']}
-   Additionally, if the knockout_prefix is passed alone as a string, it will cause
-   the entire element to be removed:
-    source = {:x => '--'}
-    dest   = {:x => [1,2,3]}
-    dest.ko_deep_merge!(source)
-    Results: {:x => ""}
- :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']}
-   dest   = {:x => ['5','6','7,8']}
-   dest.deep_merge!(source, {:unpack_arrays => ','})
-   Results: {:x => ['1','2','3','4','5','6','7','8'}
-   Why: If receiving data from an HTML form, this makes it easy for a checkbox 
-    to pass multiple values from within a single HTML element
- :merge_hash_arrays => merge hashes within arrays
-   source = {:x => [{:y => 1}]}
-   dest   = {:x => [{:z => 2}]}
-   dest.deep_merge!(source, {:merge_hash_arrays => true})
-   Results: {:x => [{:y => 1, :z => 2}]}
-
- 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
-
-
-Simple Example Code
-===================
-
-require 'deep_merge'
-x = {:x => [3,4,5]}
-y = {:x => [1,2,3]}
-y.deep_merge!(x)
-# results: y = {:x => [1,2,3,4,5]}
-
-Availablility
-=============
-SVN Repo here:  http://trac.misuse.org/science/wiki/DeepMerge
-Contact author: http://www.misuse.org/science
-
-Copyright (c) 2008 Steve Midgley, released under the MIT license

data/VERSION

@@ -1 +0,0 @@
-0.0.1