diff --git a/README.in b/README.in new file mode 100644 index 0000000..58fba0b --- /dev/null +++ b/README.in @@ -0,0 +1,41 @@ + +## jptbox + +Java functions to draw Unicode boxes. + +## Features + +* Functions for drawing boxes. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +Create a text image to act as a canvas, and then draw boxes into it: + +``` +final JPTextImageType image = + JPTextImage.create(80, 10); +final JPTextBoxDrawingType draw = + JPTextBoxDrawing.get(); + +draw.drawBox(image, 0, 0, 30, 3); +draw.drawBox(image, 29, 0, 10, 3); +draw.drawBox(image, 38, 0, 10, 3); + +draw.drawBox(image, 0, 2, 30, 3); +draw.drawBox(image, 29, 2, 10, 3); +draw.drawBox(image, 38, 2, 10, 3); + +System.out.println(JPTextImages.show(image)); +``` + +``` +┌────────────────────────────┬────────┬────────┐ +│ │ │ │ +├────────────────────────────┼────────┼────────┤ +│ │ │ │ +└────────────────────────────┴────────┴────────┘ +``` diff --git a/README.md b/README.md index aef24aa..182a1e4 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,45 @@ jptbox | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jptbox/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jptbox/actions?query=workflow%3Amain.linux.temurin.lts)| | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jptbox/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jptbox/actions?query=workflow%3Amain.windows.temurin.current)| | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jptbox/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jptbox/actions?query=workflow%3Amain.windows.temurin.lts)| + +## jptbox + +Java functions to draw Unicode boxes. + +## Features + +* Functions for drawing boxes. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +Create a text image to act as a canvas, and then draw boxes into it: + +``` +final JPTextImageType image = + JPTextImage.create(80, 10); +final JPTextBoxDrawingType draw = + JPTextBoxDrawing.get(); + +draw.drawBox(image, 0, 0, 30, 3); +draw.drawBox(image, 29, 0, 10, 3); +draw.drawBox(image, 38, 0, 10, 3); + +draw.drawBox(image, 0, 2, 30, 3); +draw.drawBox(image, 29, 2, 10, 3); +draw.drawBox(image, 38, 2, 10, 3); + +System.out.println(JPTextImages.show(image)); +``` + +``` +┌────────────────────────────┬────────┬────────┐ +│ │ │ │ +├────────────────────────────┼────────┼────────┤ +│ │ │ │ +└────────────────────────────┴────────┴────────┘ +``` + diff --git a/com.io7m.jptbox.core/pom.xml b/com.io7m.jptbox.core/pom.xml index 7c3b643..5191f17 100644 --- a/com.io7m.jptbox.core/pom.xml +++ b/com.io7m.jptbox.core/pom.xml @@ -43,28 +43,6 @@ org.osgi.annotation.bundle provided - - - junit - junit - test - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - true - - junit:junit:* - - - - - - diff --git a/com.io7m.jptbox.documentation/pom.xml b/com.io7m.jptbox.documentation/pom.xml deleted file mode 100644 index 1b6eaad..0000000 --- a/com.io7m.jptbox.documentation/pom.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - - 4.0.0 - - com.io7m.jptbox - com.io7m.jptbox - 2.0.1-SNAPSHOT - - com.io7m.jptbox.documentation - - jar - com.io7m.jptbox.documentation - Plain text box drawing (Documentation) - https://www.io7m.com/software/jptbox - - - true - - - - - ${project.groupId} - com.io7m.jptbox.core - ${project.version} - - - - com.io7m.primogenitor - com.io7m.primogenitor.support - - - - org.osgi - org.osgi.annotation.versioning - provided - - - org.osgi - org.osgi.annotation.bundle - provided - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-documentation-resources - - copy-resources - - generate-resources - - ${project.build.directory}/documentation/ - - - src/main/resources/com/io7m/jptbox/documentation/ - true - - - - - - - - - - com.io7m.jstructural - io7m-jstructural-maven-plugin - - - make-documentation-single - prepare-package - - transform - - - ${project.build.directory}/documentation/documentation.xml - ${project.build.directory}/documentation/ - ${project.build.directory}/documentation/brand.xml - XHTML_SINGLE - - - - make-documentation-multi - prepare-package - - transform - - - ${project.build.directory}/documentation/documentation.xml - ${project.build.directory}/documentation/ - ${project.build.directory}/documentation/brand.xml - XHTML_MULTI - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-sources - package - - unpack-dependencies - - - module-info.java - ${project.groupId} - sources - false - ${project.build.directory}/javadoc-sources - - - - make-classpath - package - - build-classpath - - - ${project.build.directory}/javadoc-classpath - - - - - - - - org.codehaus.mojo - exec-maven-plugin - - - - java - - package - - com.io7m.primogenitor.support.TrivialJavadoc - - ${project.build.directory}/javadoc-sources - ${project.build.directory}/javadoc-classpath - ${project.build.directory}/documentation/apidocs - ${project.build.directory}/javadoc-log.txt - ${project.build.directory}/javadoc-options - - - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - src/main/assembly/documentation.xml - - - - - make-assembly - package - - single - - - false - - - - - - - - - org.codehaus.mojo - truezip-maven-plugin - false - - - copy-site-documentation - - copy - - site - - true - - ${project.build.directory}/${project.name}-${project.version}.zip/${project.name}-${project.version}/ - ${project.parent.build.directory}/minisite/documentation/ - - - - - - - - - diff --git a/com.io7m.jptbox.documentation/src/main/assembly/documentation.xml b/com.io7m.jptbox.documentation/src/main/assembly/documentation.xml deleted file mode 100644 index b888871..0000000 --- a/com.io7m.jptbox.documentation/src/main/assembly/documentation.xml +++ /dev/null @@ -1,20 +0,0 @@ - - documentation - ${project.name}-${project.version} - - zip - - - - ${project.build.directory}/documentation - / - - - ${project.build.directory}/site/apidocs - /apidocs - - - diff --git a/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/Documentation.java b/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/Documentation.java deleted file mode 100644 index f815209..0000000 --- a/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/Documentation.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright © 2015 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -package com.io7m.jptbox.documentation; - -/** - * Marker class for looking up files by resource. - */ - -public final class Documentation -{ - private Documentation() - { - throw new AssertionError("Unreachable code"); - } -} - diff --git a/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/package-info.java b/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/package-info.java deleted file mode 100644 index 856461c..0000000 --- a/com.io7m.jptbox.documentation/src/main/java/com/io7m/jptbox/documentation/package-info.java +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Copyright © 2015 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/** - * Documentation. - */ - -package com.io7m.jptbox.documentation; diff --git a/com.io7m.jptbox.documentation/src/main/java/module-info.java b/com.io7m.jptbox.documentation/src/main/java/module-info.java deleted file mode 100644 index 779b3ff..0000000 --- a/com.io7m.jptbox.documentation/src/main/java/module-info.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright © 2015 Mark Raynsford https://www.io7m.com - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN - * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR - * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - */ - -/** - * Plain text box drawing (Documentation) - */ - -module com.io7m.jptbox.documentation -{ - requires com.io7m.jptbox.core; - - exports com.io7m.jptbox.documentation; -} \ No newline at end of file diff --git a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/brand.xml b/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/brand.xml deleted file mode 100644 index 7a7aa11..0000000 --- a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/brand.xml +++ /dev/null @@ -1,9 +0,0 @@ - -
-
- io7m -
-
- ${project.parent.name} ${project.version} -
-
diff --git a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.css b/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.css deleted file mode 100644 index f974701..0000000 --- a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.css +++ /dev/null @@ -1,73 +0,0 @@ -.brand -{ - font-size: 75%; - font-family: monospace; -} - -.brand_left -{ - float: left; -} - -.brand_right -{ - text-align: right; -} - -.package -{ - font-family: monospace; - font-weight: bold; -} - -.emphasis, -.term -{ - font-style: italic; -} - -.attribute, -.class, -.command, -.constant, -.element, -.expression, -.file, -.function, -.keyword, -.parameter, -.variable, -.type -{ - font-family: monospace; -} - -.example, .license, .terminal -{ - font-family: monospace; - border: 1px solid #ccc; - padding-top: 1.0em; - padding-left: 1.0em; - padding-bottom: 1.0em; - margin-top: 1.2em; - overflow: auto; -} - -.dependencies table td -{ - padding-right: 3.0em; - font-family: monospace; - font-size: 9pt; -} - -.platforms table td -{ - padding-right: 2.0em; -} -.platforms table tbody, -.platforms table thead -{ - font-size: 8pt; - font-family: monospace; -} - diff --git a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.xml b/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.xml deleted file mode 100644 index dc8a19f..0000000 --- a/com.io7m.jptbox.documentation/src/main/resources/com/io7m/jptbox/documentation/documentation.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - ${project.parent.name} ${project.version} Documentation - documentation.css - - - - Package Information - - - Orientation - - Overview - - The ${project.parent.name} package - provides a set of functions for drawing boxes using the Unicode - box characters. - - - - - - Installation - - Source compilation - - The project can be compiled and installed with - Maven: - - - - - - - - Maven - - Regular releases are made to the - Central Repository, - so it's possible to use the ${project.parent.name} - package in your projects with the following Maven dependency: - - - - ${project.groupId} - ${project.parent.artifactId}-core - ${project.version} -]]> - - - All io7m.com - packages use Semantic Versioning - - http://semver.org - , which implies that it is always safe to use version ranges - with an exclusive upper bound equal to the next major version - the API of - the package will not change in a backwards-incompatible manner before the - next major version. - - - - - - Platform Specific Issues - - There are currently no known platform-specific issues. - - - - - License - - All files distributed with the ${project.parent.name} - package are placed under the following license: - https://www.io7m.com - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.]]> - - - - - - - API Reference - - - Javadoc - - API documentation for the package is provided via the - included Javadoc. - - - - - diff --git a/com.io7m.jptbox.documentation/src/site/site.xml b/com.io7m.jptbox.documentation/src/site/site.xml deleted file mode 100644 index 2e43e13..0000000 --- a/com.io7m.jptbox.documentation/src/site/site.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/com.io7m.jptbox.documentation/src/site/xdoc/changes.xml.vm b/com.io7m.jptbox.documentation/src/site/xdoc/changes.xml.vm deleted file mode 100644 index 71f87e7..0000000 --- a/com.io7m.jptbox.documentation/src/site/xdoc/changes.xml.vm +++ /dev/null @@ -1,15 +0,0 @@ - - - - Changes - - -
- See ${project.parent.name} - for the package changelog. -
- - diff --git a/com.io7m.jptbox.documentation/src/site/xdoc/releases.xml.vm b/com.io7m.jptbox.documentation/src/site/xdoc/releases.xml.vm deleted file mode 100644 index aba1f49..0000000 --- a/com.io7m.jptbox.documentation/src/site/xdoc/releases.xml.vm +++ /dev/null @@ -1,15 +0,0 @@ - - - - Releases - - -
- See ${project.parent.name} - for releases and documentation. -
- - diff --git a/pom.xml b/pom.xml index 81370ad..17f3dc6 100644 --- a/pom.xml +++ b/pom.xml @@ -20,7 +20,6 @@ com.io7m.jptbox.core - com.io7m.jptbox.documentation com.io7m.jptbox.tests @@ -66,6 +65,10 @@ sonatype-nexus-staging https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + sonatype-nexus-snapshots + https://s01.oss.sonatype.org/content/repositories/snapshots/ + @@ -122,13 +125,6 @@ - - - com.io7m.jstructural - io7m-jstructural-maven-plugin - 5.0.0 - - com.github.spotbugs diff --git a/src/site/resources/documentation.xml b/src/site/resources/documentation.xml index 5c0c663..e3028d2 100644 --- a/src/site/resources/documentation.xml +++ b/src/site/resources/documentation.xml @@ -2,8 +2,7 @@

User documentation

- +

+ See the README. +