Contrast-Finder v0.6.0

---------------------- set version to 0.6.0 DOC - Updated Other-contrast-tools.md fixed #59 - Upgraded outdated dependencies: SpringFramework 4.3.10 refactor i18n i18n: missing texts (2/2) i18n: missing texts i18n: minor fix Update contrast-finder_utf8_pt.properties Update contrast-finder_utf8_pt.properties Fixed #79 - Added maven-checkstyle-plugin DOC - Updated Other-contrast-tools.md typo fixed webapp/pom.xml Fixed #76 i18n files in UTF8 character encoding #76 Converted i18n properties files in UTF8 Create contrast-finder_pt.properties Updated Contributor_doc set version to 0.5.3-dev
Asqatasun · Jul 20, 2017 · 7e00a17 · 7e00a17
2 parents 80f9506 + 9beaa92
commit 7e00a17
Show file tree

Hide file tree

Showing 28 changed files with 450 additions and 194 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # CHANGELOG
 
+Contrast-Finder 0.6.0, 2017-07-21
+---------------------------------
+
+Upgrade-o-meter: just replace the .war file and restart Tomcat
+
+### New Feature
+- [#80 - i18n: added portuguese](https://github.com/Asqatasun/Contrast-Finder/issues/80)
+
+### Outdated dependencies
+- [#59 - Upgraded SpringFramework to v4.3.10](https://github.com/Asqatasun/Contrast-Finder/issues/59)
+
+### Refactoring
+- [#76 - i18n files in UTF8 character encoding](https://github.com/Asqatasun/Contrast-Finder/issues/76) 
+
+### Task
+- [#79 - Pom.xml: added maven-checkstyle-plugin](https://github.com/Asqatasun/Contrast-Finder/issues/79) 
+
+
+
+
 Contrast-Finder 0.5.2, 2017-07-04
 ---------------------------------
 

diff --git a/docker/RELEASE/Dockerfile b/docker/RELEASE/Dockerfile
@@ -1,7 +1,7 @@
 FROM asqatasun/contrast-finder:pre-requisites_from-Ubuntu
 LABEL org.label-schema.schema-version = "1.0.0-rc.1"                                            \
       org.label-schema.name           = "Contrast-Finder - WebApp"                              \
-      org.label-schema.version        = "0.5.2"                                             \
+      org.label-schema.version        = "0.6.0"                                             \
       org.label-schema.url            = "https://contrast-finder.org"                           \
       org.label-schema.vcs-url        = "https://github.com/Asqatasun/Contrast-Finder"          \
       org.label-schema.docker.cmd     = "docker run -p 8087:8080 -d asqatasun/contrast-finder"  \
@@ -13,9 +13,9 @@ LABEL org.label-schema.schema-version = "1.0.0-rc.1"
 #
 #   --- Building this docker image
 #   docker build -t asqatasun/contrast-finder  .
-#   docker build -t asqatasun/contrast-finder  --build-arg CONTRAST_FINDER_RELEASE=0.5.2  .
-#   docker build -t asqatasun/contrast-finder  --build-arg SRC_URL_PREFIX=https://github.com/Asqatasun/Contrast-Finder/releases/download/v0.5.2/   .
-#   docker build -t asqatasun/contrast-finder  --build-arg SRC_URL=https://github.com/Asqatasun/Contrast-Finder/releases/download/v0.5.2/contrast-finder_0.5.2.i386.tar.gz   .
+#   docker build -t asqatasun/contrast-finder  --build-arg CONTRAST_FINDER_RELEASE=0.6.0  .
+#   docker build -t asqatasun/contrast-finder  --build-arg SRC_URL_PREFIX=https://github.com/Asqatasun/Contrast-Finder/releases/download/v0.6.0/   .
+#   docker build -t asqatasun/contrast-finder  --build-arg SRC_URL=https://github.com/Asqatasun/Contrast-Finder/releases/download/v0.6.0/contrast-finder_0.6.0.i386.tar.gz   .
 #
 #   --- Launch a container
 #   docker run -p 127.0.0.1:8087:8080 --name contrast.finder -d asqatasun/contrast-finder
@@ -36,7 +36,7 @@ LABEL org.label-schema.schema-version = "1.0.0-rc.1"
 ###################################################################
 
 # build variables
-ARG CONTRAST_FINDER_RELEASE="0.5.2"
+ARG CONTRAST_FINDER_RELEASE="0.6.0"
 ARG SRC_URL_PREFIX="https://github.com/Asqatasun/Contrast-Finder/releases/download/v${CONTRAST_FINDER_RELEASE}"
 ARG SRC_URL="${SRC_URL_PREFIX}/contrast-finder_${CONTRAST_FINDER_RELEASE}.i386.tar.gz"
 

diff --git a/docker/RELEASE/README.md b/docker/RELEASE/README.md
@@ -7,11 +7,11 @@ Tool to provide color combination for a good (accessible, WCAG-compliant) contra
 Supported tags and respective `Dockerfile` links :
 
 * [pre-requisites_from-Ubuntu](https://github.com/Asqatasun/Contrast-Finder/blob/master/docker/pre-requisites/pre-requisites_from-Ubuntu/Dockerfile)
-* [v0.5.2, latest](https://github.com/Asqatasun/Contrast-Finder/blob/master/docker/RELEASE/Dockerfile)
+* [v0.6.0, latest](https://github.com/Asqatasun/Contrast-Finder/blob/master/docker/RELEASE/Dockerfile)
+* [v0.5.2](https://github.com/Asqatasun/Contrast-Finder/blob/v0.5.2/docker/RELEASE/Dockerfile)
 * [v0.5.1](https://github.com/Asqatasun/Contrast-Finder/blob/v0.5.1/docker/RELEASE/Dockerfile)
 * [v0.5.0](https://github.com/Asqatasun/Contrast-Finder/blob/v0.5.0/docker/RELEASE/Dockerfile)
 * [v0.4.7](https://github.com/Asqatasun/Contrast-Finder/blob/v0.4.7/docker/RELEASE/Dockerfile)
-* [v0.4.6](https://github.com/Asqatasun/Contrast-Finder/blob/v0.4.6/docker/RELEASE/Dockerfile)
 
 ## How to use this image
 `docker pull asqatasun/contrast-finder` 

diff --git a/docker/SNAPSHOT-local_from-Tomcat/Dockerfile b/docker/SNAPSHOT-local_from-Tomcat/Dockerfile
@@ -25,7 +25,7 @@ FROM tomcat:7.0-jre7
 ###################################################################
 
 # environment variables
-ENV CONTRAST_FINDER_RELEASE="0.5.2"
+ENV CONTRAST_FINDER_RELEASE="0.6.0"
 ENV TOMCAT_WEBAPP_DIR="/usr/local/tomcat/webapps"
 
 # Prepare Contrast-Finder

diff --git a/docker/SNAPSHOT-local_from-Ubuntu/Dockerfile b/docker/SNAPSHOT-local_from-Ubuntu/Dockerfile
@@ -19,7 +19,7 @@ FROM asqatasun/contrast-finder:pre-requisites_from-Ubuntu
 ###################################################################
 
 # environment variables
-ENV CONTRAST_FINDER_RELEASE="0.5.2"
+ENV CONTRAST_FINDER_RELEASE="0.6.0"
 
 # Add contrast-finder .war
 ADD contrast-finder_${CONTRAST_FINDER_RELEASE}.i386.tar.gz  /root

diff --git a/docker/SNAPSHOT-local_from-Ubuntu/test_conf-default-algo/Dockerfile b/docker/SNAPSHOT-local_from-Ubuntu/test_conf-default-algo/Dockerfile
@@ -19,7 +19,7 @@ FROM asqatasun/contrast-finder:pre-requisites_from-Ubuntu
 ###################################################################
 
 # environment variables
-ENV CONTRAST_FINDER_RELEASE="0.5.2"
+ENV CONTRAST_FINDER_RELEASE="0.6.0"
 ENV CONF_DEFAULT_ALGO="Rgb"
     # ENV CONF_DEFAULT_ALGO="Rgb"
     # ENV CONF_DEFAULT_ALGO="HSV"

diff --git a/docker/SNAPSHOT-local_from-Ubuntu/test_conf-env_debug/Dockerfile b/docker/SNAPSHOT-local_from-Ubuntu/test_conf-env_debug/Dockerfile
@@ -19,7 +19,7 @@ FROM asqatasun/contrast-finder:pre-requisites_from-Ubuntu
 ###################################################################
 
 # environment variables
-ENV CONTRAST_FINDER_RELEASE="0.5.2"
+ENV CONTRAST_FINDER_RELEASE="0.6.0"
 ENV CONF_ENV="debug"
 
 # Add contrast-finder .war

diff --git a/docker/SNAPSHOT-local_from-Ubuntu/test_conf-piwik/Dockerfile b/docker/SNAPSHOT-local_from-Ubuntu/test_conf-piwik/Dockerfile
@@ -19,7 +19,7 @@ FROM asqatasun/contrast-finder:pre-requisites_from-Ubuntu
 ###################################################################
 
 # environment variables
-ENV CONTRAST_FINDER_RELEASE="0.5.2"
+ENV CONTRAST_FINDER_RELEASE="0.6.0"
 ENV PIWIK_KEY="9"
 ENV PIWIK_URL="http://localhost/piwik/"
 

diff --git a/docker/pre-requisites/pre-requisites_from-Ubuntu/Dockerfile b/docker/pre-requisites/pre-requisites_from-Ubuntu/Dockerfile
@@ -1,7 +1,7 @@
 FROM ubuntu:14.04
 LABEL org.label-schema.schema-version = "1.0.0-rc.1"                                            \
       org.label-schema.name           = "Contrast-Finder - WebApp pre-requisites"               \
-      org.label-schema.version        = "0.5.2"                                             \
+      org.label-schema.version        = "0.6.0"                                             \
       org.label-schema.url            = "https://contrast-finder.org"                           \
       org.label-schema.vcs-url        = "https://github.com/Asqatasun/Contrast-Finder"
           # ----> documentation  http://label-schema.org/

diff --git a/documentation/en/30_Contributor_doc/README.md b/documentation/en/30_Contributor_doc/README.md
@@ -4,38 +4,28 @@
 * [Release a version of Contrast-Finder](Release/README.md) 
 
 -----
-
-* JavaDoc
-* OWASP Dependency-Check
 * Checking for new dependency / plugin updates
+* OWASP Dependency-Check
+* Checkstyle
+* JavaDoc
 
-## JavaDoc
 
+## Checking for new dependency / plugin updates
 ```bash
-git clone https://github.com/Asqatasun/Contrast-Finder
-cd Contrast-finder
-```
+# Checking for new dependency updates
+mvn versions:display-dependency-updates 
 
-One of the following command lines:
-```bash
-mvn javadoc:javadoc
-mvn javadoc:aggregate
-mvn javadoc:test-javadoc
-mvn javadoc:test-aggregate 
-mvn site
-```
+# Checking for new plugin updates
+mvn versions:display-plugin-updates  
 
-JavaDoc is available in the following directories:
-```bash
-target/site/apidocs
-target/site/testapidocs
+# Checking for new property-linked updates
+mvn versions:display-property-updates 
 ```
 
 ### Documentation
-* [Apache Maven Javadoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/)
-* [Generate Javadocs](https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html)
-* [Javadoc Plugin Documentation](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html)
-
+* http://www.mojohaus.org/versions-maven-plugin/examples/display-dependency-updates.html
+* http://www.mojohaus.org/versions-maven-plugin/examples/display-plugin-updates.html
+* http://www.mojohaus.org/versions-maven-plugin/examples/display-property-updates.html
 
 
 ##  OWASP Dependency-Check
@@ -69,18 +59,75 @@ mvn dependency-check:help -Ddetail=true -Dgoal=aggregate
 * http://jeremylong.github.io/DependencyCheck/
 * http://jeremylong.github.io/DependencyCheck/dependency-check-maven/
 
-## Checking for new dependency / plugin updates
+
+## Checkstyle
+Scan Contrast-Finder to check the violations of a coding standard.
+
+### Documentation
+* http://checkstyle.sourceforge.net/
+* http://maven.apache.org/plugins/maven-checkstyle-plugin/
+
+### maven-checkstyle-plugin
 ```bash
-# Checking for new dependency updates
-mvn versions:display-dependency-updates 
+git clone https://github.com/Asqatasun/Contrast-Finder
+cd Contrast-finder
 
-# Checking for new plugin updates
-mvn versions:display-plugin-updates  
+# Performs Checkstyle analysis and outputs violations or a count of violations
+# to the console, potentially failing the build.
+mvn checkstyle:check
 
-# Checking for new property-linked updates
-mvn versions:display-property-updates 
+# A reporting task that performs Checkstyle analysis 
+# and generates an HTML report for each module
+mvn checkstyle:checkstyle
+
+# a reporting task that performs Checkstyle analysis
+# and generates an aggregate HTML report 
+mvn checkstyle:checkstyle-aggregate
+mvn site
+
+# Checking for violations as part of the Build
+mvn clean install 
+    # Before, remove comments 
+    # around <goal>check</goal> in pom.xml file
+```
+
+### checkstyle CLI
+```bash
+apt-get install checkstyle
+git clone https://github.com/Asqatasun/Contrast-Finder
+checkstyle  -c checkstyle.xml Contrast-Finder/**/*.java 
+```
+
+
+### CI (Travis, Gitlab, Jenkins)
+...
+
+
+
+## JavaDoc
+
+```bash
+git clone https://github.com/Asqatasun/Contrast-Finder
+cd Contrast-finder
+```
+
+One of the following command lines:
+```bash
+mvn javadoc:javadoc
+mvn javadoc:aggregate
+mvn javadoc:test-javadoc
+mvn javadoc:test-aggregate 
+mvn site
+```
+
+JavaDoc is available in the following directories:
+```bash
+target/site/apidocs
+target/site/testapidocs
 ```
+
 ### Documentation
-* http://www.mojohaus.org/versions-maven-plugin/examples/display-dependency-updates.html
-* http://www.mojohaus.org/versions-maven-plugin/examples/display-plugin-updates.html
-* http://www.mojohaus.org/versions-maven-plugin/examples/display-property-updates.html
+* [Apache Maven Javadoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/)
+* [Generate Javadocs](https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html)
+* [Javadoc Plugin Documentation](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html)
+
diff --git a/documentation/en/30_Contributor_doc/Release/README.md b/documentation/en/30_Contributor_doc/Release/README.md
@@ -80,6 +80,9 @@ none
 ### Security
 none
 
+### Outdated dependencies
+none
+
 ### Bug
 none
 

diff --git a/documentation/en/30_Contributor_doc/i18n/README.md b/documentation/en/30_Contributor_doc/i18n/README.md
@@ -0,0 +1,24 @@
+# i18n
+
+Java i18n files however must be ISO-8859-1.
+
+## Convert a single file
+
+### UTF8 to ISO-8859-1 with Unicode escapes 
+Converts a file encoded in UTF8 to a file in in ISO-8859-1 with Unicode escapes.
+```bash
+native2ascii -encoding utf8 example.utf8.txt example.propertie
+```
+
+### ISO-8859-1 with Unicode escapes to UTF8
+Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in UTF8 character encoding.
+```bash
+native2ascii -encoding utf8 -reverse example.propertie   example.reverse.utf8.txt
+```
+
+## native2ascii-maven-plugin
+
+- https://davidsimpson.me/2015/03/04/automated-native2ascii-character-conversion-internationalization-atlassian-add-ons/
+- https://blog.crafting-labs.fr/2010/09/25/fichiers-properties-java-en-utf-8-avec-maven/
+- https://stackoverflow.com/questions/7105039/maven-how-to-configure-native2ascii-maven-plugin?rq=1
+  - http://grepcode.com/project/repo1.maven.org/maven2/org.codehaus.mojo/native2ascii-maven-plugin/
diff --git a/documentation/en/Other-contrast-tools.md b/documentation/en/Other-contrast-tools.md
@@ -5,16 +5,18 @@
 * [Contrast-A](http://www.dasplankton.de/ContrastA/)
 * [WCAG Contrast Checker (firefox addon) v1.2](https://addons.mozilla.org/fr/firefox/addon/wcag-contrast-checker/versions/?page=1#version-1.2) Especially v1.2 because you can select a given text (functionnality has disappeared in further versions)
 * [Color Contrast Tool (snook.ca)](http://snook.ca/technical/colour_contrast/colour.html)
+* [Accessible-colors.com](http://accessible-colors.com/)
+    * src: https://github.com/moroshko/accessible-colors
 
 ## Other contrast tools (which are actually good, but it appears we don't them)
 * http://webaim.org/resources/contrastchecker/
 * http://contrastchecker.com/
 * http://leaverou.github.io/contrast-ratio/
-  * src: https://github.com/LeaVerou/contrast-ratio
+    * src: https://github.com/LeaVerou/contrast-ratio
 * http://juicystudio.com/services/luminositycontrastratio.php
 * http://vanisoft.pl/~lopuszanski/public/colors/
 * http://www.brandwood.com/a11y/ 
-  * src: https://github.com/andrewbrandwood/a11y-image-text
+    * src: https://github.com/andrewbrandwood/a11y-image-text
 
 ### Other contrast tools 
 * http://www.visionaustralia.org/digital-access-determinator
@@ -25,26 +27,28 @@
 * https://www.joedolson.com/tools/color-contrast-tester.php
 * https://www.joedolson.com/tools/color-contrast.php
 * https://github.com/toolness/accessible-color-matrix
-  * https://toolness.github.io/accessible-color-matrix/
+    * https://toolness.github.io/accessible-color-matrix/
 * https://addons.mozilla.org/fr/firefox/addon/wcag-contrast-checker/
 * https://hexnaw.com/
+
 * http://jxnblk.com/colorable/
-  * https://colorable.jxnblk.com/
-  * http://jxnblk.com/hello-color/
-  * http://jxnblk.com/colorable/demos/text/
-  * http://jxnblk.com/colorable/demos/matrix/
-  * http://www.aremycoloursaccessible.com/
+    * https://colorable.jxnblk.com/
+    * http://jxnblk.com/hello-color/
+    * http://jxnblk.com/colorable/demos/text/
+    * http://jxnblk.com/colorable/demos/matrix/
+    * http://www.aremycoloursaccessible.com/
 * [Sass Contrast Functions](https://codepen.io/giana/project/full/ZWbGzD)
 
 ### Color scheme generation
 
 * [Palat](https://dobtco.github.io/palat/) generate accessible color scheme
-  * Ruby gem - https://github.com/dobtco/palat/
+    * Ruby gem - https://github.com/dobtco/palat/
 
 ### Vision simulation
 
 * http://paletton.com/ very popular but n real option for accessibility (as of 2016), and not opensource
+* http://carlosrafaelgn.com.br/Aula/Cores.html (not opensource, in Portuguese)
 * http://www.getstark.co/
-  * https://github.com/stark-contrast/stark-sketch-plugin
+    * https://github.com/stark-contrast/stark-sketch-plugin
 
 
diff --git a/documentation/pom.xml b/documentation/pom.xml
@@ -4,11 +4,11 @@
     <parent>
         <groupId>org.asqatasun</groupId>
         <artifactId>contrast-finder</artifactId>
-        <version>0.5.2</version>
+        <version>0.6.0</version>
     </parent>
     <artifactId>documentation</artifactId>
     <packaging>pom</packaging>
-    <version>0.5.2</version>
+    <version>0.6.0</version>
     <name>contrast-finder-documentation</name>
     <licenses>
         <license>

diff --git a/engine/api/pom.xml b/engine/api/pom.xml
@@ -4,10 +4,10 @@
     <parent>
         <groupId>org.asqatasun</groupId>
         <artifactId>engine</artifactId>
-        <version>0.5.2</version>
+        <version>0.6.0</version>
     </parent>
     <artifactId>contrast-finder-api</artifactId>
-    <version>0.5.2</version>
+    <version>0.6.0</version>
     <packaging>jar</packaging>
     <name>api</name>
     <licenses>

diff --git a/engine/hsv/pom.xml b/engine/hsv/pom.xml
@@ -4,10 +4,10 @@
     <parent>
         <groupId>org.asqatasun</groupId>
         <artifactId>engine</artifactId>
-        <version>0.5.2</version>
+        <version>0.6.0</version>
     </parent>
     <artifactId>contrast-finder-hsv</artifactId>
-    <version>0.5.2</version>
+    <version>0.6.0</version>
     <packaging>jar</packaging>
     <name>hsv</name>
     <licenses>
-Original file line number
+Diff line change
@@ Expand Up / @@ -80,6 +80,9 @@ none @@
     ### Security
     none
+    ### Outdated dependencies
+    none
     ### Bug
     none
@@ Expand Down @@