@@ -28,33 +28,15 @@ using the symbol '@' for the current object. Filter expressions are supported vi $.store.book[?(@.price < 10)].title -Here is a complete overview and a side by side comparison of the JSONPath syntax elements with its XPath counterparts. - -<table><tr class="evn"><td> <strong>XPath</strong> </td><td> <strong>JSONPath</strong> </td><td> <strong>Result</strong> </td></tr> -<tr class="odd"><td class="lft"><code>/store/book/author</code> </td><td class="lft"><code>$.store.book[*].author</code> </td><td class="lft">the authors of all books in the store </td></tr> -<tr class="evn"><td class="lft"><code>//author</code> </td><td class="lft"><code>$..author</code> </td><td class="lft">all authors </td></tr> -<tr class="odd"><td class="lft"><code>/store/*</code> </td><td class="lft"><code>$.store.*</code> </td><td class="lft">all things in store, which are some books and a red bicycle. </td></tr> -<tr class="evn"><td class="lft"><code>/store//price</code> </td><td class="lft"><code>$.store..price</code> </td><td class="lft">the price of everything in the store. </td></tr> -<tr class="odd"><td class="lft"><code>//book[3]</code> </td><td class="lft"><code>$..book[2]</code> </td><td class="lft">the third book </td></tr> -<tr class="evn"><td class="lft"><code>//book[last()]</code> </td><td class="lft"><code>$..book[(@.length-1)]</code><br> -<code>$..book[-1:]</code> </td><td class="lft">the last book in order. </td></tr> -<tr class="odd"><td class="lft"><code>//book[position()<3]</code> </td><td class="lft"><code>$..book[0,1]</code><br> -<code>$..book[:2]</code> </td><td class="lft">the first two books </td></tr> -<tr class="evn"><td class="lft"><code>//book[isbn]</code> </td><td class="lft"><code>$..book[?(@.isbn)]</code> </td><td class="lft">filter all books with isbn number </td></tr> -<tr class="odd"><td class="lft"><code>//book[price<10]</code> </td><td class="lft"><code>$..book[?(@.price<10)]</code> </td><td class="lft">filter all books cheapier than 10 </td></tr> -<tr class="evn"><td class="lft"><code>//*</code> </td><td class="lft"><code>$..*</code> </td><td class="lft">all Elements in XML document. All members of JSON structure. </td></tr> -<tr class="odd"><td class="lft"><code>???</code> </td><td class="lft"><code>$.store.!</code> </td><td class="lft">all the keys in the store hash (bicycle, book)</td></tr> -</table> - -XPath has a lot more to offer (Location pathes in not abbreviated syntax, operators and functions) than listed here. Moreover there is a remarkable difference how the subscript operator works in Xpath and JSONPath. +XPath has a lot more to offer (Location paths in not abbreviated syntax, operators and functions) than listed here. Moreover there is a remarkable difference how the subscript operator works in Xpath and JSONPath. * Square brackets in XPath expressions always operate on the node set resulting from the previous path fragment. Indices always start by 1. * With JSONPath square brackets operate on the object or array addressed by the previous path fragment. Indices always start by 0. -[edit] [comment] [remove] |2007-08-18| e3 # JSONPath examples +# JSONPath examples -Let's practice JSONPath expressions by some more examples. We start with a simple JSON structure built after an XML example representing a bookstore (original XML file). +Let's practice JSONPath expressions by some more examples. We start with a simple JSON structure built after an XML example representing a bookstore. { "store": { "book": [ @@ -88,22 +70,27 @@ Let's practice JSONPath expressions by some more examples. We start with a simpl } } +Here are examples of all the types of JSONPath expressions you could perform on this and what you should expect to see as a result. We've also included the comparable XPath expressions. + + XPath JSONPath Result + /store/book/author $.store.book[*].author the authors of all books in the store + //author $..author all authors + /store/* $.store.* all things in store, which are some books and a red bicycle. + /store//price $.store..price the price of everything in the store. + //book[3] $..book[2] the third book + //book[last()] $..book[(@.length-1)] + //book[position()<3] $..book[-1:] the last book in order. + $..book[0,1] + $..book[:2] the first two books + //book[isbn] $..book[?(@.isbn)] filter all books with isbn number + //book[price<10] $..book[?(@.price<10)] filter all books cheapier than 10 + //* $..* all Elements in XML document. All members of JSON structure. + ??? $.store.! all the keys in the store hash (bicycle, book) + $..book[?(@.ratings><'good')] + all the books with a ratings element that contains the word "good" + This could be a key in a hash, an item in an array, + or a substring of a string. -<table><tbody><tr class="evn"><td> <strong>XPath</strong> </td><td> <strong>JSONPath</strong> </td><td> <strong>Result</strong> </td></tr> -<tr class="odd"><td class="lft"><code>/store/book/author</code> </td><td class="lft"><code>$.store.book[*].author</code> </td><td class="lft">the authors of all books in the store </td></tr> -<tr class="evn"><td class="lft"><code>//author</code> </td><td class="lft"><code>$..author</code> </td><td class="lft">all authors </td></tr> -<tr class="odd"><td class="lft"><code>/store/*</code> </td><td class="lft"><code>$.store.*</code> </td><td class="lft">all things in store, which are some books and a red bicycle. </td></tr> -<tr class="evn"><td class="lft"><code>/store//price</code> </td><td class="lft"><code>$.store..price</code> </td><td class="lft">the price of everything in the store. </td></tr> -<tr class="odd"><td class="lft"><code>//book[3]</code> </td><td class="lft"><code>$..book[2]</code> </td><td class="lft">the third book </td></tr> -<tr class="evn"><td class="lft"><code>//book[last()]</code> </td><td class="lft"><code>$..book[(@.length-1)]</code><br> -<code>$..book[-1:]</code> </td><td class="lft">the last book in order. </td></tr> -<tr class="odd"><td class="lft"><code>//book[position()<3]</code> </td><td class="lft"><code>$..book[0,1]</code><br> -<code>$..book[:2]</code> </td><td class="lft">the first two books </td></tr> -<tr class="evn"><td class="lft"><code>//book[isbn]</code> </td><td class="lft"><code>$..book[?(@.isbn)]</code> </td><td class="lft">filter all books with isbn number </td></tr> -<tr class="odd"><td class="lft"><code>//book[price<10]</code> </td><td class="lft"><code>$..book[?(@.price<10)]</code> </td><td class="lft">filter all books cheapier than 10 </td></tr> -<tr class="evn"><td class="lft"><code>//*</code> </td><td class="lft"><code>$..*</code> </td><td class="lft">all Elements in XML document. All members of JSON structure. </td></tr> -<tr class="odd"><td class="lft"><code>???</code> </td><td class="lft"><code>$.store.!</code> </td><td class="lft">all the keys in the store hash (bicycle, book)</td></tr> -</tbody></table> ## JSONPath implementation README.mkdn @@ -35,6 +35,7 @@ package JSONPath; use strict; use lib '../../lib'; use JSON; +use Scalar::Util qw(looks_like_number); sub new(){ @@ -59,7 +60,7 @@ sub run(){ $self->{'obj'} = undef; my ($obj, $expr, $arg) = @_; #my $self->{'obj'} = $obj; - ##$self->logit( "arg: $arg"); + #$self->logit( "arg: $arg"); if ($arg && $arg->{'result_type'}){ my $result_type = $arg->{'result_type'}; if ($result_type eq 'PATH' | $result_type eq 'VALUE'){ @@ -143,7 +144,7 @@ sub store(){ } sub trace(){ - ##$self->logit( "raw trace args: @_"); + #$self->logit( "raw trace args: @_"); my $self = shift; my ($expr, $obj, $path) = @_; #$self->logit( "in trace. $expr /// $obj /// $path"); @@ -151,12 +152,14 @@ sub trace(){ my @x = split(/;/, $expr); my $loc = shift(@x); my $x_string = join(';', @x); + #$self->logit("trace... expr: $expr x_string: $x_string"); my $ref_type = ref $obj; my $reserved_loc = 0; if (exists $self->{'reserved_locs'}->{$loc}){ $reserved_loc = 1; } + #$self->logit("loc: $loc // $reserved_loc // $ref_type"); if (! $reserved_loc and $ref_type eq 'HASH' and ($obj and exists $obj->{$loc}) ){ #$self->logit( "tracing loc($loc) obj (hash)?"); @@ -183,14 +186,17 @@ sub trace(){ #$self->logit( "tracing loc /^$.*?$\$/"); my $path_end = $path; $path_end =~ s/.*;(.).*?$/$1/; + #WTF is eobjuate?! $self->trace($self->eobjuate($loc, $obj, $path_end . ';' . $x_string, $obj, $path)); } elsif ($loc =~ /^\?$.*?$$/){ #$self->logit( "tracing loc /^\?$.*?$\$/"); $self->walk($loc, $x_string, $obj, $path, \&_callback_05); #$self->logit( "after walk w/ 05"); } elsif ($loc =~ /^(-?[0-9]*):(-?[0-9]*):?([0-9]*)$/){ - #$self->logit( "tracing loc for slice"); + #$self->logit( "tracing loc ($loc) for slice"); $self->slice($loc, $x_string, $obj, $path); + } elsif (! $loc and $ref_type eq 'ARRAY'){ + $self->store($path, $obj); } } else { #$self->logit( "trace no expr. will store $obj"); @@ -227,11 +233,13 @@ sub walk (){ sub slice(){ my $self = shift; - #$self->logit( "in slice"); my ($loc, $expr, $obj, $path) = @_; $loc =~ s/^(-?[0-9]*):(-?[0-9]*):?(-?[0-9]*)$/$1:$2:$3/; - my @s = split ($loc); - + # $3 would be if you wanted to specify the steps between the start and end. + + + my @s = split (/:|,/, $loc); + my $len = 0; if (ref $obj eq 'HASH'){ $len = $#{keys %{$obj}}; @@ -239,11 +247,22 @@ sub slice(){ $len = $#{$obj}; } my $start = $s[0] ? $s[0] : 0; - my $end = $s[1] ? $s[1] : $len; + my $end = undef; + if ($loc !~ m/^:(\d+):?$/){ + $end = $s[1] ? $s[1] : $len; + } else { + $end = int($s[1]) -1; + } + my $step = $s[2] ? $s[2] : 1; - $start = $start < 0 ? ($start + $len > 0 ? $start + $len : 0) : ($len > $start ? $start : $len); + #$start = $start < 0 ? ($start + $len > 0 ? $start + $len : 0) : ($len > $start ? $start : $len); + if ($start < 0){ + $start = $len > 0 ? $start + $len +1: 0 ; + #the +1 is so that -1 gets us the last entry, -2 gets us the last two, etc... + } $end = $end < 0 ? ($end + $len > 0 ? $end + $len : 0) : ($len > $end ? $end : $len); - for (my $x = $start; $x < $end-1; $x += $step){ + #$self->logit("start: $start end: $end step: $step"); + for (my $x = $start; $x <= $end; $x += $step){ $self->trace("$x;$expr", $obj, $path); } } @@ -265,6 +284,7 @@ sub evalx(){ #$self->logit( "existence test "); $loc =~ s/@\.([a-zA-Z0-9_-]*)$/exists \$obj->{'$1'}/; } else { # it's a comparis on some sort? + my $obj_type = ref($obj); $loc =~ s/@\.([a-zA-Z0-9_-]*)(.*)/\$obj->{'$1'}$2/; $loc =~ s/(?<!=)(=)(?!=)/==/; #convert single equals to double if ($loc =~ m/\s*(!|=)=['"](.*?)['"]/){ @@ -273,9 +293,8 @@ sub evalx(){ my $string_match = 0; if ($loc =~ m/ (eq|ne) /){ #dunno if those replacements happened... $string_match =1; - } + } #$self->logit( "comparison test of $1 and $2 ::loc:: $loc"); - my $obj_type = ref($obj); if ($obj_type ne 'HASH' and $obj_type ne 'ARRAY' and $obj){ if (! $string_match){ $loc =~s/\$obj->{(.*?)}(.*)/$obj $2/; @@ -283,7 +302,60 @@ sub evalx(){ $loc =~s/\$obj->{(.*?)}(.*)/"$obj" $2/; } return ($obj and $loc and eval($loc)) ? 1 : 0; + } + } elsif ($loc =~ m/></){ + my $query_item = $loc; + $query_item =~ s/.*><\s*['"]?([\w\.]*)['"]?\s*/$1/; + #$self->logit("includes test: $query_item :: $loc ::"); + if (($obj_type eq 'HASH' or $obj_type eq 'ARRAY')){ + #$self->logit("hash or array"); + if ($obj_type eq 'HASH'){ + #something like "$..book[?(@.ratings><'good')]" + #obj is book + my $eval_string = $loc; + my $sub_obj = undef; + $eval_string =~ s/(.*?)><.*/$1/; + #$eval_string =~ s/(.*?)><.*/\$sub_obj_type = ref $1\->{'$query_item'}/; + #$self->logit("eval_string: $eval_string"); + #set the sub_obj_type + eval('$sub_obj = ' . $eval_string); + my $sub_obj_type =ref $sub_obj; + #$self->logit("sub_obj_type: $sub_obj_type"); + if ($sub_obj){ + if ($sub_obj_type eq 'ARRAY'){ + foreach my $item (@{$sub_obj}){ + if (looks_like_number($item)){ + return 1 if $item == $query_item; + }else { + return 1 if $item eq $query_item; + } + } + return 0; + } elsif ($sub_obj_type eq 'HASH'){ + return exists ($sub_obj->{$query_item}) ? 1 : 0; + } + } else { + #$self->logit("no sub_obj"); + } + } + } else { + #$self->logit(" in array item evalling"); + my $returnable = 0; + if (! looks_like_number($obj)){ + #Does the string include the string they've provided? + #return ($obj eq $query_item or $obj =~ m/.*?$query_item.*?/) ? 1 : 0; + $returnable = ($obj eq $query_item or $obj =~ m/.*?$query_item.*?/) ? 1 : 0; + } else { + #return $obj == $query_item; + $returnable = ($obj == $query_item) ? 1 : 0; + } + #not the best use of the >< operator. we've been drilled down to + # + #$self->logit("returning $returnable"); + return $returnable; } + } else { + #$self->logit("loc not equality or includes test: $loc"); } } #print STDERR "loc: $loc\n"; @@ -319,7 +391,7 @@ sub _callback_04(){ #$self->logit( " in 04. expr = $expr"); if (ref $obj eq 'HASH'){ if (ref($obj->{$key}) eq 'HASH' ){ - ##$self->logit( "Passing this to trace: ..;$expr, " . $obj->{$key} . ", $path;$key\n"; + #$self->logit( "Passing this to trace: ..;$expr, " . $obj->{$key} . ", $path;$key\n"; $self->trace('..;'.$expr, $obj->{$key}, $path . ';' . $key); } elsif (ref($obj->{$key})) { #array #print STDERR "--- \$obj->{$key} wasn't a hash. it was a " . (ref $obj->{$key}) . "\n"; @@ -349,6 +421,7 @@ sub _callback_05(){ } #$self->logit( "eval_result: $eval_result"); if ($eval_result){ + #$self->logit("IT EVALLED! tracing.."); $self->trace("$key;$expr", $obj, $path); } #$self->logit( "leaving 05"); lib/JSONPath.pm @@ -5,36 +5,52 @@ use JSON; use JSONPath; use base qw(Test::Unit::TestCase); -my %test_structure =("store" => { - "book" => [ - { "category" => "reference", - "author" => "Nigel Rees", - "title" => "Sayings of the Century", - "price" => 8.95 - }, - { "category" => "fiction", - "author" => "Evelyn Waugh", - "title" => "Sword of Honour", - "price" => 12.99 - }, - { "category" => "fiction", - "author" => "Herman Melville", - "title" => "Moby Dick", - "isbn" => "0-553-21311-3", - "price" => 8.99 - }, - { "category" => "fiction", - "author" => "J. R. R. Tolkien", - "title" => "The Lord of the Rings", - "isbn" => "0-395-19395-8", - "price" => 22.99 - } - ] , - "bicycle" => { - "color" => "red", - "price" => 19.95 - } - } +my %test_structure =( + "store"=> { + "book"=> [ + { + "category"=> "reference", + "author"=> "Nigel Rees", + "title"=> "Sayings of the Century", + "price"=> 8.95, + "ratings"=> [ + 1, + 3, + 2, + 10 + ] + }, + { + "category"=> "fiction", + "author"=> "Evelyn Waugh", + "title"=> "Sword of Honour", + "price"=> 12.99, + "ratings" => [ + "good", + "bad", + "lovely" + ] + }, + { + "category"=> "fiction", + "author"=> "Herman Melville", + "title"=> "Moby Dick", + "isbn"=> "0-553-21311-3", + "price"=> 8.99 + }, + { + "category"=> "fiction", + "author"=> "J. R. R. Tolkien", + "title"=> "The Lord of the Rings", + "isbn"=> "0-395-19395-8", + "price"=> 22.99 + } + ], + "bicycle"=> { + "color"=> "red", + "price"=> 19.95 + } + } ); @@ -137,17 +153,24 @@ sub test_array_retreival(){ } - $raw_result = $jp->run(\%test_structure, '$..book[0,1]'); #the price of everything + $raw_result = $jp->run(\%test_structure, '$..book[0,1]'); # the first two books $self->assert($raw_result != 0); @result = @{$raw_result}; $self->assert_equals(1, $#result); - $raw_result = $jp->run(\%test_structure, '$..book[:2]'); #the price of everything + $raw_result = $jp->run(\%test_structure, '$..book[:2]'); # the first two books $self->assert($raw_result != 0); @result = @{$raw_result}; $self->assert_equals(1, $#result); + $raw_result = $jp->run(\%test_structure, '$..book[-1:]'); # the last book + $self->assert($raw_result != 0); + @result = @{$raw_result}; + $self->assert_equals(0, $#result); + + + $raw_result = $jp->run(\%test_structure, '$..book[?(@.isbn)]'); #the price of everything $self->assert($raw_result != 0); @result = @{$raw_result}; @@ -179,10 +202,10 @@ sub test_path_operations(){ @result = @{$raw_result}; $self->assert_equals(3, $#result); - $self->assert_equals("\$['store']['book'][0]['author']", $result[0]); - $self->assert_equals("\$['store']['book'][1]['author']", $result[1]); - $self->assert_equals("\$['store']['book'][2]['author']", $result[2]); - $self->assert_equals("\$['store']['book'][3]['author']", $result[3]); + $self->assert_equals("[\"store\"][\"book\"][0][\"author\"]", $result[0]); + $self->assert_equals("[\"store\"][\"book\"][1][\"author\"]", $result[1]); + $self->assert_equals("[\"store\"][\"book\"][2][\"author\"]", $result[2]); + $self->assert_equals("[\"store\"][\"book\"][3][\"author\"]", $result[3]); $raw_result = $jp->run(\%test_structure, '$.store.!', {'result_type' => 'PATH'}); @@ -190,8 +213,69 @@ sub test_path_operations(){ @result = @{$raw_result}; $self->assert_equals(1, $#result); - $self->assert_equals("\$['store']", $result[0]); - $self->assert_equals("\$['store']", $result[1]); + $self->assert_equals("[\"store\"]", $result[0]); + $self->assert_equals("[\"store\"]", $result[1]); } +sub test_includes_test(){ + my $self = shift; + my $jp = JSONPath->new(); + my $raw_result = undef; + my @result = undef; + + $raw_result = $jp->run(\%test_structure, "\$..book[?(@.ratings><'good')]"); + #[ + # { + # "ratings" : [ + # "good", + # "bad", + # "lovely" + # ], + # "category" : "fiction", + # "author" : "Evelyn Waugh", + # "title" : "Sword of Honour", + # "price" : 12.99 + # } + #] + $self->assert($raw_result != 0); + @result = @{$raw_result}; + $self->assert_equals(0, $#result); + $raw_result = $jp->run(\%test_structure, "\$..ratings[?(@.><'good')]"); + #[ + # [ + # "good", + # "bad", + # "lovely" + # ] + #] + $self->assert($raw_result != 0); + @result = @{$raw_result}; + $self->assert_equals(0, $#result); + $self->assert_equals('bad', $result[0][1]); + + + $raw_result = $jp->run(\%test_structure, "\$..book[?(@.ratings><3)]"); + #[ + # { + # "ratings" : [ + # 1, + # 3, + # 2, + # 10 + # ], + # "category" : "reference", + # "author" : "Nigel Rees", + # "title" : "Sayings of the Century", + # "price" : 8.95 + # } + #] + $self->assert($raw_result != 0); + @result = @{$raw_result}; + $self->assert_equals(0, $#result); + $self->assert_equals('reference', $result[0]{'category'}); + $self->assert_equals('ARRAY', ref $result[0]{'ratings'}); + $self->assert_equals(2, $result[0]{'ratings'}[2]); +# +# +} return 1; tests/JSONPathTest.pm @@ -1,31 +1,47 @@ -{ "store": { - "book": [ - { "category": "reference", - "author": "Nigel Rees", - "title": "Sayings of the Century", - "price": 8.95 - }, - { "category": "fiction", - "author": "Evelyn Waugh", - "title": "Sword of Honour", - "price": 12.99 - }, - { "category": "fiction", - "author": "Herman Melville", - "title": "Moby Dick", - "isbn": "0-553-21311-3", - "price": 8.99 - }, - { "category": "fiction", - "author": "J. R. R. Tolkien", - "title": "The Lord of the Rings", - "isbn": "0-395-19395-8", - "price": 22.99 - } - ], - "bicycle": { - "color": "red", - "price": 19.95 - } - } +{ + "store": { + "book": [ + { + "category": "reference", + "author": "Nigel Rees", + "title": "Sayings of the Century", + "price": 8.95, + "ratings": [ + 1, + 3, + 2, + 10 + ] + }, + { + "category": "fiction", + "author": "Evelyn Waugh", + "title": "Sword of Honour", + "price": 12.99, + "ratings" : [ + "good", + "bad", + "lovely" + ] + }, + { + "category": "fiction", + "author": "Herman Melville", + "title": "Moby Dick", + "isbn": "0-553-21311-3", + "price": 8.99 + }, + { + "category": "fiction", + "author": "J. R. R. Tolkien", + "title": "The Lord of the Rings", + "isbn": "0-395-19395-8", + "price": 22.99 + } + ], + "bicycle": { + "color": "red", + "price": 19.95 + } + } } tests/test.js 9e98faf97dc7d4ea090f4e00d8ad643b1ecc2869 Kate Rhodes krhodes@akamai.com http://github.com/masukomi/jsonpath-perl/commit/c927a0da540197636817c55c43ff1cbb11e2667f c927a0da540197636817c55c43ff1cbb11e2667f

2008-11-14T11:36:04-08:00

2008-11-14T10:57:02-08:00

Added support for the new >< "includes" operator * >< operator will tell you if a hash includes the specified key, an array contains the specified element, or a string contains the specified substring 033d88014b897c8a60bb7a975c36652481f5da12 Kate Rhodes krhodes@akamai.com