dotkey 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59465e04fac7799b3ae896136cf7c2e6d756d3638ce4fd4229b1b69968e42821
-  data.tar.gz: 20ce766129ecf3dab53ada7364949f423ddd2d8f287d1812219de3db733a937e
+  metadata.gz: 6f417d3b9361adfee3ad70d0154f47d92b6293bd884dc17b3dff7f7538f8b680
+  data.tar.gz: 309553fccb7020530a737ddef1559fbd4db6080aefa0d1209463f972281bdcad
 SHA512:
-  metadata.gz: 40abb13a263c3e77daedeb909087115539a66488721272105380f3e33b5c0856c1680ba65f8befadbdeeaf04ea9fca3b73ab0734f9bddcde03e6d48a8f7e729d
-  data.tar.gz: 17129e2bc6555e2b9abd4010d07d8e299267d62b2a47e71e59f82dc97d10a55dd16480a4cd1ddbcaa068d3d829540e7929687743ba0b195ce84a32325eafa008
+  metadata.gz: 39defa17fd3a0384b0b94a33c9b438009b72fae2771ef8f5f967729806f1eb0c1262d912a603eeb340e5995df84cda765e8450f20e956fdc78261b94be8e6b1c
+  data.tar.gz: 26ac9660e15c2db59deff29e10a78f777d60ca4231a7db6fa8f5290dbac4730beaccb7fc96afd6c3d479854746c6af5a03095ee775207c38db045a336c306643

data/CHANGELOG.md

@@ -1,2 +1,6 @@
-## 1.0.0 [UNRELEASED]
+## 1.0.1 [2025-05-11]
+- Fixed errors in `get_all` errors when traversing nil values
+- Fixed documentation for `get_all` using examples for `get`
+
+## 1.0.0 [2025-05-10]
 - Initial release

data/README.md

@@ -78,23 +78,23 @@ If any values along the path are `nil`, `nil` is returned. However, trying to tr
 
 ```ruby
 # `b.c` is nil so the result is nil
-DotKey.get({b: {}}, "b.c.d")        # => nil
+DotKey.get_all({b: {}}, "b.c.d")        #=> {"b.c.d" => nil}
 
 # `c` is not a valid key for an Array, so an error is raised
-DotKey.get({b: []}, "b.c.d")        # => raises DotKey::InvalidTypeError
+DotKey.get_all({b: []}, "b.c.d")        #=> raises DotKey::InvalidTypeError
 
 # `0` is a valid key for an array, but is nil so the result is nil
-DotKey.get({b: []}, "b.0.d")        # => nil
+DotKey.get_all({b: []}, "b.0.d")        #=> {"b.0.d" => nil}
 
 # Strings cannot be traversed so an error is raised
-DotKey.get({a: "a string"}, "a.b")  # => raises DotKey::InvalidTypeError
+DotKey.get_all({a: "a string"}, "a.b")  #=> raises DotKey::InvalidTypeError
 ```
 
-This behaviour can be disabled by specifying the `raise_on_invalid` parameter:
+This behaviour can be disabled by specifying the `raise_on_invalid` parameter.
 
 ```ruby
-DotKey.get({b: []}, "b.c.d", raise_on_invalid: false)        # => nil
-DotKey.get({a: "a string"}, "a.b", raise_on_invalid: false)  # => nil
+DotKey.get_all({b: []}, "b.c.d", raise_on_invalid: false)        #=> {"b.c.d" => nil}
+DotKey.get_all({a: "a string"}, "a.b", raise_on_invalid: false)  #=> {"a.b" => nil}
 ```
 
 Missing values are included in the result as `nil` values, but these can be omitted by specifying the `include_missing` parameter:

data/lib/dotkey/dot_key.rb

@@ -96,21 +96,21 @@ class DotKey
     # an error is raised.
     #
     #   # `b.c` is nil so the result is nil
-    #   DotKey.get({b: {}}, "b.c.d")        #=> nil
+    #   DotKey.get_all({b: {}}, "b.c.d")        #=> {"b.c.d" => nil}
     #
     #   # `c` is not a valid key for an Array, so an error is raised
-    #   DotKey.get({b: []}, "b.c.d")        #=> raises DotKey::InvalidTypeError
+    #   DotKey.get_all({b: []}, "b.c.d")        #=> raises DotKey::InvalidTypeError
     #
     #   # `0` is a valid key for an array, but is nil so the result is nil
-    #   DotKey.get({b: []}, "b.0.d")        #=> nil
+    #   DotKey.get_all({b: []}, "b.0.d")        #=> {"b.0.d" => nil}
     #
     #   # Strings cannot be traversed so an error is raised
-    #   DotKey.get({a: "a string"}, "a.b")  #=> raises DotKey::InvalidTypeError
+    #   DotKey.get_all({a: "a string"}, "a.b")  #=> raises DotKey::InvalidTypeError
     #
     # This behaviour can be disabled by specifying the <tt>raise_on_invalid</tt> parameter.
     #
-    #   DotKey.get({b: []}, "b.c.d", raise_on_invalid: false)        #=> nil
-    #   DotKey.get({a: "a string"}, "a.b", raise_on_invalid: false)  #=> nil
+    #   DotKey.get_all({b: []}, "b.c.d", raise_on_invalid: false)        #=> {"b.c.d" => nil}
+    #   DotKey.get_all({a: "a string"}, "a.b", raise_on_invalid: false)  #=> {"a.b" => nil}
     #
     # Missing values are included in the result as <tt>nil</tt> values, but these can be
     # omitted by specifying the <tt>include_missing</tt> parameter.
@@ -147,6 +147,10 @@ class DotKey
               array.each_with_index do |item, index|
                 object["#{key_prefix}#{index}"] = item
               end
+            elsif array.nil?
+              if include_missing
+                object["#{key_prefix}*"] = nil
+              end
             elsif raise_on_invalid
               raise InvalidTypeError.new "Expected #{parent_key} to be an Array, but got #{array.class}"
             elsif include_missing
@@ -160,6 +164,10 @@ class DotKey
               hash.each do |hash_key, item|
                 object["#{key_prefix}#{hash_key}"] = item
               end
+            elsif hash.nil?
+              if include_missing
+                object["#{key_prefix}**"] = nil
+              end
             elsif raise_on_invalid
               raise InvalidTypeError.new "Expected #{parent_key} to be a Hash, but got #{hash.class}"
             elsif include_missing
@@ -194,6 +202,10 @@ class DotKey
                   object["#{key_prefix}#{key}"] = nil
                 end
               end
+            elsif val.nil?
+              if include_missing
+                object["#{key_prefix}#{key}"] = nil
+              end
             elsif raise_on_invalid
               if val.is_a?(Array) && key_as_int == :invalid
                 raise InvalidTypeError.new "Expected #{key} to be an array key for Array #{parent_key}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotkey
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Simon J
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2025-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,8 +80,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-description: A series of utility methods allowing you to easily interact with Ruby
-  objects using dot notation
+description: DotKey provides an elegant way to read, write, and manipulate deeply
+  nested Hashes and Arrays using dot-delimited strings. It supports wildcards for
+  pattern matching, custom delimiters, and flexible handling of missing values - making
+  it ideal for working with complex data structures, configuration objects, and API
+  responses.
 email: 2857218+mwnciau@users.noreply.github.com
 executables: []
 extensions: []
@@ -118,5 +121,5 @@ requirements: []
 rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Interact with object using dot notation
+summary: Interact with nested Ruby data structures using dot-delimited strings
 test_files: []