dig-deep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35933e61d897b3d44728667d1e655d7b08a897f7
+  data.tar.gz: c719afa694f9819a030831b062731658bebf4ebd
+SHA512:
+  metadata.gz: eb18b9fd7ec987dafdd3103a0b6d70d0045f2399ba5132abb945db3db87d681a8a7efdae0c903388a57c1d28c12370e6171c48bbae43acc3835f230e2a82ea4e
+  data.tar.gz: 06824caf48cc80bbc629ffabf44de98b2a14187751444491b5437d6ef00d620a938e3e31222a210b7250f49b1dae5345ee0c6d82cd6c6b07b26c97db5bfa33fc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+dig-deep*gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at henryszeto@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dig-deep.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    dig-deep (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dig-deep!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Henry Szeto
+
+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,123 @@
+# DigDeep
+
+DigDeep will look up key/value pairs in a nested hash by a given key. It will recursively dig each nested object and return all matching key/values.
+
+Ruby's dig method can perform similar tasks, but you need to specify the path to the target key.
+
+With this gem, you will only need to specify the target key and it will do the digging.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dig-deep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dig-deep
+
+## Usage
+#### Example 1:
+Given the following hash:
+```
+data = {
+  a: {
+    b: {
+      c: "abc"
+    }
+  }
+}
+```
+Ruby `.dig`:
+```
+data.dig(:a, :b, :c)   // "abc"
+```
+With DigDeep:
+```
+require 'dig-deep'
+
+data.dig_deep(:c)      // "abc"
+```
+
+#### Example 2:
+Dig up all `:email`
+```
+data = {
+  contacts: [{
+    name: "John",
+    email: "john@example.com"
+  }, {
+    name: "Mary",
+    email: "mary@example.com"
+  }],
+  work: {
+    contacts: [{
+      name: "ACME Corp.",
+      email: "acme@example.com"
+    }, {
+      name: "Asdf Inc.",
+      email: "asdf@example.com"
+    }]
+  }
+}
+```
+```
+require 'dig-deep'
+
+data.dig_deep(:email)  // ["john@example.com", "mary@example.com", "acme@example.com", "asdf@example.com"]
+```
+
+#### Example 3:
+Object with boolean, string, array...
+```
+data = {
+  :l1 => {
+    :l2 => {
+      :l3 => {
+        :l4a => "Level 4",
+        :l4b => {
+          :l5a => false,
+          :l5b => {
+            :l6 => ["apple", "orange"]
+          }
+        } 
+      }
+    }
+  },
+  :l7 => true,
+  :l8 => {
+    :l9 => 9876
+  }
+}
+```
+```
+require 'dig-deep'
+
+data.dig_deep(:l4a)   // "Level 4"
+
+data.dig_deep(:l5a)   // false
+
+data.dig_deep(:l6)    // ["apple", "orange"]
+
+data.dig_deep(:l9)    // 9876
+
+data.dig_deep(:xyz)   // nil   (returns nil when key is not found)
+```
+
+## Contributing
+#### Bug reports and pull requests are welcome!
+Fork it, create your new branch, push and create a pull request.
+ 
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DigDeep project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dig-deep/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dig/deep"
+
+# 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(__FILE__)

data/bin/setup

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

data/dig-deep.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dig_deep/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dig-deep"
+  spec.version       = DigDeep::VERSION
+  spec.authors       = ["Henry Szeto"]
+  spec.email         = ["henryszeto@gmail.com"]
+
+  spec.summary       = %q{Dig into a nested Hash and return all values by the key.}
+  spec.description   = %q{Give a hash key, DigDeep will recursively search in the hash and return all values.}
+  spec.homepage      = "https://github.com/hszeto/dig-deep"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dig-deep.rb

@@ -0,0 +1,58 @@
+require "dig_deep/version"
+require "json"
+
+module DigDeep
+  def dig_deep(target)
+    results = dig_for(self, target)
+
+    return nil if results.empty?
+    return results[0] if results.length === 1
+    return results
+  end
+end
+
+class Hash
+  include DigDeep
+end
+
+
+private
+
+def dig_for(obj, target)
+  drill(obj, target).map do |m|
+    string_to_array(m) ? string_to_array(m) : m
+  end.compact
+end
+
+def drill(obj, target)
+  if is_object?(obj)
+    if (obj.is_a?(Hash) && obj.key?(target))
+      acc = obj[target].is_a?(Array) ? ["#{obj[target]}"] : [ obj[target] ]
+    end
+
+    obj.reduce(acc ||= []) do |acc, val|
+      if (val.is_a?(Hash) && val.key?(target))
+        acc << (val[target].is_a?(Array) ? "#{val[target]}" : val[target])
+      elsif val.is_a?(Array)
+        acc << val.reduce([]){|acc, v| drill(v, target) if is_object?(v) }
+      elsif val.is_a?(Hash)
+        acc << val.values.reduce([]){|acc,v| drill(v,target)}
+      else
+        acc
+      end
+    end.compact.flatten(1)
+  end
+end
+
+def is_object?(obj)
+  return true if ( obj.class == Hash || obj.class == Array )
+  return false
+end
+
+def string_to_array(val)
+  begin
+    JSON.parse(val)
+  rescue
+    nil
+  end
+end

data/lib/dig_deep/version.rb

@@ -0,0 +1,3 @@
+module DigDeep
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: dig-deep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henry Szeto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Give a hash key, DigDeep will recursively search in the hash and return
+  all values.
+email:
+- henryszeto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dig-deep.gemspec
+- lib/dig-deep.rb
+- lib/dig_deep/version.rb
+homepage: https://github.com/hszeto/dig-deep
+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: Dig into a nested Hash and return all values by the key.
+test_files: []