hash_miner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47cc3f1132fb53760a709194961033a327634cda3d5b5f32583cb8ab8af1cc61
+  data.tar.gz: 192a1594d31a7565aaa0d1bfc0835a29b2cdf57326c131bd6756aa58901fc5d8
+SHA512:
+  metadata.gz: 2dde32d4292f9f66374cac7c048ec5373537bfc4b988a563202aa824a394a6b7e3b0b6af057eda8e9c481aac93910b9a188714e6e2e77760c57debdd1fd98335
+  data.tar.gz: 05354d5f27da7d4d0a6f0de3c58315929193596f9a08d651e83f352df6b9f3573070016bb8e84fb64eaa2ebf8395e97c4689fbf69d38476044ed991b17297233

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 130
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/MultilineBlockChain:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_miner.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'pry', '~> 0.14'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 alexo
+
+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,146 @@
+# HashMiner
+
+Ever experienced the pain of working with deeply nested hashes in Ruby? 
+
+HashMiner expands the base Hash class in Ruby to provide helpful methods to traverse and manipulate your Hash Object regardless of complexity.
+
+The following gives a flavour of how HashMiner can help solve headaches when working with complex hashes:
+
+```ruby
+require 'hash_miner'
+
+hash = { my: { super: { duper: { deeply: 'nested hash' } } } }
+
+# Deleting a key #
+# Without HashMiner
+hash[:my][:super].delete(:duper) # => {:deeply=>"nested hash"}
+# With HashMiner
+hash.deep_remove(key: :duper) # => {:my=>{:super=>{}}}
+
+# Updating a key #
+# Without HashMiner
+hash[:my][:super][:duper][:deeply] = 'modified nested hash' # => "modified nested hash"
+# With HashMiner
+hash.deep_update(key: :deeply, value: 'modified nested hash') # => {:my=>{:super=>{:duper=>{:deeply=>"modified nested hash"}}}}
+
+# Checking a key exists #
+# Without HashMiner
+hash[:my][:super][:duper][:deeply] # => "nested hash"
+# With HashMiner
+hash.deep_find(key: :deeply) # => ["nested hash"]
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add hash_miner
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install hash_miner
+
+## Usage
+
+- HashMiner methods have no side-effects
+
+### Methods available
+#### deep_update
+
+- Updates all values that match the given key
+
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: :nasty } } }
+
+nasty_hash.deep_update(key: :nasty, value: :complicated_hash) # => {:my=>{:pretty=>[{:nasty=>:complicated_hash}, nil], :is=>{:pretty=>:nasty}}}
+
+# Errors on uniqueness
+nasty_hash.deep_update(key: :pretty, value: :super_duper) # => throws KeyNotUniqueError
+nasty_hash.deep_update(key: :pretty, value: :super_duper, error_on_uniqueness: false) # => {:my=>{:pretty=>:super_duper, :is=>{:pretty=>:super_duper}}}
+
+# Errors on missing
+nasty_hash.deep_update(key: :huh, value: :where_am_i) # => throws KeyNotFoundError
+nasty_hash.deep_update(key: :pretty, value: :super_duper, error_on_missing: false) # => {:my=>{:pretty=>[{:nasty=>:hash}, nil], :is=>{:pretty=>:nasty}}, :huh=>:where_am_i}
+
+```
+---
+#### deep_remove
+
+- Removes all values that match the given key
+
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: :nasty } } }
+
+nasty_hash.deep_remove(key: :nasty) # => {:my=>{:pretty=>[{}, nil], :is=>{:pretty=>:nasty}}}
+
+# Errors on uniqueness
+nasty_hash.deep_remove(key: :pretty) # => throws KeyNotUniqueError
+nasty_hash.deep_remove(key: :pretty, error_on_uniqueness: false) # => {:my=>{:is=>{}}}
+```
+---
+#### deep_find
+
+- Returns all values that match the given key
+
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: :nasty } } }
+
+nasty_hash.deep_find(key: :nasty) # => [:hash]
+nasty_hash.deep_find(key: :pretty) # => [{:nasty=>:hash}, nil, :nasty]
+```
+---
+#### deep_compact
+
+- Removes nil and empty values from Hash
+- Will not remove values within an Array i.e `[nil, {}]` will remain
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: {}, nasty: nil } } }
+
+nasty_hash.deep_compact # => {:my=>{:pretty=>[{:nasty=>:hash}, nil]}}
+```
+---
+#### deep_count
+
+- Returns a count for the given key
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: :nasty } } }
+
+nasty_hash.deep_count(key: :pretty) # => 2 
+nasty_hash.deep_count(key: :nasty) # => 1 
+```
+---
+#### deep_contains?
+
+- Returns `true|false` depending on if given is found
+```ruby
+require 'hash_miner'
+
+nasty_hash = { my: { pretty: [{ nasty: :hash }, nil], is: { pretty: :nasty } } }
+
+nasty_hash.deep_contains?(key: :nasty) # => true
+nasty_hash.deep_contains?(key: :super_nasty) # => false
+```
+
+## 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 the created tag, 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/[USERNAME]/hash_miner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/lib/hash_miner/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class KeyNotUniqueError < StandardError
+end
+
+class KeyNotFoundError < StandardError
+end

data/lib/hash_miner/hash.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# Adds additional methods to the Hash class
+class Hash
+  include HashMiner
+
+  # Checks if the key exists within a Hash
+  #
+  # @param key [String, Symbol] the key you want to check
+  # @param hash [Hash] the hash obj - used for recursive calling
+  #
+  # @return [Boolean] whether the key was found
+  def deep_contains?(key:, hash: self)
+    return nil unless hash.is_a? Hash
+    return true if hash.include? key
+
+    hash.filter_map do |_k, v|
+      case v
+      when Hash
+        [v.deep_contains?(key: key)]
+      when Array
+        [v.map { |i| deep_contains?(key: key, hash: i) }]
+      else
+        false
+      end
+    end.flatten.include? true
+  end
+
+  # Count the number of occurrences a key has in a Hash
+  #
+  # @param key [String, Symbol]
+  # @param hash [Hash]
+  #
+  # @return [Integer] the number of occurrences for a given key
+  def deep_count(key:, hash: self)
+    found = 0
+    return found unless hash.is_a? Hash
+    return found unless hash.deep_contains?(key: key)
+
+    hash.each do |k, v|
+      found += 1 if k.eql? key
+      found += deep_count(hash: v, key: key) if v.is_a?(Hash)
+      v.each { |i| found += deep_count(hash: i, key: key) } if v.is_a?(Array)
+    end
+
+    found
+  end
+
+  # Finds the value for a given key
+  #
+  # @param key [String, Symbol]
+  # @param hash [Hash]
+  #
+  # @return [Array] with all values that match the key
+  def deep_find(key:, hash: self)
+    return nil unless hash.is_a? Hash
+    return nil unless hash.deep_contains?(key: key)
+
+    hash.filter_map do |k, v|
+      if k.eql? key
+        v
+      elsif v.is_a?(Hash)
+        deep_find(hash: v, key: key)
+      elsif v.is_a?(Array)
+        [v.filter_map { |i| deep_find(hash: i, key: key) }]
+      end
+    end.flatten
+  end
+
+  # Removed nil/empty from Hash
+  #
+  # @return [Hash] with no nil/empty values
+  def deep_compact
+    if is_a?(Hash)
+      to_h do |k, v|
+        case v
+        when Hash
+          [k, v.deep_compact]
+        when Array
+          [k, v.map do |i|
+            i.is_a?(Hash) ? i.deep_compact : i
+          end]
+        else
+          [k, v]
+        end
+      end.delete_if { |_, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
+    else
+      self
+    end
+  end
+
+  # Updates specified key in nested hash.
+  #
+  # @param key [String, Symbol] the key to update
+  # @param value [String] the value to be set
+  # @param error_on_missing [Boolean] error if key missing
+  # @param error_on_uniqueness [Boolean] error if key not unique
+  #
+  # @return [Hash] the object with specified key updated.
+  def deep_update(key:, value:, error_on_missing: true, error_on_uniqueness: true)
+    return self unless is_a? Hash
+
+    if error_on_uniqueness && (deep_count(key: key) > 1)
+      raise KeyNotUniqueError, "Key: '#{key}' not unique | Pass 'error_on_uniqueness: false' if you do not care"
+    end
+
+    unless deep_contains?(key: key)
+      if error_on_missing
+        raise KeyNotFoundError,
+              "Key: '#{key}' not found in hash | Pass 'error_on_missing: false' if you do not care"
+      end
+
+      LOG.warn('Key not found in hash, adding to the top level')
+
+      hash = dup
+      hash[key] = value
+      return hash
+    end
+
+    to_h do |k, v|
+      if k.eql?(key)
+        [k, value]
+      elsif v.is_a?(Hash) && v.deep_contains?(key: key)
+        [k, v.deep_update(key: key, value: value, error_on_missing: error_on_missing, error_on_uniqueness: error_on_uniqueness)]
+      elsif v.is_a?(Array)
+        [k, v.map do |item|
+          if item.is_a?(Hash) && item.deep_contains?(key: key)
+            item.deep_update(key: key, value: value, error_on_missing: error_on_missing, error_on_uniqueness: error_on_uniqueness)
+          else
+            item
+          end
+        end]
+      else
+        [k, v]
+      end
+    end
+  end
+
+  # Removes specified key from nested hash.
+  #
+  # @param key [String] the key to remove.
+  #
+  # @return [Hash] the object with specified key removed.
+  def deep_remove(key:, error_on_uniqueness: true)
+    return self unless is_a? Hash
+
+    if error_on_uniqueness && (deep_count(key: key) > 1)
+      raise KeyNotUniqueError, "Key: '#{key}' not unique | Pass 'error_on_uniqueness: false' if you do not care"
+    end
+
+    # filter_map removes nil from Array
+    filter_map do |k, v|
+      if k.eql? key
+        nil
+      elsif v.is_a?(Hash)
+        [k, v.deep_remove(key: key, error_on_uniqueness: error_on_uniqueness)]
+      elsif v.is_a?(Array)
+        [k, v.map do |item|
+          if item.is_a?(Hash) && item.deep_contains?(key: key)
+            item.deep_remove(key: key, error_on_uniqueness: error_on_uniqueness)
+          else
+            item
+          end
+        end]
+      else
+        [k, v]
+      end
+    end.to_h
+  end
+end

data/lib/hash_miner/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HashMiner
+  VERSION = '1.0.0'
+end

data/lib/hash_miner.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'hash_miner/version'
+require_relative 'hash_miner/hash'
+require_relative 'hash_miner/errors'
+
+require 'pry'
+require 'logger'
+
+module HashMiner
+  class Error < StandardError; end
+
+  LOG = Logger.new($stdout)
+end

data/sig/hash_miner.rbs

@@ -0,0 +1,4 @@
+module HashMiner
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: hash_miner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- alexo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-05 00:00:00.000000000 Z
+dependencies: []
+description: Additional Hash methods to help navigate the tricky world of nested Hashes.
+email:
+- alexander.omahoney@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hash_miner.rb
+- lib/hash_miner/errors.rb
+- lib/hash_miner/hash.rb
+- lib/hash_miner/version.rb
+- sig/hash_miner.rbs
+homepage: https://github.com/dvla/hash_miner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvla/hash_miner
+  source_code_uri: https://github.com/dvla/hash_miner
+  changelog_uri: https://github.com/dvla/hash_miner
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Additional Hash methods to help navigate the tricky world of nested Hashes.
+test_files: []