Add ISUPPORT MAXLIST

Author: mbax

src/main/java/org/kitteh/irc/client/library/defaults/element/isupport/DefaultISupportMaxList.java

@@ -0,0 +1,106 @@
+/*
+ * * Copyright (C) 2013-2019 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.defaults.element.isupport;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.ISupportParameter;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.Set;
+
+/**
+ * Default implementation of {@link CaseMapping}.
+ */
+public class DefaultISupportMaxList extends DefaultISupportParameterValueRequired implements ISupportParameter.MaxList {
+    /**
+     * Default implementation of {@link MaxList.LimitData}.
+     */
+    public class DefaultLimitData implements MaxList.LimitData {
+        private final int limit;
+        private final Set<Character> modes;
+
+        /**
+         * Constructs this limit data.
+         *
+         * @param modes modes
+         * @param limit limit
+         */
+        public DefaultLimitData(@NonNull Set<Character> modes, int limit) {
+            this.limit = limit;
+            this.modes = Collections.unmodifiableSet(modes);
+        }
+
+        @Override
+        public int getLimit() {
+            return this.limit;
+        }
+
+        @Override
+        public @NonNull Set<Character> getModes() {
+            return this.modes;
+        }
+    }
+
+    private final Set<MaxList.LimitData> data;
+
+    /**
+     * Constructs the object.
+     *
+     * @param client client
+     * @param name parameter name
+     * @param value parameter value, if present
+     */
+    public DefaultISupportMaxList(@NonNull Client client, @NonNull String name, @Nullable String value) {
+        super(client, name, value);
+        Set<MaxList.LimitData> limitData = new HashSet<>();
+        for (String limit : value.split(",")) {
+            String[] split = limit.split(":");
+            Set<Character> modes = new HashSet<>();
+            for (char c : split[0].toCharArray()) {
+                modes.add(c);
+            }
+            limitData.add(new DefaultLimitData(modes, Integer.parseInt(split[1])));
+        }
+        this.data = Collections.unmodifiableSet(limitData);
+    }
+
+    @Override
+    public @NonNull Set<LimitData> getAllLimitData() {
+        return this.data;
+    }
+
+    @Override
+    public int getLimit(char c) {
+        return this.data.stream().filter(d -> d.getModes().contains(c)).mapToInt(LimitData::getLimit).findFirst().orElse(-1);
+    }
+
+    @Override
+    public @NonNull Optional<LimitData> getLimitData(char c) {
+        return this.data.stream().filter(d -> d.getModes().contains(c)).findFirst();
+    }
+}

src/main/java/org/kitteh/irc/client/library/defaults/feature/DefaultISupportManager.java

@@ -39,6 +39,7 @@
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportHostLen;
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportInvEx;
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportKickLen;
+import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportMaxList;
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportMaxTargets;
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportModes;
 import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportNetwork;
@@ -80,6 +81,7 @@ public DefaultISupportManager(Client.WithManagement client) {
         this.registerParameter(ISupportParameter.HostLen.NAME, DefaultISupportHostLen::new);
         this.registerParameter(ISupportParameter.InvEx.NAME, DefaultISupportInvEx::new);
         this.registerParameter(ISupportParameter.KickLen.NAME, DefaultISupportKickLen::new);
+        this.registerParameter(ISupportParameter.MaxList.NAME, DefaultISupportMaxList::new);
         this.registerParameter(ISupportParameter.MaxTargets.NAME, DefaultISupportMaxTargets::new);
         this.registerParameter(ISupportParameter.Modes.NAME, DefaultISupportModes::new);
         this.registerParameter(ISupportParameter.Network.NAME, DefaultISupportNetwork::new);

src/main/java/org/kitteh/irc/client/library/element/ISupportParameter.java

@@ -242,6 +242,58 @@ interface InvEx extends ISupportParameter {
         String NAME = "INVEX";
     }
 
+    /**
+     * Represents maximum list sizes for type A modes.
+     */
+    interface MaxList extends ISupportParameter {
+        /**
+         * Data on a particular limit.
+         */
+        interface LimitData {
+            /**
+             * Gets the limit for this data.
+             *
+             * @return limit
+             */
+            int getLimit();
+
+            /**
+             * Gets the modes for this data.
+             *
+             * @return modes
+             */
+            @NonNull Set<Character> getModes();
+        }
+
+        /**
+         * Parameter name.
+         */
+        String NAME = "MAXLIST";
+
+        /**
+         * Gets all the limit data specified.
+         *
+         * @return collection of limit data
+         */
+        @NonNull Set<LimitData> getAllLimitData();
+
+        /**
+         * Gets the maximum limit for a given mode.
+         *
+         * @param c mode character
+         * @return limit or -1 if not specified
+         */
+        int getLimit(char c);
+
+        /**
+         * Gets the limit data for a given mode.
+         *
+         * @param c mode character
+         * @return limit data if specified
+         */
+        @NonNull Optional<LimitData> getLimitData(char c);
+    }
+
     /**
      * Represents limits to type A mode lists.
      */

src/test/java/org/kitteh/irc/client/library/defaults/feature/isupport/MaxListTest.java

@@ -0,0 +1,45 @@
+package org.kitteh.irc.client.library.defaults.feature.isupport;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.defaults.element.isupport.DefaultISupportMaxList;
+import org.kitteh.irc.client.library.element.ISupportParameter;
+import org.mockito.Mockito;
+
+import java.util.Optional;
+
+public class MaxListTest {
+    @Test
+    public void testMaxList() {
+        ISupportParameter.MaxList maxList = new DefaultISupportMaxList(Mockito.mock(Client.class), "MAXLIST", "b:60,e:60,I:60");
+        Assert.assertEquals("b should be 60", 60, maxList.getLimit('b'));
+        Assert.assertEquals("q should be -1", -1, maxList.getLimit('q'));
+        Assert.assertEquals("e should be 60", 60, maxList.getLimit('e'));
+        Assert.assertEquals("I should be 60", 60, maxList.getLimit('I'));
+        Assert.assertEquals("Should be 3 limit data", 3, maxList.getAllLimitData().size());
+        Optional<ISupportParameter.MaxList.LimitData> bDataOpt = maxList.getLimitData('b');
+        Assert.assertTrue("b data should be present", bDataOpt.isPresent());
+        Assert.assertFalse("q data should not be present", maxList.getLimitData('q').isPresent());
+        ISupportParameter.MaxList.LimitData bData = bDataOpt.get();
+        Assert.assertEquals("b via data should be 60", 60, bData.getLimit());
+        Assert.assertEquals("Should be one char in b data", 1, bData.getModes().size());
+        Assert.assertTrue("b should be in b data", bData.getModes().contains('b'));
+    }
+
+    @Test
+    public void testMaxListMerged() {
+        ISupportParameter.MaxList maxList = new DefaultISupportMaxList(Mockito.mock(Client.class), "MAXLIST", "bqeI:100");
+        Assert.assertEquals("b should be 100", 100, maxList.getLimit('b'));
+        Assert.assertEquals("q should be 100", 100, maxList.getLimit('q'));
+        Assert.assertEquals("e should be 100", 100, maxList.getLimit('e'));
+        Assert.assertEquals("I should be 100", 100, maxList.getLimit('I'));
+        Assert.assertEquals("Should be 1 limit data", 1, maxList.getAllLimitData().size());
+        Optional<ISupportParameter.MaxList.LimitData> bDataOpt = maxList.getLimitData('b');
+        Assert.assertTrue("bData should be present", bDataOpt.isPresent());
+        ISupportParameter.MaxList.LimitData bData = bDataOpt.get();
+        Assert.assertEquals("b via data should be 60", 100, bData.getLimit());
+        Assert.assertEquals("Should be 4 chars in b data", 4, bData.getModes().size());
+        Assert.assertTrue("b should be in b data", bData.getModes().contains('b'));
+    }
+}