hash-joiner 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90c7fec799df022cab292510997f96964ce21130
-  data.tar.gz: 7cc754bf27cee1b74e5c848ff58d1d6d63cea0af
+  metadata.gz: beaba855459a6d516abe08f661ea0b4391e908a0
+  data.tar.gz: 926f8aec91e23bddf3397319d719b9cf41c5b17f
 SHA512:
-  metadata.gz: 83424ae89d14838c5aa17ea9691974d8c55df1ebbd63bc5b9a05afa97911ab385e09f267a9e9844d8ded1e1aacb57fcb5d013cfbf958c001c93cf3a1035f2786
-  data.tar.gz: fe45b74b525b1a4e5c7e2b1adfe3670097fa4bcf67308ee7b8a89350f253a343c456e2f04c5c5694b57df1aba2ad9aa70b4d0b04bdfbbe65b999f789e4b429df
+  metadata.gz: 9c0997705bd473649288db3848e3541bc325f6e730afadc2de64f30a0c8cf08f8c2a1c7399e9366506ce140edbcba81544fbe0683d1209f08daa6a3fb00022d3
+  data.tar.gz: 3a915d2f10407ed68e4f04a45fc3b3a3dd926ffca08edc928f05075e2e0c071c5b78f69c366a6abd93109da6bf809ad8289c18e2d76779905e8d94f17434deff

data/README.md

@@ -28,9 +28,11 @@ The typical use case is to have a YAML file containing both public and private d
 ```ruby
 > require 'hash-joiner'
 > my_data_collection = {
-    'name' => 'mbland', 'full_name' => 'Mike Bland',
+    'name' => 'mbland',
+    'full_name' => 'Mike Bland',
     'private' => {
-      'email' => 'michael.bland@gsa.gov', 'location' => 'DCA',
+      'email' => 'michael.bland@gsa.gov',
+      'location' => 'DCA',
     },
   }
 ```
@@ -42,7 +44,10 @@ The following examples, except for **Join an Array of Hash values**, all begin w
 ```ruby
 # Everything within the `private:` property will be deleted.
 > HashJoiner.remove_data my_data_collection, "private"
-=> {"name"=>"mbland", "full_name"=>"Mike Bland"}
+=> {
+     "name"=>"mbland",
+     "full_name"=>"Mike Bland",
+   }
 ```
 
 #### Promote private data
@@ -53,44 +58,62 @@ This will render `private:` data at the same level as other, nonprivate data:
 # Everything within the `private:` property will be
 # promoted up one level.
 > HashJoiner.promote_data my_data_collection, "private"
-=> {"name"=>"mbland", "full_name"=>"Mike Bland",
-    "email"=>"michael.bland@gsa.gov", "location"=>"DCA"}
+=> {
+     "name"=>"mbland",
+     "full_name"=>"Mike Bland",
+     "email"=>"michael.bland@gsa.gov",
+     "location"=>"DCA",
+   }
 ```
 
 #### Perform a deep merge with other Hash values
 
 ```ruby
 > extra_info = {
-  'languages' => ['C++', 'Python'], 'full_name' => 'Michael S. Bland',
-  'private' => {
-    'location' => 'Alexandria, VA', 'previous_companies' => ['Google'],
+  "languages" => ["C++", "Python"],
+  "full_name" => "Michael S. Bland",
+  "private" => {
+    "location" => "Alexandria, VA",
+    "previous_companies" => ["Google"],
     },
   }
 
 # The original Hash will have information added for
 # `full_name`, `languages', and `private => location`.
+
 > HashJoiner.deep_merge my_data_collection, extra_info
-=> {"name"=>"mbland", "full_name"=>"Michael S. Bland",
-    "private"=>{
-      "email"=>"michael.bland@gsa.gov", "location"=>"Alexandria, VA",
-      "previous_companies"=>["Google"]},
-    "languages"=>["C++", "Python"]}
+=> {
+     "name"=>"mbland",
+     "full_name"=>"Michael S. Bland",
+     "languages"=>["C++", "Python"],
+     "private"=> {
+       "email"=>"michael.bland@gsa.gov",
+       "location"=>"Alexandria, VA",
+       "previous_companies"=>["Google"],
+      },
+    }
 
 > extra_info = {
-    'languages' => ['Ruby'],
-    'private' => {
-      'previous_companies' => ['Northrop Grumman'],
+    "languages" => ["Ruby"],
+    "private" => {
+      "previous_companies" => ["Northrop Grumman"],
     },
   }
 
 # The Hash will now have added information for
 # `languages` and `private => previous_companies`.
+
 > HashJoiner.deep_merge my_data_collection, extra_info
-=> {"name"=>"mbland", "full_name"=>"Michael S. Bland",
-    "private"=>{
-      "email"=>"michael.bland@gsa.gov", "location"=>"Alexandria, VA",
-      "previous_companies"=>["Google", "Northrop Grumman"]},
-    "languages"=>["C++", "Python", "Ruby"]}
+=> {
+     "name"=>"mbland",
+     "full_name"=>"Michael S. Bland",
+     "languages"=>["C++", "Python", "Ruby"],
+     "private"=> {
+       "email"=>"michael.bland@gsa.gov",
+       "location"=>"Alexandria, VA",
+       "previous_companies"=>["Google", "Northrop Grumman"],
+      },
+   }
 ```
 
 #### Join an Array of Hash values
@@ -129,15 +152,20 @@ This corresponds to the process of joining different collections of Jekyll-impor
 #
 # `site.data['private']` can now be safely discarded.
 > HashJoiner.join_data 'team', 'name', site.data, site.data['private']
-=> {"private"=>{
-      "team"=>[
+=> {
+     "private"=>{
+       "team"=>[
         {"name"=>"mbland", "languages"=>["Python", "Ruby"]},
         {"name"=>"foobar", "email"=>"foo.bar@gsa.gov"},
-        {"name"=>"bazquux", "email"=>"baz.quux@gsa.gov"}]},
-    "team"=>[
+        {"name"=>"bazquux", "email"=>"baz.quux@gsa.gov"}
+       ]
+     },
+     "team"=>[
       {"name"=>"mbland", "languages"=>["C++", "Python", "Ruby"]},
       {"name"=>"foobar", "full_name"=>"Foo Bar", "email"=>"foo.bar@gsa.gov"},
-      {"name"=>"bazquux", "email"=>"baz.quux@gsa.gov"}]}
+      {"name"=>"bazquux", "email"=>"baz.quux@gsa.gov"}
+     ]
+   }
 ```
 
 #### Running `filter-yaml-files`

data/lib/hash-joiner.rb

@@ -1,4 +1,7 @@
 # @author: Mike Bland (michael.bland@gsa.gov)
+
+require 'hash-joiner/version'
+
 module HashJoiner
   # Recursively strips information from +collection+ matching +key+.
   #

data/lib/hash-joiner/version.rb

@@ -0,0 +1,4 @@
+# @author Mike Bland (michael.bland@gsa.gov)
+module HashJoiner
+  VERSION = "0.0.6"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash-joiner
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -92,6 +92,7 @@ files:
 - README.md
 - bin/filter-yaml-files
 - lib/hash-joiner.rb
+- lib/hash-joiner/version.rb
 homepage: https://github.com/18F/hash-joiner
 licenses:
 - CC0
@@ -117,3 +118,4 @@ signing_key:
 specification_version: 4
 summary: Module for pruning, promoting, deep-merging, and joining Hash data
 test_files: []
+has_rdoc: