From 8bfbc32e1b6567619ed751f5e07d7a8abb4984d0 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:06:11 +0200 Subject: [PATCH 1/9] Add LICENSE file --- LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. From 55c5999edb835ff15026bce27823a3121dc39e69 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:07:00 +0200 Subject: [PATCH 2/9] Update version in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52a664f..132f2ab 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ handles simple blobs (`/dir/*`, `/dir/*.jar`) and Java properties (`${spark.home Add it as a dependency: ```scala -//> using lib "io.get-coursier::class-path-util:0.1.0" +//> using lib "io.get-coursier::class-path-util:0.1.1" ``` Import it: From 9ca8a5dd542f691a3b30fa849c833cce10670e55 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:07:08 +0200 Subject: [PATCH 3/9] Fix typos in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 132f2ab..7cd3a86 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # class-path-util Utility library to parse class path inputs, and return the corresponding files. It -handles simple blobs (`/dir/*`, `/dir/*.jar`) and Java properties (`${spark.home}/jars/*`). +handles simple globs (`/dir/*`, `/dir/*.jar`) and Java properties (`${spark.home}/jars/*`). ## Usage @@ -17,5 +17,5 @@ import coursier.cputil.ClassPathUtil Use it like ```scala -ClassPathUtil.classPath("/foo/${thing}/*;/a/b.jar") // Seq[java.nio.file.Path] +ClassPathUtil.classPath("/foo/${thing}/*:/a/b.jar") // Seq[java.nio.file.Path] ``` From b0af9e2fcc2c8c27072072f4b4c27a4a05c1c69b Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:24:51 +0200 Subject: [PATCH 4/9] Run tests on Windows and macOS too --- .github/workflows/ci.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e5ffa85..bbd3d1a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -9,7 +9,11 @@ on: jobs: test: - runs-on: ubuntu-latest + runs-on: ${{ matrix.OS }} + strategy: + fail-fast: false + matrix: + OS: ["ubuntu-latest", "macos-latest", "windows-latest"] steps: - uses: actions/checkout@v3 with: From 635f42fcdeb542a929e22a260b1fbfca1263513b Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:25:07 +0200 Subject: [PATCH 5/9] Don't specify patch version for coursier/cache-action --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bbd3d1a..5412742 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,7 +18,7 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 0 - - uses: coursier/cache-action@v6.4 + - uses: coursier/cache-action@v6 - uses: VirtusLab/scala-cli-setup@v1.0 with: power: true @@ -33,7 +33,7 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 0 - - uses: coursier/cache-action@v6.4 + - uses: coursier/cache-action@v6 - uses: VirtusLab/scala-cli-setup@v1.0 with: power: true From 632358672f5c214ac593abd234fac5e9258d2f71 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:32:03 +0200 Subject: [PATCH 6/9] Ensure system properties aren't unexpectedly used in the tests --- test/coursier/cputil/tests/ClassPathUtilTests.scala | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/test/coursier/cputil/tests/ClassPathUtilTests.scala b/test/coursier/cputil/tests/ClassPathUtilTests.scala index 08eee69..7b7c489 100644 --- a/test/coursier/cputil/tests/ClassPathUtilTests.scala +++ b/test/coursier/cputil/tests/ClassPathUtilTests.scala @@ -6,6 +6,7 @@ package coursier.cputil.tests import com.eed3si9n.expecty.Expecty.expect import coursier.cputil.ClassPathUtil + import java.io.File class ClassPathUtilTests extends munit.FunSuite { @@ -24,7 +25,7 @@ class ClassPathUtilTests extends munit.FunSuite { assert(input.nonEmpty) assert(files.nonEmpty) - val res = ClassPathUtil.classPath(input).map(os.Path(_, os.pwd)) + val res = ClassPathUtil.classPath(input, _ => None).map(os.Path(_, os.pwd)) expect(files == res) } @@ -40,7 +41,7 @@ class ClassPathUtilTests extends munit.FunSuite { os.copy.into(f, tmpDir) val sep = File.separator - val res = ClassPathUtil.classPath(s"$tmpDir$sep*").map(os.Path(_, os.pwd)) + val res = ClassPathUtil.classPath(s"$tmpDir$sep*", _ => None).map(os.Path(_, os.pwd)) val expected = Seq( "compiler-interface-1.3.5.jar", From 0639c3767d570f5e4f663600999ab2146ec8a955 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:32:45 +0200 Subject: [PATCH 7/9] Ensure globs work with \ too and are case-insensitive --- coursier/cputil/ClassPathUtil.scala | 30 ++++++++++--------- .../cputil/tests/ClassPathUtilTests.scala | 16 ++++++---- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/coursier/cputil/ClassPathUtil.scala b/coursier/cputil/ClassPathUtil.scala index e277f28..b63b93d 100644 --- a/coursier/cputil/ClassPathUtil.scala +++ b/coursier/cputil/ClassPathUtil.scala @@ -11,6 +11,12 @@ import scala.collection.JavaConverters._ object ClassPathUtil { + private implicit class CustomStringOps(private val str: String) extends AnyVal { + def endsWithIgnoreCase(suffix: String): Boolean = + str.length >= suffix.length && + suffix.compareToIgnoreCase(str.substring(str.length - suffix.length)) == 0 + } + private val propertyRegex = Pattern.compile( Pattern.quote("${") + "[^" + Pattern.quote("{[()]}") + "]*" + Pattern.quote("}") ) @@ -41,23 +47,19 @@ object ClassPathUtil { Files.list(dir) .iterator .asScala - .filter { path => - val name = path.toString - name.length >= ".jar".length && - name.substring(name.length() - ".jar".length).equalsIgnoreCase(".jar") - } + .filter(_.toString.endsWithIgnoreCase(".jar")) .toVector .sortBy(_.getFileName) - if (processedElem.endsWith("/*")) { - val dir = Paths.get(processedElem.stripSuffix("/*")) - allJarsOf(dir) - } - else if (processedElem.endsWith("/*.jar")) { - val dir = Paths.get(processedElem.stripSuffix("/*.jar")) - allJarsOf(dir) + val allJarsSuffixes = Seq("/", File.separator) + .distinct + .flatMap(sep => Seq("*", "*.jar").map(sep + _)) + allJarsSuffixes.find(processedElem.endsWithIgnoreCase) match { + case Some(suffix) => + val dir = Paths.get(processedElem.substring(0, processedElem.length - suffix.length)) + allJarsOf(dir) + case None => + Seq(Paths.get(processedElem)) } - else - Seq(Paths.get(processedElem)) } } diff --git a/test/coursier/cputil/tests/ClassPathUtilTests.scala b/test/coursier/cputil/tests/ClassPathUtilTests.scala index 7b7c489..63dd145 100644 --- a/test/coursier/cputil/tests/ClassPathUtilTests.scala +++ b/test/coursier/cputil/tests/ClassPathUtilTests.scala @@ -30,6 +30,8 @@ class ClassPathUtilTests extends munit.FunSuite { expect(files == res) } + val testGlobs = Seq("*", "*.jar", "*.Jar") + test("star") { val initialCp = os.proc("cs", "fetch", "org.scala-lang:scala3-compiler_3:3.1.3") .call() @@ -41,7 +43,6 @@ class ClassPathUtilTests extends munit.FunSuite { os.copy.into(f, tmpDir) val sep = File.separator - val res = ClassPathUtil.classPath(s"$tmpDir$sep*", _ => None).map(os.Path(_, os.pwd)) val expected = Seq( "compiler-interface-1.3.5.jar", @@ -59,7 +60,10 @@ class ClassPathUtilTests extends munit.FunSuite { "util-interface-1.3.0.jar" ) - expect(res.map(_.last) == expected) + for (glob <- testGlobs) { + val res = ClassPathUtil.classPath(s"$tmpDir$sep$glob", _ => None).map(os.Path(_, os.pwd)) + expect(res.map(_.last) == expected) + } } test("property") { @@ -74,8 +78,6 @@ class ClassPathUtilTests extends munit.FunSuite { val sep = File.separator val props = Map("test.tmp.dir" -> tmpDir.toString) - val res = ClassPathUtil.classPath(s"$${test.tmp.dir}$sep*", props.get) - .map(os.Path(_, os.pwd)) val expected = Seq( "compiler-interface-1.3.5.jar", @@ -93,7 +95,11 @@ class ClassPathUtilTests extends munit.FunSuite { "util-interface-1.3.0.jar" ) - expect(res.map(_.last) == expected) + for (glob <- testGlobs) { + val res = ClassPathUtil.classPath(s"$${test.tmp.dir}$sep$glob", props.get) + .map(os.Path(_, os.pwd)) + expect(res.map(_.last) == expected) + } } } From 078666f3d1677ddc3e45d67182a781dddaf38bb8 Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:25:33 +0200 Subject: [PATCH 8/9] Add more details about path separators and globs --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 7cd3a86..e04a52a 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,20 @@ Use it like ```scala ClassPathUtil.classPath("/foo/${thing}/*:/a/b.jar") // Seq[java.nio.file.Path] ``` + +## Details + +### Separator + +Just like the format that `java -cp` accepts, paths are split +by an OS-dependent separator: `;` on Windows, `:` on Linux / macOS +(and other Unix systems). *class-path-util* uses the separator +returned by `java.io.File.pathSeparator`. + +### Globs + +`*` and `*.jar` are accepted at the end of a path. Case doesn't matter +(`*.JAR` works too, for example). Both `*` and `*.jar` are equivalent, +and make class-path-util add all the JARs (files ending in `.jar`, +comparison done in a case-insensitive way) of the underlying directory +to the class path. From 37eac22c33d18fe6be391c0daf1f96a0127e7baa Mon Sep 17 00:00:00 2001 From: Alex Archambault Date: Tue, 2 May 2023 00:40:31 +0200 Subject: [PATCH 9/9] Update os-lib to 0.9.1 --- test/coursier/cputil/tests/ClassPathUtilTests.scala | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/coursier/cputil/tests/ClassPathUtilTests.scala b/test/coursier/cputil/tests/ClassPathUtilTests.scala index 63dd145..edabe8f 100644 --- a/test/coursier/cputil/tests/ClassPathUtilTests.scala +++ b/test/coursier/cputil/tests/ClassPathUtilTests.scala @@ -1,6 +1,6 @@ //> using lib "org.scalameta::munit:0.7.29" //> using lib "com.eed3si9n.expecty::expecty:0.16.0" -//> using lib "com.lihaoyi::os-lib:0.9.0" +//> using lib "com.lihaoyi::os-lib:0.9.1" package coursier.cputil.tests