Initial commit.
This commit is contained in:
commit
a3645937ca
23 changed files with 1199 additions and 0 deletions
170
lib/build.gradle.kts
Normal file
170
lib/build.gradle.kts
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
import org.gradle.api.tasks.testing.logging.TestExceptionFormat
|
||||
import org.gradle.api.tasks.testing.logging.TestLogEvent
|
||||
import org.jetbrains.dokka.gradle.DokkaTask
|
||||
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
|
||||
|
||||
plugins {
|
||||
id("com.github.ben-manes.versions") version "0.44.0"
|
||||
id("io.gitlab.arturbosch.detekt") version "1.22.0"
|
||||
id("java")
|
||||
id("java-library")
|
||||
id("maven-publish")
|
||||
id("org.jetbrains.dokka") version "1.7.20"
|
||||
id("org.jetbrains.kotlin.jvm") version "1.8.0"
|
||||
id("org.jetbrains.kotlinx.kover") version "0.6.1"
|
||||
id("org.sonarqube") version "3.5.0.2730"
|
||||
id("signing")
|
||||
}
|
||||
|
||||
description = "URL parameters encoding and decoding"
|
||||
group = "net.thauvin.erik"
|
||||
version = "0.9-SNAPSHOT"
|
||||
|
||||
val deployDir = "deploy"
|
||||
val gitHub = "ethauvin/$name"
|
||||
val mavenUrl = "https://github.com/$gitHub"
|
||||
val publicationName = "mavenJava"
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") }
|
||||
}
|
||||
|
||||
dependencies {
|
||||
testImplementation(kotlin("test"))
|
||||
}
|
||||
|
||||
java {
|
||||
sourceCompatibility = JavaVersion.VERSION_11
|
||||
targetCompatibility = JavaVersion.VERSION_11
|
||||
withSourcesJar()
|
||||
}
|
||||
|
||||
sonarqube {
|
||||
properties {
|
||||
property("sonar.projectKey", "ethauvin_$name")
|
||||
property("sonar.organization", "ethauvin-github")
|
||||
property("sonar.host.url", "https://sonarcloud.io")
|
||||
property("sonar.sourceEncoding", "UTF-8")
|
||||
property("sonar.coverage.jacoco.xmlReportPaths", "${project.buildDir}/reports/kover/xml/report.xml")
|
||||
}
|
||||
}
|
||||
|
||||
val javadocJar by tasks.creating(Jar::class) {
|
||||
dependsOn(tasks.dokkaJavadoc)
|
||||
from(tasks.dokkaJavadoc)
|
||||
archiveClassifier.set("javadoc")
|
||||
}
|
||||
|
||||
tasks {
|
||||
withType<KotlinCompile>().configureEach {
|
||||
kotlinOptions.jvmTarget = java.targetCompatibility.toString()
|
||||
}
|
||||
|
||||
withType<Test> {
|
||||
testLogging {
|
||||
exceptionFormat = TestExceptionFormat.FULL
|
||||
events = setOf(TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED)
|
||||
}
|
||||
}
|
||||
|
||||
withType<GenerateMavenPom> {
|
||||
destination = file("$projectDir/pom.xml")
|
||||
}
|
||||
|
||||
clean {
|
||||
doLast {
|
||||
project.delete(fileTree(deployDir))
|
||||
}
|
||||
}
|
||||
|
||||
withType<DokkaTask>().configureEach {
|
||||
dokkaSourceSets {
|
||||
named("main") {
|
||||
moduleName.set("UrlEncoder API")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
val copyToDeploy by registering(Copy::class) {
|
||||
from(configurations.runtimeClasspath) {
|
||||
exclude("annotations-*.jar")
|
||||
}
|
||||
from(jar)
|
||||
into(deployDir)
|
||||
}
|
||||
|
||||
register("deploy") {
|
||||
description = "Copies all needed files to the $deployDir directory."
|
||||
group = PublishingPlugin.PUBLISH_TASK_GROUP
|
||||
dependsOn(clean, build, jar)
|
||||
outputs.dir(deployDir)
|
||||
inputs.files(copyToDeploy)
|
||||
mustRunAfter(clean)
|
||||
}
|
||||
|
||||
jar {
|
||||
archiveBaseName.set(rootProject.name)
|
||||
}
|
||||
|
||||
"sonarqube" {
|
||||
dependsOn(koverReport)
|
||||
}
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
create<MavenPublication>(publicationName) {
|
||||
from(components["java"])
|
||||
artifactId = rootProject.name
|
||||
artifact(javadocJar)
|
||||
pom {
|
||||
name.set(rootProject.name)
|
||||
description.set(project.description)
|
||||
url.set(mavenUrl)
|
||||
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:git://github.com/$gitHub.git")
|
||||
developerConnection.set("scm:git:git@github.com:$gitHub.git")
|
||||
url.set(mavenUrl)
|
||||
}
|
||||
issueManagement {
|
||||
system.set("GitHub")
|
||||
url.set("$mavenUrl/issues")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
repositories {
|
||||
maven {
|
||||
name = "ossrh"
|
||||
url = if (project.version.toString().contains("SNAPSHOT"))
|
||||
uri("https://oss.sonatype.org/content/repositories/snapshots/") else
|
||||
uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
||||
credentials(PasswordCredentials::class)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
signing {
|
||||
useGpgCmd()
|
||||
sign(publishing.publications[publicationName])
|
||||
}
|
||||
12
lib/detekt-baseline.xml
Normal file
12
lib/detekt-baseline.xml
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<SmellBaseline>
|
||||
<ManuallySuppressedIssues/>
|
||||
<CurrentIssues>
|
||||
<ID>MagicNumber:UrlEncoder.kt$UrlEncoder$0x80</ID>
|
||||
<ID>MagicNumber:UrlEncoder.kt$UrlEncoder$0xFF</ID>
|
||||
<ID>MagicNumber:UrlEncoder.kt$UrlEncoder$16</ID>
|
||||
<ID>MagicNumber:UrlEncoder.kt$UrlEncoder$3</ID>
|
||||
<ID>MagicNumber:UrlEncoder.kt$UrlEncoder$4</ID>
|
||||
<ID>NestedBlockDepth:UrlEncoder.kt$UrlEncoder$@JvmStatic fun encode(source: String, vararg allow: Char): String</ID>
|
||||
</CurrentIssues>
|
||||
</SmellBaseline>
|
||||
51
lib/pom.xml
Normal file
51
lib/pom.xml
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||
<!-- This module was also published with a richer model, Gradle metadata, -->
|
||||
<!-- which should be used instead. Do not delete the following line which -->
|
||||
<!-- is to indicate to Gradle or any Gradle module metadata file consumer -->
|
||||
<!-- that they should prefer consuming it instead. -->
|
||||
<!-- do_not_remove: published-with-gradle-metadata -->
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>net.thauvin.erik</groupId>
|
||||
<artifactId>urlencoder</artifactId>
|
||||
<version>0.9-SNAPSHOT</version>
|
||||
<name>urlencoder</name>
|
||||
<description>URL parameters encoding and decoding</description>
|
||||
<url>https://github.com/ethauvin/lib</url>
|
||||
<licenses>
|
||||
<license>
|
||||
<name>The Apache License, Version 2.0</name>
|
||||
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<developers>
|
||||
<developer>
|
||||
<id>gbevin</id>
|
||||
<name>Geert Bevin</name>
|
||||
<email>gbevin@uwyn.com</email>
|
||||
</developer>
|
||||
<developer>
|
||||
<id>ethauvin</id>
|
||||
<name>Erik C. Thauvin</name>
|
||||
<email>erik@thauvin.net</email>
|
||||
<url>https://erik.thauvin.net/</url>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<connection>scm:git:git://github.com/ethauvin/lib.git</connection>
|
||||
<developerConnection>scm:git:git@github.com:ethauvin/lib.git</developerConnection>
|
||||
<url>https://github.com/ethauvin/lib</url>
|
||||
</scm>
|
||||
<issueManagement>
|
||||
<system>GitHub</system>
|
||||
<url>https://github.com/ethauvin/lib/issues</url>
|
||||
</issueManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.jetbrains.kotlin</groupId>
|
||||
<artifactId>kotlin-stdlib-jdk8</artifactId>
|
||||
<version>1.8.0</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</project>
|
||||
168
lib/src/main/kotlin/net/thauvin/erik/urlencoder/UrlEncoder.kt
Normal file
168
lib/src/main/kotlin/net/thauvin/erik/urlencoder/UrlEncoder.kt
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
/*
|
||||
* Copyright 2001-2022 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Copyright 2022 Erik C. Thauvin (erik@thauvin.net)
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* http://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.
|
||||
*/
|
||||
|
||||
package net.thauvin.erik.urlencoder
|
||||
|
||||
import java.nio.charset.StandardCharsets
|
||||
import java.util.BitSet
|
||||
|
||||
/**
|
||||
* URL parameters encoding and decoding.
|
||||
*
|
||||
* @author Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* @author Erik C. Thauvin (erik@thauvin.net)
|
||||
*/
|
||||
object UrlEncoder {
|
||||
private val hexDigits = "0123456789ABCDEF".toCharArray()
|
||||
|
||||
// see https://www.rfc-editor.org/rfc/rfc3986#page-13
|
||||
private val unreservedChars = BitSet('~'.code + 1).apply {
|
||||
set('-')
|
||||
set('.')
|
||||
for (c in '0'..'9') {
|
||||
set(c)
|
||||
}
|
||||
for (c in 'A'..'Z') {
|
||||
set(c)
|
||||
}
|
||||
set('_'.code)
|
||||
for (c in 'a'.code..'z'.code) {
|
||||
set(c)
|
||||
}
|
||||
set('~')
|
||||
}
|
||||
|
||||
private fun BitSet.set(c: Char) = this.set(c.code)
|
||||
|
||||
// see https://www.rfc-editor.org/rfc/rfc3986#page-13
|
||||
private fun Char.isUnreserved(): Boolean {
|
||||
return if (this > '~') false else unreservedChars.get(this.code)
|
||||
}
|
||||
|
||||
private fun StringBuilder.appendEncodedDigit(digit: Int) {
|
||||
this.append(hexDigits[digit and 0x0F])
|
||||
}
|
||||
|
||||
private fun StringBuilder.appendEncodedByte(ch: Int) {
|
||||
this.append("%")
|
||||
this.appendEncodedDigit(ch shr 4)
|
||||
this.appendEncodedDigit(ch)
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided [String] into a new string, containing decoded URL characters in the UTF-8
|
||||
* encoding.
|
||||
*/
|
||||
@JvmStatic
|
||||
fun decode(source: String): String {
|
||||
if (source.isBlank()) {
|
||||
return source
|
||||
}
|
||||
|
||||
val length = source.length
|
||||
var out: StringBuilder? = null
|
||||
var ch: Char
|
||||
var bytesBuffer: ByteArray? = null
|
||||
var bytesPos = 0
|
||||
var i = 0
|
||||
while (i < length) {
|
||||
ch = source[i]
|
||||
if (ch == '%') {
|
||||
if (out == null) {
|
||||
out = StringBuilder(source.length)
|
||||
out.append(source, 0, i)
|
||||
}
|
||||
if (bytesBuffer == null) {
|
||||
// the remaining characters divided by the length of the encoding format %xx, is the maximum number
|
||||
// of bytes that can be extracted
|
||||
bytesBuffer = ByteArray((length - i) / 3)
|
||||
bytesPos = 0
|
||||
}
|
||||
i++
|
||||
require(length >= i + 2) { "Illegal escape sequence" }
|
||||
try {
|
||||
val v: Int = source.substring(i, i + 2).toInt(16)
|
||||
require(v in 0..0xFF) { "Illegal escape value" }
|
||||
bytesBuffer[bytesPos++] = v.toByte()
|
||||
i += 2
|
||||
} catch (e: NumberFormatException) {
|
||||
throw IllegalArgumentException("Illegal characters in escape sequence: $e.message")
|
||||
}
|
||||
} else {
|
||||
if (bytesBuffer != null) {
|
||||
out?.append(String(bytesBuffer, 0, bytesPos, StandardCharsets.UTF_8))
|
||||
bytesBuffer = null
|
||||
bytesPos = 0
|
||||
}
|
||||
out?.append(ch)
|
||||
i++
|
||||
}
|
||||
}
|
||||
|
||||
if (bytesBuffer != null) {
|
||||
out!!.append(String(bytesBuffer, 0, bytesPos, StandardCharsets.UTF_8))
|
||||
}
|
||||
|
||||
return out?.toString() ?: source
|
||||
}
|
||||
|
||||
/**
|
||||
* Transforms a provided [String] object into a new string, containing only valid URL characters in the UTF-8
|
||||
* encoding. Letters, numbers, unreserved (<code>"_-!.~'()*"</code>) and allowed characters are left intact.
|
||||
*/
|
||||
@JvmStatic
|
||||
fun encode(source: String, vararg allow: Char): String {
|
||||
if (source.isBlank()) {
|
||||
return source
|
||||
}
|
||||
|
||||
var out: StringBuilder? = null
|
||||
var ch: Char
|
||||
var i = 0
|
||||
while (i < source.length) {
|
||||
ch = source[i]
|
||||
if (ch.isUnreserved() || allow.contains(ch)) {
|
||||
out?.append(ch)
|
||||
i++
|
||||
} else {
|
||||
if (out == null) {
|
||||
out = StringBuilder(source.length)
|
||||
out.append(source, 0, i)
|
||||
}
|
||||
val cp = source.codePointAt(i)
|
||||
if (cp < 0x80) {
|
||||
out.appendEncodedByte(cp)
|
||||
i++
|
||||
} else if (Character.isBmpCodePoint(cp)) {
|
||||
for (b in ch.toString().toByteArray(StandardCharsets.UTF_8)) {
|
||||
out.appendEncodedByte(b.toInt())
|
||||
}
|
||||
i++
|
||||
} else if (Character.isSupplementaryCodePoint(cp)) {
|
||||
val high = Character.highSurrogate(cp)
|
||||
val low = Character.lowSurrogate(cp)
|
||||
for (b in charArrayOf(high, low).concatToString().toByteArray(StandardCharsets.UTF_8)) {
|
||||
out.appendEncodedByte(b.toInt())
|
||||
}
|
||||
i += 2
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return out?.toString() ?: source
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
/*
|
||||
* Copyright 2001-2022 Geert Bevin (gbevin[remove] at uwyn dot com)
|
||||
* Copyright 2022 Erik C. Thauvin (erik@thauvin.net)
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* http://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.
|
||||
*/
|
||||
|
||||
package net.thauvin.erik.urlencoder
|
||||
|
||||
import net.thauvin.erik.urlencoder.UrlEncoder.decode
|
||||
import net.thauvin.erik.urlencoder.UrlEncoder.encode
|
||||
import org.junit.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertFailsWith
|
||||
import kotlin.test.assertSame
|
||||
|
||||
|
||||
class UrlEncoderTest {
|
||||
private val invalid = arrayOf("sdkjfh%", "sdkjfh%6", "sdkjfh%xx", "sdfjfh%-1")
|
||||
private val same = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~"
|
||||
private val validMap = mapOf(
|
||||
"a test &" to "a%20test%20%26",
|
||||
"!abcdefghijklmnopqrstuvwxyz%%ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~=" to
|
||||
"%21abcdefghijklmnopqrstuvwxyz%25%25ABCDEFGHIJKLMNOPQRSTUVQXYZ0123456789-_.~%3D",
|
||||
"%#okékÉȢ smile!😁" to "%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81"
|
||||
)
|
||||
|
||||
@Test
|
||||
fun testDecode() {
|
||||
assertEquals("", decode(""))
|
||||
assertSame(same, decode(same))
|
||||
validMap.forEach {
|
||||
assertEquals(it.key, decode(it.value))
|
||||
}
|
||||
invalid.forEach {
|
||||
assertFailsWith(IllegalArgumentException::class) {
|
||||
decode(it)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testEncode() {
|
||||
assertEquals("", encode(""))
|
||||
assertSame(same, encode(same))
|
||||
validMap.forEach {
|
||||
assertEquals(it.value, encode(it.key))
|
||||
}
|
||||
assertEquals("?test=a%20test", encode("?test=a test", '=', '?'))
|
||||
assertEquals("aaa", encode("aaa", 'a'))
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue