jsonwalk 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29153e1f6efa3ff4ef9880bcf90fc670a7f6596a
-  data.tar.gz: bc69962029c478dc73c44bda282d3083a7171ccc
+  metadata.gz: f8ca16105bd17da8a1082049a7ab632974040680
+  data.tar.gz: b238a9f1055435af9e6a9fce2fce53f076510450
 SHA512:
-  metadata.gz: c5b98deaeea6ab16196f27b0811ac89d67f1e2a45f89f5f0691af8e9fe8f24086cde448f479dde939aed940f03f4b695a4a4b0173eabd7172e29be249cf40b2b
-  data.tar.gz: 5d698e1f8012c9ca01eec641102593e431d91ac8c6fbcde54c21f80876ae018562339a67da437624cbd31aa1c9834fbe3cbb7b10408481305482e55d51e331bd
+  metadata.gz: 15b46589fa5df9d53faeaaa3e2536f9b098a853c01214bfde27069ba9dfcd343b58a944e61edf019cfc9b217e2348397f91d5edbe6df17edfe9a58ea0bc4df3c
+  data.tar.gz: be4904e6a7ddab81cef1ccc1e60f32de46621236f9fce3ce8442ec6b4df33f82730067678fa5c2cbca38b11549d2f7a77d1698b65d958e901cf85984cda81da5

data/README.md

@@ -22,7 +22,104 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+jsonwalk provides functions to walk in a JSON tree created with JSON.parse
+	
+	- JsonWalk.walk
+		selects the list values from a JSON tree using a given path of names
+		parameters :
+			root: the top of the JSON tree
+			      usually the value returned by JSON.parse
+			path: the list of names which form the json path
+			    	each element may be a name, a selection, an integer or 
+				the .. operator which causes a backward move
+		return : 
+			the value or the list of values which match the path
+	
+	- JsonWalk.forward
+		move into a JSON tree one step deeper 
+		parameters : 
+		        node: a node or a list of nodes belonging to a JSON tree, 
+                              node may be an array. In this case all the values are returned
+		        branch: the  name of the object 
+		output :
+			a list which contains the values corresponding to branch
+			nil if node is nil or branch has not been founded
+	- JsonWalk.select
+		filter out a node list based on the given operator 
+		parameters : 
+			node: a list of nodes belonging to a JSON tree
+			branch: the name of the object on which the selection will be done
+			condition: the string which must be matched by the value
+			operator: define how the name/value pair has to match 
+					== value must be equal to condition
+					=~ value must match (regex) the condition
+					!= value must NOT be equal to condition
+					!~ value must NOT  match (regex) the condition
+		output :
+			a list of nodes which match the condition
+			this is a subset of node
+	- JsonWalk.backward
+		move into a JSON tree one step back to the root 
+		parameters :
+			parent: a single node of a JSON tree
+			node: a node or a list of nodes belonging to a JSON tree
+		output: 
+			the list of the parent childern which include node as descendant
+		
+
+## Examples
+	Consider this Json object provided as the pjson2.txt file :
+{
+"food":
+    [
+        {
+            "id": "0001",
+            "type": "donut",
+            "ingredients": [
+                {
+                    "flour": 200,
+                    "eggs":  3,
+                }
+            ]
+        },
+        {
+            "id": "0002",
+            "type": "cookie",
+            "ingredients": [
+                {
+                    "flour": 100,
+                    "chocolate":  50,
+                }
+            ]
+        },      
+    ]
+}
+
+You can use the file test/cli_jsonwalk.rb to parse it with the syntax:
+	cli_jsonwalk.rb pjson2.txt path
+
+1. get the value corresponding to the name food :
+$ ruby test_jsonwalk.rb pjson2.txt food
+["food"] ==> [{"id"=>"0001", "type"=>"donut", "ingredients"=>[{"flour"=>200}, {"eggs"=>3}]}, {"id"=>"0002", "type"=>"cookie", "ingredients"=>[{"flour"=>100}, {"chocolate"=>50}]}]
+
+2. get the values corresponding to the path food,type
+$ ruby test_jsonwalk.rb pjson2.txt food/type
+["food", "type"] ==> ["donut", "cookie"]
+
+3. get the ingredients for the elements of type donut
+$ ruby test_jsonwalk.rb pjson2.txt food/type==donut/ingredients
+["food", "type==donut", "ingredients"] ==> [[{"flour"=>200}, {"eggs"=>3}]]
+
+4. get the type of elements which needs chocolate 
+$ ruby test_jsonwalk.rb pjson2.txt food/ingredients/chocolate/../../type
+["food", "ingredients", "chocolate", "..", "..", "type"] ==> ["cookie"]
+
+5. get the second ingredient for the type donut
+$ ruby test_jsonwalk.rb pjson2.txt food/type==donut/ingredients/0/1
+["food", "type==donut", "ingredients", 0, 1] ==> {"eggs"=>3}
+
+Note that the selection type==donut does not remove the food array but propagate it 
+
 
 ## Development
 

data/lib/jsonwalk/version.rb

@@ -1,3 +1,3 @@
 module JsonWalk
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/lib/jsonwalk.rb

@@ -39,9 +39,8 @@ module JsonWalk
 	# if it is an array, return the set of children
 	def JsonWalk.forward(node, branch)
 		# move forward : get the uniq child or all of them  
-		return node.kind_of?(Array) ? 
-                             node.flatten.map {|child| child.key?(branch) ? child[branch] : nil} :
-                             node.key?(branch) ? node[branch] : nil
+		return nil if node==nil
+		return node.kind_of?(Array) ? node.flatten.map {|child| child[branch]} : node[branch] 
 	end
 	 
 	 # just select a set of children matching a condition
@@ -62,6 +61,7 @@ module JsonWalk
 	
 	# move one step backward (but keep current selection)
 	def  JsonWalk.backward(parent,node)
+		return nil if parent==nil or node==nil
 		return parent.select { |child| IsAncestor(child, node) }
 	end
 
@@ -91,11 +91,11 @@ module JsonWalk
 				# move deeper in the tree
 				print "moving forward to key #{child_key}\n"       if VERBOSE
 				levels.push nodes	# keep track of current level
-				nodes = nodes==nil ? nil : forward( nodes, child_key)
+				nodes = forward( nodes, child_key)
 			end
 			
 		end
-		return nodes
+		return nodes.class==Array ? nodes.compact : nodes
 	end
 	
 # module end		

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonwalk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Philippe Jounin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,7 @@ files:
 - bin/console
 - bin/setup
 - jsonwalk-1.1.0.gem
+- jsonwalk-1.1.1.gem
 - jsonwalk.gemspec
 - lib/jsonwalk.rb
 - lib/jsonwalk/version.rb