---
+# 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 525993b..7bd2e2f 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-
+
A arctic, north-bluish color palette Java library.
-Official implementation of Nord.
+ * Public API entry point of the Nord Java project, which
+ * implements the Nord color palette.
*
*
- *
+ *
*
*
*
Polar Night
@@ -55,105 +60,119 @@ 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 {
/**
- * The color {@code nord0} of the "Polar Night" component with an RGB value of {@code rgb(46, 52, 64)} and an HEX
- * value of {@code #2E3440}.
- *
+ * Base component color "{@code nord0}" of "Polar Night" with a RGB value of {@code rgb(46, 52, 64)} and a HEX value
+ * of {@code #2E3440}.
+ *
+ *
*/
NORD0(46, 52, 64),
/**
- * The color {@code nord1} of the "Polar Night" component with an RGB value of {@code rgb(59, 66, 82)} and an HEX
- * value of {@code #3B4252}.
- *
+ * Brighter color "{@code nord1}" of the "Polar Night" component base color {@link #NORD0} with a RGB value of
+ * {@code rgb(59, 66, 82)} and a HEX value of {@code #3B4252}.
+ *
+ *
*/
NORD1(59, 66, 82),
/**
- * The color {@code nord2} of the "Polar Night" component with an RGB value of {@code rgb(67, 76, 94)} and an HEX
- * value of {@code #434C5E}.
- *
+ * Brighter color "{@code nord2}" of the "Polar Night" component base color {@link #NORD0} with a RGB value of
+ * {@code rgb(67, 76, 94)} and a HEX value of {@code #434C5E}.
+ *
+ *
*/
NORD2(67, 76, 94),
/**
- * The color {@code nord3} of the "Polar Night" component with an RGB value of {@code rgb(76, 86, 106)} and an HEX
- * value of {@code #4C566A}.
- *
+ * Brighter color "{@code nord3}" of the "Polar Night" component base color {@link #NORD0} with a RGB value of
+ * {@code rgb(76, 86, 106)} and a HEX value of {@code #4C566A}.
+ *
+ *
*/
NORD3(76, 86, 106),
/**
- * The color {@code nord4} of the "Snow Storm" component with an RGB value of {@code rgb(216, 222, 233)} and an HEX
- * value of {@code #D8DEE9}.
- *
+ * Base component color "{@code nord4}" of "Snow Storm" with a RGB value of {@code rgb(216, 222, 233)} and a HEX value
+ * of {@code #D8DEE9}.
+ *
+ *
*/
NORD4(216, 222, 233),
/**
- * The color {@code nord5} of the "Snow Storm" component with an RGB value of {@code rgb(229, 233, 240)} and an HEX
- * value of {@code #E5E9F0}.
- *
+ * Brighter color "{@code nord5}" of the "Snow Storm" component base color {@link #NORD4} with a RGB value of
+ * {@code rgb(229, 233, 240)} and a HEX value of {@code #E5E9F0}.
+ *
+ *
*/
NORD5(229, 233, 240),
/**
- * The color {@code nord6} of the "Snow Storm" component with an RGB value of {@code rgb(236, 239, 244)} and an HEX
- * value of {@code #ECEFF4}.
- *
+ * Brighter color "{@code nord6}" of the "Snow Storm" component base color {@link #NORD4} with a RGB value of
+ * {@code rgb(236, 239, 244)} and a HEX value of {@code #ECEFF4}.
+ *
+ *
*/
NORD6(236, 239, 244),
/**
- * The color {@code nord7} of the "Frost" component with an RGB value of {@code rgb(143, 188, 187)} and an HEX
- * value of {@code #8FBCBB}.
- *
+ * Bluish core color "{@code nord7}" of the "Frost" component with a RGB value of {@code rgb(143, 188, 187)} and a
+ * HEX value of {@code #8FBCBB}.
+ *
+ *
*/
NORD7(143, 188, 187),
/**
- * The color {@code nord8} of the "Frost" component with an RGB value of {@code rgb(136, 192, 208)} and an HEX
- * value of {@code #88C0D0}.
- *
+ * Bluish core accent color "{@code nord8}" of the "Frost" component with a RGB value of {@code rgb(136, 192, 208)}
+ * and a HEX value of {@code #88C0D0}.
+ *
+ *
*/
NORD8(136, 192, 208),
/**
- * The color {@code nord9} of the "Frost" component with an RGB value of {@code rgb(129, 161, 193)} and an HEX
- * value of {@code #81A1C1}.
- *
+ * Bluish core color "{@code nord9}" of the "Frost" component with a RGB value of {@code rgb(129, 161, 193)} and a
+ * HEX value of {@code #81A1C1}.
+ *
+ *
*/
NORD9(129, 161, 193),
/**
- * The color {@code nord10} of the "Frost" component with an RGB value of {@code rgb(94, 129, 172)} and an HEX
- * value of {@code #5E81AC}.
- *
+ * Bluish core color "{@code nord10}" of the "Frost" component with a RGB value of {@code rgb(94, 129, 172)} and a
+ * HEX value of {@code #5E81AC}.
+ *
+ *
*/
NORD10(94, 129, 172),
/**
- * The color {@code nord11} of the "Aurora" component with an RGB value of {@code rgb(191, 97, 106)} and an HEX
- * value of {@code #BF616A}.
- *
+ * Colorful color "{@code nord11}" of the "Aurora" component with a RGB value of {@code rgb(191, 97, 106)} and a
+ * HEX value of {@code #BF616A}.
+ *
+ *
*/
NORD11(191, 97, 106),
/**
- * The color {@code nord12} of the "Aurora" component with an RGB value of {@code rgb(208, 135, 112)} and an HEX
- * value of {@code #D08770}.
- *
+ * Colorful color "{@code nord12}" of the "Aurora" component with a RGB value of {@code rgb(208, 135, 112)} and a
+ * HEX value of {@code #D08770}.
+ *
+ *
*/
NORD12(208, 135, 112),
/**
- * The color {@code nord13} of the "Aurora" component with an RGB value of {@code rgb(235, 203, 139)} and an HEX
- * value of {@code #EBCB8B}.
- *
+ * Colorful color "{@code nord13}" of the "Aurora" component with a RGB value of {@code rgb(235, 203, 139)} and a
+ * HEX value of {@code #EBCB8B}.
+ *
+ *
*/
NORD13(235, 203, 139),
@@ -165,21 +184,27 @@ public enum Nord {
NORD14(163, 190, 140),
/**
- * The color {@code nord15} of the "Aurora" component with an RGB value of {@code rgb(180, 142, 173)} and an HEX
- * value of {@code #B48EAD}.
- *
+ * Colorful color "{@code nord15}" of the "Aurora" component with a RGB value of {@code rgb(180, 142, 173)} and a
+ * HEX value of {@code #B48EAD}.
+ *
+ *
*/
NORD15(180, 142, 173);
/**
- * Compiled pattern to convert the RGB and HEX color values.
+ * Prefix pattern to convert RGB- and HEX color values.
*/
private static final Pattern COLOR_PREFIX = Pattern.compile("0x", Pattern.LITERAL);
/**
- * Contains the RGB color code.
+ * The RGB color code.
*/
- private final Color COLOR;
+ private final Color color;
+
+ /**
+ * The ArcVer version of the public API.
+ */
+ private static final String VERSION = "0.2.0";
/**
* Constructs a new color object.
@@ -189,13 +214,13 @@ public enum Nord {
* @param blue the value for the additive primary color {@code blue}
*/
Nord(final int red, final int green, final int blue) {
- COLOR = Color.rgb(red, green, blue);
+ color = Color.rgb(red, green, blue);
}
/**
- * Converts the {@code color} to the HEX identifier.
+ * Converts the specified color to the HEX identifier.
*
- * @param color the color object
+ * @param color the color object to convert
* @return the string representation of the HEX identifier
*/
public static String hex(final Color color) {
@@ -203,9 +228,9 @@ public static String hex(final Color color) {
}
/**
- * Converts the {@code color} to the RGB identifier.
+ * Converts the specified color to the RGB identifier.
*
- * @param color the color object
+ * @param color the color object to convert
* @return the string representation of the RGB identifier
*/
public static String rgb(final Color color) {
@@ -222,12 +247,12 @@ public static String rgb(final Color color) {
}
/**
- * Returns the color object.
+ * The color constant as color object.
*
* @return the color object
*/
public Color get() {
- return COLOR;
+ return color;
}
/**
@@ -236,7 +261,7 @@ public Color get() {
* @return the ArcVer version string
* @see SemVer
*/
- public String getVersion() {
- return "0.1.0";
+ public static String getVersion() {
+ return VERSION;
}
}
diff --git a/src/main/java/com/arcticicestudio/nord/package-info.java b/src/main/java/com/arcticicestudio/nord/package-info.java
index b143b3d..7542978 100644
--- a/src/main/java/com/arcticicestudio/nord/package-info.java
+++ b/src/main/java/com/arcticicestudio/nord/package-info.java
@@ -2,7 +2,6 @@
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title Nord API Package Info +
project nord-java +
-version 0.1.0 +
repository https://github.com/arcticicestudio/nord-java +
author Arctic Ice Studio +
email development@arcticicestudio.com +
@@ -10,17 +9,14 @@ copyright Copyright (C) 2016 +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*/
/**
- * Public API of the Nord - Java project, which implements
+ * Public API of the Nord Java project, which implements
* the Nord color palette.
*
*
- * The main entry point of the API is the {@link com.arcticicestudio.nord.Nord} enum.
- *
+ * The public API entry point is the {@link com.arcticicestudio.nord.Nord} enum.
*
* @author Arctic Ice Studio <development@arcticicestudio.com>
- * @see Nord - Java
- * @see Nord
- * @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 e0952d5..bd95f29 100644
--- a/src/test/java/com/arcticicestudio/nord/NordTest.java
+++ b/src/test/java/com/arcticicestudio/nord/NordTest.java
@@ -2,7 +2,6 @@
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title Nord API Unit Test +
project nord-java +
-version 0.1.0 +
repository https://github.com/arcticicestudio/nord-java +
author Arctic Ice Studio +
email development@arcticicestudio.com +
@@ -11,20 +10,22 @@ copyright Copyright (C) 2016 +
*/
package com.arcticicestudio.nord;
+import com.arcticicestudio.arcver.Version;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
/**
- * Unit tests for the public API {@link Nord}.
+ * Unit tests for the {@link Nord} public API.
*
* @author Arctic Ice Studio <development@arcticicestudio.com>
- * @see Nord
* @since 0.1.0
*/
public class NordTest {
+
@Test
- public void shouldReturnTheCorrectHEXColorCode() {
+ public void shouldReturnHEXColorCode() {
assertEquals(Nord.hex(Nord.NORD0.get()), "#2E3440");
assertEquals(Nord.hex(Nord.NORD1.get()), "#3B4252");
assertEquals(Nord.hex(Nord.NORD2.get()), "#434C5E");
@@ -62,4 +63,9 @@ public void shouldReturnTheCorrectRGBColorCode() {
assertEquals(Nord.rgb(Nord.NORD14.get()), "rgb(163, 190, 140)");
assertEquals(Nord.rgb(Nord.NORD15.get()), "rgb(180, 142, 173)");
}
+
+ @Test
+ public void shouldReturnTheCorrectVersionString() {
+ assertTrue(Version.valueOf(Nord.getVersion()).satisfies("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')
```