Skip to content

Commit

Permalink
Merge branch 'feature/ghi-#1-nord-api' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
@arcticicestudio
arcticicestudio committed Sep 26, 2016
2 parents f44bcf1 + 036da58 commit 8949a9b
Show file tree
Hide file tree
Showing 3 changed files with 333 additions and 0 deletions.
242 changes: 242 additions & 0 deletions src/main/java/com/arcticicestudio/nord/Nord.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title Nord API +
project nord-java +
version 0.0.0 +
repository https://github.com/arcticicestudio/nord-java +
author Arctic Ice Studio +
email [email protected] +
copyright Copyright (C) 2016 +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*/
package com.arcticicestudio.nord;

import javafx.scene.paint.Color;

import java.util.regex.Pattern;

/**
* Public API entry point of the <a href="https://github.com/arcticicestudio/nord-java">Nord - Java</a> project, which
* implements the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.
*
* <div>
* <table >
* <tbody>
* <tr>
* <th style="border:0;">Polar Night</th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(46,52,64);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(59,66,82);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(67,76,94);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(76,86,106);margin:0"></th>
* </tr>
* <tr>
* <th style="border:0;">Snow Storm</th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(216,222,233);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(229,233,240);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(236,239,244);margin:0"></th>
* </tr>
* <tr>
* <th style="border:0;">Frost</th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(143,188,187);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(136,192,208);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(129,161,193);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(94,129,172);margin:0"></th>
* </tr>
* <tr>
* <th style="border:0;">Aurora</th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(191,97,106);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(208,135,112);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(235,203,139);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(163,190,140);margin:0"></th>
* <th style="border:0;width:25px;height:30px;background-color:rgb(180,142,173);margin:0"></th>
* </tr>
* </tbody>
* </table>
* </div>
*
* @author Arctic Ice Studio &lt;[email protected]&gt;
* @version 0.0.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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(46,52,64);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(59,66,82);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(67,76,94);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(76,86,106);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(216,222,233);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(229,233,240);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(236,239,244);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(143,188,187);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(136,192,208);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(129,161,193);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(94,129,172);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(191,97,106);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(208,135,112);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(235,203,139);margin: 0"></div>
*/
NORD13(235, 203, 139),

/**
* The color {@code nord14} of the "Aurora" component with an RGB value of {@code rgb(163, 190, 140)} and an HEX
* value of {@code #A3BE8C}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(163,190,140);margin: 0"></div>
*/
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}.
* <div style="border:none;width:25px;height:30px;background-color:rgb(180,142,173);margin: 0"></div>
*/
NORD15(180, 142, 173);

/**
* Compiled pattern to convert the RGB and HEX color values.
*/
private static final Pattern COLOR_PREFIX = Pattern.compile("0x", Pattern.LITERAL);

/**
* Contains the RGB color code.
*/
private final Color COLOR;

/**
* Constructs a new color object.
*
* @param red the value for the additive primary color {@code red}
* @param green the value for the additive primary color {@code green}
* @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);
}

/**
* Converts the {@code color} to the HEX identifier.
*
* @param color the color object
* @return the string representation of the HEX identifier
*/
public static String hex(final Color color) {
return COLOR_PREFIX.matcher(color.toString()).replaceAll("#").substring(0, 7).toUpperCase();
}

/**
* Converts the {@code color} to the RGB identifier.
*
* @param color the color object
* @return the string representation of the RGB identifier
*/
public static String rgb(final Color color) {
String hex = COLOR_PREFIX.matcher(color.toString()).replaceAll("");
String hexRed = hex.substring(0, 2).toUpperCase();
String hexGreen = hex.substring(2, 4).toUpperCase();
String hexBlue = hex.substring(4, 6).toUpperCase();

String intRed = Integer.toString(Integer.parseInt(hexRed, 16));
String intGreen = Integer.toString(Integer.parseInt(hexGreen, 16));
String intBlue = Integer.toString(Integer.parseInt(hexBlue, 16));

return String.join("", "rgb(", intRed, ", ", intGreen, ", ", intBlue, ")");
}

/**
* Returns the color object.
*
* @return the color object
*/
public Color get() {
return COLOR;
}

/**
* Returns the <a href="https://github.com/arcticicestudio/arcver">ArcVer</a> version of the public API.
*
* @return the ArcVer version string
* @see <a href="http://semver.org">SemVer</a>
*/
public String getVersion() {
return "0.0.0";
}
}
26 changes: 26 additions & 0 deletions src/main/java/com/arcticicestudio/nord/package-info.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title Nord API Package Info +
project nord-java +
version 0.0.0 +
repository https://github.com/arcticicestudio/nord-java +
author Arctic Ice Studio +
email [email protected] +
copyright Copyright (C) 2016 +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*/
/**
* Public API of the <a href="https://github.com/arcticicestudio/nord-java">Nord - Java</a> project, which implements
* the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.
*
* <p>
* The main entry point of the API is the {@link com.arcticicestudio.nord.Nord} enum.
* </p>
*
* @author Arctic Ice Studio &lt;[email protected]&gt;
* @see <a href="https://github.com/arcticicestudio/nord-java">Nord - Java </a>
* @see <a href="https://github.com/arcticicestudio/nord">Nord</a>
* @version 0.0.0
* @since 0.1.0
*/
package com.arcticicestudio.nord;
65 changes: 65 additions & 0 deletions src/test/java/com/arcticicestudio/nord/NordTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title Nord API Unit Test +
project nord-java +
version 0.0.0 +
repository https://github.com/arcticicestudio/nord-java +
author Arctic Ice Studio +
email [email protected] +
copyright Copyright (C) 2016 +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*/
package com.arcticicestudio.nord;

import org.junit.Test;

import static org.junit.Assert.assertEquals;

/**
* Unit tests for the public API {@link Nord}.
*
* @author Arctic Ice Studio &lt;[email protected]&gt;
* @see Nord
* @since 0.1.0
*/
public class NordTest {
@Test
public void shouldReturnTheCorrectHEXColorCode() {
assertEquals(Nord.hex(Nord.NORD0.get()), "#2E3440");
assertEquals(Nord.hex(Nord.NORD1.get()), "#3B4252");
assertEquals(Nord.hex(Nord.NORD2.get()), "#434C5E");
assertEquals(Nord.hex(Nord.NORD3.get()), "#4C566A");
assertEquals(Nord.hex(Nord.NORD4.get()), "#D8DEE9");
assertEquals(Nord.hex(Nord.NORD5.get()), "#E5E9F0");
assertEquals(Nord.hex(Nord.NORD6.get()), "#ECEFF4");
assertEquals(Nord.hex(Nord.NORD7.get()), "#8FBCBB");
assertEquals(Nord.hex(Nord.NORD8.get()), "#88C0D0");
assertEquals(Nord.hex(Nord.NORD9.get()), "#81A1C1");
assertEquals(Nord.hex(Nord.NORD10.get()), "#5E81AC");
assertEquals(Nord.hex(Nord.NORD11.get()), "#BF616A");
assertEquals(Nord.hex(Nord.NORD12.get()), "#D08770");
assertEquals(Nord.hex(Nord.NORD13.get()), "#EBCB8B");
assertEquals(Nord.hex(Nord.NORD14.get()), "#A3BE8C");
assertEquals(Nord.hex(Nord.NORD15.get()), "#B48EAD");
}

@Test
public void shouldReturnTheCorrectRGBColorCode() {
assertEquals(Nord.rgb(Nord.NORD0.get()), "rgb(46, 52, 64)");
assertEquals(Nord.rgb(Nord.NORD1.get()), "rgb(59, 66, 82)");
assertEquals(Nord.rgb(Nord.NORD2.get()), "rgb(67, 76, 94)");
assertEquals(Nord.rgb(Nord.NORD3.get()), "rgb(76, 86, 106)");
assertEquals(Nord.rgb(Nord.NORD4.get()), "rgb(216, 222, 233)");
assertEquals(Nord.rgb(Nord.NORD5.get()), "rgb(229, 233, 240)");
assertEquals(Nord.rgb(Nord.NORD6.get()), "rgb(236, 239, 244)");
assertEquals(Nord.rgb(Nord.NORD7.get()), "rgb(143, 188, 187)");
assertEquals(Nord.rgb(Nord.NORD8.get()), "rgb(136, 192, 208)");
assertEquals(Nord.rgb(Nord.NORD9.get()), "rgb(129, 161, 193)");
assertEquals(Nord.rgb(Nord.NORD10.get()), "rgb(94, 129, 172)");
assertEquals(Nord.rgb(Nord.NORD11.get()), "rgb(191, 97, 106)");
assertEquals(Nord.rgb(Nord.NORD12.get()), "rgb(208, 135, 112)");
assertEquals(Nord.rgb(Nord.NORD13.get()), "rgb(235, 203, 139)");
assertEquals(Nord.rgb(Nord.NORD14.get()), "rgb(163, 190, 140)");
assertEquals(Nord.rgb(Nord.NORD15.get()), "rgb(180, 142, 173)");
}
}

0 comments on commit 8949a9b

Please sign in to comment.