kernel-fetch_in 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2ZiMjU0NWM0Y2Q4ZmNkY2IyNDMwMmM5ODIyZTY3YzVlNWQ1ODgxMw==
+  data.tar.gz: !binary |-
+    OThkNGE0NjEzZjc0ODE5MTVkNzUxMWY3OGJlZDllMjEzYTlkYTNmNQ==
+SHA512:
+  metadata.gz: !binary |-
+    YWIzMzYyZjRmZjVlZmUxMjY5ZjUyOWI1Y2FhNTMxM2NlYjQwNTJmYWM2NTVk
+    YWZhZWU0ZWY4Yzc3ZmFjNGFhNjNkMDA5MWU0YmI3MTBmZGYzYTUzMjZkMWM5
+    NmFmNWY5NzU4MjA2MTQ0NzE5MjUzN2U2MzAxYjUwNWY3MDAyZGU=
+  data.tar.gz: !binary |-
+    NDFkOTVlOWU2NjZhM2FmM2MzNGRhZWY4MjE0Y2QxMWNhZmZlODc5NjU1MTFk
+    YWQxZDcwYWNkZTc5YTY4ODQ2MjM1MDlmOWVlZGYzOWNiNzkxZGRjMTg1MDFj
+    ZDM1MDM2Y2I4NzQyNDI2YTMwYTRjOGVmZGRiMjJmOTlmMjJhYzg=

data/.gitignore

@@ -0,0 +1,14 @@
+/.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,14 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.5
+deploy:
+  provider: rubygems
+  api_key:
+    secure: bgwOZUqdIvxdsvTqxTAp/Ay1QzWlMCcs8cDZ5/EJQWogeHObD9RAeHGchMYJeon1vKgkFBx1pQW/rVzcDzsXii8Cn7u2IYqHeVMWoYkoB/svavY6gGd/amM40HhvyK4HNZpXxZJuqZpJryUD3igNkbdskbYS5iTvE8IWQixmiMU=
+  gem: kernel-fetch_in
+  on:
+    tags: true
+    repo: nicknovitski/kernel-fetch_in
+    all_branches: true

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nick Novitski
+
+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,73 @@
+# Kernel#fetch_in
+
+This gem is for people who need to leap boldy into deep and treacherous hashes.
+It adds a single method to Kernel, `#fetch_in`.  If you know Clojure, you can
+think of it as a Ruby version of `get-in`.
+
+```ruby
+# from this:
+customer = response['customer']
+billing = customer_hash['billing_address'] if customer
+country_code = billing['country'] if billing
+do_something(with: country_code) if country_code
+
+# to this:
+country_code = fetch_in(response, 'customer', 'billing_address', 'country') { false }
+do_something(with: country_code) if country_code
+
+# or maybe even
+do_something(with: fetch_in(response, 'customer', 'billing_address', 'country') { 'N/A' }
+```
+
+## Installation
+
+Stick this in your Gemfile:
+```ruby
+gem 'kernel-fetch_in'
+```
+
+## Usage
+
+```
+fetch_in(collection, *keys) → obj
+fetch_in(collection, *keys) { |key| block } → obj
+```
+
+`fetch_in` looks up values in nested Hashes (and Arrays, and anything else with
+a `#fetch` method).  First it fetches the value in the passed collection at the first key,
+then it fetches the value in that value at the next key, if any, and so on for
+all keys passed, returning the last value fetched.
+
+```ruby
+bob = {
+  powers: {
+    strength: 'super',
+    toughness: 'extreme'
+  }
+}
+helen = {
+  powers: {
+    flexibility: 'extreme',
+    flight: 'expert'
+  }
+}
+
+fetch_in(bob, :powers, :strength) #=> 'super'
+fetch_in(helen, :powers, :flight) #=> 'expert'
+```
+
+If the optional block parameter is passed, it is evaluated for a default value
+when any of the passed keys are not present.
+
+```ruby
+fetch_in(bob, :powers, :flexibility) { 'normal' } #=> 'normal'
+fetch_in(helen, :weaknesses, :physical) { 'unknown' } #=> 'unknown'
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/nicknovitski/kernel-fetch_in/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,4 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task default: :spec

data/kernel-fetch_in.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetch_in/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kernel-fetch_in'
+  spec.version       = FetchIn::VERSION
+  spec.authors       = ['Nick Novitski']
+  spec.email         = ['nicknovitski@gmail.com']
+  spec.summary       = 'Nested #fetch in functional and OO flavors'
+  spec.homepage      = 'https://github.com/nicknovitski/kernel-fetch_in'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/fetch_in/version.rb

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

data/lib/kernel/fetch_in.rb

@@ -0,0 +1,15 @@
+require 'kernel/fetch_in'
+
+module Kernel
+  def fetch_in(collection, *keys)
+    last_key = nil
+    keys.reduce(collection) do |c, k|
+      last_key = k
+      c.fetch(k)
+    end
+  rescue IndexError, KeyError
+    raise unless block_given?
+    yield last_key
+  end
+  private :fetch_in
+end

data/spec/kernel/fetch_in_spec.rb

@@ -0,0 +1,47 @@
+require 'kernel/fetch_in'
+
+RSpec.describe Kernel do
+  let(:collection) { double }
+  let(:key) { double }
+  let(:value) { double }
+
+  describe '#fetch_in' do
+    context 'passed a single key argument' do
+      it 'returns what #fetch on the collection argument returns' do
+        allow(collection).to receive(:fetch).with(key) { value }
+        expect(fetch_in(collection, key)).to be value
+      end
+
+      [IndexError, KeyError].each do |err|
+        context "when #fetch raises a #{err}" do
+          before { allow(collection).to receive(:fetch).with(key) { raise err } }
+
+          it 'raises that Error' do
+            expect { fetch_in(collection, key) }.to raise_error err
+          end
+
+          context 'and a block argument is provided' do
+            it 'returns the return value of that block argument' do
+              expect(fetch_in(collection, key) { value }).to be value
+            end
+
+            it 'yields the the key to that block' do
+              expect { |b| fetch_in(collection, key, &b) }.to yield_with_args(key)
+            end
+          end
+        end
+      end
+    end
+
+    context 'passed multiple key arguments' do
+      it 'chains #fetch calls on the collection' do
+        allow(collection).to receive(:fetch).with(key) { value }
+        outer_collection = double
+        key2 = double
+        allow(outer_collection).to receive(:fetch).with(key2) { collection }
+
+        expect(fetch_in(outer_collection, key2, key)).to be value
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: kernel-fetch_in
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Novitski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- nicknovitski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kernel-fetch_in.gemspec
+- lib/fetch_in/version.rb
+- lib/kernel/fetch_in.rb
+- spec/kernel/fetch_in_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nicknovitski/kernel-fetch_in
+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.2
+signing_key: 
+specification_version: 4
+summary: ! 'Nested #fetch in functional and OO flavors'
+test_files:
+- spec/kernel/fetch_in_spec.rb
+- spec/spec_helper.rb