diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml index be5ea0d..fa9b896 100644 --- a/.github/workflows/develop.yml +++ b/.github/workflows/develop.yml @@ -1,13 +1,18 @@ # This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time -# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven -name: Build +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Dev Build on: push: - branches: [ develop ] + branches: [ "develop" ] pull_request: - branches: [ develop ] + branches: [ "develop" ] jobs: build: @@ -15,16 +20,11 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up JDK - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: - java-version: '21' + java-version: '24' distribution: 'temurin' - cache: maven - server-id: github # Value of the distributionManagement/repository/id field of the pom.xml - settings-path: ${{ github.workspace }} # location for the settings.xml file - - name: Code Quality Checks - run: ./mvnw -B jacoco:prepare-agent test jacoco:report -s $GITHUB_WORKSPACE/settings.xml --file pom.xml - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + - name: Quality Check + run: mvn -B jacoco:prepare-agent install jacoco:report --file pom.xml \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..3b07cf3 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,30 @@ +# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Java CI + +on: + push: + branches: [ "main" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up JDK + uses: actions/setup-java@v4 + with: + java-version: '24' + distribution: 'temurin' + - name: Publish to GitHub Maven Repository + run: ./mvnw -DskipTests -Dcheckstyle.skip deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties index eacdc9e..d58dfb7 100644 --- a/.mvn/wrapper/maven-wrapper.properties +++ b/.mvn/wrapper/maven-wrapper.properties @@ -14,5 +14,6 @@ # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. -distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip -wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip diff --git a/README.md b/README.md index be565e8..cfa90c0 100644 --- a/README.md +++ b/README.md @@ -2,51 +2,48 @@ # SJson -SJson is a **lightweight tailer made json parser for server side workloads**. It tries to get optimized memory and performance with below goals. +> **SJson** is a lightweight, high-performance JSON parser built for server-side Java. Designed for REST APIs and microservices, it delivers faster parsing with lower memory usage using native Java structures. -## Design Goals +## Why Use SJson? -1. Optimized for Serialization, Deserialization and validation. -2. Represent Json in native java format. -3. No external dependencies -4. Trust the validity of json documents. It is just enough to say invalid, reasoning is optional -5. Utilize latest java features +- Optimized for fast serialization & deserialization +- No external dependencies. Uses native Java types (`Map`, `List`, etc.) +- Assumes valid JSON (minimal validation overhead) +- Clean, modern, and extendable Java code -**Note:** This is **not** general purpose parser. This is specifically written for REST API use cases. +### Use cases -1. Service to Service Communications in microservices -2. Client SDK such as Elastic REST Client. +- **Microservices:** Service-to-service communication +- **Client SDKs:** Lightweight JSON processing (e.g., Elastic clients) +- **Data Engineering:** ETL pipelines, streaming ingestion, compact intermediate JSON parsing ## Usage -Include below in your pom.xml +Add dependency to your project +### Maven ```xml - com.techatpark.sjson - json-parser - 1.0.0 - + com.techatpark.sjson + json-parser + {{version}} + ``` - -To read JSON as Java Object - -```java - Json json = Json; - Object obj = json.read(new StringReader("{ \"abc\" : \"def\" }")); +### Gradle +```groovy +implementation 'com.techatpark.sjson:json-parser:{{version}}' ``` -## Development +You can now perform serialization & deserialization -Below VM Options should be added for JVM. This is required to calculate the size of the objects +```java +Object obj = Json.parse(Reader.of("{ \"abc\" : \"def\" }")); // Map -```shell --javaagent:<>/jamm-0.4.1.jar --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.math=ALL-UNNAMED +String jsonString = Json.stringify(obj); ``` -## How it works -SJson was part of the tech talk series at Bangalore Opensource Java User Group. This will give an idea behind this work. +## Reference -1. Setup : https://www.youtube.com/watch?v=q_1H8ZJceA8 -2. Optimization: https://www.youtube.com/watch?v=XMRaLCRfvlQ -3. Collection: https://www.youtube.com/watch?v=tMgy5PxPFQ4 +- https://www.youtube.com/watch?v=NSzRK8f7EX0&pp=ygUSSlNPTiBBUEkgQ29yZSBKYXZh +- https://www.youtube.com/watch?v=W8k9ZCrsphc&t=448s +- https://www.youtube.com/watch?v=R8Xubleffr8 \ No newline at end of file diff --git a/mvnw b/mvnw index 8d937f4..19529dd 100755 --- a/mvnw +++ b/mvnw @@ -19,290 +19,241 @@ # ---------------------------------------------------------------------------- # ---------------------------------------------------------------------------- -# Apache Maven Wrapper startup batch script, version 3.2.0 -# -# Required ENV vars: -# ------------------ -# JAVA_HOME - location of a JDK home dir +# Apache Maven Wrapper startup batch script, version 3.3.2 # # Optional ENV vars # ----------------- -# MAVEN_OPTS - parameters passed to the Java VM when running Maven -# e.g. to debug Maven itself, use -# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output # ---------------------------------------------------------------------------- -if [ -z "$MAVEN_SKIP_RC" ] ; then - - if [ -f /usr/local/etc/mavenrc ] ; then - . /usr/local/etc/mavenrc - fi - - if [ -f /etc/mavenrc ] ; then - . /etc/mavenrc - fi - - if [ -f "$HOME/.mavenrc" ] ; then - . "$HOME/.mavenrc" - fi - -fi +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x -# OS specific support. $var _must_ be set to either true or false. -cygwin=false; -darwin=false; -mingw=false +# OS specific support. +native_path() { printf %s\\n "$1"; } case "$(uname)" in - CYGWIN*) cygwin=true ;; - MINGW*) mingw=true;; - Darwin*) darwin=true - # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home - # See https://developer.apple.com/library/mac/qa/qa1170/_index.html - if [ -z "$JAVA_HOME" ]; then - if [ -x "/usr/libexec/java_home" ]; then - JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME - else - JAVA_HOME="/Library/Java/Home"; export JAVA_HOME - fi - fi - ;; +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; esac -if [ -z "$JAVA_HOME" ] ; then - if [ -r /etc/gentoo-release ] ; then - JAVA_HOME=$(java-config --jre-home) - fi -fi - -# For Cygwin, ensure paths are in UNIX format before anything is touched -if $cygwin ; then - [ -n "$JAVA_HOME" ] && - JAVA_HOME=$(cygpath --unix "$JAVA_HOME") - [ -n "$CLASSPATH" ] && - CLASSPATH=$(cygpath --path --unix "$CLASSPATH") -fi - -# For Mingw, ensure paths are in UNIX format before anything is touched -if $mingw ; then - [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && - JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" -fi - -if [ -z "$JAVA_HOME" ]; then - javaExecutable="$(which javac)" - if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then - # readlink(1) is not available as standard on Solaris 10. - readLink=$(which readlink) - if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then - if $darwin ; then - javaHome="$(dirname "\"$javaExecutable\"")" - javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" - else - javaExecutable="$(readlink -f "\"$javaExecutable\"")" - fi - javaHome="$(dirname "\"$javaExecutable\"")" - javaHome=$(expr "$javaHome" : '\(.*\)/bin') - JAVA_HOME="$javaHome" - export JAVA_HOME - fi - fi -fi - -if [ -z "$JAVACMD" ] ; then - if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" else JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi fi else - JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" - fi -fi - -if [ ! -x "$JAVACMD" ] ; then - echo "Error: JAVA_HOME is not defined correctly." >&2 - echo " We cannot execute $JAVACMD" >&2 - exit 1 -fi + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : -if [ -z "$JAVA_HOME" ] ; then - echo "Warning: JAVA_HOME environment variable is not set." -fi - -# traverses directory structure from process work directory to filesystem root -# first directory with .mvn subdirectory is considered project base directory -find_maven_basedir() { - if [ -z "$1" ] - then - echo "Path not specified to find_maven_basedir" - return 1 + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi fi +} - basedir="$1" - wdir="$1" - while [ "$wdir" != '/' ] ; do - if [ -d "$wdir"/.mvn ] ; then - basedir=$wdir - break - fi - # workaround for JBEAP-8937 (on Solaris 10/Sparc) - if [ -d "${wdir}" ]; then - wdir=$(cd "$wdir/.." || exit 1; pwd) - fi - # end of workaround +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" done - printf '%s' "$(cd "$basedir" || exit 1; pwd)" + printf %x\\n $h } -# concatenates all lines of a file -concat_lines() { - if [ -f "$1" ]; then - # Remove \r in case we run on Windows within Git Bash - # and check out the repository with auto CRLF management - # enabled. Otherwise, we may read lines that are delimited with - # \r\n and produce $'-Xarg\r' rather than -Xarg due to word - # splitting rules. - tr -s '\r\n' ' ' < "$1" - fi +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 } -log() { - if [ "$MVNW_VERBOSE" = true ]; then - printf '%s\n' "$1" - fi +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" } -BASE_DIR=$(find_maven_basedir "$(dirname "$0")") -if [ -z "$BASE_DIR" ]; then - exit 1; +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" fi -MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR -log "$MAVEN_PROJECTBASEDIR" +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac -########################################################################################## -# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central -# This allows using the maven wrapper in projects that prohibit checking in binary data. -########################################################################################## -wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" -if [ -r "$wrapperJarPath" ]; then - log "Found $wrapperJarPath" +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT else - log "Couldn't find $wrapperJarPath, downloading it ..." + die "cannot create temp dir" +fi - if [ -n "$MVNW_REPOURL" ]; then - wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" - else - wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" - fi - while IFS="=" read -r key value; do - # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) - safeValue=$(echo "$value" | tr -d '\r') - case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; - esac - done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" - log "Downloading from: $wrapperUrl" +mkdir -p -- "${MAVEN_HOME%/*}" - if $cygwin; then - wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") - fi +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" - if command -v wget > /dev/null; then - log "Found wget ... using wget" - [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" - if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then - wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" - else - wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" - fi - elif command -v curl > /dev/null; then - log "Found curl ... using curl" - [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" - if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then - curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" - else - curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" - fi - else - log "Falling back to using Java to download" - javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" - javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" - # For Cygwin, switch paths to Windows format before running javac - if $cygwin; then - javaSource=$(cygpath --path --windows "$javaSource") - javaClass=$(cygpath --path --windows "$javaClass") - fi - if [ -e "$javaSource" ]; then - if [ ! -e "$javaClass" ]; then - log " - Compiling MavenWrapperDownloader.java ..." - ("$JAVA_HOME/bin/javac" "$javaSource") - fi - if [ -e "$javaClass" ]; then - log " - Running MavenWrapperDownloader.java ..." - ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" - fi - fi - fi +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" fi -########################################################################################## -# End of extension -########################################################################################## -# If specified, validate the SHA-256 sum of the Maven wrapper jar file -wrapperSha256Sum="" -while IFS="=" read -r key value; do - case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; - esac -done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" -if [ -n "$wrapperSha256Sum" ]; then - wrapperSha256Result=false - if command -v sha256sum > /dev/null; then - if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then - wrapperSha256Result=true +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then + distributionSha256Result=true fi - elif command -v shasum > /dev/null; then - if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then - wrapperSha256Result=true + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true fi else - echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." - echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 exit 1 fi - if [ $wrapperSha256Result = false ]; then - echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 - echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 - echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 exit 1 fi fi -MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" - -# For Cygwin, switch paths to Windows format before running java -if $cygwin; then - [ -n "$JAVA_HOME" ] && - JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") - [ -n "$CLASSPATH" ] && - CLASSPATH=$(cygpath --path --windows "$CLASSPATH") - [ -n "$MAVEN_PROJECTBASEDIR" ] && - MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" fi +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" -# Provide a "standardized" way to retrieve the CLI args that will -# work with both Windows and non-Windows executions. -MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" -export MAVEN_CMD_LINE_ARGS - -WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain - -# shellcheck disable=SC2086 # safe args -exec "$JAVACMD" \ - $MAVEN_OPTS \ - $MAVEN_DEBUG_OPTS \ - -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ - "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ - ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" +clean || : +exec_maven "$@" diff --git a/mvnw.cmd b/mvnw.cmd index c4586b5..249bdf3 100644 --- a/mvnw.cmd +++ b/mvnw.cmd @@ -1,3 +1,4 @@ +<# : batch portion @REM ---------------------------------------------------------------------------- @REM Licensed to the Apache Software Foundation (ASF) under one @REM or more contributor license agreements. See the NOTICE file @@ -18,188 +19,131 @@ @REM ---------------------------------------------------------------------------- @REM ---------------------------------------------------------------------------- -@REM Apache Maven Wrapper startup batch script, version 3.2.0 -@REM -@REM Required ENV vars: -@REM JAVA_HOME - location of a JDK home dir +@REM Apache Maven Wrapper startup batch script, version 3.3.2 @REM @REM Optional ENV vars -@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands -@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending -@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven -@REM e.g. to debug Maven itself, use -@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output @REM ---------------------------------------------------------------------------- -@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' -@echo off -@REM set title of command window -title %0 -@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' -@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% - -@REM set %HOME% to equivalent of $HOME -if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") - -@REM Execute a user defined script before this one -if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre -@REM check for pre script, once with legacy .bat ending and once with .cmd ending -if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* -if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* -:skipRcPre - -@setlocal - -set ERROR_CODE=0 - -@REM To isolate internal variables from possible post scripts, we use another setlocal -@setlocal - -@REM ==== START VALIDATION ==== -if not "%JAVA_HOME%" == "" goto OkJHome - -echo. -echo Error: JAVA_HOME not found in your environment. >&2 -echo Please set the JAVA_HOME variable in your environment to match the >&2 -echo location of your Java installation. >&2 -echo. -goto error - -:OkJHome -if exist "%JAVA_HOME%\bin\java.exe" goto init - -echo. -echo Error: JAVA_HOME is set to an invalid directory. >&2 -echo JAVA_HOME = "%JAVA_HOME%" >&2 -echo Please set the JAVA_HOME variable in your environment to match the >&2 -echo location of your Java installation. >&2 -echo. -goto error - -@REM ==== END VALIDATION ==== - -:init - -@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". -@REM Fallback to current working directory if not found. - -set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% -IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir - -set EXEC_DIR=%CD% -set WDIR=%EXEC_DIR% -:findBaseDir -IF EXIST "%WDIR%"\.mvn goto baseDirFound -cd .. -IF "%WDIR%"=="%CD%" goto baseDirNotFound -set WDIR=%CD% -goto findBaseDir - -:baseDirFound -set MAVEN_PROJECTBASEDIR=%WDIR% -cd "%EXEC_DIR%" -goto endDetectBaseDir - -:baseDirNotFound -set MAVEN_PROJECTBASEDIR=%EXEC_DIR% -cd "%EXEC_DIR%" - -:endDetectBaseDir - -IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig - -@setlocal EnableExtensions EnableDelayedExpansion -for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a -@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% - -:endReadAdditionalConfig - -SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" -set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" -set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain - -set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" - -FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( - IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B -) - -@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central -@REM This allows using the maven wrapper in projects that prohibit checking in binary data. -if exist %WRAPPER_JAR% ( - if "%MVNW_VERBOSE%" == "true" ( - echo Found %WRAPPER_JAR% - ) -) else ( - if not "%MVNW_REPOURL%" == "" ( - SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" - ) - if "%MVNW_VERBOSE%" == "true" ( - echo Couldn't find %WRAPPER_JAR%, downloading it ... - echo Downloading from: %WRAPPER_URL% - ) - - powershell -Command "&{"^ - "$webclient = new-object System.Net.WebClient;"^ - "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ - "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ - "}"^ - "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ - "}" - if "%MVNW_VERBOSE%" == "true" ( - echo Finished downloading %WRAPPER_JAR% - ) -) -@REM End of extension - -@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file -SET WRAPPER_SHA_256_SUM="" -FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( - IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) ) -IF NOT %WRAPPER_SHA_256_SUM%=="" ( - powershell -Command "&{"^ - "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ - "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ - " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ - " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ - " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ - " exit 1;"^ - "}"^ - "}" - if ERRORLEVEL 1 goto error -) - -@REM Provide a "standardized" way to retrieve the CLI args that will -@REM work with both Windows and non-Windows executions. -set MAVEN_CMD_LINE_ARGS=%* - -%MAVEN_JAVA_EXE% ^ - %JVM_CONFIG_MAVEN_PROPS% ^ - %MAVEN_OPTS% ^ - %MAVEN_DEBUG_OPTS% ^ - -classpath %WRAPPER_JAR% ^ - "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ - %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* -if ERRORLEVEL 1 goto error -goto end - -:error -set ERROR_CODE=1 - -:end -@endlocal & set ERROR_CODE=%ERROR_CODE% - -if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost -@REM check for post script, once with legacy .bat ending and once with .cmd ending -if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" -if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" -:skipRcPost - -@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' -if "%MAVEN_BATCH_PAUSE%"=="on" pause - -if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% - -cmd /C exit /B %ERROR_CODE% +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' +$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/pom.xml b/pom.xml index 9c3ac9d..056859e 100644 --- a/pom.xml +++ b/pom.xml @@ -52,23 +52,25 @@ - 21 - 21 + 24 + ${java.version} + ${java.version} + 3.1.1 0.4.1 - 2.18.3 - 2.12.1 - 20250107 - 5.13.0-M1 - 1.4.0 - 5.0.0.4389 - 3.5.2 - 0.8.12 + 2.20.0-rc1 + 2.13.1 + 20250517 + 5.13.4 + 1.4.1 + 5.1.0.4751 + 3.5.3 + 0.8.13 3.6.0 2.5.3 3.3.1 3.0.1 3.2.1 - 10.21.4 + 11.0.0 -javaagent:${user.home}/.m2/repository/io/github/stephankoelle/jamm/${jamm.version}/jamm-${jamm.version}.jar --add-opens java.base/java.util=ALL-UNNAMED --add-opens jakarta.validation/jakarta.validation=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens @@ -94,7 +96,7 @@ jakarta.validation jakarta.validation-api - 3.0.2 + ${jakarta.validation-api.version} @@ -201,7 +203,7 @@ LINE COVEREDRATIO - 0.93 + 0.95 @@ -210,16 +212,6 @@ - - - - - - - - - - org.apache.maven.plugins maven-surefire-plugin diff --git a/src/main/java/com/techatpark/sjson/Json.java b/src/main/java/com/techatpark/sjson/Json.java index ac0ee88..c88c85c 100644 --- a/src/main/java/com/techatpark/sjson/Json.java +++ b/src/main/java/com/techatpark/sjson/Json.java @@ -1,12 +1,11 @@ package com.techatpark.sjson; import com.techatpark.sjson.element.JsonArray; -import com.techatpark.sjson.element.JsonFalse; import com.techatpark.sjson.element.JsonNull; import com.techatpark.sjson.element.JsonNumber; import com.techatpark.sjson.element.JsonObject; import com.techatpark.sjson.element.JsonString; -import com.techatpark.sjson.element.JsonTrue; +import com.techatpark.sjson.element.JsonBoolean; import java.io.IOException; import java.io.Reader; @@ -30,8 +29,8 @@ * @param type of object */ public sealed interface Json - permits JsonString, JsonNumber, JsonTrue, JsonFalse, - JsonNull, JsonArray, JsonObject, + permits JsonString, JsonNumber, JsonBoolean, + JsonNull, JsonArray, JsonObject, Json.Parser { /** @@ -68,8 +67,8 @@ public sealed interface Json * @return object * @throws IOException - throws io exception */ - static Object read(final Reader reader) throws IOException { - return parse(reader).read(); + static Object parse(final Reader reader) throws IOException { + return jsonReader(reader).read(); } /** @@ -78,7 +77,7 @@ static Object read(final Reader reader) throws IOException { * @return json * @throws IOException */ - private static Json parse(final Reader reader) throws IOException { + private static Json jsonReader(final Reader reader) throws IOException { try (reader) { return new Parser(reader).parse(); } @@ -94,7 +93,7 @@ static String jsonText(final Map jsonMap) { return "{" + jsonMap.entrySet().stream() .map(entry -> "\"" + escapeJsonTxt(entry.getKey()) + "\":" - + getValue(entry.getValue() + + stringify(entry.getValue() )).collect(Collectors.joining(",")) + "}"; } @@ -106,7 +105,7 @@ static String jsonText(final Map jsonMap) { */ private static String jsonText(final List jsonArray) { return "[" + jsonArray.stream() - .map(Json::getValue) + .map(Json::stringify) .collect(Collectors.joining(",")) + "]"; } @@ -116,7 +115,7 @@ private static String jsonText(final List jsonArray) { * @param value * @return valueText */ - private static String getValue(final Object value) { + static String stringify(final Object value) { return switch (value) { case null -> "null"; case String str -> "\"" + escapeJsonTxt(str) + "\""; @@ -178,15 +177,12 @@ private static void escape(final String s, final StringBuilder sb) { break; default: //Reference: http://www.unicode.org/versions/Unicode5.1.0/ - if ((ch >= '\u0000' && ch <= '\u001F') - || (ch >= '\u007F' && ch <= '\u009F') - || (ch >= '\u2000' && ch <= '\u20FF')) { + if (ch <= '\u001F' || ch >= '\u007F' + && ch <= '\u009F' || ch >= '\u2000' + && ch <= '\u20FF') { String ss = Integer.toHexString(ch); sb.append("\\u"); - for (int k = 0; k < UNICODE_LENGTH - - ss.length(); k++) { - sb.append('0'); - } + sb.append("0".repeat(UNICODE_LENGTH - ss.length())); sb.append(ss.toUpperCase()); } else { sb.append(ch); @@ -285,8 +281,8 @@ public Json parse() throws IOException { return switch (character) { case '"' -> new JsonString(this); case 'n' -> new JsonNull(this); - case 't' -> new JsonTrue(this); - case 'f' -> new JsonFalse(this); + case 't' -> new JsonBoolean(this, true); + case 'f' -> new JsonBoolean(this, false); case '{' -> new JsonObject(this); case '[' -> new JsonArray(this); case ']' -> this; diff --git a/src/main/java/com/techatpark/sjson/element/JsonArray.java b/src/main/java/com/techatpark/sjson/element/JsonArray.java index d86d574..9d83fb8 100644 --- a/src/main/java/com/techatpark/sjson/element/JsonArray.java +++ b/src/main/java/com/techatpark/sjson/element/JsonArray.java @@ -24,7 +24,7 @@ public JsonArray( parser) throws IOException { parser.startArray(); final Json value = parser.parse(); - // If not Empty Array + // If Empty Array if (value == parser) { parser.setCursorToNextClean(); jsonElements = Collections.emptyList(); @@ -47,9 +47,7 @@ public JsonArray( * @return flag * @throws IOException */ - private static boolean endOfArray( - final Parser - parser) throws IOException { + private boolean endOfArray(final Parser parser) throws IOException { char character; if (parser.getCursor() == ',') { return false; @@ -65,7 +63,6 @@ private static boolean endOfArray( return character == ']'; } - @Override public List read() { return jsonElements diff --git a/src/main/java/com/techatpark/sjson/element/JsonBoolean.java b/src/main/java/com/techatpark/sjson/element/JsonBoolean.java new file mode 100644 index 0000000..7eccb55 --- /dev/null +++ b/src/main/java/com/techatpark/sjson/element/JsonBoolean.java @@ -0,0 +1,61 @@ +package com.techatpark.sjson.element; + +import com.techatpark.sjson.Json; + +import java.io.IOException; + +/** + * Boolean Parser. + * */ + +public final class JsonBoolean implements Json { + + /** + * This is for length. + */ + public static final int THREE = 3; + + /** + * This is for length. + */ + public static final int FOUR = 4; + + + /** + * Thr value to be returned. + */ + private final boolean value; + /** + * Reads True from Reader. Reader will stip at the "e" symbol. + * @param parser + * @param theValue + * @throws IOException + */ + public JsonBoolean( + final Parser + parser, + final boolean theValue) throws IOException { + this.value = theValue; + if (theValue) { + char[] charBuffer = parser.next(THREE); + if (charBuffer[0] != 'r' + || charBuffer[1] != 'u' + || charBuffer[2] != 'e') { + throw new IllegalArgumentException(ILLEGAL_JSON_VALUE); + } + } else { + char[] charBuffer = parser.next(FOUR); + if (charBuffer[0] != 'a' + || charBuffer[1] != 'l' + || charBuffer[2] != 's' + || charBuffer[THREE] != 'e') { + throw new IllegalArgumentException(ILLEGAL_JSON_VALUE); + } + } + } + + @Override + public Boolean read() { + return this.value; + } +} diff --git a/src/main/java/com/techatpark/sjson/element/JsonFalse.java b/src/main/java/com/techatpark/sjson/element/JsonFalse.java deleted file mode 100644 index dd64f82..0000000 --- a/src/main/java/com/techatpark/sjson/element/JsonFalse.java +++ /dev/null @@ -1,43 +0,0 @@ -package com.techatpark.sjson.element; - -import com.techatpark.sjson.Json; - -import java.io.IOException; - -/** - * Boolean Parser. - * */ - -public final class JsonFalse implements Json { - - /** - * This is for length. - */ - public static final int THREE = 3; - /** - * This is for length. - */ - public static final int FOUR = 4; - - /** - * Reads False from Reader. Reader will strip at the "e" symbol. - * @param parser - * @throws IOException - */ - public JsonFalse( - final Parser - parser) throws IOException { - char[] charBuffer = parser.next(FOUR); - if (charBuffer[0] != 'a' - || charBuffer[1] != 'l' - || charBuffer[2] != 's' - || charBuffer[THREE] != 'e') { - throw new IllegalArgumentException(ILLEGAL_JSON_VALUE); - } - } - - @Override - public Boolean read() { - return Boolean.FALSE; - } -} diff --git a/src/main/java/com/techatpark/sjson/element/JsonTrue.java b/src/main/java/com/techatpark/sjson/element/JsonTrue.java deleted file mode 100644 index 891d133..0000000 --- a/src/main/java/com/techatpark/sjson/element/JsonTrue.java +++ /dev/null @@ -1,38 +0,0 @@ -package com.techatpark.sjson.element; - -import com.techatpark.sjson.Json; - -import java.io.IOException; - -/** - * Boolean Parser. - * */ - -public final class JsonTrue implements Json { - - /** - * This is for length. - */ - public static final int THREE = 3; - - /** - * Reads True from Reader. Reader will stip at the "e" symbol. - * @param parser - * @throws IOException - */ - public JsonTrue( - final Parser - parser) throws IOException { - char[] charBuffer = parser.next(THREE); - if (charBuffer[0] != 'r' - || charBuffer[1] != 'u' - || charBuffer[2] != 'e') { - throw new IllegalArgumentException(ILLEGAL_JSON_VALUE); - } - } - - @Override - public Boolean read() { - return Boolean.TRUE; - } -} diff --git a/src/test/java/com/techatpark/sjson/ArrayTest.java b/src/test/java/com/techatpark/sjson/ArrayTest.java index 19ff216..23fa13c 100644 --- a/src/test/java/com/techatpark/sjson/ArrayTest.java +++ b/src/test/java/com/techatpark/sjson/ArrayTest.java @@ -10,10 +10,8 @@ import java.io.FileReader; import java.io.IOException; import java.io.StringReader; -import java.nio.file.Files; import java.nio.file.Path; -import java.util.ArrayList; -import java.util.List; +import java.util.Set; class ArrayTest { final ObjectMapper objectMapper = new ObjectMapper(); @@ -25,18 +23,8 @@ class ArrayTest { * @return Stream of paths to JSON files * @throws IOException if there is an issue listing files */ - private static List jsonFilePath() throws IOException { - List jsonFilePath = new ArrayList<>(); - - for (Path path : TestDataProvider.getJSONFiles()) { - String jsonText = Files.readString(path).trim(); - if (jsonText.startsWith("[")) { - jsonFilePath.add(path); - } - } - - return jsonFilePath; - + private static Set jsonFilePath() throws IOException { + return TestDataProvider.getJSONArrayFiles(); } @ParameterizedTest @@ -45,7 +33,7 @@ void testValid(final Path path) throws IOException { Assertions.assertEquals(JsonParser .parseReader( new StringReader(objectMapper.writeValueAsString( - Json.read( + Json.parse( new FileReader(path.toFile()) )))), JsonParser.parseReader(new FileReader(path.toFile())), diff --git a/src/test/java/com/techatpark/sjson/BooleanTest.java b/src/test/java/com/techatpark/sjson/BooleanTest.java index 96f04fa..a142929 100644 --- a/src/test/java/com/techatpark/sjson/BooleanTest.java +++ b/src/test/java/com/techatpark/sjson/BooleanTest.java @@ -35,7 +35,7 @@ class BooleanTest { void testValid(final Boolean originalValue) throws IOException { String jsonString = objectMapper.writeValueAsString(originalValue); Assertions.assertEquals(originalValue , - Json.read(new StringReader(jsonString))); + Json.parse(new StringReader(jsonString))); } /** * Tests invalid Boolean Values. @@ -52,6 +52,6 @@ void testValid(final Boolean originalValue) throws IOException { @ValueSource(strings = {"tru", "fals"}) void testInvalid(final String invalidJson) { assertThrows(IllegalArgumentException.class, - () -> Json.read(new StringReader(invalidJson))); + () -> Json.parse(new StringReader(invalidJson))); } } \ No newline at end of file diff --git a/src/test/java/com/techatpark/sjson/DeepNestedTest.java b/src/test/java/com/techatpark/sjson/DeepNestedTest.java index 2cb8b98..4d23c63 100644 --- a/src/test/java/com/techatpark/sjson/DeepNestedTest.java +++ b/src/test/java/com/techatpark/sjson/DeepNestedTest.java @@ -35,7 +35,7 @@ void testDeeplyNestedJson() throws IOException { "\"final\": \"value\"" + "}".repeat(10_000); - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(deepJson))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(deepJson))); } /** @@ -52,7 +52,7 @@ void testDeeplyNestedArray() throws IOException { "\"value\"" + "]".repeat(10_000); - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(deepArray))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(deepArray))); } /** @@ -76,7 +76,7 @@ void testMixedDeeplyNestedJson() throws IOException { mixedJson.append("]"); } - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(mixedJson.toString()))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(mixedJson.toString()))); } /** @@ -94,7 +94,7 @@ void testNestedJsonWithinLimit() throws IOException { "\"final\": \"value\"" + "}".repeat(9_999); - assertDoesNotThrow(() -> Json.read(new StringReader(deepJson))); + assertDoesNotThrow(() -> Json.parse(new StringReader(deepJson))); } /** @@ -105,7 +105,7 @@ void testNestedJsonWithinLimit() throws IOException { @Test void testUnbalancedNesting() throws IOException { String unbalancedJson = "{ \"key\": { \"nested\": [ 1, 2, 3 }"; // Missing closing bracket - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(unbalancedJson))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(unbalancedJson))); } /** @@ -119,6 +119,6 @@ void testDeeplyNestedWithEscapedCharacters() throws IOException { "\"final\": \"value\"" + "}".repeat(500); - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(json))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(json))); } } diff --git a/src/test/java/com/techatpark/sjson/InvalidButParsableTest.java b/src/test/java/com/techatpark/sjson/InvalidButParsableTest.java index 895ce44..4208ff0 100644 --- a/src/test/java/com/techatpark/sjson/InvalidButParsableTest.java +++ b/src/test/java/com/techatpark/sjson/InvalidButParsableTest.java @@ -22,7 +22,7 @@ class InvalidButParsableTest { "\"Newline in string \n remains invalid\""}) void testInvalid(final String invalidJson) { assertDoesNotThrow( - () -> Json.read(new StringReader(invalidJson))); + () -> Json.parse(new StringReader(invalidJson))); } } diff --git a/src/test/java/com/techatpark/sjson/JsonParserValidationTest.java b/src/test/java/com/techatpark/sjson/JsonParserValidationTest.java index c5b25dc..d6654d9 100644 --- a/src/test/java/com/techatpark/sjson/JsonParserValidationTest.java +++ b/src/test/java/com/techatpark/sjson/JsonParserValidationTest.java @@ -24,7 +24,7 @@ class JsonParserValidationTest { @MethodSource("illegalJsonPaths") void testIllegal(Path path) { Exception exception = Assertions.assertThrows(IllegalArgumentException.class, () -> { - Json.read(new FileReader(path.toFile())); + Json.parse(new FileReader(path.toFile())); }); } diff --git a/src/test/java/com/techatpark/sjson/JsonTest.java b/src/test/java/com/techatpark/sjson/JsonTest.java index c8391da..7a0073b 100644 --- a/src/test/java/com/techatpark/sjson/JsonTest.java +++ b/src/test/java/com/techatpark/sjson/JsonTest.java @@ -34,7 +34,7 @@ class JsonTest { @ParameterizedTest @MethodSource("jsonFilesProvider") void testGetJsonText(Path path) throws IOException { - if(Json.read(new BufferedReader(new FileReader(path.toFile()))) + if(Json.parse(new BufferedReader(new FileReader(path.toFile()))) instanceof Map sJsonObject) { Assertions.assertEquals(JsonParser.parseString(jackson.writeValueAsString(sJsonObject)), JsonParser.parseReader(new StringReader(Json.jsonText(sJsonObject))), diff --git a/src/test/java/com/techatpark/sjson/LargeObjectTest.java b/src/test/java/com/techatpark/sjson/LargeObjectTest.java index 5476d1d..e2caedd 100644 --- a/src/test/java/com/techatpark/sjson/LargeObjectTest.java +++ b/src/test/java/com/techatpark/sjson/LargeObjectTest.java @@ -25,6 +25,6 @@ void testLargeJson() throws IOException { JsonNode jsonNode = new ObjectMapper().readTree(new StringReader(largeJson.toString())); - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(largeJson.toString()))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(largeJson.toString()))); } } diff --git a/src/test/java/com/techatpark/sjson/NullTest.java b/src/test/java/com/techatpark/sjson/NullTest.java index 0680e13..5b6b703 100644 --- a/src/test/java/com/techatpark/sjson/NullTest.java +++ b/src/test/java/com/techatpark/sjson/NullTest.java @@ -30,7 +30,7 @@ class NullTest { @Test void testValid() throws IOException { String jsonString = objectMapper.writeValueAsString(null); - Assertions.assertNull(Json.read(new StringReader(jsonString))); + Assertions.assertNull(Json.parse(new StringReader(jsonString))); } /** @@ -50,7 +50,7 @@ void testValid() throws IOException { }) void testInvalid(final String invalidjson) throws IOException { assertThrows(IllegalArgumentException.class, - () -> Json.read(new StringReader(invalidjson))); + () -> Json.parse(new StringReader(invalidjson))); } } \ No newline at end of file diff --git a/src/test/java/com/techatpark/sjson/NumberTest.java b/src/test/java/com/techatpark/sjson/NumberTest.java index 9d3a113..c3b1ec7 100644 --- a/src/test/java/com/techatpark/sjson/NumberTest.java +++ b/src/test/java/com/techatpark/sjson/NumberTest.java @@ -32,7 +32,7 @@ class NumberTest { @Test void testLargeNumber() throws JsonProcessingException { String largeNumber = "{\"a\" : " + "9".repeat(100000) + "}"; - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(largeNumber))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(largeNumber))); } /** @@ -53,7 +53,7 @@ void testLargeNumber() throws JsonProcessingException { @MethodSource("validNumbers") void testValidNumbers(final Number expectedNumber) throws IOException { String jsonString = objectMapper.writeValueAsString(expectedNumber); - Assertions.assertEquals(expectedNumber, Json.read(new StringReader(jsonString))); + Assertions.assertEquals(expectedNumber, Json.parse(new StringReader(jsonString))); } /** @@ -112,7 +112,7 @@ static List validNumbers() { @ParameterizedTest @MethodSource("invalidNumbers") void testInvalidNumbers(final String invalidNumber) { - assertThrows(IllegalArgumentException.class, () -> Json.read(new StringReader(invalidNumber))); + assertThrows(IllegalArgumentException.class, () -> Json.parse(new StringReader(invalidNumber))); } /** diff --git a/src/test/java/com/techatpark/sjson/ObjectTest.java b/src/test/java/com/techatpark/sjson/ObjectTest.java index 6cb186a..7911265 100644 --- a/src/test/java/com/techatpark/sjson/ObjectTest.java +++ b/src/test/java/com/techatpark/sjson/ObjectTest.java @@ -12,10 +12,8 @@ import java.io.FileReader; import java.io.IOException; import java.io.StringReader; -import java.nio.file.Files; import java.nio.file.Path; -import java.util.ArrayList; -import java.util.List; +import java.util.Set; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -30,18 +28,8 @@ class ObjectTest { * @return Stream of paths to JSON files * @throws IOException if there is an issue listing files */ - private static List jsonFilePath() throws IOException { - List jsonFilePath = new ArrayList<>(); - - for (Path path : TestDataProvider.getJSONFiles()) { - String jsonText = Files.readString(path).trim(); - if (jsonText.startsWith("{")) { - jsonFilePath.add(path); - } - } - - return jsonFilePath; - + private static Set jsonFilePath() throws IOException { + return TestDataProvider.getJSONObjectFiles(); } @ParameterizedTest @@ -50,7 +38,7 @@ void testValid(final Path path) throws IOException { Assertions.assertEquals(JsonParser .parseReader( new StringReader(objectMapper.writeValueAsString( - Json.read( + Json.parse( new FileReader(path.toFile()) )))), JsonParser.parseReader(new FileReader(path.toFile())), @@ -69,7 +57,7 @@ void testDuplicateKey() { """; assertThrows(IllegalArgumentException.class, - () -> Json.read(new StringReader(json))); + () -> Json.parse(new StringReader(json))); } } \ No newline at end of file diff --git a/src/test/java/com/techatpark/sjson/PerformanceTest.java b/src/test/java/com/techatpark/sjson/PerformanceTest.java index 00ae814..517c0c1 100644 --- a/src/test/java/com/techatpark/sjson/PerformanceTest.java +++ b/src/test/java/com/techatpark/sjson/PerformanceTest.java @@ -1,13 +1,15 @@ package com.techatpark.sjson; -import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; -import com.google.gson.JsonElement; +import com.google.gson.Gson; import com.google.gson.JsonParser; import com.techatpark.sjson.util.TestDataProvider; import org.github.jamm.MemoryMeter; import org.json.JSONObject; +import org.json.JSONTokener; +import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.TestInstance; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.MethodSource; @@ -16,114 +18,135 @@ import java.io.IOException; import java.io.StringReader; import java.nio.file.Path; +import java.util.Map; import java.util.Set; - +/** + * Reads Json Objects as Map using various parsers, + * Compare them with Json.parse() by Memory usage and performance + */ +@TestInstance(TestInstance.Lifecycle.PER_CLASS) class PerformanceTest { - public static final String ANSI_RESET = "\u001B[0m"; - public static final String ANSI_RED = "\u001B[31m"; - public static final String ANSI_GREEN = "\u001B[32m"; - public static final String ANSI_WHITE = "\u001B[37m"; + private static final String ANSI_RESET = "\u001B[0m"; + private static final String ANSI_RED = "\u001B[31m"; + private static final String ANSI_GREEN = "\u001B[32m"; + private static final String ANSI_WHITE = "\u001B[37m"; + + private final ObjectMapper jackson = new ObjectMapper(); + private final Gson gson = new Gson(); + + private final MemoryMeter meter = MemoryMeter.builder().build(); + long totalOursTime = 0; + long totalOrgJsonTime = 0; + long totalJacksonTime = 0; + long totalGsonTime = 0; - public final ObjectMapper jackson = new ObjectMapper(); + long totalOursSize = 0; + long totalOrgJsonSize = 0; + long totalJacksonSize = 0; + long totalGsonSize = 0; + + int fileCount = 0; + @ParameterizedTest @MethodSource("jsonFilesProvider") void testRead(Path path) throws IOException { - MemoryMeter meter = MemoryMeter.builder().build(); - Object ourJsonObject; - JSONObject orgJSONObject; - JsonNode jacksonJsonNode; - JsonElement gsonObject; - - long start; + fileCount++; - long jacksonsTime, jsonTime, gsonTime, oursTime; - long jacksonsSize, jsonSize, gsonSize, oursSize; + // Org JSON + long start = System.nanoTime(); + JSONTokener jsonTokener = new JSONTokener(new BufferedReader(new FileReader(path.toFile()))); + Map orgJsonObject = new JSONObject(jsonTokener).toMap(); + long orgjsonTime = System.nanoTime() - start; + long orgjsonSize = meter.measureDeep(orgJsonObject); - // Measure SJson + // Our Json start = System.nanoTime(); - ourJsonObject = Json.read(new BufferedReader(new FileReader(path.toFile()))); - oursTime = System.nanoTime() - start; - oursSize = meter.measureDeep(ourJsonObject); + Object ourJsonObject = Json.parse(new BufferedReader(new FileReader(path.toFile()))); + long oursTime = System.nanoTime() - start; + long oursSize = meter.measureDeep(ourJsonObject); - // Measure Org Json + // Jackson start = System.nanoTime(); - orgJSONObject = new JSONObject(new BufferedReader(new FileReader(path.toFile()))); - jsonTime = System.nanoTime() - start - oursTime; - jsonSize = meter.measureDeep(orgJSONObject); + Map jacksonJson = jackson.readValue(new BufferedReader(new FileReader(path.toFile())), Map.class); + long jacksonsTime = System.nanoTime() - start; + long jacksonsSize = meter.measureDeep(jacksonJson); - // Measure Jackson + // Gson start = System.nanoTime(); - jacksonJsonNode = jackson.readTree(new BufferedReader(new FileReader(path.toFile()))); - jacksonsTime = System.nanoTime() - start - oursTime; - jacksonsSize = meter.measureDeep(jacksonJsonNode); + Map gsonJson = gson.fromJson(new BufferedReader(new FileReader(path.toFile())), Map.class); + long gsonTime = System.nanoTime() - start; + long gsonSize = meter.measureDeep(gsonJson); - // Measure Gson - start = System.nanoTime(); - gsonObject = JsonParser.parseReader(new BufferedReader(new FileReader(path.toFile()))); - gsonTime = System.nanoTime() - start - oursTime; - gsonSize = meter.measureDeep(gsonObject); + // Accumulate totals + totalOursTime += oursTime; + totalOrgJsonTime += orgjsonTime; + totalJacksonTime += jacksonsTime; + totalGsonTime += gsonTime; + + totalOursSize += oursSize; + totalOrgJsonSize += orgjsonSize; + totalJacksonSize += jacksonsSize; + totalGsonSize += gsonSize; // Check Correctness of the parser - Assertions.assertEquals(gsonObject, + Assertions.assertEquals(JsonParser.parseReader(new StringReader(jackson.writeValueAsString(gsonJson))), JsonParser.parseReader(new StringReader(jackson.writeValueAsString(ourJsonObject))), "Reverse JSON Failed for " + path); + // Print formatted table System.out.format("%33s%20s%20s%20s%10s%20s%20s%20s\n", ANSI_RESET + path.getFileName(), - getSizeDisplay(jsonSize, oursSize), - getSizeDisplay(jacksonsSize, oursSize), - getSizeDisplay(gsonSize, oursSize), + getMemoryDisplay(orgjsonSize, oursSize), + getMemoryDisplay(jacksonsSize, oursSize), + getMemoryDisplay(gsonSize, oursSize), + ANSI_WHITE + "|", + getTimeDisplay(orgjsonTime, oursTime), + getTimeDisplay(jacksonsTime, oursTime), + getTimeDisplay(gsonTime, oursTime) + ); + } + + @AfterAll + void printAverages() { + System.out.println(ANSI_RESET + "\nAverage Memory and Time Usage (nanoseconds and bytes):"); + System.out.format("%33s%20s%20s%20s%10s%20s%20s%20s\n", + ANSI_RESET + "Average", + getMemoryDisplay(totalOrgJsonSize / fileCount, totalOursSize / fileCount), + getMemoryDisplay(totalJacksonSize / fileCount, totalOursSize / fileCount), + getMemoryDisplay(totalGsonSize / fileCount, totalOursSize / fileCount), ANSI_WHITE + "|", - getTimeDisplay(jsonTime), - getTimeDisplay(jacksonsTime), - getTimeDisplay(gsonTime) + getTimeDisplay(totalOrgJsonTime / fileCount, totalOursTime / fileCount), + getTimeDisplay(totalJacksonTime / fileCount, totalOursTime / fileCount), + getTimeDisplay(totalGsonTime / fileCount, totalOursTime / fileCount) ); } - /** - * Provides paths to JSON files for parameterized tests. - * - * @return Stream of paths to JSON files - * @throws IOException if there is an issue listing files - */ private static Set jsonFilesProvider() throws IOException { - return TestDataProvider.getJSONFiles(); + return TestDataProvider.getJSONObjectFiles(); } - /** - * Get Timing in a Color Coded Format. - * @param time - * @return time as text - */ - private String getTimeDisplay(final long time) { + private String getTimeDisplay(final long time, final long oursTime) { StringBuilder builder = new StringBuilder(); - if(time < 0) { - builder.append(ANSI_RED); - } - else { + long gap = time - oursTime; + if (gap > 0) { builder.append(ANSI_GREEN); + } else { + builder.append(ANSI_RED); } return builder.append(time).toString(); } - /** - * Get Size in a Color Coded Format. - * @param size - * @return size as text - */ - private String getSizeDisplay(final long size,final long ourSize) { + private String getMemoryDisplay(final long size, final long ourSize) { StringBuilder builder = new StringBuilder(); - long gap = size-ourSize; - if(gap < 0) { - builder.append(ANSI_RED); - } - else { + if (size > ourSize) { builder.append(ANSI_GREEN); + } else { + builder.append(ANSI_RED); } - return builder.append(gap).toString(); + return builder.append(size).toString(); } } diff --git a/src/test/java/com/techatpark/sjson/StringTest.java b/src/test/java/com/techatpark/sjson/StringTest.java index f20c548..f19be45 100644 --- a/src/test/java/com/techatpark/sjson/StringTest.java +++ b/src/test/java/com/techatpark/sjson/StringTest.java @@ -38,12 +38,13 @@ class StringTest { "你好 (Chinese)", "Привет (Russian)", "வணக்கம் (Tamil)", - "Mix: English हिंदी 中文 日本語 \uD83D\uDE80" + "Mix: English हिंदी 中文 日本語 \uD83D\uDE80", + "this is\nA test\r\nWith some different\rNew Lines" }) void testValid(final String originalValue) throws IOException { String jsonString = objectMapper.writeValueAsString(originalValue); - Assertions.assertEquals(originalValue, Json.read(new StringReader(jsonString))); + Assertions.assertEquals(originalValue, Json.parse(new StringReader(jsonString))); } /** @@ -68,6 +69,6 @@ void testValid(final String originalValue) throws IOException { }) void testInvalid(final String invalidjson) throws IOException { assertThrows(IllegalArgumentException.class, - () -> Json.read(new StringReader(invalidjson))); + () -> Json.parse(new StringReader(invalidjson))); } } diff --git a/src/test/java/com/techatpark/sjson/util/TestDataProvider.java b/src/test/java/com/techatpark/sjson/util/TestDataProvider.java index d6d3c04..1f3ba9f 100644 --- a/src/test/java/com/techatpark/sjson/util/TestDataProvider.java +++ b/src/test/java/com/techatpark/sjson/util/TestDataProvider.java @@ -5,6 +5,7 @@ import java.math.BigInteger; import java.nio.file.Files; import java.nio.file.Path; +import java.util.ArrayList; import java.util.List; import java.util.Set; import java.util.stream.Collectors; @@ -12,7 +13,7 @@ public class TestDataProvider { - private static String baseFolder = System.getenv("SJSON_LOCAL_DIR") == null ? "src/test/resources" : + private static String baseFolder = System.getenv("SJSON_LOCAL_DIR") == null ? "src/test/resources/samples" : System.getenv("SJSON_LOCAL_DIR"); /** @@ -21,64 +22,50 @@ public class TestDataProvider { * @throws IOException */ public static Set getJSONFiles() throws IOException { - - try (Stream stream = Files.list(new File(baseFolder, "samples").toPath())) { + try (Stream stream = Files.walk(new File(baseFolder).toPath())) { return stream - .filter(file -> !Files.isDirectory(file)) + .filter(path -> !Files.isDirectory(path)) + .filter(path -> path.toString().toLowerCase().endsWith(".json")) .collect(Collectors.toSet()); } } /** - * Utility to get Json Schema Files from Test Resources directory. + * Utility to get Json Object Files from Test Resources directory. * @return Set of Paths * @throws IOException */ - public static Set getJSONSchemaFiles() throws IOException { - try (Stream stream = Files.list(new File(baseFolder, "schemas").toPath())) { + public static Set getJSONObjectFiles() throws IOException { + try (Stream stream = getJSONFiles().stream()) { return stream - .filter(path -> !Files.isDirectory(path)) - .map(Path::toFile) + .filter(path -> { + try { + return Files.readString(path).trim().startsWith("{"); + } catch (IOException e) { + throw new RuntimeException(e); + } + }) .collect(Collectors.toSet()); } } /** - * Provides Numbers to Test. - * - * @return Stream of Numbers - * @throws IOException if there is an issue listing files + * Utility to get Json Array Files from Test Resources directory. + * @return Set of Paths + * @throws IOException */ - public static List numbers() { - return List.of( - Byte.MIN_VALUE, - Byte.MAX_VALUE, - Short.MIN_VALUE, - Short.MAX_VALUE, - Integer.MIN_VALUE, - Integer.MAX_VALUE, - Long.MIN_VALUE, - Long.MAX_VALUE, - BigInteger.valueOf(Long.MIN_VALUE).multiply(BigInteger.TEN), - BigInteger.valueOf(Long.MAX_VALUE).multiply(BigInteger.TEN), - Float.MIN_VALUE, - Float.MAX_VALUE, - Double.MIN_VALUE, - 123, - -456, - 12.34, - -0.567, - 1.23e4, - 5.67E-8, - 0.456, - 1.23e001, - +789, - 0.4e006, - 0.4e-006, - 0.4e+006, - 4e006, - 4e-006, - 4e+006 - ); + public static Set getJSONArrayFiles() throws IOException { + try (Stream stream = getJSONFiles().stream()) { + return stream + .filter(path -> { + try { + return Files.readString(path).trim().startsWith("["); + } catch (IOException e) { + throw new RuntimeException(e); + } + }) + .collect(Collectors.toSet()); + } } + } diff --git a/src/test/resources/samples/product.json b/src/test/resources/samples/product.json deleted file mode 100644 index 3a6b348..0000000 --- a/src/test/resources/samples/product.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "id": 1, - "name": "Lampshade", - "price": 6 -} \ No newline at end of file diff --git a/src/test/resources/schemas/product.json b/src/test/resources/schemas/product.json deleted file mode 100644 index f7c9405..0000000 --- a/src/test/resources/schemas/product.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Product", - "description": "A product from the catalog", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for a product", - "type": "integer" - }, - "name": { - "description": "Name of the product", - "type": "string" - }, - "price": { - "type": "number", - "minimum": 0, - "exclusiveMinimum": true - } - }, - "required": ["id", "name", "price"] -} \ No newline at end of file