deep_nest 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 588a15e28dc8a68fb2b1a1510bc2a70f74974d193dcc62958dda711b60adffbd
+  data.tar.gz: ca41c512276eac8a9febb577c90800baa52d728b76848647422ce62c45c3ccc4
+SHA512:
+  metadata.gz: 79dc95591b1d300ce02bee14bb391c6f6a7f59bf8afdeda256644933a6f3324d3736ecf9e0bc9771419379aaf85aa07d089dddf31439a1c6b49b556ac58babdd
+  data.tar.gz: 1db08aeba7fbcfd89c98ae28b280ec5a68f59d2cf81f585e859cef0e424505757b3e3324adfdd23f56a54c2f2b0ec4116c8b72855c51857e337cef324e122965

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/doc/
+/docs/
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--output-dir docs/

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# DeepNest
+
+## 0.1.1
+
+### Include DeepNest in native Ruby classes
+
+  - Add helper namespace to use self in recursive methods (i.e. can use `structure.deep_dup` instead of `DeepNest.deep_dup(structure)`).
+  - Add patch file to allow users to monkey patch recursive methods in native Hash and Array Ruby classes.
+  - Add patch spec.
+
+## 0.1.0
+
+### Initial Release
+
+  - Add recursive methods
+    - deep_dup(structure) that returns a deep copy of the passed hash or array.
+    - deep_merge(hash1, hash2, &block) that returns a hash with the passed hashes recursively merged. An optional block can be passed to merge values.
+    - deep_equal?(struct1, struct2) that returns true if the passed objects are same in structure and values, false otherwise.
+    - deep_transform_keys(structure, &block) that returns a hash or array with all hash keys modified by the passed block.
+    - deep_transform_values(structure, &block) that returns a hash or array with all hash values modified by the passed block.
+    - deep_stringify_keys(structure) that returns hash or array with all hash keys converted to strings.
+    - deep_stringify_values(structure) that returns a hash or array with all hash keys converted to symbols.
+  

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deep_nest.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    deep_nest (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    fabrication (2.30.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  deep_nest!
+  fabrication (~> 2.30.0)
+  guard (~> 2.18.0)
+  guard-rspec (~> 4.7.3)
+  rake (~> 13.0)
+  rspec (~> 3.12.0)
+  yard (~> 0.9.28)
+
+BUNDLED WITH
+   2.3.26

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.(rb|thor)$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+  watch(%r{spec/support/shared_examples/(.+).rb$}) { "spec" }
+end

data/README.md

@@ -0,0 +1,29 @@
+# DeepNest
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/deep_nest`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add deep_nest
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install deep_nest
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/deep_nest.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "deep_nest"
+
+# 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/deep_nest.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/deep_nest/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "deep_nest"
+  spec.version = DeepNest::VERSION
+  spec.authors = ["Mattie Hansen"]
+  spec.email = ["mattie.hansen@realmfive.com"]
+
+  spec.summary = "Recursive methods for Ruby structures."
+  spec.homepage = "https://github.com/RealmFive/deep_nest"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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|Guardfile|doc|tmp)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'fabrication', '~> 2.30.0'
+  spec.add_development_dependency 'guard', '~> 2.18.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'yard', '~> 0.9.28'
+end

data/lib/deep_nest/helpers.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../deep_nest'
+
+##
+# Namespace for helper methods to use self in recursive methods
+module DeepNest
+  ##
+  # Default error class for Methods module.
+  class Error < StandardError; end
+
+  module Helpers
+    ##
+    # Returns a deep copy of the passed hash or array.
+    #
+    # @param self [Hash, Array] The hash or array to be deep copied.
+    #
+    # @return [Hash, Array] The deep copy of the passed hash or array.
+    def deep_dup
+      DeepNest.deep_dup(self)
+    end
+
+    ##
+    # Returns a hash with the passed hashes recursively merged. An optional block can be passed to merge values.
+    #
+    # @param self [Hash] The first hash to be merged.
+    #
+    # @param other_hash [Hash] The second hash to be merged.
+    #
+    # @yield [&block] Operation to merge values of the hashes.
+    #
+    # @return [Hash] The hash with recursively merged hashes.
+    def deep_merge(other_hash, &block)
+      DeepNest.deep_merge(self, other_hash, &block)
+    end
+
+    ##
+    # Returns true if the passed parameters are same in structure and values, false otherwise.
+    #
+    # @param self [Hash, Array] First structure to be compared.
+    #
+    # @param other_structure [Hash, Array] Second structure to be compared.
+    #
+    # @return [true] If parameters are equal in structure and values.
+    #
+    # @return [false] If parameters are not equal in structure and values.
+    def deep_equal?(other_structure)
+      DeepNest.deep_equal?(self, other_structure)
+    end
+
+    ##
+    # Returns a hash or array with all hash keys modified by the passed block.
+    #
+    # @param self [Hash, Array] The hash or array to transform the keys.
+    #
+    # @yield [&block] Operation to modify the keys.
+    #
+    # @return [Hash, Array] The hash or array with transformed keys.
+    def deep_transform_keys(&block)
+      DeepNest.deep_transform_keys(self, &block)
+    end
+
+    ##
+    # Returns a hash or array with all hash values modified by the passed block.
+    #
+    # @param self [Hash, Array] The hash or array to transform the values.
+    #
+    # @yield [&block] Operation to modify the values.
+    #
+    # @return [Hash, Array] The hash or array with transformed values.
+    def deep_transform_values(&block)
+      DeepNest.deep_transform_values(self, &block)
+    end
+
+    ##
+    # Returns a hash or array with all hash keys converted to strings.
+    #
+    # @param self [Hash, Array] The hash or array to stringify the keys
+    #
+    # @return [Hash, Array] The hash or array with stringified keys.
+    def deep_stringify_keys
+      DeepNest.deep_stringify_keys(self)
+    end
+
+    ##
+    # Returns a hash or array with all hash keys converted to symbols.
+    #
+    # @param self [Hash, Array] The hash or array to symbolize the keys
+    #
+    # @return [Hash, Array] The hash or array with symbolized keys.
+    def deep_symbolize_keys
+      DeepNest.deep_symbolize_keys(self)
+    end
+  end
+end

data/lib/deep_nest/patch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+##
+# The native Hash Ruby class with monkey patched helper methods.
+class Hash
+  include DeepNest::Helpers
+end
+
+##
+# The native Array Ruby class with monkey patched helper methods.
+class Array
+  include DeepNest::Helpers
+end

data/lib/deep_nest/version.rb

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

data/lib/deep_nest.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative 'deep_nest/version'
+require_relative 'deep_nest/helpers'
+
+##
+# Primary namespace for the deep_nest gem.
+module DeepNest
+  ##
+  # Default error class for DeepNest module.
+  class Error < StandardError; end
+  class << self
+    ##
+    # Returns a deep copy of the passed hash or array.
+    #
+    # @param structure [Hash, Array] The hash or array to be deep copied.
+    #
+    # @return [Hash, Array] The deep copy of the passed hash or array.
+    def deep_dup(structure)
+      case structure
+      when Array
+        structure.map { |x| deep_dup(x) }
+      when Hash
+        structure.transform_values { |v| deep_dup(v) }
+      else
+        structure.dup
+      end
+    end
+
+    ##
+    # Returns a hash with the passed hashes recursively merged. An optional block can be passed to merge values.
+    #
+    # @param hash1 [Hash] The first hash to be merged.
+    #
+    # @param hash2 [Hash] The second hash to be merged.
+    #
+    # @yield [&block] Operation to merge values of the hashes.
+    #
+    # @return [Hash] The hash with recursively merged hashes.
+    def deep_merge(hash1, hash2, &block)
+      raise Error, 'Parameters must be hashes' unless hash1.is_a?(Hash) && hash2.is_a?(Hash)
+
+      hash1.merge(hash2) do |k, v1, v2|
+        if v1.is_a?(Hash) && v2.is_a?(Hash)
+          deep_merge(v1, v2, &block)
+        elsif block_given?
+          block.call(k, v1, v2)
+        else
+          v2
+        end
+      end
+    end
+
+    ##
+    # Returns true if the passed parameters are same in structure and values, false otherwise.
+    #
+    # @param struct1 [Hash, Array] First structure to be compared.
+    #
+    # @param struct2 [Hash, Array] Second structure to be compared.
+    #
+    # @return [true] If parameters are equal in structure and values.
+    #
+    # @return [false] If parameters are not equal in structure and values.
+    def deep_equal?(struct1, struct2)
+      if struct1.eql?(struct2)
+        case struct1
+        when Array
+          struct1.zip(struct2).each { |e1, e2| deep_equal?(e1, e2) }
+        when Hash
+          struct1.merge(struct2).each { |v1, v2| deep_equal?(v1, v2) }
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    ##
+    # Returns a hash or array with all hash keys modified by the passed block.
+    #
+    # @param structure [Hash, Array] The hash or array to transform the keys.
+    #
+    # @yield [&block] Operation to modify the keys.
+    #
+    # @return [Hash, Array] The hash or array with transformed keys.
+    def deep_transform_keys(structure, &block)
+      case structure
+      when Hash
+        structure.each_with_object({}) do |(k, v), result|
+          result[yield(k)] = deep_transform_keys(v, &block)
+        end
+      when Array
+        structure.map { |e| deep_transform_keys(e, &block) }
+      else
+        structure
+      end
+    end
+
+    ##
+    # Returns a hash or array with all hash values modified by the passed block.
+    #
+    # @param structure [Hash, Array] The hash or array to transform the values.
+    #
+    # @yield [&block] Operation to modify the values.
+    #
+    # @return [Hash, Array] The hash or array with transformed values.
+    def deep_transform_values(structure, &block)
+      case structure
+      when Hash
+        structure.transform_values { |v| deep_transform_values(v, &block) }
+      when Array
+        structure.map { |e| deep_transform_values(e, &block) }
+      else
+        yield(structure)
+      end
+    end
+
+    ##
+    # Returns a hash or array with all hash keys converted to strings.
+    #
+    # @param structure [Hash, Array] The hash or array to stringify the keys
+    #
+    # @return [Hash, Array] The hash or array with stringified keys.
+    def deep_stringify_keys(structure)
+      deep_transform_keys(structure, &:to_s)
+    end
+
+    ##
+    # Returns a hash or array with all hash keys converted to symbols.
+    #
+    # @param structure [Hash, Array] The hash or array to symbolize the keys
+    #
+    # @return [Hash, Array] The hash or array with symbolized keys.
+    def deep_symbolize_keys(structure)
+      deep_transform_keys(structure, &:to_sym)
+    end
+  end
+end

data/sig/deep_nest.rbs

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: deep_nest
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mattie Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+description:
+email:
+- mattie.hansen@realmfive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deep_nest.gemspec
+- lib/deep_nest.rb
+- lib/deep_nest/helpers.rb
+- lib/deep_nest/patch.rb
+- lib/deep_nest/version.rb
+- sig/deep_nest.rbs
+homepage: https://github.com/RealmFive/deep_nest
+licenses: []
+metadata:
+  homepage_uri: https://github.com/RealmFive/deep_nest
+  source_code_uri: https://github.com/RealmFive/deep_nest
+  changelog_uri: https://github.com/RealmFive/deep_nest/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Recursive methods for Ruby structures.
+test_files: []