nested_objects 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e46cbbe94fd34a0e69804d0ce6e1a6d3228fa5ff656db4e050c9d29c0e592fc
-  data.tar.gz: 0adb30d3a7ead3749df4f863efaabd2dbc8bb20332ff5e7b1d131bc86dbeb267
+  metadata.gz: 83ade50105b58330d52486368bf31c36396ad6f12e135418bfb04be50b863764
+  data.tar.gz: e0fbfb421c4a4370cca8ff5660913baec9e8338b0a2a74d9a52b9c19003fa77e
 SHA512:
-  metadata.gz: 69ce1523d3959da5f968dc197d1d2375afbdf25be62c5faea10c9cb911edc637733f9172e326e0b0be8b77e24b2880625ee3f8cc659dcc15098417e366ec22e2
-  data.tar.gz: af925766a658fdef76b2ca260e9bdf6322afd737a35e16e56974e2ab7a1769d868fc7b0ec6c0b42d6358bd32c82e86774ecf3f16288da484dab16a8789182411
+  metadata.gz: 620c0900e01d2244c73159559e769a9f133dfba49b9caadb7bb306d7b18a13275ff150bdf28551592e62fb517796ec1c5f71907f6a5edb7e32a06779d6cc82e7
+  data.tar.gz: 8c0d7bc25ddf9fdef17def566c8fa850a7842ee7505590a3372525fc73ab9b901886d66d52338f4f4c53221cb6e6df06a2d76bc027f799e735ccf193a35dae78

data/.release-please-manifest.json

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

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.1.17](https://github.com/main-branch/nested_objects/compare/v0.1.16...v0.1.17) (2025-04-27)
+
+
+### Other Changes
+
+* Update online yardoc links and simplify readme ([5777d3e](https://github.com/main-branch/nested_objects/commit/5777d3e6a643d3d14c05b1b699a20b0f9fdebebd))
+
 ## [0.1.16](https://github.com/main-branch/nested_objects/compare/v0.1.15...v0.1.16) (2025-04-27)
 
 

data/README.md

@@ -2,72 +2,57 @@
 
 [![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/)
+[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://gemdocs.org/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
+The `NestedObjects` module provides module 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:
+## Usage
 
-* `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
+### Module Methods
 
-These methods (prefixed with `nested_` to avoid method conflicts) can be mixed into
-`Object` for ease of use:
+These methods are exposted on the `NestedObjects` module. The key methods are:
+`deep_copy`, `dig`, `bury`, `delete`, and `path?`.
 
-```Ruby
-Object.include NestedObjects::Mixin
+Here is an example of using the `dig` method:
 
-data = { 'users' => [{ 'name' => 'John Smith'}, { 'name' => 'Jane Doe' }] }
+```Ruby
+require 'nested_objects'
 
-data.nested_dig(%w[users 1 name]) #=> 'Jane Doe'
+data = { 'people' => [{ 'name' => 'John'}, { 'name', 'Jane' }] }
+path = 'people/0/name'.split('/')
+NestedObjects.dig(data, path) #=> 'John'
 ```
 
-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.
+See documentation and examples of the full API in
+[the gem's YARD documentation](https://gemdocs.org/gems/nested_objects/).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at <https://github.com/main-branch/nested_objects>.
+### Object Mixin
 
-### Commit message guidelines
+As a convenience, these methods can be mixed into other classes by including the `NestedObjects::Mixin` module.
 
-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.
+In order to reduce the possibility of method name conflicts, all methods are prefixed with `nested_`.
 
-To ensure compliance, this project includes:
+```Ruby
+Object.include NestedObjects::Mixin
 
-- A git commit-msg hook that validates your commit messages before they are accepted.
+data = { 'people' => [{ 'name' => 'John'}, { 'name', 'Jane' }] }
+path = 'people/0/name'.split('/')
+data.nested_dig(path) #=> 'John'
+```
 
-  To activate the hook, you must have node installed and run `npm install`.
+## Development
 
-- A GitHub Actions workflow that will enforce the Conventional Commit standard as
-  part of the continuous integration pipeline.
+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.
 
-  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.
+For experimentation, you can also run `bin/console` for an interactive (IRB) prompt
+that automatically requires nested_objects.
 
-### Pull request guidelines
+## Contributing
 
-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.
+See [the contributing guildlines](CONTRIBUTING.md) for guidance on how to contriute
+to this project.

data/lib/nested_objects/version.rb

@@ -2,5 +2,5 @@
 
 module NestedObjects
   # The last released gem version
-  VERSION = '0.1.16'
+  VERSION = '0.1.17'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nested_objects
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - James Couball
@@ -218,8 +218,8 @@ 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
+  documentation_uri: https://gemdocs.org/nested_objects/0.1.17
+  changelog_uri: https://gemdocs.org/nested_objects/0.1.17/file.CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: