From 17c8100635efb55b4a961922c15fb900803868b1 Mon Sep 17 00:00:00 2001 From: Robert Halter Date: Sat, 19 Aug 2023 21:05:16 +0200 Subject: [PATCH] README.md with: (MUST) add dependency for easy commandline handling lets add the Apache 2.0 License of the **Picocli** Library to the Project in to the legal/picocli-NOTICE.txt file new TODO: We have to add all the files in directory legal in to the distribution ... implementation with Picocli Library ./gradlew run --args='--repeat=2 i like gradle and picocli' thank you and all changes in the descripted files. --- NOTICE.txt | 1 + README.md | 217 ++++++++++++++++++ app/build.gradle.kts | 11 + .../roebi/roebiapplicationcli/app/App.java | 37 ++- legal/picocli-LICENSE.txt | 201 ++++++++++++++++ 5 files changed, 465 insertions(+), 2 deletions(-) create mode 100644 NOTICE.txt create mode 100644 legal/picocli-LICENSE.txt diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..49d3269 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1 @@ +Please read the different LICENSE files present in this distribution. diff --git a/README.md b/README.md index 5fbe11a..2dec361 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,223 @@ up to here it was a project setup with explanations. #### (MUST) add dependency for easy commandline handling +How to find a Java Library? + +I personally like to old style MVN Repository with its Categories: + +in this case + +on https://mvnrepository.com i entered 'command line' + +find among other things Apache Commons CLI + +the click on **commons-cli** + +and the click on the Categories **Command Line Parsers** + +here we are, a list of Command Line Parser Libraries (ordered by popular (amount of usages) ): + +https://mvnrepository.com/open-source/command-line-parsers?sort=popular + +here you can see the last Release, the License and the usage of a library in other open source projects. + +for Example the first two Entries + +- Apache Commons CLI - Last Release on Oct 27, 2021 - 4573 usages - Apache License +- JCommander - Last Release on Jan 11, 2022 - 1278 usages - Apache License + +if you interested in newer things + +change the search to **newest** + +https://mvnrepository.com/open-source/command-line-parsers?sort=newest + +here we found + +- **Scopt** - Last Release on Jul 2, 2022 - 563 usages - MIT License +- it is for **Scala**: https://github.com/scopt/scopt + +about the MIT License: + +- https://choosealicense.com/licenses/mit/ +- https://opensource.org/license/mit/ + +next is **Clikt**, it is for Kotlin, has a Apache License + +next is **Picocli** - Last Release on Jun 3, 2023 - 701 usages - Apache License + +about the Apache License: + +- https://choosealicense.com/licenses/apache/ Version 2.0 +- https://opensource.org/license/apache-2-0/ Version 2.0 +- ( https://opensource.org/license/apache/ old Version 1.1 ) + +Conditions of the Apache License 2.0 + +- a copy of the license and copyright notice must be included with the licensed material + +then we use the **Picocli** Library: + +https://mvnrepository.com/artifact/info.picocli/picocli + +its description: + +Java command line parser with both an annotations API and a programmatic API. Usage help with ANSI styles and colors. Autocomplete. Nested subcommands. Easily included as source to avoid adding a dependency. + +and if yo click on the newest Version - current 4.7.4 + +https://mvnrepository.com/artifact/info.picocli/picocli/4.7.4 + +there is the HomePage: https://picocli.info + +over the HomePage you will find + +- its Repo: https://github.com/remkop/picocli +- info like 'command line syntax styles including POSIX, GNU, MS-DOS and more' +- info like [Quick Guide](https://picocli.info/quick-guide.html) + +now add the dependency to the app: + +back to https://mvnrepository.com/artifact/info.picocli/picocli/4.7.4 + +switch to Tab **Gradle (Kotlin)** + +click in the Text field - and then - 'Copied to clipboard!' appears + +open ... /app/build.gradle.kts + +add it to the dependencies block like this: + +```build.gradle.kts +dependencies { + implementation("org.apache.commons:commons-text") + implementation(project(":utilities")) + // https://mvnrepository.com/artifact/info.picocli/picocli + implementation("info.picocli:picocli:4.7.4") +} +``` + +now the ide know about this gradle build change + +press on the icon **Load Gradle Changes** + +now in the ide in the **External Libraries** you will find the Entry **info.picocli:picocli:picocli:4.7.4** + +this means you can now use this Picocli Classes in your Project. + +and remember - with Gradle Task **installDist** in the app/build/install/app/lib there is the picocli-4.7.4.jar added. + +nice ! + +remark: this is not a legal advice. + +> maybe someone here knows where this is defined exactly + +lets add the Apache 2.0 License of the **Picocli** Library to the Project in to the legal/picocli-NOTICE.txt file: + +same file structure and naming from here: https://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/legal/ + +with for example this content: + +```legal/picocli-LICENSE.txt + Apache License + Version 2.0, January 2004 + ... +``` +real content copy from here: + +https://github.com/remkop/picocli/blob/main/LICENSE + +use the **Raw** Link + +https://github.com/remkop/picocli/raw/main/LICENSE + +to copy its content directly in to + +**legal/picocli-LICENSE.txt** + +and add in the project directory a file named **NOTICE.txt** + +```NOTICE.txt +Please read the different LICENSE files present in this distribution. +``` + +new TODO: We have to add all the files in directory legal in to the distribution ... + +The Application Plugin applies [The Distribution Plugin](https://docs.gradle.org/current/userguide/distribution_plugin.html#sec:distribution_contents) + +here we use **Distribution contents** + +and add this part into **app/build.gradle.kts**: + +about the contents block, it is a copy Spec. + +more info here: + +https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Copy.html + +```app/build.gradle.kts +distributions { + main { + contents { + from("../NOTICE.txt") + from("../legal") + } + } +} +``` + +now try the Gradle Task **installDist** + +```git bash +# fast version +./gradlew installDist +# version without optimizing +./gradlew clean installDist --rerun-tasks +``` + +great, now NOTICE.txt and all files from **legal** directory are in + +... /app/build/install/app directory + +same with Gradle Task **distZip** / **distTar** + +## add the missing parts / what I have already done + +### implementation with Picocli Library + +from Picocli [Quick Guide](https://picocli.info/quick-guide.html) + +in File app/src/main/java/.../App.java change it to ... + +```App.java +// see current file content of file App.java in this project +``` + +find more examples here: + +https://github.com/remkop/picocli/tree/main/picocli-examples/src/main/java/picocli/examples + +to run the application with some command line parameters try + +based on + +https://docs.gradle.org/current/dsl/org.gradle.api.tasks.JavaExec.html + +```git bash +./gradlew run --args='--help' +./gradlew run --args='--version' +./gradlew run --args='--repeat=2 i like gradle and picocli' +``` + +That's it - thank you for following / working through this README.md + +## from here it is the remaining piece of the README.md template from + +https://github.com/jehna/readme-best-practices + +I didn't consciously erase it. + ... Here's a brief intro about what a developer must do in order to start developing diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 7f2a027..7ea52dd 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -9,9 +9,20 @@ plugins { dependencies { implementation("org.apache.commons:commons-text") implementation(project(":utilities")) + // https://mvnrepository.com/artifact/info.picocli/picocli + implementation("info.picocli:picocli:4.7.4") } application { // Define the main class for the application. mainClass.set("in.halter.roebi.roebiapplicationcli.app.App") } + +distributions { + main { + contents { + from("../NOTICE.txt") + from("../legal") + } + } +} diff --git a/app/src/main/java/in/halter/roebi/roebiapplicationcli/app/App.java b/app/src/main/java/in/halter/roebi/roebiapplicationcli/app/App.java index e2647e5..dc7430b 100644 --- a/app/src/main/java/in/halter/roebi/roebiapplicationcli/app/App.java +++ b/app/src/main/java/in/halter/roebi/roebiapplicationcli/app/App.java @@ -10,12 +10,45 @@ import static in.halter.roebi.roebiapplicationcli.app.MessageUtils.getMessage; import org.apache.commons.text.WordUtils; +import picocli.CommandLine; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; +import picocli.CommandLine.Parameters; -public class App { - public static void main(String[] args) { +import java.util.Arrays; +import java.util.stream.Collectors; + +@Command(name = "myApp", version = "myApp 0.1", header = "%n@|blue Start of Help of myApp|@", footer = "%n@|blue end of help of myApp|@", mixinStandardHelpOptions = true) +public class App implements Runnable { + + @Option(names = { "-r", "--repeat" }, description = "Repeat the words to Standard out.") + int repeat = 1; + + @Parameters(paramLabel = "", defaultValue = "Hello, picocli", + description = "Words to write to standard out.") + private String[] words = { "Hello,", "picocli" }; + + @Override + public void run() { + // The business logic of the command goes here ... + // In this case, your code + + // Here the new Part from adapted Picocli Example + // use option 'repeat': + System.out.println("repeat: " + repeat); + // use parameter(s) 'words': + for (int i = 0; i < repeat; i++) { + System.out.println("repeat: " + i + " : words: " + Arrays.stream(words).collect(Collectors.joining(" ")).toString()); + } + + // Here the existing Part from the Gradle Init generation LinkedList tokens; tokens = split(getMessage()); String result = join(tokens); System.out.println(WordUtils.capitalize(result)); } + public static void main(String[] args) { + int exitCode = new CommandLine(new App()).execute(args); + System.exit(exitCode); + } } diff --git a/legal/picocli-LICENSE.txt b/legal/picocli-LICENSE.txt new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/legal/picocli-LICENSE.txt @@ -0,0 +1,201 @@ + 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.