├── .github └── workflows │ ├── release.yml │ └── test.yml ├── .gitignore ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── LICENCE ├── README.md ├── gleam.toml ├── manifest.toml ├── src └── gleam_community │ └── path.gleam └── test ├── gleam_community ├── path_string_test.gleam └── path_test.gleam └── gleam_community_path_test.gleam /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: release 2 | 3 | on: 4 | push: 5 | tags: ["v*"] 6 | 7 | jobs: 8 | publish: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v3 13 | 14 | - uses: erlef/setup-beam@v1 15 | with: 16 | otp-version: "26.1" 17 | gleam-version: "0.32.4" 18 | 19 | - run: | 20 | version="v$(cat gleam.toml | grep -m 1 "version" | sed -r "s/version *= *\"([[:digit:].]+)\"/\1/")" 21 | if [ "$version" != "${{ github.ref_name }}" ]; then 22 | echo "tag '${{ github.ref_name }}' does not match the version in gleam.toml" 23 | echo "expected a tag name 'v$version'" 24 | exit 1 25 | fi 26 | name: check version 27 | 28 | - run: gleam format --check 29 | 30 | - run: gleam test 31 | 32 | - run: gleam publish -y 33 | env: 34 | HEXPM_USER: ${{ secrets.HEX_USERNAME }} 35 | HEXPM_PASS: ${{ secrets.HEX_PASSWORD }} 36 | 37 | - uses: softprops/action-gh-release@v1 38 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: main 2 | 3 | on: 4 | push: 5 | branches: ["main"] 6 | pull_request: 7 | branches: ["**"] 8 | 9 | concurrency: 10 | group: ${{ github.workflow }}-${{ github.ref }} 11 | cancel-in-progress: true 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | 20 | - uses: erlef/setup-beam@v1 21 | with: 22 | otp-version: "26.1" 23 | gleam-version: "0.32.4" 24 | 25 | - run: gleam format --check 26 | 27 | - run: gleam test 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .env* 3 | .idea/ 4 | .nova/ 5 | .vscode/ 6 | build/ 7 | coverage/ 8 | dist/ 9 | erl_crash.dump 10 | node_modules/ 11 | *.beam 12 | *.ez 13 | *.log 14 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @aslilac -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | - Using welcoming and inclusive language 18 | - Being respectful of differing viewpoints and experiences 19 | - Gracefully accepting constructive criticism 20 | - Focusing on what is best for the community 21 | - Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | - The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | - Trolling, insulting/derogatory comments, and personal or political attacks 28 | - Public or private harassment 29 | - Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | - Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting one of the organizers or moderators of the gleam-community 59 | organization. All complaints will be reviewed and investigated and will result in a 60 | response that is deemed necessary and appropriate to the circumstances. The project team 61 | is obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is a direct decendant of the [Gleam Code of Conduct][gleam coc], 71 | which is itself a decendant of the [Contributor Covenant (v1.4)][cc]. 72 | 73 | [gleam coc]: https://github.com/gleam-lang/gleam/blob/f793b5d28a3102276a8b861c7e16a19c5231426e/CODE_OF_CONDUCT.md 74 | [cc]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 75 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 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 | Copyright 2023 Gleam Community Contributors 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gleam_community_path 2 | 3 | ## Installation 4 | 5 | ```sh 6 | gleam add gleam_community_path 7 | ``` 8 | 9 | ## Documentation 10 | 11 | 12 | -------------------------------------------------------------------------------- /gleam.toml: -------------------------------------------------------------------------------- 1 | name = "gleam_community_path" 2 | version = "0.1.0" 3 | licences = ["Apache-2.0"] 4 | description = "Path parsing and manipulation" 5 | repository = { type = "github", user = "gleam-community", repo = "path" } 6 | 7 | [dependencies] 8 | gleam_stdlib = "~> 0.32" 9 | 10 | [dev-dependencies] 11 | gleeunit = "~> 1.0" 12 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | # This file was generated by Gleam 2 | # You typically do not need to edit this file 3 | 4 | packages = [ 5 | { name = "gleam_stdlib", version = "0.32.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "07D64C26D014CF570F8ACADCE602761EA2E74C842D26F2FD49B0D61973D9966F" }, 6 | { name = "gleeunit", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "D3682ED8C5F9CAE1C928F2506DE91625588CC752495988CBE0F5653A42A6F334" }, 7 | ] 8 | 9 | [requirements] 10 | gleam_stdlib = { version = "~> 0.32" } 11 | gleeunit = { version = "~> 1.0" } 12 | -------------------------------------------------------------------------------- /src/gleam_community/path.gleam: -------------------------------------------------------------------------------- 1 | //// Provides many utilities for dealing with paths. 2 | 3 | import gleam/iterator.{type Iterator} 4 | import gleam/option.{type Option} 5 | 6 | pub type Path = 7 | String 8 | 9 | /// `is_absolute` will tell you if a given path unambiguously refers to a single location. For 10 | /// example, an absolute path won't depend on the working directory. 11 | /// 12 | ///
13 | /// Examples 14 | /// 15 | /// ```gleam 16 | /// path.is_absolute("/") 17 | /// |> should.equal(True) 18 | /// ``` 19 | /// 20 | /// ```gleam 21 | /// path.is_absolute("/wibble/wobble") 22 | /// |> should.equal(True) 23 | /// ``` 24 | /// 25 | /// ```gleam 26 | /// path.is_absolute("~") 27 | /// |> should.equal(True) 28 | /// ``` 29 | /// 30 | /// 31 | ///
32 | /// 33 | pub fn is_absolute(self: Path) -> Bool { 34 | todo 35 | } 36 | 37 | /// `is_relative` will tell you if a given path is context dependent. For example, if it depends 38 | /// on the working directory. 39 | /// 40 | ///
41 | /// Examples 42 | /// 43 | /// ```gleam 44 | /// path.is_directory("/") 45 | /// |> should.equal(False) 46 | /// ``` 47 | /// 48 | ///
49 | /// 50 | pub fn is_relative(self: Path) -> Bool { 51 | todo 52 | } 53 | 54 | /// `is_directory` can be used to guess if the path references a directory. This does not check 55 | /// the filesystem, and only reflects whether or not other functions will treat it as a directory. 56 | /// 57 | ///
58 | /// Examples 59 | /// 60 | /// ```gleam 61 | /// path.is_directory("/") 62 | /// |> should.equal(True) 63 | /// ``` 64 | /// 65 | /// ```gleam 66 | /// path.is_directory(".") 67 | /// |> should.equal(True) 68 | /// ``` 69 | /// 70 | /// ```gleam 71 | /// path.is_directory("../..") 72 | /// |> should.equal(True) 73 | /// ``` 74 | /// 75 | /// ```gleam 76 | /// path.is_directory("/usr/local/gleam/bin/") 77 | /// |> should.equal(True) 78 | /// ``` 79 | /// 80 | /// ```gleam 81 | /// path.is_directory("/usr/local/gleam/bin/gleam") 82 | /// |> should.equal(False) 83 | /// ``` 84 | /// 85 | ///
86 | /// 87 | pub fn is_directory(self: Path) -> Bool { 88 | todo 89 | } 90 | 91 | /// `is_file` can be used to guess if the path references a file. This does not check 92 | /// the filesystem, and only reflects whether other functions will treat it as a file or not. 93 | /// This function will always return the opposite of [`is_directory`](#is_directory). 94 | pub fn is_file(self: Path) -> Bool { 95 | todo 96 | } 97 | 98 | /// ```gleam 99 | /// path.components("/wibble/wobble") 100 | /// // => ["wibble", "wobble"] 101 | /// ``` 102 | pub fn components(self: Path) -> List(String) { 103 | todo 104 | } 105 | 106 | /// `parent` will return the parent path of the given path. ie. the directory which contains 107 | /// the file that the original path references. 108 | /// 109 | ///
110 | /// Examples 111 | /// 112 | /// ```gleam 113 | /// path.parent("gleam_community/path") 114 | /// |> should.equal(Some("gleam_community")) 115 | /// ``` 116 | /// 117 | /// ```gleam 118 | /// path.parent("gleam_community") 119 | /// |> should.equal(Some(".")) 120 | /// ``` 121 | /// 122 | /// ```gleam 123 | /// path.parent("/gleam_community") 124 | /// |> should.equal(Some("/")) 125 | /// ``` 126 | /// 127 | /// ```gleam 128 | /// path.parent("/") 129 | /// |> should.equal(None) 130 | /// ``` 131 | /// 132 | /// ```gleam 133 | /// "." 134 | /// |> path.parent() 135 | /// |> path.parent() 136 | /// |> path.parent() 137 | /// |> should.equal(Some("../../..")) 138 | /// ``` 139 | /// 140 | ///
141 | /// 142 | pub fn parent(self: Path) -> Option(Path) { 143 | todo 144 | } 145 | 146 | /// ```gleam 147 | /// path.ancestors("/wibble/wobble/wooble/weeble") 148 | /// // => ["/wibble/wobble/wooble", "/wibble/wobble", "/wibble"] 149 | /// ``` 150 | pub fn ancestors(self: Path) -> Iterator(Path) { 151 | todo 152 | } 153 | 154 | pub fn directory(self: Path) -> String { 155 | todo 156 | } 157 | 158 | pub fn file_name(self: Path) -> String { 159 | todo 160 | } 161 | 162 | pub fn base_name(self: Path) -> String { 163 | todo 164 | } 165 | 166 | pub fn extension(self: Path) -> Option(String) { 167 | todo 168 | } 169 | 170 | /// `and_then` will follow directions from one path to reach another. It can be thought of as 171 | /// an equivalent of the `cd` shell command. Whether you tell it to follow a relative path, or 172 | /// an absolute one, it will listen. 173 | /// 174 | ///
175 | /// Examples 176 | /// 177 | /// ```gleam 178 | /// "/Users/Bandit" 179 | /// |> path.and_then("Documents/secrets") 180 | /// |> should.equal("/Users/Bandit/Documents/secrets") 181 | /// ``` 182 | /// 183 | /// ```gleam 184 | /// "/Users/Bandit" 185 | /// |> path.and_then("/Users/August") 186 | /// |> should.equal("/Users/August") 187 | /// ``` 188 | /// 189 | /// ```gleam 190 | /// "/Users/Bandit" 191 | /// |> path.and_then("../Penelope/Pictures/") 192 | /// |> should.equal("/Users/Penelope/Pictures") 193 | /// ``` 194 | /// 195 | ///
196 | /// 197 | pub fn and_then(self: Path, to: Path) -> Path { 198 | todo 199 | } 200 | 201 | /// `join` will concatenate both paths and normalize the result. This function is useful if you 202 | /// want to allow relative paths to traverse up, but you don't want an absolute path to overwrite everything. 203 | /// 204 | ///
205 | /// Examples 206 | /// 207 | /// ```gleam 208 | /// path.join("/Users/Bandit", "Documents/secrets") 209 | /// |> should.equal("/Users/Bandit/Documents/secrets") 210 | /// ``` 211 | /// 212 | /// ```gleam 213 | /// path.join("/Users/Bandit", "/Documents/secrets") 214 | /// |> should.equal("/Users/Bandit/Documents/secrets") 215 | /// ``` 216 | /// 217 | /// ```gleam 218 | /// path.join("/Users/Bandit", "../Penelope/Pictures/") 219 | /// |> should.equal("/Users/Penelope/Pictures") 220 | /// ``` 221 | /// 222 | ///
223 | /// 224 | pub fn join(self: Path, to: Path) -> Path { 225 | todo 226 | } 227 | 228 | /// `inside` is like [`join`](#join), but guaranteed to return a path that exists within 229 | /// `base`. 230 | /// 231 | ///
232 | /// Examples 233 | /// 234 | /// ```gleam 235 | /// "/content/banner.webp" 236 | /// |> path.inside("/Source/wwwroot") 237 | /// |> should.equal("/Source/wwwroot/content/banner.webp") 238 | /// ``` 239 | /// 240 | /// ```gleam 241 | /// "/content/../../banner.webp" 242 | /// |> path.inside("/Source/wwwroot") 243 | /// |> should.equal("/Source/wwwroot/banner.webp") 244 | /// ``` 245 | /// 246 | ///
247 | /// 248 | pub fn inside(self: Path, base of: Path) -> Path { 249 | todo 250 | } 251 | 252 | /// `set_filename` will change the path to point to a file with the provided name in the same 253 | /// directory. A path ending in "/" will be treated as a directory, not a file. 254 | /// 255 | ///
256 | /// Examples 257 | /// 258 | /// ```gleam 259 | /// path.set_filename("/public/index.html", "favicon.ico") 260 | /// |> should.equal("/public/favicon.ico") 261 | /// ``` 262 | /// 263 | /// ```gleam 264 | /// path.set_filename("/public/", "favicon.ico") 265 | /// |> should.equal("/public/favicon.ico") 266 | /// ``` 267 | /// 268 | /// ```gleam 269 | /// path.set_filename("/public", "favicon.ico") 270 | /// |> should.equal("/favicon.ico") 271 | /// ``` 272 | /// 273 | ///
274 | /// 275 | pub fn set_file_name(self: Path, filename: String) -> Path { 276 | todo 277 | } 278 | 279 | /// `set_basename` will change the path to point to a file with the provided basename in the 280 | /// same directory, with the same extension (or lack of). A path ending in "/" will be treated 281 | /// as a directory, not a file. 282 | /// 283 | ///
284 | /// Examples 285 | /// 286 | /// ```gleam 287 | /// path.set_basename("/gleam.toml", "manifest") 288 | /// |> should.equal("/manifest.toml") 289 | /// ``` 290 | /// 291 | /// ```gleam 292 | /// path.set_basename("/LICENSE", "LICENCE") 293 | /// |> should.equal("/LICENCE") 294 | /// ``` 295 | /// 296 | /// ```gleam 297 | /// path.set_basename("/LICENSE.MIT", "LICENCE") 298 | /// |> should.equal("/LICENCE.MIT") 299 | /// ``` 300 | /// 301 | /// ```gleam 302 | /// path.set_basename("/my-project/", "LICENCE") 303 | /// |> should.equal("/my-project/LICENCE") 304 | /// ``` 305 | /// 306 | ///
307 | /// 308 | pub fn set_file_base_name(self: Path, basename: String) -> Path { 309 | todo 310 | } 311 | 312 | /// `set_extension` will change the path to point to a file with the provided extension in the 313 | /// same directory, with the same basename. A path ending in "/" will be treated as a 314 | /// directory, not a file. 315 | /// 316 | ///
317 | /// Examples 318 | /// 319 | /// ```gleam 320 | /// path.set_extension("/favicon.ico", "svg") 321 | /// |> should.equal("/manifest.toml") 322 | /// ``` 323 | /// 324 | /// ```gleam 325 | /// path.set_extension("/favicon.ico", ".svg") 326 | /// |> should.equal("/favicon.svg") 327 | /// ``` 328 | /// 329 | /// ```gleam 330 | /// path.set_extension("/LICENSE.MIT", "LICENCE") 331 | /// |> should.equal("/LICENCE.MIT") 332 | /// ``` 333 | /// 334 | ///
335 | /// 336 | pub fn set_file_extension(self: Path, extension: String) -> Path { 337 | todo 338 | } 339 | -------------------------------------------------------------------------------- /test/gleam_community/path_string_test.gleam: -------------------------------------------------------------------------------- 1 | import gleam_community/path_string 2 | import gleeunit/should 3 | 4 | pub fn normalize_test() { 5 | path_string.normalize("/hello/./there/../friend") 6 | |> should.equal("/hello/friend") 7 | 8 | path_string.normalize("hello/./there/../friend") 9 | |> should.equal("hello/friend") 10 | 11 | path_string.normalize("/hello/./there/../../../goodbye/forever") 12 | |> should.equal("/goodbye/forever") 13 | 14 | path_string.normalize("hello/./there/../../../goodbye/forever") 15 | |> should.equal("../goodbye/forever") 16 | 17 | path_string.normalize("/hello/./there/../../../goodbye/../../../hello/again") 18 | |> should.equal("/hello/again") 19 | 20 | path_string.normalize("hello/./there/../../../goodbye/../../../hello/again") 21 | |> should.equal("../../../hello/again") 22 | 23 | path_string.normalize("../../../hello/sailor") 24 | |> should.equal("../../../hello/sailor") 25 | } 26 | 27 | pub fn and_then_test() { 28 | path_string.and_then("/hello", "./././there") 29 | |> should.equal("/hello/there") 30 | 31 | path_string.and_then("./hello", "/there") 32 | |> should.equal("/there") 33 | } 34 | 35 | pub fn append_test() { 36 | path_string.append("/hello", "./././there") 37 | |> should.equal("/hello/there") 38 | 39 | path_string.append("./hello", "./././there") 40 | |> should.equal("./hello/there") 41 | } 42 | -------------------------------------------------------------------------------- /test/gleam_community/path_test.gleam: -------------------------------------------------------------------------------- 1 | import gleam_community/path 2 | import gleeunit/should 3 | 4 | pub fn from_string_test() { 5 | path.from_string("/hello/friend") 6 | |> path.equals(["hello", "friend"], path.Absolute) 7 | |> should.be_true() 8 | 9 | path.from_string("/hello/friend/../buddy") 10 | |> path.equals(["hello", "buddy"], path.Absolute) 11 | |> should.be_true() 12 | 13 | path.from_string("hello/friend") 14 | |> path.equals(["hello", "friend"], path.Relative) 15 | |> should.be_true() 16 | 17 | path.from_string("./hello/./friend/../buddy") 18 | |> path.equals([".", "hello", "buddy"], path.Relative) 19 | |> should.be_true() 20 | } 21 | 22 | pub fn and_then_test() { 23 | path.from_string("/hello/there") 24 | |> path.and_then_string("./buddy/pal") 25 | |> path.equals(["hello", "there", "buddy", "pal"], path.Absolute) 26 | |> should.be_true() 27 | 28 | path.from_string("/hello/there") 29 | |> path.and_then_string("../sailor") 30 | |> path.equals(["hello", "sailor"], path.Absolute) 31 | |> should.be_true() 32 | 33 | path.from_string("/hello/there") 34 | |> path.and_then_string("/sailor") 35 | |> path.equals(["sailor"], path.Absolute) 36 | |> should.be_true() 37 | } 38 | 39 | pub fn append_test() { 40 | path.from_string("/hello/there") 41 | |> path.append_string("./buddy/pal") 42 | |> path.equals(["hello", "there", "buddy", "pal"], path.Absolute) 43 | |> should.be_true() 44 | 45 | path.from_string("/hello/there") 46 | |> path.append_string("../sailor") 47 | |> path.equals(["hello", "sailor"], path.Absolute) 48 | |> should.be_true() 49 | 50 | path.from_string("/hello/there") 51 | |> path.append_string("/sailor") 52 | |> path.equals(["hello", "there", "sailor"], path.Absolute) 53 | |> should.be_true() 54 | } 55 | -------------------------------------------------------------------------------- /test/gleam_community_path_test.gleam: -------------------------------------------------------------------------------- 1 | import gleeunit 2 | 3 | pub fn main() { 4 | gleeunit.main() 5 | } 6 | --------------------------------------------------------------------------------