diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..430a902 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,51 @@ +version: '2.1' +orbs: + jvm: sailthru/jvm@0.4.3 + +parameters: + publish_snapshot: + description: Flag indicating a SNAPSHOT version should be built for this branch + type: boolean + default: false + +workflows: + build: + unless: << pipeline.parameters.publish_snapshot >> + jobs: + - jvm/test: + context: + - Docker Hub + - Nexus Credentials + filters: + branches: + only: /.*/ + tags: + ignore: /.*/ + + publish: + jobs: + - jvm/publish_jar: + context: + - Docker Hub + - Nexus Credentials + filters: + branches: + ignore: /.*/ + tags: + only: /^v\d+.\d+.\d+$/ + version: ${CIRCLE_TAG} + + publish_snapshot: + when: << pipeline.parameters.publish_snapshot >> + jobs: + - jvm/publish_jar: + name: Publish SNAPSHOT JAR + context: + - Docker Hub + filters: + branches: + only: /.*/ + tags: + ignore: /.*/ + # add "v" in front so the branch is > than actual version tags + version: v${CIRCLE_BRANCH}-SNAPSHOT diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index fca139e..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Build - -on: - pull_request: - branches: [ main, master ] - -jobs: - build: - runs-on: ubuntu-latest - environment: snapshot - steps: - - uses: actions/checkout@v4 - - name: Set up JDK 8 - uses: actions/setup-java@v3 - with: - java-version: '8' - distribution: 'temurin' - cache: 'gradle' - - name: Setup Gradle - uses: gradle/gradle-build-action@v2 - with: - cache-read-only: false - gradle-home-cache-cleanup: true - - name: Build - run: ./gradlew build \ No newline at end of file diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml deleted file mode 100644 index cbaf61e..0000000 --- a/.github/workflows/publish.yml +++ /dev/null @@ -1,63 +0,0 @@ -name: Publish - -on: - push: - branches: [ main ] - -jobs: - publish: - runs-on: ubuntu-latest - environment: production - steps: - - uses: actions/checkout@v4 - - name: Set up JDK 8 - uses: actions/setup-java@v3 - with: - java-version: '8' - distribution: 'temurin' - cache: 'gradle' - - name: Setup Gradle - uses: gradle/gradle-build-action@v2 - - name: Set release version - run: | - # Remove -SNAPSHOT from version - sed -i 's/\(version "[0-9.]*\)-SNAPSHOT"/\1"/' build.gradle - - name: Publish package - env: - SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }} - SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }} - SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }} - SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }} - SIGNING_KEY: ${{ secrets.SIGNING_KEY }} - run: | - ./gradlew build uploadArchives - - name: Bump version - id: bump_version - run: | - # Get current version without SNAPSHOT - CURRENT_VERSION=$(grep "version" build.gradle | sed 's/version "\(.*\)"/\1/') - - # Split into parts - IFS='.' read -ra VERSION_PARTS <<< "$CURRENT_VERSION" - - # Increment patch version - NEXT_PATCH=$((VERSION_PARTS[2] + 1)) - - # Create new version - NEXT_VERSION="${VERSION_PARTS[0]}.${VERSION_PARTS[1]}.$NEXT_PATCH-SNAPSHOT" - - # Update build.gradle - sed -i "s/version \".*\"/version \"$NEXT_VERSION\"/" build.gradle - - # Make the new version available to other steps - echo "next_version=$NEXT_VERSION" >> $GITHUB_OUTPUT - - name: Commit version bump - env: - NEXT_VERSION: ${{ steps.bump_version.outputs.next_version }} - run: | - git config user.name "github-actions[bot]" - git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - git add --all - git commit -m "Prepare version $NEXT_VERSION for development [skip ci]" - git pull --rebase origin main - git push origin HEAD:main \ No newline at end of file diff --git a/README.md b/README.md index cb92eb5..0fe339a 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ JsonLogic is documented extensively at [JsonLogic.com](http://jsonlogic.com), in ```xml - io.github.jamsesso + com.sailthru json-logic-java - 1.1.0 + 2.0.0 ``` @@ -56,3 +56,47 @@ assert JsonLogic.truthy("Hello world!") == true; // etc... ``` + +## Usage: + +### Update dependencies: +```bash +./gradlew dependencies --write-locks +``` + +### Local testing +To "publish" a version locally for testing run: +```bash +./gradlew publishToMavenLocal +``` + +This will publish a copy of the library to maven local that will be accessible within other libraries/services. + +Inside your other project update the version of the dependency to `vSANDBOX` to access the library. + +For example: +``` +implementation("com.sailthru:json-logic-java:v2.0.0") +// Becomes +implementation("com.sailthru:json-logic-java:vSANDBOX") +``` + +## Contents: +This template contains the bare minimal requirements to create and publish a Java library. + +### CI/CD +CI/CD is provided by CircleCI. Specifically the [Sailthru JVM orb](https://circleci.com/developer/orbs/orb/sailthru/jvm). + +Every branch is tested using the `./gradlew check` command. + +To publish a release you must [create a GitHub Release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release). +Within this release you will need to create a semantic version tag in the format `vMAJOR.MINOR.PATCH` for example `v1.0.1`. + +Once a tag is created CircleCI will automatically detect this and publish the JAR to [CodeArtifact](https://us-east-1.console.aws.amazon.com/codesuite/codeartifact/d/680305091011/sailthru/r/maven). + +### Gradle +Most Gradle logic will be contained within our [Sailthru gradle plugin (gradle-config)](https://github.com/sailthru/gradle-config). + +All projects require dependency locking, connecting to CodeArtifact as a source, and to use Checkstyle (this can be disabled if required). + +Library projects also include support to publish to CodeArtifact. diff --git a/build.gradle b/build.gradle index d3cd452..85358d4 100644 --- a/build.gradle +++ b/build.gradle @@ -1,110 +1,19 @@ +import com.sailthru.gradle.ProjectType + plugins { - id "java" - id "maven" - id "signing" + id("java-library") + id("com.sailthru.gradle") version("v0.16.0") } -group "io.github.jamsesso" -version "1.1.1-SNAPSHOT" - -sourceCompatibility = 1.8 -targetCompatibility = 1.8 - -repositories { - mavenCentral() -} +group "com.sailthru" dependencies { - compile "com.google.code.gson:gson:2.8.5" - testCompile "junit:junit:4.12" -} - -task javadocJar(type: Jar, dependsOn: javadoc) { - classifier = "javadoc" - from javadoc.destinationDir -} - -task sourcesJar(type: Jar) { - classifier = "sources" - from sourceSets.main.allSource -} - -test { - testLogging { - events "passed", "skipped", "failed" - exceptionFormat "full" - showStandardStreams = true - } -} - -artifacts { - archives jar, javadocJar, sourcesJar -} - -def getSonatypeUsername() { - return System.getenv('SONATYPE_USERNAME') -} - -def getSonatypePassword() { - return System.getenv('SONATYPE_PASSWORD') -} - -def hasCredentials() { - def result = getSonatypeUsername() != null && getSonatypePassword() != null - if (!result) { - println "Cannot publish package since Sonatype credentials are not set. Please set SONATYPE_USERNAME and SONATYPE_PASSWORD environment variables." - } - return result -} - -signing { - required { gradle.taskGraph.hasTask("uploadArchives") } - useInMemoryPgpKeys(System.getenv('SIGNING_KEY'), System.getenv('SIGNING_PASSWORD')) - sign configurations.archives + implementation('com.google.code.gson:gson:2.13.1') + testImplementation('junit:junit:4.13.2') } -uploadArchives { - repositories { - mavenDeployer { - beforeDeployment { deployment -> signing.signPom(deployment) } - - repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") { - authentication(userName: getSonatypeUsername(), password: getSonatypePassword()) - } - - snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") { - authentication(userName: getSonatypeUsername(), password: getSonatypePassword()) - } - - pom.project { - name "json-logic-java" - artifactId "json-logic-java" - packaging "jar" - description "A native Java implementation of the json-logic project" - url "https://github.com/jamsesso/json-logic-java" - - scm { - connection "scm:git@github.com:jamsesso/json-logic-java.git" - developerConnection "scm:git@github.com:jamsesso/json-logic-java.git" - url "https://github.com/jamsesso/json-logic-java.git" - } - - licenses { - license { - name "MIT License" - url "https://github.com/jamsesso/json-logic-java/blob/master/LICENSE" - } - } - - developers { - developer { - id "jamsesso" - name "Sam Jesso" - email "samuel.jesso@gmail.com" - } - } - } - } - } - onlyIf { hasCredentials() } +sailthru { + type = ProjectType.LIBRARY + javaVersion = JavaVersion.VERSION_1_8 + checkstyleEnabled = false } diff --git a/gradle.lockfile b/gradle.lockfile new file mode 100644 index 0000000..ff352d8 --- /dev/null +++ b/gradle.lockfile @@ -0,0 +1,23 @@ +# This is a Gradle generated file for dependency locking. +# Manual edits can break the build and are not advised. +# This file is expected to be part of source control. +com.google.code.findbugs:jsr305:3.0.2=checkstyle +com.google.code.gson:gson:2.13.1=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath +com.google.errorprone:error_prone_annotations:2.38.0=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath +com.google.errorprone:error_prone_annotations:2.7.1=checkstyle +com.google.guava:failureaccess:1.0.1=checkstyle +com.google.guava:guava:31.0.1-jre=checkstyle +com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava=checkstyle +com.google.j2objc:j2objc-annotations:1.3=checkstyle +com.puppycrawl.tools:checkstyle:9.3=checkstyle +commons-beanutils:commons-beanutils:1.9.4=checkstyle +commons-collections:commons-collections:3.2.2=checkstyle +info.picocli:picocli:4.6.2=checkstyle +junit:junit:4.13.2=testCompileClasspath,testRuntimeClasspath +net.sf.saxon:Saxon-HE:10.6=checkstyle +org.antlr:antlr4-runtime:4.9.3=checkstyle +org.checkerframework:checker-qual:3.12.0=checkstyle +org.hamcrest:hamcrest-core:1.3=testCompileClasspath,testRuntimeClasspath +org.javassist:javassist:3.28.0-GA=checkstyle +org.reflections:reflections:0.10.2=checkstyle +empty=annotationProcessor,testAnnotationProcessor diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..d3c26f1 --- /dev/null +++ b/gradle.properties @@ -0,0 +1 @@ +version=vSANDBOX diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 01b8bf6..1b33c55 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 1ff5349..d4081da 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,7 @@ -#Mon Jul 02 21:26:44 ADT 2018 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-bin.zip \ No newline at end of file diff --git a/gradlew b/gradlew index cccdd3d..23d15a9 100755 --- a/gradlew +++ b/gradlew @@ -1,78 +1,129 @@ -#!/usr/bin/env sh +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null - -APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar +CLASSPATH="\\\"\\\"" + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -81,92 +132,120 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." + fi fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=$((i+1)) + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=$(save "$@") - -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" fi +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index e95643d..5eed7ee 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,4 +1,22 @@ -@if "%DEBUG%" == "" @echo off +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -9,25 +27,29 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if %ERRORLEVEL% equ 0 goto execute -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail @@ -35,48 +57,36 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar +set CLASSPATH= + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 0 goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/settings.gradle b/settings.gradle index ea28c84..7f86262 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,15 @@ -rootProject.name = 'json-logic-java' +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + maven { + url = uri("https://sailthru-680305091011.d.codeartifact.us-east-1.amazonaws.com/maven/maven/") + credentials { + username = "aws" + password = System.getenv("CODEARTIFACT_AUTH_TOKEN") + } + } + } +} +rootProject.name = 'json-logic-java' diff --git a/src/main/java/io/github/jamsesso/jsonlogic/evaluator/JsonLogicEvaluator.java b/src/main/java/io/github/jamsesso/jsonlogic/evaluator/JsonLogicEvaluator.java index d78892b..e15fbb0 100644 --- a/src/main/java/io/github/jamsesso/jsonlogic/evaluator/JsonLogicEvaluator.java +++ b/src/main/java/io/github/jamsesso/jsonlogic/evaluator/JsonLogicEvaluator.java @@ -6,6 +6,10 @@ import java.util.*; public class JsonLogicEvaluator { + + /** Sentinel object to represent a missing value (for internal use only). */ + private static final Object MISSING = new Object(); + private final Map expressions; public JsonLogicEvaluator(Collection expressions) { @@ -82,8 +86,10 @@ public Object evaluate(JsonLogicVariable variable, Object data, String jsonPath) for (String partial : keys) { result = evaluatePartialVariable(partial, result, jsonPath + "[0]"); - if (result == null) { + if (result == MISSING) { return defaultValue; + } else if (result == null) { + return null; } } @@ -106,14 +112,19 @@ private Object evaluatePartialVariable(String key, Object data, String jsonPath) } if (index < 0 || index >= list.size()) { - return null; + return MISSING; } return transform(list.get(index)); } if (data instanceof Map) { - return transform(((Map) data).get(key)); + Map map = (Map) data; + if (map.containsKey(key)) { + return transform(map.get(key)); + } else { + return MISSING; + } } return null; diff --git a/src/test/java/io/github/jamsesso/jsonlogic/VariableTests.java b/src/test/java/io/github/jamsesso/jsonlogic/VariableTests.java index 9a4e98f..980fc58 100644 --- a/src/test/java/io/github/jamsesso/jsonlogic/VariableTests.java +++ b/src/test/java/io/github/jamsesso/jsonlogic/VariableTests.java @@ -3,12 +3,15 @@ import org.junit.Test; import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; public class VariableTests { private static final JsonLogic jsonLogic = new JsonLogic(); @@ -99,4 +102,115 @@ public void testComplexAccess() throws JsonLogicException { assertEquals("Jane", jsonLogic.apply("{\"var\": \"users.1.name\"}", data)); assertEquals(2048.0, jsonLogic.apply("{\"var\": \"users.1.followers\"}", data)); } + + @Test + public void missingNestedMapKey_returnsDefault() throws JsonLogicException { + // data.a.b is missing -> should use default + String rule = "{\"var\": [\"a.b.c\", \"fallback\"]}"; + Map data = map("a", map("b", new HashMap<>())); + + Object result = jsonLogic.apply(rule, data); + + assertEquals("fallback", result); + } + + @Test + public void presentNullLeaf_returnsNull_notDefault() throws JsonLogicException { + // data.user.age present with value null -> should return null (no default) + String rule = "{\"var\": [\"user.age\", 42]}"; + Map user = new HashMap<>(); + user.put("age", null); + Map data = map("user", user); + + Object result = jsonLogic.apply(rule, data); + + assertNull(result); + } + + @Test + public void intermediateNull_returnsNull_notDefault() throws JsonLogicException { + // data.a.b is null before finishing path -> should return null (no default) + String rule = "{\"var\": [\"a.b.c\", \"fallback\"]}"; + Map data = map("a", map("b", null)); + + Object result = jsonLogic.apply(rule, data); + + assertNull(result); + } + + @Test + public void nonTraversableIntermediate_returnsNull_notDefault() throws JsonLogicException { + // data.a is a number; trying to access a.b -> should return null (no default) + String rule = "{\"var\": [\"a.b\", \"fallback\"]}"; + Map data = map("a", 5); + + Object result = jsonLogic.apply(rule, data); + + assertNull(result); + } + + @Test + public void arrayIndexWithinBounds_returnsElement_asDoubleForNumbers() throws JsonLogicException { + // items.1 exists -> should return 20 (as a double per evaluator.transform) + String rule = "{\"var\": [\"items.1\", 999]}"; + Map data = map("items", Arrays.asList(10, 20)); + + Object result = jsonLogic.apply(rule, data); + + assertTrue(result instanceof Number); + assertEquals(20.0, ((Number) result).doubleValue(), 0.0); + } + + @Test + public void arrayIndexOutOfBounds_returnsDefault() throws JsonLogicException { + // items.2 missing -> use default + String rule = "{\"var\": [\"items.2\", \"missing\"]}"; + Map data = map("items", Arrays.asList(10, 20)); + + Object result = jsonLogic.apply(rule, data); + + assertEquals("missing", result); + } + + @Test + public void arrayElementPresentButNull_returnsNull_notDefault() throws JsonLogicException { + // items.0 exists and is null -> should return null (no default) + String rule = "{\"var\": [\"items.0\", \"missing\"]}"; + Map data = map("items", Collections.singletonList(null)); + + Object result = jsonLogic.apply(rule, data); + + assertNull(result); + } + + @Test + public void topLevelNumericIndex_overList_works() throws JsonLogicException { + // {"var": [1, "missing"]} over a top-level list -> "banana" + String rule = "{\"var\": [1, \"missing\"]}"; + List data = Arrays.asList("apple", "banana", "carrot"); + + Object result = jsonLogic.apply(rule, data); + + assertEquals("banana", result); + } + + @Test + public void emptyVarKey_returnsWholeDataObject() throws JsonLogicException { + // {"var": ""} should return the entire data object (same instance) + String rule = "{\"var\": \"\"}"; + Map data = map("x", 1); + + Object result = jsonLogic.apply(rule, data); + + assertSame("Should return the same data instance", data, result); + } + + /** Helper to make small maps concisely. */ + private static Map map(Object... kv) { + Map m = new HashMap<>(); + for (int i = 0; i < kv.length; i += 2) { + m.put((String) kv[i], kv[i + 1]); + } + return m; + } }