path_example_test.go

package jsonpath_test

import (
	"encoding/json"
	"errors"
	"fmt"
	"log"

	"github.com/theory/jsonpath"
	"github.com/theory/jsonpath/registry"
	"github.com/theory/jsonpath/spec"
)

// Select all the authors of the books in a bookstore object.
func Example() {
	// Parse a jsonpath query.
	p, err := jsonpath.Parse(`$.store.book[*].author`)
	if err != nil {
		log.Fatal(err)
	}

	// Select values from unmarshaled JSON input.
	store := bookstore()
	nodes := p.Select(store)

	// Show the selected values.
	items, err := json.Marshal(nodes)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", items)

	// Output: ["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]
}

func ExamplePath_Select() {
	// Load some JSON.
	menu := map[string]any{
		"apps": map[string]any{
			"guacamole": 19.99,
			"salsa":     5.99,
		},
	}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse("$.apps.*")
	nodes := p.Select(menu)

	// Show the selected values.
	for node := range nodes.All() {
		fmt.Printf("%v\n", node)
	}
	// Unordered output:
	// 19.99
	// 5.99
}

func ExamplePath_SelectLocated() {
	// Load some JSON.
	menu := map[string]any{
		"apps": map[string]any{
			"guacamole": 19.99,
			"salsa":     5.99,
		},
	}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse("$.apps.*")
	nodes := p.SelectLocated(menu)

	// Show the selected nodes.
	for node := range nodes.All() {
		fmt.Printf("%v: %v\n", node.Path, node.Node)
	}

	// Unordered output:
	// $['apps']['guacamole']: 19.99
	// $['apps']['salsa']: 5.99
}

func ExampleLocatedNodeList() {
	// Load some JSON.
	menu := map[string]any{
		"apps": map[string]any{
			"guacamole": 19.99,
			"salsa":     5.99,
		},
	}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse(`$.apps["salsa", "guacamole"]`)
	nodes := p.SelectLocated(menu)

	// Show the nodes.
	fmt.Println("Nodes:")
	for n := range nodes.Nodes() {
		fmt.Printf("  %v\n", n)
	}

	// Show the paths.
	fmt.Println("\nPaths:")
	for p := range nodes.Paths() {
		fmt.Printf("  %v\n", p)
	}

	// Output:
	// Nodes:
	//   5.99
	//   19.99
	//
	// Paths:
	//   $['apps']['salsa']
	//   $['apps']['guacamole']
}

func ExampleLocatedNodeList_Deduplicate() {
	// Load some JSON.
	pallet := map[string]any{"colors": []any{"red", "blue"}}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse("$.colors[0, 1, 1, 0]")
	nodes := p.SelectLocated(pallet)
	fmt.Printf("Items: %v\n", len(nodes))

	// Deduplicate
	nodes = nodes.Deduplicate()
	fmt.Printf("Items: %v\n", len(nodes))

	// Output:
	// Items: 4
	// Items: 2
}

func ExampleLocatedNodeList_Sort() {
	// Load some JSON.
	pallet := map[string]any{"colors": []any{"red", "blue", "green"}}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse("$.colors[2, 0, 1]")
	nodes := p.SelectLocated(pallet)

	// Show selected.
	fmt.Println("Selected:")
	for _, node := range nodes {
		fmt.Printf("  %v: %v\n", node.Path, node.Node)
	}

	// Sort by normalized paths and show selected again.
	nodes.Sort()
	fmt.Println("\nSorted:")
	for _, node := range nodes {
		fmt.Printf("  %v: %v\n", node.Path, node.Node)
	}

	// Output:
	// Selected:
	//   $['colors'][2]: green
	//   $['colors'][0]: red
	//   $['colors'][1]: blue
	//
	// Sorted:
	//   $['colors'][0]: red
	//   $['colors'][1]: blue
	//   $['colors'][2]: green
}

func ExampleLocatedNodeList_Clone() {
	// Load some JSON.
	items := []any{1, 2, 3, 4, 5}

	// Parse a JSONPath and select from the input.
	p := jsonpath.MustParse("$[2, 0, 1, 0, 1]")
	nodes := p.SelectLocated(items)

	// Clone the selected nodes then deduplicate.
	orig := nodes.Clone()
	nodes = nodes.Deduplicate()

	// Cloned nodes have the original count.
	fmt.Printf("Unique Count:   %v\nOriginal Count: %v\n", len(nodes), len(orig))

	// Output:
	// Unique Count:   3
	// Original Count: 5
}

// Use the Parser to parse a collection of paths.
func ExampleParser() {
	// Create a new parser using the default function registry.
	parser := jsonpath.NewParser()

	// Parse a list of paths.
	paths := []*jsonpath.Path{}
	for _, path := range []string{
		"$.store.book[*].author",
		"$..author",
		"$.store..color",
		"$..book[2].author",
		"$..book[2].publisher",
		"$..book[?@.isbn].title",
		"$..book[?@.price<10].title",
	} {
		p, err := parser.Parse(path)
		if err != nil {
			log.Fatal(err)
		}
		paths = append(paths, p)
	}

	// Later, use the paths to select from JSON inputs.
	store := bookstore()
	for _, p := range paths {
		items := p.Select(store)
		array, err := json.Marshal(items)
		if err != nil {
			log.Fatal(err)
		}

		fmt.Printf("%s\n", array)
	}
	// Output:
	// ["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]
	// ["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]
	// ["red"]
	// ["Herman Melville"]
	// []
	// ["Moby Dick","The Lord of the Rings"]
	// ["Sayings of the Century","Moby Dick"]
}

// Use WithRegistry to create a [Parser] that uses a [registry.Registry]
// containing function extensions, as [defined by the standard]. This example
// creates a function named "first" that returns the first item in a list of
// nodes.
//
// [defined by the standard]: https://www.rfc-editor.org/rfc/rfc9535.html#name-function-extensions
func ExampleWithRegistry() {
	// Register the first function.
	reg := registry.New()
	err := reg.Register(
		"first",           // name
		spec.FuncValue,    // returns a single value
		validateFirstArgs, // parse-time validation defined below
		firstFunc,         // function defined below
	)
	if err != nil {
		log.Fatalf("Error %v", err)
	}

	// Create a parser with the registry that contains the extension.
	parser := jsonpath.NewParser(jsonpath.WithRegistry(reg))

	// Use the function to select lists that start with 6.
	path, err := parser.Parse("$[? first(@.*) == 6]")
	if err != nil {
		log.Fatalf("Error %v", err)
	}

	// Do any of these arrays start with 6?
	input := []any{
		[]any{1, 2, 3, 4, 5},
		[]any{6, 7, 8, 9},
		[]any{4, 8, 12},
	}
	nodes := path.Select(input)
	fmt.Printf("%v\n", nodes)
	// Output: [[6 7 8 9]]
}

// validateFirstArgs validates that a single argument is passed to the first()
// function, and that it can be converted to [spec.NodesType], so that first()
// can return the first node. It's called by the parser.
func validateFirstArgs(args []spec.FuncExprArg) error {
	if len(args) != 1 {
		return fmt.Errorf("expected 1 argument but found %v", len(args))
	}

	if !args[0].ConvertsTo(spec.FuncNodes) {
		return errors.New("cannot convert argument to nodes")
	}

	return nil
}

// firstFunc defines the custom first() JSONPath function. It converts its
// single argument to a [spec.NodesType] value and returns a [spec.ValueType]
// that contains the first node. If there are no nodes it returns nil.
func firstFunc(jv []spec.PathValue) spec.PathValue {
	nodes := spec.NodesFrom(jv[0])
	if len(nodes) == 0 {
		return nil
	}
	return spec.Value(nodes[0])
}

// bookstore returns an unmarshaled JSON object.
func bookstore() any {
	src := []byte(`{
	  "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": 399
	    }
	  }
	}`)

	// Parse the JSON.
	var value any
	if err := json.Unmarshal(src, &value); err != nil {
		log.Fatal(err)
	}
	return value
}