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

eiiches · Sep 25, 2021 · 5186c99 · 5186c99
2 parents d373805 + 50cd9ca
commit 5186c99
Show file tree

Hide file tree

Showing 103 changed files with 1,253 additions and 289 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "maven"
+    directory: "/jackson-jq/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "maven"
+    directory: "/jackson-jq-cli/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "maven"
+    directory: "/jackson-jq-extra/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/deploy-snapshot.yaml b/.github/workflows/deploy-snapshot.yaml
@@ -8,11 +8,12 @@ jobs:
   build:
     runs-on: ubuntu-18.04
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2.3.4
     - name: Set up JDK 1.8
-      uses: actions/setup-java@v1
+      uses: actions/setup-java@v2.3.0
       with:
-        java-version: 1.8
+        java-version: '8'
+        distribution: 'zulu'
 
     - name: Download jq-1.5 and jq-1.6
       run: |

diff --git a/.github/workflows/test-pull-requests.yaml b/.github/workflows/test-pull-requests.yaml
@@ -0,0 +1,25 @@
+name: 'test-pull-requests'
+on:
+  pull_request:
+    branches:
+    - develop/1.x
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/[email protected]
+    - name: Set up JDK 1.8
+      uses: actions/[email protected]
+      with:
+        java-version: '8'
+        distribution: 'zulu'
+
+    - name: Download jq-1.5 and jq-1.6
+      run: |
+        mkdir -p $HOME/bin
+        wget -O $HOME/bin/jq-1.5 https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64
+        wget -O $HOME/bin/jq-1.6 https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64
+        chmod +x $HOME/bin/jq-1.5 $HOME/bin/jq-1.6
+
+    - name: Build & Deploy
+      run: 'PATH="$HOME/bin:$PATH" mvn clean package'
diff --git a/README.md b/README.md
diff --git a/jackson-jq-cli/pom.xml b/jackson-jq-cli/pom.xml
@@ -8,14 +8,14 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210610</version>
+		<version>1.0.0-preview.20210926</version>
 	</parent>
 
 	<dependencies>
 		<dependency>
 			<groupId>net.thisptr</groupId>
 			<artifactId>jackson-jq-extra</artifactId>
-			<version>1.0.0-preview.20210610</version>
+			<version>1.0.0-preview.20210926</version>
 		</dependency>
 		<dependency>
 			<groupId>commons-cli</groupId>

diff --git a/jackson-jq-extra/pom.xml b/jackson-jq-extra/pom.xml
@@ -8,14 +8,14 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210610</version>
+		<version>1.0.0-preview.20210926</version>
 	</parent>
 
 	<dependencies>
 		<dependency>
 			<groupId>net.thisptr</groupId>
 			<artifactId>jackson-jq</artifactId>
-			<version>1.0.0-preview.20210610</version>
+			<version>1.0.0-preview.20210926</version>
 		</dependency>
 	</dependencies>
 

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/HostnameFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/HostnameFunction.java
@@ -8,13 +8,13 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/RandomFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/RandomFunction.java
@@ -6,13 +6,13 @@
 import com.fasterxml.jackson.databind.node.DoubleNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/StrFTimeFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/StrFTimeFunction.java
@@ -9,15 +9,15 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
 import net.thisptr.jackson.jq.exception.JsonQueryTypeException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
-import net.thisptr.jackson.jq.internal.misc.Preconditions;
+import net.thisptr.jackson.jq.extra.internal.misc.Preconditions;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/StrPTimeFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/StrPTimeFunction.java
@@ -10,15 +10,15 @@
 import com.fasterxml.jackson.databind.node.LongNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
 import net.thisptr.jackson.jq.exception.JsonQueryTypeException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
-import net.thisptr.jackson.jq.internal.misc.Preconditions;
+import net.thisptr.jackson.jq.extra.internal.misc.Preconditions;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/TimestampFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/TimestampFunction.java
@@ -6,13 +6,13 @@
 import com.fasterxml.jackson.databind.node.LongNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/UriDecodeFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/UriDecodeFunction.java
@@ -9,14 +9,14 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
-import net.thisptr.jackson.jq.internal.misc.Preconditions;
+import net.thisptr.jackson.jq.extra.internal.misc.Preconditions;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/UriParseFunction.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/UriParseFunction.java
@@ -18,14 +18,14 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
-import net.thisptr.jackson.jq.internal.misc.Preconditions;
+import net.thisptr.jackson.jq.extra.internal.misc.Preconditions;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/Uuid4Function.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/functions/Uuid4Function.java
@@ -7,13 +7,13 @@
 import com.fasterxml.jackson.databind.node.TextNode;
 import com.google.auto.service.AutoService;
 
+import net.thisptr.jackson.jq.BuiltinFunction;
 import net.thisptr.jackson.jq.Expression;
 import net.thisptr.jackson.jq.Function;
 import net.thisptr.jackson.jq.PathOutput;
 import net.thisptr.jackson.jq.Scope;
 import net.thisptr.jackson.jq.Version;
 import net.thisptr.jackson.jq.exception.JsonQueryException;
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
 import net.thisptr.jackson.jq.path.Path;
 
 @AutoService(Function.class)

diff --git a/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/internal/misc/Preconditions.java b/jackson-jq-extra/src/main/java/net/thisptr/jackson/jq/extra/internal/misc/Preconditions.java
@@ -0,0 +1,19 @@
+package net.thisptr.jackson.jq.extra.internal.misc;
+
+import java.util.Arrays;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.JsonNodeType;
+
+import net.thisptr.jackson.jq.exception.IllegalJsonInputException;
+
+public class Preconditions {
+
+	public static void checkInputType(final String fname, final JsonNode in, final JsonNodeType... types) throws IllegalJsonInputException {
+		final JsonNodeType t = in.getNodeType();
+		for (final JsonNodeType type : types)
+			if (t == type)
+				return;
+		throw new IllegalJsonInputException(String.format("%s is not applicable to %s; expected one of %s", fname, in.getNodeType(), Arrays.toString(types)));
+	}
+}
diff --git a/jackson-jq/pom.xml b/jackson-jq/pom.xml
@@ -8,14 +8,14 @@
 	<parent>
 		<groupId>net.thisptr</groupId>
 		<artifactId>jackson-jq-parent</artifactId>
-		<version>1.0.0-preview.20210610</version>
+		<version>1.0.0-preview.20210926</version>
 	</parent>
 
 	<dependencies>
 		<dependency>
 			<groupId>org.jruby.joni</groupId>
 			<artifactId>joni</artifactId>
-			<version>2.1.29</version>
+			<version>2.1.41</version>
 		</dependency>
 		<dependency>
 			<groupId>com.google.guava</groupId>

diff --git a/jackson-jq/src/main/java/net/thisptr/jackson/jq/BuiltinFunction.java b/jackson-jq/src/main/java/net/thisptr/jackson/jq/BuiltinFunction.java
@@ -0,0 +1,14 @@
+package net.thisptr.jackson.jq;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface BuiltinFunction {
+	String[] value();
+
+	String version() default "";
+}
diff --git a/jackson-jq/src/main/java/net/thisptr/jackson/jq/BuiltinFunctionLoader.java b/jackson-jq/src/main/java/net/thisptr/jackson/jq/BuiltinFunctionLoader.java
@@ -17,8 +17,6 @@
 import com.fasterxml.jackson.databind.MappingIterator;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-
-import net.thisptr.jackson.jq.internal.BuiltinFunction;
 import net.thisptr.jackson.jq.internal.IsolatedScopeQuery;
 import net.thisptr.jackson.jq.internal.JsonQueryFunction;
 import net.thisptr.jackson.jq.internal.javacc.ExpressionParser;
@@ -78,8 +76,8 @@ private static String resolvePath(final Class<?> clazz, final String name) {
 	 */
 	public Map<String, Function> listFunctions(final ClassLoader classLoader, final Version version, final Scope closureScope) {
 		final Map<String, Function> functions = new HashMap<>();
-		loadMacros(functions, classLoader, version, closureScope);
-		loadBuiltinFunctions(functions, version, classLoader);
+		functions.putAll(loadFunctionsFromJsonJq(classLoader, version, closureScope));
+		functions.putAll(loadFunctionsFromServiceLoader(classLoader, version));
 		return functions;
 	}
 
@@ -119,23 +117,58 @@ private static List<JqJson> loadConfig(final ClassLoader loader, final String pa
 		return result;
 	}
 
-	private void loadBuiltinFunctions(final Map<String, Function> functions, final Version version, final ClassLoader classLoader) {
+	private static String[] extractFunctionNamesFromAnnotationIfVersionMatch(Function fn, final Version version) {
+		final net.thisptr.jackson.jq.BuiltinFunction annotation = fn.getClass().getAnnotation(net.thisptr.jackson.jq.BuiltinFunction.class);
+		if (annotation == null)
+			return null;
+		if (!annotation.version().isEmpty()) {
+			final VersionRange range = VersionRange.valueOf(annotation.version());
+			if (!range.contains(version))
+				return new String[0];
+		}
+		return annotation.value();
+	}
+
+	@SuppressWarnings("deprecation")
+	private static String[] extractFunctionNamesFromDeprecatedAnnotationIfVersionMatch(Function fn, final Version version) {
+		final net.thisptr.jackson.jq.internal.BuiltinFunction annotation = fn.getClass().getAnnotation(net.thisptr.jackson.jq.internal.BuiltinFunction.class);
+		if (annotation == null)
+			return null;
+		if (!annotation.version().isEmpty()) {
+			final VersionRange range = VersionRange.valueOf(annotation.version());
+			if (!range.contains(version))
+				return new String[0];
+		}
+		return annotation.value();
+	}
+
+	/**
+	 * Do not use this method. This method is only for Quarkus extension.
+	 */
+	public Map<String, Function> loadFunctionsFromServiceLoader(final ClassLoader classLoader, final Version version) {
+		final Map<String, Function> functions = new HashMap<>();
 		for (final Function fn : ServiceLoader.load(Function.class, classLoader)) {
-			final BuiltinFunction annotation = fn.getClass().getAnnotation(BuiltinFunction.class);
-			if (annotation == null)
-				continue;
-			if (!annotation.version().isEmpty()) {
-				final VersionRange range = VersionRange.valueOf(annotation.version());
-				if (!range.contains(version))
-					continue;
+			String[] names = extractFunctionNamesFromAnnotationIfVersionMatch(fn, version);
+			if (names == null) { // i.e. if annotation is missing,
+				// Look for deprecated annotation as well for compatibility reasons. TODO: Delete this in 1.0.0 release.
+				names = extractFunctionNamesFromDeprecatedAnnotationIfVersionMatch(fn, version);
 			}
-			for (final String name : annotation.value())
+
+			if (names == null) // i.e. no annotations found
+				continue;
+
+			for (final String name : names)
 				functions.put(name, fn);
 		}
+		return functions;
 	}
 
-	private void loadMacros(final Map<String, Function> functions, final ClassLoader classLoader, final Version version, final Scope closureScope) {
+	/**
+	 * Do not use this method. This method is only for Quarkus extension.
+	 */
+	public Map<String, Function> loadFunctionsFromJsonJq(final ClassLoader classLoader, final Version version, final Scope closureScope) {
 		try {
+			final Map<String, Function> functions = new HashMap<>();
 			final List<JqJson> configs = loadConfig(classLoader, CONFIG_PATH);
 			for (final JqJson jqJson : configs) {
 				for (final JqJson.JqFuncDef def : jqJson.functions) {
@@ -144,6 +177,7 @@ private void loadMacros(final Map<String, Function> functions, final ClassLoader
 					functions.put(def.name + "/" + def.args.size(), new JsonQueryFunction(def.name, def.args, new IsolatedScopeQuery(ExpressionParser.compile(def.body, version)), closureScope));
 				}
 			}
+			return functions;
 		} catch (final IOException e) {
 			throw new RuntimeException("Failed to load macros", e);
 		}

diff --git a/jackson-jq/src/main/java/net/thisptr/jackson/jq/internal/BuiltinFunction.java b/jackson-jq/src/main/java/net/thisptr/jackson/jq/internal/BuiltinFunction.java
@@ -5,8 +5,12 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * @deprecated Use {@link net.thisptr.jackson.jq.BuiltinFunction} instead.
+ */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
+@Deprecated
 public @interface BuiltinFunction {
 	String[] value();