ruby_dig2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e6979c486db18c2597b6d41471e387bf482a6d1
+  data.tar.gz: da672e7a1374ff3978f82f857b813dce51865e72
+SHA512:
+  metadata.gz: 61f7272f33bc0689ddba786fdea5f360915444f33e013d3979a578887b3a2787c28aece2ae2ca4aa888fa6e0d0e775075d96b101cee72703647329df8f535a77
+  data.tar.gz: fbf7277e84cbc700dbc42779ff343a748c5bb9ca2334803c9bbbf0c6a499a14298647c0ad7917ce1f44692260c98a31e647971e07c441452eb10e276d465529d

data/.gitignore

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

data/Gemfile

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

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,59 @@
+# RubyDig2
+
+`Hash#dig2` and `Array#dig2` enhances Rubys `Hash#dig` and `Array#dig` methods functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_dig2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_dig2
+
+## Usage
+
+```
+require 'ruby_dig2'
+
+response = {mom: {first: "Marge", last: "Bouvier"},
+            dad: {first: "Homer", last: "Simpson"},
+            kids: [
+                {first: "Bart", last: "Simpson"},
+                {first: "Lisa", last: "Simpson"}
+            ]}
+
+response.dig2(:kids, 1, :first)
+# => "Lisa"
+```
+
+Or finding the first detected element in array of hashes.
+
+```
+require 'ruby_dig2'
+
+response = {mom: {first: "Marge", last: "Bouvier"},
+            dad: {first: "Homer", last: "Simpson"},
+            kids: [
+                {first: "Bart", last: "Simpson"},
+                {first: "Lisa", last: "Simpson"}
+            ]}
+
+response.dig2(:kids, {first: 'Lisa'}, :last)
+# => "Simpson"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/leoc/ruby_dig2/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,8 @@
+require 'bundler/gem_tasks'
+
+task default: :test
+
+desc 'Run unit tests.'
+task :test do
+  ruby './test/ruby_dig2_test.rb'
+end

data/lib/ruby_dig2.rb

@@ -0,0 +1,26 @@
+module RubyDig2
+  def dig2(key, *rest)
+    value =
+      if key.is_a?(Hash)
+        detect do |e| 
+          key.all? { |k, v| e[k] == v }
+        end
+      else
+        self[key]
+      end
+    if value.nil? || rest.empty?
+      value
+    elsif value.respond_to?(:dig2)
+      value.dig2(*rest)
+    else
+      fail TypeError, "#{value.class} does not have #dig2 method"
+    end
+  end
+end
+
+class Array
+  include RubyDig2
+end
+class Hash
+  include RubyDig2
+end

data/lib/ruby_dig2/version.rb

@@ -0,0 +1,3 @@
+module RubyDig2
+  VERSION = '0.0.1'
+end

data/ruby_dig2.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_dig2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_dig2'
+  spec.version       = RubyDig2::VERSION
+  spec.authors       = ['Colin Kelley', 'Arthur Andersen']
+  spec.email         = ['colin@invoca.com', 'aandersen@velalu.qa']
+  spec.summary       = 'Enhanced Array#dig and Hash#dig implementation.'
+  spec.homepage      = 'https://github.com/leoc/ruby_dig2'
+  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 'minitest'
+end

data/test/ruby_dig2_test.rb

@@ -0,0 +1,88 @@
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+
+require 'minitest'
+require 'minitest/autorun'
+
+require 'ruby_dig2'
+
+class RubyDig2Test
+  class Diggable
+    def dig2(*keys)
+      keys
+    end
+  end
+
+  describe RubyDig2 do
+    describe "Array" do
+      it "digs an array by index" do
+        assert_equal 'one', ['zero', 'one', 'two'].dig2(1)
+      end
+
+      it "digs a nested array by index" do
+        assert_equal 'twelve', ['zero', ['ten', 'eleven', 'twelve'], 'two'].dig2(1, 2)
+      end
+
+      it "raises TypeError when nested array doesn't support dig2" do
+        assert_raises(TypeError) { ['zero', 'one', 'two'].dig2(1, 2) }
+      end
+
+      it "returns nil when dig not found" do
+        assert_equal nil, ['zero', 'one', 'two'].dig2(4)
+      end
+
+      it "raises TypeError when dig index not an integer" do
+        assert_raises(TypeError) { ['zero', 'one', 'two'].dig2(:four) }
+      end
+
+      it "digs into any object that implements dig2" do
+        assert_equal [:a, :b], [0, Diggable.new].dig2(1, :a, :b)
+      end
+
+      it "returns the value false" do
+        assert_equal false, [:a, [true, false]].dig2(1, 1)
+      end
+    end
+
+    describe "Hash" do
+      it "digs a hash by key" do
+        assert_equal 'Homer', {first: "Homer", last: "Simpson"}.dig2(:first)
+      end
+
+      it "digs a nested hash by keys" do
+        assert_equal 'Homer', {mom: {first: "Marge", last: "Bouvier"}, dad: {first: "Homer", last: "Simpson"}}.dig2(:dad, :first)
+      end
+
+      it "raises TypeError when nested hash doesn't support dig2" do
+        assert_raises(TypeError) { {mom: {first: "Marge", last: "Bouvier"}, dad: "Homer Simpson"}.dig2(:dad, :first) }
+      end
+
+      it "returns nil when dig not found" do
+        assert_equal nil, {first: "Homer", last: "Simpson"}.dig2(:middle)
+      end
+
+      it "digs into any object that implements dig2" do
+        assert_equal [:a, :b], {diggable: Diggable.new}.dig2(:diggable, :a, :b)
+      end
+
+      it "returns the value false" do
+        assert_equal false, {first: "Homer", last: "Simpson", sobber: false}.dig2(:sobber)
+      end
+    end
+
+    describe "Nested Hash and Array" do
+      it "navigates both" do
+        assert_equal 'Lisa', {mom: {first: "Marge", last: "Bouvier"},
+                              dad: {first: "Homer", last: "Simpson"},
+                              kids: [{first: "Bart"}, {first: "Lisa"}]}.dig2(:kids, 1, :first)
+      end
+
+      it "detects key-value path element" do
+        assert_equal 'Bouvier', { people: [
+                                    {first: "Marge", last: "Bouvier"},
+                                    {first: "Homer", last: "Simpson"},
+                                  ]
+                                }.dig2(:people, {first: "Marge"}, :last)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: ruby_dig2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Colin Kelley
+- Arthur Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-14 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: minitest
+  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:
+- colin@invoca.com
+- aandersen@velalu.qa
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_dig2.rb
+- lib/ruby_dig2/version.rb
+- ruby_dig2.gemspec
+- test/ruby_dig2_test.rb
+homepage: https://github.com/leoc/ruby_dig2
+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: Enhanced Array#dig and Hash#dig implementation.
+test_files:
+- test/ruby_dig2_test.rb