nested_lookup 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c1d498fae745d1ac5d6ad5794725213234cb7fb
-  data.tar.gz: 2578cd450b8c083680f630b7274174598c4835da
+  metadata.gz: 6375c79eb43aa42a0cc87dac7c2c698a14b72bea
+  data.tar.gz: a642e98b2083a1f8b5f33198a28ad8492fc88968
 SHA512:
-  metadata.gz: d3e0255f43b5b0dd4265df11d7a7e03d2a9d4a54ac03201f3e85d1b82528622ad27b0b515d80e6b7dac690370c8834672b5968fc9b78f385553e32767589d8bb
-  data.tar.gz: da20018e60c7024f77eac2696c95b86eb0dad2d2498aefe24b0db83f662e647f8fdd93789766514faae89fcc08fbd4a1bae52cd14d9c8d09faa01cd3252aec5e
+  metadata.gz: fe7cc244265a0c8a93acaf1736ec3ede23c196a889836f06f45de5f1a67439513ed393e09356081fbc1a4d941c996f2cb3aafb60740ad7923f5c77c403dfd5f5
+  data.tar.gz: ede8c61e70832728424903e049bddf45993c211650714f95b3d53c772fd38c9058b62d12eaa06458acc1ef615fd1ceb45adc607ad9aceb27c8935e9ab86cbd8a

data/.travis.yml

@@ -8,6 +8,8 @@ deploy:
   api_key:
     secure: F/wADg5teclCHTkQHVL413+Ow3/XGkAgSMsWJOKKc+vJqdBTckz60U9ghUL36RF1XX7ZcZZ8biUb2hM1mGUPtG/C6uML2tWy2KBbHNf8yleGL9C68cWM+AicQ5yF3Ug8GRKd/XaM4uxh3gCv1QSqOez8beYVIjjw2U+otper/5hTYzgMoKYCSN9+z0bUhrEbEMull5WgG+RF+3ulHThW96fD3LhetnJOEewHhHbmr2fO4QUAF2trLxVKczYeAOf1KrEicbxgTM9CEIgYRyGSTAyfKAKB8fW87hcn2xxJi6OkZOVZSw1HPnhS9GtfMyGAC+wAEY540Q03NHutwvdARZoylbBKnuuGCrZUSv0215ueCrBSvdBR1vLXkiDXpi02LHYo7nrq6sy6e7WC9UDwGTMSDlZDJaSPiXqY7YIAzyapbaCU+FzUVSoN8ZI6cNZx0sKrR/h+sAZlfnVEPG7wkK+jaMh0Lo3JW3Yzn92vsFbq04sirZ82WrxNHaw9vHZd/jO0Xuj8hkF8tI0YDnlm8H41mbFlue2j7eaXFFkU3o6/P1YwdMqu7q/B+MAl41jfgRDsolv8XZ9jlt7QE1C3ESJxI/aJqyALfzTiNZHhHvKckUzHtTWGndeVkm0g1AWP+fbUw1qTjooWriYm7/L6uOBzqmVipzVnV1dDDEiXQGw=
   gem: nested_lookup
+  on:
+    tags: true
 
 env:
   global:

data/README.md

@@ -1,11 +1,14 @@
 # NestedLookup [![Build Status](https://travis-ci.com/rameshrvr/nested_lookup.svg?branch=master)](https://travis-ci.com/rameshrvr/nested_lookup) [![Coverage Status](https://codecov.io/gh/rameshrvr/nested_lookup/badge.svg?branch=master)](https://codecov.io/gh/rameshrvr/nested_lookup?branch=master) [![Gem Version](https://badge.fury.io/rb/nested_lookup.svg)](https://badge.fury.io/rb/nested_lookup)
 
-A small ruby library which enables key/value lookups on deeply nested documents (Arrays and Hashes)
+Ruby library which enables key/value lookup, update, delete 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
+Features: (document might be Array of Hashes/Hash, Arrays/nested Arrays/nested Hashes etc)
+1. (nested_lookup) key lookups on deeply nested document.
+2. (get_all_keys) fetching all keys from a nested document.
+3. (get_occurrence_of_key/get_occurrence_of_value) get the number of occurrences of a key/value from a nested document
+4. (nested_get) Get a value in a nested document using its key
+5. (nested_update) Update a value in a nested document using its key
+6. (nested_delete) Delete a key->value pair in nested document using its key
 
 Documents may be built out of nested Hashes and/or Arrays.
 
@@ -33,8 +36,6 @@ Or install it yourself as:
 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',
@@ -80,8 +81,18 @@ irb(main):036:0> sample_data.get_occurrence_of_value('memory')
 # 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> 
-
+# Get value for the key 'memory', 'l2_cache(per_core)'
+irb(main):032:0* sample_data.nested_get('memory')
+=> "16 GB"
+irb(main):033:0> sample_data.nested_get('l2_cache(per_core)')
+=> "256 KB"
+# Delete a key in nested document (key -> 'hardware_details')
+irb(main):034:0> sample_data.nested_delete('hardware_details')
+=> {:dup_hardware_details=>{:model_name=>"MacBook Pro - 1", :os_details=>{:product_version=>"10.14.0", :build_version=>"17G65"}}}
+# Update a key in nested document (key -> 'hardware_details')
+irb(main):035:0> sample_data.nested_update(key: 'hardware_details', value: 'Test')
+=> {:hardware_details=>"Test", :dup_hardware_details=>{:model_name=>"MacBook Pro - 1", :os_details=>{:product_version=>"10.14.0", :build_version=>"17G65"}}}
+irb(main):036:0>
 ```
 
 ### longer tutorial
@@ -167,6 +178,53 @@ irb(main):065:0> sample_data.get_occurrence_of_value('256 KB')
 irb(main):072:0>
 ```
 
+To Get / Delete / Update a key->value pair in a nested document
+
+```ruby
+irb(main):001:0> require 'nested_lookup'
+=> true
+irb(main):066:0* sample_data.nested_get('os_details')
+=> {:product_version=>"10.13.6", :build_version=>"17G65"}
+irb(main):067:0> sample_data.nested_get('memory')
+=> "16 GB"
+irb(main):068:0> sample_data.nested_delete('processor_details')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}}
+irb(main):069:0> sample_data.nested_update(key: 'processor_details', value: 'Test')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :processor_details=>"Test", :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}}
+irb(main):070:0>
+```
+
+Delete key->value pair (Normal and bang menthod)
+
+```ruby
+# Normal method (Returns a document that includes everything but the given key)
+irb(main):068:0> sample_data.nested_delete('processor_details')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}}
+irb(main):071:0* 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"}}
+# Bang method (Replaces the document without the given key)
+irb(main):074:0* sample_data.nested_delete!('processor_details')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}}
+irb(main):075:0> sample_data
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :os_details=>{:product_version=>"10.13.6", :build_version=>"17G65"}, :memory=>"16 GB"}}
+```
+
+Update value for the given key (Normal and bang method)
+
+```ruby
+# Normal method (Returns a document that has updated key, value pair)
+irb(main):109:0* sample_data.nested_update(key: 'processor_details', value: 'Test')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :processor_details=>"Test", :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):110:0> 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"}, :dup_hardware_details=>{:model_name=>"MacBook Pro - 1", :os_details=>{:product_version=>"10.14.0", :build_version=>"17G65"}}}
+# Replaces the document with the updated key, value pair
+irb(main):114:0* sample_data.nested_update!(key: 'processor_details', value: 'Test')
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :processor_details=>"Test", :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):115:0> sample_data
+=> {:hardware_details=>{:model_name=>"MacBook Pro", :processor_details=>"Test", :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"}}}
+
+```
+
 ## 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.

data/lib/lookup_api.rb

@@ -0,0 +1,118 @@
+# Module that holds methods Get, Delete, Update
+module LookUpApi
+  @result = nil
+  # Private method to lookup inside a document
+  def _get(key:, document:)
+    if document.instance_of? Array
+      document.each do |array_element|
+        _get(key: key, document: array_element)
+      end
+    elsif document.instance_of? Hash
+      document.each do |hash_key, hash_value|
+        @result = hash_value if hash_key.to_s.eql?(key)
+        _get(key: key, document: hash_value)
+      end
+    end
+    # Return NIL if the key is not present in the document
+    @result
+  end
+
+  # Method to get the value from 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
+  #
+  # @return Value if found else NULL
+  def nested_get(key)
+    _get(key: key, document: dup)
+  end
+
+  # Returns a document that includes everything but the given key.
+  #    document = { a: 1, b: 2, c: 3 }
+  #    document.nested_delete('c') # => { a: 1, b: 2 }
+  #    document # => { a: 1, b: 2, c: 3 }
+  #
+  # @param document Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  # @param key: Key to delete
+  #
+  # @return Result document
+  def nested_delete(key)
+    # Create deep copy of the object
+    temp = Marshal.load(Marshal.dump(self))
+    temp.nested_delete!(key)
+  end
+
+  # Replaces the document without the given key.
+  #    document = { a: 1, b: 2, c: 3 }
+  #    document.nested_delete!('c') # => { a: 1, b: 2 }
+  #    document # => { a: 1, b: 2 }
+  #
+  # @param document Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  # @param key: Key to delete
+  #
+  # @return self
+  def nested_delete!(key)
+    if instance_of? Array
+      each do |array_element|
+        array_element.nested_delete!(key)
+      end
+    elsif instance_of? Hash
+      each do |hash_key, hash_value|
+        if hash_key.to_s.eql?(key)
+          delete(hash_key)
+        else
+          hash_value.nested_delete!(key)
+        end
+      end
+    end
+    self
+  end
+
+  # Returns a document that has updated key, value pair.
+  #    document = { a: 1, b: 2, c: 3 }
+  #    document.nested_update(key: 'c', value: 4) # => { a: 1, b: 2 , c: 4}
+  #    document # => { a: 1, b: 2, c: 3 }
+  #
+  # @param document Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  # @param key: Key to Update
+  # @param value: Value to be updated
+  #
+  # @return Result document
+  def nested_update(key:, value:)
+    # Create deep copy of the object
+    temp = Marshal.load(Marshal.dump(self))
+    temp.nested_update!(key: key, value: value)
+  end
+
+  # Replaces the document with the updated key, value pair.
+  #    document = { a: 1, b: 2, c: 3 }
+  #    document.nested_update!(key: 'c', value: 4) # => { a: 1, b: 2 , c: 4}
+  #    document # => { a: 1, b: 2, c: 4 }
+  #
+  # @param document Might be Array of Hashes (or)
+  #   Hash of Arrays (or) Hash of array of hash etc...
+  # @param key: Key to Update
+  # @param value: Value to be updated
+  #
+  # @return self
+  def nested_update!(key:, value:)
+    if instance_of? Array
+      each do |array_element|
+        array_element.nested_update!(key: key, value: value)
+      end
+    elsif instance_of? Hash
+      each do |hash_key, hash_value|
+        if hash_key.to_s.eql?(key)
+          self[hash_key] = value
+        else
+          hash_value.nested_update!(key: key, value: value)
+        end
+      end
+    end
+    self
+  end
+end

data/lib/nested_lookup.rb

@@ -1,4 +1,9 @@
 require_relative 'nested_lookup/version'
+require_relative 'lookup_api'
+
+# Include all supporting modules here
+include NestedLookup
+include LookUpApi
 
 # module responsible for holding nested_lookup methods
 module NestedLookup

data/lib/nested_lookup/version.rb

@@ -1,3 +1,3 @@
 module NestedLookup
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/nested_lookup.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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.homepage      = 'https://rubygems.org/gems/nested_lookup'
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
     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."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nested_lookup
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ramesh RV
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,17 +70,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/lookup_api.rb
 - lib/nested_lookup.rb
 - lib/nested_lookup/version.rb
 - nested_lookup.gemspec
-homepage: https://github.com/rameshrvr/nested_lookup
+homepage: https://rubygems.org/gems/nested_lookup
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/rameshrvr/nested_lookup
+  homepage_uri: https://rubygems.org/gems/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: