json_path_rfc9535 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 341631a563a6872bcf0f04f58fdb547a5a17500f3f7fae04ba29ada044c17dbd
-  data.tar.gz: '0669414a8c33cd4ddfd67f2e330d72783ec862ba1a26573053a5bbf372a6b26e'
+  metadata.gz: 69b07574707f71649d798ce1c776fd4130df2fa439f7d83289296029af07a5ff
+  data.tar.gz: 795c8a411c539e28e4698979d251cc87994d0b8a5ba33b6833049b3303b973a5
 SHA512:
-  metadata.gz: c355da298d64c50f35f59a76bbff44b2511de1dafbf65181a078db74909433396dd86f803ecd1b821ce0bf4327264786298d7189e5c7ee37777bf35e53dacc8e
-  data.tar.gz: f8e4f5e8a131adb0b1d88b9a820218687db2a146fea1a4ef91e33adb461b1d299285895c5fde88554f6ac14d87b7e86235ed97734253f397e06e741a5f270b13
+  metadata.gz: bb465b393405011742d074b069503872715c8eb31dbaf554b3795db58b897857ffe54a3866157ab4d85f7693e7f02af1b239f0c1b72c0379cf7e29a461f68552
+  data.tar.gz: c19ddf5f2d90ebc66bfc6d3b263a5a1375bdde3b8a6c8a75536fa6e687686b06d2f029311cf0a37d27791aef4019557879852a4742f62d1337ac7f4710e9ad8c

data/CHANGELOG.md

@@ -8,6 +8,13 @@
 ### Bug fixes
 )-->
 
+## 1.1.0 2024-09-10
+
+### New features
+
+- Made the return value of queries an `Enumerable`.
+- Made individual nodes queryable.
+
 ## 1.0.0 2024-09-09
 
 First public release. Refer to [README.md](README.md) for the full documentation.

data/README.md

@@ -75,12 +75,23 @@ JSON
 doc.query('$.store.bicycle.color')
 ```
 
-The returned object has methods to retrieve the values or the paths of all the retrieved nodes:
+If you already parsed the Json, you can use that instead of the Json string:
 
 ```ruby
-doc.query('$.store.book.*.category').values
+json = JSON.parse('...')
+...
+doc = JsonPath::Doc(json)
+```
+
+The query returns an `Enumerable`, which also has methods to retrieve the values or the paths of all the retrieved nodes:
+
+```ruby
+results = doc.query('$.store.book.*.category')
+results.count
+# => 4
+results.values
 # => ["reference", "fiction", "fiction", "fiction"]
-doc.query('$.store.book.*.category').paths
+results.paths
 # => ["$['store']['book'][0]['category']", "$['store']['book'][1]['category']", "$['store']['book'][2]['category']", "$['store']['book'][3]['category']"]
 ```
 
@@ -94,6 +105,13 @@ results.query('$.author').values
 # => ["Evelyn Waugh", "J. R. R. Tolkien"]
 ```
 
+Alternatively, you can query the single nodes:
+
+```ruby
+results.flat_map { _1.query('$.author').values }.join(', ')
+# => "Evelyn Waugh, J. R. R. Tolkien"
+```
+
 This gem implements most of RFC 9535, with the exception of [function extensions](https://datatracker.ietf.org/doc/html/rfc9535#name-function-extensions) and the related [type system](https://datatracker.ietf.org/doc/html/rfc9535#name-type-system-for-function-ex). It also relies on the underlying Ruby interpreter for string evaluation, meaning that characters don't need to be double-escaped.
 
 ## Plans for future development

data/lib/json_path/doc.rb

@@ -1,7 +1,5 @@
 require 'json'
 require_relative 'nodes'
-require_relative 'path'
-require_relative 'node_list'
 
 module JsonPath
   class Doc
@@ -12,12 +10,8 @@ module JsonPath
       @root_node = Nodes.parse '$', json
     end
 
-    def query json_path
-      json_path = Path.new json_path
-
-      json_path
-        .apply(root_node)
-        .then { NodeList.new _1 }
+    def query(...)
+      root_node.query(...)
     end
 
     def value

data/lib/json_path/node_list.rb

@@ -1,27 +1,29 @@
-require_relative 'path'
-
 module JsonPath
   class NodeList
+    include Enumerable
+
     attr_reader :nodes
 
     def initialize nodes
       @nodes = nodes
     end
 
-    def query json_path
-      json_path = Path.new json_path
-
+    def query(...)
       nodes
-        .flat_map { json_path.apply _1 }
+        .flat_map { _1.query(...) }
         .then { self.class.new _1 }
     end
 
+    def each(&block)
+      nodes.each(&block)
+    end
+
     def values
-      nodes.map(&:value)
+      map(&:value)
     end
 
     def paths
-      nodes.map(&:path)
+      map(&:path)
     end
   end
 end

data/lib/json_path/nodes/base.rb

@@ -1,3 +1,6 @@
+require_relative '../path'
+require_relative '../node_list'
+
 module JsonPath
   module Nodes
     class Base
@@ -8,6 +11,14 @@ module JsonPath
         @path = path
         @children = []
       end
+
+      def query json_path
+        json_path = Path.new json_path
+
+        json_path
+          .apply(self)
+          .then { NodeList.new _1 }
+      end
     end
   end
 end

data/lib/json_path_rfc9535/version.rb

@@ -1,3 +1,3 @@
 module JsonPathRfc9535
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_path_rfc9535
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet