Reorganized code

Author: Artem Labazin

.codestyle/checkstyle.xml

@@ -71,7 +71,7 @@ limitations under the License.
 
     <!-- Checks for Javadoc comments.                     -->
     <!-- See http://checkstyle.sf.net/config_javadoc.html -->
-    <!-- <module name="JavadocMethod">
+    <module name="JavadocMethod">
       <property name="scope" value="protected"/>
       <property name="allowedAnnotations" value="Override, Test"/>
       <property name="allowThrowsTagsForSubclasses" value="true"/>
@@ -98,7 +98,7 @@ limitations under the License.
       <property name="tagOrder" value="@param, @return, @throws, @see, @since, @author, @version, @deprecated"/>
       <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
     </module>
-    <module name="NonEmptyAtclauseDescription"/> -->
+    <module name="NonEmptyAtclauseDescription"/>
 
 
     <!-- Checks for Naming Conventions.                  -->

.images/example.png

@@ -11,6 +11,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Add different logging frameworks.
 
+## [1.1.0](https://github.com/appulse-projects/logging-java/releases/tag/1.1.0) - 2018-06-05
+
+Reorganized code.
+
+### Added
+
+- JavaDoc comments.
+- Default `logback.xml` configuration (just includes `default.xml` config).
+
+### Removed
+
+- `AnsiBackground`.
+- `LogbackConfigurator`.
+- `AnsiOutputEnabledValue`.
+
 ## [1.0.2](https://github.com/appulse-projects/logging-java/releases/tag/1.0.2) - 2018-03-15
 
 Small refactoring

.images/override_example.png

@@ -17,7 +17,7 @@ Just add dependency to your project.
     <dependency>
         <groupId>io.appulse</groupId>
         <artifactId>logging-java</artifactId>
-        <version>1.0.2</version>
+        <version>1.1.0</version>
     </dependency>
     ...
 </dependencies>
@@ -26,9 +26,68 @@ Just add dependency to your project.
 **Gradle**:
 
 ```groovy
-compile 'io.appulse:logging-java:1.0.2'
+compile 'io.appulse:logging-java:1.1.0'
 ```
 
+And use it as usual:
+
+```java
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SomeClass {
+
+  Logger log = LoggerFactory.getLogger(SomeClass.class);
+
+  public void doSomeLog () {
+    log.info("info message");
+    log.warn("warn message");
+    log.error("error message");
+  }
+}
+```
+
+or, if you use a Lombok Project:
+
+```java
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class SomeClass {
+
+  public void doSomeLog () {
+    log.info("info message");
+    log.warn("warn message");
+    log.error("error message");
+  }
+}
+```
+
+With default configuration (no `logback.xml` in classpath at all) it looks like:
+
+![override example](https://github.com/appulse-projects/logging-java/blob/master/.images/override_example.png?raw=true)
+
+You also could to override default `logback`'s configuration, like an example below.
+
+**resources/logback.xml**:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+
+<configuration>
+  <property
+    name="CONSOLE_LOG_PATTERN"
+    value="${CONSOLE_LOG_PATTERN:-%clr(${LOG_LEVEL_PATTERN:-%5p}) %clr([%25.25thread]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"
+  />
+
+  <include resource="io/appulse/logging/logback/base.xml"/>
+</configuration>
+```
+
+And output will be like:
+
+![override example](https://github.com/appulse-projects/logging-java/blob/master/.images/override_example.png?raw=true)
+
 ## Development
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

CHANGELOG.md

@@ -24,7 +24,7 @@ limitations under the License.
 
   <groupId>io.appulse</groupId>
   <artifactId>logging-java</artifactId>
-  <version>1.0.2</version>
+  <version>1.1.0</version>
   <packaging>jar</packaging>
 
   <properties>
@@ -62,7 +62,7 @@ limitations under the License.
     <url>https://github.com/appulse-projects/logging-java</url>
     <connection>scm:git:https://github.com/appulse-projects/logging-java.git</connection>
     <developerConnection>scm:git:https://github.com/appulse-projects/logging-java.git</developerConnection>
-    <tag>1.0.2</tag>
+    <tag>1.1.0</tag>
   </scm>
 
   <distributionManagement>
@@ -98,7 +98,7 @@ limitations under the License.
     <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
-      <version>1.16.20</version>
+      <version>1.18.0</version>
       <scope>provided</scope>
     </dependency>
 
@@ -130,7 +130,7 @@ limitations under the License.
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
-      <version>3.9.1</version>
+      <version>3.10.0</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -273,7 +273,7 @@ limitations under the License.
           <dependency>
             <groupId>com.puppycrawl.tools</groupId>
             <artifactId>checkstyle</artifactId>
-            <version>8.8</version>
+            <version>8.10.1</version>
           </dependency>
         </dependencies>
         <executions>

README.md

@@ -16,40 +16,112 @@
 
 package io.appulse.logging;
 
+import static lombok.AccessLevel.PRIVATE;
+
+import lombok.experimental.FieldDefaults;
+
 /**
  * {@link AnsiElement Ansi} colors.
  *
  * @author Artem Labazin
  * @since 1.0.0
  */
+@FieldDefaults(level = PRIVATE, makeFinal = true)
 public enum AnsiColor implements AnsiElement {
 
+  /**
+   * System default ANSI color.
+   */
   DEFAULT("39"),
+
+  /**
+   * Black ANSI color.
+   */
   BLACK("30"),
+
+  /**
+   * Red ANSI color.
+   */
   RED("31"),
+
+  /**
+   * Green ANSI color.
+   */
   GREEN("32"),
+
+  /**
+   * Yellow ANSI color.
+   */
   YELLOW("33"),
+
+  /**
+   * Blue ANSI color.
+   */
   BLUE("34"),
+
+  /**
+   * Magenta ANSI color.
+   */
   MAGENTA("35"),
+
+  /**
+   * Cyan ANSI color.
+   */
   CYAN("36"),
+
+  /**
+   * White ANSI color.
+   */
   WHITE("37"),
+
+  /**
+   * High bntensty black ANSI color.
+   */
   BRIGHT_BLACK("90"),
+
+  /**
+   * High bntensty red ANSI color.
+   */
   BRIGHT_RED("91"),
+
+  /**
+   * High bntensty green ANSI color.
+   */
   BRIGHT_GREEN("92"),
+
+  /**
+   * High bntensty yellow ANSI color.
+   */
   BRIGHT_YELLOW("93"),
+
+  /**
+   * High bntensty blue ANSI color.
+   */
   BRIGHT_BLUE("94"),
+
+  /**
+   * High bntensty magenta ANSI color.
+   */
   BRIGHT_MAGENTA("95"),
+
+  /**
+   * High bntensty cyan ANSI color.
+   */
   BRIGHT_CYAN("96"),
+
+  /**
+   * High bntensty white ANSI color.
+   */
   BRIGHT_WHITE("97");
 
-  private final String code;
+  String code;
 
   AnsiColor (String code) {
     this.code = code;
   }
 
   @Override
   public String toString () {
-    return this.code;
+    return code;
   }
 }

pom.xml

@@ -45,10 +45,10 @@
 /**
  * Utility for working with {@link AnsiColor} in the context of {@link Color AWT Colors}.
  *
- * @author Artem Labazin
  * @since 1.0.0
+ * @author Artem Labazin
  */
-public final class AnsiColors {
+final class AnsiColors {
 
   private static final Map<AnsiColor, LabColor> ANSI_COLOR_MAP;
 
@@ -75,7 +75,7 @@ public final class AnsiColors {
   private AnsiColors () {
   }
 
-  public static AnsiColor getClosest (Color color) {
+  static AnsiColor getClosest (Color color) {
     return getClosest(new LabColor(color));
   }
 

src/main/java/io/appulse/logging/AnsiBackground.java

@@ -19,12 +19,15 @@
 /**
  * An ANSI encodable element.
  *
- * @author Artem Labazin
  * @since 1.0.0
+ * @author Artem Labazin
  */
 public interface AnsiElement {
 
   /**
+   * Overrides default {@code toString()} method for {@link AnsiElement} instances,
+   * which should returns element's code.
+   *
    * @return the ANSI escape code
    */
   @Override