Add format provider that handles multiple sources.

This will allow plugins to supply their own format providers
while still allowing the user to override them using the
main format.yml file.

Issue #622

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

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2006-2015 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 java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Provides formats from multiple other {@link EventFormatProvider}.
+ */
+public class MultiEventFormatProvider implements EventFormatProvider {
+
+    /** Providers to test for formats, in order. */
+    private final List<EventFormatProvider> providers = new ArrayList<>();
+
+    public MultiEventFormatProvider(final EventFormatProvider ... providers) {
+        this.providers.addAll(Arrays.asList(providers));
+    }
+
+    public void addProvider(final EventFormatProvider provider) {
+        providers.add(provider);
+    }
+
+    public void removeProvider(final EventFormatProvider provider) {
+        providers.remove(provider);
+    }
+
+    @Override
+    public Optional<EventFormat> getFormat(final Class<? extends DisplayableEvent> eventType) {
+        return providers.stream()
+                .map(provider -> provider.getFormat(eventType))
+                .filter(Optional::isPresent)
+                .findFirst()
+                .map(Optional::get);
+    }
+
+}

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

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2006-2015 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.ChannelModesDiscoveredEvent;
+
+import java.util.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.assertFalse;
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class MultiEventFormatProviderTest {
+
+    @Mock private EventFormat mockEventFormat1;
+    @Mock private EventFormat mockEventFormat2;
+    @Mock private EventFormatProvider mockEventFormatProvider1;
+    @Mock private EventFormatProvider mockEventFormatProvider2;
+
+    @Before
+    public void setup() {
+        when(mockEventFormatProvider1.getFormat(ChannelModesDiscoveredEvent.class))
+                .thenReturn(Optional.of(mockEventFormat1));
+        when(mockEventFormatProvider2.getFormat(ChannelModesDiscoveredEvent.class))
+                .thenReturn(Optional.of(mockEventFormat2));
+    }
+
+    @Test
+    public void testReturnsEmptyWithNoProviders() {
+        final EventFormatProvider provider = new MultiEventFormatProvider();
+        assertFalse(provider.getFormat(ChannelModesDiscoveredEvent.class).isPresent());
+    }
+
+    @Test
+    public void testReturnsFormatFromProvider() {
+        final EventFormatProvider provider = new MultiEventFormatProvider(mockEventFormatProvider1);
+        final Optional<EventFormat> res = provider.getFormat(ChannelModesDiscoveredEvent.class);
+        assertTrue(res.isPresent());
+        assertSame(mockEventFormat1, res.get());
+    }
+
+    @Test
+    public void testReturnsFormatFromAlternateProvider() {
+        final MultiEventFormatProvider provider =
+                new MultiEventFormatProvider(mockEventFormatProvider1);
+        provider.addProvider(mockEventFormatProvider2);
+
+        final Optional<EventFormat> res = provider.getFormat(ChannelModesDiscoveredEvent.class);
+        assertTrue(res.isPresent());
+        assertSame(mockEventFormat1, res.get());
+    }
+
+    @Test
+    public void testReturnsFirstFormatIfMultipleProvidersHaveFormats() {
+        final MultiEventFormatProvider provider =
+                new MultiEventFormatProvider(mockEventFormatProvider1);
+        provider.addProvider(mockEventFormatProvider2);
+
+        final Optional<EventFormat> res = provider.getFormat(ChannelModesDiscoveredEvent.class);
+        assertTrue(res.isPresent());
+        assertSame(mockEventFormat1, res.get());
+    }
+
+    @Test
+    public void testRemovesProvider() {
+        final MultiEventFormatProvider provider =
+                new MultiEventFormatProvider(mockEventFormatProvider1);
+        provider.addProvider(mockEventFormatProvider2);
+        provider.removeProvider(mockEventFormatProvider1);
+
+        final Optional<EventFormat> res = provider.getFormat(ChannelModesDiscoveredEvent.class);
+        assertTrue(res.isPresent());
+        assertSame(mockEventFormat2, res.get());
+
+        provider.removeProvider(mockEventFormatProvider2);
+        assertFalse(provider.getFormat(ChannelModesDiscoveredEvent.class).isPresent());
+    }
+
+}