Merge lp:~stolowski/unity/expand-2nd-home-category into lp:unity

[Paweł Stołowski]

Dash Home Lens: expand 2nd category (Files & Folders by default) if search is empty.

Dash Home Lens: expand 2nd category (Files & Folders by default) if search is empty.

[Andrea Azzarone (azzar1)]

Do we really need to hardcode it? A category cannot expand itself using libunity etc.?

[Andrea Azzarone (azzar1)]

review: Needs Information

[Paweł Stołowski (stolowski)]

Unfortunately there is no way to do this from lenses. Ideally, we should have a new expand-in-home-on-empty-search lens property in libunity Lens class, that would be passed via existing as{v} hints over DBus. I discussed this with Neil and he suggested handling it as an edge case on unity side only, as it's sanest for 12.10.

[Michal Hruby (mhr3)]

Can we at least do this when the search actually finishes and not arbitrarily after adding a few results?

Otherwise the category might get expanded, but as another lens finishes search and pushes more results it will again get unexpanded... Or is that what what we actually want?

> lens_->view_type == ViewType::LENS_VIEW

That doesn't look right, we should be using HOME_VIEW in home lens (if that's not the case the id check should suffice)

review: Needs Fixing

[Andrea Azzarone (azzar1)]

> Unfortunately there is no way to do this from lenses. Ideally, we should have
> a new expand-in-home-on-empty-search lens property in libunity Lens class,
> that would be passed via existing as{v} hints over DBus. I discussed this with
> Neil and he suggested handling it as an edge case on unity side only, as it's
> sanest for 12.10.

Got it.

[lp:~stolowski/unity/expand-2nd-home-category]

2756. By Paweł Stołowski on 2012-09-27

Perform category expansion on search finished.

2757. By Paweł Stołowski on 2012-11-05

Merged trunk.

2758. By Paweł Stołowski on 2012-11-05

Added manual test for 2nd category expansion in dash home view.

[Andrea Azzarone (azzar1)]

review: Disapprove

Unmerged revisions

2758. By Paweł Stołowski on 2012-11-05

Added manual test for 2nd category expansion in dash home view.

2757. By Paweł Stołowski on 2012-11-05

Merged trunk.

2756. By Paweł Stołowski on 2012-09-27

Perform category expansion on search finished.

2755. By Paweł Stołowski on 2012-09-26

Dash Home Lens: expand 2nd category (Files & Folders by default) if search is empty.

=== modified file 'dash/DashView.cpp'
--- dash/DashView.cpp	2012-10-29 09:34:54 +0000
+++ dash/DashView.cpp	2012-11-05 10:17:23 +0000
@@ -1013,6 +1013,17 @@
   if (active_lens_view_ == NULL) return;
 
   active_lens_view_->CheckNoResults(hints);
+
+  if (active_lens_view_ == home_view_ && active_lens_view_->lens()->last_search_string == "")
+  {
+    active_lens_view_->CheckCategoryExpansion(2);
+  }
+  else
+  {
+    // Check if all results so far are from one category
+    // If so, then expand that category.
+    active_lens_view_->CheckCategoryExpansion(1);
+  }
   std::string const& search_string = search_bar_->search_string;
 
   if (active_lens_view_->search_string == search_string)

=== modified file 'dash/LensView.cpp'
--- dash/LensView.cpp	2012-10-29 09:34:54 +0000
+++ dash/LensView.cpp	2012-11-05 10:17:23 +0000
@@ -483,16 +483,15 @@
       CheckNoResults(Lens::Hints());
     }
 
-    if (!model_updated_timeout_)
+    /* Disabled for now, enable back if needed
+      if (!model_updated_timeout_)
     {
       model_updated_timeout_.reset(new glib::Idle([&] () {
-        // Check if all results so far are from one category
-        // If so, then expand that category.
-        CheckCategoryExpansion();
         model_updated_timeout_.reset();
         return false;
       }, glib::Source::Priority::HIGH));
     }
+    */
   } catch (std::out_of_range& oor) {
     LOG_WARN(logger) << "Result does not have a valid category index: "
                      << boost::lexical_cast<unsigned int>(result.category_index)
@@ -566,7 +565,9 @@
   }
 }
 
-void LensView::CheckCategoryExpansion()
+
+/* Expand last category if number of categories with results is less than or equal to max_categories */
+void LensView::CheckCategoryExpansion(int max_categories)
 {
     int number_of_displayed_categories = 0;
 
@@ -574,23 +575,37 @@
     // If so, collapse it for now
     if (last_expanded_group_ != nullptr)
     {
-        last_expanded_group_->SetExpanded(false);
-        last_expanded_group_ = nullptr;
+      last_expanded_group_->SetExpanded(false);
+      last_expanded_group_ = nullptr;
     }
 
-    // Cycle through all categories
+    const std::vector<unsigned> order(lens_->GetCategoriesOrder());
+    unsigned last_category_index = 0;
+
+    // Cycle through all categories, find last category to expand based on order
     for (auto category : categories_)
     {
-        if (counts_[category] > 0) {
-            number_of_displayed_categories++;
-            last_expanded_group_ = category;
+      if (counts_[category] > 0) {
+        number_of_displayed_categories++;
+        for (unsigned i = 0; i < order.size(); i++)
+        {
+          if (order[i] == category->GetCategoryIndex())
+          {
+            if (i >= last_category_index)
+            {
+              last_category_index = i;
+              last_expanded_group_ = category;
+            }
+            break;
+          }
         }
+      }
     }
-
-    if (number_of_displayed_categories == 1 && last_expanded_group_ != nullptr)
-        last_expanded_group_->SetExpanded(true);
+    
+    if (number_of_displayed_categories <= max_categories && last_expanded_group_ != nullptr)
+      last_expanded_group_->SetExpanded(true);
     else
-        last_expanded_group_ = nullptr;
+      last_expanded_group_ = nullptr;
 }
 
 void LensView::HideResultsMessage()

=== modified file 'dash/LensView.h'
--- dash/LensView.h	2012-10-11 01:44:15 +0000
+++ dash/LensView.h	2012-11-05 10:17:23 +0000
@@ -72,7 +72,7 @@
 
   void PerformSearch(std::string const& search_query);
   void CheckNoResults(Lens::Hints const& hints);
-  void CheckCategoryExpansion();
+  void CheckCategoryExpansion(int max_categories);
   void HideResultsMessage();
 
 private:

=== modified file 'manual-tests/Dash.txt'
--- manual-tests/Dash.txt	2012-10-11 01:44:15 +0000
+++ manual-tests/Dash.txt	2012-11-05 10:17:23 +0000
@@ -90,7 +90,7 @@
  * Open the dash home view
  * Search for something on your system that returns multiple results (more than the number that can fit in a row)
    yet all results are in one category only. This differs per system; try searching for "gnome" in the home lens, or "kde"
-   in the app lens. 
+   in the app lens.
  * Multiple results should be returned in both the cases, but if searching for "gnome" on the home lens returns folders in addition to apps
    or "kde" returns results from two categories in the apps lens, then keep experimenting with other search strings.
  * When you have at least one situation in which results from only one category are returned, and the number of results are enough to overflow one single row,
@@ -101,6 +101,21 @@
    header expands automatically
 
 
+Dash home category expand test
+------------------------------
+This tests whether the dash home expands 2nd category (Files & Folders by default) if there is no search query.
+https://bugs.launchpad.net/unity/+bug/1052914
+
+Setup:
+Make sure you've at least 6 files indexed by zeitgeist - just create some empty files in nautilus if needed.
+
+Actions:
+ * Open the dash home view, make sure search query is empty.
+
+Expected result:
+ * 'Files & Folders' category header is expanded.
+
+
 Test the Panel does not lose track of when the Dash is opened then closed.
 --------------------------------------------------------------------------
 This tests shows the panel will not think the Dash is opened when it is closed.
@@ -307,7 +322,7 @@
     2758 ?        Sl     0:00 /usr/lib/unity-lens-music/unity-music-daemon
     2760 ?        Sl     0:00 /usr/bin/python /usr/lib/unity-lens-video/unity-lens-video
     2816 ?        Sl     0:00 /usr/lib/unity-lens-music/unity-musicstore-daemon
-    
+
 Wrong Result:
   #2 and #4 both produce non-empty result which means the lenses were not
   lazy-loaded but they were running before the first dash use.