Merge pull request #617 from csmith/tidying

Add ugly event-based whois output.

res/com/dmdirc/ui/messages/format.yml

@@ -208,6 +208,12 @@ CommandOutputEvent:
 UnknownCommandEvent:
   format: "Unknown command {{command}}."
   colour: 14
+UserInfoResponseEvent:
+  before: "---------- User info for {{user.nickname}} ----------"
+  after: "--------- End of info for {{user.nickname}} ---------"
+  iterate: "entries"
+  format: "{{key}}: {{value}}"
+  colour: 10
 
 ################## TODO ############################################################################
 #  selfCTCP=4->- [%1$s] %2$s

src/com/dmdirc/events/UserInfoResponseEvent.java

@@ -26,6 +26,7 @@ import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.User;
 import com.dmdirc.parser.events.UserInfoEvent;
 
+import java.util.Collection;
 import java.util.EnumMap;
 import java.util.Map;
 import java.util.Optional;
@@ -33,7 +34,7 @@ import java.util.Optional;
 /**
  * Event raised when detailed user info has been received for a user.
  */
-public class UserInfoResponseEvent extends ServerEvent {
+public class UserInfoResponseEvent extends ServerDisplayableEvent {
 
     private final User user;
     private final Map<UserInfoEvent.UserInfoType, String> info;
@@ -64,4 +65,14 @@ public class UserInfoResponseEvent extends ServerEvent {
     public Optional<String> getInfo(final UserInfoEvent.UserInfoType type) {
         return Optional.ofNullable(info.get(type));
     }
+
+    /**
+     * Gets a collection of all info entries in the response.
+     *
+     * @return A collection of all user info entries.
+     */
+    public Collection<Map.Entry<UserInfoEvent.UserInfoType, String>> getEntries() {
+        return info.entrySet();
+    }
+
 }

src/com/dmdirc/ui/messages/EventFormat.java

@@ -40,6 +40,8 @@ public abstract class EventFormat {
     public abstract Optional<String> getBeforeTemplate();
     /** The template to use after finishing rendering the event. */
     public abstract Optional<String> getAfterTemplate();
+    /** The property that should be iterated over, if the event contains multiple lines. */
+    public abstract Optional<String> getIterateProperty();
 
     // TODO: This should probably be a generic set of properties.
     public abstract Optional<Colour> getDefaultForegroundColour();
@@ -48,8 +50,9 @@ public abstract class EventFormat {
             final String template,
             final Optional<String> beforeTemplate,
             final Optional<String> afterTemplate,
+            final Optional<String> iterateProperty,
             final Optional<Colour> defaultForegroundColour) {
-        return new AutoValue_EventFormat(template, beforeTemplate, afterTemplate,
+        return new AutoValue_EventFormat(template, beforeTemplate, afterTemplate, iterateProperty,
                 defaultForegroundColour);
     }
 

src/com/dmdirc/ui/messages/EventFormatter.java

@@ -65,34 +65,59 @@ public class EventFormatter {
                     .ifPresent(c -> event.setDisplayProperty(DisplayProperty.FOREGROUND_COLOUR, c));
         }
 
-        return format.map(f -> {
-            final StringBuilder builder = getTemplate(f, event);
-            int tagStart = builder.indexOf("{{");
-            while (tagStart > -1) {
-                final int tagEnd = builder.indexOf("}}", tagStart);
-                final String tag = builder.substring(tagStart + 2, tagEnd);
-                final String replacement = getReplacement(event, tag);
-                builder.replace(tagStart, tagEnd + 2, replacement);
-                tagStart = builder.indexOf("{{", tagStart + replacement.length());
-            }
-
-            return builder.toString();
-        });
+        return format.map(f -> format(f, event));
     }
 
-    private StringBuilder getTemplate(final EventFormat format, final DisplayableEvent event) {
+    private String format(final EventFormat format, final DisplayableEvent event) {
         final StringBuilder builder = new StringBuilder();
-        format.getBeforeTemplate().ifPresent(before -> builder.append(before).append('\n'));
-        builder.append(format.getTemplate());
-        format.getAfterTemplate().ifPresent(after -> builder.append('\n').append(after));
-        return builder;
+        format.getBeforeTemplate().ifPresent(
+                before -> builder.append(doSubstitutions(event, before)).append('\n'));
+        builder.append(
+                format.getIterateProperty()
+                        .map(iterate -> formatIterable(event, iterate, format.getTemplate()))
+                        .orElseGet(() -> doSubstitutions(event, format.getTemplate())));
+        format.getAfterTemplate().ifPresent(
+                after -> builder.append('\n').append(doSubstitutions(event, after)));
+        return builder.toString();
+    }
+
+    private String doSubstitutions(final Object dataSource, final String line) {
+        final StringBuilder builder = new StringBuilder(line);
+        int tagStart = builder.indexOf("{{");
+        while (tagStart > -1) {
+            final int tagEnd = builder.indexOf("}}", tagStart);
+            final String tag = builder.substring(tagStart + 2, tagEnd);
+            final String replacement = getReplacement(dataSource, tag);
+            builder.replace(tagStart, tagEnd + 2, replacement);
+            tagStart = builder.indexOf("{{", tagStart + replacement.length());
+        }
+        return builder.toString();
+    }
+
+    private String formatIterable(final DisplayableEvent event, final String property,
+            final String template) {
+        final Optional<Object> value
+                = propertyManager.getProperty(event, event.getClass(), property);
+        if (!value.isPresent() || !(value.get() instanceof Iterable<?>)) {
+            return ERROR_STRING;
+        }
+        @SuppressWarnings("unchecked")
+        final Iterable<Object> collection = (Iterable<Object>) value.get();
+        final StringBuilder res = new StringBuilder();
+        for (Object line : collection) {
+            if (res.length() > 0) {
+                res.append('\n');
+            }
+            res.append(doSubstitutions(line, template));
+        }
+        return res.toString();
     }
 
-    private String getReplacement(final DisplayableEvent event, final String tag) {
+    private String getReplacement(final Object dataSource, final String tag) {
         final String[] functionParts = tag.split("\\|");
         final String[] dataParts = functionParts[0].split("\\.");
 
-        Object target = event;
+        Object target = dataSource;
         for (String part : dataParts) {
             final Optional<Object> result =
                     propertyManager.getProperty(target, target.getClass(), part);

src/com/dmdirc/ui/messages/YamlEventFormatProvider.java

@@ -99,11 +99,15 @@ public class YamlEventFormatProvider implements EventFormatProvider {
         final Optional<String> afterTemplate = info.containsKey("after")
                 ? Optional.of(info.get("after").toString())
                 : Optional.empty();
+        final Optional<String> iterateProperty = info.containsKey("iterate")
+                ? Optional.of(info.get("iterate").toString())
+                : Optional.empty();
         final Optional<Colour> foregroundColour = info.containsKey("colour")
                 ? Optional.of(colourManager.getColourFromIrcCode(
                         Integer.parseInt(info.get("colour").toString())))
                 : Optional.empty();
-        return EventFormat.create(template, beforeTemplate, afterTemplate, foregroundColour);
+        return EventFormat.create(
+                template, beforeTemplate, afterTemplate, iterateProperty, foregroundColour);
     }
 
     @Override

test/com/dmdirc/ui/messages/EventFormatterTest.java

@@ -60,6 +60,7 @@ public class EventFormatterTest {
                                 "Template {{channel}} meep",
                                 Optional.empty(),
                                 Optional.empty(),
+                                Optional.empty(),
                                 Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
                 .thenReturn(Optional.of("MONKEY"));
@@ -77,6 +78,7 @@ public class EventFormatterTest {
                                 "Template {{channel}} meep",
                                 Optional.of("Before!"),
                                 Optional.of("After!"),
+                                Optional.empty(),
                                 Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
                 .thenReturn(Optional.of("MONKEY"));
@@ -96,6 +98,7 @@ public class EventFormatterTest {
                                 "Template {{channel|lowercase}} meep",
                                 Optional.empty(),
                                 Optional.empty(),
+                                Optional.empty(),
                                 Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
                 .thenReturn(Optional.of("MONKEY"));
@@ -114,6 +117,7 @@ public class EventFormatterTest {
                                 "Template {{message}} meep",
                                 Optional.empty(),
                                 Optional.empty(),
+                                Optional.empty(),
                                 Optional.empty())));
         when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "message"))
                 .thenReturn(Optional.of("{{channel}}"));