nested_objects 0.1.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e46cbbe94fd34a0e69804d0ce6e1a6d3228fa5ff656db4e050c9d29c0e592fc
+  data.tar.gz: 0adb30d3a7ead3749df4f863efaabd2dbc8bb20332ff5e7b1d131bc86dbeb267
+SHA512:
+  metadata.gz: 69ce1523d3959da5f968dc197d1d2375afbdf25be62c5faea10c9cb911edc637733f9172e326e0b0be8b77e24b2880625ee3f8cc659dcc15098417e366ec22e2
+  data.tar.gz: af925766a658fdef76b2ca260e9bdf6322afd737a35e16e56974e2ab7a1769d868fc7b0ec6c0b42d6358bd32c82e86774ecf3f16288da484dab16a8789182411

data/.commitlintrc.yml

@@ -0,0 +1,37 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration
+  # array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if
+  #   violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule (if applicable)
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all
+  # rules.
+  #
+  header-max-length:      [2, always, 100]        # Header can not exceed 100 chars
+
+  type-case:              [2, always, lower-case] # Type must be lower case
+  type-empty:             [2, never]              # Type must not be empty
+
+  # Supported conventional commit types
+  type-enum:              [2, always, [build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test]]
+
+  scope-case:             [2, always, lower-case] # Scope must be lower case
+
+  # Error if subject is one of these cases (encourages lower-case)
+  subject-case:           [2, never, [sentence-case, start-case, pascal-case, upper-case]]
+  subject-empty:          [2, never]              # Subject must not be empty
+  subject-full-stop:      [2, never, "."]         # Subject must not end with a period
+
+  body-leading-blank:     [2, always]             # Body must have a blank line before it
+  body-max-line-length:   [2, always, 100]        # Body lines can not exceed 100 chars
+
+  footer-leading-blank:   [2, always]             # Footer must have a blank line before it
+  footer-max-line-length: [2, always, 100]        # Footer lines can not exceed 100 chars

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.markdownlint.yml

@@ -0,0 +1,26 @@
+---
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: ".,;:" }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: "ordered" }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.16"
+}

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+---
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+
+Metrics/MethodLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+
+Metrics/AbcSize:
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "spec/**/*_spec.rb"
+
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is
+  # upgraded to 3.2 or later.
+  TargetRubyVersion: 3.1

data/.yamllint.yml

@@ -0,0 +1,12 @@
+---
+extends: default
+
+ignore: |
+  node_modules
+
+rules:
+  braces:
+    min-spaces-inside: 1
+    max-spaces-inside: 1
+  truthy:
+    check-keys: false

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+--readme README.md
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [0.1.16](https://github.com/main-branch/nested_objects/compare/v0.1.15...v0.1.16) (2025-04-27)
+
+
+### Features
+
+* Initial version of NestedObjects ([515fc47](https://github.com/main-branch/nested_objects/commit/515fc4793ab7ad66dcf3beeff94a011978bff57f))
+
+## Change Log

data/CONTRIBUTING.md

@@ -0,0 +1,191 @@
+# Contributing to nested_objects
+
+Thank you for your interest in contributing to the nested_objects project!
+
+This document gives the guidelines for contributing to this project.
+These guidelines may not fit every situation. When contributing use your best
+judgement.
+
+Propose changes to these guidelines with a pull request.
+
+## How to contribute to nested_objects
+
+You can contribute in two ways:
+
+1. [Report an issue or make a feature request](#how-to-report-an-issue-or-make-a-feature-request)
+2. [Submit a code or documentation change](#how-to-submit-a-code-or-documentation-change)
+
+## How to report an issue or make a feature request
+
+nested_objects utilizes [GitHub Issues](https://help.github.com/en/github/managing-your-work-on-github/about-issues)
+for issue tracking and feature requests.
+
+Report an issue or feature request by [creating a nested_objects Github issue](https://github.com/main-branch/nested_objects/issues/new).
+Fill in the template to describe the issue or feature request the best you can.
+
+## How to submit a code or documentation change
+
+There is three step process for code or documentation changes:
+
+1. [Commit your changes to a fork of nested_objects](#commit-changes-to-a-fork-of-nested_objects)
+2. [Create a pull request](#create-a-pull-request)
+3. [Get your pull request reviewed](#get-your-pull-request-reviewed)
+
+### Commit changes to a fork of nested_objects
+
+Make your changes in a fork of the nested_objects repository.
+
+#### Conventional commits
+
+All commits to this repository MUST follow [the conventional commits
+specification](https://www.conventionalcommits.org/en/v1.0.0/#specification). This is
+so that release versions can automatically be generated based on the commit messages.
+The Continuous Integration workflow will fail if a commit message is not in this
+format.
+
+The format for a conventional commit message is:
+
+```Text
+<commit-type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Where commit type is one of:
+
+* `feat:` A new feature for the end-user.
+* `fix:` A bug fix for the end-user.
+* `build:` Changes that affect the build system or external dependencies (e.g.,
+  changes to npm, webpack, Docker configurations).
+* `chore:` Routine tasks, maintenance, or changes that don't modify source code or
+  test files (e.g., updating dependencies, configuring linters).
+* `docs:` Changes to documentation only (e.g., updating README, guides, or extensive
+  code comments).
+* `style:` Changes that do not affect the meaning or logic of the code (e.g.,
+  white-space, formatting, fixing linter warnings, missing semi-colons).
+* `refactor:` A code change that neither fixes a bug nor adds a feature, but improves
+  the code structure, readability, or organization without changing its external
+  behavior.
+* `perf:` A code change that improves performance.
+* `test:` Adding missing tests or correcting existing tests; changes to the test
+  environment or configuration.
+
+Backward incompatible changes (aka breaking changes) should append a `!` after the
+commit type or add the footer `BREAKING CHANGE:` as shown in the following examples:
+
+```Text
+fix!: change the interface to match the requirements
+```
+
+```Text
+fix: change the interface to match the requirements
+
+BREAKING CHANGE: users will need to add additional, non-default option
+```
+
+These commit messages will have the following impact on the release version number:
+
+* Breaking changes (of any commit type) will bump the major version component
+* `feat:` commits will bump the minor version component
+* `fix:` commits will bump the patch version component
+
+Any other commit types (that are not breaking changes) will not trigger a release.
+
+### Create a pull request
+
+See [this article](https://help.github.com/articles/about-pull-requests/) if you
+are not familiar with GitHub Pull Requests.
+
+Follow the instructions in the pull request template.
+
+### Get your pull request reviewed
+
+Code review takes place in a GitHub pull request using the
+[the Github pull request review feature](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews).
+
+Once your pull request is ready for review, request a review from at least one of the
+[code owners](https://github.com/orgs/main-branch/teams/nested_objects-codeowners/members).
+
+During the review process, you may need to make additional commits which would
+need to be squashed. It may also be necessary to rebase to main again if other
+changes are merged before your PR.
+
+At least one approval is required from a project maintainer before your pull
+request can be merged. The maintainer is responsible for ensuring that the pull
+request meets [the project's coding standards](#coding-standards).
+
+## Coding standards
+
+All pull requests must meet these requirements:
+
+### Rebase Merge Strategy
+
+Our project requires a linear commit history, which is achieved by using a
+rebase strategy to enable fast-forward merges for all Pull Requests (PRs).
+
+* **Goal:** To integrate PRs without creating extra merge commits, ensuring a clean
+  and linear project history. This requires the PR branch to be eligible for a
+  [fast-forward
+  merge](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging).
+* **Commit History:** Before merging, clean up your PR's commit history. Squash
+  related changes into logical commits using interactive rebase (`git rebase -i`).
+  Aim for a minimal number of meaningful commits that represent distinct steps or
+  features.
+* **Enable Fast-Forward:** To ensure a fast-forward merge is possible, you must
+  rebase your feature branch onto the latest version of the target branch (e.g.,
+  `main`) *before* the PR is merged.
+  * Example commands (assuming your remote is `origin` and the target branch is
+    `main`):
+
+    ```bash
+    # Fetch the latest changes from the remote
+    git fetch origin
+
+    # Rebase your current branch onto the latest main branch
+    git rebase origin/main
+    ```
+
+  * You may need to resolve conflicts during the rebase process. After successfully
+    rebasing, you'll likely need to force-push your branch (`git push
+    --force-with-lease`).
+
+  * You may need to rebase again if other PRs are merged to main.
+
+### Unit tests
+
+- All changes must be accompanied by new or modified RSpec unit tests
+- The entire test suite must pass when `bundle exec rake spec` is run from the
+  project's local working tree
+- The unit test suite must maintain 100% code coverage to pass
+
+### Documentation
+
+- New and updated public methods must have [YARD](https://yardoc.org/)
+  documentation added to them
+  - [The YARD Cheatsheet](https://gist.github.com/thelastinuit/5984665e6ab69d3c0a413a03602c45be)
+    is a good reference
+- New and updated public facing features should be documented in the project's
+  [README.md](README.md)
+- All documentation must pass `yardstick` documentation analysis
+- The documentation suite must maintain 100% documentation to pass
+
+### Continuous Integration
+
+- All tests must pass in the project's [Travis CI](https://travis-ci.org/main-branch/nested_objects)
+  build before the pull request will be merged.
+- You can simulate what happens in the Travis CI build by running `bundle exec rake` in
+  the projects root directory.
+
+### Other Design Guidelines
+
+- Use keyword args with defaults instead of an opts hash
+
+## Licensing
+
+nested_objects uses [the MIT license](https://choosealicense.com/licenses/mit/) as
+declared in the [LICENSE](LICENSE) file.
+
+Licensing is very important to open source projects. It helps ensure the
+software continues to be available under the terms that the author desired.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 James Couball
+
+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,73 @@
+# nested_objects gem
+
+[![Gem Version](https://badge.fury.io/rb/nested_objects.svg)](https://badge.fury.io/rb/nested_objects)
+[![Build Status](https://github.com/main-branch/nested_objects/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/nested_objects/actions/workflows/continuous_integration.yml)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/nested_objects/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/nested_objects/file/CHANGELOG.md)
+[![Slack](https://img.shields.io/badge/slack-main--branch/track__open__instances-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C01CHR7TMM2)
+
+The `NestedObjects` module provides module level methods to safely navigate and
+manage a heirarchy of Ruby POROs nested using Hashes or Arrays. Think of these
+nested data objects like what you would get after reading in a JSON file.
+
+The key methods are:
+
+* `NestedObjects.deep_copy(data)` - returns a deep copy of data including nested hash
+  values and array elements
+* `NestedObjects.dig(data, path)` - returns the value at the given path
+* `NestedObjects.bury(data, path, value)` - sets a value within the data structure at
+  the given path
+* `NestedObjects.delete(data, path)` - deletes the Hash key or Array index at the
+  given path
+* `NestedObjects.path?(data, path)` - returns true if the path exists in the given
+  data structure
+
+These methods (prefixed with `nested_` to avoid method conflicts) can be mixed into
+`Object` for ease of use:
+
+```Ruby
+Object.include NestedObjects::Mixin
+
+data = { 'users' => [{ 'name' => 'John Smith'}, { 'name' => 'Jane Doe' }] }
+
+data.nested_dig(%w[users 1 name]) #=> 'Jane Doe'
+```
+
+If the path is malformed or does not exist, a `BadPathError` will be raised.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rake` to run tests, static analysis, and build the gem.
+
+For experimentation, you can also run `bin/console` for an interactive (IRB) prompt that
+automatically requires nested_objects.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/main-branch/nested_objects>.
+
+### Commit message guidelines
+
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
+
+To ensure compliance, this project includes:
+
+- A git commit-msg hook that validates your commit messages before they are accepted.
+
+  To activate the hook, you must have node installed and run `npm install`.
+
+- A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
+
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
+
+### Pull request guidelines
+
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.

data/Rakefile

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+# Make it so that calling `rake release` just calls `rake release:rubygems_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+# YARD
+
+unless RUBY_PLATFORM == 'java'
+  # yard:build
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.options = %w[--no-private]
+    t.stats_options = %w[--list-undoc]
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # yard:audit
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # yard:coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
+
+  # yard
+
+  desc 'Run all YARD tasks'
+  task yard: %i[yard:build yard:audit yard:coverage]
+end

data/lib/nested_objects/mixin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NestedObjects
+  # Include this module to add methods for working with nested data structures
+  #
+  # Usually included into the Object class.
+  #
+  # @example
+  #   require 'nested_objects/mixin'
+  #   Object.include(NestedObjects::Mixin)
+  #   data = { 'a' => { 'b' => [1, 2, 3] } }
+  #   data.nested_dig(['a', 'b', '0']) #=> 1
+  #
+  # @api public
+  module Mixin
+    # (see NestedObjects.path?)
+    def nested_path?(path) = NestedObjects.path?(self, path)
+
+    # (see NestedObjects.dig)
+    def nested_dig(path) = NestedObjects.dig(self, path)
+
+    # (see NestedObjects.bury)
+    def nested_bury(path, value) = NestedObjects.bury(self, path, value)
+
+    # (see NestedObjects.delete)
+    def nested_delete(path) = NestedObjects.delete(self, path)
+
+    # (see NestedObjects.deep_copy)
+    def nested_deep_copy = NestedObjects.deep_copy(self)
+  end
+end

data/lib/nested_objects/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NestedObjects
+  # The last released gem version
+  VERSION = '0.1.16'
+end

data/lib/nested_objects.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require_relative 'nested_objects/mixin'
+require_relative 'nested_objects/version'
+
+# Utilities for working with POROs arbitrarily nested with Hashes and Arrays
+# @api public
+module NestedObjects
+  # Error raised when a path is invalid or does not exist in the data
+  class BadPathError < StandardError; end
+
+  class << self
+    # Creates a deep copy of data using Marshal
+    #
+    # @example
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.deep_copy(data) #=> { 'a' => { 'b' => [1, 2, 3] } }
+    #
+    # @param data [Object] The object to be deeply copied
+    # @return [Object] A new object that is a deep copy of the input `obj`
+    # @raise [TypeError] if the object cannot be marshaled (see Marshal documentation)
+    def deep_copy(data)
+      Marshal.load(Marshal.dump(data))
+    end
+
+    # Retrieves the value at the specified path in the given data
+    #
+    # @example
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.dig(data, ['a', 'b', '0']) #=> 1
+    #
+    # @param data [Hash, Array, Object] The data containing the value to retrieve
+    # @param path [Array<String>] An array of keys/indices representing the path to the desired value
+    # @return [Object] the value at the specified path
+    # @raise [BadPathError] if the path is invalid or does not exist
+    def dig(data, path)
+      return data if path.empty?
+
+      raise BadPathError unless data.is_a?(Hash) || data.is_a?(Array)
+
+      if data.is_a?(Hash)
+        dig_into_hash(data, path)
+      else
+        dig_into_array(data, path)
+      end
+    end
+
+    # Sets a value within a nested data structure
+    #
+    # Creates intermediate Hashes along the path if they do not exist.
+    # Does NOT create intermediate Arrays (creates a Hash instead).
+    #
+    # @example
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.bury(data, ['a', 'b', '0'], 42) #=> { 'a' => { 'b' => [42, 2, 3] } }
+    #
+    # @example will overwrite existing values
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.bury(data, ['a'], 42) #=> { 'a' => 42 }
+    #
+    # @example will create intermediate Hashes
+    #   data = {}
+    #   NestedObjects.bury(data, ['a', 'b'], 42) #=> { 'a' => { 'b' => 42 } })
+    #
+    # @example will NOT create intermediate Arrays (creates a Hash instead)
+    #   data = {}
+    #   NestedObjects.bury(data, ['a', '0'], 42) #=> { 'a' => { '0' => [42, 2, 3] } }
+    #
+    # @param data [Hash, Array, Object] The structure to modify
+    # @param path [Array<String>] An array of keys/indices representing the path to the item to set
+    # @param value [Object] The value to set at the specified path
+    # @return [Object] The modified data structure
+    # @raise [BadPathError] if the path is invalid or the item does not exist
+    #
+    def bury(data, path, value)
+      raise BadPathError if path.empty? || !(data.is_a?(Hash) || data.is_a?(Array))
+
+      key, found = next_key(data, path)
+
+      if path.length == 1
+        data[key] = value
+      else
+        data[key] = {} unless found
+        bury(data[key], path[1..], value)
+      end
+
+      data
+    end
+
+    # Delete a key or element from nested data identified by path
+    #
+    # @example
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.delete(data, ['a', 'b', '0']) #=> 1
+    #   data #=> { 'a' => { 'b' => [2, 3] } }
+    #
+    # @param data [Hash, Array, Object] The structure to modify
+    # @param path [Array<String>] An array of keys/indices representing the path to the item to delete
+    # @return [Object] The value of the element that was deleted
+    # @raise [BadPathError] if the path is invalid or the item does not exist
+    #
+    def delete(data, path)
+      raise BadPathError if path.empty? || !(data.is_a?(Hash) || data.is_a?(Array))
+
+      key, found = next_key(data, path)
+
+      raise BadPathError unless found
+
+      if path.length == 1
+        delete_key(data, key)
+      else
+        delete(data[key], path[1..])
+      end
+    end
+
+    # Check if the path is valid for the given data structure
+    #
+    # @example
+    #   data = { 'a' => { 'b' => [1, 2, 3] } }
+    #   NestedObjects.path?(data, ['a', 'b', '0']) #=> true
+    #   NestedObjects.path?(data, ['d']) #=> false
+    #
+    # @param data [Hash, Array, Object] The structure to check
+    # @param path [Array<String>] An array of keys/indices representing the path to check
+    # @return [Boolean] `true` if the path is valid, `false` otherwise
+    # @raise [BadPathError] if path tries to traverse an Array with a non-integer key
+    #
+    def path?(data, path)
+      return true if path.empty?
+
+      return false unless data.is_a?(Hash) || data.is_a?(Array)
+
+      key, found = next_key(data, path)
+
+      return false unless found
+
+      path?(data[key], path[1..])
+    end
+
+    private
+
+    # Traverse through a Hash via the nest path component
+    # @return the value at the end of the path
+    # @raise [BadPathError] if the path is invalid or does not exist
+    # @api private
+    def dig_into_hash(data, path)
+      key = path.first
+      raise BadPathError unless data.key?(key)
+
+      dig(data[key], path[1..])
+    end
+
+    # Traverse through an Array via the nest path component
+    # @return the value at the end of the path
+    # @raise [BadPathError] if the path is invalid or does not exist
+    # @api private
+    def dig_into_array(data, path)
+      index = key_to_index(path.first)
+      raise BadPathError unless !index.nil? && index >= 0 && index < data.length
+
+      dig(data[index], path[1..])
+    end
+
+    # Delete a Hash key or an Array element from data
+    # @return the value of the element that was deleted
+    # @api private
+    def delete_key(data, key)
+      if data.is_a?(Hash)
+        data.delete(key)
+      else
+        data.delete_at(key)
+      end
+    end
+
+    # The next key in the path and whether it exists in the root of the data structure
+    #
+    # The next key is a string for Hashes and an integer for Arrays
+    #
+    # @example
+    #   next_key({ 'a' => 1 }, ['a']) #=> ['a', true]
+    #   next_key({ 'a' => 1 }, ['b']) #=> ['b', false]
+    # @param data [Hash, Array, Object] The data structure to check
+    # @param path [Array<String>] An array of keys/indices representing the path being traversed
+    # @return [Array<[String, Integer], Boolean>] The next key and whether it exists
+    # @api private
+    def next_key(data, path)
+      if data.is_a?(Hash)
+        key = path.first
+        [key, data.key?(key)]
+      else
+        index = key_to_index(path.first)
+        [index, index >= 0 && index < data.length]
+      end
+    end
+
+    # Convert a String key to an Integer array index
+    # @param key [String] The key to convert to an index
+    # @return [Integer] the index of the key in the array
+    # @raise [BadPathError] if the key is not a String representation of an Integer
+    # @api private
+    def key_to_index(key)
+      Integer(key)
+    rescue ArgumentError
+      raise BadPathError
+    end
+  end
+end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

data/pre-commit

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+##
+# Run this before doing a commit.  To ensure this happens, after cloning this
+# repository, run bin/setup from the projects root directory
+
+echo 'Performing pre-commit checks'
+
+# Make sure we are testing with the latest version of gems
+# since this is what will get installed in the CI build
+#
+echo "Running 'bundle update'..."
+if ! bundle update > /dev/null; then
+    echo 'FAIL: bundle update failed'
+    exit 1
+fi
+
+# Run all the tests, code/doc analysis, gem build, etc.
+#
+echo "Running 'bundle exec rake default'..."
+if ! bundle exec rake default > /dev/null 2>&1; then
+    echo 'FAIL: Rake default task failed'
+    exit 1
+fi
+
+echo 'SUCCESS'

data/release-please-config.json

@@ -0,0 +1,36 @@
+{
+  "bootstrap-sha": "c0076bab53d3eae31f3798217e281e3d51a292a3",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "nested_objects",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/nested_objects/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false,
+      "pull-request-title-pattern": "chore: release v${version}",
+      "changelog-sections": [
+        { "type": "feat",     "section": "Features",      "hidden": false },
+        { "type": "fix",      "section": "Bug Fixes",     "hidden": false },
+        { "type": "build",    "section": "Other Changes", "hidden": false },
+        { "type": "chore",    "section": "Other Changes", "hidden": false },
+        { "type": "ci",       "section": "Other Changes", "hidden": false },
+        { "type": "docs",     "section": "Other Changes", "hidden": false },
+        { "type": "perf",     "section": "Other Changes", "hidden": false },
+        { "type": "refactor", "section": "Other Changes", "hidden": false },
+        { "type": "revert",   "section": "Other Changes", "hidden": false },
+        { "type": "style",    "section": "Other Changes", "hidden": false },
+        { "type": "test",     "section": "Other Changes", "hidden": false }
+      ]
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: nested_objects
+version: !ruby/object:Gem::Version
+  version: 0.1.16
+platform: ruby
+authors:
+- James Couball
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: create_github_release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: main_branch_shared_rubocop_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |
+  Utility methods such as deep_copy, dig, bury, delete, and path? for working with
+  PORO structures arbitrarily nested with Hashes and Arrays.
+email:
+- jcouball@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
+- ".markdownlint.yml"
+- ".release-please-manifest.json"
+- ".rspec"
+- ".rubocop.yml"
+- ".yamllint.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nested_objects.rb
+- lib/nested_objects/mixin.rb
+- lib/nested_objects/version.rb
+- package.json
+- pre-commit
+- release-please-config.json
+homepage: https://github.com/main-branch/nested_objects
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/main-branch/nested_objects
+  source_code_uri: https://github.com/main-branch/nested_objects
+  documentation_uri: https://rubydoc.info/gems/nested_objects/0.1.16
+  changelog_uri: https://rubydoc.info/gems/nested_objects/0.1.16/file/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'Platform: Mac, Linux, or Windows'
+- 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Utilities for working with PORO structures arbitrarily nested with Hashes
+  and Arrays
+test_files: []