Improve module errors, and add ModuleReporter

Author: Pablete1234

build.gradle

@@ -37,6 +37,7 @@ dependencies {
     compile 'ee.ellytr.command:EllyCommand:2.0.4'
     compile 'ee.ellytr.chat:EllyChat:1.2.6'
     compile 'org.jdom:jdom2:2.0.6'
+    compile 'org.jdom:jdom2-contrib:2.0.5'
     compile 'org.ow2.asm:asm-all:5.0.4'
 
     testCompile('junit:junit:4.12')
@@ -57,6 +58,7 @@ shadowJar {
     append('LICENSE')
     dependencies {
         include(dependency('org.jdom:jdom2:2.0.6'))
+        include(dependency('org.jdom:jdom2-contrib:2.0.5'))
         relocate 'org.jdom2', 'in.twizmwaz.cardinal.libs.jdom2'
         include(dependency('org.ow2.asm:asm-all:5.0.4'))
         relocate 'org.objectweb.asm', 'in.twizmwaz.cardinal.libs.asm'

gradle/wrapper/gradle-wrapper.properties

@@ -1,4 +1,4 @@
-#Tue Apr 26 23:37:45 EDT 2016
+#Thu Sep 22 02:07:06 CEST 2016
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

src/main/java/in/twizmwaz/cardinal/module/ModuleError.java

@@ -26,14 +26,46 @@
 package in.twizmwaz.cardinal.module;
 
 import in.twizmwaz.cardinal.module.repository.LoadedMap;
+import lombok.AllArgsConstructor;
 import lombok.Data;
+import org.jdom2.Attribute;
+import org.jdom2.Element;
+import org.jdom2.contrib.input.LineNumberElement;
 
 @Data
+@AllArgsConstructor
 public final class ModuleError {
 
   private final Module module;
   private final LoadedMap map;
   private final String[] message;
   private final boolean critical;
 
+  public ModuleError(Module module, LoadedMap map, boolean critical, String... message) {
+    this(module, map, message, critical);
+  }
+
+  public ModuleError(Module module, LoadedMap map, Element element, String message, boolean critical) {
+    this(module, map, critical, getErrorLocation(element), message);
+  }
+
+  public ModuleError(Module module, LoadedMap map, Attribute attr, String message, boolean critical) {
+    this(module, map, critical, getErrorLocation(attr), message);
+  }
+
+  private static String getErrorLocation(Element element) {
+    String result = "'" + element.getName() + "' element";
+    if (element instanceof LineNumberElement) {
+      LineNumberElement lineElement = (LineNumberElement) element;
+      result += lineElement.getStartLine() == lineElement.getEndLine()
+          ? " on line " + lineElement.getStartLine()
+          : " from line " + lineElement.getStartLine() + " to " + lineElement.getEndLine();
+    }
+    return result;
+  }
+
+  private static String getErrorLocation(Attribute attribute) {
+    return "'" + attribute.getName() + "' attribute in " + getErrorLocation(attribute.getParent());
+  }
+
 }

src/main/java/in/twizmwaz/cardinal/module/ModuleReporter.java

@@ -0,0 +1,55 @@
+package in.twizmwaz.cardinal.module;
+
+import in.twizmwaz.cardinal.module.repository.LoadedMap;
+import in.twizmwaz.cardinal.util.document.XML;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.jdom2.Attribute;
+import org.jdom2.Element;
+
+@RequiredArgsConstructor
+public class ModuleReporter {
+
+  private final Module module;
+  private final LoadedMap map;
+
+  @Getter
+  private boolean canLoad = false;
+
+  public void reset() {
+    canLoad = true;
+  }
+
+  /**
+   * Gets an attribute value from an element.
+   * @param element The element to get the attribute from.
+   * @param attr The attribute to get.
+   * @param type The class of the type to convert the string to.
+   * @param required If this is required for the module to load, if true, null is not a valid return, and an error will
+   *                 be thrown.
+   * @param <T> The type to convert the attribute value to.
+   * @return An object of the correct type, or null if argument is missing or invalid.
+   */
+  public <T> T getAttr(Element element, String attr, Class<T> type, boolean required) {
+    Attribute attribute = element.getAttribute(attr);
+    if (required && attribute == null) {
+      module.getErrors().add(new ModuleError(module, map, element, "Missing required attribute:'" + attr + "'", false));
+      return null;
+    }
+    T result = getAttribute(attribute, type);
+    if (required && result == null) {
+      canLoad = false;
+    }
+    return result;
+  }
+
+  private <T> T getAttribute(Attribute attr, Class<T> type) {
+    try {
+      return XML.getAttr(attr, type);
+    } catch (Exception e) {
+      module.getErrors().add(new ModuleError(module, map, attr, e.getMessage(), false));
+    }
+    return null;
+  }
+
+}

src/main/java/in/twizmwaz/cardinal/module/objective/wool/WoolModule.java

@@ -64,10 +64,6 @@
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
-import org.bukkit.event.block.BlockBreakEvent;
-import org.bukkit.event.block.BlockFormEvent;
-import org.bukkit.event.block.BlockPistonExtendEvent;
-import org.bukkit.event.block.BlockPistonRetractEvent;
 import org.bukkit.event.block.BlockPlaceEvent;
 import org.bukkit.event.entity.PlayerDeathEvent;
 import org.bukkit.event.inventory.CraftItemEvent;

src/main/java/in/twizmwaz/cardinal/util/document/XML.java

@@ -0,0 +1,63 @@
+package in.twizmwaz.cardinal.util.document;
+
+import com.google.common.collect.Maps;
+import com.google.common.collect.ObjectArrays;
+import in.twizmwaz.cardinal.util.Numbers;
+import in.twizmwaz.cardinal.util.Strings;
+import lombok.NonNull;
+import org.bukkit.DyeColor;
+import org.jdom2.Attribute;
+import org.jdom2.Element;
+
+import java.util.Map;
+import java.util.function.Function;
+
+public class XML {
+
+  private static Map<Class, Function<String, ?>> stringProviders = Maps.newHashMap();
+  private static Map<Class, Function<Element, ?>> elementProviders = Maps.newHashMap();
+
+  static {
+    stringProviders.put(String.class, (String in) -> in);
+    stringProviders.put(Integer.class, Numbers::parseInteger);
+    stringProviders.put(Double.class, Numbers::parseDouble);
+    stringProviders.put(DyeColor.class, (String in) -> DyeColor.valueOf(Strings.getTechnicalName(in)));
+
+    elementProviders.put(String.class, Element::getText);
+  }
+
+
+  /**
+   * Gets an object from an attribute.
+   * @param attr The attribute name.
+   * @param type The class you want.
+   * @param <T> The type.
+   * @return An object of that type if possible, null otherwise.
+   */
+  public static <T> T getAttr(@NonNull Attribute attr, Class<T> type) throws Exception {
+    return getFromString(attr.getValue(), type);
+  }
+
+  /**
+   * Gets an object from an attribute.
+   * @param el The Element name.
+   * @param type The class you want.
+   * @param <T> The type.
+   * @return An object of that type if possible, null otherwise.
+   */
+  public static <T> T getElement(@NonNull Element el, Class<T> type) throws Exception {
+    return getFromString(el.getText(), type);
+  }
+
+  @SuppressWarnings("unchecked")
+  public static <T> T getFromString(String in, Class<T> type) {
+    if (in == null) {
+      return null;
+    }
+    if (XML.stringProviders.containsKey(type)) {
+      return (T) XML.stringProviders.get(type).apply(in);
+    }
+    throw new IllegalStateException("Missing ObjectProvider for class: " + type.getName());
+  }
+
+}