Contrast-Finder v0.4.7

----------------------

  set version to 0.4.7
  Fixed Asqatasun#51 - Added a cookie to keep the user's choice on the algorithm to use
  Asqatasun#44 - Upgrade outdated dependencies: maven-dependency-plugin  3.0.1 instead of 3.0.0
  fixed Asqatasun#50 - contrast-finder.conf file: added option to override the default algorithm
  Added Sass Contrast Functions
  fixed Asqatasun#44 - Upgrade outdated dependencies (2) : maven-war-plugin 3.1.0 instead of 3.0.0
  typo
  docker/pre-requisites - Added HEALTHCHECK instruction
  Update Other-contrast-tools.md
  typo + Updated the "Code of Conduct" (version 1.4 instead of 1.3.0)
  fixed Asqatasun#12 - Added documentation for releasing a new version
  Updated documentation
  Fixed Asqatasun#47 - Added prerequisites for maven (version 3.1)
  Fixed Asqatasun#42 - Javadoc warnings
  fixed Asqatasun#46 -  maven WARNING - pom.xml : 'version' contains an expression but should be a constant
  fixed Asqatasun#44 - Upgrade outdated dependencies
  fixed docker/pre-requisites
  set version to 0.4.7-dev

CHANGELOG.md

@@ -1,4 +1,29 @@
 
+Contrast-Finder 0.4.7, 2017-06-01
+---------------------------------
+
+Features:
+- [#51 - Added a cookie to keep the user's choice on the algorithm to use](https://github.com/Asqatasun/Contrast-Finder/issues/51)
+
+Security:
+- [#44 - Upgrade outdated dependencies: SpringFramework, maven-surefire, maven-war, maven-dependency](https://github.com/Asqatasun/Contrast-Finder/issues/44)
+
+Bugs:
+- [#45 - Fixed docker/pre-requisites: syntax error](https://github.com/Asqatasun/Contrast-Finder/issues/45)
+- [#46 - Fixed maven warnings: 'version' contains an expression but should be a constant](https://github.com/Asqatasun/Contrast-Finder/issues/46)
+
+Configuration: 
+- [#50 - contrast-finder.conf file: added option to override the default algorithm](https://github.com/Asqatasun/Contrast-Finder/issues/50) 
+- [#47 - Added prerequisites for maven (version 3.1)](https://github.com/Asqatasun/Contrast-Finder/issues/47) 
+- [#49 - Dockerfile: added HEALTHCHECK instruction](https://github.com/Asqatasun/Contrast-Finder/issues/49) 
+
+Documentation:
+- [#42 - Fixed Javadoc warnings](https://github.com/Asqatasun/Contrast-Finder/issues/42) 
+- [#12 - Added documentation for releasing a new version](https://github.com/Asqatasun/Contrast-Finder/issues/12) 
+
+Upgrade-o-meter: just replace the .war file and restart Tomcat
+
+
 Contrast-Finder 0.4.6, 2017-04-12
 ---------------------------------
 
@@ -22,7 +47,7 @@ Documentation:
 - [#8 - Howto build & install: missing libspring-instrument-java](https://github.com/Asqatasun/Contrast-Finder/issues/8)
 
 Upgrade-o-meter:
-none
+just replace the .war file and restart Tomcat
 
 
 Contrast-Finder 0.4.5, 2017-03-30

CODE_OF_CONDUCT.md

@@ -1,50 +1,81 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
 that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
 
 This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at asqatasun@asqatasun.org. All
+reported by contacting the project team at asqatasun@asqatasun.org. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
----
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version [1.3.0][version].
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/
+
+## Translations
+
+* [Español](http://contributor-covenant.org/version/1/4/es/)
+* [Français](http://contributor-covenant.org/version/1/4/fr/)
+
+[All available translations](http://contributor-covenant.org/i18n/)

CONTRIBUTING.md

@@ -41,8 +41,6 @@ git checkout develop
 docker/compile_and_build_docker_image.sh -l -s ${PWD} -d docker/SNAPSHOT-local_from-Ubuntu
 ```
 
-
-
 ## Sources of inspiration for CONTRIBUTING.md
 
 * For contributors doc [Gitlab Workflow](https://about.gitlab.com/handbook/#gitlab-workflow)

LICENSE

@@ -617,5 +617,3 @@ Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.
 
                      END OF TERMS AND CONDITIONS
-
-

README.md

@@ -1,7 +1,7 @@
 [![License : AGPL v3](https://img.shields.io/badge/License-AGPL3-blue.svg)](https://github.com/Asqatasun/Contrast-Finder/blob/master/LICENSE) 
 [![Build Status](https://travis-ci.org/Asqatasun/Contrast-Finder.svg)](https://travis-ci.org/Asqatasun/Contrast-Finder)
 [![Release](https://img.shields.io/github/release/asqatasun/Contrast-Finder.svg)](https://github.com/Asqatasun/Contrast-Finder/releases/latest)
-[![Dependency Status](https://www.versioneye.com/user/projects/58eae8f4dff1cd000eaa3fb4/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/58eae8f4dff1cd000eaa3fb4)
+[![Dependency Status](https://www.versioneye.com/user/projects/58fb3e17c2ef423822580804/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/58fb3e17c2ef423822580804?child=summary#tab-dependencies)
 
 # Contrast-Finder
 
@@ -18,7 +18,6 @@ This helps you in satisfying web accessibility (a11y) tests on contrasts:
 ## Demo
 https://app.contrast-finder.org
 
-
 ## Why another contrast tool ?
 
 Just to **provide contrast solutions** !
@@ -34,7 +33,6 @@ Go to the [documentation](https://github.com/Asqatasun/Contrast-Finder/blob/mast
 ## Screenshots
 ![Screenshot - Contrast-Finder v0.3.5](https://github.com/Asqatasun/Contrast-Finder/blob/master/documentation/en/images/screenshot.EN_contrast-finder.v0.3.5_2016-12-19.png)
 
-
 ---
 
 ## Contact and discussions

contrast-finder-api/pom.xml

@@ -4,10 +4,10 @@
     <parent>
         <groupId>org.asqatasun</groupId>
         <artifactId>contrast-finder</artifactId>
-        <version>0.4.6</version>
+        <version>0.4.7</version>
     </parent>
     <artifactId>contrast-finder-api</artifactId>
-    <version>${project.parent.version}</version>
+    <version>0.4.7</version>
     <packaging>jar</packaging>
 
     <name>contrast-finder-api</name>

contrast-finder-api/src/main/java/org/asqatasun/contrastFinder/ColorFinder.java

@@ -29,12 +29,10 @@
 public interface ColorFinder {
 
     /**
-     * 
      * @param foregroundColor
      * @param backgroundColor
      * @param isBackgroundTested
      * @param coefficientLevel
-     * @return 
      */
     void findColors (
             Color foregroundColor, 
@@ -43,13 +41,11 @@ void findColors (
             Float coefficientLevel);
 
     /**
-     * 
-     * @return 
+     * @return ColorResult object
      */
     ColorResult getColorResult();
 
     /**
-     *
      * @return a key that represents the colorFinder
      */
     String getColorFinderKey();

contrast-finder-api/src/main/java/org/asqatasun/contrastFinder/result/ColorCombinaison.java

@@ -31,92 +31,78 @@ public interface ColorCombinaison {
 
 
     /**
-     * 
-     * @return 
+     * @return Gap
      */
     Float getGap();
 
     /**
-     *
-     * @return
+     * @return Color object
      */
     Color getColor();
 
     /**
-     *
      * @param color
      */
     void setColor(Color color);
 
     /**
-     *
-     * @return
+     * @return contrast
      */
     Double getContrast();
 
     /**
-     * 
-     * @param distance 
+     * @param distance from initial color
      */
     void setDistanceFromInitialColor(Double distance);
 
     /**
-     * 
-     * @return 
+     * @return distance
      */
     Double getDistance();
 
     /**
-     * 
-     * @param threshold 
+     * @param threshold
      */
     void setThreshold(Double threshold);
 
     /**
-     * 
-     * @return 
+     * @return threshold
      */
     Double getThreshold();
 
     /**
-     * 
-     * @return 
+     * @return true if is valid contrast
      */
     boolean isContrastValid();
 
     /**
-     *
-     * @return
+     * @return Color object
      */
     Color getComparisonColor();
 
     /**
-     *
      * @param color
      */
     void setComparisonColor(Color color);
 
     /**
-     * 
-     * @param color 
+     * @return color in hexadecimal format, example: #FFFFFF
      */
     String getHexaColor();
 
     /**
      * 
-     * @return 
+     * @return color in HSL format, example: hsl(0, 0%, 100%)
      */
     String getHslColor();
 
     /**
-     * 
-     * @param color 
+     * @return color in hexadecimal format, example: #FFFFFF
      */
     String getHexaColorComp();
 
     /**
-     * 
-     * @return 
+     * @return color in HSL format, example: hsl(0, 0%, 100%)
      */
     String getHslColorComp();
 }