Merge lp:~sil2100/unity/fix_draging_last_position_out_of_launcher_5.0 into lp:unity/5.0

[Łukasz Zemczak]

Cherry-picked from unity trunk (rev2407):
Launcher: Fix dragging to the last position when out of the launcher

Cherry-picked from upstream. Original description:

Launcher: Fix dragging to the last position when out of the launcher

Without this patch there is the following bug:
 * Have a launcher with free space under the workspace switcher
 * Start dragging a tile from the launcher
 * Move it outside (to the right) of the launcher
 * See how a horizontal bar shows where the icon will land once you release the mouse button
 * Move the mouse down so the horizontal bar should go just before the worspace switcher
 * See that it doesn't go there, it keeps itself one icon before that

With this patch this behaviour is fixed

[Marco Trevisan (Treviño) (3v1n0)]

review: Approve

=== modified file 'plugins/unityshell/src/Launcher.cpp'
--- plugins/unityshell/src/Launcher.cpp	2012-06-06 09:25:29 +0000
+++ plugins/unityshell/src/Launcher.cpp	2012-06-18 16:32:24 +0000
@@ -2272,8 +2272,36 @@
 
       if (progress >= 1.0f)
         _model->ReorderSmart(_drag_icon, hovered_icon, true);
-      else if (progress == 0.0f)
-        _model->ReorderBefore(_drag_icon, hovered_icon, false);
+      else if (progress == 0.0f) {
+        if (_drag_icon->GetIconType() == hovered_icon->GetIconType()) {
+          _model->ReorderBefore(_drag_icon, hovered_icon, false);
+        } else {
+          // LauncherModel::ReorderBefore does not work on different icon types
+          // so if hovered_icon is of a different type than _drag_icon
+          // try to use LauncherModel::ReorderAfter with the icon that is before hovered_icon
+          AbstractLauncherIcon::Ptr iconBeforeHover;
+          LauncherModel::iterator it;
+          LauncherModel::iterator prevIt = _model->end();
+          for (it = _model->begin(); it != _model->end(); it++)
+          {
+            if (!(*it)->GetQuirk(AbstractLauncherIcon::QUIRK_VISIBLE) || !(*it)->IsVisibleOnMonitor(monitor))
+              continue;
+            
+            if ((*it) == hovered_icon) {
+              if (prevIt != _model->end()) {
+                iconBeforeHover = *prevIt;
+              }
+              break;
+            }
+            
+            prevIt = it;
+          }
+
+          if (iconBeforeHover && _drag_icon != iconBeforeHover) {
+            _model->ReorderAfter(_drag_icon, iconBeforeHover);
+          }
+        }
+      }
     }
   }
 }

=== modified file 'tests/autopilot/autopilot/emulators/unity/launcher.py'
--- tests/autopilot/autopilot/emulators/unity/launcher.py	2012-05-21 15:29:34 +0000
+++ tests/autopilot/autopilot/emulators/unity/launcher.py	2012-06-18 16:32:24 +0000
@@ -7,8 +7,10 @@
 # by the Free Software Foundation.
 #
 
+from autopilot.utilities import get_compiz_option
 import dbus
 import logging
+from math import floor
 from testtools.matchers import NotEquals
 from time import sleep
 
@@ -22,6 +24,12 @@
 logger = logging.getLogger(__name__)
 
 
+class IconDragType:
+    """Define possible positions to drag an icon onto another"""
+    INSIDE = 0
+    OUTSIDE = 1
+
+
 class LauncherController(UnityIntrospectionObject):
     """The LauncherController class."""
 
@@ -116,6 +124,16 @@
         logger.debug("Moving mouse to center of launcher.")
         self._mouse.move(target_x, target_y)
 
+    def move_mouse_to_icon(self, icon):
+        # The icon may be off the bottom of screen, so we do this in a loop:
+        while 1:
+            target_x = icon.center_x + self.x
+            target_y = icon.center_y
+            if self._mouse.x == target_x and self._mouse.y == target_y:
+                break
+            self._mouse.move(target_x, target_y)
+            sleep(0.5)
+
     def mouse_reveal_launcher(self):
         """Reveal this launcher with the mouse."""
         self._screen.move_mouse_to_monitor(self.monitor)
@@ -246,6 +264,66 @@
         self._mouse.click(button)
         self.move_mouse_to_right_of_launcher()
 
+    def drag_icon_to_position(self, icon, pos, drag_type=IconDragType.INSIDE):
+        """Place the supplied icon above the icon in the position pos.
+
+        The icon is dragged inside or outside the launcher.
+
+        >>> drag_icon_to_position(calc_icon, 0, IconDragType.INSIDE)
+
+        This will drag the calculator icon above the bfb (but as you can't go
+        above the bfb it will move below it (to position 1))
+
+        """
+        if not isinstance(icon, BamfLauncherIcon):
+            raise TypeError("icon must be a LauncherIcon")
+
+        [launcher_model] = LauncherModel.get_all_instances()
+        all_icons = launcher_model.get_launcher_icons()
+        all_icon_len = len(all_icons)
+        if pos >= all_icon_len:
+            raise ValueError("pos is outside valid range (0-%d)" % all_icon_len)
+
+        logger.debug("Dragging launcher icon %r on monitor %d to position %s"
+                     % (icon, self.monitor, pos))
+        self.mouse_reveal_launcher()
+
+        icon_height = get_compiz_option("unityshell", "icon_size")
+
+        target_icon = all_icons[pos]
+        if target_icon.id == icon.id:
+            logger.warning("%s is already the icon in position %d. Nothing to do." % (icon, pos))
+            return
+
+        self.move_mouse_to_icon(icon)
+        self._mouse.press()
+        sleep(2)
+
+        if drag_type == IconDragType.OUTSIDE:
+            shift_over = self._mouse.x + (icon_height * 2)
+            self._mouse.move(shift_over, self._mouse.y)
+            sleep(0.5)
+
+        # find the target drop position, between the center & top of the target icon
+        target_y = target_icon.center_y - floor(icon_height / 4)
+
+        # Need to move the icons top (if moving up) or bottom (if moving
+        # downward) to the target position
+        moving_up = True if icon.center_y > target_icon.center_y else False
+        icon_half_height = floor(icon_height / 2)
+        fudge_factor = 5
+        if moving_up or drag_type == IconDragType.OUTSIDE:
+            target_y += icon_half_height + fudge_factor
+        else:
+            target_y -= icon_half_height - fudge_factor
+
+        self._mouse.move(self._mouse.x, target_y, rate=20,
+                         time_between_events=0.05)
+        sleep(1)
+
+        self._mouse.release()
+        self.move_mouse_to_right_of_launcher()
+
     def lock_to_launcher(self, icon):
         """lock 'icon' to the launcher, if it's not already.
         `icon` must be an instance of BamfLauncherIcon.

=== modified file 'tests/autopilot/autopilot/tests/test_launcher.py'
--- tests/autopilot/autopilot/tests/test_launcher.py	2012-05-23 12:13:10 +0000
+++ tests/autopilot/autopilot/tests/test_launcher.py	2012-06-18 16:32:24 +0000
@@ -18,6 +18,7 @@
 from autopilot.emulators.X11 import ScreenGeometry
 from autopilot.matchers import Eventually
 from autopilot.tests import AutopilotTestCase, multiply_scenarios
+from unity.emulators.launcher import IconDragType
 
 logger = logging.getLogger(__name__)
 
@@ -460,6 +461,61 @@
         self.assertThat(calc_icon, NotEquals(None))
         self.assertThat(calc_icon.visible, Eventually(Equals(True)))
 
+class LauncherDragIconsBehavior(LauncherTestCase):
+    """Tests interation with dragging icons with the Launcher"""
+
+    scenarios = multiply_scenarios(_make_scenarios(),
+                                   [
+                                       ('inside', {'drag_type': IconDragType.INSIDE}),
+                                       ('outside', {'drag_type': IconDragType.OUTSIDE}),
+                                   ])
+
+    def ensure_calc_icon_not_in_launcher(self):
+        while 1:
+            icon = self.launcher.model.get_icon_by_desktop_id("gcalctool.desktop")
+            if not icon:
+                break
+            sleep(1)
+
+    def test_can_drag_icon_below_bfb(self):
+        """Application icons must be draggable to below the BFB."""
+
+        self.ensure_calc_icon_not_in_launcher()
+        calc = self.start_app("Calculator")
+        calc_icon = self.launcher.model.get_icon_by_desktop_id(calc.desktop_file)
+
+        bfb_icon_position = 0
+        self.launcher_instance.drag_icon_to_position(calc_icon,
+                                                     bfb_icon_position,
+                                                     self.drag_type)
+        moved_icon = self.launcher.model.\
+                     get_launcher_icons_for_monitor(self.launcher_monitor)[1]
+        self.assertThat(moved_icon.id, Equals(calc_icon.id))
+
+    def test_can_drag_icon_above_window_switcher(self):
+        """Launcher icons must be dragable to above the workspace switcher icon."""
+
+        self.ensure_calc_icon_not_in_launcher()
+        calc = self.start_app("Calculator")
+        calc_icon = self.launcher.model.get_icon_by_desktop_id(calc.desktop_file)
+
+        # Move a known icon to the top as it needs to be more than 2 icon
+        # spaces away for this test to actually do anything
+        bfb_icon_position = 0
+        self.launcher_instance.drag_icon_to_position(calc_icon,
+                                                     bfb_icon_position,
+                                                     self.drag_type)
+        sleep(1)
+        switcher_pos = -2
+        self.launcher_instance.drag_icon_to_position(calc_icon,
+                                                     switcher_pos,
+                                                     self.drag_type)
+
+        moved_icon = self.launcher.model.\
+                     get_launcher_icons_for_monitor(self.launcher_monitor)[-3]
+        self.assertThat(moved_icon.id, Equals(calc_icon.id))
+
+
 class LauncherRevealTests(LauncherTestCase):
     """Test the launcher reveal behavior when in autohide mode."""