hash-selector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aba65b6d21271d3127dae88d963ac20b182cdc7
+  data.tar.gz: 958929bebd3c730c8ecc5c64bab8d2fed69462d9
+SHA512:
+  metadata.gz: 3fdde540f8d87267856d59a5a47ef94efec344a3b0ec9daacda3bb0c46289f7c7ab5101af7cf707f914a7ed1f74e52ca8fd82fce3ef299c1b401a8d06e396140
+  data.tar.gz: 6ffd9d9d114d4248aa1672956a4febe4d03cca92cb1b7fe9e84d1847563624038731050c3bad836b69b0161f61f1a1b6da5dd0ba6df31d038156288aa8e2df3f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.1"
+  - "2.2.2"
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Peter Williams
+
+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,69 @@
+[![Build Status](https://travis-ci.org/pezra/hash-selector.svg)](https://travis-ci.org/pezra/hash-selector)
+
+# HashSelector
+
+Select values from deeply nested/complex hashes with ease.
+
+## Usage
+
+Consider a complex and deeply nested hash such as the following:
+
+```ruby
+config =
+{ databases: [
+    { name: "myapp_production",
+      user: "myapp",
+      host: "db1"
+    },
+    { name: "legacy_db",
+      host: "db2"
+    }
+  ],
+  "redis": { host: "redis_server" }
+}
+```
+
+Say we want to find the user name of legacy db but if we do not find it use a default value. With just the basic hash behavior this can be rather onerous. With `HashSelector` is it a breeze.
+
+```ruby
+selector = HashSelector.new[:databases].find{|db| db[:name] == "myapp_production"}[:user]
+selector.find_in(config) # => "myapp"
+```
+The selector definition line should be read as "a new selector that chooses the `:databases` item, finds an entry in it whose name is `myapp_production`, and selects its `:user`"
+
+If the location specified by a `HashSelector` does not exist the hash it will raise a `KeyError` unless a block is provided. If a block is provided the block will be evaluated and its return value will returned from `#find_in`.
+
+```ruby
+selector = HashSelector.new[:databases].find{|db| db[:name] == "myapp_test"}[:user]
+selector.find_in(config) { "myapp" } # => "myapp"
+```
+
+In this example, there find fails because there is not entry in `:databases` with a name of `myapp_test` so the default (`myapp`) is returned instead.
+
+`HashSelector`s are immutable and may be reused any any number of different hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash-selector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash-selector
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hash_selector/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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end
+

data/hash_selector.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_selector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash-selector"
+  spec.version       = HashSelector::VERSION
+  spec.authors       = ["Peter Williams"]
+  spec.email         = ["pezra@barelyenough.org"]
+  spec.summary       = %q{Easily select values from deep inside hierarchical hashes.}
+  spec.homepage      = "https://github.com/pezra/hash-selector"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/hash-selector.rb

@@ -0,0 +1 @@
+require_relative "./hash_selector"

data/lib/hash_selector.rb

@@ -0,0 +1,62 @@
+require "hash_selector/version"
+
+# Selects a value from a complex or deeply nested hash structure with default
+# values.
+#
+# Example
+#
+# HashSelector.new[:foo][:bar][:baz].find_in(foo: { bar: { baz: 42 } } )
+# # => 42
+#
+# HashSelector.new[:foo][:bar][:baz].find_in(foo: nil) { 42 }
+# # => 42
+class HashSelector
+
+  # Returns a new selector that selects the specified key from result of the
+  # current selector.
+  def [](key)
+    HashSelector.new steps + [ ->(subject) {
+                                 begin
+                                   subject.fetch(key)
+                                 rescue IndexError
+                                   raise KeyError
+                                 end
+                               } ]
+  end
+
+  # Returns a new selector that selects an entry from the result of the current
+  # selector using a predicate block.
+  def find(&blk)
+    HashSelector.new steps + [ ->(subject) {
+                                   needle = subject.find(->(){ MISSING }, &blk)
+                                   if MISSING == needle
+                                     fail KeyError
+                                   else
+                                     needle
+                                   end
+                               } ]
+  end
+  alias_method :detect, :find
+
+  # Returns the value from a hash at the location specified by this selector.
+  def find_in(hay_stack)
+    steps.reduce(hay_stack) { |search_area, step| step.call(search_area) }
+
+  rescue KeyError
+    if block_given?
+      yield hay_stack
+    else
+      raise
+    end
+  end
+
+  protected
+
+  MISSING = Object.new
+
+  def initialize(steps = [])
+    @steps = steps
+  end
+
+  attr_reader :steps
+end

data/lib/hash_selector/version.rb

@@ -0,0 +1,3 @@
+class HashSelector
+  VERSION = "1.0.0"
+end

data/spec/hash_selector_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe "HashSelector" do
+
+  let(:data) { { foo: {
+                   bar: [
+                     { baz: 1,
+                       name: "alice"},
+                     { baz: 2,
+                       name: "bob"}
+                   ] },
+                 qux: 42 } }
+
+  it "can select values from top level" do
+    expect(
+      HashSelector.new[:qux]
+      .find_in(data)
+    ).to eq 42
+  end
+
+  it "raises error on a index miss" do
+    expect {
+      HashSelector.new[:quux].find_in(data)
+    }.to raise_error KeyError
+  end
+
+  it "returns value of default value block on a index miss" do
+    expect(
+      HashSelector.new[:quux].find_in(data) { "whatever" }
+    ).to eq "whatever"
+  end
+
+  it "can select deeply nested values" do
+    expect( HashSelector.new[:foo][:bar][0][:baz].find_in(data)
+          ).to eq 1
+  end
+
+  it "raise error on a array index miss" do
+    expect { HashSelector.new[:foo][:bar][42].find_in(data)
+    }.to raise_error KeyError
+  end
+
+  it "returns value of default value block a array index miss" do
+    expect(
+      HashSelector.new[:foo][:bar][42].find_in(data) { "whatever" }
+    ).to eq "whatever"
+  end
+
+  it "can select path using #find" do
+    expect(
+      HashSelector.new[:foo][:bar].find{|it| it[:name] == "bob"}[:baz].find_in(data)
+    ).to eq 2
+  end
+
+  it "can select path using #detect" do
+    expect(
+      HashSelector.new[:foo][:bar].detect{|it| it[:name] == "bob"}[:baz]
+      .find_in(data)
+    ).to eq 2
+  end
+
+  it "raises error on a #find/#detect miss" do
+    expect {
+      HashSelector.new[:foo][:bar].detect{|it| it[:name] == "mallory"}
+        .find_in(data)
+    }.to raise_error KeyError
+  end
+
+  it "returns value of default value block on a #find/#detect miss" do
+    expect(
+      HashSelector.new[:foo][:bar].detect{|it| it[:name] == "mallory"}
+        .find_in(data) { "whatever" }
+    ).to eq "whatever"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'hash-selector'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hash-selector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- pezra@barelyenough.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_selector.gemspec
+- lib/hash-selector.rb
+- lib/hash_selector.rb
+- lib/hash_selector/version.rb
+- spec/hash_selector_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pezra/hash-selector
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Easily select values from deep inside hierarchical hashes.
+test_files:
+- spec/hash_selector_spec.rb
+- spec/spec_helper.rb
+has_rdoc: