dig_rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8119335fa948de9dfdfccbf17dd0bb995fa92d67
+  data.tar.gz: a5fa30724dde8b5798924b74f46ab7b49ef6b885
+SHA512:
+  metadata.gz: 1575d9074b230b488030453743e3344577ed1656c8e1c9867d437e3c011d4669ead57e0c4905454893a694119b4000eda29dcb21605e70241d1bbf8aad499a33
+  data.tar.gz: 6f685adff1c006cfcfef66c2a013ee289787b62b2c1be9706e5d82eb379af6c2e44580502b2ef10cf4586e058c93d23842349f5e3696c4d08b50df88e70f9f4c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jonathan Rochkind
+
+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,57 @@
+# Dig_rb
+
+[Ruby 2.3.0 introduced #dig on Hash, Array, and Struct](https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released/). With this gem, you can have dig on ruby pre 2.3.0, or any ruby lacking dig.
+
+If you are writing an app and want to use dig in it you should probably just upgrade to ruby 2.3.0. But if you are writing a gem and want it to work with both MRI 2.3.0 and others, this gem is for you. This gem only adds #dig methods if they aren't already defined, so it's safe to use in code that is for all rubies, if run on MRI 2.3.0 you'll still be using native #dig, otherwise dig_rb's implementation.
+
+## Will it work identically to MRI 2.3.0 dig?
+
+Dig_rb is tested with:
+
+* Specs found in MRI repo for #dig in 2.3.0
+* [Ruby Spec Suite](https://github.com/ruby/spec/) specs found in repo for Array and Hash#dig
+* All examples in MRI 2.3.0 generated method API docs. (One example in MRI 2.3.0 is _wrong_ about exception class/method returned, dig_rb matches actual 2.3.0 behavior there, not documented example)
+
+If you find any weird edge cases that work differenty in MRI 2.3.0 than in ruby_dig, let me know in a GitHub Issue please.
+
+The performance of dig_rb will probably be less than native MRI 2.3.0 implementation, this code is not written for performance. But it should
+be fine, really.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dig_rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dig_rb
+
+## Usage
+
+Just go ahead and use #dig as doc'd in MRI 2.3.0, now it'll work on any ruby.
+
+* [Hash](http://ruby-doc.org/core-2.3.0/Hash.html#method-i-dig)
+* [Array](http://ruby-doc.org/core-2.3.0/Array.html#method-i-dig)
+* [Struct](http://ruby-doc.org/core-2.3.0/Struct.html#method-i-dig)
+* [OpenStruct](http://ruby-doc.org/stdlib-2.3.0/libdoc/ostruct/rdoc/OpenStruct.html#method-i-dig)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dig_rb/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,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test*.rb'] + FileList['test/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dig_rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dig_rb.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dig_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dig_rb"
+  spec.version       = DigRb::VERSION
+  spec.authors       = ["Jonathan Rochkind"]
+  spec.email         = ["jonathan@dnil.net"]
+
+  spec.summary       = %q{Array/Hash/Struct#dig backfill for ruby}
+  spec.homepage      = "https://github.com/jrochkind/dig_rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dig_rb.rb

@@ -0,0 +1,13 @@
+require 'dig_rb/version'
+require 'dig_rb/hash'
+require 'dig_rb/array'
+require 'dig_rb/struct'
+require 'dig_rb/ostruct'
+
+module DigRb
+  def self.guard_dig(obj)
+    unless obj.respond_to?(:dig)
+      raise TypeError, "#{obj.class.name} does not have #dig method"
+    end
+  end
+end

data/lib/dig_rb/array.rb

@@ -0,0 +1,10 @@
+unless Array.respond_to?(:dig)
+  Array.class_eval do
+    def dig(key, *args)
+      value = self.at(key)
+      return value if args.length == 0 || value.nil?
+      DigRb.guard_dig(value)
+      value.dig(*args)
+    end
+  end
+end

data/lib/dig_rb/hash.rb

@@ -0,0 +1,15 @@
+unless Hash.respond_to?(:dig)
+  Hash.class_eval do
+    # Retrieves the value object corresponding to the each key objects repeatedly.
+    #
+    #     h = { foo: {bar: {baz: 1}}}
+    #     h.dig(:foo, :bar, :baz)           #=> 1
+    #     h.dig(:foo, :zot)                 #=> nil
+    def dig(key, *args)
+      value = self[key]
+      return value if args.length == 0 || value.nil?
+      DigRb.guard_dig(value)
+      value.dig(*args)
+    end
+  end
+end

data/lib/dig_rb/ostruct.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+unless OpenStruct.respond_to?(:dig)
+  OpenStruct.class_eval do
+    #
+    # Retrieves the value object corresponding to the each +name+
+    # objects repeatedly.
+    #
+    #   address = OpenStruct.new('city' => "Anytown NC", 'zip' => 12345)
+    #   person = OpenStruct.new('name' => 'John Smith', 'address' => address)
+    #   person.dig(:address, 'zip') # => 12345
+    #   person.dig(:business_address, 'zip') # => nil
+    #
+    def dig(name, *args)
+      begin
+        name = name.to_sym
+      rescue NoMethodError
+        raise TypeError, "#{name} is not a symbol nor a string"
+      end
+      return nil unless self.respond_to?(name)
+      value = self.send(name)
+      return value if args.length == 0 || value.nil?
+      DigRb.guard_dig(value)
+      value.dig(*args)
+    end
+  end
+end

data/lib/dig_rb/struct.rb

@@ -0,0 +1,27 @@
+require 'ostruct'
+unless Struct.respond_to?(:dig)
+  Struct.class_eval do
+
+    # Extracts the nested value specified by the sequence of <i>idx</i>
+    # objects by calling +dig+ at each step, returning +nil+ if any
+    # intermediate step is +nil+.
+
+    #    klass = Struct.new(:a)
+    #    o = klass.new(klass.new({b: [1, 2, 3]}))
+
+    #    o.dig(:a, :a, :b, 0)              #=> 1
+    #    o.dig(:b, 0)                      #=> nil
+    def dig(name, *args)
+      begin
+        name = name.to_sym
+      rescue NoMethodError
+        raise TypeError, "#{name} is not a symbol nor a string"
+      end
+      return nil unless self.respond_to?(name)
+      value = self.send(name)
+      return value if args.length == 0 || value.nil?
+      DigRb.guard_dig(value)
+      value.dig(*args)
+    end
+  end
+end

data/lib/dig_rb/version.rb

@@ -0,0 +1,3 @@
+module DigRb
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: dig_rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Rochkind
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: 
+email:
+- jonathan@dnil.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dig_rb.gemspec
+- lib/dig_rb.rb
+- lib/dig_rb/array.rb
+- lib/dig_rb/hash.rb
+- lib/dig_rb/ostruct.rb
+- lib/dig_rb/struct.rb
+- lib/dig_rb/version.rb
+homepage: https://github.com/jrochkind/dig_rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Array/Hash/Struct#dig backfill for ruby
+test_files: []