respond_to_dig 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 684e7adf041fc4664d3d08ed6e68690858d1ff18
-  data.tar.gz: 7da073c97ebb9d9227b353f9efdc6c3b4ed744bf
+  metadata.gz: 38f3df9283b99bb984df4903b5cbf3c9918eafd3
+  data.tar.gz: 4fda9b0c7ad5aa7a33e0f75c872e01714a2e4f64
 SHA512:
-  metadata.gz: 0d3310f6d20d9e25c3b79ada3a8a3c18c1a579343e7c218678ca7933556a262a82d1b66982d61309997378d6e48e849749a5edb591b5bff6da715e716627c3fc
-  data.tar.gz: f97cd4a6aec84f0700bf935ec8cad0e200d5c9587c50ecf108b6b90ce92f959e2a5078af356e964cc6d6ef8c6e337b69a04543207d0624f4c0af794a7b8e6bbe
+  metadata.gz: 70ed1d747efffcf96b38ba3e70c1fb3730b09e5466fc72f591f964675ab098c925d8ce8b63c55ad7b8112f451cae5190f2c2ec632288865445c245baecfa2da7
+  data.tar.gz: c5ef4ceee329deaf2317936992287be1aced7310256a18c61f1ecca5113ee3cc61558cae4222e05fcf709c09f98713d542d4a98ca89d09fdf46107882f2e0487

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace  = true
+max_line_length = 120

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+| Q             | A
+| ------------- | ---
+| Branch?       | "master" for new features / 1.0 for fixes
+| Bug fix?      | yes/no
+| New feature?  | yes/no
+| BC breaks?    | yes/no
+| Deprecations? | yes/no
+| Tests pass?   | yes/no
+| Fixed tickets | comma-separated list of tickets fixed by the PR, if any
+| License       | MIT
+| Doc PR        | reference to the documentation PR, if any

data/.gitignore

@@ -12,3 +12,7 @@
 *.o
 *.a
 mkmf.log
+
+!/.github/
+!/.editorconfig
+!/.travis.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9

data/README.md

@@ -5,8 +5,9 @@ RespondToDig
 
 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.
+## vs [RubyDig](https://github.com/Invoca/ruby_dig)
+* RubyDig has side-effects, but RespondToDig doesn't.
+* RespondToDig only supports `Array` and `Hash`, but RespondToDig supports any `Enumerable` classes which have `[]` method such as `Struct`.
 
 ## Installation
 

data/lib/respond_to_dig/version.rb

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

data/lib/respond_to_dig.rb

@@ -1,15 +1,18 @@
 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
+        r.singleton_class.send(:include, RespondToDig) if RespondToDig.diggable? r
       end
     end
 
-    def target?(target)
-      not respond_to? :dig and RESPONDERS.any? {|klass| target.is_a? klass}
+    # The reason why not purely duck typed by `[]` method is to avoid unexpected behavior,
+    # for example we won't get `'o'` by `'foo'.dig(1)` by String#[].
+    def diggable?(target)
+      target.is_a? Enumerable and
+          target.respond_to? :[] and
+          not target.respond_to? :dig
     end
   end
 

data/respond_to_dig.gemspec

@@ -6,9 +6,9 @@ require 'respond_to_dig/version'
 Gem::Specification.new do |spec|
   spec.name          = "respond_to_dig"
   spec.version       = RespondToDig::VERSION
-  spec.authors       = ["@ymkjp"]
+  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.summary       = %q{Explicit backporting of Array#dig and Hash#dig for Ruby < 2.3.}
   spec.homepage      = "https://github.com/announce/respond_to_dig"
   spec.license       = "MIT"
 

data/test/respond_to_dig_test.rb

@@ -25,6 +25,10 @@ class RespondToDigTest
     let (:a_nested_hash) {
       RespondToDig::respond_to_dig({mom: {first: "Marge", last: "Bouvier"}, dad: {first: "Homer", last: "Simpson"}})
     }
+    let (:containing_struct) {
+      Dog = Struct.new(:name, :age)
+      RespondToDig::respond_to_dig({dogs: [Dog.new("Fred", 5), Dog.new("Harry", 2)]})
+    }
 
     describe "Array" do
       it "digs an array by index" do
@@ -47,10 +51,6 @@ class RespondToDigTest
         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
@@ -82,11 +82,20 @@ class RespondToDigTest
       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)
+    describe "Various classes" do
+      it "navigates both nested Hash and Array" 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
+
+      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 "digs into Enumerable object that implements #[]" do
+        assert_equal 'Harry', RespondToDig::respond_to_dig(containing_struct).dig(:dogs, 1, :name)
       end
     end
   end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: respond_to_dig
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- '@ymkjp'
+- ymkjp
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,42 +14,42 @@ dependencies:
   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: 
@@ -59,7 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".editorconfig"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -79,19 +82,19 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Pure Ruby implementation of Array#dig and Hash#dig for Ruby < 2.3.
+summary: Explicit backporting of Array#dig and Hash#dig for Ruby < 2.3.
 test_files:
 - test/respond_to_dig_test.rb