hash_dig_and_collect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fad901b18c1025db61c628891834e39f3364bdd9
+  data.tar.gz: 48948fabfe8ee7a3488a276787d87a6e7848a55c
+SHA512:
+  metadata.gz: 537012f52a0dfcda47ed6e30fd34c57b98b438a4b65019ccad1418f4f358a5ab4b899da6623748f70094936884159e9c6db2b5384ae6aaf7fe4a732bec7d5dff
+  data.tar.gz: cf99df1ab898d37dbd826e03f9fdfa8c6bd35555622c17479ad4f38ad4f387c1874176ca96183de7be3b77c8ddbea5dbbe6484ae17a0e5651ef407aef41cc9dc

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    hash_dig_and_collect (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  hash_dig_and_collect!
+  pry
+  pry-nav
+  rspec
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Colin Kelley
+
+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,66 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_dig_and_collect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_dig_and_collect
+
+## Usage
+
+Hash#dig  in Ruby 2.3 completely changed the way I navigate deeply nested hashes. This repo contains an implementation of 
+Hash#dig_and_collect, a new utility method to navigate even more complex nested hashes without messing up your code. 
+
+See the details of the why in this [Blog post](http://www.alfredo.motta.name/making-ruby-hashdig-even-more-awesome-introducing-hashdig_and_collect).
+
+```
+client_with_many_addresses = {
+  details: {
+    first_name: "Florentino",
+    last_name: "Perez"
+  },
+  addresses: [
+    {
+      type: "home",
+      postcode: "SE1 9SG",
+      street: "London Bridge St",
+      number: 32,
+      city: "London",
+      location: {
+        latitude: 51.504382,
+        longitude: -0.086279
+      }
+    },
+    {
+      type: "office",
+      postcode: "SW1A 1AA",
+      street: "Buckingham Palace Road",
+      number: nil,
+      city: "London",
+      location: {
+        latitude: 51.5013673,
+        longitude: -0.1440787
+      }
+    }
+  ]
+}
+
+client_with_many_addresses.dig_and_collect(:addresses, :location, :latitude)
+# 51.5013673
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mottalrd/hash_dig_and_collect/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/examples/dig_and_collect_demonstration.rb

@@ -0,0 +1,81 @@
+# This example demonstrates how complicated it could
+# get without dig_and_collect and why it is a good idea
+# to have it
+
+require_relative 'lib/hash'
+
+client_with_no_addresses = {
+  details: {
+    first_name: "Florentino",
+    last_name: "Perez"
+  },
+  addresses: nil
+}
+
+client_with_one_address = {
+  details: {
+    first_name: "Florentino",
+    last_name: "Perez"
+  },
+  addresses:  {
+    type: "home",
+    postcode: "SE1 9SG",
+    street: "London Bridge St",
+    number: 32,
+    city: "London",
+    location: {
+      latitude: 51.504382,
+      longitude: -0.086279
+    }
+  }
+}
+
+client_with_many_addresses = {
+  details: {
+    first_name: "Florentino",
+    last_name: "Perez"
+  },
+  addresses: [
+    {
+      type: "home",
+      postcode: "SE1 9SG",
+      street: "London Bridge St",
+      number: 32,
+      city: "London",
+      location: {
+        latitude: 51.504382,
+        longitude: -0.086279
+      }
+    },
+    {
+      type: "office",
+      postcode: "SW1A 1AA",
+      street: "Buckingham Palace Road",
+      number: nil,
+      city: "London",
+      location: {
+        latitude: 51.5013673,
+        longitude: -0.1440787
+      }
+    }
+  ]
+}
+
+def get_offices_latitudes_for(client)
+  addresses = client[:addresses]
+  return [] if addresses.nil?
+
+  if addresses.is_a? Hash
+    [ addresses.dig(:location, :latitude) ]
+  else
+    addresses.map { |address| address.dig(:location, :latitude) }
+  end
+end
+
+puts get_offices_latitudes_for(client_with_no_addresses).join(", ")
+puts get_offices_latitudes_for(client_with_one_address).join(", ")
+puts get_offices_latitudes_for(client_with_many_addresses).join(", ")
+
+puts client_with_no_addresses.dig_and_collect(:addresses, :location, :latitude)
+puts client_with_one_address.dig_and_collect(:addresses, :location, :latitude)
+puts client_with_many_addresses.dig_and_collect(:addresses, :location, :latitude)

data/examples/dig_limitations.rb

@@ -0,0 +1,35 @@
+# This example demonstrates the limitations of dig when
+# you have Arrays in your nested Hash
+
+client_with_many_addresses = {
+  details: {
+    first_name: "Florentino",
+    last_name: "Perez"
+  },
+  addresses: [
+    {
+      type: "home",
+      postcode: "SE1 9SG",
+      street: "London Bridge St",
+      number: 32,
+      city: "London",
+      location: {
+        latitude: 51.504382,
+        longitude: -0.086279
+      }
+    },
+    {
+      type: "office",
+      postcode: "SW1A 1AA",
+      street: "Buckingham Palace Road",
+      number: nil,
+      city: "London",
+      location: {
+        latitude: 51.5013673,
+        longitude: -0.1440787
+      }
+    }
+  ]
+}
+
+puts client_with_many_addresses.dig(:addresses, :location, :latitude)

data/hash_dig_and_collect.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_dig_and_collect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_dig_and_collect"
+  spec.version       = HashDigAndCollect::VERSION
+  spec.authors       = ["Alfredo Motta"]
+  spec.summary       = %q{Utility method build on top of Ruby dig to navigate hashes mixed up with arrays.}
+  spec.homepage      = "https://github.com/mottalrd/hash_dig_and_collect"
+  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 "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/hash_dig_and_collect.rb

@@ -0,0 +1,23 @@
+module HashDigAndCollect
+  def dig_and_collect *keys
+    keys = keys.dup
+
+    next_key = keys.shift
+    return [] unless self.has_key? next_key
+
+    next_val = self[next_key]
+    return [next_val] if keys.empty?
+
+    return next_val.dig_and_collect(*keys) if next_val.is_a? Hash
+
+    return [] unless next_val.is_a? Array
+    next_val.each_with_object([]) do |v, result|
+      inner = v.dig_and_collect(*keys)
+      result.concat inner
+    end
+  end
+end
+
+class Hash
+  include HashDigAndCollect
+end

data/lib/hash_dig_and_collect/version.rb

@@ -0,0 +1,3 @@
+module HashDigAndCollect
+  VERSION = "0.0.1"
+end

data/spec/hash_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require_relative '../lib/hash_dig_and_collect'
+
+RSpec.describe HashDigAndCollect do
+  describe '#dig_and_collect' do
+    context 'when key is present' do
+      let(:values) { [nil, '', []] }
+
+      context 'when nil' do
+        subject do { a: nil } end
+        it 'returns the value' do
+          expect(subject.dig_and_collect(:a)).to eq([ nil ])
+        end
+      end
+
+      context 'when empty string' do
+        subject do { a: '' } end
+        it 'returns the value' do
+          expect(subject.dig_and_collect(:a)).to eq([ '' ])
+        end
+      end
+
+      context 'when empty array' do
+        subject do { a: [] } end
+        it 'returns the value' do
+          expect(subject.dig_and_collect(:a)).to eq([ [] ])
+        end
+      end
+    end
+
+    context 'when no arrays are present' do
+      subject do
+        {
+          a: { b: { c: 'ok' } }
+        }
+      end
+
+      it 'collects the values' do
+        expect(subject.dig_and_collect(:a, :b, :c)).to eq(['ok'])
+      end
+
+      context 'and some key is missing' do
+        it 'returns an empty array' do
+          expect(subject.dig_and_collect(:a, :zzz, :c)).to eq([])
+        end
+      end
+    end
+
+    context 'when arrays are present' do
+      subject do
+        {
+          a: [
+            {
+              b: {
+                c: [
+                  { d: { e: 'ok' } },
+                  { d: { e: 'ok' } }
+                ]
+              }
+            },
+            {
+              b: {
+                c: [
+                  { d: { e: 'ok' } },
+                  { d: { e: 'ok' } }
+                ]
+              }
+            }
+          ]
+        }
+      end
+
+      it 'returns an array with the collected values' do
+        expect(subject.dig_and_collect(:a, :b, :c, :d, :e)).to eq(['ok', 'ok', 'ok', 'ok'])
+      end
+
+      context 'some key in the path is missing' do
+        it 'default to empty set' do
+          expect(subject.dig_and_collect(:a, :zz, :c, :d, :e)).to eq([])
+        end
+      end
+    end
+
+    context 'when objects are present and we miss the path' do
+      subject do
+        {
+          a: { b: Object.new }
+        }
+      end
+
+      it 'returns an empty array' do
+        expect(subject.dig_and_collect(:a, :b, :c)).to eq([])
+      end
+    end
+
+    context 'when objects are present and there is a path' do
+      subject do
+        {
+          a: [
+            { b: Object.new },
+            { b: { c: 'ok' } }
+          ]
+        }
+      end
+
+      it 'returns an empty array' do
+        expect(subject.dig_and_collect(:a, :b, :c)).to eq(['ok'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require 'pry-nav'
+
+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
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: hash_dig_and_collect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alfredo Motta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-04 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: rspec
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- examples/dig_and_collect_demonstration.rb
+- examples/dig_limitations.rb
+- hash_dig_and_collect.gemspec
+- lib/hash_dig_and_collect.rb
+- lib/hash_dig_and_collect/version.rb
+- spec/hash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mottalrd/hash_dig_and_collect
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Utility method build on top of Ruby dig to navigate hashes mixed up with
+  arrays.
+test_files:
+- spec/hash_spec.rb
+- spec/spec_helper.rb