From 5f09efce4cc326ea1adb7875990ec0fdd8f21217 Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Sat, 3 Dec 2016 11:51:55 +0100 Subject: [PATCH 1/2] Prepare stable development release version 0.2.0 --- .travis.yml | 1 - CHANGELOG.md | 30 +++++++++++++++++++ README.md | 24 +++++++-------- circle.yml | 1 - pom.xml | 2 +- src/main/assets/assembly-bin.xml | 1 - .../java/com/arcticicestudio/nord/Nord.java | 2 +- .../arcticicestudio/nord/package-info.java | 4 +-- .../com/arcticicestudio/nord/NordTest.java | 2 +- 9 files changed, 47 insertions(+), 20 deletions(-) diff --git a/.travis.yml b/.travis.yml index 4721b68..240c8ac 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,6 @@ # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # title Travis CI Build Configuration + # project nord-java + -# version 0.1.0 + # repository https://github.com/arcticicestudio/nord-java + # author Arctic Ice Studio + # email development@arcticicestudio.com + diff --git a/CHANGELOG.md b/CHANGELOG.md index 1085f3b..9e0ea6e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,36 @@ --- +# 0.2.0 (2016-12-03) +## Improvements +### Public API +The public API method `getVersion() : String` is now static and returns the `String` constant `VERSION` to adapt to the SonarQube minor rule [squid:S3400](https://sonarqube.com/coding_rules#q=squid%3AS3400). +The associated unit test has been refactored to test against the [ArcVer](https://github.com/arcticicestudio/arcver) library [arcver-java](https://github.com/arcticicestudio/arcver). (@arcticicestudio, #8, 7efc44cc) + +The attribute +```java +private final Color COLOR; +``` +conflicted with the SonarQube rule [squid:S00116](https://sonarqube.com/coding_rules#q=squid%3AS00116) and has been adapted to the Arctic Ice Studio Java code style. (@arcticicestudio, #9, 8eb03e63) + +### Toolbox +Fixed the deprecated POM variable `${inceptionYear}` and replaced it with `${project.inceptionYear}`. (@arcticicestudio, #3, 1a02e6d2) + +Added POM profiles for [JFrog Bintray](https://bintray.com) to deploy Maven artifacts to the [jCenter](https://bintray.com/bintray/jcenter) and snapshots to the [OSS JFrog](https://oss.jfrog.org) repository. (@arcticicestudio, #4, f74c7a57) + +### Public API Documentation +Adapted the documentation style of the Nord color palette project to the JavaDoc. (@arcticicestudio, #7, 9eab5800) + +## Bug Fixes +### Public API Documentation +Fixed malformed JavaDoc to prevent compilation errors caused by the new JavaDoc linter rules introduced JDK 8u92 by adding the `summary` attribute to `table` tags. (@arcticicestudio, #3, 1a02e6d2) + +## Tasks +### Toolbox +Created a `circle.yml` configuration file to add [Circle CI](https://circleci.com) build integration. (@arcticicestudio, #6, f241e8de) + +Added the `maven-assembly-plugin` as `assemble` POM profile (@arcticicestudio, #5, 9f6e438d) + # 0.1.0 (2016-09-26) ## Features Implemented the public API (@arcticicestudio, #1, 8949a9baa7adf73be66b7ac8e15dfa2b57b0ac92) diff --git a/README.md b/README.md index b89a041..7bd2e2f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-

+

A arctic, north-bluish color palette Java library.
Implementation of the Nord project.

@@ -17,18 +17,18 @@ You can get it from the com.arcticicestudio nord-java - 0.1.0 + 0.2.0 ``` Gradle ```java -compile(group: 'com.arcticicestudio', name: 'nord-java', version: '0.1.0') +compile(group: 'com.arcticicestudio', name: 'nord-java', version: '0.2.0') ``` Apache Ivy ```xml - + ``` Development snapshots are available via [OSS Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/nord-java) and [JFrog Artifactory](https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/arcticicestudio/nord-java). @@ -51,25 +51,25 @@ This is a basic guide to show the common usage of the nord-java API. The API documentation can be found in the JavaDoc. The class `Nord` is the entrypoint to the nord-java API, use it to generate the HEX and RGB color codes. - - [Generate color code strings](#generate-color-code-strings) - - [Obtaining the Public API version](#obtaining-the-public-api-version) + 1. [Generate color code strings](#generate-color-code-strings) + 2. [Obtaining the Public API version](#obtaining-the-public-api-version) ### Generate color code strings -You can generate color code strings from all `Nord` enum variables by using the with the static methods `hex(Color)` and `rgb(Color)`. +Color code strings can be generated from all `Nord` enum constants by using the static methods `hex(Color)` and `rgb(Color)`. The `Color` object can be obtained from a `Nord` enum variable via the `get()` method. ```java -String hex = Nord.hex(Nord.NORD0.get()); // ""#2E3440" -String rgb = Nord.rgb(Nord.NORD8.get()); // "rgb(136, 192, 208)"" +String hex = Nord.hex(Nord.NORD0.get()); // "#2E3440" +String rgb = Nord.rgb(Nord.NORD8.get()); // "rgb(136, 192, 208)" ``` ### Obtaining the Public API version -The method `getVersion()` returns the version of the public API as string. +The `getVersion()` method returns the [ArcVer](https://github.com/arcticicestudio/arcver) version of the public API. ```java -String version = Nord.NORD0.getVersion(); // "0.1.0" +String version = Nord.getVersion(); // "0.2.0" ``` ## Development -[![](https://img.shields.io/badge/Changelog-0.1.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/v0.1.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver) +[![](https://img.shields.io/badge/Changelog-0.2.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/v0.2.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver) ### Contribution Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-java/issues). diff --git a/circle.yml b/circle.yml index 48eb847..d423004 100644 --- a/circle.yml +++ b/circle.yml @@ -1,7 +1,6 @@ # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # title Circle CI Build Configuration + # project nord-java + -# version + # repository https://github.com/arcticicestudio/nord-java + # author Arctic Ice Studio + # email development@arcticicestudio.com + diff --git a/pom.xml b/pom.xml index a0a8142..6f6be2f 100644 --- a/pom.xml +++ b/pom.xml @@ -27,7 +27,7 @@ JFrog com.arcticicestudio nord-java - 0.2.0-SNAPSHOT + 0.2.0 jar nord-java diff --git a/src/main/assets/assembly-bin.xml b/src/main/assets/assembly-bin.xml index 8648f7b..09342cf 100644 --- a/src/main/assets/assembly-bin.xml +++ b/src/main/assets/assembly-bin.xml @@ -3,7 +3,6 @@ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ title Binary Assembly Descriptor + project nord-java + -version + repository https://github.com/arcticicestudio/nord-java + author Arctic Ice Studio + email development@arcticicestudio.com + diff --git a/src/main/java/com/arcticicestudio/nord/Nord.java b/src/main/java/com/arcticicestudio/nord/Nord.java index df580f7..b5c3bc4 100644 --- a/src/main/java/com/arcticicestudio/nord/Nord.java +++ b/src/main/java/com/arcticicestudio/nord/Nord.java @@ -60,7 +60,7 @@ copyright Copyright (C) 2016 + * * * @author Arctic Ice Studio <development@arcticicestudio.com> - * @version 0.1.0 + * @version 0.2.0 * @since 0.1.0 */ public enum Nord { diff --git a/src/main/java/com/arcticicestudio/nord/package-info.java b/src/main/java/com/arcticicestudio/nord/package-info.java index d8a445e..7542978 100644 --- a/src/main/java/com/arcticicestudio/nord/package-info.java +++ b/src/main/java/com/arcticicestudio/nord/package-info.java @@ -16,7 +16,7 @@ copyright Copyright (C) 2016 + * The public API entry point is the {@link com.arcticicestudio.nord.Nord} enum. * * @author Arctic Ice Studio <development@arcticicestudio.com> - * @version 0.1.0 + * @version 0.2.0 * @since 0.1.0 */ -package com.arcticicestudio.nord; \ No newline at end of file +package com.arcticicestudio.nord; diff --git a/src/test/java/com/arcticicestudio/nord/NordTest.java b/src/test/java/com/arcticicestudio/nord/NordTest.java index e897c85..bd95f29 100644 --- a/src/test/java/com/arcticicestudio/nord/NordTest.java +++ b/src/test/java/com/arcticicestudio/nord/NordTest.java @@ -66,6 +66,6 @@ public void shouldReturnTheCorrectRGBColorCode() { @Test public void shouldReturnTheCorrectVersionString() { - assertTrue(Version.valueOf(Nord.getVersion()).satisfies("0.1.0")); + assertTrue(Version.valueOf(Nord.getVersion()).satisfies("0.2.0")); } } From c650dd70ce1098274dd69fdd4b80f982f00796f7 Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Sat, 3 Dec 2016 11:53:10 +0100 Subject: [PATCH 2/2] Fix Nord public API constant version string --- src/main/java/com/arcticicestudio/nord/Nord.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/arcticicestudio/nord/Nord.java b/src/main/java/com/arcticicestudio/nord/Nord.java index b5c3bc4..056f749 100644 --- a/src/main/java/com/arcticicestudio/nord/Nord.java +++ b/src/main/java/com/arcticicestudio/nord/Nord.java @@ -204,7 +204,7 @@ public enum Nord { /** * The ArcVer version of the public API. */ - private static final String VERSION = "0.1.0"; + private static final String VERSION = "0.2.0"; /** * Constructs a new color object.