aha 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb3f97c109690791bca8f2838ac07cc21aa40e0a
-  data.tar.gz: 14ade28b15cff210f3b416db650ec9128d9e381e
+  metadata.gz: fee7461ca33670cd06d3e0ba15144dbe5c70302e
+  data.tar.gz: 1f1679c8cf4aac1aca799c7fa80fbe4f1317e6c8
 SHA512:
-  metadata.gz: 32234582b85e179aba8baa33540a57e66fe8f101bad71eebacb352319db29b0b59a28fe6b426755b52557426ed96cd4d11d052bd9eac1e08e80e22ef0634478e
-  data.tar.gz: 513d4cb0a36dc4d93e04a985b093ef02cbcd85365aee380923cfb9c476f3107f6cee89d76fe7358bae43f5ac67f66d1e239055f1d08f449bcddd4314d03fbd2a
+  metadata.gz: b28862c8eae277802caee38c1a3ad48ffebb66f77e7382cccac910153c5c24ef02e7df49fc01d3e8e45fc5c6386d150c4b1c048e4d8ca01bb4726504361d76ca
+  data.tar.gz: 46958e1b06abd0a6dffe2f5f6bb9934e3c10222c68a31e892cb3390e4bf1671c93d9bf3afa5ac5e4b81a9a5f9b26be431c6db7e80440b2ef11d02803bed8341a

data/README.md

@@ -1,31 +1,87 @@
 # Aha
 
-TODO: Write a gem description
+A(ugmented)ha(sh) is a Hash extension library that makes it easy to work with
+data represented by nested hash maps.
+
+It was largely inspired by Uncle Bob's [keynote](http://www.confreaks.com/videos/759-rubymidwest2011-keynote-architecture-the-lost-years)
+'Architecture: the lost years' and the insight that while domain modeling with
+objects is great, we want to deal with plain data structures at the boundaries
+of our system.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```shell
+gem install aha
+```
+or add the following line to your application's Gemfile:
 
 ```ruby
 gem 'aha'
 ```
+and run `bundle install` from your shell.
+
+## Usage
 
-And then execute:
+```ruby
+# some data to play with
+def data
+  {:a  => 'value_1',
+   'b' => {:c => 'value_2',
+           :d => 'value_3'},
+   :e  => {:f => 'value_4',
+           :g => {:h => 'value_5'}}}
+end
 
-    $ bundle
+# Destructuring assignment
+value_1, value_2, value_3, value_4, value_5
+  = data.vals_at :a, ['b', :c, :d], [:e, :f [:g, :h]]
 
-Or install it yourself as:
+# Get nested values from top level object
+data.get_in :e, :g, :h
+# => 'value_5'
 
-    $ gem install aha
+# Set nested values from top level object
+d1 = data
+d1.put_in! :e, :g, :h, 'new_value'
+d1.get_in :e, :g, :h
+# => 'new_value'
 
-## Usage
+# Update nested values from top level object
+d2 = data
+d2.update_in!(:e, :g, :h) { |v| v * 3 }
+d2.get_in :e, :g, :h
+# => 'value_5value_5value_5'
+
+# Delete nested values from top level object
+d3 = data
+d3.delete_in! 'b', :d
+d3['b']
+# => {:c => 'value_2'}
+
+# Exclude keys from nested hash
+d4 = data
+d4.exclude! :a, ['b', :c], [:e, :g]
+d4
+# => {'b' => {:d => 'value_3'}, :e => {:f => 'value_4'}}
 
-TODO: Write usage instructions here
+# Keep a subset of keys
+d5 = data
+d5.only :a, [:e, [:g, :h]]
+# => {:a => 'value_1', :e => {:g => {:h => 'value_5'}}}
+
+```
+
+## Planned
+
+* Non-destructive variants of all the existing methods
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/aha/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+* If it is a new feature please create an issue first.
+* Fork and send me a pull request. Tests are a must!
+
+## License
+
+Copyright © 2014 Mike Jackson.
+
+Distributed under the permissive [MIT license](http://opensource.org/licenses/MIT).

data/lib/aha/version.rb

@@ -1,3 +1,3 @@
 module Aha
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aha
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ files:
 - lib/aha/version.rb
 - spec/lib/aha_spec.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/aha
+homepage: https://github.com/occamin/aha
 licenses:
 - MIT
 metadata: {}