respond_to_dig 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 684e7adf041fc4664d3d08ed6e68690858d1ff18
+  data.tar.gz: 7da073c97ebb9d9227b353f9efdc6c3b4ed744bf
+SHA512:
+  metadata.gz: 0d3310f6d20d9e25c3b79ada3a8a3c18c1a579343e7c218678ca7933556a262a82d1b66982d61309997378d6e48e849749a5edb591b5bff6da715e716627c3fc
+  data.tar.gz: f97cd4a6aec84f0700bf935ec8cad0e200d5c9587c50ecf108b6b90ce92f959e2a5078af356e964cc6d6ef8c6e337b69a04543207d0624f4c0af794a7b8e6bbe

data/.gitignore

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

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+Contributing
+===
+
+1. Fork it ( https://github.com/announce/respond_to_dig/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/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,42 @@
+RespondToDig
+===
+
+[![Build Status](https://travis-ci.org/announce/respond_to_dig.svg?branch=master)](https://travis-ci.org/announce/respond_to_dig)
+
+This gem backports Array#dig and Hash#dig methods from Ruby 2.3+ to earlier versions of Ruby, only if you explicitly call it.
+
+## vs RubyDig
+* [RubyDig](https://github.com/Invoca/ruby_dig) has side-effects, but RespondToDig doesn't.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'respond_to_dig'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install respond_to_dig
+
+## Usage
+
+```
+require 'respond_to_dig'
+
+response = RespondToDig::respond_to_dig({
+            mom: {first: "Marge", last: "Bouvier"},
+            dad: {first: "Homer", last: "Simpson"},
+            kids: [
+                {first: "Bart", last: "Simpson"},
+                {first: "Lisa", last: "Simpson"}
+            ]})
+
+response.dig(:kids, 1, :first)
+# => "Lisa"
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+desc "Run unit tests."
+task :test do
+  ruby "./test/respond_to_dig_test.rb"
+end

data/lib/respond_to_dig/version.rb

@@ -0,0 +1,3 @@
+module RespondToDig
+  VERSION = '1.0.0'.freeze
+end

data/lib/respond_to_dig.rb

@@ -0,0 +1,27 @@
+module RespondToDig
+  RESPONDERS = [Array, Hash]
+
+  class << self
+    def respond_to_dig(receiver)
+      receiver.tap do |r|
+        r.singleton_class.send(:include, RespondToDig) if RespondToDig.target? r
+      end
+    end
+
+    def target?(target)
+      not respond_to? :dig and RESPONDERS.any? {|klass| target.is_a? klass}
+    end
+  end
+
+  def dig(key, *rest)
+    value = RespondToDig::respond_to_dig(self[key])
+    if value.nil? || rest.empty?
+      value
+    elsif value.respond_to?(:dig)
+      value.dig(*rest)
+    else
+      fail TypeError, "#{value.class} does not have #dig method"
+    end
+  end
+
+end

data/respond_to_dig.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'respond_to_dig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "respond_to_dig"
+  spec.version       = RespondToDig::VERSION
+  spec.authors       = ["@ymkjp"]
+  spec.email         = ["ymkjp@jaist.ac.jp"]
+  spec.summary       = %q{Pure Ruby implementation of Array#dig and Hash#dig for Ruby < 2.3.}
+  spec.homepage      = "https://github.com/announce/respond_to_dig"
+  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/respond_to_dig_test.rb

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: respond_to_dig
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- '@ymkjp'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-03 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:
+- ymkjp@jaist.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/respond_to_dig.rb
+- lib/respond_to_dig/version.rb
+- respond_to_dig.gemspec
+- test/respond_to_dig_test.rb
+homepage: https://github.com/announce/respond_to_dig
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Pure Ruby implementation of Array#dig and Hash#dig for Ruby < 2.3.
+test_files:
+- test/respond_to_dig_test.rb