mirror of
https://github.com/gbevin/urlencoder.git
synced 2025-04-24 23:07:12 -07:00
Compare commits
78 commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b20e8a5e48 | |||
| 9d5dc90f13 | |||
| 7b6fb79e15 | |||
| 4821e236ad | |||
|
4f5033862c | ||
| 297475c28a | |||
| eae1956ff2 | |||
| fa63916eeb | |||
| 39a5b36f88 | |||
| 1072c1a14d | |||
| 678c3fd356 | |||
| 23713874a0 | |||
| 1ea5b17101 | |||
| 35bf94f2f5 | |||
| bc03fb03ab | |||
| ea8fd08ffc | |||
| f27d846afd | |||
| 692aa5fbab | |||
| 96d38ac40e | |||
| 27f12c169b | |||
| 6f8fc8df36 | |||
| baa1784ca1 | |||
| af154ed603 | |||
| 0031864b76 | |||
| 626e20d030 | |||
| 3f3447a48b | |||
| 4afb8ab50f | |||
| cdad2dd145 | |||
| c9c36c444f | |||
|
62f9d7e46a | ||
| c4fb56ba6d | |||
| 35ff42a5c8 | |||
| f075688ddd | |||
| df4bf1a4c0 | |||
| 844db85cbe | |||
| b8322bfe9f | |||
| 5b293d9ca8 | |||
| d7437f3167 | |||
| 783a044cab | |||
| 70bfd2e663 | |||
| 7e03e1e275 | |||
| 2409932ac5 | |||
| 6bebfc3cab | |||
| 5c2881c845 | |||
| f84caca6b2 | |||
| 9c3e68bb44 | |||
| a02e617f5b | |||
| 954aa3e92e | |||
| b12f3eafd7 | |||
| 320be3b3a1 | |||
| 92d767aadf | |||
| 444175e01a | |||
| 23707b9d18 | |||
| 5627d6db35 | |||
| 9c103b8f9c | |||
| a7eaf1a608 | |||
| 1370da18bb | |||
| 3ff4549d0e | |||
| 266691467b | |||
| 97bc6137a3 | |||
| ca82b1ec6d | |||
| a5dfff64a0 | |||
| c3fad893f1 | |||
| c98db644bd | |||
| 076c95d132 | |||
| 76fc4b6815 | |||
| 4ed86c9a1d | |||
| 1ee9721d3c | |||
| 2ae47b770f | |||
| bfeb894372 | |||
| 48bc321058 | |||
| f3c7853d02 | |||
| 0f12ed90cc | |||
| 3171b82ae1 | |||
| 79264bdb68 | |||
| 9af78b38d9 | |||
| f5485bf2d5 | |||
| 1e4a930864 |
34 changed files with 807 additions and 628 deletions
9
.gitattributes
vendored
9
.gitattributes
vendored
|
|
@ -1,9 +0,0 @@
|
|||
#
|
||||
# https://help.github.com/articles/dealing-with-line-endings/
|
||||
#
|
||||
# Linux start script should use lf
|
||||
/gradlew text eol=lf
|
||||
|
||||
# These are Windows script files and should use crlf
|
||||
*.bat text eol=crlf
|
||||
|
||||
29
.github/workflows/bld.yml
vendored
Normal file
29
.github/workflows/bld.yml
vendored
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
name: bld-ci
|
||||
|
||||
on: [ push, pull_request, workflow_dispatch ]
|
||||
|
||||
jobs:
|
||||
build-gradle-project:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
java-version: [ 17, 19, 20 ]
|
||||
|
||||
steps:
|
||||
- name: Checkout source repository
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up JDK ${{ matrix.java-version }}
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
distribution: 'zulu'
|
||||
java-version: ${{ matrix.java-version }}
|
||||
|
||||
- name: Run tests
|
||||
run: >-
|
||||
./bld download compile test
|
||||
-DtestsBadgeUrl=https://rife2.com/tests-badge/update/com.uwyn/urlencoder
|
||||
-DtestsBadgeApiKey=${{ secrets.TESTS_BADGE_API_KEY }}
|
||||
63
.github/workflows/gradle.yml
vendored
63
.github/workflows/gradle.yml
vendored
|
|
@ -1,63 +0,0 @@
|
|||
name: gradle-ci
|
||||
|
||||
on: [push, pull_request, workflow_dispatch]
|
||||
|
||||
jobs:
|
||||
build-gradle-project:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
env:
|
||||
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m"
|
||||
SONAR_JDK: "11"
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
java-version: [ 11, 17, 19 ]
|
||||
|
||||
steps:
|
||||
- name: Checkout source repository
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up JDK ${{ matrix.java-version }}
|
||||
uses: actions/setup-java@v2
|
||||
with:
|
||||
distribution: 'temurin'
|
||||
java-version: ${{ matrix.java-version }}
|
||||
|
||||
- name: Grant execute permission for gradlew
|
||||
run: chmod +x gradlew
|
||||
|
||||
- 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: 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
|
||||
|
||||
- name: SonarCloud
|
||||
if: success() && matrix.java-version == env.SONAR_JDK
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: ./gradlew jacocoTestReport sonar --info
|
||||
|
||||
- name: Cleanup Gradle Cache
|
||||
run: |
|
||||
rm -f ~/.gradle/caches/modules-2/modules-2.lock
|
||||
rm -f ~/.gradle/caches/modules-2/gc.properties
|
||||
54
.gitignore
vendored
54
.gitignore
vendored
|
|
@ -1,3 +1,55 @@
|
|||
.gradle
|
||||
.DS_Store
|
||||
build
|
||||
.idea
|
||||
lib/bld/**
|
||||
lib/compile/**
|
||||
lib/runtime/**
|
||||
lib/standalone/**
|
||||
lib/test/**
|
||||
!bld-wrapper.jar
|
||||
!bld-wrapper.properties
|
||||
|
||||
# IDEA ignores
|
||||
|
||||
# User-specific
|
||||
.idea/**/workspace.xml
|
||||
.idea/**/tasks.xml
|
||||
.idea/**/usage.statistics.xml
|
||||
.idea/**/dictionaries
|
||||
.idea/**/shelf
|
||||
|
||||
# AWS User-specific
|
||||
.idea/**/aws.xml
|
||||
|
||||
# Generated files
|
||||
.idea/**/contentModel.xml
|
||||
|
||||
# Sensitive or high-churn files
|
||||
.idea/**/dataSources/
|
||||
.idea/**/dataSources.ids
|
||||
.idea/**/dataSources.local.xml
|
||||
.idea/**/sqlDataSources.xml
|
||||
.idea/**/dynamic.xml
|
||||
.idea/**/uiDesigner.xml
|
||||
.idea/**/dbnavigator.xml
|
||||
|
||||
# Gradle
|
||||
.idea/**/gradle.xml
|
||||
|
||||
# Mongo Explorer plugin
|
||||
.idea/**/mongoSettings.xml
|
||||
|
||||
# mpeltonen/sbt-idea plugin
|
||||
.idea_modules/
|
||||
|
||||
# JIRA plugin
|
||||
atlassian-ide-plugin.xml
|
||||
|
||||
# Cursive Clojure plugin
|
||||
.idea/replstate.xml
|
||||
|
||||
# SonarLint plugin
|
||||
.idea/sonarlint/
|
||||
|
||||
# Editor-based Rest Client
|
||||
.idea/httpRequests
|
||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
28
.idea/app.iml
generated
Normal file
28
.idea/app.iml
generated
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="JAVA_MODULE" version="4">
|
||||
<component name="NewModuleRootManager">
|
||||
<output url="file://$MODULE_DIR$/build/main" />
|
||||
<output-test url="file://$MODULE_DIR$/build/test" />
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$">
|
||||
<sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/src/main/resources/templates" />
|
||||
</content>
|
||||
<orderEntry type="inheritedJdk" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
<orderEntry type="module-library" scope="RUNTIME">
|
||||
<library>
|
||||
<CLASSES>
|
||||
<root url="file://$MODULE_DIR$/src/main/resources/templates" />
|
||||
</CLASSES>
|
||||
<JAVADOC />
|
||||
<SOURCES />
|
||||
</library>
|
||||
</orderEntry>
|
||||
<orderEntry type="library" name="compile" level="project" />
|
||||
<orderEntry type="library" scope="RUNTIME" name="runtime" level="project" />
|
||||
<orderEntry type="library" scope="TEST" name="test" level="project" />
|
||||
</component>
|
||||
</module>
|
||||
14
.idea/bld.iml
generated
Normal file
14
.idea/bld.iml
generated
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="JAVA_MODULE" version="4">
|
||||
<component name="NewModuleRootManager">
|
||||
<output url="file://$MODULE_DIR$/build/bld" />
|
||||
<output-test url="file://$MODULE_DIR$/build/bld" />
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$/src/bld">
|
||||
<sourceFolder url="file://$MODULE_DIR$/src/bld/java" isTestSource="false" />
|
||||
</content>
|
||||
<orderEntry type="inheritedJdk" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
<orderEntry type="library" name="bld" level="project" />
|
||||
</component>
|
||||
</module>
|
||||
18
.idea/libraries/bld.xml
generated
Normal file
18
.idea/libraries/bld.xml
generated
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<component name="libraryTable">
|
||||
<library name="bld">
|
||||
<CLASSES>
|
||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||
<root url="jar://$USER_HOME$/.bld/dist/bld-1.8.0.jar!/" />
|
||||
</CLASSES>
|
||||
<JAVADOC />
|
||||
<SOURCES>
|
||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||
<root url="jar://$USER_HOME$/.bld/dist/bld-1.8.0-sources.jar!/" />
|
||||
</SOURCES>
|
||||
<excluded>
|
||||
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
||||
</excluded>
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" />
|
||||
</library>
|
||||
</component>
|
||||
17
.idea/libraries/compile.xml
generated
Normal file
17
.idea/libraries/compile.xml
generated
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<component name="libraryTable">
|
||||
<library name="compile">
|
||||
<CLASSES>
|
||||
<root url="file://$PROJECT_DIR$/lib/compile" />
|
||||
<root url="file://$PROJECT_DIR$/lib/provided" />
|
||||
</CLASSES>
|
||||
<JAVADOC />
|
||||
<SOURCES>
|
||||
<root url="file://$PROJECT_DIR$/lib/compile" />
|
||||
<root url="file://$PROJECT_DIR$/lib/provided" />
|
||||
</SOURCES>
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/compile" recursive="false" type="SOURCES" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="false" type="SOURCES" />
|
||||
</library>
|
||||
</component>
|
||||
13
.idea/libraries/runtime.xml
generated
Normal file
13
.idea/libraries/runtime.xml
generated
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<component name="libraryTable">
|
||||
<library name="runtime">
|
||||
<CLASSES>
|
||||
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
||||
</CLASSES>
|
||||
<JAVADOC />
|
||||
<SOURCES>
|
||||
<root url="file://$PROJECT_DIR$/lib/runtime" />
|
||||
</SOURCES>
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/runtime" recursive="false" type="SOURCES" />
|
||||
</library>
|
||||
</component>
|
||||
18
.idea/libraries/test.xml
generated
Normal file
18
.idea/libraries/test.xml
generated
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<component name="libraryTable">
|
||||
<library name="test">
|
||||
<CLASSES>
|
||||
<root url="file://$PROJECT_DIR$/lib/test" />
|
||||
<root url="file://$PROJECT_DIR$/lib/provided" />
|
||||
<root url="file://$PROJECT_DIR$/src/test/resources" />
|
||||
</CLASSES>
|
||||
<JAVADOC />
|
||||
<SOURCES>
|
||||
<root url="file://$PROJECT_DIR$/lib/test" />
|
||||
<root url="file://$PROJECT_DIR$/lib/provided" />
|
||||
</SOURCES>
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/test" recursive="false" type="SOURCES" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="false" />
|
||||
<jarDirectory url="file://$PROJECT_DIR$/lib/provided" recursive="false" type="SOURCES" />
|
||||
</library>
|
||||
</component>
|
||||
8
.idea/misc.xml
generated
Normal file
8
.idea/misc.xml
generated
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<project version="4">
|
||||
<component name="PDMPlugin">
|
||||
<option name="skipTestSources" value="false" />
|
||||
</component>
|
||||
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" project-jdk-name="17" project-jdk-type="JavaSDK">
|
||||
<output url="file://$PROJECT_DIR$/build" />
|
||||
</component>
|
||||
</project>
|
||||
9
.idea/modules.xml
generated
Normal file
9
.idea/modules.xml
generated
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectModuleManager">
|
||||
<modules>
|
||||
<module fileurl="file://$PROJECT_DIR$/.idea/app.iml" filepath="$PROJECT_DIR$/.idea/app.iml" />
|
||||
<module fileurl="file://$PROJECT_DIR$/.idea/bld.iml" filepath="$PROJECT_DIR$/.idea/bld.iml" />
|
||||
</modules>
|
||||
</component>
|
||||
</project>
|
||||
9
.idea/runConfigurations/Run Main.xml
generated
Normal file
9
.idea/runConfigurations/Run Main.xml
generated
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<component name="ProjectRunConfigurationManager">
|
||||
<configuration default="false" name="Run Main" type="Application" factoryName="Application" nameIsGenerated="true">
|
||||
<option name="MAIN_CLASS_NAME" value="com.uwyn.urlencoder.UrlEncoder" />
|
||||
<module name="app" />
|
||||
<method v="2">
|
||||
<option name="Make" enabled="true" />
|
||||
</method>
|
||||
</configuration>
|
||||
</component>
|
||||
13
.idea/runConfigurations/Run Tests.xml
generated
Normal file
13
.idea/runConfigurations/Run Tests.xml
generated
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<component name="ProjectRunConfigurationManager">
|
||||
<configuration default="false" name="Run Tests" type="JUnit" factoryName="JUnit">
|
||||
<module name="app" />
|
||||
<option name="PACKAGE_NAME" value="moog" />
|
||||
<option name="MAIN_CLASS_NAME" value="com.uwyn.urlencoder" />
|
||||
<option name="METHOD_NAME" value="" />
|
||||
<option name="TEST_OBJECT" value="directory" />
|
||||
<dir value="$PROJECT_DIR$/src/test/java" />
|
||||
<method v="2">
|
||||
<option name="Make" enabled="true" />
|
||||
</method>
|
||||
</configuration>
|
||||
</component>
|
||||
6
.idea/vcs.xml
generated
Normal file
6
.idea/vcs.xml
generated
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
24
.vscode/launch.json
vendored
Normal file
24
.vscode/launch.json
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"type": "java",
|
||||
"name": "Run Main",
|
||||
"request": "launch",
|
||||
"mainClass": "com.uwyn.urlencoder.UrlEncoder"
|
||||
},
|
||||
{
|
||||
"type": "java",
|
||||
"name": "Run Tests",
|
||||
"request": "launch",
|
||||
"mainClass": "org.junit.platform.console.ConsoleLauncher",
|
||||
"args": [
|
||||
"--details=verbose",
|
||||
"--scan-classpath",
|
||||
"--disable-banner",
|
||||
"--disable-ansi-colors",
|
||||
"--exclude-engine=junit-platform-suite",
|
||||
"--exclude-engine=junit-vintage"]
|
||||
}
|
||||
]
|
||||
}
|
||||
16
.vscode/settings.json
vendored
Normal file
16
.vscode/settings.json
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"java.project.sourcePaths": [
|
||||
"src/main/java",
|
||||
"src/main/resources",
|
||||
"src/test/java",
|
||||
"src/bld/java"
|
||||
],
|
||||
"java.configuration.updateBuildConfiguration": "automatic",
|
||||
"java.project.referencedLibraries": [
|
||||
"${HOME}bld-1.7.0.jar",
|
||||
"lib/bld/*.jar",
|
||||
"lib/compile/*.jar",
|
||||
"lib/runtime/*.jar",
|
||||
"lib/test/*.jar"
|
||||
]
|
||||
}
|
||||
124
README.md
124
README.md
|
|
@ -1,35 +1,47 @@
|
|||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
[](https://s01.oss.sonatype.org/content/repositories/snapshots/com/uwyn/urlencoder/)
|
||||
[](https://sonarcloud.io/dashboard?id=gbevin_urlencoder)
|
||||
[](https://github.com/gbevin/urlencoder/actions/workflows/gradle.yml)
|
||||
[](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
|
||||
[](https://s01.oss.sonatype.org/content/repositories/snapshots/com/uwyn/urlencoder/)
|
||||
[](https://github.com/gbevin/urlencoder/releases/latest)
|
||||
[](https://maven-badges.herokuapp.com/maven-central/com.uwyn/urlencoder)
|
||||
[](https://github.com/gbevin/urlencoder/actions/workflows/bld.yml)
|
||||
[](https://github.com/gbevin/urlencoder/actions/workflows/gradle.yml)
|
||||
|
||||
# URL Encoder for Java
|
||||
|
||||
A simple library to encode/decode URL parameters.
|
||||
A simple defensive library to encode/decode URL components.
|
||||
|
||||
This library was extracted from the [RIFE2 Web Application Framework](https://rife2.com).
|
||||
A Kotlin version can also be found at [https://github.com/ethauvin/urlencoder](https://github.com/ethauvin/urlencoder).
|
||||
A Kotlin Multiplatform 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
|
||||
parameters, not URLs, causing the wrong escape sequences to be used.
|
||||
The rules are determined by combining the unreserved character set from
|
||||
[RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#page-13) with the
|
||||
percent-encode set from
|
||||
[application/x-www-form-urlencoded](https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set).
|
||||
|
||||
Additionally, `java.net.URLEncoder` allocates memory even when no encoding is
|
||||
necessary, significantly impacting performance. This library has a negligible
|
||||
performance impact when the string that is passed in doesn't need to be encoded.
|
||||
Both specs above support percent decoding of two hexadecimal digits to a
|
||||
binary octet, however their unreserved set of characters differs and
|
||||
`application/x-www-form-urlencoded` adds conversion of space to `+`,
|
||||
that has the potential to be misunderstood.
|
||||
|
||||
Android's [Uri.encode](https://developer.android.com/reference/android/net/Uri#encode(java.lang.String,%20java.lang.String))
|
||||
also addresses these issues.
|
||||
This class encodes with rules that will be decoded correctly in either case.
|
||||
|
||||
Additionally, this library allocates no memory when encoding isn't needed and
|
||||
does the work in a single pass without multiple loops. Both of these
|
||||
optimizations have a significantly beneficial impact on performance of encoding
|
||||
compared to other solutions like the standard `URLEncoder` in the JDK or
|
||||
`UriUtils` in Spring.
|
||||
|
||||
## Examples (TL;DR)
|
||||
|
||||
```java
|
||||
UrlEncoder.encode("a test &"); // -> "a%20test%20%26"
|
||||
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.encode("a test &"); // -> "a%20test%20%26"
|
||||
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.encode("foo bar", true); // -> "foo+bar" (encode space to +)
|
||||
|
||||
UrlEncoder.decode("a%20test%20%26"); // -> "a test &"
|
||||
UrlEncoder.decode("a%20test%20%26"); // -> "a test &"
|
||||
UrlEncoder.decode("%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81"); // -> "%#okékÉȢ smile!😁"
|
||||
UrlEncoder.decode("foo+bar", true); // -> "foo bar" (decode + to space)
|
||||
```
|
||||
|
||||
## Gradle, Maven, etc.
|
||||
|
|
@ -37,8 +49,82 @@ To use with [Gradle](https://gradle.org/), include the following dependency in y
|
|||
|
||||
```gradle
|
||||
dependencies {
|
||||
implementation("com.uwyn:urlencoder:1.0.0")
|
||||
implementation("com.uwyn:urlencoder:1.2.0")
|
||||
}
|
||||
```
|
||||
|
||||
Instructions for using with Maven, Ivy, etc. can be found on Maven Central.
|
||||
Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://maven-badges.herokuapp.com/maven-central/com.uwyn/urlencoder).
|
||||
|
||||
## Standalone usage
|
||||
|
||||
UrlEncoder can be used on the command line also, both for encoding and decoding.
|
||||
|
||||
You have two options:
|
||||
* run it with Gradle
|
||||
* build the jar and launch it with Java
|
||||
|
||||
The usage is as follows:
|
||||
|
||||
```
|
||||
Encode and decode URL components defensively.
|
||||
-e encode (default)
|
||||
-d decode
|
||||
```
|
||||
|
||||
### Running with Gradle
|
||||
|
||||
```shell
|
||||
./gradlew run --args="-e 'a test &'" # -> a%20test%20%26
|
||||
./gradlew run --args="%#okékÉȢ" # -> %25%23ok%C3%A9k%C3%89%C8%A2
|
||||
|
||||
./gradlew run --args="-d 'a%20test%20%26'" # -> a test &
|
||||
```
|
||||
|
||||
### Running with Java
|
||||
|
||||
First build the jar file:
|
||||
|
||||
```shell
|
||||
./gradlew clean jar
|
||||
```
|
||||
|
||||
Then run it:
|
||||
|
||||
```shell
|
||||
java -jar lib/build/libs/urlencoder-*.jar -e "a test &" # -> a%20test%20%26
|
||||
java -jar lib/build/libs/urlencoder-*.jar "%#okékÉȢ" # -> %25%23ok%C3%A9k%C3%89%C8%A2
|
||||
|
||||
java -jar lib/build/libs/urlencoder-*.jar -d "a%20test%20%26" # -> a test &
|
||||
```
|
||||
|
||||
## Why not simply use `java.net.URLEncoder`?
|
||||
|
||||
Apart for being quite inefficient, some URL components encoded with `URLEncoder.encode` might not be able to be properly decoded.
|
||||
|
||||
For example, a simply search query such as:
|
||||
|
||||
```java
|
||||
var u = URLEncoder.encode("foo +bar", StandardCharsets.UTF_8);
|
||||
```
|
||||
|
||||
would be encoded as:
|
||||
|
||||
```
|
||||
foo+%2Bbar
|
||||
```
|
||||
|
||||
Trying to decode it with [Spring](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/util/UriUtils.html#decode(java.lang.String,java.lang.String)), for example:
|
||||
|
||||
```java
|
||||
UriUtils.decode(u, StandardCharsets.UTF_8));
|
||||
```
|
||||
|
||||
would return:
|
||||
|
||||
```
|
||||
foo++bar
|
||||
```
|
||||
|
||||
Unfortunately, decoding with [Uri.decode](https://developer.android.com/reference/android/net/Uri#decode(java.lang.String)) on Android, [decodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI) in Javascript, etc. would yield the exact same result.
|
||||
|
||||
|
||||
|
|
|
|||
2
bld
Executable file
2
bld
Executable file
|
|
@ -0,0 +1,2 @@
|
|||
#!/usr/bin/env sh
|
||||
java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build com.uwyn.urlencoder.UrlEncoderBuild "$@"
|
||||
4
bld.bat
Normal file
4
bld.bat
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
@echo off
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%" == "" set DIRNAME=.
|
||||
java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build com.uwyn.urlencoder.UrlEncoderBuild %*
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
5
gradle/wrapper/gradle-wrapper.properties
vendored
5
gradle/wrapper/gradle-wrapper.properties
vendored
|
|
@ -1,5 +0,0 @@
|
|||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
240
gradlew
vendored
240
gradlew
vendored
|
|
@ -1,240 +0,0 @@
|
|||
#!/bin/sh
|
||||
|
||||
#
|
||||
# Copyright © 2015-2021 the original authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
##############################################################################
|
||||
#
|
||||
# Gradle start up script for POSIX generated by Gradle.
|
||||
#
|
||||
# Important for running:
|
||||
#
|
||||
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||
# noncompliant, but you have some other compliant shell such as ksh or
|
||||
# bash, then to run this script, type that shell name before the whole
|
||||
# command line, like:
|
||||
#
|
||||
# ksh Gradle
|
||||
#
|
||||
# Busybox and similar reduced shells will NOT work, because this script
|
||||
# requires all of these POSIX shell features:
|
||||
# * functions;
|
||||
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||
# * compound commands having a testable exit status, especially «case»;
|
||||
# * various built-in commands including «command», «set», and «ulimit».
|
||||
#
|
||||
# Important for patching:
|
||||
#
|
||||
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||
#
|
||||
# The "traditional" practice of packing multiple parameters into a
|
||||
# space-separated string is a well documented source of bugs and security
|
||||
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||
# options in "$@", and eventually passing that to Java.
|
||||
#
|
||||
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||
# see the in-line comments for details.
|
||||
#
|
||||
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||
# Darwin, MinGW, and NonStop.
|
||||
#
|
||||
# (3) This script is generated from the Groovy template
|
||||
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||
# within the Gradle project.
|
||||
#
|
||||
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||
#
|
||||
##############################################################################
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
|
||||
# Resolve links: $0 may be a link
|
||||
app_path=$0
|
||||
|
||||
# Need this for daisy-chained symlinks.
|
||||
while
|
||||
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||
[ -h "$app_path" ]
|
||||
do
|
||||
ls=$( ls -ld "$app_path" )
|
||||
link=${ls#*' -> '}
|
||||
case $link in #(
|
||||
/*) app_path=$link ;; #(
|
||||
*) app_path=$APP_HOME$link ;;
|
||||
esac
|
||||
done
|
||||
|
||||
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=${0##*/}
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
|
||||
warn () {
|
||||
echo "$*"
|
||||
} >&2
|
||||
|
||||
die () {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
} >&2
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
nonstop=false
|
||||
case "$( uname )" in #(
|
||||
CYGWIN* ) cygwin=true ;; #(
|
||||
Darwin* ) darwin=true ;; #(
|
||||
MSYS* | MINGW* ) msys=true ;; #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
if [ -n "$JAVA_HOME" ] ; then
|
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||
# IBM's JDK on AIX uses strange locations for the executables
|
||||
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||
else
|
||||
JAVACMD=$JAVA_HOME/bin/java
|
||||
fi
|
||||
if [ ! -x "$JAVACMD" ] ; then
|
||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
else
|
||||
JAVACMD=java
|
||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
|
||||
# Increase the maximum file descriptors if we can.
|
||||
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||
case $MAX_FD in #(
|
||||
max*)
|
||||
MAX_FD=$( ulimit -H -n ) ||
|
||||
warn "Could not query maximum file descriptor limit"
|
||||
esac
|
||||
case $MAX_FD in #(
|
||||
'' | soft) :;; #(
|
||||
*)
|
||||
ulimit -n "$MAX_FD" ||
|
||||
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||
esac
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command, stacking in reverse order:
|
||||
# * args from the command line
|
||||
# * the main class name
|
||||
# * -classpath
|
||||
# * -D...appname settings
|
||||
# * --module-path (only if needed)
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if "$cygwin" || "$msys" ; then
|
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||
for arg do
|
||||
if
|
||||
case $arg in #(
|
||||
-*) false ;; # don't mess with options #(
|
||||
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||
[ -e "$t" ] ;; #(
|
||||
*) false ;;
|
||||
esac
|
||||
then
|
||||
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||
fi
|
||||
# Roll the args list around exactly as many times as the number of
|
||||
# args, so each arg winds up back in the position where it started, but
|
||||
# possibly modified.
|
||||
#
|
||||
# NB: a `for` loop captures its iteration list before it begins, so
|
||||
# changing the positional parameters here affects neither the number of
|
||||
# iterations, nor the values presented in `arg`.
|
||||
shift # remove old arg
|
||||
set -- "$@" "$arg" # push replacement arg
|
||||
done
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command;
|
||||
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
|
||||
# shell script including quotes and variable substitutions, so put them in
|
||||
# double quotes to make sure that they get re-expanded; and
|
||||
# * put everything else in single quotes, so that it's not re-expanded.
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
"$@"
|
||||
|
||||
# Stop when "xargs" is not available.
|
||||
if ! command -v xargs >/dev/null 2>&1
|
||||
then
|
||||
die "xargs is not available"
|
||||
fi
|
||||
|
||||
# Use "xargs" to parse quoted args.
|
||||
#
|
||||
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||
#
|
||||
# In Bash we could simply go:
|
||||
#
|
||||
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||
# set -- "${ARGS[@]}" "$@"
|
||||
#
|
||||
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||
# character that might be a shell metacharacter, then use eval to reverse
|
||||
# that process (while maintaining the separation between arguments), and wrap
|
||||
# the whole thing up as a single "set" statement.
|
||||
#
|
||||
# This will of course break if any of these variables contains a newline or
|
||||
# an unmatched quote.
|
||||
#
|
||||
|
||||
eval "set -- $(
|
||||
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||
xargs -n1 |
|
||||
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||
tr '\n' ' '
|
||||
)" '"$@"'
|
||||
|
||||
exec "$JAVACMD" "$@"
|
||||
91
gradlew.bat
vendored
91
gradlew.bat
vendored
|
|
@ -1,91 +0,0 @@
|
|||
@rem
|
||||
@rem Copyright 2015 the original author or authors.
|
||||
@rem
|
||||
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||
@rem you may not use this file except in compliance with the License.
|
||||
@rem You may obtain a copy of the License at
|
||||
@rem
|
||||
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||
@rem
|
||||
@rem Unless required by applicable law or agreed to in writing, software
|
||||
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@rem See the License for the specific language governing permissions and
|
||||
@rem limitations under the License.
|
||||
@rem
|
||||
|
||||
@if "%DEBUG%"=="" @echo off
|
||||
@rem ##########################################################################
|
||||
@rem
|
||||
@rem Gradle startup script for Windows
|
||||
@rem
|
||||
@rem ##########################################################################
|
||||
|
||||
@rem Set local scope for the variables with windows NT shell
|
||||
if "%OS%"=="Windows_NT" setlocal
|
||||
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%"=="" set DIRNAME=.
|
||||
set APP_BASE_NAME=%~n0
|
||||
set APP_HOME=%DIRNAME%
|
||||
|
||||
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
set JAVA_EXE=java.exe
|
||||
%JAVA_EXE% -version >NUL 2>&1
|
||||
if %ERRORLEVEL% equ 0 goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:findJavaFromJavaHome
|
||||
set JAVA_HOME=%JAVA_HOME:"=%
|
||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||
|
||||
if exist "%JAVA_EXE%" goto execute
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||
|
||||
:fail
|
||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||
rem the _cmd.exe /c_ return code!
|
||||
set EXIT_CODE=%ERRORLEVEL%
|
||||
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||
exit /b %EXIT_CODE%
|
||||
|
||||
:mainEnd
|
||||
if "%OS%"=="Windows_NT" endlocal
|
||||
|
||||
:omega
|
||||
BIN
lib/bld/bld-wrapper.jar
Normal file
BIN
lib/bld/bld-wrapper.jar
Normal file
Binary file not shown.
6
lib/bld/bld-wrapper.properties
Normal file
6
lib/bld/bld-wrapper.properties
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
bld.downloadExtensionJavadoc=false
|
||||
bld.downloadExtensionSources=true
|
||||
bld.extensions=com.uwyn.rife2:bld-tests-badge:1.4.6
|
||||
bld.repositories=MAVEN_CENTRAL,RIFE2_RELEASES
|
||||
bld.downloadLocation=
|
||||
bld.version=1.8.0
|
||||
|
|
@ -1,102 +0,0 @@
|
|||
plugins {
|
||||
`java-library`
|
||||
`maven-publish`
|
||||
signing
|
||||
jacoco
|
||||
id("org.sonarqube") version "3.5.0.2730"
|
||||
}
|
||||
|
||||
group = "com.uwyn"
|
||||
|
||||
base {
|
||||
archivesName.set("urlencoder")
|
||||
version = "1.0.0"
|
||||
}
|
||||
|
||||
java {
|
||||
withJavadocJar()
|
||||
withSourcesJar()
|
||||
toolchain {
|
||||
languageVersion.set(JavaLanguageVersion.of(11))
|
||||
}
|
||||
}
|
||||
|
||||
tasks.jacocoTestReport {
|
||||
reports {
|
||||
xml.required.set(true)
|
||||
}
|
||||
}
|
||||
|
||||
sonarqube {
|
||||
properties {
|
||||
property("sonar.projectName", rootProject.name)
|
||||
property("sonar.projectKey", "gbevin_${rootProject.name}")
|
||||
property("sonar.organization", "gbevin")
|
||||
property("sonar.host.url", "https://sonarcloud.io")
|
||||
property("sonar.sourceEncoding", "UTF-8")
|
||||
}
|
||||
}
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
testImplementation("org.junit.jupiter:junit-jupiter:5.9.0")
|
||||
}
|
||||
|
||||
tasks.named<Test>("test") {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
create<MavenPublication>("mavenJava") {
|
||||
artifactId = "urlencoder"
|
||||
from(components["java"])
|
||||
pom {
|
||||
name.set("URL Encoder")
|
||||
description.set("A simple library to encode/decode URL parameters.")
|
||||
url.set("https://github.com/gbevin/urlencoder")
|
||||
licenses {
|
||||
license {
|
||||
name.set("The Apache License, Version 2.0")
|
||||
url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
|
||||
}
|
||||
}
|
||||
developers {
|
||||
developer {
|
||||
id.set("gbevin")
|
||||
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")
|
||||
developerConnection.set("scm:git:git@github.com:gbevin/urlencoder.git")
|
||||
url.set("https://github.com/gbevin/urlencoder")
|
||||
}
|
||||
}
|
||||
repositories {
|
||||
maven {
|
||||
credentials {
|
||||
username = project.properties["ossrhUsername"].toString()
|
||||
password = project.properties["ossrhPassword"].toString()
|
||||
}
|
||||
val releasesRepoUrl = uri("https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/")
|
||||
val snapshotsRepoUrl = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
|
||||
url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
signing {
|
||||
sign(publishing.publications["mavenJava"])
|
||||
}
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
* Copyright 2001-2022 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Licensed under the Apache License, Version 2.0 (the "License")
|
||||
*/
|
||||
package com.uwyn.urlencoder;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class UrlEncoderTest {
|
||||
private String[] invalid = {"sdkjfh%", "sdkjfh%6", "sdkjfh%xx", "sdfjfh%-1"};
|
||||
private String same = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~";
|
||||
private Map<String, String> 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
|
||||
void testDecodeURL() {
|
||||
assertNull(UrlEncoder.decode(null));
|
||||
assertSame(same, UrlEncoder.decode(same));
|
||||
validMap.forEach((expected, source) -> assertEquals(expected, UrlEncoder.decode(source)));
|
||||
|
||||
for (String i : invalid) {
|
||||
assertThrows(IllegalArgumentException.class, () -> UrlEncoder.decode(i));
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
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'));
|
||||
}
|
||||
}
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
/*
|
||||
* This file was generated by the Gradle 'init' task.
|
||||
*
|
||||
* The settings file is used to specify which projects to include in your build.
|
||||
*
|
||||
* Detailed information about configuring a multi-project build in Gradle can be found
|
||||
* in the user manual at https://docs.gradle.org/7.5.1/userguide/multi_project_builds.html
|
||||
*/
|
||||
|
||||
rootProject.name = "urlencoder"
|
||||
include("lib")
|
||||
76
src/bld/java/com/uwyn/urlencoder/UrlEncoderBuild.java
Normal file
76
src/bld/java/com/uwyn/urlencoder/UrlEncoderBuild.java
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
package com.uwyn.urlencoder;
|
||||
|
||||
import rife.bld.Project;
|
||||
import rife.bld.extension.TestsBadgeOperation;
|
||||
import rife.bld.operations.JarOperation;
|
||||
import rife.bld.publish.PublishDeveloper;
|
||||
import rife.bld.publish.PublishInfo;
|
||||
import rife.bld.publish.PublishLicense;
|
||||
import rife.bld.publish.PublishScm;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.jar.Attributes;
|
||||
|
||||
import static rife.bld.dependencies.Repository.*;
|
||||
import static rife.bld.dependencies.Scope.*;
|
||||
|
||||
public class UrlEncoderBuild extends Project {
|
||||
public UrlEncoderBuild() {
|
||||
pkg = "com.uwyn.urlencoder";
|
||||
name = "UrlEncoder";
|
||||
mainClass = "com.uwyn.urlencoder.UrlEncoder";
|
||||
version = version(1,3,5);
|
||||
|
||||
javaRelease = 11;
|
||||
downloadSources = true;
|
||||
autoDownloadPurge = true;
|
||||
|
||||
repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
|
||||
scope(test)
|
||||
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5,10,1)))
|
||||
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1,10,1)));
|
||||
|
||||
jarOperation()
|
||||
.manifestAttribute(Attributes.Name.MAIN_CLASS, mainClass());
|
||||
|
||||
publishOperation()
|
||||
.repository(version.isSnapshot() ? repository("sonatype-snapshots") : repository("sonatype-releases"))
|
||||
.info()
|
||||
.groupId("com.uwyn")
|
||||
.artifactId("urlencoder")
|
||||
.description("A simple defensive library to encode/decode URL components.")
|
||||
.url("https://github.com/rife2/tests-badge")
|
||||
.developer(new PublishDeveloper()
|
||||
.id("gbevin")
|
||||
.name("Geert Bevin")
|
||||
.email("gbevin@uwyn.com")
|
||||
.url("https://github.com/gbevin"))
|
||||
.developer(new PublishDeveloper()
|
||||
.id("ethauvin")
|
||||
.name("Erik C. Thauvin")
|
||||
.email("erik@thauvin.net")
|
||||
.url("https://erik.thauvin.net/"))
|
||||
.license(new PublishLicense()
|
||||
.name("The Apache License, Version 2.0")
|
||||
.url("https://www.apache.org/licenses/LICENSE-2.0.txt"))
|
||||
.scm(new PublishScm()
|
||||
.connection("scm:git:https://github.com/gbevin/urlencoder.git")
|
||||
.developerConnection("scm:git:git@github.com:gbevin/urlencoder.git")
|
||||
.url("https://github.com/gbevin/urlencoder"))
|
||||
.signKey(property("sign.key"))
|
||||
.signPassphrase(property("sign.passphrase"));
|
||||
}
|
||||
|
||||
private final TestsBadgeOperation testsBadgeOperation = new TestsBadgeOperation();
|
||||
public void test()
|
||||
throws Exception {
|
||||
testsBadgeOperation.executeOnce(() -> testsBadgeOperation
|
||||
.url(property("testsBadgeUrl"))
|
||||
.apiKey(property("testsBadgeApiKey"))
|
||||
.fromProject(this));
|
||||
}
|
||||
|
||||
public static void main(String[] args) {
|
||||
new UrlEncoderBuild().start(args);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,16 +1,28 @@
|
|||
/*
|
||||
* Copyright 2001-2022 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Copyright 2001-2023 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Licensed under the Apache License, Version 2.0 (the "License")
|
||||
*/
|
||||
package com.uwyn.urlencoder;
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.ArrayList;
|
||||
import java.util.BitSet;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* URL encoding and decoding.
|
||||
* Most defensive approach to URL encoding and decoding.
|
||||
* <p>
|
||||
* Rules determined by <a href="https://www.rfc-editor.org/rfc/rfc3986#page-13">RFC 3986</a>.
|
||||
* Rules determined by combining the unreserved character set from
|
||||
* <a href="https://www.rfc-editor.org/rfc/rfc3986#page-13">RFC 3986</a> with
|
||||
* the percent-encode set from
|
||||
* <a href="https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set">application/x-www-form-urlencoded</a>.
|
||||
* <p>
|
||||
* Both specs above support percent decoding of two hexadecimal digits to a
|
||||
* binary octet, however their unreserved set of characters differs and
|
||||
* {@code application/x-www-form-urlencoded} adds conversion of space to +,
|
||||
* which has the potential to be misunderstood.
|
||||
* <p>
|
||||
* This class encodes with rules that will be decoded correctly in either case.
|
||||
*
|
||||
* @author Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* @author Erik C. Thauvin (erik@thauvin.net)
|
||||
|
|
@ -22,17 +34,21 @@ public final class UrlEncoder {
|
|||
|
||||
static {
|
||||
// see https://www.rfc-editor.org/rfc/rfc3986#page-13
|
||||
var unreserved = new BitSet('~' + 1);
|
||||
// and https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set
|
||||
var unreserved = new BitSet('z' + 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 UrlEncoder() {
|
||||
// no-op
|
||||
}
|
||||
|
||||
private static void appendUrlEncodedByte(StringBuilder out, int ch) {
|
||||
out.append("%");
|
||||
appendUrlEncodedDigit(out, ch >> 4);
|
||||
|
|
@ -43,10 +59,6 @@ public final class UrlEncoder {
|
|||
out.append(HEX_DIGITS[digit & 0x0F]);
|
||||
}
|
||||
|
||||
private UrlEncoder() {
|
||||
// no-op
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> URL into a new string,
|
||||
* containing decoded URL characters in the UTF-8 encoding.
|
||||
|
|
@ -57,7 +69,21 @@ public final class UrlEncoder {
|
|||
* @since 1.0
|
||||
*/
|
||||
public static String decode(String source) {
|
||||
if (source == null || source.isBlank()) {
|
||||
return decode(source, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> URL into a new string,
|
||||
* containing decoded URL characters in the UTF-8 encoding.
|
||||
*
|
||||
* @param source The string URL that has to be decoded
|
||||
* @param plusToSpace Convert any {@code +} to space.
|
||||
* @return The decoded <code>String</code> object.
|
||||
* @see #encode(String, String)
|
||||
* @since 1.0
|
||||
*/
|
||||
public static String decode(String source, boolean plusToSpace) {
|
||||
if (source == null || source.isEmpty()) {
|
||||
return source;
|
||||
}
|
||||
|
||||
|
|
@ -67,14 +93,11 @@ public final class UrlEncoder {
|
|||
byte[] bytes_buffer = null;
|
||||
var bytes_pos = 0;
|
||||
var i = 0;
|
||||
while(i < length) {
|
||||
while (i < length) {
|
||||
ch = source.charAt(i);
|
||||
|
||||
if (ch == '%') {
|
||||
if (out == null) {
|
||||
out = new StringBuilder(length);
|
||||
out.append(source, 0, i);
|
||||
}
|
||||
out = startConstructingIfNeeded(out, source, i);
|
||||
|
||||
if (bytes_buffer == null) {
|
||||
// the remaining characters divided by the length
|
||||
|
|
@ -97,7 +120,7 @@ public final class UrlEncoder {
|
|||
|
||||
i += 2;
|
||||
} catch (NumberFormatException e) {
|
||||
throw new IllegalArgumentException("Illegal characters in escape sequence: " + e.getMessage());
|
||||
throw new IllegalArgumentException("Illegal characters in escape sequence: " + e.getMessage(), e);
|
||||
}
|
||||
} else {
|
||||
if (bytes_buffer != null) {
|
||||
|
|
@ -107,7 +130,10 @@ public final class UrlEncoder {
|
|||
bytes_pos = 0;
|
||||
}
|
||||
|
||||
if (out != null) {
|
||||
if (plusToSpace && ch == '+') {
|
||||
out = startConstructingIfNeeded(out, source, i);
|
||||
out.append(" ");
|
||||
} else if (out != null) {
|
||||
out.append(ch);
|
||||
}
|
||||
|
||||
|
|
@ -126,6 +152,14 @@ public final class UrlEncoder {
|
|||
return out.toString();
|
||||
}
|
||||
|
||||
private static StringBuilder startConstructingIfNeeded(StringBuilder out, String source, int currentSourcePosition) {
|
||||
if (out == null) {
|
||||
out = new StringBuilder(source.length());
|
||||
out.append(source, 0, currentSourcePosition);
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> object into a new string,
|
||||
* containing only valid URL characters in the UTF-8 encoding.
|
||||
|
|
@ -137,22 +171,7 @@ public final class UrlEncoder {
|
|||
* @since 1.0
|
||||
*/
|
||||
public static String encode(String source) {
|
||||
return encode(source, (String)null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> 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 <code>String</code> object.
|
||||
* @see #decode(String)
|
||||
* @since 1.0
|
||||
*/
|
||||
public static String encode(String source, char... allow) {
|
||||
return encode(source, new String(allow));
|
||||
return encode(source, null, false);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -167,14 +186,45 @@ public final class UrlEncoder {
|
|||
* @since 1.0
|
||||
*/
|
||||
public static String encode(String source, String allow) {
|
||||
if (source == null || source.isBlank()) {
|
||||
return encode(source, allow, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> 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 spaceToPlus Convert any space to {@code +}.
|
||||
* @return The encoded <code>String</code> object.
|
||||
* @see #decode(String)
|
||||
* @since 1.0
|
||||
*/
|
||||
public static String encode(String source, boolean spaceToPlus) {
|
||||
return encode(source, null, spaceToPlus);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided <code>String</code> 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.
|
||||
* @param spaceToPlus Convert any space to {@code +}.
|
||||
* @return The encoded <code>String</code> object.
|
||||
* @see #decode(String)
|
||||
* @since 1.0
|
||||
*/
|
||||
public static String encode(String source, String allow, boolean spaceToPlus) {
|
||||
if (source == null || source.isEmpty()) {
|
||||
return source;
|
||||
}
|
||||
|
||||
StringBuilder out = null;
|
||||
char ch;
|
||||
var i = 0;
|
||||
while(i < source.length()) {
|
||||
while (i < source.length()) {
|
||||
ch = source.charAt(i);
|
||||
if (isUnreservedUriChar(ch) || (allow != null && allow.indexOf(ch) != -1)) {
|
||||
if (out != null) {
|
||||
|
|
@ -182,14 +232,15 @@ public final class UrlEncoder {
|
|||
}
|
||||
i += 1;
|
||||
} else {
|
||||
if (out == null) {
|
||||
out = new StringBuilder(source.length());
|
||||
out.append(source, 0, i);
|
||||
}
|
||||
out = startConstructingIfNeeded(out, source, i);
|
||||
|
||||
var cp = source.codePointAt(i);
|
||||
if (cp < 0x80) {
|
||||
appendUrlEncodedByte(out, cp);
|
||||
if (spaceToPlus && ch == ' ') {
|
||||
out.append('+');
|
||||
} else {
|
||||
appendUrlEncodedByte(out, cp);
|
||||
}
|
||||
i += 1;
|
||||
} else if (Character.isBmpCodePoint(cp)) {
|
||||
for (var b : Character.toString(ch).getBytes(StandardCharsets.UTF_8)) {
|
||||
|
|
@ -215,7 +266,74 @@ public final class UrlEncoder {
|
|||
}
|
||||
|
||||
// see https://www.rfc-editor.org/rfc/rfc3986#page-13
|
||||
// and https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set
|
||||
private static boolean isUnreservedUriChar(char ch) {
|
||||
return ch <= '~' && UNRESERVED_URI_CHARS.get(ch);
|
||||
return ch <= 'z' && UNRESERVED_URI_CHARS.get(ch);
|
||||
}
|
||||
|
||||
/**
|
||||
* Main method to encode/decode URLs on the command line
|
||||
*
|
||||
* @param arguments the command line arguments
|
||||
* @since 1.1
|
||||
*/
|
||||
public static void main(String[] arguments) {
|
||||
try {
|
||||
var result = processMain(arguments);
|
||||
if (result.status == 0) {
|
||||
System.out.println(result.output);
|
||||
} else {
|
||||
System.err.println(result.output);
|
||||
}
|
||||
System.exit(result.status);
|
||||
} catch (IllegalArgumentException e) {
|
||||
System.err.println(UrlEncoder.class.getSimpleName() + ": " + e.getMessage());
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
static MainResult processMain(String... arguments) {
|
||||
var valid_arguments = false;
|
||||
var perform_decode = false;
|
||||
var args = new ArrayList<>(List.of(arguments));
|
||||
if (!args.isEmpty() && args.get(0).startsWith("-")) {
|
||||
var option = args.remove(0);
|
||||
if (("-d").equals(option)) {
|
||||
perform_decode = true;
|
||||
valid_arguments = (args.size() == 1);
|
||||
} else if (("-e").equals(option)) {
|
||||
valid_arguments = (args.size() == 1);
|
||||
} else {
|
||||
args.clear();
|
||||
}
|
||||
}
|
||||
|
||||
var text = "";
|
||||
if (args.size() == 1 && !args.get(0).isEmpty()) {
|
||||
text = args.remove(0);
|
||||
valid_arguments = true;
|
||||
}
|
||||
|
||||
if (!valid_arguments) {
|
||||
return new MainResult("Usage : java -jar urlencoder-*.jar [-ed] text" + System.lineSeparator() +
|
||||
"Encode and decode URL components defensively." + System.lineSeparator() +
|
||||
" -e encode (default)" + System.lineSeparator() +
|
||||
" -d decode", 1);
|
||||
}
|
||||
if (perform_decode) {
|
||||
return new MainResult(UrlEncoder.decode(text), 0);
|
||||
} else {
|
||||
return new MainResult(UrlEncoder.encode(text), 0);
|
||||
}
|
||||
}
|
||||
|
||||
static class MainResult {
|
||||
final String output;
|
||||
final int status;
|
||||
|
||||
public MainResult(String output, int status) {
|
||||
this.output = output;
|
||||
this.status = status;
|
||||
}
|
||||
}
|
||||
}
|
||||
3
src/main/java/module-info.java
Normal file
3
src/main/java/module-info.java
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
module com.uwyn.urlencoder {
|
||||
exports com.uwyn.urlencoder;
|
||||
}
|
||||
169
src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java
Normal file
169
src/test/java/com/uwyn/urlencoder/UrlEncoderTest.java
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
/*
|
||||
* Copyright 2001-2023 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Licensed under the Apache License, Version 2.0 (the "License")
|
||||
*/
|
||||
package com.uwyn.urlencoder;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.params.ParameterizedTest;
|
||||
import org.junit.jupiter.params.provider.Arguments;
|
||||
import org.junit.jupiter.params.provider.MethodSource;
|
||||
import org.junit.jupiter.params.provider.ValueSource;
|
||||
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.junit.jupiter.params.provider.Arguments.arguments;
|
||||
|
||||
class UrlEncoderTest {
|
||||
private final String same = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.";
|
||||
|
||||
private static Stream<String> invalid() {
|
||||
return Stream.of("sdkjfh%", "sdkjfh%6", "sdkjfh%xx", "sdfjfh%-1");
|
||||
}
|
||||
|
||||
private static Stream<Arguments> validMap() {
|
||||
return Stream.of(
|
||||
arguments("a test &", "a%20test%20%26"),
|
||||
arguments(
|
||||
"!abcdefghijklmnopqrstuvwxyz%%ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~=",
|
||||
"%21abcdefghijklmnopqrstuvwxyz%25%25ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.%7E%3D"
|
||||
),
|
||||
arguments("%#okékÉȢ smile!😁", "%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81"),
|
||||
arguments(
|
||||
"\uD808\uDC00\uD809\uDD00\uD808\uDF00\uD808\uDD00",
|
||||
"%F0%92%80%80%F0%92%94%80%F0%92%8C%80%F0%92%84%80"
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testDecodeNotNeeded() {
|
||||
assertSame(same, UrlEncoder.decode(same));
|
||||
assertEquals("", UrlEncoder.decode(""), "decode('')");
|
||||
assertEquals(" ", UrlEncoder.decode(" "), "decode(' ')");
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "decode({0}) should be {1}")
|
||||
@MethodSource("validMap")
|
||||
void testDecodeUrl(String expected, String source) {
|
||||
assertEquals(expected, UrlEncoder.decode(source));
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "decode({0})")
|
||||
@MethodSource("invalid")
|
||||
void testDecodeWithException(String source) {
|
||||
assertThrows(IllegalArgumentException.class, () -> UrlEncoder.decode(source), "decode(" + source + ")");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testDecodeWithNull() {
|
||||
assertNull(UrlEncoder.decode(null), "decode(null)");
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "encode({0}) should be {1}")
|
||||
@MethodSource("validMap")
|
||||
void testEncodeUrl(String source, String expected) {
|
||||
assertEquals(expected, UrlEncoder.encode(source));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testEncodeWhenNoneNeeded() {
|
||||
assertSame(same, UrlEncoder.encode(same));
|
||||
assertSame(same, UrlEncoder.encode(same, ""), "with empty allow");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testEncodeWithAllowArg() {
|
||||
assertEquals("?test=a%20test", UrlEncoder.encode("?test=a test", "=?"), "encode(x, =?)");
|
||||
assertEquals("aaa", UrlEncoder.encode("aaa", "a"), "encode(aaa, a)");
|
||||
assertEquals(" ", UrlEncoder.encode(" ", " "), "encode(' ', ' ')");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testEncodeWithEmptyOrBlank() {
|
||||
assertTrue(UrlEncoder.encode("", "").isEmpty(), "encode('','')");
|
||||
assertEquals("", UrlEncoder.encode(""), "encode('')");
|
||||
assertEquals("%20", UrlEncoder.encode(" "), "encode('')");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testEncodeWithNulls() {
|
||||
assertNull(UrlEncoder.encode(null), "encode(null)");
|
||||
assertNull(UrlEncoder.encode(null, null), "encode(null, null)");
|
||||
assertEquals("foo", UrlEncoder.encode("foo", null), "encode(foo, null");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testEncodeSpaceToPlus() {
|
||||
assertEquals("foo+bar", UrlEncoder.encode("foo bar", true));
|
||||
assertEquals("foo+bar++foo", UrlEncoder.encode("foo bar foo", true));
|
||||
assertEquals("foo bar", UrlEncoder.encode("foo bar", " ", true));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testDecodePlusToSpace() {
|
||||
assertEquals("foo bar", UrlEncoder.decode("foo+bar", true));
|
||||
assertEquals("foo bar foo", UrlEncoder.decode("foo+bar++foo", true));
|
||||
assertEquals("foo bar foo", UrlEncoder.decode("foo+%20bar%20+foo", true));
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "processMain(-d {1}) should be {0}")
|
||||
@MethodSource("validMap")
|
||||
void testMainDecode(String expected, String source) {
|
||||
var result = UrlEncoder.processMain("-d", source);
|
||||
assertEquals(expected, result.output);
|
||||
assertEquals(0, result.status, "processMain(-d " + source + ").status");
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "processMain(-e {0})")
|
||||
@MethodSource("validMap")
|
||||
void testMainEncode(String source, String expected) {
|
||||
var result = UrlEncoder.processMain(source);
|
||||
assertEquals(expected, result.output);
|
||||
assertEquals(0, result.status, "processMain(-e " + source + ").status");
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "processMain(-d {0})")
|
||||
@MethodSource("invalid")
|
||||
void testMainEncodeWithExceptions(String source) {
|
||||
assertThrows(IllegalArgumentException.class, () -> UrlEncoder.processMain("-d", source), source);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testMainTooManyArgs() {
|
||||
assertTrue(UrlEncoder.processMain("foo", "bar", "test").output.contains("Usage :"), "too many args");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testMainWithEmptyArgs() {
|
||||
assertTrue(UrlEncoder.processMain(" ", " ").output.contains("Usage :"), "processMain(' ', ' ')");
|
||||
assertTrue(UrlEncoder.processMain("foo", " ").output.contains("Usage :"), "processMain('foo', ' ')");
|
||||
assertTrue(UrlEncoder.processMain(" ", "foo").output.contains("Usage :"), "processMain(' ', 'foo')");
|
||||
assertTrue(UrlEncoder.processMain("-d ", "").output.contains("Usage :"), "processMain('-d', '')");
|
||||
assertEquals("%20", UrlEncoder.processMain(new String[]{"-e", " "}).output, "processMain('-e', ' ')");
|
||||
assertEquals(" ", UrlEncoder.processMain(new String[]{"-d", " "}).output, "processMain('-d', ' ')");
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(strings = {"", "-d", "-e"})
|
||||
void testMainWithInvalidArgs(String arg) {
|
||||
var result = UrlEncoder.processMain(arg);
|
||||
assertTrue(result.output.contains("Usage :"), "processMain('" + arg + "')");
|
||||
assertEquals(1, result.status, "processMain('" + arg + "').status");
|
||||
}
|
||||
|
||||
@ParameterizedTest(name = "processMain(-e {0})")
|
||||
@MethodSource("validMap")
|
||||
void testMainWithOption(String source, String expected) {
|
||||
var result = UrlEncoder.processMain("-e", source);
|
||||
assertEquals(expected, result.output);
|
||||
assertEquals(0, result.status, "processMain(-e " + source + ").status");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testMainWithUnknownOptions() {
|
||||
assertTrue(UrlEncoder.processMain("-p").output.contains("Usage :"), "processMain(-p)");
|
||||
assertTrue(UrlEncoder.processMain("-").output.contains("Usage :"), "processMain(-)");
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue