Merge pull request #11 from mauritssilvis/java_darts_cli_split_code

Prepare splitting of the Java darts CLI project

README.md

@@ -25,7 +25,7 @@ In addition, several game modes are supported, including modes that require play
 Finally, `darts` can provide output in several formats: easily readable Markdown tables, HTML tables for web pages and JSON objects for computer processing.
 
 Currently, `darts` is available as a Java-based command-line application.
-More information about the installation and use of this app can be found in the [Java command-line toolbox](cli/java) readme.
+More information about the installation and use of this app can be found in the [Java command-line toolbox](cli/java-darts-cli) readme.
 If you are interested in checking out those checkout tables, refer to the [Markdown checkout tables](tables/md).
 
 ## License

cli/README.md

@@ -10,7 +10,7 @@ This part of the [darts](https://github.com/mauritssilvis/darts) project provide
 
 Currently, command-line interfaces are available in the following languages:
 
-- [Java](java)
+- [Java](java-darts-cli)
 
 ## License
 

cli/java/CHANGELOG.md → cli/java-darts-cli/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to the `java-darts-cli` project (see [darts](https://github.
 The file format is based on [keep a changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2023-03-18
+
+### Changed
+
+#### Command-line interface
+
+- Load the version from the project manifest file.
+
+#### General
+
+- Split the code in CLI, API and core packages.
+
 ## [0.3.0] - 2023-03-17
 
 ### Added
@@ -17,14 +29,14 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-#### Documentation
-
-- Document changes in the usage of `darts`.
-
 #### Installation
 
 - Change the `darts` installation location.
 
+#### Documentation
+
+- Document changes in the usage of `darts`.
+
 #### Dependencies
 
 - Update the Gradle version to 8.0.2.
@@ -45,7 +57,7 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 
 - Describe the installation of `darts`.
 - Document the usage of the `darts` command-line interface.
-- Document potential problems with the installation or usage of `darts`.
+- Document potential problems with the installation and usage of `darts`.
 
 #### Installation
 

cli/java/README.md → cli/java-darts-cli/README.md

@@ -1,4 +1,4 @@
-# darts > CLI > Java
+# java-darts-cli
 
 > A Java-based command-line toolbox aimed at the game of darts
 
@@ -50,7 +50,7 @@ You can then install the `darts` toolbox as follows:
 
 - Navigate to the folder containing the `darts` installation scripts, `install` and `install.bat`.
     - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
-    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java-darts-cli` folder of that code.
 - Run the `install` command to install `darts` in the `bin` folder.
 - Navigate to the newly created `bin` folder.
 - Test the execution of the `darts` toolbox by running the `darts` command.
@@ -843,7 +843,7 @@ To solve these problems, take the following steps:
 
 - Ensure you navigated to the folder containing the `darts` installation scripts, `install` and `install.bat`.
     - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
-    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java-darts-cli` folder of that code.
 - Prefix the `install` command with `./` (Bash) or `.\` (PowerShell) before execution.
 
 #### 3.1.2 Java was not installed or found
@@ -928,7 +928,7 @@ To solve these problems, take the following steps:
 - Install `darts` by following the [installation instructions](#1-installation).
 - Ensure you navigated to the folder containing the `darts` installation scripts, `install` and `install.bat`.
     - If you downloaded the latest `java-darts-cli` release, these scripts can be found in the extracted folder.
-    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java` folder of that code.
+    - If you downloaded the full `darts` code, these scripts can be found in the `cli/java-darts-cli` folder of that code.
 - Navigate to the `bin` folder.
 - Prefix the `darts` command with `./` (Bash) or `.\` (PowerShell) before execution.
 

cli/java/build.gradle.kts → cli/java-darts-cli/build.gradle.kts

@@ -11,7 +11,7 @@ plugins {
 }
 
 group = "nl.mauritssilvis.darts.java"
-version = "0.3.0"
+version = "0.4.0"
 
 repositories {
     mavenCentral()
@@ -79,6 +79,13 @@ publishing {
             }
         }
     }
+
+    repositories {
+        maven {
+            name = "buildFolder"
+            url = uri(layout.buildDirectory.dir("repo"))
+        }
+    }
 }
 
 nexusPublishing {
@@ -107,7 +114,11 @@ tasks {
 
     jar {
         manifest {
-            attributes("Main-Class" to "nl.mauritssilvis.darts.java.cli.DartsApp")
+            attributes(
+                    "Implementation-Title" to project.name,
+                    "Implementation-Version" to project.version,
+                    "Main-Class" to "nl.mauritssilvis.darts.java.cli.DartsApp"
+            )
         }
     }
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/boards/Board.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/boards/Board.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.boards;
+package nl.mauritssilvis.darts.java.api.boards;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/boards/Field.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/boards/Field.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.boards;
+package nl.mauritssilvis.darts.java.api.boards;
 
 /**
  * A dartboard field with a type, a name and a score.

cli/java/src/main/java/nl/mauritssilvis/darts/java/boards/FieldType.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/boards/FieldType.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.boards;
+package nl.mauritssilvis.darts.java.api.boards;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/finders/checkouts/Checkout.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/finders/checkouts/Checkout.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.finders.checkouts;
+package nl.mauritssilvis.darts.java.api.finders.checkouts;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/finders/checkouts/CheckoutFinder.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/finders/checkouts/CheckoutFinder.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.finders.checkouts;
+package nl.mauritssilvis.darts.java.api.finders.checkouts;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/finders/checkouts/Throw.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/finders/checkouts/Throw.java

@@ -3,9 +3,9 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.finders.checkouts;
+package nl.mauritssilvis.darts.java.api.finders.checkouts;
 
-import nl.mauritssilvis.darts.java.boards.Field;
+import nl.mauritssilvis.darts.java.api.boards.Field;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/finders/paths/Path.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/finders/paths/Path.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.finders.paths;
+package nl.mauritssilvis.darts.java.api.finders.paths;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/finders/paths/Pathfinder.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/finders/paths/Pathfinder.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.finders.paths;
+package nl.mauritssilvis.darts.java.api.finders.paths;
 
 import java.util.List;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/output/Formatter.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/output/Formatter.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.output;
+package nl.mauritssilvis.darts.java.api.output;
 
 /**
  * A string formatter.

cli/java/src/main/java/nl/mauritssilvis/darts/java/output/Serializer.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/output/Serializer.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.output;
+package nl.mauritssilvis.darts.java.api.output;
 
 /**
  * A serializer.

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/BoardType.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/BoardType.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/CheckMode.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/CheckMode.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/FinderType.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/FinderType.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/OutputFormat.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/OutputFormat.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/Settings.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/Settings.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 /**
  * Checkout table settings.

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/SettingsBuilder.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/SettingsBuilder.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 /**
  * A checkout table settings builder.

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/TableType.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/TableType.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/settings/ThrowMode.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/settings/ThrowMode.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.settings;
+package nl.mauritssilvis.darts.java.api.settings;
 
 import lombok.ToString;
 

cli/java/src/main/java/nl/mauritssilvis/darts/java/tables/Table.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/tables/Table.java

@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.tables;
+package nl.mauritssilvis.darts.java.api.tables;
 
-import nl.mauritssilvis.darts.java.finders.checkouts.Checkout;
-import nl.mauritssilvis.darts.java.settings.Settings;
+import nl.mauritssilvis.darts.java.api.finders.checkouts.Checkout;
+import nl.mauritssilvis.darts.java.api.settings.Settings;
 
 import java.util.List;
 import java.util.Map;

cli/java/src/main/java/nl/mauritssilvis/darts/java/tables/TableGenerator.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/api/tables/TableGenerator.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-package nl.mauritssilvis.darts.java.tables;
+package nl.mauritssilvis.darts.java.api.tables;
 
 /**
  * A checkout table generator.

cli/java/src/main/java/nl/mauritssilvis/darts/java/cli/BoardsCommand.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/cli/BoardsCommand.java

@@ -6,12 +6,12 @@
 package nl.mauritssilvis.darts.java.cli;
 
 import lombok.ToString;
-import nl.mauritssilvis.darts.java.boards.Board;
-import nl.mauritssilvis.darts.java.boards.output.BoardSerializerFactory;
-import nl.mauritssilvis.darts.java.boards.types.BoardFactory;
-import nl.mauritssilvis.darts.java.output.Serializer;
-import nl.mauritssilvis.darts.java.settings.BoardType;
-import nl.mauritssilvis.darts.java.settings.OutputFormat;
+import nl.mauritssilvis.darts.java.api.boards.Board;
+import nl.mauritssilvis.darts.java.api.output.Serializer;
+import nl.mauritssilvis.darts.java.api.settings.BoardType;
+import nl.mauritssilvis.darts.java.api.settings.OutputFormat;
+import nl.mauritssilvis.darts.java.core.boards.BoardFactory;
+import nl.mauritssilvis.darts.java.core.boards.output.BoardSerializerFactory;
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Model.CommandSpec;
 import picocli.CommandLine.Option;
@@ -44,7 +44,7 @@
         showDefaultValues = true,
         footerHeading = "%n",
         footer = {
-                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java",
+                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java-darts-cli",
                 "",
                 "Copyright © 2023 Maurits Silvis",
                 "SPDX-License-Identifier: GPL-3.0-or-later"

cli/java/src/main/java/nl/mauritssilvis/darts/java/cli/CheckoutsCommand.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/cli/CheckoutsCommand.java

@@ -6,13 +6,13 @@
 package nl.mauritssilvis.darts.java.cli;
 
 import lombok.ToString;
-import nl.mauritssilvis.darts.java.output.Serializer;
-import nl.mauritssilvis.darts.java.settings.*;
-import nl.mauritssilvis.darts.java.settings.types.TableSettingsBuilder;
-import nl.mauritssilvis.darts.java.tables.Table;
-import nl.mauritssilvis.darts.java.tables.TableGenerator;
-import nl.mauritssilvis.darts.java.tables.output.TableSerializerFactory;
-import nl.mauritssilvis.darts.java.tables.types.TableGeneratorFactory;
+import nl.mauritssilvis.darts.java.api.output.Serializer;
+import nl.mauritssilvis.darts.java.api.settings.*;
+import nl.mauritssilvis.darts.java.api.tables.Table;
+import nl.mauritssilvis.darts.java.api.tables.TableGenerator;
+import nl.mauritssilvis.darts.java.core.settings.TableSettingsBuilder;
+import nl.mauritssilvis.darts.java.core.tables.TableGeneratorFactory;
+import nl.mauritssilvis.darts.java.core.tables.output.TableSerializerFactory;
 import picocli.CommandLine;
 import picocli.CommandLine.*;
 import picocli.CommandLine.Model.CommandSpec;
@@ -47,7 +47,7 @@
         showDefaultValues = true,
         footerHeading = "%n",
         footer = {
-                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java",
+                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java-darts-cli",
                 "",
                 "Copyright © 2023 Maurits Silvis",
                 "SPDX-License-Identifier: GPL-3.0-or-later"

cli/java/src/main/java/nl/mauritssilvis/darts/java/cli/DartsApp.java → cli/java-darts-cli/src/main/java/nl/mauritssilvis/darts/java/cli/DartsApp.java

@@ -51,7 +51,7 @@
         commandListHeading = "%nCommands:%n",
         footerHeading = "%n",
         footer = {
-                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java",
+                "Online documentation: https://github.com/mauritssilvis/darts/tree/main/cli/java-darts-cli",
                 "",
                 "Copyright © 2023 Maurits Silvis",
                 "SPDX-License-Identifier: GPL-3.0-or-later"