Merge lp:~elopio/ubuntu-ui-toolkit/fix1324556-get_top_container into lp:ubuntu-ui-toolkit

[Leo Arias]

On the header autopilot helper, use the top container instead of the main view.

[lp:~elopio/ubuntu-ui-toolkit/fix1324556-get_top_container]

1091. By Leo Arias on 2014-05-29

Reverted the change on the test init.

1092. By Leo Arias on 2014-05-29

Fixed pep8.

1093. By Leo Arias on 2014-05-29

Typo.

1094. By Leo Arias on 2014-05-29

Fixed the regression test.

1095. By Leo Arias on 2014-05-29

Prunned the custom main view.

1096. By Leo Arias on 2014-05-29

removed the header.

1097. By Leo Arias on 2014-05-30

Kick jenkins.

Unmerged revisions

=== modified file 'CHANGES'
--- CHANGES	2014-05-20 08:35:14 +0000
+++ CHANGES	2014-05-29 16:26:04 +0000
@@ -12,7 +12,7 @@
 
 Compatibility Breaks
 ********************
-
+* Header component API was made internal (as it was always documented)
 
 Ubuntu.Components 1.0
 #####################

=== modified file 'components.api'
--- components.api	2014-05-26 11:36:53 +0000
+++ components.api	2014-05-29 16:26:04 +0000
@@ -31,6 +31,7 @@
 AbstractButton
     property color color
     property Gradient gradient
+    property font font
     property string iconPosition
 CheckBox 0.1 1.0
 AbstractButton
@@ -61,19 +62,6 @@
     readonly property bool running
     property size sourceSize
     readonly property int status
-Header 0.1 1.0
-StyledItem
-    property bool animate
-    function show()
-    function hide()
-    property string title
-    property Item contents
-    property var tabsModel
-    property var pageStack
-    property var actions
-    property var __customBackAction
-    property Flickable flickable
-    property bool useDeprecatedToolbar
 Icon 0.1 1.0
 Item
     property string name
@@ -94,7 +82,7 @@
     property real __leftIconMargin
     property real __rightIconMargin
     property bool __iconIsItem
-    property internal children
+    default property internal children
 Caption 0.1 1.0
 Item
     property string text
@@ -140,6 +128,7 @@
     property bool expanded
     property bool multiSelection
     property bool colourImage
+    property Component delegate
     property real containerHeight
     property int selectedIndex
     property bool currentlyExpanded
@@ -204,12 +193,14 @@
 Object 0.1 1.0
 QtObject
     default property internal children
+    property list<QtObject> __defaultPropertyFix
 OptionSelector 0.1 1.0
 ListItem.Empty
     property var model
     property bool expanded
     property bool multiSelection
     property bool colourImage
+    property Component delegate
     property real containerHeight
     property int selectedIndex
     property bool currentlyExpanded
@@ -235,6 +226,7 @@
 Page 0.1 1.0
 PageTreeNode
     property string title
+    property Item tools
     property Item __customHeaderContents
     property Flickable flickable
     property list<Action> actions
@@ -355,6 +347,7 @@
 OrientationHelper
     property Item dismissArea
     property bool grabDismissAreaEvents
+    property PropertyAnimation fadingAnimation
     function show()
     function hide()
     function __closeIfHidden()

=== modified file 'modules/Ubuntu/Components/AnimatedItem.qml'
--- modules/Ubuntu/Components/AnimatedItem.qml	2014-04-23 08:50:20 +0000
+++ modules/Ubuntu/Components/AnimatedItem.qml	2014-05-29 16:26:04 +0000
@@ -30,45 +30,8 @@
     id: root
     /*!
       \preliminary
+      \deprecated
       Specifies whether the component is on the visible area of the Flickable or not.
     */
     property bool onScreen: true
-
-    QtObject {
-        id: internal
-        property Flickable flickable
-
-        // returns whether the component is in the visible area of the flickable
-        function checkOnScreen()
-        {
-            var pos = root.mapToItem(flickable, 0, 0)
-            root.onScreen = (pos.y + root.height >= 0) && (pos.y <= internal.flickable.height) &&
-                            (pos.x + root.width >= 0) && (pos.x <= internal.flickable.width)
-        }
-        // lookup for a flickable parent
-        function updateFlickableParent()
-        {
-            var flickable = root.parent
-            while (flickable) {
-                if (flickable.hasOwnProperty("flicking") && flickable.hasOwnProperty("flickableDirection")) {
-                    // non-interactive flickables must be skipped as those do not provide
-                    // on-screen detection support
-                    if (flickable.interactive)
-                        break
-                }
-                flickable = flickable.parent
-            }
-            internal.flickable = flickable
-        }
-    }
-
-    Connections {
-        target: internal.flickable
-
-        onContentXChanged: internal.checkOnScreen()
-        onContentYChanged: internal.checkOnScreen()
-    }
-
-    Component.onCompleted: internal.updateFlickableParent()
-    onParentChanged: internal.updateFlickableParent()
 }

=== modified file 'modules/Ubuntu/Components/ListItems/Base.qml'
--- modules/Ubuntu/Components/ListItems/Base.qml	2014-04-28 19:24:56 +0000
+++ modules/Ubuntu/Components/ListItems/Base.qml	2014-05-29 16:26:04 +0000
@@ -159,7 +159,7 @@
     /*!
       \internal
      */
-    property alias children: middle.data
+    default property alias children: middle.data
     Item {
         id: middle
         property bool anchorToIconHelper: !__iconIsItem && iconHelper.source != ""

=== modified file 'modules/Ubuntu/Components/PageStack.qml'
--- modules/Ubuntu/Components/PageStack.qml	2014-05-13 09:09:35 +0000
+++ modules/Ubuntu/Components/PageStack.qml	2014-05-29 16:26:04 +0000
@@ -192,6 +192,7 @@
      */
     default property alias data: inactiveNode.data
     PageTreeNode {
+        anchors.fill: parent
         id: inactiveNode
         active: false
     }

=== modified file 'modules/Ubuntu/Components/Pickers/DatePicker.qml'
--- modules/Ubuntu/Components/Pickers/DatePicker.qml	2014-05-07 10:42:31 +0000
+++ modules/Ubuntu/Components/Pickers/DatePicker.qml	2014-05-29 16:26:04 +0000
@@ -523,7 +523,8 @@
         function updatePickers() {
             if (completed) {
                 // check mode flags first
-                var modes = datePicker.mode.split(/\W/g);
+                // FIXME: The js split(/\W/g) terminates the process on armhf with Qt 5.3 (v4 js) (https://bugreports.qt-project.org/browse/QTBUG-39255)
+                var modes = datePicker.mode.match(/\w+/g);
 
                 showYearPicker = showMonthPicker = showDayPicker =
                 showHoursPicker = showMinutesPicker = showSecondsPicker = false;
@@ -607,7 +608,8 @@
             completed = false;
 
             // use short format to exclude any extra characters
-            var format = datePicker.locale.dateFormat(Locale.ShortFormat).split(/\W/g);
+            // FIXME: The js split(/\W/g) terminates the process on armhf with Qt 5.3 (v4 js) (https://bugreports.qt-project.org/browse/QTBUG-39255)
+            var format = datePicker.locale.dateFormat(Locale.ShortFormat).match(/\w+/g);
             // loop through the format to decide the position of the tumbler
             var formatIndex = 0;
             for (var i in format) {

=== modified file 'modules/Ubuntu/Components/plugin/i18n.cpp'
--- modules/Ubuntu/Components/plugin/i18n.cpp	2014-05-22 15:54:13 +0000
+++ modules/Ubuntu/Components/plugin/i18n.cpp	2014-05-29 16:26:04 +0000
@@ -103,13 +103,14 @@
     /*
      The default is /usr/share/locale if we don't set a folder
      For click we use APP_DIR/share/locale
-     eg. /usr/share/click/preinstalled/com.example.foo/current/share/locale
+     e.g. /usr/share/click/preinstalled/com.example.foo/current/share/locale
      */
-    QDir appDir(getenv("APP_DIR"));
-    if (appDir.exists()) {
-        QString localePath(appDir.filePath("share/locale"));
-        C::bindtextdomain(domain.toUtf8(), localePath.toUtf8());
+    QString appDir(getenv("APP_DIR"));
+    if (!QDir::isAbsolutePath (appDir)) {
+        appDir = "/usr";
     }
+    QString localePath(QDir(appDir).filePath("share/locale"));
+    C::bindtextdomain(domain.toUtf8(), localePath.toUtf8());
     Q_EMIT domainChanged();
 }
 

=== modified file 'modules/Ubuntu/Components/plugin/thumbnailgenerator.cpp'
--- modules/Ubuntu/Components/plugin/thumbnailgenerator.cpp	2014-02-25 09:14:23 +0000
+++ modules/Ubuntu/Components/plugin/thumbnailgenerator.cpp	2014-05-29 16:26:04 +0000
@@ -43,12 +43,15 @@
      * is the only way around the issue for now. */
     std::string src_path(QUrl(id).path().toUtf8().data());
     std::string tgt_path;
+    const int xlarge_cutoff = 512;
+    const int large_cutoff = 256;
+    const int small_cutoff = 128;
     try {
         ThumbnailSize desiredSize;
-        const int large_cutoff = 256;
-        const int small_cutoff = 128;
-        if(requestedSize.width() > large_cutoff || requestedSize.height() > large_cutoff) {
+        if(requestedSize.width() > xlarge_cutoff || requestedSize.height() > xlarge_cutoff) {
             desiredSize = TN_SIZE_ORIGINAL;
+        } else if(requestedSize.width() > large_cutoff || requestedSize.height() > large_cutoff) {
+            desiredSize = TN_SIZE_XLARGE;
         } else if(requestedSize.width() > small_cutoff || requestedSize.height() > small_cutoff) {
             desiredSize = TN_SIZE_LARGE;
         } else {

=== modified file 'modules/Ubuntu/Components/qmldir'
--- modules/Ubuntu/Components/qmldir	2014-04-25 12:53:58 +0000
+++ modules/Ubuntu/Components/qmldir	2014-05-29 16:26:04 +0000
@@ -29,7 +29,7 @@
 internal PageTreeNode PageTreeNode.qml
 PageStack 0.1 PageStack.qml
 internal Toolbar Toolbar.qml
-Header 0.1 Header.qml
+internal Header Header.qml
 internal AnimatedItem AnimatedItem.qml
 internal PageWrapper PageWrapper.qml
 UbuntuShape 0.1 UbuntuShape.qml
@@ -76,7 +76,6 @@
 OptionSelectorDelegate 1.0 OptionSelectorDelegate.qml
 Page 1.0 Page.qml
 PageStack 1.0 PageStack.qml
-Header 1.0 Header.qml
 UbuntuShape 1.0 UbuntuShape.qml
 CrossFadeImage 1.0 CrossFadeImage.qml
 Icon 1.0 Icon.qml

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2014-04-29 23:03:58 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2014-05-29 16:26:04 +0000
@@ -111,3 +111,19 @@
         raise ToolkitException(
             "The element is not contained in a Flickable so it can't be "
             "swiped into view.")
+
+    def _get_top_container(self):
+        """Return the top-most container with a globalRect."""
+        root = self.get_root_instance()
+        parent = self.get_parent()
+        top_container = None
+        while parent.id != root.id:
+            if hasattr(parent, 'globalRect'):
+                top_container = parent
+
+            parent = parent.get_parent()
+
+        if top_container is None:
+            raise ToolkitException('Could not find the top-most container.')
+        else:
+            return top_container

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-05-20 07:31:55 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-05-29 16:26:04 +0000
@@ -51,23 +51,6 @@
         containers = [self._get_top_container(), self]
         return containers
 
-    def _get_top_container(self):
-        """Return the top-most container with a globalRect."""
-        root = self.get_root_instance()
-        parent = self.get_parent()
-        top_container = None
-        while parent.id != root.id:
-            if hasattr(parent, 'globalRect'):
-                top_container = parent
-
-            parent = parent.get_parent()
-
-        if top_container is None:
-            raise _common.ToolkitException(
-                "Couldn't find the top-most container.")
-        else:
-            return top_container
-
     def _is_child_visible(self, child, containers):
         """Check if the center of the child is visible.
 

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-05-13 12:43:31 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-05-29 16:26:04 +0000
@@ -21,7 +21,6 @@
 
 from ubuntuuitoolkit._custom_proxy_objects import (
     _common,
-    _mainview,
     _tabbar
 )
 
@@ -35,13 +34,6 @@
 class Header(_common.UbuntuUIToolkitCustomProxyObjectBase):
     """Header Autopilot emulator."""
 
-    def __init__(self, *args):
-        super(Header, self).__init__(*args)
-        # XXX we need a better way to keep reference to the main view.
-        # --elopio - 2014-02-26
-        self.main_view = self.get_root_instance().select_single(
-            _mainview.MainView)
-
     def _show_if_not_visible(self):
         if not self._is_visible():
             self._show()
@@ -53,8 +45,9 @@
         # FIXME This will fail if the header is not linked to a flickable that
         # fills the main view. The header has a flickable property but it
         # can't be read by autopilot. See bug http://pad.lv/1318829
+        top_container = self._get_top_container()
         start_x = stop_x = (self.globalRect.x + self.globalRect.width) // 2
-        start_y = self.main_view.globalRect.y + 5
+        start_y = top_container.globalRect.y + 5
         stop_y = start_y + self.globalRect.height
         self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
         self.y.wait_for(0)

=== modified file 'tests/autopilot/ubuntuuitoolkit/fixture_setup.py'
--- tests/autopilot/ubuntuuitoolkit/fixture_setup.py	2014-04-23 08:50:20 +0000
+++ tests/autopilot/ubuntuuitoolkit/fixture_setup.py	2014-05-29 16:26:04 +0000
@@ -16,6 +16,7 @@
 
 import copy
 import os
+import shutil
 import tempfile
 
 import fixtures
@@ -118,3 +119,47 @@
                 original_value)
         else:
             self.addCleanup(environment.unset_initctl_env_var, variable)
+
+
+class FakeHome(fixtures.Fixture):
+
+    # We copy the Xauthority file to allow executions using XVFB. If it is not
+    # on the user's HOME directory, nothing will happen.
+    should_copy_xauthority_file = True
+
+    def __init__(self, directory=None):
+        super(FakeHome, self).__init__()
+        self.directory = directory
+
+    def setUp(self):
+        super(FakeHome, self).setUp()
+        self.directory = self._make_directory_if_not_specified()
+        if self.should_copy_xauthority_file:
+            self._copy_xauthority_file(self.directory)
+        # We patch both environment variables so it works on the desktop and on
+        # the phone.
+        self.useFixture(
+            InitctlEnvironmentVariable(HOME=self.directory))
+        self.useFixture(
+            fixtures.EnvironmentVariable('HOME', newvalue=self.directory))
+
+    def _make_directory_if_not_specified(self):
+        if self.directory is None:
+            parent_directory = os.path.join(
+                os.environ.get('HOME'), 'autopilot', 'fakeenv')
+            if not os.path.exists(parent_directory):
+                os.makedirs(parent_directory)
+            temp_dir_fixture = fixtures.TempDir(parent_directory)
+            self.useFixture(temp_dir_fixture)
+            return temp_dir_fixture.path
+        else:
+            return self.directory
+
+    def _copy_xauthority_file(self, directory):
+        """Copy the .Xauthority file if it exists in the user's home."""
+        xauthority_file_path = os.path.join(
+            os.environ.get('HOME'), '.Xauthority')
+        if os.path.isfile(xauthority_file_path):
+            shutil.copyfile(
+                xauthority_file_path,
+                os.path.join(directory, '.Xauthority'))

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml	2014-05-29 16:26:04 +0000
@@ -0,0 +1,27 @@
+/*
+ * Copyright 2014Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import Ubuntu.Components 1.1
+
+Item {
+
+    objectName: 'mainView'
+
+    Header {
+        title: 'test header'
+    }
+}

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-05-20 08:56:28 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-05-29 16:26:04 +0000
@@ -14,6 +14,8 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
+import os
+
 import ubuntuuitoolkit
 from ubuntuuitoolkit import tests
 
@@ -157,3 +159,24 @@
 
         # only three actions are visible
         self.assertEqual(overflow_button.visible, False)
+
+
+class HeaderInCustomMainViewTestCase(tests.QMLFileAppTestCase):
+
+    path = os.path.abspath(__file__)
+    dir_path = os.path.dirname(path)
+    test_qml_file_path = os.path.join(
+        dir_path, 'test_header.HeaderInCustomMainViewTestCase.qml')
+
+    @property
+    def main_view(self):
+        return self.app.select_single('QQuickItem', objectName='mainView')
+
+    def test_get_header_from_custom_main_view(self):
+        """Test that we can get the header from a custom main view.
+
+        This prevents a regression of http://pad.lv/1324556.
+
+        """
+        header = self.app.select_single(ubuntuuitoolkit.Header)
+        self.assertIsInstance(header, ubuntuuitoolkit.Header)

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py'
--- tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	2014-03-10 16:51:01 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	2014-05-29 16:26:04 +0000
@@ -15,6 +15,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 import os
+import tempfile
 
 try:
     # Python 3.
@@ -24,7 +25,7 @@
     import mock
 import testtools
 from autopilot import testcase as autopilot_testcase
-from testtools.matchers import Contains, Not, FileExists
+from testtools.matchers import Contains, FileExists, Not
 
 from ubuntuuitoolkit import base, environment, fixture_setup
 
@@ -233,3 +234,73 @@
         self.assertEqual(
             'original test value',
             environment.get_initctl_env_var('testenvvarforfixture'))
+
+
+class FakeHomeTestCase(testtools.TestCase):
+
+    def test_fake_home_fixture_patches_initctl_env_var(self):
+        original_home = environment.get_initctl_env_var('HOME')
+        fake_home = original_home + 'fake'
+        result = testtools.TestResult()
+
+        def inner_test():
+            class TestWithFakeHome(testtools.TestCase):
+                def test_it(self):
+                    fake_home_fixture = fixture_setup.FakeHome(fake_home)
+                    fake_home_fixture.should_copy_xauthority_file = False
+                    self.useFixture(fake_home_fixture)
+                    self.assertEqual(
+                        fake_home, environment.get_initctl_env_var('HOME'))
+            return TestWithFakeHome('test_it')
+
+        inner_test().run(result)
+
+        self.assertTrue(
+            result.wasSuccessful(),
+            'Failed to fake the home: {}'.format(result.errors))
+        self.assertEqual(
+            original_home,
+            environment.get_initctl_env_var('HOME'))
+
+    def test_fake_home_fixture_patches_env_var(self):
+        original_home = os.environ.get('HOME')
+        fake_home = tempfile.gettempdir()
+        result = testtools.TestResult()
+
+        def inner_test():
+            class TestWithFakeHome(testtools.TestCase):
+                def test_it(self):
+                    fake_home_fixture = fixture_setup.FakeHome(fake_home)
+                    fake_home_fixture.should_copy_xauthority_file = False
+                    self.useFixture(fake_home_fixture)
+                    self.assertEqual(
+                        fake_home, os.environ.get('HOME'))
+            return TestWithFakeHome('test_it')
+
+        inner_test().run(result)
+
+        self.assertTrue(
+            result.wasSuccessful(),
+            'Failed to fake the home: {}'.format(result.failures))
+        self.assertEqual(original_home, os.environ.get('HOME'))
+
+    def test_fake_home_fixture_must_create_default_directory(self):
+        original_home = os.environ.get('HOME')
+        self.useFixture(fixture_setup.FakeHome())
+
+        home_parent_directory, _ = os.path.split(os.environ.get('HOME'))
+        self.assertEqual(
+            home_parent_directory,
+            os.path.join(original_home, 'autopilot', 'fakeenv'))
+
+    def test_fake_home_fixture_must_copy_xauthority(self):
+        # Fake the home first so we don't write the xauthority on the real
+        # home.
+        self.useFixture(fixture_setup.FakeHome())
+
+        open(os.path.join(os.environ.get('HOME'), '.Xauthority')).close()
+
+        self.useFixture(fixture_setup.FakeHome())
+        self.assertTrue(
+            os.path.exists(
+                os.path.join(os.environ.get('HOME'), '.Xauthority')))

=== modified file 'tests/qmlapicheck.py'
--- tests/qmlapicheck.py	2014-04-24 09:18:38 +0000
+++ tests/qmlapicheck.py	2014-05-29 16:26:04 +0000
@@ -130,10 +130,10 @@
     if '{' in line and '}' in line:
         if filetype == 'qmltypes' and not in_builtin_type:
             print('    ' + line.strip())
-        continue
+            continue
 
     # End of function/ signal/ Item block
-    if '}' in line:
+    if '}' in line and not '{' in line:
         in_block -= 1
         block_meta = {}
         if in_block == 1 and in_builtin_type:
@@ -143,7 +143,7 @@
     # Only root "Item {" is inspected for QML, otherwise all children
     if in_block == 1 or filetype == 'qmltypes':
         # Left hand side specifies a keyword, a type and a variable name
-        declaration = line.split(':')[0]
+        declaration = line.split(':', 1)[0]
         words = declaration.strip().split(' ')
         # Skip types with prefixes considered builtin
         if filetype == 'qmltypes' and words[0] == 'name':
@@ -175,7 +175,8 @@
         for word in words:
             if word in keywords:
                 if filetype == 'qml':
-                    signature = declaration.split('{')[0].strip()
+                    separator = '{' if 'function' in declaration else ':'
+                    signature = declaration.split(separator, 1)[0].strip()
                     if 'alias' in line:
                         no_mods = signature
                         for mod in ['readonly', 'default']:
@@ -198,7 +199,7 @@
                 break
 
     # Start of function/ signal/ Item block
-    if '{' in line:
+    if '{' in line and not '}' in line:
         in_block += 1
         block_meta = {}
         # The parent type can affect API