hash_pick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b75650026df7c097b17e4a1fa531839b0433ac1
+  data.tar.gz: da6ed3ea00514b66eca4d2224683144ebcc2f144
+SHA512:
+  metadata.gz: e8d0f5ead75097e5d2ade4e0b30d44ef2fa374763d6ccfd95d5827fd68d06a561b23e073b5ecda1dc3dfd9b3cbc970873ceb25fadf7ee6ee866171d028153933
+  data.tar.gz: 724582a7f839502b46603823ccc1aae482810eb856d00937e4d80a7d440c1063b82c3e1143efebe2fe637555f6605e7172d1207ae2023f66474bb792425a42cf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--exclude README.md
+--readme README.rdoc
+-

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+[![Gem Version](https://badge.fury.io/rb/hash_path.svg)](http://badge.fury.io/rb/hash_path) [![Build Status](https://travis-ci.org/hetznerZA/hash_path.svg?branch=master)](https://travis-ci.org/hetznerZA/hash_path) [![Dependency Status](https://gemnasium.com/hetznerZA/hash_path.svg)](https://gemnasium.com/hetznerZA/hash_path)
+
+# HashPath
+
+A module of utility methods for hash path queries.
+
+## Documentation
+
+For documentation of the released gem, see [rubydoc.info](http://www.rubydoc.info/gems/hash_path).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_path'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_path
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hetznerZA/hash_path.
+

data/README.rdoc

@@ -0,0 +1,14 @@
+= HashPath
+
+Provides utility methods for hash path queries.
+
+Hash paths can be expressed as lists of keys of these types:
+
+* Object.
+* String.
+* Symbol.
+* Eithe String or Symbol.
+
+The methods are provided by the module {HashPath}.
+
+The implementation is covered by an rspec test suite in the {https://github.com/hetznerZA/hash_path HashPath repo}.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hash_path"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hash_pick.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_pick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_pick"
+  spec.version       = HashPick::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Hash path query}
+  spec.description   = %q{A hash path query support library}
+  spec.homepage      = "https://github.com/hetznerZA/hash_pick"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/lib/hash_pick/version.rb

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

data/lib/hash_pick.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+##
+# Fetch a value from a nested dictionary
+#
+# Provides methods for fetching a value from a nested dictionary (an object that implements +include?+ and +fetch+),
+# using a key path expressed as a list (+Enumerable+).
+#
+# The key path is iterated. In each iteration, the key is looked up in the dictionary, and the value found is used
+# as the dictionary for the next iteration. Lookup failure immediately returns nil.
+#
+# @example Indifferent hash path
+#
+#   require "hash_pick"
+#
+#   dict = {
+#     people: {
+#       "sheldon": {
+#         first_name: "Sheldon",
+#         last_name: "Hearn",
+#         contacts: {
+#           "email": "sheldonh@starjuice",
+#         }
+#       },
+#       "charles": {
+#         first_name: "Charles",
+#         last_name: "Mulder",
+#       }
+#     }
+#   }
+#
+#   HashPick[dict, %w{people sheldon contacts email}] # -> "sheldonh@starjuice"
+#   HashPick[dict, %w{people charles contacts email}] # -> nil
+#
+module HashPick
+
+  ##
+  # Fetch value from dictionary using string or symbol key path
+  #
+  # Each value in the path is used as a symbol or, if symbol lookup fails, a string.
+  #
+  # @param [Hash] hash
+  #   the dictionary to apply the +path+ to.
+  # @param [Array] path
+  #   an ordered list of keys that implement +to_s+ and +to_sym+.
+  # @return [Object] the value found at the path in the dictionary.
+  # @return [nil] if any key lookup failed.
+  #
+  def self.indifferent(hash, path)
+    path.inject(hash) do |acc, p|
+      break unless acc.respond_to?(:include?) && acc.respond_to?(:fetch)
+      if acc.include?(p.to_sym)
+        acc.fetch(p.to_sym)
+      elsif acc.include?(p.to_s)
+        acc[p.to_s]
+      else
+        break
+      end
+    end
+  end
+
+  class << self
+    alias_method :[], :indifferent
+  end
+
+  ##
+  # Fetch value from dictionary using object key path
+  #
+  # Each value in the path is used as is.
+  #
+  # @param [Hash] hash
+  #   the dictionary to apply the +path+ to.
+  # @param [Array] path
+  #   an ordered list of object keys.
+  # @return [Object] the value found at the path in the dictionary.
+  # @return [nil] if any key lookup failed.
+  #
+  def self.object(hash, path)
+    path.inject(hash) do |acc, p|
+      break unless acc.respond_to?(:include?) && acc.respond_to?(:fetch) && acc.include?(p)
+      acc[p]
+    end
+  end
+
+  ##
+  # Fetch value from dictionary using symbol key path
+  #
+  # Each value in the path is used as a symbol.
+  #
+  # @param [Hash] hash
+  #   the dictionary to apply the +path+ to.
+  # @param [Array] path
+  #   an ordered list of keys that implement +to_sym+.
+  # @return [Object] the value found at the path in the dictionary.
+  # @return [nil] if any key lookup failed.
+  #
+  def self.symbol(hash, path)
+    object(hash, path.map(&:to_sym))
+  end
+
+  ##
+  # Fetch value from dictionary using string key path
+  #
+  # Each value in the path is used as a string.
+  #
+  # @param [Hash] hash
+  #   the dictionary to apply the +path+ to.
+  # @param [Array] path
+  #   an ordered list of keys that implement +to_s+.
+  # @return [Object] the value found at the path in the dictionary.
+  # @return [nil] if any key lookup failed.
+  #
+  def self.string(hash, path)
+    object(hash, path.map(&:to_s))
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hash_pick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A hash path query support library
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- README.md
+- README.rdoc
+- Rakefile
+- bin/console
+- bin/setup
+- hash_pick.gemspec
+- lib/hash_pick.rb
+- lib/hash_pick/version.rb
+homepage: https://github.com/hetznerZA/hash_pick
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Hash path query
+test_files: []
+has_rdoc: