README.md in hash_ext-0.1.1 vs README.md in hash_ext-0.2.0
- old
+ new
@@ -1,12 +1,12 @@
# HashExt
-[](https://rubygems.org/gems/hash_ext)
-[](https://travis-ci.org/gabynaiman/hash_ext)
-[](https://coveralls.io/r/gabynaiman/hash_ext?branch=master)
-[](https://codeclimate.com/github/gabynaiman/hash_ext)
-[](https://gemnasium.com/gabynaiman/hash_ext)
+[](https://rubygems.org/gems/hash_ext)
+[](https://travis-ci.org/gabynaiman/hash_ext)
+[](https://coveralls.io/r/gabynaiman/hash_ext?branch=master)
+[](https://codeclimate.com/github/gabynaiman/hash_ext)
+[](https://gemnasium.com/gabynaiman/hash_ext)
Hash extensions without monkey patching
## Installation
@@ -24,16 +24,73 @@
$ gem install hash_ext
## Usage
-### Available classes
+### Accessible
```ruby
-Hash::Accessible
-Hash::Builder
-Hash::Indifferent
-Hash::Sorted
+hash = Hash::Accessible.new key_1: 1, key_2: { key_3: 3 }
+
+hash[:key_1] # => 1
+hash.key_1 # => 1
+
+hash[:key_2] # => {key_3: 3}
+hash.key_2 # => {key_3: 3}
+
+hash[:key_2][:key_3] # => 3
+hash.key_2.key_3 # => 3
+```
+
+### Builder
+
+```ruby
+hash = Hash::Builder.build do |h|
+ h.key_1 1
+ h.key_2 do
+ h.key_3 3
+ end
+end
+
+hash # => {key_1: 1, key_2: {key_3: 3}}
+```
+
+### Normalized
+
+```ruby
+hash = Hash::Normalized.new { |key| key.upcase }
+
+hash['key_1'] = 1
+
+hash['key_1'] # => 1
+hash['KEY_1'] # => 1
+```
+
+### Indifferent
+
+```ruby
+hash = Hash::Indifferent.new
+
+hash['key_1'] = 1
+hash[:key_2] = 2
+
+hash['key_1'] # => 1
+hash[:key_1] # => 1
+
+hash['key_2'] # => 2
+hash[:key_2] # => 2
+```
+
+### Sorted
+
+```ruby
+hash = Hash::Sorted.asc { |k,v| k.to_s }
+
+hash[:c] = 1
+hash[:b] = 2
+hash[:a] = 3
+
+hash.keys # => [:a, :b, :c]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.