From 5a0c682f6f54d66ed99dd1dd01e03eb25b396f27 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 31 Dec 2022 01:47:40 -0800 Subject: [PATCH 01/14] Upgarded to Gradle 7.6 --- gradle/wrapper/gradle-wrapper.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index ae04661..070cb70 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists From e62af2cf4b379d7b60c9391323831daaecdb2b15 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 31 Dec 2022 01:48:28 -0800 Subject: [PATCH 02/14] Added allow parameter --- README.md | 3 +- .../java/com/uwyn/urlencoder/UrlEncoder.java | 238 +++++++++--------- 2 files changed, 128 insertions(+), 113 deletions(-) diff --git a/README.md b/README.md index daca475..2d8e866 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A simple library to encode/decode URL parameters. This library was extracted from the [RIFE2 Web Application Framework](https://rife2.com). -The Kotlin version can be found at [https://github.com/ethauvin/urlencoder](https://github.com/ethauvin/urlencoder). +A Kotlin version can also be found at [https://github.com/ethauvin/urlencoder](https://github.com/ethauvin/urlencoder). For decades, we've been using [java.net.URLEncoder](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URLEncoder.html) because of its improper naming. It is actually intended to encode HTML form @@ -22,6 +22,7 @@ also addresses this issue. UrlEncoder.encode("a test &"); // -> "a%20test%20%26" UrlEncoder.encode("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"); // -> "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~" UrlEncoder.encode("%#okékÉȢ smile!😁"); // -> "%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81" +UrlEncoder.encode("?test=a test", "?="); // -> ?test=a%20test UrlEncoder.decode("a%20test%20%26"); // -> "a test &" UrlEncoder.decode("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"); // -> "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~" diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index 76aade4..af10245 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -16,26 +16,147 @@ import java.util.BitSet; * @since 1.0 */ public class UrlEncoder { + static final BitSet UNRESERVED_URI_CHARS; + private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray(); + + static { + // see https://www.rfc-editor.org/rfc/rfc3986#page-13 + var unreserved = new BitSet('~' + 1); + unreserved.set('-'); + unreserved.set('.'); + for (int c = '0'; c <= '9'; ++c) unreserved.set(c); + for (int c = 'A'; c <= 'Z'; ++c) unreserved.set(c); + unreserved.set('_'); + for (int c = 'a'; c <= 'z'; ++c) unreserved.set(c); + unreserved.set('~'); + UNRESERVED_URI_CHARS = unreserved; + } + + private static void appendUrlEncodedByte(StringBuilder out, int ch) { + out.append("%"); + appendUrlEncodedDigit(out, ch >> 4); + appendUrlEncodedDigit(out, ch); + } + + private static void appendUrlEncodedDigit(StringBuilder out, int digit) { + out.append(HEX_DIGITS[digit & 0x0F]); + } + + /** + * Transforms a provided String URL into a new string, + * containing decoded URL characters in the UTF-8 encoding. + * + * @param source The string URL that has to be decoded + * @return The decoded String object. + * @see #encode(String, String) + * @since 1.0 + */ + public static String decode(String source) { + if (source == null || source.isBlank()) { + return source; + } + + var length = source.length(); + StringBuilder out = null; + char ch; + byte[] bytes_buffer = null; + var bytes_pos = 0; + for (var i = 0; i < length; ) { + ch = source.charAt(i); + + if (ch == '%') { + if (out == null) { + out = new StringBuilder(length); + out.append(source, 0, i); + } + + if (bytes_buffer == null) { + // the remaining characters divided by the length + // of the encoding format %xx, is the maximum number of + // bytes that can be extracted + bytes_buffer = new byte[(length - i) / 3]; + bytes_pos = 0; + } + + i += 1; + if (length < i + 2) { + throw new IllegalArgumentException("Illegal escape sequence"); + } + try { + var v = Integer.parseInt(source, i, i + 2, 16); + if (v < 0 || v > 0xFF) { + throw new IllegalArgumentException("Illegal escape value"); + } + + bytes_buffer[bytes_pos++] = (byte) v; + + i += 2; + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Illegal characters in escape sequence: " + e.getMessage()); + } + } else { + if (bytes_buffer != null) { + out.append(new String(bytes_buffer, 0, bytes_pos, StandardCharsets.UTF_8)); + + bytes_buffer = null; + bytes_pos = 0; + } + + if (out != null) { + out.append(ch); + } + + i += 1; + } + } + + if (out == null) { + return source; + } + + if (bytes_buffer != null) { + out.append(new String(bytes_buffer, 0, bytes_pos, StandardCharsets.UTF_8)); + } + + return out.toString(); + } + /** * Transforms a provided String object into a new string, * containing only valid URL characters in the UTF-8 encoding. * * @param source The string that has to be transformed into a valid URL * string. + * @param allow Additional characters to allow. * @return The encoded String object. * @see #decode(String) * @since 1.0 */ - public static String encode(String source) { - if (source == null) { - return null; + public static String encode(String source, char... allow) { + return encode(source, new String(allow)); + } + + /** + * Transforms a provided String object into a new string, + * containing only valid URL characters in the UTF-8 encoding. + * + * @param source The string that has to be transformed into a valid URL + * string. + * @param allow Additional characters to allow. + * @return The encoded String object. + * @see #decode(String) + * @since 1.0 + */ + public static String encode(String source, String allow) { + if (source == null || source.isBlank()) { + return source; } StringBuilder out = null; char ch; for (var i = 0; i < source.length(); ) { ch = source.charAt(i); - if (isUnreservedUriChar(ch)) { + if (isUnreservedUriChar(ch) || allow.indexOf(ch) != -1) { if (out != null) { out.append(ch); } @@ -73,115 +194,8 @@ public class UrlEncoder { return out.toString(); } - static final BitSet UNRESERVED_URI_CHARS; - - static { - // see https://www.rfc-editor.org/rfc/rfc3986#page-13 - var unreserved = new BitSet('~' + 1); - unreserved.set('-'); - unreserved.set('.'); - for (int c = '0'; c <= '9'; ++c) unreserved.set(c); - for (int c = 'A'; c <= 'Z'; ++c) unreserved.set(c); - unreserved.set('_'); - for (int c = 'a'; c <= 'z'; ++c) unreserved.set(c); - unreserved.set('~'); - UNRESERVED_URI_CHARS = unreserved; - } - // see https://www.rfc-editor.org/rfc/rfc3986#page-13 private static boolean isUnreservedUriChar(char ch) { - if (ch > '~') return false; - return UNRESERVED_URI_CHARS.get(ch); - } - - private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray(); - - private static void appendUrlEncodedDigit(StringBuilder out, int digit) { - out.append(HEX_DIGITS[digit & 0x0F]); - } - - private static void appendUrlEncodedByte(StringBuilder out, int ch) { - out.append("%"); - appendUrlEncodedDigit(out, ch >> 4); - appendUrlEncodedDigit(out, ch); - } - - /** - * Transforms a provided String URL into a new string, - * containing decoded URL characters in the UTF-8 encoding. - * - * @param source The string URL that has to be decoded - * @return The decoded String object. - * @see #encode(String) - * @since 1.0 - */ - public static String decode(String source) { - if (source == null) { - return source; - } - - var length = source.length(); - StringBuilder out = null; - char ch; - byte[] bytes_buffer = null; - var bytes_pos = 0; - for (var i = 0; i < length; ) { - ch = source.charAt(i); - - if (ch == '%') { - if (out == null) { - out = new StringBuilder(source.length()); - out.append(source, 0, i); - } - - if (bytes_buffer == null) { - // the remaining characters divided by the length - // of the encoding format %xx, is the maximum number of - // bytes that can be extracted - bytes_buffer = new byte[(length - i) / 3]; - bytes_pos = 0; - } - - i += 1; - if (length < i + 2) { - throw new IllegalArgumentException("Illegal escape sequence"); - } - try { - var v = Integer.parseInt(source, i, i + 2, 16); - if (v < 0 || v > 0xFF) { - throw new IllegalArgumentException("Illegal escape value"); - } - - bytes_buffer[bytes_pos++] = (byte) v; - - i += 2; - } catch (NumberFormatException e) { - throw new IllegalArgumentException("Illegal characters in escape sequence" + e.getMessage()); - } - } else { - if (bytes_buffer != null) { - out.append(new String(bytes_buffer, 0, bytes_pos, StandardCharsets.UTF_8)); - - bytes_buffer = null; - bytes_pos = 0; - } - - if (out != null) { - out.append(ch); - } - - i += 1; - } - } - - if (out == null) { - return source; - } - - if (bytes_buffer != null) { - out.append(new String(bytes_buffer, 0, bytes_pos, StandardCharsets.UTF_8)); - } - - return out.toString(); + return ch <= '~' && UNRESERVED_URI_CHARS.get(ch); } } From be01f6dc07b68ef86d4c368bfb8f2dda8ceee27f Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 31 Dec 2022 01:48:49 -0800 Subject: [PATCH 03/14] Cleaned up tests --- .../com/uwyn/urlencoder/UrlEncoderTest.java | 61 ++++++++----------- 1 file changed, 27 insertions(+), 34 deletions(-) diff --git a/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java b/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java index 3dc5fd2..56775af 100644 --- a/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java +++ b/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java @@ -6,48 +6,41 @@ package com.uwyn.urlencoder; import org.junit.jupiter.api.Test; +import java.util.Map; + import static org.junit.jupiter.api.Assertions.*; -import static org.junit.jupiter.api.Assertions.assertTrue; class UrlEncoderTest { - @Test - public void testEncodeURL() { - assertNull(UrlEncoder.encode(null)); - assertEquals("a%20test%20%26", UrlEncoder.encode("a test &")); - String valid = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"; - assertSame(valid, UrlEncoder.encode(valid)); - assertEquals("%21abcdefghijklmnopqrstuvwxyz%25%25ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~%3D", UrlEncoder.encode("!abcdefghijklmnopqrstuvwxyz%%ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~=")); - assertEquals("%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81", UrlEncoder.encode("%#okékÉȢ smile!😁")); - } + private String[] invalid = {"sdkjfh%", "sdkjfh%6", "sdkjfh%xx", "sdfjfh%-1"}; + private String same = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"; + private Map validMap = Map.of( + "a test &", "a%20test%20%26", + "!abcdefghijklmnopqrstuvwxyz%%ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~=", + "%21abcdefghijklmnopqrstuvwxyz%25%25ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~%3D", + "%#okékÉȢ smile!😁", "%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81" + ); @Test public void testDecodeURL() { assertNull(UrlEncoder.decode(null)); - assertEquals("a test &", UrlEncoder.decode("a%20test%20%26")); - String valid = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"; - assertSame(valid, UrlEncoder.decode(valid)); - assertEquals("!abcdefghijklmnopqrstuvwxyz%%ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~=", UrlEncoder.decode("%21abcdefghijklmnopqrstuvwxyz%25%25ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~%3D")); - assertEquals("%#okékÉȢ smile!😁", UrlEncoder.decode("%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81")); + assertSame(same, UrlEncoder.decode(same)); + validMap.forEach((expected, source) -> assertEquals(expected, UrlEncoder.decode(source))); - try { - UrlEncoder.decode("sdkjfh%"); - fail(); - } catch (Exception e) { - assertTrue(e instanceof IllegalArgumentException); - } - - try { - UrlEncoder.decode("sdkjfh%6"); - fail(); - } catch (Exception e) { - assertTrue(e instanceof IllegalArgumentException); - } - - try { - UrlEncoder.decode("sdkjfh%xx"); - fail(); - } catch (Exception e) { - assertTrue(e instanceof IllegalArgumentException); + for (String i : invalid) { + assertThrows(IllegalArgumentException.class, () -> UrlEncoder.decode(i)); } } + + @Test + public void testEncodeURL() { + assertNull(UrlEncoder.encode(null)); + assertTrue(UrlEncoder.encode("").isEmpty()); + assertSame(same, UrlEncoder.encode(same)); + assertSame(same, UrlEncoder.encode(same, "")); + validMap.forEach((source, expected) -> assertEquals(expected, UrlEncoder.encode(source))); + + assertEquals("?test=a%20test", UrlEncoder.encode("?test=a test", "?=")); + assertEquals("?test=a%20test", UrlEncoder.encode("?test=a test", '?', '=')); + assertEquals("aaa", UrlEncoder.encode("aaa", 'a')); + } } From 8fc30ed4adb34ae743299715190027737a325e7a Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:01:36 -0500 Subject: [PATCH 04/14] Updated for Sonarcloud --- .github/workflows/gradle.yml | 34 +++++++++++++++++++++++++++++----- lib/build.gradle.kts | 9 +++++++++ 2 files changed, 38 insertions(+), 5 deletions(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 396e6bf..9f3c3b4 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -27,11 +27,35 @@ jobs: - name: Grant execute permission for gradlew run: chmod +x gradlew - - name: Checkout project sources - uses: actions/checkout@v2 + - name: Cache SonarCloud packages + if: matrix.java-version == env.SONAR_JDK + uses: actions/cache@v1 + with: + path: ~/.sonar/cache + key: ${{ runner.os }}-sonar + restore-keys: ${{ runner.os }}-sonar - - name: Setup Gradle - uses: gradle/gradle-build-action@v2 + - name: Cache Gradle packages + uses: actions/cache@v2 + with: + path: | + ~/.gradle/caches + ~/.gradle/wrapper + key: ${{ runner.os }}-gradle-${{ matrix.java-version }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} + restore-keys: | + ${{ runner.os }}-gradle-${{ matrix.java-version }}- - name: Test with Gradle - run: ./gradlew build check --stacktrace \ No newline at end of file + run: ./gradlew build check --stacktrace + + - name: SonarCloud + if: success() && matrix.java-version == env.SONAR_JDK + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} + run: ./gradlew sonarqube --info + + - name: Cleanup Gradle Cache + run: | + rm -f ~/.gradle/caches/modules-2/modules-2.lock + rm -f ~/.gradle/caches/modules-2/gc.properties \ No newline at end of file diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts index c905fe5..758293f 100644 --- a/lib/build.gradle.kts +++ b/lib/build.gradle.kts @@ -2,6 +2,7 @@ plugins { `java-library` `maven-publish` signing + id("org.sonarqube") version "3.5.0.2730" } group = "com.uwyn" @@ -18,6 +19,14 @@ java { } } +sonarqube { + properties { + property("sonar.projectName", rootProject.name) + property("sonar.projectKey", "gbevin_urlencoder") + property("sonar.organization", "gbevin") + property("sonar.host.url", "https://sonarcloud.io") + } +} repositories { mavenCentral() } From fc251e20739d10db97640c2f906ff4046dfeff98 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:08:47 -0500 Subject: [PATCH 05/14] Code cleanups --- lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 5 +++-- lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index af10245..06e7978 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -15,7 +15,7 @@ import java.util.BitSet; * @author Geert Bevin (gbevin[remove] at uwyn dot com) * @since 1.0 */ -public class UrlEncoder { +public abstract class UrlEncoder { static final BitSet UNRESERVED_URI_CHARS; private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray(); @@ -61,7 +61,8 @@ public class UrlEncoder { char ch; byte[] bytes_buffer = null; var bytes_pos = 0; - for (var i = 0; i < length; ) { + var i = 0; + while(i < length) { ch = source.charAt(i); if (ch == '%') { diff --git a/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java b/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java index 56775af..530dd4c 100644 --- a/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java +++ b/lib/src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java @@ -21,7 +21,7 @@ class UrlEncoderTest { ); @Test - public void testDecodeURL() { + void testDecodeURL() { assertNull(UrlEncoder.decode(null)); assertSame(same, UrlEncoder.decode(same)); validMap.forEach((expected, source) -> assertEquals(expected, UrlEncoder.decode(source))); @@ -32,7 +32,7 @@ class UrlEncoderTest { } @Test - public void testEncodeURL() { + void testEncodeURL() { assertNull(UrlEncoder.encode(null)); assertTrue(UrlEncoder.encode("").isEmpty()); assertSame(same, UrlEncoder.encode(same)); From 3208aa4cca7bb98c72262ba5fb4de46bb6185af9 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:18:07 -0500 Subject: [PATCH 06/14] Code cleanups --- lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index 06e7978..d7b7f7b 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -32,6 +32,10 @@ public abstract class UrlEncoder { UNRESERVED_URI_CHARS = unreserved; } + private UrlEncoder() { + throw new IllegalStateException("UrlEncoder shouldn't be instantiated"); + } + private static void appendUrlEncodedByte(StringBuilder out, int ch) { out.append("%"); appendUrlEncodedDigit(out, ch >> 4); @@ -155,7 +159,8 @@ public abstract class UrlEncoder { StringBuilder out = null; char ch; - for (var i = 0; i < source.length(); ) { + var i = 0; + while(i < source.length()) { ch = source.charAt(i); if (isUnreservedUriChar(ch) || allow.indexOf(ch) != -1) { if (out != null) { From b2a313e02778166cf8b081cdd7ec70cba8318434 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:34:43 -0500 Subject: [PATCH 07/14] Activated code coverage --- lib/build.gradle.kts | 8 ++++++++ lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 4 ---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts index 758293f..056b963 100644 --- a/lib/build.gradle.kts +++ b/lib/build.gradle.kts @@ -2,6 +2,7 @@ plugins { `java-library` `maven-publish` signing + jacoco id("org.sonarqube") version "3.5.0.2730" } @@ -19,6 +20,13 @@ java { } } +tasks.jacocoTestReport { + reports { + xml.required.set(true) + html.required.set(true) + } +} + sonarqube { properties { property("sonar.projectName", rootProject.name) diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index d7b7f7b..7adee18 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -32,10 +32,6 @@ public abstract class UrlEncoder { UNRESERVED_URI_CHARS = unreserved; } - private UrlEncoder() { - throw new IllegalStateException("UrlEncoder shouldn't be instantiated"); - } - private static void appendUrlEncodedByte(StringBuilder out, int ch) { out.append("%"); appendUrlEncodedDigit(out, ch >> 4); From 73fcf2bf7cb83316b0f5a60f2712f890cafe5011 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:47:45 -0500 Subject: [PATCH 08/14] Build file tweaks --- lib/build.gradle.kts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts index 056b963..7caf895 100644 --- a/lib/build.gradle.kts +++ b/lib/build.gradle.kts @@ -12,6 +12,7 @@ base { archivesName.set("urlencoder") version = "0.9-SNAPSHOT" } + java { withJavadocJar() withSourcesJar() @@ -23,16 +24,16 @@ java { tasks.jacocoTestReport { reports { xml.required.set(true) - html.required.set(true) } } sonarqube { properties { property("sonar.projectName", rootProject.name) - property("sonar.projectKey", "gbevin_urlencoder") + property("sonar.projectKey", "gbevin_${rootProject.name}") property("sonar.organization", "gbevin") property("sonar.host.url", "https://sonarcloud.io") + property("sonar.sourceEncoding", "UTF-8") } } repositories { From 051e0f2adb3f3b04958cffe675e8d75e8267ef5d Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 08:50:28 -0500 Subject: [PATCH 09/14] Updated GitHub flow --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 9f3c3b4..6a6ae16 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -53,7 +53,7 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} - run: ./gradlew sonarqube --info + run: ./gradlew jacocoTestReport sonar --info - name: Cleanup Gradle Cache run: | From 361d41b82f81ba5eae290b8a998ad72a32187a8a Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 09:04:42 -0500 Subject: [PATCH 10/14] Updated readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2d8e866..4506f2d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Nexus Snapshot](https://img.shields.io/nexus/s/com.uwyn/urlencoder?server=https%3A%2F%2Fs01.oss.sonatype.org%2F)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/uwyn/urlencoder/) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gbevin_urlencoder&metric=alert_status)](https://sonarcloud.io/dashboard?id=gbevin_urlencoder) [![GitHub CI](https://github.com/gbevin/urlencoder/actions/workflows/gradle.yml/badge.svg)](https://github.com/gbevin/urlencoder/actions/workflows/gradle.yml) # URL Encoder for Java From 12d7fd7941b8c8b6d48e60f29688ff7a51e95606 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 09:06:58 -0500 Subject: [PATCH 11/14] Updated readme --- lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index 7adee18..1962f61 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -76,7 +76,6 @@ public abstract class UrlEncoder { // of the encoding format %xx, is the maximum number of // bytes that can be extracted bytes_buffer = new byte[(length - i) / 3]; - bytes_pos = 0; } i += 1; From 34d109d77862c80a5b20d4fa13e71b471cecde45 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 12:18:29 -0500 Subject: [PATCH 12/14] Added Eric C. Thauvin as author --- lib/build.gradle.kts | 6 ++++++ lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 1 + 2 files changed, 7 insertions(+) diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts index 7caf895..d4d2d43 100644 --- a/lib/build.gradle.kts +++ b/lib/build.gradle.kts @@ -69,6 +69,12 @@ publishing { name.set("Geert Bevin") email.set("gbevin@uwyn.com") } + developer { + id.set("ethauvin") + name.set("Erik C. Thauvin") + email.set("erik@thauvin.net") + url.set("https://erik.thauvin.net/") + } } scm { connection.set("scm:git:https://github.com/gbevin/urlencoder.git") diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index 1962f61..b0237cc 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -13,6 +13,7 @@ import java.util.BitSet; * Rules determined by RFC 3986. * * @author Geert Bevin (gbevin[remove] at uwyn dot com) + * @author Erik C. Thauvin (erik@thauvin.net) * @since 1.0 */ public abstract class UrlEncoder { From 9dccf4afdaef19dfe24f1b119bab49355fafee69 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 12:18:39 -0500 Subject: [PATCH 13/14] Enabled JDK 19 for testing --- .github/workflows/gradle.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index 6a6ae16..ef31be6 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -12,7 +12,7 @@ jobs: strategy: matrix: - java-version: [ 11, 17 ] + java-version: [ 11, 17, 19 ] steps: - uses: actions/checkout@v2 From 262e9d6d2990b7262104918ffb410512cfea0227 Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Sat, 31 Dec 2022 12:42:21 -0500 Subject: [PATCH 14/14] Change UrlEncoder to convey utility class semantics. --- lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java index b0237cc..d751011 100644 --- a/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java +++ b/lib/src/main/java/com/uwyn/urlencoder/UrlEncoder.java @@ -16,7 +16,7 @@ import java.util.BitSet; * @author Erik C. Thauvin (erik@thauvin.net) * @since 1.0 */ -public abstract class UrlEncoder { +public final class UrlEncoder { static final BitSet UNRESERVED_URI_CHARS; private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray(); @@ -43,6 +43,10 @@ public abstract class UrlEncoder { out.append(HEX_DIGITS[digit & 0x0F]); } + private UrlEncoder() { + // no-op + } + /** * Transforms a provided String URL into a new string, * containing decoded URL characters in the UTF-8 encoding.