Merge lp:~julien-spautz/cable/identity-network-refactor into lp:cable

[Julien Spautz]

Work in progress.

Refactoring Identity and Network classes, also testing TDD approach.

Wrote tests for Identity and IdentityFactory and implemented them.

[lp:~julien-spautz/cable/identity-network-refactor]

144. By Julien Spautz on 2013-09-24

added import export functions to IdentityFactory

145. By Julien Spautz on 2013-09-25

implemented remove method

Unmerged revisions

145. By Julien Spautz on 2013-09-25

implemented remove method

144. By Julien Spautz on 2013-09-24

added import export functions to IdentityFactory

143. By Julien Spautz on 2013-09-23

added files for previous commit

142. By Julien Spautz on 2013-09-23

added new Identity and IdentityFActory classes with unit tests

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-09-23 16:18:15 +0000
+++ CMakeLists.txt	2013-09-25 18:53:06 +0000
@@ -115,15 +115,16 @@
     )
 
 vala_precompile(VALA_C_TESTS
-    unit/Assert.vala
-    unit/Test.vala
-    unit/TestCase.vala
-    unit/TestSuite.vala
-    unit/Unit.vala
     
     tests/TestMain.vala
     tests/TestUpMarker.vala
     tests/TestMessageHistory.vala
+    
+    unit/Assert.vala
+    unit/Test.vala
+    unit/TestCase.vala
+    unit/TestSuite.vala
+    unit/Unit.vala
 
     src/Utils/Utils.vala
     src/Utils/MessageHistory.vala
@@ -145,10 +146,37 @@
     --verbose
 )
 
+vala_precompile(VALA_C_TESTS_2
+    
+    tests/Identity/main.vala
+    tests/Identity/Identity.vala
+    tests/Identity/TestIdentity.vala
+    tests/Identity/IdentityFactory.vala
+    tests/Identity/TestIdentityFactory.vala
+    
+    unit/Assert.vala
+    unit/Test.vala
+    unit/TestCase.vala
+    unit/TestSuite.vala
+    unit/Unit.vala
+PACKAGES
+    gtk+-3.0
+    granite
+    libnotify
+    unity
+OPTIONS
+    --target-glib=2.32
+    --vapidir=${CMAKE_CURRENT_SOURCE_DIR}/vapi/
+    --enable-experimental
+    #--fatal-warnings
+    --verbose
+)
+
 add_subdirectory (po)
 add_subdirectory (data)
 
 add_executable(cable ${VALA_C})
 add_executable(cable_tests ${VALA_C_TESTS})
+add_executable(cable_tests_2 ${VALA_C_TESTS_2})
 
 install(TARGETS cable RUNTIME DESTINATION bin)
 
=== added directory 'tests/Identity'
=== added file 'tests/Identity/Identity.vala'
--- tests/Identity/Identity.vala	1970-01-01 00:00:00 +0000
+++ tests/Identity/Identity.vala	2013-09-25 18:53:06 +0000
@@ -0,0 +1,23 @@
+public class Cable.Utils.Identity : GLib.Object {
+
+    public string nick_name { get; construct; }
+    public string real_name { get; construct; }
+    //public string user_name { get; construct; }
+
+    public string part_message { get; construct set; }
+    public string away_message { get; construct set; }
+    public string quit_message { get; construct set; }
+
+    public Identity (string nick_name,
+                     string? real_name = null,
+                     string? part_message = null,
+                     string? quit_message = null,
+                     string? away_message = null) {
+                     
+        GLib.Object (nick_name: nick_name,
+                     real_name: real_name ?? nick_name,
+                     part_message: part_message ?? _("Good night everyone!"),
+                     quit_message: quit_message ?? _("Good night everyone!"),
+                     away_message: away_message ?? _("Try again later!"));
+    }
+}
 
=== added file 'tests/Identity/IdentityFactory.vala'
--- tests/Identity/IdentityFactory.vala	1970-01-01 00:00:00 +0000
+++ tests/Identity/IdentityFactory.vala	2013-09-25 18:53:06 +0000
@@ -0,0 +1,93 @@
+namespace Cable.Utils.IdentityFactory {
+
+    Gee.List <Identity> id_list;
+
+    public void init () {
+        id_list = new Gee.ArrayList <Identity> () as Gee.List;
+    }
+    
+    public void uninit () {
+        id_list = null;
+    }
+    
+    public Identity get_or_create (string nick) {
+        if (has (nick) == false)
+            add (new Identity (nick));
+        return search (nick);
+    }
+    
+    void add (Identity id) requires (has (id.nick_name) == false) {
+        id_list.add (id);
+    }
+    
+    Identity search (string nick) requires (has (nick)) {
+        foreach (var id in id_list)
+            if (id.nick_name == nick)
+                return id;
+        return (Identity) null;
+    }
+    
+    public bool has (string nick) {
+        foreach (var id in id_list)
+            if (id.nick_name == nick)
+                return true;
+        return false;
+    }
+    
+    public void remove (string nick) requires (has (nick)) {
+        foreach (var id in id_list)
+            if (id.nick_name == nick)
+                id_list.remove (id);
+    }
+    
+    public void import (string[] data) {
+        foreach (var identity in data) {
+            var values = identity.split (":");
+            Identity id = null;
+            
+            switch (values.length) {
+                case 0:
+                    warn_if_reached ();
+                    break;
+                case 1:
+                    id = new Identity (values[0]);
+                    break;
+                case 2:
+                    id = new Identity (values[0], values[1]);
+                    break;
+                case 3:
+                    id = new Identity (values[0], values[1], values[2]);
+                    break;
+                case 4:
+                    id = new Identity (values[0], values[1], values[2],
+                                       values[3]);
+                    break;
+                case 5:
+                    id = new Identity (values[0], values[1], values[2],
+                                       values[3], values[4]);
+                    break;
+                default:
+                    warn_if_reached ();
+                    break;
+            }
+            
+            if (id != null && ! has (id.nick_name))
+                add (id);
+        }
+    }
+
+    public string[] export () {
+        string[] result = {};
+
+        foreach (var identity in id_list) {
+            result += string.join (":",
+                identity.nick_name,
+                identity.real_name,
+                identity.part_message,
+                identity.quit_message,
+                identity.away_message);
+        }
+
+        return result;
+    }
+}
 
=== added file 'tests/Identity/TestIdentity.vala'
--- tests/Identity/TestIdentity.vala	1970-01-01 00:00:00 +0000
+++ tests/Identity/TestIdentity.vala	2013-09-25 18:53:06 +0000
@@ -0,0 +1,31 @@
+using Cable.Utils;
+
+public class TestIdentity : Unit.TestCase {
+
+    const string PART_MESSAGE = "Good night everyone!";
+    const string QUIT_MESSAGE = "Good night everyone!";
+    const string AWAY_MESSAGE = "Try again later!";
+
+    public TestIdentity () {
+        base ("Identity");
+        
+        add_test_method ("Creation", test_creation);
+    }
+    
+    public override void set_up () {
+    }
+    
+    public override void tear_down () {
+    }
+
+    void test_creation () throws Assert.Error {
+        var id = new Identity ("Test");
+        
+        Assert.equals ("Test", id.nick_name);
+        Assert.equals ("Test", id.real_name);
+        Assert.equals (PART_MESSAGE, id.part_message);
+        Assert.equals (QUIT_MESSAGE, id.quit_message);
+        Assert.equals (AWAY_MESSAGE, id.away_message);
+    }
+
+}
 \ No newline at end of file
 
=== added file 'tests/Identity/TestIdentityFactory.vala'
--- tests/Identity/TestIdentityFactory.vala	1970-01-01 00:00:00 +0000
+++ tests/Identity/TestIdentityFactory.vala	2013-09-25 18:53:06 +0000
@@ -0,0 +1,86 @@
+using Cable.Utils;
+
+public class TestIdentityFactory : Unit.TestCase {
+
+    const string PART_MESSAGE = "Good night everyone!";
+    const string QUIT_MESSAGE = "Good night everyone!";
+    const string AWAY_MESSAGE = "Try again later!";
+
+    string[] import_data = {
+        "johndoe:John Doe:Parting:Quitting:I'm away"
+    };
+
+    public TestIdentityFactory () {
+        base ("Identity Factory");
+        
+        add_test_method ("Initial State", test_initial_state);
+        add_test_method ("First Insert", test_first_insert);
+        add_test_method ("Get or Create", test_insert_same);
+        add_test_method ("Remove", test_remove);
+        add_test_method ("Import", test_import);
+        add_test_method ("Export", test_export);
+    }
+    
+    public override void set_up () {
+        IdentityFactory.init ();
+    }
+
+    void test_initial_state () throws Assert.Error {
+        Assert.is_false (IdentityFactory.has ("Test"));
+    }
+    
+    void test_first_insert () throws Assert.Error {
+        IdentityFactory.get_or_create ("Test");
+        
+        Assert.is_true (IdentityFactory.has ("Test"));
+        Assert.is_false (IdentityFactory.has ("Test not there"));
+    }
+    
+    void test_insert_same () throws Assert.Error {
+        var id_1 = IdentityFactory.get_or_create ("Test");
+        var id_2 = IdentityFactory.get_or_create ("Test");
+        
+        Assert.is_true (IdentityFactory.has ("Test"));
+        Assert.equals (id_1, id_2);
+    }
+    
+    void test_remove () throws Assert.Error {
+        IdentityFactory.get_or_create ("Test");
+        IdentityFactory.get_or_create ("Removed");
+        IdentityFactory.remove ("Removed");
+        
+        Assert.is_false (IdentityFactory.has ("Removed"));
+    }
+    
+    void test_import () throws Assert.Error {
+        IdentityFactory.import (import_data);
+        var id = IdentityFactory.get_or_create ("johndoe");
+        
+        Assert.equals ("johndoe", id.nick_name);
+        Assert.equals ("John Doe", id.real_name);
+        Assert.equals ("Parting", id.part_message);
+        Assert.equals ("Quitting", id.quit_message);
+        Assert.equals ("I'm away", id.away_message);
+    }
+    
+    void test_export () throws Assert.Error {
+        var id_1 = IdentityFactory.get_or_create ("First");
+        var id_2 = IdentityFactory.get_or_create ("Second");
+        
+        id_2.part_message = "New Part Message";
+        
+        var export_data = IdentityFactory.export ();
+        
+        Assert.equals (2, export_data.length);
+        Assert.equals (@"First:First:$PART_MESSAGE:"+
+                       @"$QUIT_MESSAGE:$AWAY_MESSAGE",
+                       export_data[0]);
+        Assert.equals (@"Second:Second:New Part Message:"+
+                       @"$QUIT_MESSAGE:$AWAY_MESSAGE",
+                       export_data[1]);
+    }
+    
+    public override void tear_down () {
+        IdentityFactory.uninit ();
+    }
+}
 
=== added file 'tests/Identity/main.vala'
--- tests/Identity/main.vala	1970-01-01 00:00:00 +0000
+++ tests/Identity/main.vala	2013-09-25 18:53:06 +0000
@@ -0,0 +1,8 @@
+void main () {
+    var suite = new Unit.TestSuite ("Identity and Identity Factory");
+
+    suite.add_test (new TestIdentity ());
+    suite.add_test (new TestIdentityFactory ());
+
+    suite.run ();
+}
 \ No newline at end of file
 
=== modified file 'tests/TestMessageHistory.vala'
--- tests/TestMessageHistory.vala	2013-09-21 09:14:29 +0000
+++ tests/TestMessageHistory.vala	2013-09-25 18:53:06 +0000
@@ -18,6 +18,9 @@
         history = new Cable.Utils.MessageHistory ();
     }
 
+    public override void tear_down () {
+    }
+
     public void test_initial_state () throws Assert.Error {
         Assert.is_false (history.has_older ());
         Assert.is_false (history.has_newer ());
 
=== modified file 'tests/TestUpMarker.vala'
--- tests/TestUpMarker.vala	2013-09-21 13:19:14 +0000
+++ tests/TestUpMarker.vala	2013-09-25 18:53:06 +0000
@@ -18,6 +18,9 @@
     public override void set_up () {
         up_marker = new UpMarker ();
     }
+    
+    public override void tear_down () {
+    }
 
     string create_token (int foreground_color = -1, int background_color = -1) {
         var token = "&#x3;";
 
=== modified file 'unit/TestCase.vala'
--- unit/TestCase.vala	2013-09-21 13:19:14 +0000
+++ unit/TestCase.vala	2013-09-25 18:53:06 +0000
@@ -88,7 +88,7 @@
     * Sets up the fixture, for example, open a network connection.
     * This method is called before a test is executed.
     */
-    protected virtual void set_up () {
+    public virtual void set_up () {
     }
     
 
@@ -96,7 +96,7 @@
     * Tears down the fixture, for example, close a network connection.
     * This method is called after a test is executed.
     */
-    protected virtual void tear_down () {
+    public virtual void tear_down () {
     }
     
     /**