├── .golangci.yml ├── go.mod ├── README.md ├── encodeuricomponent.go ├── .github └── workflows │ ├── tests.yml │ └── lint.yml ├── go.sum ├── encodeuricomponent_test.go └── LICENSE /.golangci.yml: -------------------------------------------------------------------------------- 1 | linters: 2 | enable: 3 | - gofmt 4 | - nolintlint 5 | 6 | issues: 7 | max-issues-per-linter: 0 8 | max-same-issues: 0 -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/leodido/go-encodeuricomponent 2 | 3 | go 1.19 4 | 5 | require github.com/stretchr/testify v1.8.1 6 | 7 | require ( 8 | github.com/davecgh/go-spew v1.1.1 // indirect 9 | github.com/pmezard/go-difflib v1.0.0 // indirect 10 | gopkg.in/yaml.v3 v3.0.1 // indirect 11 | ) 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-encodeuricomponent 2 | 3 | > A library that replicates the behavior of the `encodeURIComponent` JavaScript function 4 | 5 | ##### Notice 6 | 7 | The current implementation doesn't detect lead and trail surrogates. 8 | 9 | The Javascript `encodeURIComponent` returns an error when one attempts to encode a lone low/high surrogate. 10 | 11 | This library doesn't, at the moment. Supporting this feature is a very valuable way to start contributing! 12 | 13 | Get to know more by reading the [mdn web docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI#encoding_a_lone_high_surrogate_throws). 14 | -------------------------------------------------------------------------------- /encodeuricomponent.go: -------------------------------------------------------------------------------- 1 | package encodeuricomponent 2 | 3 | import ( 4 | "net/url" 5 | "strings" 6 | ) 7 | 8 | // EncodeURIComponent encodes a URI by replacing each instance of 9 | // certain characters by one, two, three, or four escape sequences 10 | // representing the UTF-8 encoding of the character. 11 | // 12 | // It will use 4 escape sequences only for characters composed of 2 surrogate characters. 13 | func EncodeURIComponent(input string) string { 14 | return strings.ReplaceAll( 15 | strings.ReplaceAll( 16 | strings.ReplaceAll( 17 | strings.ReplaceAll( 18 | strings.ReplaceAll( 19 | strings.ReplaceAll( 20 | url.QueryEscape(strings.ReplaceAll(input, " ", "%20")), 21 | "%2520", 22 | "%20", 23 | ), 24 | "%27", 25 | "'", 26 | ), 27 | "%28", 28 | "(", 29 | ), 30 | "%29", 31 | ")", 32 | ), 33 | "%21", 34 | "!", 35 | ), 36 | "%2A", 37 | "*", 38 | ) 39 | } 40 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: tests 2 | 3 | on: 4 | push: 5 | branches: ['main'] 6 | pull_request: 7 | branches: ['main'] 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | build: 14 | strategy: 15 | fail-fast: true 16 | matrix: 17 | os: [ubuntu-latest, macos-latest] 18 | runs-on: ${{ matrix.os }} 19 | 20 | steps: 21 | - name: Set up Go 1.19 22 | uses: actions/setup-go@v3 23 | with: 24 | go-version: 1.19 25 | 26 | - name: Check out the source code 27 | uses: actions/checkout@v3 28 | 29 | - name: Restore the Go modules cache 30 | uses: actions/cache@v3 31 | with: 32 | path: ~/go/pkg/mod 33 | key: go-${{ runner.os }}-${{ hashFiles('go.mod') }} 34 | restore-keys: | 35 | go-${{ runner.os }}- 36 | 37 | - name: Download Go modules 38 | run: go mod download 39 | 40 | - name: Run tests 41 | run: go test -race ./... 42 | 43 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 2 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 3 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 5 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 6 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 7 | github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= 8 | github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= 9 | github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 10 | github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= 11 | github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= 12 | github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= 13 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 14 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 15 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 16 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 17 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 18 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: linting 2 | 3 | on: 4 | push: 5 | paths: 6 | - "**.go" 7 | - go.mod 8 | - go.sum 9 | branches: ['main'] 10 | pull_request: 11 | paths: 12 | - "**.go" 13 | - go.mod 14 | - go.sum 15 | branches: ['main'] 16 | 17 | permissions: 18 | contents: read 19 | 20 | jobs: 21 | lint: 22 | runs-on: ubuntu-latest 23 | 24 | steps: 25 | - name: Set up Go 1.19 26 | uses: actions/setup-go@v3 27 | with: 28 | go-version: 1.19 29 | 30 | - name: Check out the source code 31 | uses: actions/checkout@v3 32 | 33 | - name: Restore the Go modules cache 34 | uses: actions/cache@v3 35 | with: 36 | path: ~/go/pkg/mod 37 | key: go-${{ runner.os }}-${{ hashFiles('go.mod') }} 38 | restore-keys: | 39 | go-${{ runner.os }}- 40 | - name: Verify the dependencies 41 | run: | 42 | go mod verify 43 | go mod download 44 | LINT_VERSION=1.50.1 45 | curl -fsSL https://github.com/golangci/golangci-lint/releases/download/v${LINT_VERSION}/golangci-lint-${LINT_VERSION}-linux-amd64.tar.gz | tar xz --strip-components 1 --wildcards \*/golangci-lint 46 | mkdir -p bin && mv golangci-lint bin/ 47 | - name: Check 48 | run: | 49 | STATUS=0 50 | assert-nothing-changed() { 51 | local diff 52 | "$@" >/dev/null || return 1 53 | if ! diff="$(git diff -U1 --color --exit-code)"; then 54 | printf '\e[31mError: running `\e[1m%s\e[22m` results in modifications that you must check into version control:\e[0m\n%s\n\n' "$*" "$diff" >&2 55 | git checkout -- . 56 | STATUS=1 57 | fi 58 | } 59 | assert-nothing-changed go fmt ./... 60 | assert-nothing-changed go mod tidy 61 | bin/golangci-lint run --out-format=github-actions --timeout=3m || STATUS=$? 62 | exit $STATUS -------------------------------------------------------------------------------- /encodeuricomponent_test.go: -------------------------------------------------------------------------------- 1 | package encodeuricomponent 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/stretchr/testify/assert" 7 | ) 8 | 9 | func TestEncodeURIComponent(t *testing.T) { 10 | t.Helper() 11 | 12 | type test struct { 13 | input string 14 | output string 15 | } 16 | 17 | cases := []test{ 18 | // UNESCAPE 19 | { 20 | "alphanumeric123", 21 | "alphanumeric123", 22 | }, 23 | { 24 | "ALPHANUMERIC098", 25 | "ALPHANUMERIC098", 26 | }, 27 | { 28 | "asteri*", 29 | "asteri*", 30 | }, 31 | { 32 | "dash-", 33 | "dash-", 34 | }, 35 | { 36 | "dot.", 37 | "dot.", 38 | }, 39 | { 40 | "_underscore", 41 | "_underscore", 42 | }, 43 | { 44 | "~user", 45 | "~user", 46 | }, 47 | { 48 | "single'quote", 49 | "single'quote", 50 | }, 51 | { 52 | "open(", 53 | "open(", 54 | }, 55 | { 56 | "close)", 57 | "close)", 58 | }, 59 | { 60 | "exclamation!", 61 | "exclamation!", 62 | }, 63 | // ESCAPE 64 | { 65 | "space ", 66 | "space%20", 67 | }, 68 | { 69 | "a+b c", 70 | "a%2Bb%20c", 71 | }, 72 | { 73 | "\"A\" B ± \"", 74 | "%22A%22%20B%20%C2%B1%20%22", 75 | }, 76 | { 77 | "s/l/a/s/h/e/s", 78 | "s%2Fl%2Fa%2Fs%2Fh%2Fe%2Fs", 79 | }, 80 | { 81 | "with:colon", 82 | "with%3Acolon", 83 | }, 84 | { 85 | "money$", 86 | "money%24", 87 | }, 88 | { 89 | "money€", 90 | "money%E2%82%AC", 91 | }, 92 | { 93 | "escape@", 94 | "escape%40", 95 | }, 96 | { 97 | "+/", 98 | "%2B%2F", 99 | }, 100 | { 101 | "힇", 102 | "%ED%9E%87", 103 | }, 104 | { 105 | "ࠑ", 106 | "%E0%A0%91", 107 | }, 108 | { 109 | "힙", // rune(0xD799) 110 | "%ED%9E%99", 111 | }, 112 | { 113 | "🤣见見", 114 | "%F0%9F%A4%A3%E8%A7%81%E8%A6%8B", 115 | }, 116 | { 117 | "Hello World!@#$%^&*()_+-={}[]\\|;':\",.<>/?`~", 118 | "Hello%20World!%40%23%24%25%5E%26*()_%2B-%3D%7B%7D%5B%5D%5C%7C%3B'%3A%22%2C.%3C%3E%2F%3F%60~", 119 | }, 120 | { 121 | "Hello World áéíóú ü", 122 | "Hello%20World%20%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA%20%C3%BC", 123 | }, 124 | { 125 | "日a本b語ç日ð本Ê語þ日¥本¼語i日©", 126 | "%E6%97%A5a%E6%9C%ACb%E8%AA%9E%C3%A7%E6%97%A5%C3%B0%E6%9C%AC%C3%8A%E8%AA%9E%C3%BE%E6%97%A5%C2%A5%E6%9C%AC%C2%BC%E8%AA%9Ei%E6%97%A5%C2%A9", 127 | }, 128 | { 129 | "💩", 130 | "%F0%9F%92%A9", 131 | }, 132 | { 133 | "шеллы", 134 | "%D1%88%D0%B5%D0%BB%D0%BB%D1%8B", 135 | }, 136 | // FIXME > high-low surrogate pair is okay 137 | // { 138 | // string([]rune{0xD800, 0xDFFF}), 139 | // "%F0%90%8F%BF", 140 | // }, 141 | // ERRORS 142 | // FIXME > lone high/low surrogates return error 143 | // { 144 | // string([]rune{0xD800}), 145 | // "", 146 | // fmt.Errorf("URI malformed"), 147 | // }, 148 | // { 149 | // string([]rune{DFF}), 150 | // "", 151 | // fmt.Errorf("URI malformed"), 152 | // }, 153 | } 154 | 155 | for _, tc := range cases { 156 | tc := tc 157 | 158 | t.Run(tc.output, func(t *testing.T) { 159 | output := EncodeURIComponent(tc.input) 160 | 161 | assert.Equal(t, tc.output, output) 162 | }) 163 | } 164 | } 165 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2022 Leonardo Di Donato 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------