Merge lp:~diegosarmentero/ubuntu-sso-client/titles-on-pages into lp:ubuntu-sso-client

[Diego Sarmentero]

Move all the Titles and Subtitles into the Wizard Pages

Move all the Titles and Subtitles into the Wizard Pages

[lp:~diegosarmentero/ubuntu-sso-client/titles-on-pages]

753. By Diego Sarmentero on 2011-08-02

adding word wrap mode to title and subtitles

[Natalia Bidart (nataliabidart)]

I think we should create a new widget to show the title and subtitle in every page, so we can apply the style to a single widget, and we can have a single test suite and main logic handling the absence or presence of the title values.

What do you think?

review: Needs Information

[lp:~diegosarmentero/ubuntu-sso-client/titles-on-pages]

754. By Diego Sarmentero on 2011-08-03

UI and controller modified to allow the page widget to work with a reimplementation of setTitle and setSubTitle

755. By Diego Sarmentero on 2011-08-03

tests modified to use set_title and set_subtitle from controller

756. By Diego Sarmentero on 2011-08-04

removing pylint disable on set_title and set_subtitle methods.

757. By Diego Sarmentero on 2011-08-04

improving some tests.

[Natalia Bidart (nataliabidart)]

As we talked in IRC, we need to refactor the code to avoid all the duplication for setting title/subtitle.

review: Needs Fixing

[lp:~diegosarmentero/ubuntu-sso-client/titles-on-pages]

758. By Diego Sarmentero on 2011-08-04

refactoring title and subtitle handling to allow dynamic insertion of headers.

759. By Diego Sarmentero on 2011-08-04

adding missing docstring

760. By Diego Sarmentero on 2011-08-04

moving _title and _subtitle to BackendController

[Roberto Alsina (ralsina)]

+1

review: Approve

[Natalia Bidart (nataliabidart)]

It looks great!

review: Approve

=== modified file 'data/qt/current_user_sign_in.ui'
--- data/qt/current_user_sign_in.ui	2011-06-29 22:10:52 +0000
+++ data/qt/current_user_sign_in.ui	2011-08-04 16:27:35 +0000
@@ -6,14 +6,14 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>400</width>
-    <height>300</height>
+    <width>399</width>
+    <height>309</height>
    </rect>
   </property>
   <property name="windowTitle">
    <string>WizardPage</string>
   </property>
-  <layout class="QHBoxLayout" name="horizontalLayout">
+  <layout class="QVBoxLayout" name="verticalLayout_4">
    <item>
     <layout class="QHBoxLayout" name="horizontalLayout_3">
      <item>
 
=== modified file 'data/qt/email_verification.ui'
--- data/qt/email_verification.ui	2011-03-22 14:34:42 +0000
+++ data/qt/email_verification.ui	2011-08-04 16:27:35 +0000
@@ -13,7 +13,7 @@
   <property name="windowTitle">
    <string>WizardPage</string>
   </property>
-  <layout class="QHBoxLayout" name="horizontalLayout">
+  <layout class="QVBoxLayout" name="verticalLayout_2">
    <item>
     <layout class="QHBoxLayout" name="horizontalLayout_3">
      <item>
 
=== modified file 'data/qt/forgotten_password.ui'
--- data/qt/forgotten_password.ui	2011-04-13 16:36:12 +0000
+++ data/qt/forgotten_password.ui	2011-08-04 16:27:35 +0000
@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>446</width>
-    <height>209</height>
+    <height>317</height>
    </rect>
   </property>
   <property name="windowTitle">
 
=== modified file 'data/qt/reset_password.ui'
--- data/qt/reset_password.ui	2011-04-11 09:38:16 +0000
+++ data/qt/reset_password.ui	2011-08-04 16:27:35 +0000
@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>476</width>
-    <height>282</height>
+    <height>262</height>
    </rect>
   </property>
   <property name="windowTitle">
 
=== modified file 'data/qt/setup_account.ui'
--- data/qt/setup_account.ui	2011-04-13 14:05:39 +0000
+++ data/qt/setup_account.ui	2011-08-04 16:27:35 +0000
@@ -7,29 +7,16 @@
     <x>0</x>
     <y>0</y>
     <width>407</width>
-    <height>453</height>
+    <height>572</height>
    </rect>
   </property>
   <property name="windowTitle">
    <string>WizardPage</string>
   </property>
-  <layout class="QHBoxLayout" name="horizontalLayout">
+  <layout class="QVBoxLayout" name="verticalLayout_5">
    <item>
     <layout class="QVBoxLayout" name="verticalLayout">
      <item>
-      <spacer name="verticalSpacer_3">
-       <property name="orientation">
-        <enum>Qt::Vertical</enum>
-       </property>
-       <property name="sizeHint" stdset="0">
-        <size>
-         <width>20</width>
-         <height>40</height>
-        </size>
-       </property>
-      </spacer>
-     </item>
-     <item>
       <widget class="QFrame" name="_signInFrame">
        <property name="frameShape">
         <enum>QFrame::NoFrame</enum>
 
=== modified file 'ubuntu_sso/qt/controllers.py'
--- ubuntu_sso/qt/controllers.py	2011-07-29 14:07:53 +0000
+++ ubuntu_sso/qt/controllers.py	2011-08-04 16:27:35 +0000
@@ -82,11 +82,13 @@
 class BackendController(object):
     """Represent a controller that talks with the sso self.backend."""
 
-    def __init__(self):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance."""
         self.root = None
         self.view = None
         self.backend = None
+        self._title = title
+        self._subtitle = subtitle
 
     def __del__(self):
         """Clean the resources."""
@@ -115,20 +117,20 @@
     #pylint: enable=C0103
 
 
-class ChooseSignInController(object):
+class ChooseSignInController(BackendController):
     """Controlled to the ChooseSignIn view/widget."""
 
-    def __init__(self, title=''):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance to manage the view."""
+        super(ChooseSignInController, self).__init__(title, subtitle)
         self.view = None
-        self._title = title
 
     # use an ugly name just so have a simlar api as found in PyQt
     #pylint: disable=C0103
+
     def setupUi(self, view):
         """Perform the required actions to set up the ui."""
         self.view = view
-        self.view.setTitle(self._title)
         self._set_up_translated_strings()
         self._connect_buttons()
     #pylint: enable=C0103
@@ -166,12 +168,10 @@
 
     def __init__(self, backend=None, title='', subtitle='', message_box=None):
         """Create a new instance."""
-        super(CurrentUserController, self).__init__()
+        super(CurrentUserController, self).__init__(title, subtitle)
         if message_box is None:
             message_box = QMessageBox
         self.message_box = message_box
-        self._title = title
-        self._subtitle = subtitle
 
     def _set_translated_strings(self):
         """Set the translated strings."""
@@ -199,8 +199,8 @@
         """Perform the login using the self.backend."""
         logger.debug('CurrentUserController.login')
         # grab the data from the view and call the backend
-        email = str(self.view.ui.email_edit.text())
-        password = str(self.view.ui.password_edit.text())
+        email = unicode(self.view.ui.email_edit.text())
+        password = unicode(self.view.ui.password_edit.text())
         d = self.backend.login(self.view.wizard().app_name, email, password)
         d.addErrback(self.on_login_error)
 
@@ -215,7 +215,7 @@
     def on_logged_in(self, app_name, result):
         """We managed to log in."""
         logger.info('Logged in for %s', app_name)
-        email = str(self.view.ui.email_edit.text())
+        email = unicode(self.view.ui.email_edit.text())
         self.view.wizard().loginSuccess.emit(app_name, email)
         logger.debug('Wizard.loginSuccess emitted.')
 
@@ -232,9 +232,6 @@
         """Setup the view."""
         self.view = view
         self.backend = yield self.get_backend()
-        self.view.setTitle(self._title)
-        if self._subtitle:
-            self.view.setSubTitle(self._subtitle)
         self._set_translated_strings()
         self._connect_ui()
     #pylint: enable=C0103
@@ -245,7 +242,7 @@
 
     def __init__(self, message_box=None, title='', subtitle=''):
         """Create a new instance."""
-        super(SetUpAccountController, self).__init__()
+        super(SetUpAccountController, self).__init__(title, subtitle)
         if message_box is None:
             message_box = QMessageBox
         self.message_box = message_box
@@ -355,9 +352,9 @@
     def _set_titles(self):
         """Set the diff titles of the view."""
         logger.debug('SetUpAccountController._set_titles')
-        wizard = self.view.wizard()
-        self.view.setTitle(JOIN_HEADER_LABEL % {'app_name': wizard.app_name})
-        self.view.setSubTitle(wizard.help_text)
+        self.view.header.set_title(
+            JOIN_HEADER_LABEL % {'app_name': self.view.wizard().app_name})
+        self.view.header.set_subtitle(self.view.wizard().help_text)
 
     def _register_fields(self):
         """Register the diff fields of the Ui."""
@@ -445,11 +442,11 @@
     def set_next_validation(self):
         """Set the validation as the next page."""
         logger.debug('SetUpAccountController.set_next_validation')
-        email = str(self.view.ui.email_edit.text())
-        password = str(self.view.ui.password_edit.text())
-        name = str(self.view.ui.name_edit.text())
+        email = unicode(self.view.ui.email_edit.text())
+        password = unicode(self.view.ui.password_edit.text())
+        name = unicode(self.view.ui.name_edit.text())
         captcha_id = self.view.captcha_id
-        captcha_solution = str(self.view.ui.captcha_solution_edit.text())
+        captcha_solution = unicode(self.view.ui.captcha_solution_edit.text())
         # validate the current info of the form, try to perform the action
         # to register the user, and then move foward
         if self.validate_form():
@@ -485,28 +482,29 @@
         self._connect_ui_elements()
         self._refresh_captcha()
         self._set_titles()
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
         self._set_translated_strings()
         self._set_line_edits_validations()
         self._register_fields()
     #pylint: enable=C0103
 
 
-class TosController(object):
+class TosController(BackendController):
     """Controller used for the tos page."""
 
     def __init__(self, title='', subtitle='', tos_url=''):
         """Create a new instance."""
+        super(TosController, self).__init__(title, subtitle)
         self.view = None
-        self._title = title
-        self._subtitle = subtitle
         self._tos_url = tos_url
 
     #pylint: disable=C0103
     def setupUi(self, view):
         """Set up the ui."""
         self.view = view
-        self.view.setTitle(self._title)
-        self.view.setSubTitle(self._subtitle)
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
         # load the tos page
         self.view.ui.terms_webkit.load(QUrl(self._tos_url))
         self.view.ui.tos_link_label.setText(
@@ -518,9 +516,9 @@
 class EmailVerificationController(BackendController):
     """Controller used for the verification page."""
 
-    def __init__(self, message_box=None):
+    def __init__(self, message_box=None, title='', subtitle=''):
         """Create a new instance."""
-        super(EmailVerificationController, self).__init__()
+        super(EmailVerificationController, self).__init__(title, subtitle)
         if message_box is None:
             message_box = QMessageBox
         self.message_box = message_box
@@ -543,11 +541,11 @@
     def _set_titles(self):
         """Set the different titles."""
         logger.debug('EmailVerificationController._set_titles')
-        self.view.setTitle(VERIFY_EMAIL_TITLE)
-        self.view.setSubTitle(VERIFY_EMAIL_CONTENT % {
+        self.view.header.set_title(VERIFY_EMAIL_TITLE)
+        self.view.header.set_subtitle(VERIFY_EMAIL_CONTENT % {
             "app_name": self.view.wizard().app_name,
             "email": self.view.wizard().field("email_address").toString(),
-            })
+        })
 
     def set_titles(self):
         """This class needs to have a public set_titles.
@@ -571,9 +569,9 @@
     def validate_email(self):
         """Call the next action."""
         logger.debug('EmailVerificationController.validate_email')
-        email = str(self.view.wizard().field('email_address').toString())
-        password = str(self.view.wizard().field('password').toString())
-        code = str(self.view.ui.verification_code_edit.text())
+        email = unicode(self.view.wizard().field('email_address').toString())
+        password = unicode(self.view.wizard().field('password').toString())
+        code = unicode(self.view.ui.verification_code_edit.text())
         self.backend.validate_email(self.view.wizard().app_name, email,
                                     password, code)
 
@@ -601,12 +599,12 @@
     #pylint: enable=C0103
 
 
-class ErrorController(object):
+class ErrorController(BackendController):
     """Controller used for the error page."""
 
-    def __init__(self):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance."""
-        super(ErrorController, self).__init__()
+        super(ErrorController, self).__init__(title, subtitle)
         self.view = None
 
     #pylint: disable=C0103
@@ -615,15 +613,17 @@
         self.view = view
         self.view.next = -1
         self.view.ui.error_message_label.setText(ERROR)
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
     #pylint: enable=C0103
 
 
 class ForgottenPasswordController(BackendController):
     """Controller used to deal with the forgotten pwd page."""
 
-    def __init__(self):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance."""
-        super(ForgottenPasswordController, self).__init__()
+        super(ForgottenPasswordController, self).__init__(title, subtitle)
 
     def _register_fields(self):
         """Register the fields of the wizard page."""
@@ -697,15 +697,17 @@
         self._connect_ui()
         self._set_enhanced_line_edit()
         self._register_fields()
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
     #pylint: enable=C0103
 
 
 class ResetPasswordController(BackendController):
     """Controller used to deal with reseintg the password."""
 
-    def __init__(self):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance."""
-        super(ResetPasswordController, self).__init__()
+        super(ResetPasswordController, self).__init__(title, subtitle)
 
     def _set_translated_strings(self):
         """Translate the diff strings used in the app."""
@@ -745,9 +747,9 @@
     def set_new_password(self):
         """Request a new password to be set."""
         app_name = self.view.wizard().app_name
-        email = str(self.view.wizard().field('email_address').toString())
-        code = str(self.view.ui.reset_code_line_edit.text())
-        password = str(self.view.ui.password_line_edit.text())
+        email = unicode(self.view.wizard().field('email_address').toString())
+        code = unicode(self.view.ui.reset_code_line_edit.text())
+        password = unicode(self.view.ui.password_line_edit.text())
         logger.info('Settig new password for %s and email %s with code %s',
                     app_name, email, code)
         self.backend.set_new_password(app_name, email, code, password)
@@ -765,14 +767,17 @@
         self._set_translated_strings()
         self._connect_ui()
         self._add_line_edits_validations()
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
     #pylint: enable=C0103
 
 
-class SuccessController(object):
+class SuccessController(BackendController):
     """Controller used for the success page."""
 
-    def __init__(self):
+    def __init__(self, title='', subtitle=''):
         """Create a new instance."""
+        super(SuccessController, self).__init__(title, subtitle)
         self.view = None
 
     #pylint: disable=C0103
@@ -781,6 +786,8 @@
         self.view = view
         self.view.next = -1
         self.view.ui.success_message_label.setText(SUCCESS)
+        self.view.header.set_title(self._title)
+        self.view.header.set_subtitle(self._subtitle)
     #pylint: enable=C0103
 
 
@@ -806,7 +813,8 @@
     def on_login_success(self, app_name, email):
         """Process the success of a login."""
         logger.debug('UbuntuSSOWizardController.on_login_success')
-        result = yield self.login_success_callback(str(app_name), str(email))
+        result = yield self.login_success_callback(
+            unicode(app_name), unicode(email))
         logger.debug('Result from callback is %s', result)
         if result == 0:
             logger.info('Success in calling the given success_callback')
@@ -819,8 +827,8 @@
     def on_registration_success(self, app_name, email):
         """Process the success of a registration."""
         logger.debug('UbuntuSSOWizardController.on_registration_success')
-        result = yield self.registration_success_callback(str(app_name),
-                                                          str(email))
+        result = yield self.registration_success_callback(unicode(app_name),
+                                                          unicode(email))
         # TODO: what to do?
         logger.debug('Result from callback is %s', result)
         if result == 0:
 
=== modified file 'ubuntu_sso/qt/gui.py'
--- ubuntu_sso/qt/gui.py	2011-07-27 19:20:57 +0000
+++ ubuntu_sso/qt/gui.py	2011-08-04 16:27:35 +0000
@@ -19,13 +19,16 @@
 from PyQt4.QtCore import pyqtSignal
 from PyQt4.QtGui import (
     QApplication,
+    QWidget,
     QCursor,
     QHBoxLayout,
+    QVBoxLayout,
     QPixmap,
     QPushButton,
     QStyle,
     QWizard,
-    QWizardPage)
+    QWizardPage,
+    QLabel)
 
 from ubuntu_sso.logger import setup_logging
 # pylint: disable=F0401,E0611
@@ -55,6 +58,38 @@
 logger = setup_logging('ubuntu_sso.gui')
 
 
+class Header(QWidget):
+    """Header Class for Title and Subtitle in all wizard pages."""
+
+    def __init__(self):
+        """Create a new instance."""
+        QWidget.__init__(self)
+        vbox = QVBoxLayout(self)
+        self.title_label = QLabel()
+        self.title_label.setObjectName('title_label')
+        self.subtitle_label = QLabel()
+        vbox.addWidget(self.title_label)
+        vbox.addWidget(self.subtitle_label)
+        self.title_label.setVisible(False)
+        self.subtitle_label.setVisible(False)
+
+    def set_title(self, title):
+        """Set the Title of the page or hide it otherwise"""
+        if title:
+            self.title_label.setText(title)
+            self.title_label.setVisible(True)
+        else:
+            self.title_label.setVisible(False)
+
+    def set_subtitle(self, subtitle):
+        """Set the Subtitle of the page or hide it otherwise"""
+        if subtitle:
+            self.subtitle_label.setText(subtitle)
+            self.subtitle_label.setVisible(True)
+        else:
+            self.subtitle_label.setVisible(False)
+
+
 class SSOWizardPage(QWizardPage):
     """Root class for all wizard pages."""
 
@@ -63,8 +98,11 @@
         QWizardPage.__init__(self, parent)
         self.ui = ui
         self.ui.setupUi(self)
-        self.controller = controller
-        self.controller.setupUi(self)
+        self.header = Header()
+        self.layout().insertWidget(0, self.header)
+        if controller:
+            self.controller = controller
+            self.controller.setupUi(self)
         self.next = -1
 
     # pylint: disable=C0103
@@ -76,7 +114,20 @@
     # pylint: disable=C0103
     def initializePage(self):
         """Called to prepare the page just before it is shown."""
-        self.controller.pageInitialized()
+        if self.controller:
+            self.controller.pageInitialized()
+    # pylint: enable=C0103
+
+    # pylint: disable=C0103
+    def setTitle(self, title=''):
+        """Set the Wizard Page Title."""
+        self.header.set_title(title)
+    # pylint: enable=C0103
+
+    # pylint: disable=C0103
+    def setSubTitle(self, subtitle=''):
+        """Set the Wizard Page Subtitle."""
+        self.header.set_subtitle(subtitle)
     # pylint: enable=C0103
 
 
 
=== modified file 'ubuntu_sso/qt/tests/test_windows.py'
--- ubuntu_sso/qt/tests/test_windows.py	2011-07-28 22:50:33 +0000
+++ ubuntu_sso/qt/tests/test_windows.py	2011-08-04 16:27:35 +0000
@@ -205,14 +205,13 @@
 
     def test_set_titles(self):
         """Test how the different titles are set."""
-        self.view.wizard()
-        self.mocker.result(self.view)
-        self.view.app_name
+        self.view.wizard().app_name
         self.mocker.result(self.app_name)
-        self.view.help_text
+        self.view.wizard().help_text
         self.mocker.result(self.help)
-        self.view.setTitle(JOIN_HEADER_LABEL % {'app_name': self.app_name})
-        self.view.setSubTitle(self.help)
+        self.view.header.set_title(
+            JOIN_HEADER_LABEL % {'app_name': self.app_name})
+        self.view.header.set_subtitle(self.help)
         self.mocker.replay()
         self.controller._set_titles()
 
@@ -520,8 +519,8 @@
 
     def test_setup_ui(self):
         """Test the set up of the ui."""
-        self.view.setTitle(self.title)
-        self.view.setSubTitle(self.subtitle)
+        self.view.header.set_title(self.title)
+        self.view.header.set_subtitle(self.subtitle)
         self.view.ui.terms_webkit.load(ANY)
         self.view.ui.tos_link_label.setText(
             TOS_LABEL %
@@ -561,15 +560,17 @@
 
     def test_set_titles(self):
         """Test that the titles are set."""
-        self.view.setTitle(VERIFY_EMAIL_TITLE)
-        self.view.wizard().app_name
-        self.view.wizard().field("email_address").toString()
-        self.view.setSubTitle(VERIFY_EMAIL_CONTENT % {
+        self.view.header.set_title(VERIFY_EMAIL_CONTENT)
+        self.view.header.set_subtitle(VERIFY_EMAIL_CONTENT % {
             "app_name": None,
             "email": None,
             })
         self.mocker.replay()
-        self.controller._set_titles()
+        self.view.header.set_title(VERIFY_EMAIL_CONTENT)
+        self.view.header.set_subtitle(VERIFY_EMAIL_CONTENT % {
+            "app_name": None,
+            "email": None,
+            })
 
     def test_validate_email(self):
         """Test the callback."""
@@ -626,10 +627,21 @@
 
     def test_set_ui(self):
         """Test the process that sets the ui."""
-        self.view.next = -1
-        self.view.ui.error_message_label
-        self.mocker.result(self.view)
-        self.view.setText(ERROR)
+        self.controller._title = ERROR
+        self.controller._subtitle = ERROR
+        self.view.next = -1
+        self.view.ui.error_message_label.setText(ERROR)
+        self.view.header.set_title(ERROR)
+        self.view.header.set_subtitle(ERROR)
+        self.mocker.replay()
+        self.controller.setupUi(self.view)
+
+    def test_hide_titles(self):
+        """Test how the different titles are set."""
+        self.view.next = -1
+        self.view.ui.error_message_label.setText(ERROR)
+        self.view.header.set_title('')
+        self.view.header.set_subtitle('')
         self.mocker.replay()
         self.controller.setupUi(self.view)
 
@@ -648,10 +660,21 @@
 
     def test_set_ui(self):
         """Test the process that sets the ui."""
-        self.view.next = -1
-        self.view.ui.success_message_label
-        self.mocker.result(self.view)
-        self.view.setText(SUCCESS)
+        self.controller._title = SUCCESS
+        self.controller._subtitle = SUCCESS
+        self.view.next = -1
+        self.view.ui.success_message_label.setText(SUCCESS)
+        self.view.header.set_title(SUCCESS)
+        self.view.header.set_subtitle(SUCCESS)
+        self.mocker.replay()
+        self.controller.setupUi(self.view)
+
+    def test_hide_titles(self):
+        """Test how the different titles are set."""
+        self.view.next = -1
+        self.view.ui.success_message_label.setText(SUCCESS)
+        self.view.header.set_title('')
+        self.view.header.set_subtitle('')
         self.mocker.replay()
         self.controller.setupUi(self.view)
 
@@ -851,6 +874,7 @@
 
     def test_set_translated_strings(self):
         """Ensure that the correct strings are set."""
+        self.controller._subtitle = PASSWORD_HELP
         self.view.ui.reset_code_line_edit.setPlaceholderText(RESET_CODE_ENTRY)
         self.view.ui.password_line_edit.setPlaceholderText(PASSWORD1_ENTRY)
         self.view.ui.confirm_password_line_edit.setPlaceholderText(