hash_path 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efc30720d5e9dc46735cdbcdca64437b58a0e442
+  data.tar.gz: 5de1e070a617786d9717242cb421a993afca0341
+SHA512:
+  metadata.gz: 9b99483587f78bf847bd8ac51cbb38951fecfe9ba73679e37d3bc39341657904d63e0432daf3f1d6481695e0eb91f0658768232cb71e45e7f993401506efecde
+  data.tar.gz: 997d8a91955d890b3657c405c404fd3c60781f1fc886ed3c0e3bfcea343a55be0eca19bca7ae5ea9a4e403279867f1216df8c8326bae176a69cac2c93c7dafc4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change log
+
+## 0.4.0
+### 2014-11-25
+
+- Now at_path and at_path! can look up keys which are symbols, rather than strings.
+
+## 0.3.0
+### 2012-10-09
+
+- Start of the change log. Adds at_path, at_path!, and flatten_key_paths methods to Hash.

data/README.md

@@ -2,14 +2,14 @@
 
 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.
+The gem was written to help with specs, so use in production code will have an
+unknown performance hit.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'path_spec'
+    gem 'hash_path'
 
 And then execute:
 
@@ -17,7 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install path_spec
+    $ gem install hash_path
 
 ## Usage
 
@@ -38,7 +38,7 @@ Given the hash
     # 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
+    my_hash.at_path!("not_a_key")     #=> raises
 
 
 ## Contributing

data/hash_path.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "hash_path"
   gem.require_paths = ["lib"]
   gem.version       = HashPath::VERSION
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'pry'
 end

data/lib/hash_path/version.rb

@@ -1,3 +1,3 @@
 module HashPath
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/hash_path.rb

@@ -9,35 +9,33 @@ module HashPath
   # @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 current_value.respond_to?(:[])
-      current_value = current_value[key]
-    end
-    current_value
+    at_path!(path) rescue nil
   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'}, "baz" => [1,2] } }
+  #   f = { 'foo' => {'bar' => {'baz' => 'hai'} }, "baz" => [1,2] }
   #   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'
   #   f.at_path!("baz.1") # => 2
   # @see HashPath#at_path
   def at_path!(path)
-    path_keys = normalize_path(path)
-    the_keys, current_value = [], self
+    the_keys = []
 
-    path_keys.each do |key|
-      raise(PathNotFound, the_keys.join(DELIMITER)) unless current_value.respond_to?(:[])
+    normalize_path(path).reduce(self) do |memo, key|
       the_keys << key
-      current_value = current_value[key]
+      case key
+      when String
+        memo.key?(key) ? memo.fetch(key) : memo.fetch(key.to_sym)
+      else
+        memo.fetch(key)
+      end
     end
-    current_value
+
+  rescue => e
+    raise(PathNotFound, the_keys.join(DELIMITER))
   end
 
   # Provides flattened hash key paths
@@ -45,10 +43,11 @@ module HashPath
     case hash_or_obj
     when Hash
       hash_or_obj.inject({}) do |h, (k,v)|
-        full_prefix = [prefix, k].compact.join(".")
+        full_prefix = [prefix, k].compact.join(DELIMITER)
         result = flatten_key_paths(v, full_prefix)
-        if Hash === result
-          h.merge! result
+        case result
+        when Hash
+          h.merge!(result)
         else
           h[full_prefix] = result
         end
@@ -60,13 +59,14 @@ module HashPath
   end
 
   private
+
   def normalize_path(path)
     case path
     when Array
       path
     when String, Symbol
       path.to_s.split(DELIMITER)
-    end.map{|key| key =~ /^\d+$/ ? key.to_i : key }
+    end.map{|key| key =~ /\A\d+\z/ ? key.to_i : key }
   end
 end
 

data/spec/hash_path_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+RSpec.describe HashPath do
+  describe '#at_path' do
+    it 'returns nil if the key is not found' do
+      expect({}.at_path('foo')).to eq(nil)
+    end
+
+    it 'returns a value if it is found' do
+      expect({foo: {bar: 5}}.at_path('foo.bar')).to eq(5)
+    end
+  end
+
+  describe '#at_path!' do
+    it 'looks up a key given by a string' do
+      expect({'foo' => 5}.at_path!('foo')).to eq(5)
+    end
+
+    it 'finds a symbol when searching by a string' do
+      expect({foo: 5}.at_path!('foo')).to eq(5)
+    end
+
+    it 'looks up a key given by a symbol' do
+      expect({foo: 5}.at_path!(:foo)).to eq(5)
+    end
+
+    it 'looks up a symbol key given by an array' do
+      expect({foo: 5}.at_path!(['foo'])).to eq(5)
+    end
+
+    it 'looks up a string key given by an array' do
+      expect({'foo' => 5}.at_path!(['foo'])).to eq(5)
+    end
+
+    it 'looks up an object key' do
+      expect({73 => 5}.at_path!([73])).to eq(5)
+    end
+
+    it 'looks up a second level value' do
+      expect({foo: {bar: 5}}.at_path!(['foo', :bar])).to eq(5)
+    end
+
+    it 'raises a nice error when top-level key not found' do
+      expect {
+        {}.at_path!(['foo', 'bar'])
+      }.to raise_error(HashPath::PathNotFound, 'foo')
+    end
+
+    it 'raises a nice error when second-level key not found' do
+      expect {
+        {foo: {}}.at_path!(['foo', 'bar'])
+      }.to raise_error(HashPath::PathNotFound, 'foo.bar')
+    end
+
+    context 'a few more cases' do
+      let(:hash) { { 'foo' => {'bar' => {'baz' => 'hai'} }, "baz" => [11,22] } }
+
+      it 'throws an exception with middle key missing' do
+        expect { hash.at_path!('foo.not.baz') }.to raise_error(HashPath::PathNotFound, 'foo.not')
+      end
+
+      it 'throws an exception with first key missing' do
+        expect { hash.at_path!('not.here.yo') }.to raise_error(HashPath::PathNotFound, 'not')
+      end
+
+      it 'throws an exception with third key missing' do
+        expect { hash.at_path!('foo.bar.not') }.to raise_error(HashPath::PathNotFound, 'foo.bar.not')
+      end
+
+      it 'can traverse an array with a zero-based integer' do
+        expect(hash.at_path!('baz.1')).to eq(22)
+      end
+    end
+  end
+
+  describe '#flatten_key_paths' do
+    it 'un-nests hashes' do
+      expect({a: 5, b: {c: 7}}.flatten_key_paths).to eq({'a' => 5, 'b.c' => 7})
+    end
+  end
+
+  describe 'HashPath::VERSION' do
+    it 'is set' do
+      expect(HashPath::VERSION).not_to eq(nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure(&:disable_monkey_patching!)
+
+require 'hash_path'

metadata

@@ -1,34 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hash_path
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Daniel Neighman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-10 00:00:00 Z
-dependencies: []
-
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Easy path navigation for hashes
-email: 
+email:
 - dneighman@squareup.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -36,38 +54,32 @@ files:
 - hash_path.gemspec
 - lib/hash_path.rb
 - lib/hash_path/version.rb
-homepage: ""
+- spec/hash_path_spec.rb
+- spec/spec_helper.rb
+homepage: ''
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easy path navigation for hashes. Useful in specs
-test_files: []
-
+test_files:
+- spec/hash_path_spec.rb
+- spec/spec_helper.rb
+has_rdoc: