nested_lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8f0b066a9fadc7710505ae6e7e60b6dbc8c050c
+  data.tar.gz: 15fb97664ee9a09f88a9de46e5b4d085dfb99193
+SHA512:
+  metadata.gz: '049a7d3dec924ce0e2e77f469abd6d7dd123209b06c1e29d735da18bd4fb342b9d81ec97d356e88b4d15d5d0f25d985de9cd903060da48132af380bcf074f14c'
+  data.tar.gz: a2c0cc4ed54fce1c12cb159128cc95c7a04589afe54e2b3b9a8019923f310401096083defaedb71457562177240d3162b4ae7c85c67d1e1b69a0cdc228b60c9c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.7
+before_install: gem install bundler -v 1.16.6

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 rameshrvr@outlook.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 nested_lookup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ramesh RV
+
+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,186 @@
+# NestedLookup
+
+A small ruby library which enables key/value lookups on deeply nested documents (Arrays and Hashes)
+
+Features: (document might be Array of Hashes/Hash or Arrays/nested Arrays/nested Hashes etc)
+1. key lookups on deeply nested document.
+2. fetching all keys from a nested document.
+3. get the number of occurrences of a key/value from a nested document
+
+Documents may be built out of dictionaries (dicts) and/or lists.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nested_lookup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nested_lookup
+
+## Usage
+
+### quick tutorial
+
+```ruby
+Rameshs-MacBook-Pro:nested_lookup rameshrv$ irb
+irb(main):001:0> require 'nested_lookup'
+=> true
+irb(main):002:0> include NestedLookup
+=> Object
+irb(main):003:0> sample_data = {
+irb(main):004:1*   "hardware_details": {
+irb(main):005:2*     "model_name": 'MacBook Pro',
+irb(main):006:2*     "processor_details": [
+irb(main):007:3*       {
+irb(main):008:4*         "processor_name": 'Intel Core i7',
+irb(main):009:4*         "processor_speed": '2.7 GHz',
+irb(main):010:4*         "core_details": {
+irb(main):011:5*           "total_numberof_cores": '4',
+irb(main):012:5*           "l2_cache(per_core)": '256 KB'
+irb(main):013:5>         }
+irb(main):014:4>       }
+irb(main):015:3>     ],
+irb(main):016:2*     "os_details": {
+irb(main):017:3*       "product_version": '10.13.6',
+irb(main):018:3*       "build_version": '17G65'
+irb(main):019:3>     },
+irb(main):020:2*     "memory": '16 GB'
+irb(main):021:2>   },
+irb(main):022:1*   "dup_hardware_details": {
+irb(main):023:2*     "model_name": 'MacBook Pro - 1',
+irb(main):024:2*     "os_details": {
+irb(main):025:3*       "product_version": '10.14.0',
+irb(main):026:3*       "build_version": '17G65'
+irb(main):027:3>     },
+irb(main):028:2*   }
+irb(main):029:1> }
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :processor_details=>[{:processor_name=>"Intel Core i7", :processor_speed=>"2.7 GHz", :core_details=>{:total_numberof_cores=>"4", :"l2_cache(per_core)"=>"256 KB"}}], :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}, :dup_hardware_details=>{:model_name=>"MacBook Pro - 1", :os_details=>{:product_version=>"10.14.0", :build_version=>"17G65"}}}
+irb(main):030:0> 
+irb(main):032:0> 
+# Search for key 'product_version'
+irb(main):033:0* sample_data.nested_lookup('product_version')
+=> ["10.13.6", "10.14.0"]
+# Fetch all keys from the document
+irb(main):034:0> sample_data.get_all_keys
+=> ["hardware_details", "model_name", "processor_details", "processor_name", "processor_speed", "core_details", "total_numberof_cores", "l2_cache(per_core)", "os_details", "product_version", "build_version", "memory", "dup_hardware_details", "model_name", "os_details", "product_version", "build_version"]
+# Get occurrence of key 'model_name' (present in both 'hardware_details', 'dup_hardware_details')
+irb(main):035:0> sample_data.get_occurrence_of_key('model_name')
+=> 2
+# Get occurrence of value 'memory' (It is actually a key, should return 0)
+irb(main):036:0> sample_data.get_occurrence_of_value('memory')
+=> 0
+# Get occurrence of value 'Intel Core i7'
+irb(main):037:0> sample_data.get_occurrence_of_value('Intel Core i7')
+=> 1
+irb(main):038:0> 
+
+```
+
+### longer tutorial
+
+You may control the nested_lookup method's behavior by passing some optional arguments.
+
+1. wild (defaults to `False`):
+
+ - if `wild` is `True`, treat the given `key` as a case insensitive
+ substring when performing lookups.
+
+2. with_keys (defaults to `False`):
+
+ - if `with_keys` is `True`, return a Hash of all matched keys
+  and an Array of values.
+
+For example, given the following document:
+
+```ruby
+sample_data = {
+  "hardware_details": {
+    "model_name": 'MacBook Pro',
+    "processor_details": [
+      {
+        "processor_name": 'Intel Core i7',
+        "processor_speed": '2.7 GHz',
+        "core_details": {
+          "total_numberof_cores": '4',
+          "l2_cache(per_core)": '256 KB'
+        }
+      }
+    ],
+    "os_details": {
+      "product_version": '10.13.6',
+      "build_version": '17G65'
+    },
+    "memory": '16 GB'
+  }
+}
+```
+
+We could act `wild` and find all the version like this:
+
+```ruby
+irb(main):069:0* sample_data.nested_lookup('version', wild: true)
+=> ["10.13.6", "17G65"]
+irb(main):072:0>
+```
+
+Additionally, if you also needed the matched key names, you could do this:
+
+```ruby
+irb(main):071:0* sample_data.nested_lookup('version', wild: true, with_keys: true)
+=> {"product_version"=>["10.13.6"], "build_version"=>["17G65"]}
+irb(main):073:0* sample_data.nested_lookup('product_version', with_keys: true)
+=> {"product_version"=>["10.13.6"]}
+irb(main):074:0> 
+```
+
+To get a list of every nested key in a document, run this:
+
+```ruby
+irb(main):060:0* require 'nested_lookup'
+=> false
+irb(main):061:0> include NestedLookup
+=> Object
+irb(main):062:0> sample_data.get_all_keys
+=> ["hardware_details", "model_name", "processor_details", "processor_name", "processor_speed", "core_details", "total_numberof_cores", "l2_cache(per_core)", "os_details", "product_version", "build_version", "memory"]
+irb(main):063:0> 
+```
+
+To get the number of occurrence of the given key/value
+
+```ruby
+irb(main):060:0* require 'nested_lookup'
+=> false
+irb(main):061:0> include NestedLookup
+=> Object
+irb(main):064:0* sample_data.get_occurrence_of_key('processor_speed')
+=> 1
+irb(main):065:0> sample_data.get_occurrence_of_value('256 KB')
+=> 1
+irb(main):072:0>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rameshrvr/nested_lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 NestedLookup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rameshrvr/nested_lookup/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 "nested_lookup"
+
+# 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/lib/nested_lookup.rb

@@ -0,0 +1,170 @@
+require_relative 'nested_lookup/version'
+
+# module responsible for holding nested_lookup methods
+module NestedLookup
+  # Method to lookup a key in a deeply nested document
+  #
+  # @param document: Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  # @param key: Key to lookup
+  # @param wild: Default disabled, enable it to
+  #   perform case insensitive lookup
+  # @param with_keys: Set to true will get the results with keys
+  #
+  # @return (with_keys set to false) Array of values
+  #         (with_keys set to true) Hash of keys and values
+  def nested_lookup(
+      key, wild: false, with_keys: false
+    )
+    if with_keys
+      result_hash = {}
+      _nested_lookup(
+        key: key, document: self,
+        wild: wild, with_keys: with_keys
+      ).each do |temp_hash|
+        temp_hash.each do |hash_key, hash_value|
+          if !(result_hash[hash_key.to_s])
+            result_hash[hash_key.to_s] = [hash_value]
+          else
+            result_hash[hash_key.to_s].push(hash_value)
+          end
+        end
+      end
+      return result_hash
+    end
+    result_array = _nested_lookup(
+      key: key, document: self, wild: wild,
+      with_keys: with_keys
+    )
+    result_array
+  end
+
+  # Private method to lookup inside a document
+  def _nested_lookup(
+      key:, document:, wild: false,
+      with_keys: false, result: []
+    )
+    if document.instance_of? Array
+      document.each do |array_element|
+        _nested_lookup(
+          key: key, document: array_element,
+          wild: wild, with_keys: with_keys,
+          result: result
+        )
+      end
+    elsif document.instance_of? Hash
+      document.each do |hash_key, hash_value|
+        if hash_key.to_s.eql?(key) || (
+            wild && hash_key.to_s.downcase.include?(key.downcase)
+          )
+          if with_keys
+            result.push("#{hash_key}": hash_value)
+          else
+            result.push(hash_value)
+          end
+        end
+        if hash_value.instance_of? Array
+          _nested_lookup(
+            key: key, document: hash_value,
+            wild: wild, with_keys: with_keys,
+            result: result
+          )
+        elsif hash_value.instance_of? Hash
+          _nested_lookup(
+            key: key, document: hash_value,
+            wild: wild, with_keys: with_keys,
+            result: result
+          )
+        end
+      end
+    end
+    result
+  end
+
+  # Method to get all keys from a nested dictionary as a List
+  #
+  # @param document: Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  #
+  # @return Array of keys in the document
+  #
+  # Usage:
+  # => document.get_all_keys() (or) document.get_all_keys
+  def get_all_keys(
+      result_array: []
+    )
+    if instance_of? Array
+      each do |_element|
+        _element.get_all_keys(result_array: result_array)
+      end
+    elsif instance_of? Hash
+      each do |key, value|
+        result_array.push(key.to_s)
+        if value.instance_of? Hash
+          value.get_all_keys(result_array: result_array)
+        elsif value.instance_of? Array
+          value.each do |arr_element|
+            arr_element.get_all_keys(result_array: result_array)
+          end
+        end
+      end
+    end
+    result_array
+  end
+
+  # Method to get occurrence of key in a deeply nested
+  # document
+  #
+  # @param document: Deeply nested document
+  # @param key: key name to look into the document
+  #
+  # @return Number of occurrence (Integer)
+  def get_occurrence_of_key(key)
+    _get_occurrence(document: self, item: 'key', keyword: key)
+  end
+
+  # Method to get occurrence of value in a deeply nested
+  # document
+  #
+  # @param document: Deeply nested document
+  # @param value: value name to look into the document
+  #
+  # @return Number of occurrence (Integer)
+  def get_occurrence_of_value(value)
+    _get_occurrence(document: self, item: 'value', keyword: value)
+  end
+
+  # Private method to get occurrence of key or value in deeply
+  # nested document
+  def _get_occurrence(
+      document:, item:, keyword:
+    )
+    @result = 0
+    @item = item
+    @keyword = keyword
+    def recrusion(document:)
+      if document.instance_of? Hash
+        if @item == 'key'
+          @result += 1 if document.key?(@keyword.to_sym)
+        elsif document.value?(@keyword)
+          @result += document.values.count(@keyword)
+        end
+        document.each do |_key, value|
+          if value.instance_of? Hash
+            recrusion(document: value)
+          elsif value.instance_of? Array
+            value.each do |element|
+              recrusion(document: element)
+            end
+          end
+        end
+      elsif document.instance_of? Array
+        document.each do |element|
+          recrusion(document: element)
+        end
+      end
+    end
+    recrusion(document: document)
+    @result
+  end
+end

data/lib/nested_lookup/version.rb

@@ -0,0 +1,3 @@
+module NestedLookup
+  VERSION = '0.1.0'.freeze
+end

data/nested_lookup.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/nested_lookup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_lookup"
+  spec.version       = NestedLookup::VERSION
+  spec.authors       = ["Ramesh RV"]
+  spec.email         = ["rameshrvr@outlook.com"]
+
+  spec.summary       = %q{Ruby gem which enables key/value lookups on deeply nested documents (Arrays and Hashes)}
+  spec.description   = %q{A small ruby library which enables key/value lookups on deeply nested documents (Arrays and Hashes)}
+  spec.homepage      = "https://github.com/rameshrvr/nested_lookup"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/rameshrvr/nested_lookup"
+    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: nested_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramesh RV
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-29 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: A small ruby library which enables key/value lookups on deeply nested
+  documents (Arrays and Hashes)
+email:
+- rameshrvr@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nested_lookup.rb
+- lib/nested_lookup/version.rb
+- nested_lookup.gemspec
+homepage: https://github.com/rameshrvr/nested_lookup
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rameshrvr/nested_lookup
+  source_code_uri: https://github.com/rameshrvr/nested_lookup
+  changelog_uri: 'TODO: Put your gem''s CHANGELOG.md URL here.'
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby gem which enables key/value lookups on deeply nested documents (Arrays
+  and Hashes)
+test_files: []