aha 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb3f97c109690791bca8f2838ac07cc21aa40e0a
+  data.tar.gz: 14ade28b15cff210f3b416db650ec9128d9e381e
+SHA512:
+  metadata.gz: 32234582b85e179aba8baa33540a57e66fe8f101bad71eebacb352319db29b0b59a28fe6b426755b52557426ed96cd4d11d052bd9eac1e08e80e22ef0634478e
+  data.tar.gz: 513d4cb0a36dc4d93e04a985b093ef02cbcd85365aee380923cfb9c476f3107f6cee89d76fe7358bae43f5ac67f66d1e239055f1d08f449bcddd4314d03fbd2a

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Jackson
+
+MIT License
+
+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,31 @@
+# Aha
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aha
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/lib/aha/augmented_hash.rb

@@ -0,0 +1,186 @@
+require 'aha/helper'
+
+module Aha
+  # Public: Provides functionality for dealing with nested hashes.
+  #
+  # Nested keys are represented by an array where the first element represents the
+  # the key to access the sub hash and the rest represent keys for that hash.
+  #
+  # These arrays can be nested allowing us to represent keys for an arbitrarily
+  # nested hash. This way of representing keys is used throughout Aha and is
+  # heavily inspired by the Prismatic's Clojure fnk style destructuring as seen
+  # here: https://github.com/Prismatic/plumbing/tree/master/src/plumbing/fnk
+  #
+  # For example:
+  #
+  #   Given the hash {a: 'hello', b: {c: 'augmented', d: {e: 'hash'}}}
+  #   the keys :a, [:b, :c, [:d, :e]] would correspond to the values
+  #   'hello', 'augmented', 'hash'
+  module AugmentedHash
+    extend self
+
+    # Public: Similar to Hash#values_at except that it supports nested key
+    # syntax and is primarily intented to be used for destructuring assignment.
+    #
+    # hash - The nested hash to extract values from.
+    # keys - They keys corresponding to the values to be extracted. Supports
+    #        nested key syntax.
+    #
+    # Examples:
+    #
+    #   h = {'a' => 3, :b => {:c => 2, 'd' => {:e => 1}}}
+    #   value_1, value_2, value_3 = vals_at h, 'a', [:b, :c, ['d', :e]]
+    #
+    #   value_1
+    #   # => 3
+    #   value_2
+    #   # => 2
+    #   value_3
+    #   # => 1
+    #
+    # Returns an array of values corresponding to the given keys.
+    def vals_at(hash, *keys)
+      result = Aha::Helper::extract_option(:acc, keys) || []
+
+      result.tap do |acc|
+        keys.each do |k|
+          if k.is_a? Array
+            subkey, *keys = k
+            vals_at(hash[subkey], *keys, {acc: acc})
+          else
+            acc << hash[k]
+          end
+        end
+      end
+    end
+
+    # Public: Retrieves a value from a nested hash. Equivalent to
+    # hash[k1][..][kn]
+    #
+    # hash - The hash to retrieve the value from.
+    # keys - The keys to the value in order of depth.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 'value'}}}
+    #   get_in h, :a, 'b', :c
+    #   # => 'value'
+    #
+    # Returns the value if it exists and nil otherwise
+    def get_in(hash, *keys)
+      keys.reduce(hash) { |acc, k| acc[k] }
+    end
+
+    # Public: Sets a value within a nested hash. Equivalent to
+    # hash[k1][..][kn] = val
+    #
+    # hash - The nested hash to set the value in.
+    # keys - The keys to the value to set in order of depth.
+    # val  - The new value to set.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 'value'}}}
+    #   put_in! h, :a, 'b', :c, 'new_value'
+    #   h
+    #   # => {:a => {'b' => {:c => 'new_value'}}}
+    #
+    # Returns nothing.
+    def put_in!(hash, *keys, val)
+      last_key = keys.pop
+      get_in(hash, *keys)[last_key] = val
+    end
+
+    # Public: Updates a value within a nested hash.
+    #
+    # hash  - The nested hash to update the value in.
+    # keys  - The keys to the current value in order of depth
+    # block - A required block that is given the current value and should return
+    #         the updated value to be set.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 33}}}
+    #   update_in!(h, :a, 'b', :c) { |v| v + 9}
+    #   h
+    #   # => {:a => {'b' => {:c => 42}}}
+    #
+    # Returns nothing.
+    def update_in!(hash, *keys)
+      put_in!(hash, *keys, yield(get_in(hash, *keys))) if block_given?
+    end
+
+    # Public: Deletes a value within a nested hash. Equivalent to
+    # hash[k1][..][kn-1].delete(kn)
+    #
+    # hash - The nested hash to delete the value in.
+    # keys - They keys to the value to delete in order of depth.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 'hello', :d => 'world'}}}
+    #   delete_in! h, :a, 'b', :c
+    #   h
+    #   # => {:a => {'b' => {:d => 'world'}}}
+    #
+    # Returns nothing.
+    def delete_in!(hash, *keys)
+      last_key = keys.pop
+      get_in(hash, *keys).delete last_key
+    end
+
+    # Public: Removes the excluded keys from the hash.
+    #
+    # hash - The hash to exclude keys from.
+    # keys - The keys to be excluded from the hash. Supports nested key syntax.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 'hello', :d => 'augmented'}}, :e => 'hash'}
+    #   exclude! h, [:a, ['b', :d]], :e
+    #   h
+    #   # => {:a => {'b' => {:c => 'hello'}}}
+    #
+    # Returns nothing.
+    def exclude!(hash, *keys)
+      keys.each do |k|
+        if k.is_a? Array
+          subkey, *keys = k
+          exclude!(hash[subkey], *keys)
+        else
+          hash.delete k
+        end
+      end
+    end
+
+    # Public: Creates a new hash consisting only keys given and their
+    # corresponding values.
+    #
+    # hash - The hash to base the result on.
+    # keys - The keys that the new hash will contain. Supports nested key
+    #        syntax.
+    #
+    # Examples:
+    #
+    #   h = {:a => {'b' => {:c => 'hello', :d => 'augmented'}}, :e => 'hash'}
+    #   only h, [:a, ['b', :d]]
+    #   # => {:a => {'b' => {:d => 'augmented'}}}
+    #
+    # Returns the new, smaller hash.
+    def only(hash, *keys)
+      result = {}
+
+      result.tap do |r|
+        keys.each do |k|
+          if k.is_a? Array
+            subkey, *keys = k
+            r[subkey] = only(hash[subkey], *keys)
+          else
+            r[k] = hash[k]
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/aha/helper.rb

@@ -0,0 +1,28 @@
+module Aha
+  # Internal: Provides helper methods for the rest of the Aha library.
+  module Helper
+    extend self
+    
+    # Internal: Extracts an option from the options hash if it exists in the method args.
+    #
+    # option_key - A symbol corresponding to a key in the options hash.
+    # args - An array containing a number of args followed by an optional options hash.
+    #
+    # Examples:
+    #
+    #   args_with_options = [:a, :b, :c, :d, {:key => :option}]
+    #   args_without_options = [:a, :b, :c, :d]
+    #
+    #   extract_option :key, args_with_options
+    #   # => :option
+    #
+    #   extract_option :key, args_without_options
+    #   # => nil
+    #
+    # Returns the option value if it exists and nil otherwise.
+    def extract_option(option_key, args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[option_key]
+    end
+  end
+end

data/lib/aha/version.rb

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

data/lib/aha.rb

@@ -0,0 +1,40 @@
+require 'aha/version'
+require 'aha/augmented_hash'
+
+# Extends Hash with functionality from Aha::AugmentedHash.
+#
+# Methods are implemented by delegating to AugmentedHash on an individual method
+# basis. Using module methods as opposed to a mixing in a module is preferrable
+# as it allows us to include functionality in a piecemeal manner if necessary
+# and supports minimal changes to the core Hash class.
+#
+# For more information see Aha::AugmentedHash.
+class Hash
+  def vals_at(*keys)
+    Aha::AugmentedHash::vals_at(self, *keys)
+  end
+
+  def get_in(*keys)
+    Aha::AugmentedHash::get_in(self, *keys)
+  end
+
+  def put_in!(*args)
+    Aha::AugmentedHash::put_in!(self, *args)
+  end
+
+  def update_in!(*keys, &block)
+    Aha::AugmentedHash::update_in!(self, *keys, &block)
+  end
+
+  def delete_in!(*keys)
+    Aha::AugmentedHash::delete_in!(self, *keys)
+  end
+
+  def exclude!(*keys)
+    Aha::AugmentedHash::exclude!(self, *keys)
+  end
+
+  def only(*keys)
+    Aha::AugmentedHash::only(self, *keys)
+  end
+end

data/spec/lib/aha_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'aha'
+
+describe Hash do
+  before(:each) do
+     @data = {:name     => 'Oculus VR',
+              :founders => ['Palmer Luckey', 'Brendan Iribe', 'Michael Antonov', 'Nate Mitchell', 'Jack McCauley'],
+              :ceo      => {'name' => 'Brendan Iribe'},
+              'cto'     => {:name   => 'John Carmack',
+                            'age'   => 44,
+                            :spouse => {:name => 'Katherine Anna Kang'}}}
+  end
+
+  it 'should destructure nested hashes' do
+    company_name, ceo_name, cto_name, cto_age, cto_spouse_name =
+      @data.vals_at(:name, [:ceo, 'name'], ['cto', :name, 'age', [:spouse, :name]])
+
+    company_name.should == 'Oculus VR'
+    ceo_name.should == 'Brendan Iribe'
+    cto_name.should == 'John Carmack'
+    cto_age.should == 44
+    cto_spouse_name.should == 'Katherine Anna Kang'
+  end
+
+  it 'should retrieve nested values' do
+    @data.get_in('cto', :spouse, :name).should == 'Katherine Anna Kang'
+  end
+
+  it 'should set nested values' do
+    @data.put_in! 'cto', :name, 'Alan Kay'
+    @data['cto'][:name].should == 'Alan Kay'
+  end
+
+  it 'should updated nested values' do
+    @data.update_in!('cto', 'age') { |age| age + 5 }
+    @data['cto']['age'].should == 49
+  end
+
+  it 'should delete nested values' do
+    @data.delete_in! 'cto', :spouse
+    @data['cto'][:spouse].should be_nil
+  end
+
+  it 'should exclude keys in nested hashes' do
+    @data.exclude! :founders, :ceo, ['cto', 'age', :spouse]
+    @data.should == {:name => 'Oculus VR', 'cto' => {:name => 'John Carmack'}}
+  end
+
+  it 'should return a new hash from given keys' do
+    @data.only(:name, ['cto', [:spouse, :name]]). should ==
+      {:name => 'Oculus VR',
+       'cto' => {:spouse => {:name => 'Katherine Anna Kang'}}}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = [:should, :expect]
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: aha
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Jackson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: occamin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/aha.rb
+- lib/aha/augmented_hash.rb
+- lib/aha/helper.rb
+- lib/aha/version.rb
+- spec/lib/aha_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/aha
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A library of Hash extensions to simplify working with nested data.
+test_files: []