Merge branch 'release/1.0.0-preview.20210928' into master/1.x

Author: eiiches

README.md

@@ -12,13 +12,13 @@ Usage
 
 First, you need Java 8 or later.
 
-If you use Maven, add the following snippet to the `<dependencies>` section of your POM. For instructions for other build tools (Gradle, etc.), visit [jackson-jq](https://search.maven.org/artifact/net.thisptr/jackson-jq/1.0.0-preview.20210926/jar) on search.maven.org.
+If you use Maven, add the following snippet to the `<dependencies>` section of your POM. For instructions for other build tools (Gradle, etc.), visit [jackson-jq](https://search.maven.org/artifact/net.thisptr/jackson-jq/1.0.0-preview.20210928/jar) on search.maven.org.
 
 ```xml
 <dependency>
 	<groupId>net.thisptr</groupId>
 	<artifactId>jackson-jq</artifactId>
-	<version>1.0.0-preview.20210926</version>
+	<version>1.0.0-preview.20210928</version>
 </dependency>
 ```
 
@@ -32,29 +32,29 @@ To test a query quickly, we provide jackson-jq CLI.
 *Please note that jackson-jq is a Java library and the CLI is provided solely for debugging/testing purpose (and not for production). The command-line options might change without notice.*
 
 ```sh
-$ curl -LO https://repo1.maven.org/maven2/net/thisptr/jackson-jq-cli/1.0.0-preview.20210926/jackson-jq-cli-1.0.0-preview.20210926.jar
+$ curl -LO https://repo1.maven.org/maven2/net/thisptr/jackson-jq-cli/1.0.0-preview.20210928/jackson-jq-cli-1.0.0-preview.20210928.jar
 
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --help
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --help
 usage: jackson-jq [OPTIONS...] QUERY
  -c,--compact      compact instead of pretty-printed output
  -h,--help         print this message
     --jq <arg>     specify jq version
  -n,--null-input   use `null` as the single input value
  -r,--raw          output raw strings, not JSON texts
 
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar '.foo'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar '.foo'
 {"foo": 42}
 42
 ```
 
 To test a query with a specific jq version,
 
 ```sh
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.5 'join("-")'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.5 'join("-")'
 ["1", 2]
 jq: error: string ("-") and number (2) cannot be added
 
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.6 'join("-")' # jq-1.6 can join any values, not only strings
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.6 'join("-")' # jq-1.6 can join any values, not only strings
 ["1", 2]
 "1-2"
 ```
@@ -206,7 +206,7 @@ This table illustrates which features (picked from jq-1.5 manual) are supported
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [`ǀ=`](https://stedolan.github.io/jq/manual/v1.5/#&#124;&#61;)                                                                                                                                                                                                                                      | ○<sup>*8</sup> |
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [`+=`, `-=`, `*=`, `/=`, `%=`, `//=`](https://stedolan.github.io/jq/manual/v1.5/#&#43;&#61;&#44;&#45;&#61;&#44;&#42;&#61;&#44;&#47;&#61;&#44;&#37;&#61;&#44;&#47;&#47;&#61;)                                                                                                                        | ○          |
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [Complex assignments](https://stedolan.github.io/jq/manual/v1.5/#Complexassignments)                                                                                                                                                                                                                | ○          |
-| [Modules](https://stedolan.github.io/jq/manual/v1.5/#Modules)                                                                                                                                                                                                                                                                      | ×          |
+| [Modules](https://stedolan.github.io/jq/manual/v1.5/#Modules)                                                                                                                                                                                                                                                                      | △          |
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [`import RelativePathString as NAME [<metadata>];`](https://stedolan.github.io/jq/manual/v1.5/#importRelativePathStringasNAME&#91;&#60;metadata&#62;&#93;&#59;)                                                                                                                                     | ×          |
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [`include RelativePathString [<metadata>];`](https://stedolan.github.io/jq/manual/v1.5/#includeRelativePathString&#91;&#60;metadata&#62;&#93;&#59;)                                                                                                                                                 | ×          |
 | &nbsp;&nbsp;&nbsp;&nbsp;&bull; [`import RelativePathString as $NAME [<metadata>];`](https://stedolan.github.io/jq/manual/v1.5/#importRelativePathStringas&#36;NAME&#91;&#60;metadata&#62;&#93;&#59;)                                                                                                                               | ×          |
@@ -236,9 +236,9 @@ $ jq -n '1 + 3 as $a | ($a * 2)' # interpreted as 1 + (3 as $a | ($a * 2))
 whereas jackson-jq consistently interprets them as `(1 + 3)` whether `as $a` is used or not:
 
 ```console
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '1 + 3 | (. * 2)' # interpreted as (1 + 3) | (. * 2)
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n '1 + 3 | (. * 2)' # interpreted as (1 + 3) | (. * 2)
 8
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '1 + 3 as $a | ($a * 2)' # interpreted as (1 + 3) as $a | ($a * 2)
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n '1 + 3 as $a | ($a * 2)' # interpreted as (1 + 3) as $a | ($a * 2)
 8
 ```
 
@@ -247,7 +247,7 @@ $ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '1 + 3 as $a | ($a * 2)
 ```console
 $ jq -n '1 + 3 as $a | ($a * 2)' # interpreted as 1 + (3 as $a | ($a * 2))
 7
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '1 + 3 as $a | ($a * 2)' # interpreted as (1 + 3) as $a | ($a * 2)
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n '1 + 3 as $a | ($a * 2)' # interpreted as (1 + 3) as $a | ($a * 2)
 8
 ```
 
@@ -274,7 +274,7 @@ If the function with the same is defined more than once at the same scope, jacks
 ```console
 $ jq -n 'def f: 1; def g: f; def f: 2; g'
 1
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n 'def f: 1; def g: f; def f: 2; g'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n 'def f: 1; def g: f; def f: 2; g'
 2
 ```
 
@@ -283,7 +283,7 @@ $ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n 'def f: 1; def g: f; de
 Avoid using the duplicate function name.
 
 ```console
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n 'def f1: 1; def g: f1; def f2: 2; g'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n 'def f1: 1; def g: f1; def f2: 2; g'
 1
 ```
 
@@ -353,7 +353,7 @@ jq: error: Division by zero? at <top-level>, line 1:
 jq: 1 compile error
 $ jq '. / 0' <<< 0
 jq: error (at <stdin>:1): number (0) and number (0) cannot be divided because the divisor is zero
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '0 / 0'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n '0 / 0'
 jq: error: number (0) and number (0) cannot be divided because the divisor is zero
 ```
 
@@ -386,9 +386,9 @@ $ jq-1.2 -n '[1,2,3] | ((.[] | select(. > 1)) |= empty)'
   2,
   3
 ]
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.6 -n '[1,2,3] | ((.[] | select(. > 1)) |= empty)'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.6 -n '[1,2,3] | ((.[] | select(. > 1)) |= empty)'
 jq: error: `|= empty` is undefined. See https://github.com/stedolan/jq/issues/897
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.5 -n '[1,2,3] | ((.[] | select(. > 1)) |= empty)'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.5 -n '[1,2,3] | ((.[] | select(. > 1)) |= empty)'
 jq: error: `|= empty` is undefined. See https://github.com/stedolan/jq/issues/897
 ```
 
@@ -397,9 +397,9 @@ jq: error: `|= empty` is undefined. See https://github.com/stedolan/jq/issues/89
 You can use `_modify/2` if you really want to the original behavior.
 
 ```console
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.6 -n '[1,2,3] | _modify((.[] | select(. > 1)); empty)'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.6 -n '[1,2,3] | _modify((.[] | select(. > 1)); empty)'
 [ 1, 3 ]
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.5 -n '[1,2,3] | _modify((.[] | select(. > 1)); empty)'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.5 -n '[1,2,3] | _modify((.[] | select(. > 1)); empty)'
 null
 ```
 
@@ -419,7 +419,7 @@ jq 1.5
 ```console
 $ jq-1.5 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
 ["foo"]
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.5 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.5 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
 jq: error: Invalid path expression with result 1
 ```
 
@@ -428,7 +428,7 @@ jq 1.6
 ```console
 $ jq-1.6 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
 jq: error (at <stdin>:1): Invalid path expression with result 1
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar --jq 1.6 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar --jq 1.6 -c 'path(.foo as $a | $a)' <<< '{"foo": 1}'
 jq: error: Invalid path expression with result 1
 ```
 
@@ -452,7 +452,7 @@ $ jq -n 'label $a | label $b | try (break $b) catch .'
 {
   "__jq": 1
 }
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n 'label $a | label $b | try (break $b) catch .'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n 'label $a | label $b | try (break $b) catch .'
 {
   "__jq" : 0
 }
@@ -482,25 +482,37 @@ $ jq-1.6 -n '"x" | indices("")' # stuck in infinite loop
 ^C
 $ jq-1.6-83-gb52fc10 -n '"x" | indices("")'
 []
-$ java -jar jackson-jq-cli-1.0.0-preview.20210926.jar -n '"x" | indices("")'
+$ java -jar jackson-jq-cli-1.0.0-preview.20210928.jar -n '"x" | indices("")'
 [ ]
 ```
 
 </details>
 
-Using jackson-jq-extra module
------------------------------
+Using jackson-jq/extras module
+------------------------------
 
-`jackson-jq-extra` module provides extra functions that you might find useful. These functions do not exist in jq.
+The `jackson-jq/extras` module is a jq module that provides some useful functions that do not exist in jq.
+
+To use this module, you need to add the following Maven dependency and set `BuiltinModuleLoader` (see [jackson-jq/src/test/java/examples/Usage.java](jackson-jq/src/test/java/examples/Usage.java)) to the scope.
 
 ```xml
 <dependency>
 	<groupId>net.thisptr</groupId>
 	<artifactId>jackson-jq-extra</artifactId>
-	<version>1.0.0-preview.20210926</version>
+	<version>1.0.0-preview.20210928</version>
 </dependency>
 ```
 
+Now, you can import the module in jq:
+
+```jq
+import "jackson-jq/extras" as extras;
+
+extras::uuid4
+```
+
+For a historical reason, adding the Maven dependency also makes the functions directly available to jq. This behavior is deprecated and will be removed at some point in the future.
+
 <details>
 <summary>List of Functions</summary>
 

jackson-jq-cli/pom.xml

@@ -8,14 +8,14 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210926</version>
+		<version>1.0.0-preview.20210928</version>
 	</parent>
 
 	<dependencies>
 		<dependency>
 			<groupId>net.thisptr</groupId>
 			<artifactId>jackson-jq-extra</artifactId>
-			<version>1.0.0-preview.20210926</version>
+			<version>1.0.0-preview.20210928</version>
 		</dependency>
 		<dependency>
 			<groupId>commons-cli</groupId>

jackson-jq-cli/src/main/java/net/thisptr/jackson/jq/cli/Main.java

@@ -5,6 +5,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.nio.file.FileSystems;
 import java.util.Arrays;
 import java.util.List;
 
@@ -28,6 +29,10 @@
 import net.thisptr.jackson.jq.Versions;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
 import net.thisptr.jackson.jq.internal.functions.EnvFunction;
+import net.thisptr.jackson.jq.module.ModuleLoader;
+import net.thisptr.jackson.jq.module.loaders.BuiltinModuleLoader;
+import net.thisptr.jackson.jq.module.loaders.ChainedModuleLoader;
+import net.thisptr.jackson.jq.module.loaders.FileSystemModuleLoader;
 
 public class Main {
 	private static final ObjectMapper MAPPER = new ObjectMapper();
@@ -108,6 +113,11 @@ public static void main(String[] args) throws IOException, ParseException {
 		BuiltinFunctionLoader.getInstance().loadFunctions(version, scope);
 		scope.addFunction("env", 0, new EnvFunction());
 
+		scope.setModuleLoader(new ChainedModuleLoader(new ModuleLoader[] {
+				BuiltinModuleLoader.getInstance(),
+				new FileSystemModuleLoader(scope, version, FileSystems.getDefault().getPath("").toAbsolutePath()),
+		}));
+
 		try (final BufferedReader reader = new BufferedReader(new InputStreamReader(is))) {
 			final JsonParser parser = MAPPER.getFactory().createParser(reader);
 			while (!parser.isClosed()) {

jackson-jq-extra/pom.xml

@@ -8,14 +8,14 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210926</version>
+		<version>1.0.0-preview.20210928</version>
 	</parent>
 
 	<dependencies>
 		<dependency>
 			<groupId>net.thisptr</groupId>
 			<artifactId>jackson-jq</artifactId>
-			<version>1.0.0-preview.20210926</version>
+			<version>1.0.0-preview.20210928</version>
 		</dependency>
 	</dependencies>
 
@@ -26,7 +26,7 @@
 				<artifactId>maven-bundle-plugin</artifactId>
 				<configuration>
 					<instructions>
-						<Include-Resource>META-INF/services/net.thisptr.jackson.jq.Function=${project.build.outputDirectory}/META-INF/services/net.thisptr.jackson.jq.Function</Include-Resource>
+						<Include-Resource>META-INF/services/net.thisptr.jackson.jq.Function=${project.build.outputDirectory}/META-INF/services/net.thisptr.jackson.jq.Function,META-INF/services/net.thisptr.jackson.jq.module.Module=${project.build.outputDirectory}/META-INF/services/net.thisptr.jackson.jq.module.Module</Include-Resource>
 					</instructions>
 				</configuration>
 			</plugin>

jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/ModuleImpl.java

@@ -0,0 +1,39 @@
+package net.thisptr.jackson.jq.extra;
+
+import com.google.auto.service.AutoService;
+
+import net.thisptr.jackson.jq.BuiltinFunction;
+import net.thisptr.jackson.jq.Function;
+import net.thisptr.jackson.jq.extra.functions.HostnameFunction;
+import net.thisptr.jackson.jq.extra.functions.RandomFunction;
+import net.thisptr.jackson.jq.extra.functions.StrFTimeFunction;
+import net.thisptr.jackson.jq.extra.functions.StrPTimeFunction;
+import net.thisptr.jackson.jq.extra.functions.TimestampFunction;
+import net.thisptr.jackson.jq.extra.functions.UriDecodeFunction;
+import net.thisptr.jackson.jq.extra.functions.UriParseFunction;
+import net.thisptr.jackson.jq.extra.functions.Uuid4Function;
+import net.thisptr.jackson.jq.module.BuiltinModule;
+import net.thisptr.jackson.jq.module.Module;
+import net.thisptr.jackson.jq.module.SimpleModule;
+
+@AutoService(Module.class)
+@BuiltinModule(path = "jackson-jq/extras")
+public class ModuleImpl extends SimpleModule {
+
+	public ModuleImpl() {
+		addFunction(new HostnameFunction());
+		addFunction(new RandomFunction());
+		addFunction(new StrFTimeFunction());
+		addFunction(new StrPTimeFunction());
+		addFunction(new TimestampFunction());
+		addFunction(new UriDecodeFunction());
+		addFunction(new UriParseFunction());
+		addFunction(new Uuid4Function());
+	}
+
+	private void addFunction(final Function f) {
+		final BuiltinFunction annotation = f.getClass().getAnnotation(BuiltinFunction.class);
+		for (final String fname : annotation.value())
+			addFunction(fname, f);
+	}
+}

jackson-jq/pom.xml

@@ -8,7 +8,7 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210926</version>
+		<version>1.0.0-preview.20210928</version>
 	</parent>
 
 	<dependencies>
@@ -20,7 +20,7 @@
 		<dependency>
 			<groupId>com.google.guava</groupId>
 			<artifactId>guava</artifactId>
-			<version>30.1.1-jre</version>
+			<version>31.0.1-jre</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>