From ebcf0b6132c6397d2e9d08ab01a61e030d3c13f7 Mon Sep 17 00:00:00 2001
From: Ronald Jack Jenkins Jr <me@ronjenkins.info>
Date: Tue, 8 Aug 2017 20:06:17 -0400
Subject: [PATCH] Improve comments/strip ChatColors

---
 pom.xml                                       |  2 +-
 .../slf4bukkit/AnsiColorMapper.java           | 22 ++++---------
 .../ronjenkins/slf4bukkit/ColorMapper.java    | 10 +++---
 .../slf4bukkit/ColorMapperFactory.java        | 23 +++++++++++--
 .../slf4bukkit/NotSupportedColorMapper.java   | 32 +++++++++++++++++--
 .../org/slf4j/impl/BukkitLoggerAdapter.java   | 10 +++++-
 6 files changed, 73 insertions(+), 26 deletions(-)

diff --git a/pom.xml b/pom.xml
index 4d95eff..456c8d5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  Copyright (C) 2016 Ronald Jack Jenkins Jr.
+  Copyright (C) 2016-2017 Ronald Jack Jenkins Jr., SLF4Bukkit contributors.
 
   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
diff --git a/src/main/java/info/ronjenkins/slf4bukkit/AnsiColorMapper.java b/src/main/java/info/ronjenkins/slf4bukkit/AnsiColorMapper.java
index b6a50eb..c94932a 100644
--- a/src/main/java/info/ronjenkins/slf4bukkit/AnsiColorMapper.java
+++ b/src/main/java/info/ronjenkins/slf4bukkit/AnsiColorMapper.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016 Ronald Jack Jenkins Jr.
+ * Copyright (C) 2016-2017 Ronald Jack Jenkins Jr., SLF4Bukkit contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,28 +25,20 @@ import org.fusesource.jansi.Ansi.Attribute;
 import java.util.Map;
 
 /**
- * Maps {@link ChatColor} values to their Jansi equivalents.
- *
- * <p>This class might not always be instantiable as Jansi might not be present at runtime.</p>
+ * Maps {@link ChatColor} values to their JAnsi equivalents.
  *
  * @author Ronald Jack Jenkins Jr.
  */
 final class AnsiColorMapper implements ColorMapper {
 
   /**
-   * Creates a new instance.
+   * No-op constructor. Callers must catch {@code Throwable} and handle the
+   * scenario in which JAnsi is not available by substituting another
+   * {@link ColorMapper} implementation.
    *
-   * <p>This class relies on Jansi. If this dependency is not present at runtime, it cannot be initialized as the JVM
-   * raises a {@code Throwable} due to missing dependencies.</p>
-   *
-   * <p>In this case callers of this constructor should fall back to an alternative {@code ColorMapper}
-   * implementation.</p>
-   *
-   * @throws Throwable if Jansi is not present at runtime
+   * @throws Throwable if JAnsi is not present at runtime.
    */
-  AnsiColorMapper() throws Throwable {
-    //see javadoc
-  }
+  AnsiColorMapper() throws Throwable {}
 
   // @formatter:off
   private final Map<ChatColor, String> MAP = ImmutableMap.<ChatColor, String>builder()
diff --git a/src/main/java/info/ronjenkins/slf4bukkit/ColorMapper.java b/src/main/java/info/ronjenkins/slf4bukkit/ColorMapper.java
index bafaccb..ec10b8e 100644
--- a/src/main/java/info/ronjenkins/slf4bukkit/ColorMapper.java
+++ b/src/main/java/info/ronjenkins/slf4bukkit/ColorMapper.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016 Ronald Jack Jenkins Jr.
+ * Copyright (C) 2016-2017 Ronald Jack Jenkins Jr., SLF4Bukkit contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,13 +19,15 @@ package info.ronjenkins.slf4bukkit;
 import org.bukkit.ChatColor;
 
 /**
- * Utility class that maps {@link ChatColor} values to their equivalents,
- * so that messages logged to the console are formatted correctly.
+ * Implementations of this interface map {@link ChatColor} values to their
+ * equivalents, based on what the current Bukkit implementation supports.
+ *
+ * @author Ronald Jack Jenkins Jr.
  */
 public interface ColorMapper {
 
   /**
-   * Translates {@link ChatColor} directives to their equivalents.
+   * Translates {@link ChatColor} directives to their string equivalents.
    *
    * @param input
    *          null is coerced to the empty string.
diff --git a/src/main/java/info/ronjenkins/slf4bukkit/ColorMapperFactory.java b/src/main/java/info/ronjenkins/slf4bukkit/ColorMapperFactory.java
index 67a0c58..7e9d201 100644
--- a/src/main/java/info/ronjenkins/slf4bukkit/ColorMapperFactory.java
+++ b/src/main/java/info/ronjenkins/slf4bukkit/ColorMapperFactory.java
@@ -1,16 +1,33 @@
+/*
+ * Copyright (C) 2017 TheE, Ronald Jack Jenkins Jr, SLF4Bukkit contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package info.ronjenkins.slf4bukkit;
 
 /**
- * Creates {@code ColorMapper} instances.
+ * Creates the {@link ColorMapper} instance that best suits the capabilities of
+ * the current Bukkit environment.
  *
- * @see ColorMapper
+ * @author TheE
  */
 public final class ColorMapperFactory {
 
   /**
    * Creates an new {@code ColorMapper} instance.
    *
-   * @return a new instance
+   * @return never null.
    */
   public static ColorMapper create() {
     try {
diff --git a/src/main/java/info/ronjenkins/slf4bukkit/NotSupportedColorMapper.java b/src/main/java/info/ronjenkins/slf4bukkit/NotSupportedColorMapper.java
index d67fda4..2f3c67c 100644
--- a/src/main/java/info/ronjenkins/slf4bukkit/NotSupportedColorMapper.java
+++ b/src/main/java/info/ronjenkins/slf4bukkit/NotSupportedColorMapper.java
@@ -1,12 +1,40 @@
+/*
+ * Copyright (C) 2017 TheE, Ronald Jack Jenkins Jr, SLF4Bukkit contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package info.ronjenkins.slf4bukkit;
 
+import org.bukkit.ChatColor;
+
 /**
- * Does not do any mapping but simply returns the given string or, if {@code null} is given, an empty string.
+ * Strips all {@link ChatColor}s from the input string.
+ *
+ * @author TheE
  */
 final class NotSupportedColorMapper implements ColorMapper {
 
   @Override
   public String map(final String input) {
-    return input == null ? "" : input;
+    if (input == null) {
+      return "";
+    }
+    String output = input;
+    for (final ChatColor chatColor : ChatColor.values()) {
+      output = output.replace(chatColor.toString(), "");
+    }
+    return output;
   }
+
 }
diff --git a/src/main/java/org/slf4j/impl/BukkitLoggerAdapter.java b/src/main/java/org/slf4j/impl/BukkitLoggerAdapter.java
index 1e53511..21f605e 100644
--- a/src/main/java/org/slf4j/impl/BukkitLoggerAdapter.java
+++ b/src/main/java/org/slf4j/impl/BukkitLoggerAdapter.java
@@ -4,7 +4,7 @@
  */
 /*
  * Portions of this file are
- * Copyright (C) 2016 Ronald Jack Jenkins Jr.
+ * Copyright (C) 2016-2017 Ronald Jack Jenkins Jr., SLF4Bukkit contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -181,6 +181,14 @@ import com.google.common.collect.ImmutableMap;
  * of markers does not affect whether or not a given logging level is enabled.
  * </p>
  *
+ * <p>
+ * When executed on a Bukkit implementation that does not contain the JAnsi
+ * library (e.g. PaperSpigot), all color-related functionality is silently
+ * ignored. Any messages logged in such an environment by SLF4Bukkit will have
+ * any {@link ChatColor} values stripped. SLF4Bukkit does not emit any warnings
+ * when executed in an environment where JAnsi is not available.
+ * </p>
+ *
  * @author Ceki G&uuml;lc&uuml;
  * @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
  * @author Rod Waldhoff