Move profile to core.

Issue: CLIENT-464
Change-Id: Idf8b7726de5132bf67836b7613ba7fd616f3d414
Reviewed-on: http://gerrit.dmdirc.com/3303
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/actions/wrappers/Profile.java

@@ -0,0 +1,237 @@
+/*
+ * 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.actions.wrappers;
+
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.interfaces.config.IdentityFactory;
+
+import com.google.common.base.Preconditions;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Profile wrapper class.
+ */
+public class Profile {
+
+    /** Identity backing this profile. */
+    private ConfigProvider configProvider;
+    /** Profile Name, must be a sanitised filename. */
+    private String name;
+    /** Real name. */
+    private String realname;
+    /** Ident. */
+    private String ident;
+    /** Nicknames. */
+    private List<String> nicknames;
+    /** Has this profile been marked deleted? */
+    private boolean deleted;
+    /** Factory to use to create profiles when saving. */
+    private final IdentityFactory identityFactory;
+
+    /**
+     * Creates a new profile.
+     *
+     * @param name            Profile name
+     * @param identityFactory The factory to use to create the profile's config file when saving.
+     */
+    public Profile(final String name, final IdentityFactory identityFactory) {
+        this.identityFactory = identityFactory;
+        this.configProvider = null;
+        this.name = name;
+        this.nicknames = new ArrayList<>(Arrays.asList(name.replaceAll(" ", "")));
+        this.realname = name;
+        this.ident = "";
+    }
+
+    /**
+     * Creates a new profile based off the specified Identity.
+     *
+     * @param identityFactory The factory to use to create the profile's config file when saving.
+     * @param configProvider  Provider to read existing profile from.
+     */
+    public Profile(final IdentityFactory identityFactory,
+            @Nonnull final ConfigProvider configProvider) {
+        Preconditions.checkNotNull(configProvider);
+        this.identityFactory = identityFactory;
+        this.configProvider = configProvider;
+        this.name = configProvider.getOption("identity", "name");
+        this.nicknames = configProvider.getOptionList("profile", "nicknames");
+        this.realname = configProvider.getOption("profile", "realname");
+        this.ident = configProvider.getOption("profile", "ident");
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    public String getRealname() {
+        return realname;
+    }
+
+    public void setRealname(final String realname) {
+        this.realname = realname;
+    }
+
+    public String getIdent() {
+        return ident;
+    }
+
+    public void setIdent(final String ident) {
+        this.ident = ident;
+    }
+
+    public List<String> getNicknames() {
+        return nicknames;
+    }
+
+    public void setNicknames(final List<String> nicknames) {
+        this.nicknames = nicknames;
+    }
+
+    public boolean isDeleted() {
+        return deleted;
+    }
+
+    public void setDeleted(final boolean deleted) {
+        this.deleted = deleted;
+    }
+
+    /**
+     * Adds a nickname to this profile.
+     *
+     * @param nickname A new nickname for the profile
+     */
+    public void addNickname(final String nickname) {
+        if (!nicknames.contains(nickname)) {
+            nicknames.add(nickname);
+        }
+    }
+
+    /**
+     * Adds a nickname to this profile.
+     *
+     * @param nickname A new nickname for the profile
+     * @param position Position for the new alternate nickname
+     */
+    public void addNickname(final String nickname, final int position) {
+        if (!nicknames.contains(nickname)) {
+            nicknames.add(position, nickname);
+        }
+    }
+
+    /**
+     * Deletes a nickname from this profile.
+     *
+     * @param nickname An existing nickname from the profile
+     */
+    public void delNickname(final String nickname) {
+        nicknames.remove(nickname);
+    }
+
+    /**
+     * Edits a nickname in the list.
+     *
+     * @param nickname    Nickname to edit
+     * @param newNickname Edited nickname
+     */
+    public void editNickname(final String nickname, final String newNickname) {
+        if (nickname.isEmpty() || newNickname.isEmpty()) {
+            return;
+        }
+        if (!nickname.equals(newNickname)) {
+            final int index = nicknames.indexOf(nickname);
+            nicknames.remove(nickname);
+            nicknames.add(index, newNickname);
+        }
+    }
+
+    /** Saves this profile. */
+    public void save() {
+        if (configProvider == null) {
+            configProvider = identityFactory.createProfileConfig(name);
+        }
+
+        configProvider.setOption("identity", "name", name);
+        configProvider.setOption("profile", "nicknames", nicknames);
+        configProvider.setOption("profile", "realname", realname);
+        configProvider.setOption("profile", "ident", ident);
+    }
+
+    /**
+     * Deletes the profile.
+     */
+    public void delete() {
+        if (configProvider == null) {
+            return;
+        }
+        configProvider.delete();
+    }
+
+    @Override
+    public int hashCode() {
+        int hash = 7;
+        hash = 59 * hash + Objects.hashCode(this.name);
+        hash = 59 * hash + Objects.hashCode(this.realname);
+        hash = 59 * hash + Objects.hashCode(this.ident);
+        hash = 59 * hash + Objects.hashCode(this.nicknames);
+        return hash;
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        final Profile other = (Profile) obj;
+        if (!Objects.equals(this.name, other.name)) {
+            return false;
+        }
+        if (!Objects.equals(this.realname, other.realname)) {
+            return false;
+        }
+        if (!Objects.equals(this.ident, other.ident)) {
+            return false;
+        }
+        return Objects.equals(this.nicknames, other.nicknames);
+    }
+
+    @Override
+    public String toString() {
+        return "Profile{" + "name=" + name + ", realname=" + realname
+                + ", ident=" + ident + ", nicknames=" + nicknames + ", deleted=" + deleted + '}';
+    }
+
+}

test/com/dmdirc/actions/wrappers/ProfileTest.java

@@ -0,0 +1,251 @@
+/*
+ * 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.actions.wrappers;
+
+import com.dmdirc.actions.wrappers.Profile;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.interfaces.config.IdentityFactory;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+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.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+/**
+ * Test profile class.
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ProfileTest {
+
+    @Mock private IdentityFactory identityFactory;
+
+    private Profile createProfile() {
+        final List<String> nicknames = new ArrayList<>();
+        nicknames.add("nickname1");
+        nicknames.add("nickname2");
+        final ConfigProvider configProvider = mock(ConfigProvider.class);
+        when(configProvider.getName()).thenReturn("profile");
+        when(configProvider.getOption("identity", "name")).thenReturn("profile");
+        when(configProvider.getOptionList("profile", "nicknames")).thenReturn(nicknames);
+        when(configProvider.getOption("profile", "realname")).thenReturn("realname");
+        when(configProvider.getOption("profile", "ident")).thenReturn("ident");
+
+        return new Profile(identityFactory, configProvider);
+    }
+
+    /**
+     * Test null profile constructor.
+     */
+    @Test
+    public void testEmptyConstructor() {
+        Profile instance = new Profile("New Profile", identityFactory);
+        assertEquals("", instance.getIdent());
+        assertEquals("New Profile", instance.getName());
+        assertEquals(new ArrayList<>(Arrays.asList("NewProfile")), instance.getNicknames());
+        assertEquals("New Profile", instance.getRealname());
+    }
+
+    /**
+     * Test null profile constructor.
+     */
+    @Test
+    public void testIdentityConstructor() {
+        Profile instance = createProfile();
+        assertEquals("ident", instance.getIdent());
+        assertEquals("profile", instance.getName());
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2", })
+                .equals(instance.getNicknames()));
+        assertEquals("realname", instance.getRealname());
+    }
+
+    /**
+     * Test of addNickname method, of class Profile.
+     */
+    @Test
+    public void testAddNickname_String() {
+        Profile instance = createProfile();
+        instance.addNickname("nickname3");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2",
+            "nickname3"}).equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of addNickname method, of class Profile.
+     */
+    @Test
+    public void testAddNickname_String_Contains() {
+        Profile instance = createProfile();
+        instance.addNickname("nickname2");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of addNickname method, of class Profile.
+     */
+    @Test
+    public void testAddNickname_String_int() {
+        Profile instance = createProfile();
+        instance.addNickname("nickname3", 0);
+        assertTrue(Arrays.asList(new String[]{"nickname3", "nickname1",
+            "nickname2"}).equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of addNickname method, of class Profile.
+     */
+    @Test
+    public void testAddNickname_String_int_Contains() {
+        Profile instance = createProfile();
+        instance.addNickname("nickname2", 0);
+        assertTrue(Arrays.asList(new String[]{"nickname1","nickname2"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of delNickname method, of class Profile.
+     */
+    @Test
+    public void testDelNickname() {
+        Profile instance = createProfile();
+        instance.delNickname("nickname2");
+        assertTrue(Arrays.asList(new String[]{"nickname1"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of save method, of class Profile.
+     */
+    @Test
+    public void testSave() {
+        final List<String> nicknames = new ArrayList<>();
+        nicknames.add("nickname1");
+        nicknames.add("nickname2");
+        final ConfigProvider configProvider = mock(ConfigProvider.class);
+        when(configProvider.getName()).thenReturn("profile");
+        when(configProvider.getOption("identity", "name")).thenReturn("profile");
+        when(configProvider.getOptionList("profile", "nicknames")).thenReturn(nicknames);
+        when(configProvider.getOption("profile", "realname")).thenReturn("realname");
+        when(configProvider.getOption("profile", "ident")).thenReturn("ident");
+
+        Profile instance = new Profile(identityFactory, configProvider);
+        instance.save();
+        verify(configProvider).setOption("identity", "name", "profile");
+        verify(configProvider).setOption("profile", "nicknames", nicknames);
+        verify(configProvider).setOption("profile", "realname", "realname");
+        verify(configProvider).setOption("profile", "ident", "ident");
+    }
+
+    @Test
+    public void testSaveNoConfig() {
+        final ConfigProvider configProvider = mock(ConfigProvider.class);
+
+        when(identityFactory.createProfileConfig("New Profile")).thenReturn(configProvider);
+
+        Profile instance = new Profile("New Profile", identityFactory);
+        instance.save();
+        verify(identityFactory).createProfileConfig("New Profile");
+    }
+
+    /**
+     * Test of editNickname method, of class Profile.
+     */
+    @Test
+    public void testEditNicknameOldEmpty() {
+        Profile instance = createProfile();
+        instance.editNickname("", "nickname3");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of editNickname method, of class Profile.
+     */
+    @Test
+    public void testEditNicknameNewEmpty() {
+        Profile instance = createProfile();
+        instance.editNickname("nickname2", "");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of editNickname method, of class Profile.
+     */
+    @Test
+    public void testEditNicknameSame() {
+        Profile instance = createProfile();
+        instance.editNickname("nickname2", "nickname2");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname2"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of editNickname method, of class Profile.
+     */
+    @Test
+    public void testEditNickname() {
+        Profile instance = createProfile();
+        instance.editNickname("nickname2", "nickname3");
+        assertTrue(Arrays.asList(new String[]{"nickname1", "nickname3"})
+                .equals(instance.getNicknames()));
+    }
+
+    /**
+     * Test of delete method, of class Profile.
+     */
+    @Test
+    public void testDelete() {
+        final List<String> nicknames = new ArrayList<>();
+        nicknames.add("nickname1");
+        nicknames.add("nickname2");
+        final ConfigProvider configProvider = mock(ConfigProvider.class);
+        when(configProvider.getName()).thenReturn("profile");
+        when(configProvider.getOption("identity", "name")).thenReturn("profile");
+        when(configProvider.getOptionList("profile", "nicknames")).thenReturn(nicknames);
+        when(configProvider.getOption("profile", "realname")).thenReturn("realname");
+        when(configProvider.getOption("profile", "ident")).thenReturn("ident");
+
+        Profile instance = new Profile(identityFactory, configProvider);
+        instance.delete();
+        verify(configProvider).delete();
+    }
+
+    /**
+     * Test of delete method, of class Profile.
+     */
+    @Test
+    public void testDeleteNullIdentity() {
+        Profile instance = new Profile("New Profile", null);
+        instance.delete();
+    }
+}