Merge lp:~diegosarmentero/ubuntuone-control-panel/checkwrap into lp:ubuntuone-control-panel

[Diego Sarmentero]

Adding a word_wrap function to use it in those cases where the widget don't implement a wrapping functionality.

[Diego Sarmentero (diegosarmentero)]

I force the strings to be longer (repeating the text twice) and this is how it looks now with this code:

http://ubuntuone.com/6avGquAa62TNcSQ5GB7n7G

[lp:~diegosarmentero/ubuntuone-control-panel/checkwrap]

314. By Diego Sarmentero on 2012-04-16

Fixing lint issue.

315. By Diego Sarmentero on 2012-04-16

reverting code for example.

[Manuel de la Peña (mandel)]

I really thing we can get a much better algorithm here to calculate the wrapping a good example to do so is to read http://en.wikipedia.org/wiki/Word_wrap#Minimum_length and implement something similar that does not force us to have a loop inside an other.

review: Needs Fixing

[Roberto Alsina (ralsina)]

+1 and sharing mandel's algorithm caveat

review: Approve

[lp:~diegosarmentero/ubuntuone-control-panel/checkwrap]

316. By Diego Sarmentero on 2012-04-16

Improve wrapping algorithm, fix tests.

[Diego Sarmentero (diegosarmentero)]

> I really thing we can get a much better algorithm here to calculate the
> wrapping a good example to do so is to read
> http://en.wikipedia.org/wiki/Word_wrap#Minimum_length and implement something
> similar that does not force us to have a loop inside an other.

Done

[Manuel de la Peña (mandel)]

Two comments,

1. I have been told (I' not sure how official is this) that we should start making some move towards using python 3, due to that we should stop using the old string formating 'Hola %s' % 'gatox' to the new one 'Hola {0}'.format('gatox'). Can you please do that.

2. I'm not sure about the removal of the \n in the text.. In translations they do not care about the length of the string but they do care about the paragraph separations. What I mean is:

'This is a very long text, lets say I use more than one paragraph to separater ideas.\n\nThis is my new paragraph focusing on a diff idea.'

In these type of cases we are breaking the paragraph separation that is used by the translator with the intent to express to diff ideas. What I would do is not to remove \n and to check at in every word if we have a \n at the end (word[-1] is faster than endswith.) if that is the case we should set the size to be the full line size.

3. Since this is a very generic method (can be used in any possible widget) and there is no limit in the length of the strings to be wrapped I would assume the worst case scenario which is the case in which strings are very long. If that is the case using += to create the final text is probably not the best thing to do. Following the recommendations from http://wiki.python.org/moin/PythonSpeed/PerformanceTips#String_Concatenation I would at least move to .join instead of +=.

review: Needs Fixing

[lp:~diegosarmentero/ubuntuone-control-panel/checkwrap]

317. By Diego Sarmentero on 2012-04-17

Improving algorithm.

[Diego Sarmentero (diegosarmentero)]

> Two comments,
>
> 1. I have been told (I' not sure how official is this) that we should start
> making some move towards using python 3, due to that we should stop using the
> old string formating 'Hola %s' % 'gatox' to the new one 'Hola
> {0}'.format('gatox'). Can you please do that.
>

Stay as it is because we didn't decide how to use yet.

> 2. I'm not sure about the removal of the \n in the text.. In translations they
> do not care about the length of the string but they do care about the
> paragraph separations. What I mean is:
>
> 'This is a very long text, lets say I use more than one paragraph to separater
> ideas.\n\nThis is my new paragraph focusing on a diff idea.'
>
> In these type of cases we are breaking the paragraph separation that is used
> by the translator with the intent to express to diff ideas. What I would do is
> not to remove \n and to check at in every word if we have a \n at the end
> (word[-1] is faster than endswith.) if that is the case we should set the size
> to be the full line size.
>

Fixed, the '\n' is not needed because we are always providing the original string for the wrapping method.

> 3. Since this is a very generic method (can be used in any possible widget)
> and there is no limit in the length of the strings to be wrapped I would
> assume the worst case scenario which is the case in which strings are very
> long. If that is the case using += to create the final text is probably not
> the best thing to do. Following the recommendations from
> http://wiki.python.org/moin/PythonSpeed/PerformanceTips#String_Concatenation I
> would at least move to .join instead of +=.

Changed.

[Manuel de la Peña (mandel)]

Great!

review: Approve

=== modified file 'ubuntuone/controlpanel/gui/qt/__init__.py'
--- ubuntuone/controlpanel/gui/qt/__init__.py	2012-03-27 12:52:17 +0000
+++ ubuntuone/controlpanel/gui/qt/__init__.py	2012-04-17 18:12:18 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Natalia B Bidart <[e-mail]>
 #
-# Copyright 2010 Canonical Ltd.
+# Copyright 2010-2012 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
@@ -33,6 +31,26 @@
 )
 
 
+def force_wordwrap(widget, size, text):
+    """Set the text to the widget after word wrapping it."""
+    font_metrics = QtGui.QFontMetrics(widget.font())
+    text_width = font_metrics.width(text)
+    if size > 0 and text_width > size:
+        words = text.split(' ')
+        text = ''
+        size_left = size
+        for word in words:
+            word_size = font_metrics.width(word)
+            if (size_left - word_size) > 0 or word_size > size:
+                text = ''.join((text, '%s ' % word))
+                size_left -= word_size
+            else:
+                text = ''.join((text, '\n%s ' % word))
+                size_left = size - word_size
+        text = text.rstrip()
+    widget.setText(text)
+
+
 def uri_hook(uri):
     """Open an URI using the default browser/file manager."""
     if uri.startswith(FILE_URI_PREFIX):
 
=== modified file 'ubuntuone/controlpanel/gui/qt/preferences.py'
--- ubuntuone/controlpanel/gui/qt/preferences.py	2012-03-28 12:06:28 +0000
+++ ubuntuone/controlpanel/gui/qt/preferences.py	2012-04-17 18:12:18 +0000
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Authors: Alejandro J. Cura <[e-mail]>
 #
-# Copyright 2011 Canonical Ltd.
+# Copyright 2011-2012 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
@@ -41,6 +39,7 @@
     SETTINGS_SYNC_ALL_FOLDERS,
     SETTINGS_SYNC_ALL_SHARES,
 )
+from ubuntuone.controlpanel.gui.qt import force_wordwrap
 from ubuntuone.controlpanel.gui.qt.ubuntuonebin import UbuntuOneBin
 from ubuntuone.controlpanel.gui.qt.ui import preferences_ui
 
@@ -82,19 +81,12 @@
         """Do some extra setupping for the UI."""
         super(PreferencesPanel, self)._setup()
         self.ui.apply_changes_button.setText(SETTINGS_BUTTON_APPLY)
-        self.ui.autoconnect_checkbox.setText(SETTINGS_AUTO_CONNECT)
         self.ui.bandwidth_settings.setTitle(SETTINGS_BANDWIDTH)
         self.ui.file_sync_settings.setTitle(SETTINGS_FILE_SYNC)
         self.ui.kbps_label_1.setText(SETTINGS_KILOBITS_PER_SECOND)
         self.ui.kbps_label_2.setText(SETTINGS_KILOBITS_PER_SECOND)
         self.ui.label_2.setText(SETTINGS_BANDWIDTH_ZERO_WARNING)
-        self.ui.limit_uploads_checkbox.setText(SETTINGS_LIMIT_UPLOAD)
-        self.ui.limit_downloads_checkbox.setText(SETTINGS_LIMIT_DOWNLOAD)
         self.ui.restore_defaults_button.setText(SETTINGS_BUTTON_DEFAULT)
-        self.ui.share_autosubscribe_checkbox.setText(SETTINGS_SYNC_ALL_FOLDERS)
-        self.ui.show_all_notifications_checkbox.setText(
-            SETTINGS_ALLOW_NOTIFICATIONS)
-        self.ui.udf_autosubscribe_checkbox.setText(SETTINGS_SYNC_ALL_SHARES)
 
     # pylint: disable=E0202
     @defer.inlineCallbacks
@@ -192,3 +184,23 @@
         settings = yield self.backend.file_sync_settings_info()
 
         self.process_info(settings)
+
+    def resizeEvent(self, event):
+        super(PreferencesPanel, self).resizeEvent(event)
+        size_bandwidth = (self.ui.bandwidth_settings.width() -
+            self.ui.upload_speed_spinbox.width() -
+            self.ui.kbps_label_1.width())
+        padding = 160  # Padding to allow shrinking
+        size_sync = (self.ui.file_sync_settings.width() - padding)
+        force_wordwrap(self.ui.limit_uploads_checkbox, size_bandwidth,
+            SETTINGS_LIMIT_UPLOAD)
+        force_wordwrap(self.ui.limit_downloads_checkbox, size_bandwidth,
+            SETTINGS_LIMIT_DOWNLOAD)
+        force_wordwrap(self.ui.autoconnect_checkbox, size_sync,
+            SETTINGS_AUTO_CONNECT)
+        force_wordwrap(self.ui.udf_autosubscribe_checkbox, size_sync,
+            SETTINGS_SYNC_ALL_SHARES)
+        force_wordwrap(self.ui.share_autosubscribe_checkbox, size_sync,
+            SETTINGS_SYNC_ALL_FOLDERS)
+        force_wordwrap(self.ui.show_all_notifications_checkbox, size_sync,
+            SETTINGS_ALLOW_NOTIFICATIONS)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_common.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_common.py	2012-03-26 21:00:47 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_common.py	2012-04-17 18:12:18 +0000
@@ -28,13 +28,72 @@
     GENERAL_ERROR_TITLE,
     GENERAL_ERROR_MSG,
 )
-from ubuntuone.controlpanel.gui.qt import uri_hook, handle_errors
+from ubuntuone.controlpanel.gui.qt import (
+    force_wordwrap,
+    handle_errors,
+    uri_hook,
+)
 from ubuntuone.controlpanel.gui.qt.tests import (
     BaseTestCase,
     FakedDialog,
 )
 
 
+class ForceWordWrapTestCase(BaseTestCase):
+    """The test suite for the force_wordwrap."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        yield super(ForceWordWrapTestCase, self).setUp()
+        self.check = QtGui.QCheckBox()
+
+    def test_small_text_no_wordwrap(self):
+        """Set a small text, the widget shouldn't wordwrap."""
+        text = u'small text'
+        force_wordwrap(self.check, 1000, text)
+        self.assertEqual(unicode(self.check.text()), text)
+
+    def test_size_invalid(self):
+        """The text shouldn't change if the size is not valid."""
+        text = u'small text' * 20
+        force_wordwrap(self.check, 0, text)
+        self.assertEqual(unicode(self.check.text()), text)
+
+    def test_size_too_small(self):
+        """The text shouldn't change if the size is too small."""
+        text = u'small text' * 20
+        force_wordwrap(self.check, 10, text)
+        self.assertEqual(unicode(self.check.text()), text)
+
+    def test_check_wrapping(self):
+        """The text should be splitted in several lines."""
+        text = u'small text ' * 20
+        font_metrics = QtGui.QFontMetrics(self.check.font())
+        size = font_metrics.width('small text')
+        force_wordwrap(self.check, size, text)
+        expected = u'small text \n' * 20
+        expected = expected[:-1]
+        self.assertEqual(unicode(self.check.text()), expected.rstrip())
+
+    def test_check_wrapping_in_the_middle_of_word(self):
+        """The text should be splitted in several lines."""
+        text = u'small text ' * 20
+        font_metrics = QtGui.QFontMetrics(self.check.font())
+        size = font_metrics.width('small text')
+        force_wordwrap(self.check, size, text)
+        expected = u'small text \n' * 20
+        expected = expected[:-1]
+        self.assertEqual(unicode(self.check.text()), expected.rstrip())
+
+    def test_no_word_wrap_valid(self):
+        """If a not valid wrap place is found, the word wrap is not made."""
+        text = u'smalltext ' * 20
+        font_metrics = QtGui.QFontMetrics(self.check.font())
+        size = font_metrics.averageCharWidth() * 5
+        force_wordwrap(self.check, size, text)
+        self.assertEqual(unicode(self.check.text()), text.rstrip())
+
+
 class UriHookTestCase(BaseTestCase):
     """The test suite for the uri_hook."""
 
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_preferences.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_preferences.py	2012-03-28 12:06:28 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_preferences.py	2012-04-17 18:12:18 +0000
@@ -20,6 +20,8 @@
 
 from __future__ import division
 
+import operator
+
 from twisted.internet import defer
 
 from ubuntuone.controlpanel.gui.qt import preferences as gui
@@ -297,3 +299,31 @@
     def test_tweak_speed_positive(self):
         """Tweak speed properly: if param is positive, return kilobytes."""
         self.assertEqual(123456 * gui.KILOBYTES, gui.tweak_speed(123456))
+
+    def test_resize_event(self):
+        """Check that the QCheckBox widgets receive the proper texts."""
+        wrap_calls = {}
+        self.patch(gui, "force_wordwrap",
+            lambda check, size, text: operator.setitem(
+                wrap_calls, check, (size, text)))
+        self.ui.setFixedWidth(1000)
+        size_bandwidth = (self.ui.ui.bandwidth_settings.width() -
+            self.ui.ui.upload_speed_spinbox.width() -
+            self.ui.ui.kbps_label_1.width())
+        padding = 160  # Left and Right Padding
+        size_sync = (self.ui.ui.file_sync_settings.width() - padding)
+        self.ui.show()
+        self.addCleanup(self.ui.hide)
+        self.assertEqual(wrap_calls[self.ui.ui.limit_uploads_checkbox],
+            (size_bandwidth, gui.SETTINGS_LIMIT_UPLOAD))
+        self.assertEqual(wrap_calls[self.ui.ui.limit_downloads_checkbox],
+            (size_bandwidth, gui.SETTINGS_LIMIT_DOWNLOAD))
+        self.assertEqual(wrap_calls[self.ui.ui.autoconnect_checkbox],
+            (size_sync, gui.SETTINGS_AUTO_CONNECT))
+        self.assertEqual(wrap_calls[self.ui.ui.udf_autosubscribe_checkbox],
+            (size_sync, gui.SETTINGS_SYNC_ALL_SHARES))
+        self.assertEqual(wrap_calls[self.ui.ui.share_autosubscribe_checkbox],
+            (size_sync, gui.SETTINGS_SYNC_ALL_FOLDERS))
+        self.assertEqual(
+            wrap_calls[self.ui.ui.show_all_notifications_checkbox],
+            (size_sync, gui.SETTINGS_ALLOW_NOTIFICATIONS))