From 426a3adaa49f77e44d866d5db588b4942639ce3d Mon Sep 17 00:00:00 2001 From: Mark Raynsford Date: Sat, 4 May 2024 10:57:02 +0000 Subject: [PATCH] Eliminate jstructural Affects: https://github.com/io7m-com/.github/issues/2 --- README-CHANGES.xml | 18 +- README.in | 22 ++ README.md | 23 ++ com.io7m.jinterp.core/pom.xml | 11 + .../java/com/io7m/jinterp/package-info.java | 8 +- .../src/main/java/module-info.java | 4 + com.io7m.jinterp.documentation/pom.xml | 203 ------------------ .../src/main/assembly/documentation.xml | 20 -- .../jinterp/documentation/Documentation.java | 29 --- .../jinterp/documentation/package-info.java | 22 -- .../src/main/java/module-info.java | 26 --- .../com/io7m/jinterp/documentation/brand.xml | 9 - .../jinterp/documentation/documentation.css | 73 ------- .../jinterp/documentation/documentation.xml | 123 ----------- pom.xml | 35 ++- 15 files changed, 94 insertions(+), 532 deletions(-) create mode 100644 README.in delete mode 100644 com.io7m.jinterp.documentation/pom.xml delete mode 100644 com.io7m.jinterp.documentation/src/main/assembly/documentation.xml delete mode 100644 com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/Documentation.java delete mode 100644 com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/package-info.java delete mode 100644 com.io7m.jinterp.documentation/src/main/java/module-info.java delete mode 100644 com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/brand.xml delete mode 100644 com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.css delete mode 100644 com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.xml diff --git a/README-CHANGES.xml b/README-CHANGES.xml index 439967b..87c5857 100644 --- a/README-CHANGES.xml +++ b/README-CHANGES.xml @@ -1,26 +1,32 @@ - + + - + - + - + - + - + + + + + + diff --git a/README.in b/README.in new file mode 100644 index 0000000..9af1f16 --- /dev/null +++ b/README.in @@ -0,0 +1,22 @@ + +## jinterp + +Trivial Java functions to interpolate values. + +## Features + +* Linear interpolation. +* Cosine interpolation. +* Exponential interpolation. +* Log interpolation. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +``` +final double r = InterpolationD.interpolateLinear(0.0, 10.0, 0.5) +assert r == 5.0 +``` diff --git a/README.md b/README.md index 45779d3..6ae7cb6 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,26 @@ jinterp | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jinterp/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jinterp/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/jinterp/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jinterp/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/jinterp/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jinterp/actions?query=workflow%3Amain.windows.temurin.lts)| + +## jinterp + +Trivial Java functions to interpolate values. + +## Features + +* Linear interpolation. +* Cosine interpolation. +* Exponential interpolation. +* Log interpolation. +* High coverage test suite. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Usage + +``` +final double r = InterpolationD.interpolateLinear(0.0, 10.0, 0.5) +assert r == 5.0 +``` + diff --git a/com.io7m.jinterp.core/pom.xml b/com.io7m.jinterp.core/pom.xml index 4e2e01d..b15e41e 100644 --- a/com.io7m.jinterp.core/pom.xml +++ b/com.io7m.jinterp.core/pom.xml @@ -22,6 +22,17 @@ com.io7m.junreachable com.io7m.junreachable.core + + + org.osgi + org.osgi.annotation.bundle + provided + + + org.osgi + org.osgi.annotation.versioning + provided + diff --git a/com.io7m.jinterp.core/src/main/java/com/io7m/jinterp/package-info.java b/com.io7m.jinterp.core/src/main/java/com/io7m/jinterp/package-info.java index 9a5416d..93d052a 100644 --- a/com.io7m.jinterp.core/src/main/java/com/io7m/jinterp/package-info.java +++ b/com.io7m.jinterp.core/src/main/java/com/io7m/jinterp/package-info.java @@ -1,10 +1,10 @@ /* * Copyright © 2014 http://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 @@ -18,5 +18,9 @@ * Core functions and types. */ +@Export +@Version("3.0.0") package com.io7m.jinterp; +import org.osgi.annotation.bundle.Export; +import org.osgi.annotation.versioning.Version; diff --git a/com.io7m.jinterp.core/src/main/java/module-info.java b/com.io7m.jinterp.core/src/main/java/module-info.java index 3bf227f..536360b 100644 --- a/com.io7m.jinterp.core/src/main/java/module-info.java +++ b/com.io7m.jinterp.core/src/main/java/module-info.java @@ -20,6 +20,10 @@ module com.io7m.jinterp.core { + requires static org.osgi.annotation.bundle; + requires static org.osgi.annotation.versioning; + requires com.io7m.junreachable.core; + exports com.io7m.jinterp; } \ No newline at end of file diff --git a/com.io7m.jinterp.documentation/pom.xml b/com.io7m.jinterp.documentation/pom.xml deleted file mode 100644 index 943ecd0..0000000 --- a/com.io7m.jinterp.documentation/pom.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - 4.0.0 - - com.io7m.jinterp - com.io7m.jinterp - 3.0.0-SNAPSHOT - - com.io7m.jinterp.documentation - - jar - com.io7m.jinterp.documentation - Interpolation functions (Documentation) - https://www.io7m.com/software/jinterp - - - true - - - - - ${project.groupId} - com.io7m.jinterp.core - ${project.version} - - - - com.io7m.primogenitor - com.io7m.primogenitor.support - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-documentation-resources - - copy-resources - - generate-resources - - ${project.build.directory}/documentation/ - - - src/main/resources/com/io7m/jinterp/documentation/ - true - - - - - - - - - - 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 - - - - - - - - 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.codehaus.mojo - exec-maven-plugin - - - javadoc - - 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.jinterp.documentation/src/main/assembly/documentation.xml b/com.io7m.jinterp.documentation/src/main/assembly/documentation.xml deleted file mode 100644 index b888871..0000000 --- a/com.io7m.jinterp.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.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/Documentation.java b/com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/Documentation.java deleted file mode 100644 index d0efb53..0000000 --- a/com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/Documentation.java +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright © 2014 http://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.jinterp.documentation; - -/** - * Marker class for documentation. - */ - -public final class Documentation -{ - private Documentation() - { - - } -} diff --git a/com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/package-info.java b/com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/package-info.java deleted file mode 100644 index 2464b83..0000000 --- a/com.io7m.jinterp.documentation/src/main/java/com/io7m/jinterp/documentation/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright © 2015 http://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.jinterp.documentation; - diff --git a/com.io7m.jinterp.documentation/src/main/java/module-info.java b/com.io7m.jinterp.documentation/src/main/java/module-info.java deleted file mode 100644 index 190932c..0000000 --- a/com.io7m.jinterp.documentation/src/main/java/module-info.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright © 2014 http://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. - */ - -/** - * Interpolation functions (Documentation) - */ - -module com.io7m.jinterp.documentation -{ - requires com.io7m.jinterp.core; - - exports com.io7m.jinterp.documentation; -} \ No newline at end of file diff --git a/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/brand.xml b/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/brand.xml deleted file mode 100644 index 0cd038f..0000000 --- a/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/brand.xml +++ /dev/null @@ -1,9 +0,0 @@ - -
-
- io7m -
-
- ${project.parent.name} ${project.version} -
-
diff --git a/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.css b/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.css deleted file mode 100644 index f974701..0000000 --- a/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/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.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.xml b/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.xml deleted file mode 100644 index abf8489..0000000 --- a/com.io7m.jinterp.documentation/src/main/resources/com/io7m/jinterp/documentation/documentation.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - ${project.parent.name} ${project.version} Documentation - documentation.css - - - - Package Information - - - Orientation - - Overview - - The ${project.parent.name} package - implements a set of functions and types for interpolating real values. - - - - - - 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: - http://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/pom.xml b/pom.xml index 31d2398..0d6d6d2 100644 --- a/pom.xml +++ b/pom.xml @@ -21,7 +21,6 @@ com.io7m.jinterp.core com.io7m.jinterp.tests - com.io7m.jinterp.documentation @@ -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/ + @@ -85,11 +88,23 @@ 4.0.0 + com.io7m.primogenitor com.io7m.primogenitor.support 8.2.0 + + org.osgi + org.osgi.annotation.versioning + 1.1.2 + + + org.osgi + org.osgi.annotation.bundle + 2.0.0 + + junit junit @@ -101,24 +116,6 @@ - - - org.apache.maven.plugins - maven-compiler-plugin - - 11 - 11 - 11 - - - - - - com.io7m.jstructural - io7m-jstructural-maven-plugin - 5.0.0 - - com.github.spotbugs