Initial work on EventFormatters.

These will be used to format events for displaying in a window.

Change-Id: I30381c2adc7bd77de486d6c0410a0a6395a7ea8d
Reviewed-on: http://gerrit.dmdirc.com/3835
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

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

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.events.DisplayableEvent;
+
+import com.google.common.base.Optional;
+
+/**
+ * Formats an event into a text string, based on a user-defined template.
+ *
+ * <p>Template tags start with <code>{{</code> and end with <code>}}</code>. The start of the
+ * tag should be the property of the event that will be displayed. Properties can be chained using
+ * a <code>.</code> character, e.g. <code>{{user.hostname}}</code>. One or more functions can
+ * be applied to the result of this, to change the appearance of the output. Functions are
+ * separated from their argument with a <code>|</code> character,
+ * e.g. <code>{{user.hostname|toCapitals}}</code>.
+ *
+ * <p>Properties and functions are case-insensitive.
+ */
+public class EventFormatter {
+
+    private final EventPropertyManager propertyManager;
+    private final EventTemplateProvider templateProvider;
+
+    public EventFormatter(final EventPropertyManager propertyManager,
+            final EventTemplateProvider templateProvider) {
+        this.propertyManager = propertyManager;
+        this.templateProvider = templateProvider;
+    }
+
+    public Optional<String> format(final DisplayableEvent event) {
+        final Optional<String> template = templateProvider.getTemplate(event.getClass());
+
+        if (template.isPresent()) {
+            final StringBuilder builder = new StringBuilder(template.get());
+            int tagStart = builder.indexOf("{{");
+            while (tagStart > -1) {
+                final int tagEnd = builder.indexOf("}}", tagStart);
+                final String tag = builder.substring(tagStart + 2, tagEnd);
+                builder.replace(tagStart, tagEnd + 2, getReplacement(event, tag));
+                tagStart = builder.indexOf("{{");
+            }
+            return Optional.fromNullable(builder.toString());
+        }
+
+        return Optional.absent();
+    }
+
+    private String getReplacement(final DisplayableEvent event, final String tag) {
+        final String[] functionParts = tag.split("\\|");
+        final String[] dataParts = functionParts[0].split("\\.");
+
+        Object target = event;
+        for (String part : dataParts) {
+            target = propertyManager.getProperty(target, target.getClass(), part);
+        }
+
+        String value = target.toString();
+        for (int i = 1; i < functionParts.length; i++) {
+            value = propertyManager.applyFunction(value, functionParts[i]);
+        }
+
+        return value;
+    }
+
+}

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+public class EventPropertyManager {
+
+    public <S, T> T getProperty(final S object, final Class<? extends S> type,
+            final String property) {
+        return null;
+    }
+
+    public String applyFunction(final String input, final String property) {
+        return null;
+    }
+
+}

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

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.events.DisplayableEvent;
+
+import com.google.common.base.Optional;
+
+/**
+ * Provides templates to be used for displayable events.
+ */
+public interface EventTemplateProvider {
+
+    /**
+     * Gets the template to be used, if any, for the given event type.
+     *
+     * @param eventType The type of event to retrieve a template for.
+     * @return The template to use, or an absent optional if no template is defined.
+     */
+    Optional<String> getTemplate(final Class<? extends DisplayableEvent> eventType);
+
+}

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

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.messages;
+
+import com.dmdirc.Channel;
+import com.dmdirc.events.ChannelMessageEvent;
+
+import com.google.common.base.Optional;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class EventFormatterTest {
+
+    @Mock private EventPropertyManager propertyManager;
+    @Mock private EventTemplateProvider templateProvider;
+    @Mock private Channel channel;
+    private ChannelMessageEvent messageEvent;
+    private EventFormatter formatter;
+
+    @Before
+    public void setup() {
+        formatter = new EventFormatter(propertyManager, templateProvider);
+        messageEvent = new ChannelMessageEvent(channel, null, null);
+
+        when(templateProvider.getTemplate(ChannelMessageEvent.class))
+                .thenReturn(Optional.fromNullable("Template {{channel}} meep"));
+        when(propertyManager.getProperty(messageEvent, ChannelMessageEvent.class, "channel"))
+                .thenReturn("MONKEY");
+    }
+
+    @Test
+    public void testBasicFormat() {
+        assertEquals("Template MONKEY meep", formatter.format(messageEvent).orNull());
+    }
+
+}