respond_to_dig 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f3df9283b99bb984df4903b5cbf3c9918eafd3
-  data.tar.gz: 4fda9b0c7ad5aa7a33e0f75c872e01714a2e4f64
+  metadata.gz: 7093fc0a72916735cfa5a2e911152ad6564b8029
+  data.tar.gz: d8d5fa0f6cc82c881caca196a30df4bcfb915090
 SHA512:
-  metadata.gz: 70ed1d747efffcf96b38ba3e70c1fb3730b09e5466fc72f591f964675ab098c925d8ce8b63c55ad7b8112f451cae5190f2c2ec632288865445c245baecfa2da7
-  data.tar.gz: c5ef4ceee329deaf2317936992287be1aced7310256a18c61f1ecca5113ee3cc61558cae4222e05fcf709c09f98713d542d4a98ca89d09fdf46107882f2e0487
+  metadata.gz: 3b9e60265b8f80a7066be6acc05e8194ba9cdbba5b935bc35366e1e452310d9d4a15b4ce38e033aee7a842aee0271bc73caa39c260f4856e939f7784b7a1adbf
+  data.tar.gz: 77f95396978f600b84f0f3ed38432651d9942ee0c991ad0fb412f122514edae8a802a907714d647350089871c9b018543e08475bf3c55b8e0cfadf00ab2ab34e

data/README.md

@@ -7,7 +7,7 @@ This gem backports Array#dig and Hash#dig methods from Ruby 2.3+ to earlier vers
 
 ## 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`.
+* RespondToDig only supports `Array` and `Hash`, but RespondToDig supports any `Enumerable` objects which have `[]` method such as `Struct`.
 
 ## Installation
 
@@ -27,17 +27,16 @@ Or install it yourself as:
 
 ## Usage
 
-```
+```rb
 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"}
-            ]})
+h = RespondToDig::respond_to_dig({ foo: {bar: {baz: 1 }}})
+h.dig(:foo, :bar, :baz)           #=> 1
+h.dig(:foo, :zot, :xyz)           #=> nil
+h.dig(:foo, :bar, :baz, :xyz)     #=> TypeError
 
-response.dig(:kids, 1, :first)
-# => "Lisa"
+g = RespondToDig::respond_to_dig({ foo: [10, 11, 12] })
+g.dig(:foo, 1)                    #=> 11
 ```
+
+For the details, refer [Module: RespondToDig — Documentation](http://www.rubydoc.info/gems/respond_to_dig/RespondToDig).

data/lib/respond_to_dig/version.rb

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

data/lib/respond_to_dig.rb

@@ -1,21 +1,44 @@
+# Extracts the nested value specified by the sequence of index by calling dig at each step,
+# returning nil if any intermediate step is nil.
+# @example
+#   h = RespondToDig::invoke_dig({ foo: {bar: {baz: 1 }}})
+#   h.dig(:foo, :bar, :baz)           #=> 1
+#   h.dig(:foo, :zot, :xyz)           #=> nil
+#   h.dig(:foo, :bar, :baz, :xyz)     #=> TypeError
+#
+#   g = RespondToDig::invoke_dig({ foo: [10, 11, 12] })
+#   g.dig(:foo, 1)                    #=> 11
 module RespondToDig
 
   class << self
+    # Invokes `RespondToDig` module if the `receiver` object is digabble
+    # @see RespondToDig#digabble
+    # @param receiver [Object]
+    # @return [Object, RespondToDig]
     def respond_to_dig(receiver)
       receiver.tap do |r|
         r.singleton_class.send(:include, RespondToDig) if RespondToDig.diggable? r
       end
     end
 
-    # 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#[].
+    # Returns whether the `target` object is able to be invoked by `RespondToDig`
+    # @note 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#[].
+    # @param target [Object]
+    # @return [Bool]
     def diggable?(target)
       target.is_a? Enumerable and
           target.respond_to? :[] and
           not target.respond_to? :dig
     end
+
+    alias_method :invoke_dig, :respond_to_dig
   end
 
+  # Retrieves the value object corresponding to the each `key` objects recursively with nil-safe
+  # @param key [Object, ...]
+  # @raise [TypeError] Throws if trying to access the value which doesn't respond to `#dig` such as `String` object
+  # @return [Object, RespondToDig, NilClass]
   def dig(key, *rest)
     value = RespondToDig::respond_to_dig(self[key])
     if value.nil? || rest.empty?

data/test/respond_to_dig_test.rb

@@ -99,4 +99,10 @@ class RespondToDigTest
       end
     end
   end
+
+  describe "Alias" do
+    it 'alias #invoke_dig' do
+      assert_equal RespondToDig::respond_to_dig({}), RespondToDig::invoke_dig({})
+    end
+  end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: respond_to_dig
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - ymkjp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-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: 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,10 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".gitignore"
-- ".travis.yml"
+- .editorconfig
+- .github/PULL_REQUEST_TEMPLATE.md
+- .gitignore
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -82,17 +82,17 @@ 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.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Explicit backporting of Array#dig and Hash#dig for Ruby < 2.3.