hash_path 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +6 -0
- data/LICENSE +22 -0
- data/README.md +50 -0
- data/Rakefile +2 -0
- data/hash_path.gemspec +17 -0
- data/lib/hash_path/version.rb +3 -0
- data/lib/hash_path.rb +55 -0
- metadata +53 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2012 Daniel Neighman
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# HashPath
|
2
|
+
|
3
|
+
Provides a simple interface to access hash paths.
|
4
|
+
|
5
|
+
The gem was written to help with specs so use in production code will have an
|
6
|
+
unkonwn performance hit.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
gem 'path_spec'
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install path_spec
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
Given the hash
|
25
|
+
{
|
26
|
+
'foo' => {
|
27
|
+
'bar' => {
|
28
|
+
'baz' => 'hai'
|
29
|
+
}
|
30
|
+
}
|
31
|
+
}
|
32
|
+
|
33
|
+
# Nil versions
|
34
|
+
my_hash.at_path("foo.bar.baz") #=> 'hai'
|
35
|
+
my_hash.at_path("foo.bar.barry") #=> nil
|
36
|
+
my_hash.at_path("not_a_key") #=> nil
|
37
|
+
|
38
|
+
# Or the raise version
|
39
|
+
my_hash.at_path!("foo.bar.baz") #=> 'hai'
|
40
|
+
my_hash.at_path!("foo.bar.barry") #=> raises
|
41
|
+
my_hash.at_path("not_a_key") #=> raises
|
42
|
+
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
1. Fork it
|
47
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
48
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
49
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
50
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
data/hash_path.gemspec
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require File.expand_path('../lib/hash_path/version', __FILE__)
|
3
|
+
|
4
|
+
Gem::Specification.new do |gem|
|
5
|
+
gem.authors = ["Daniel Neighman"]
|
6
|
+
gem.email = ["dneighman@squareup.com"]
|
7
|
+
gem.description = %q{Easy path navigation for hashes}
|
8
|
+
gem.summary = %q{Easy path navigation for hashes. Useful in specs}
|
9
|
+
gem.homepage = ""
|
10
|
+
|
11
|
+
gem.files = `git ls-files`.split($\)
|
12
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
13
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
14
|
+
gem.name = "hash_path"
|
15
|
+
gem.require_paths = ["lib"]
|
16
|
+
gem.version = HashPath::VERSION
|
17
|
+
end
|
data/lib/hash_path.rb
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
require "hash_path/version"
|
2
|
+
module HashPath
|
3
|
+
class PathNotFound < StandardError; end
|
4
|
+
|
5
|
+
DELIMITER = '.'
|
6
|
+
|
7
|
+
# Looks up the path provided
|
8
|
+
# @param path String the path to lookup
|
9
|
+
# @example
|
10
|
+
# my_hash.at_path("foo.bar.baz") # looks in my_hash['foo']['bar']['baz']
|
11
|
+
def at_path(path)
|
12
|
+
path_keys = normalize_path(path)
|
13
|
+
current_value = self
|
14
|
+
|
15
|
+
path_keys.each do |key|
|
16
|
+
return nil unless ::Hash === current_value
|
17
|
+
current_value = current_value[key]
|
18
|
+
end
|
19
|
+
current_value
|
20
|
+
end
|
21
|
+
|
22
|
+
# Same as at_path but raises when a path is not found
|
23
|
+
# The raise will give a delimited path of where the path went dead
|
24
|
+
# @example
|
25
|
+
# f = { 'foo' => {'bar' => {'baz' => 'hai'} } }
|
26
|
+
# f.at_path!('foo.not.baz') # Raises, message == 'foo.not'
|
27
|
+
# f.at_path!('not.here.yo') # Raises, message == 'not'
|
28
|
+
# f.at_path!('foo.bar.not') # Raises, message == 'foo.bar.not'
|
29
|
+
# @see HashPath#at_path
|
30
|
+
def at_path!(path)
|
31
|
+
path_keys = normalize_path(path)
|
32
|
+
the_keys, current_value = [], self
|
33
|
+
|
34
|
+
path_keys.each do |key|
|
35
|
+
raise(PathNotFound, the_keys.join(DELIMITER))unless ::Hash === current_value
|
36
|
+
the_keys << key
|
37
|
+
current_value = current_value[key]
|
38
|
+
end
|
39
|
+
current_value
|
40
|
+
end
|
41
|
+
|
42
|
+
private
|
43
|
+
def normalize_path(path)
|
44
|
+
case path
|
45
|
+
when Array
|
46
|
+
path
|
47
|
+
when String, Symbol
|
48
|
+
path.to_s.split(DELIMITER)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
class Hash
|
54
|
+
include HashPath
|
55
|
+
end
|
metadata
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: hash_path
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Daniel Neighman
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-07-19 00:00:00.000000000 Z
|
13
|
+
dependencies: []
|
14
|
+
description: Easy path navigation for hashes
|
15
|
+
email:
|
16
|
+
- dneighman@squareup.com
|
17
|
+
executables: []
|
18
|
+
extensions: []
|
19
|
+
extra_rdoc_files: []
|
20
|
+
files:
|
21
|
+
- .gitignore
|
22
|
+
- Gemfile
|
23
|
+
- LICENSE
|
24
|
+
- README.md
|
25
|
+
- Rakefile
|
26
|
+
- hash_path.gemspec
|
27
|
+
- lib/hash_path.rb
|
28
|
+
- lib/hash_path/version.rb
|
29
|
+
homepage: ''
|
30
|
+
licenses: []
|
31
|
+
post_install_message:
|
32
|
+
rdoc_options: []
|
33
|
+
require_paths:
|
34
|
+
- lib
|
35
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
36
|
+
none: false
|
37
|
+
requirements:
|
38
|
+
- - ! '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
42
|
+
none: false
|
43
|
+
requirements:
|
44
|
+
- - ! '>='
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '0'
|
47
|
+
requirements: []
|
48
|
+
rubyforge_project:
|
49
|
+
rubygems_version: 1.8.24
|
50
|
+
signing_key:
|
51
|
+
specification_version: 3
|
52
|
+
summary: Easy path navigation for hashes. Useful in specs
|
53
|
+
test_files: []
|