hash_path 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in path_spec.gemspec
+gemspec
+
+gem 'json'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Neighman
+
+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,50 @@
+# HashPath
+
+Provides a simple interface to access hash paths.
+
+The gem was written to help with specs so use in production code will have an
+unkonwn performance hit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'path_spec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install path_spec
+
+## Usage
+
+Given the hash
+    {
+      'foo' => {
+        'bar' => {
+          'baz' => 'hai'
+        }
+      }
+    }
+
+    # Nil versions
+    my_hash.at_path("foo.bar.baz")   #=> 'hai'
+    my_hash.at_path("foo.bar.barry") #=> nil
+    my_hash.at_path("not_a_key")     #=> nil
+
+    # Or the raise version
+    my_hash.at_path!("foo.bar.baz")   #=> 'hai'
+    my_hash.at_path!("foo.bar.barry") #=> raises
+    my_hash.at_path("not_a_key")      #=> raises
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hash_path.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hash_path/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daniel Neighman"]
+  gem.email         = ["dneighman@squareup.com"]
+  gem.description   = %q{Easy path navigation for hashes}
+  gem.summary       = %q{Easy path navigation for hashes. Useful in specs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hash_path"
+  gem.require_paths = ["lib"]
+  gem.version       = HashPath::VERSION
+end

data/lib/hash_path/version.rb

@@ -0,0 +1,3 @@
+module HashPath
+  VERSION = "0.1.0"
+end

data/lib/hash_path.rb

@@ -0,0 +1,55 @@
+require "hash_path/version"
+module HashPath
+  class PathNotFound < StandardError; end
+
+  DELIMITER = '.'
+
+  # Looks up the path provided
+  # @param path String the path to lookup
+  # @example
+  #   my_hash.at_path("foo.bar.baz") # looks in my_hash['foo']['bar']['baz']
+  def at_path(path)
+    path_keys = normalize_path(path)
+    current_value = self
+
+    path_keys.each do |key|
+      return nil unless ::Hash === current_value
+      current_value = current_value[key]
+    end
+    current_value
+  end
+
+  # Same as at_path but raises when a path is not found
+  # The raise will give a delimited path of where the path went dead
+  # @example
+  #   f = { 'foo' => {'bar' => {'baz' => 'hai'} } }
+  #   f.at_path!('foo.not.baz') # Raises, message == 'foo.not'
+  #   f.at_path!('not.here.yo') # Raises, message == 'not'
+  #   f.at_path!('foo.bar.not') # Raises, message == 'foo.bar.not'
+  # @see HashPath#at_path
+  def at_path!(path)
+    path_keys = normalize_path(path)
+    the_keys, current_value = [], self
+
+    path_keys.each do |key|
+      raise(PathNotFound, the_keys.join(DELIMITER))unless ::Hash === current_value
+      the_keys << key
+      current_value = current_value[key]
+    end
+    current_value
+  end
+
+  private
+  def normalize_path(path)
+    case path
+    when Array
+      path
+    when String, Symbol
+      path.to_s.split(DELIMITER)
+    end
+  end
+end
+
+class Hash
+  include HashPath
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: hash_path
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-19 00:00:00.000000000 Z
+dependencies: []
+description: Easy path navigation for hashes
+email:
+- dneighman@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hash_path.gemspec
+- lib/hash_path.rb
+- lib/hash_path/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy path navigation for hashes. Useful in specs
+test_files: []