angry_hash 0.2.0 → 0.2.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 PLUS2 Pty. Ltd.
+
+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

@@ -0,0 +1,114 @@
+# AngryHash
+
+A stabler mash with different emphases.
+
+# Install
+
+    gem install angry_hash
+
+# Usage
+    grr = AngryHash[]   #=> {}
+    grr = AngryHash.new #=> {}
+
+    grr = AngryHash[ :look => { :a => ['hash'] } ]
+
+    # reach into the hash using dot notation
+    grr.look.a[0] #=> 'hash'
+
+    # instantiate a sub-hash (idempotently):
+    grr.look.another       #=> nil
+    grr.look.another!.one = "nice"
+
+    grr.look.another!.one #=> "nice"
+    grr.look.another.one  #=> "nice"
+
+    # truth in hashes
+    grr.green  = true
+    grr.yellow = [:goldenrod,:canary]
+    grr.red    = false
+
+    grr.green?  #=> true
+    grr.yellow? #=> true
+    grr.red?    #=> false
+    grr.blue?   #=> false
+
+
+## Merging Deeply
+
+### Merge
+
+Deep merges are non-destructive, as in normal hash merges.
+
+Merge favours the other hash's keys. Reverse merge favours the target's keys.
+
+    grr = AngryHash[ :a => {:b => :c}, :z => :x ]
+    arr = AngryHash[ :a => {:d => :e}, :z => :y ]
+
+    grr.deep_merge( arr )         #=> {"a" => {"b" => :c, "d" => :e}, "z" => :y}
+    grr.reverse_deep_merge( arr ) #=> {"a" => {"b" => :c, "d" => :e}, "z" => :x}
+
+    # grr & arr are unmodified
+    grr #=> { "a" => {"b" => :c}, "z" => :x }
+    arr #=> { "a" => {"d" => :e}, "z" => :y }
+
+### Update
+
+Deep updates replace the contents of the hash with the merged version.
+
+They're also known as `deep_merge!` and `reverse_deep_merge!`
+
+    grr = AngryHash[ :a => {:b => :c}, :z => :x ]
+    arr = AngryHash[ :a => {:d => :e}, :z => :y ]
+
+    grr.deep_update( arr )
+
+    # grr is updated, arr is unmodified
+    grr #=> { "a" => {"b" => :c, "d" => :e}, "z" => :y }
+    arr #=> { "a" => {"d" => :e}, "z" => :y }
+
+    grr.reverse_deep_update( arr )
+
+    # grr is updated, arr is unmodified
+    grr #=> { "a" => {"b" => :c,  "d" => :e}, "z" => :x }
+    arr #=> { "a" => {"d" => :e}, "z" => :y }
+    
+# Extensions
+
+`TODO` write up this section.
+
+# Gotchas
+
+## AngryHashes are Hashes
+
+This is good and bad. Its good because you can use all the normal hash methods.
+
+    AngryHash[ :a => :b, :c => :d ].each {|k,v| ... }
+
+Unfortunately this also means that that if your hash keys collide with the names of Hash methods (or those of its ancestors) you can't use dot notation:
+
+    h = AngryHash[ :hash => 'hooray' ]
+
+    h.hash    #=> 12345...
+    h['hash'] #=> 'hooray'
+    h[:hash]  #=> 'hooray'
+    
+I'm planning on creating a sanitised `AngryProxy` to wrap `AngryHash`es for the times you really want guaranteed access via dot notation.
+
+## id
+
+Since `Object#id` is deprecated in Ruby 1.8 and has been removed in 1.9, I decided it was safe to override `id` in `AngryHash`:
+
+    h = AngryHash[ :id => 'abc' ]
+
+    h.id     #=> 'abc'
+    h.__id__ #=> 12345...
+
+# About
+
+`AngryHash`'s code is hosted on GitHub and can be found at http://github.com/plus2/angry_hash
+
+Please report problems at http://github.com/plus2/angry_hash/issues.
+
+`AngryHash` is by Lachie Cox for PLUS2 & YesMaster.
+
+You're free to use AngryHash under the MIT license; see License for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/angry_hash.gemspec

@@ -5,13 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{angry_hash}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lachie Cox"]
-  s.date = %q{2010-08-25}
+  s.date = %q{2010-08-28}
   s.description = %q{A stabler mash with different emphases. Used in plus2 projects AngryMob and Igor.}
   s.email = %q{lachie@plus2.com.au}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
   s.files = [
     ".gitignore",
      "Changelog.md",

data/examples/dup_eg.rb

@@ -1,7 +1,6 @@
 require 'eg_helper'
 
-require 'angry_hash/extension_tracking'
-AngryHash.send :include, AngryHash::ExtensionTracking
+require 'angry_hash/extension'
 
 eg.setup do
   @original = { 'database' => {
@@ -42,7 +41,7 @@ end
 
 module Extendo
   def as_dag
-    dag = dup
+    dag = dup_with_extension
     dag
   end
 

data/examples/merge_eg.rb

@@ -133,3 +133,12 @@ eg 'merge with symbol key' do
   Show( merged )
   Assert( merged.keys[1].is_a?(String) )
 end
+
+eg 'merge regression 2' do
+  other = { 'subscriptions' => [{'id' => 'fooper', 'kind' => 'topic', 'key' => 'bloop.*'}] }
+  this  = AngryHash[ :whatever => 'blah blah' ]
+
+  this.deep_update(other)
+
+  Assert( AngryHash === this.subscriptions.first )
+end

data/lib/angry_hash.rb

@@ -48,7 +48,8 @@ class AngryHash < Hash
   end
 
   def deep_merge(other_hash)
-    # XXX this should convert other to AHash!
+    other_hash = AngryHash[other_hash]
+
     self.regular_merge( other_hash ) do |key, oldval, newval|
       oldval = AngryHash.__convert_value(oldval)
       newval = AngryHash.__convert_value(newval)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Lachie Cox
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 +10:00
+date: 2010-08-28 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -24,8 +24,9 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.md
 files: 
 - .gitignore
 - Changelog.md
@@ -38,6 +39,8 @@ files:
 - lib/angry_hash/dsl.rb
 - lib/angry_hash/extension.rb
 - lib/angry_hash/merge_string.rb
+- LICENSE
+- README.md
 has_rdoc: true
 homepage: http://github.com/plus2/angry_hash
 licenses: []