Merge lp:~kamstrup/libunity/sorted-filters into lp:libunity

[Mikkel Kamstrup Erlandsen]

Adds API to sort Unity.FilterOptions in various ways inside a Unity.OptionsFilter. The default behaviour remains the same as before this change. The apps lens will use it to sort the filter options according to translation (and locale rules)

[Neil J. Patel (njpatel)]

Approved!

review: Approve

=== modified file 'src/unity-lens-filters.vala'
--- src/unity-lens-filters.vala	2011-09-08 12:08:56 +0000
+++ src/unity-lens-filters.vala	2011-09-12 14:51:24 +0000
@@ -34,7 +34,6 @@
   FILTERING
 }
 
-
 /*
  * Base class for filters. If you are implmenting a scope, checking first that
  * a filter is "filtering" is a good way to avoid unnecessary extra logic in
@@ -103,14 +102,45 @@
 public class OptionsFilter : Filter
 {
   public List<FilterOption> options;
+  public SortType sort_type { get; set; default = SortType.MANUAL; }
+  
+  public enum SortType
+  {
+    MANUAL,
+    DISPLAY_NAME,
+    ID
+  }
 
   public FilterOption add_option (string id, string display_name, Icon? icon_hint=null)
   {
     var option = new FilterOption(id, display_name, icon_hint);
-    options.append (option);
-
+    
+    switch (sort_type)
+      {
+        case SortType.DISPLAY_NAME:
+          options.insert_sorted (option, sort_by_display_name);
+          break;
+        case SortType.ID:
+          options.insert_sorted (option, sort_by_id);
+          break;
+        case SortType.MANUAL :
+        default:
+          options.append (option);
+          break;
+      }
+    
     return option;
   }
+  
+  private static int sort_by_display_name (FilterOption f1, FilterOption f2)
+  {
+    return f1.display_name.collate (f2.display_name);
+  }
+  
+  private static int sort_by_id (FilterOption f1, FilterOption f2)
+  {
+    return f1.id.collate (f2.id);
+  }
 
   public FilterOption? get_option (string id)
   {
 
=== modified file 'test/vala/Makefile.am'
--- test/vala/Makefile.am	2011-08-04 09:29:04 +0000
+++ test/vala/Makefile.am	2011-09-12 14:51:24 +0000
@@ -32,6 +32,7 @@
 
 test_vala_SOURCES = \
   test-appinfo-manager.vala \
+  test-filters.vala \
   test-io.vala \
   test-launcher.vala \
   test-sound-menu.vala \
 
=== added file 'test/vala/test-filters.vala'
--- test/vala/test-filters.vala	1970-01-01 00:00:00 +0000
+++ test/vala/test-filters.vala	2011-09-12 14:51:24 +0000
@@ -0,0 +1,132 @@
+/* -*- Mode: vala; indent-tabs-mode: nil; c-basic-offset: 2; tab-width: 2 -*- */
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Mikkel Kamstrup Erlandsen <[e-mail]>
+ *
+ */
+using Unity;
+
+namespace Unity.Test
+{
+  public class FilterSuite
+  {
+    public FilterSuite ()
+    {
+      GLib.Test.add_data_func ("/Unit/Filters/OptionsFilter/Empty",
+                               FilterSuite.test_options_filter_empty);
+      GLib.Test.add_data_func ("/Unit/Filters/OptionsFilter/SortManual",
+                               FilterSuite.test_options_filter_sort_manual);
+      GLib.Test.add_data_func ("/Unit/Filters/OptionsFilter/SortDisplayName",
+                               FilterSuite.test_options_filter_sort_display_name);
+      GLib.Test.add_data_func ("/Unit/Filters/OptionsFilter/SortId",
+                               FilterSuite.test_options_filter_sort_id);
+    }
+
+    internal static void test_options_filter_empty ()
+    {
+      var filter = new OptionsFilter ();
+      assert (filter.options.length () == 0);
+    }
+    
+    private static int find_filter_offset_by_id (OptionsFilter filter, string id)
+    {
+      int i = 0;
+      foreach (var f in filter.options)
+      {
+        if (f.id == id)
+          return i;
+        i++;
+      }
+      return -1;
+    }
+    
+    internal static void test_options_filter_sort_manual ()
+    {
+      var filter = new OptionsFilter ();
+      assert (filter.sort_type == OptionsFilter.SortType.MANUAL);
+      
+      filter.add_option ("accessories", "Accessories");
+      filter.add_option ("bccessories", "Bccessories");
+      filter.add_option ("xenomorphs", "Xenomorphic Creatures");
+      
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 2);
+      
+      filter.add_option ("aardvaark", "Weird Animal");
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 2);
+      assert (find_filter_offset_by_id (filter, "aardvaark") == 3);
+    }
+    
+    internal static void test_options_filter_sort_display_name ()
+    {
+      var filter = new OptionsFilter ();
+      filter.sort_type = OptionsFilter.SortType.DISPLAY_NAME;
+      assert (filter.sort_type == OptionsFilter.SortType.DISPLAY_NAME);
+      
+      filter.add_option ("accessories", "Accessories");
+      filter.add_option ("bccessories", "Bccessories");
+      filter.add_option ("xenomorphs", "Xenomorphic Creatures");
+      
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 2);
+
+      filter.add_option ("weirdanimal", "Aardvaark");
+      assert (find_filter_offset_by_id (filter, "weirdanimal") == 0);
+      assert (find_filter_offset_by_id (filter, "accessories") == 1);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 2);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 3);
+      
+      filter.add_option ("zooanimal", "Zebra");
+      assert (find_filter_offset_by_id (filter, "weirdanimal") == 0);
+      assert (find_filter_offset_by_id (filter, "accessories") == 1);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 2);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 3);
+      assert (find_filter_offset_by_id (filter, "zooanimal") == 4);
+    }
+    
+    internal static void test_options_filter_sort_id ()
+    {
+      var filter = new OptionsFilter ();
+      filter.sort_type = OptionsFilter.SortType.ID;
+      assert (filter.sort_type == OptionsFilter.SortType.ID);
+      
+      filter.add_option ("accessories", "Accessories");
+      filter.add_option ("bccessories", "Bccessories");
+      filter.add_option ("xenomorphs", "Xenomorphic Creatures");
+      
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 2);
+
+      filter.add_option ("weirdanimal", "Aardvaark");
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "weirdanimal") == 2);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 3);
+      
+      filter.add_option ("zooanimal", "Zebra");
+      assert (find_filter_offset_by_id (filter, "accessories") == 0);
+      assert (find_filter_offset_by_id (filter, "bccessories") == 1);
+      assert (find_filter_offset_by_id (filter, "weirdanimal") == 2);
+      assert (find_filter_offset_by_id (filter, "xenomorphs") == 3);
+      assert (find_filter_offset_by_id (filter, "zooanimal") == 4);
+    }
+  }
+}
 
=== modified file 'test/vala/test-vala.vala'
--- test/vala/test-vala.vala	2011-09-08 15:10:30 +0000
+++ test/vala/test-vala.vala	2011-09-12 14:51:24 +0000
@@ -27,6 +27,7 @@
     AppInfoManagerSuite appinfo_manager;
     LauncherSuite launcher;
     SoundMenuSuite sound_menu_test_suite;
+    FilterSuite filter_suite;
     
     Environment.set_variable ("XDG_DATA_HOME", Config.TESTDIR+"/data", true);
     Test.init (ref args);
@@ -39,6 +40,9 @@
     appinfo_manager = new AppInfoManagerSuite ();
     
     launcher = new LauncherSuite ();
+    
+    /* Lens Filters */
+    filter_suite = new FilterSuite ();
 
     Test.run ();