From 960fbb8865d0b0f0e81ff02b27ed998014da7bf2 Mon Sep 17 00:00:00 2001 From: Ian Knight Date: Mon, 18 Jan 2016 03:16:37 +1030 Subject: [PATCH 1/5] Implemented Better Preview for Service Manager Blueprint --- openlp/core/common/settings.py | 1 + openlp/core/ui/advancedtab.py | 7 ++++++ openlp/core/ui/servicemanager.py | 9 ++++++++ .../openlp_core_ui/test_servicemanager.py | 22 +++++++++++++++++-- 4 files changed, 37 insertions(+), 2 deletions(-) diff --git a/openlp/core/common/settings.py b/openlp/core/common/settings.py index 68b0763df..7b43f6f39 100644 --- a/openlp/core/common/settings.py +++ b/openlp/core/common/settings.py @@ -131,6 +131,7 @@ class Settings(QtCore.QSettings): 'advanced/save current plugin': False, 'advanced/slide limits': SlideLimits.End, 'advanced/single click preview': False, + 'advanced/single click service preview': False, 'advanced/x11 bypass wm': X11_BYPASS_DEFAULT, 'advanced/search as type': True, 'crashreport/last directory': '', diff --git a/openlp/core/ui/advancedtab.py b/openlp/core/ui/advancedtab.py index 4421b432f..fe8c09131 100644 --- a/openlp/core/ui/advancedtab.py +++ b/openlp/core/ui/advancedtab.py @@ -77,6 +77,9 @@ class AdvancedTab(SettingsTab): self.single_click_preview_check_box = QtWidgets.QCheckBox(self.ui_group_box) self.single_click_preview_check_box.setObjectName('single_click_preview_check_box') self.ui_layout.addRow(self.single_click_preview_check_box) + self.single_click_service_preview_check_box = QtWidgets.QCheckBox(self.ui_group_box) + self.single_click_service_preview_check_box.setObjectName('single_click_service_preview_check_box') + self.ui_layout.addRow(self.single_click_service_preview_check_box) self.expand_service_item_check_box = QtWidgets.QCheckBox(self.ui_group_box) self.expand_service_item_check_box.setObjectName('expand_service_item_check_box') self.ui_layout.addRow(self.expand_service_item_check_box) @@ -270,6 +273,8 @@ class AdvancedTab(SettingsTab): 'Double-click to send items straight to live')) self.single_click_preview_check_box.setText(translate('OpenLP.AdvancedTab', 'Preview items when clicked in Media Manager')) + self.single_click_service_preview_check_box.setText(translate('OpenLP.AdvancedTab', + 'Preview items when clicked in Service Manager')) self.expand_service_item_check_box.setText(translate('OpenLP.AdvancedTab', 'Expand new service items on creation')) self.enable_auto_close_check_box.setText(translate('OpenLP.AdvancedTab', @@ -339,6 +344,7 @@ class AdvancedTab(SettingsTab): self.media_plugin_check_box.setChecked(settings.value('save current plugin')) self.double_click_live_check_box.setChecked(settings.value('double click live')) self.single_click_preview_check_box.setChecked(settings.value('single click preview')) + self.single_click_service_preview_check_box.setChecked(settings.value('single click service preview')) self.expand_service_item_check_box.setChecked(settings.value('expand service item')) self.enable_auto_close_check_box.setChecked(settings.value('enable exit confirmation')) self.hide_mouse_check_box.setChecked(settings.value('hide mouse')) @@ -420,6 +426,7 @@ class AdvancedTab(SettingsTab): settings.setValue('save current plugin', self.media_plugin_check_box.isChecked()) settings.setValue('double click live', self.double_click_live_check_box.isChecked()) settings.setValue('single click preview', self.single_click_preview_check_box.isChecked()) + settings.setValue('single click service preview', self.single_click_service_preview_check_box.isChecked()) settings.setValue('expand service item', self.expand_service_item_check_box.isChecked()) settings.setValue('enable exit confirmation', self.enable_auto_close_check_box.isChecked()) settings.setValue('hide mouse', self.hide_mouse_check_box.isChecked()) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index e4a1b143a..a90ab1e8b 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -212,6 +212,7 @@ class Ui_ServiceManager(object): # Connect up our signals and slots self.theme_combo_box.activated.connect(self.on_theme_combo_box_selected) self.service_manager_list.doubleClicked.connect(self.on_make_live) + self.service_manager_list.clicked.connect(self.on_single_click_preview) self.service_manager_list.itemCollapsed.connect(self.collapsed) self.service_manager_list.itemExpanded.connect(self.expanded) # Last little bits of setting up @@ -1461,6 +1462,14 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ServiceMa """ self.make_live() + def on_single_click_preview(self, field=None): + """ + If single click previewing is enabled, send the current item to the Preview slide controller but triggered by a tablewidget click event. + :param field: + """ + if Settings().value('advanced/single click service preview'): + self.make_preview() + def make_live(self, row=-1): """ Send the current item to the Live slide controller diff --git a/tests/functional/openlp_core_ui/test_servicemanager.py b/tests/functional/openlp_core_ui/test_servicemanager.py index 1f9070249..3bd9d8898 100644 --- a/tests/functional/openlp_core_ui/test_servicemanager.py +++ b/tests/functional/openlp_core_ui/test_servicemanager.py @@ -24,11 +24,11 @@ Package to test the openlp.core.ui.slidecontroller package. """ from unittest import TestCase -from openlp.core.common import Registry, ThemeLevel +from openlp.core.common import Registry, ThemeLevel, Settings from openlp.core.lib import ServiceItem, ServiceItemType, ItemCapabilities from openlp.core.ui import ServiceManager -from tests.functional import MagicMock +from tests.functional import MagicMock, patch class TestServiceManager(TestCase): @@ -540,3 +540,21 @@ class TestServiceManager(TestCase): self.assertEquals(service_manager.timed_slide_interval.setChecked.call_count, 0, 'Should not be called') self.assertEquals(service_manager.theme_menu.menuAction().setVisible.call_count, 1, 'Should have be called once') + + @patch(u'openlp.core.lib.mediamanageritem.Settings') + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') + def single_click_preview_test(self, mocked_make_preview, MockedSettings): + """ + Test that when "Preview items when clicked in Service Manager" is enabled that the item goes to preview + """ + # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. + mocked_settings = MagicMock() + mocked_settings.value.side_effect = lambda x: x == 'advanced/single click service preview' + MockedSettings.return_value = mocked_settings + service_manager = ServiceManager(None) + + # WHEN: on_double_clicked() is called + service_manager.on_single_click_preview() + + # THEN: on_live_click() should have been called + mocked_make_preview.assert_called_with() \ No newline at end of file From 34c771688c8d65be076f517d9eeb410065662a3e Mon Sep 17 00:00:00 2001 From: Ian Knight Date: Mon, 18 Jan 2016 12:49:20 +1030 Subject: [PATCH 2/5] Tests for Better Preview for Service Manager Blueprint --- .../openlp_core_ui/test_servicemanager.py | 32 +++++++++++++------ 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/tests/functional/openlp_core_ui/test_servicemanager.py b/tests/functional/openlp_core_ui/test_servicemanager.py index 3bd9d8898..f013b9ada 100644 --- a/tests/functional/openlp_core_ui/test_servicemanager.py +++ b/tests/functional/openlp_core_ui/test_servicemanager.py @@ -540,21 +540,35 @@ class TestServiceManager(TestCase): self.assertEquals(service_manager.timed_slide_interval.setChecked.call_count, 0, 'Should not be called') self.assertEquals(service_manager.theme_menu.menuAction().setVisible.call_count, 1, 'Should have be called once') - - @patch(u'openlp.core.lib.mediamanageritem.Settings') + + @patch(u'openlp.core.ui.servicemanager.Settings') @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') - def single_click_preview_test(self, mocked_make_preview, MockedSettings): + def single_click_preview_test_true(self, mocked_make_preview, MockedSettings): """ Test that when "Preview items when clicked in Service Manager" is enabled that the item goes to preview """ # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. mocked_settings = MagicMock() - mocked_settings.value.side_effect = lambda x: x == 'advanced/single click service preview' + mocked_settings.value.return_value = True MockedSettings.return_value = mocked_settings service_manager = ServiceManager(None) - - # WHEN: on_double_clicked() is called + # WHEN: on_single_click_preview() is called service_manager.on_single_click_preview() - - # THEN: on_live_click() should have been called - mocked_make_preview.assert_called_with() \ No newline at end of file + # THEN: make_preview() should have been called + self.assertEquals(mocked_make_preview.call_count, 1, 'Should have been called once') + + @patch(u'openlp.core.ui.servicemanager.Settings') + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') + def single_click_preview_test_false(self, mocked_make_preview, MockedSettings): + """ + Test that when "Preview items when clicked in Service Manager" is disabled that the item does not goes to preview + """ + # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. + mocked_settings = MagicMock() + mocked_settings.value.return_value = False + MockedSettings.return_value = mocked_settings + service_manager = ServiceManager(None) + # WHEN: on_single_click_preview() is called + service_manager.on_single_click_preview() + # THEN: make_preview() should have been called + self.assertEquals(mocked_make_preview.call_count, 0, 'Should not be called') From 7f8e19adcade618b9e3aa9afe98495cc8968b8f4 Mon Sep 17 00:00:00 2001 From: Ian Knight Date: Tue, 19 Jan 2016 17:22:23 +1030 Subject: [PATCH 3/5] Prevented Single Click Preview when a double click had triggered & Updated tests for this --- openlp/core/ui/advancedtab.py | 2 +- openlp/core/ui/servicemanager.py | 22 ++++++- .../openlp_core_ui/test_servicemanager.py | 65 ++++++++++++++++--- 3 files changed, 75 insertions(+), 14 deletions(-) diff --git a/openlp/core/ui/advancedtab.py b/openlp/core/ui/advancedtab.py index fe8c09131..08adc0f29 100644 --- a/openlp/core/ui/advancedtab.py +++ b/openlp/core/ui/advancedtab.py @@ -274,7 +274,7 @@ class AdvancedTab(SettingsTab): self.single_click_preview_check_box.setText(translate('OpenLP.AdvancedTab', 'Preview items when clicked in Media Manager')) self.single_click_service_preview_check_box.setText(translate('OpenLP.AdvancedTab', - 'Preview items when clicked in Service Manager')) + 'Preview items when clicked in Service Manager')) self.expand_service_item_check_box.setText(translate('OpenLP.AdvancedTab', 'Expand new service items on creation')) self.enable_auto_close_check_box.setText(translate('OpenLP.AdvancedTab', diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index a90ab1e8b..e75a24d9e 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -211,7 +211,7 @@ class Ui_ServiceManager(object): self.layout.addWidget(self.order_toolbar) # Connect up our signals and slots self.theme_combo_box.activated.connect(self.on_theme_combo_box_selected) - self.service_manager_list.doubleClicked.connect(self.on_make_live) + self.service_manager_list.doubleClicked.connect(self.on_double_click_live) self.service_manager_list.clicked.connect(self.on_single_click_preview) self.service_manager_list.itemCollapsed.connect(self.collapsed) self.service_manager_list.itemExpanded.connect(self.expanded) @@ -320,6 +320,7 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ServiceMa self._modified = False self._file_name = '' self.service_has_all_original_files = True + self.list_double_clicked = False def bootstrap_initialise(self): """ @@ -1455,19 +1456,34 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ServiceMa else: return self.service_items[item]['service_item'] - def on_make_live(self, field=None): + def on_double_click_live(self, field=None): """ Send the current item to the Live slide controller but triggered by a tablewidget click event. :param field: """ + self.list_double_clicked = True self.make_live() def on_single_click_preview(self, field=None): """ - If single click previewing is enabled, send the current item to the Preview slide controller but triggered by a tablewidget click event. + If single click previewing is enabled, and triggered by a tablewidget click event, start a timeout to verify a double-click hasn't triggered. :param field: """ if Settings().value('advanced/single click service preview'): + if not self.list_double_clicked: + # If a double click has not registered start a timer, otherwise wait for the existing timer to finish. + QtCore.QTimer.singleShot(QtWidgets.QApplication.instance().doubleClickInterval(), self.on_single_click_preview_timeout) + + def on_single_click_preview_timeout(self): + """ + If a single click, but not a double click has been triggered, send the current item to the Preview slide controller. + :param field: + """ + if self.list_double_clicked: + # If a double click has registered, clear it. + self.list_double_clicked = False + else: + # Otherwise preview the item. self.make_preview() def make_live(self, row=-1): diff --git a/tests/functional/openlp_core_ui/test_servicemanager.py b/tests/functional/openlp_core_ui/test_servicemanager.py index f013b9ada..f731f7761 100644 --- a/tests/functional/openlp_core_ui/test_servicemanager.py +++ b/tests/functional/openlp_core_ui/test_servicemanager.py @@ -22,6 +22,7 @@ """ Package to test the openlp.core.ui.slidecontroller package. """ +import PyQt5 from unittest import TestCase from openlp.core.common import Registry, ThemeLevel, Settings @@ -540,12 +541,12 @@ class TestServiceManager(TestCase): self.assertEquals(service_manager.timed_slide_interval.setChecked.call_count, 0, 'Should not be called') self.assertEquals(service_manager.theme_menu.menuAction().setVisible.call_count, 1, 'Should have be called once') - + @patch(u'openlp.core.ui.servicemanager.Settings') - @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') - def single_click_preview_test_true(self, mocked_make_preview, MockedSettings): + @patch(u'PyQt5.QtCore.QTimer.singleShot') + def single_click_preview_test_true(self, mocked_singleShot, MockedSettings): """ - Test that when "Preview items when clicked in Service Manager" is enabled that the item goes to preview + Test that when "Preview items when clicked in Service Manager" enabled the preview timer starts """ # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. mocked_settings = MagicMock() @@ -554,14 +555,14 @@ class TestServiceManager(TestCase): service_manager = ServiceManager(None) # WHEN: on_single_click_preview() is called service_manager.on_single_click_preview() - # THEN: make_preview() should have been called - self.assertEquals(mocked_make_preview.call_count, 1, 'Should have been called once') - + # THEN: timer should have been started + mocked_singleShot.assert_called_with(PyQt5.QtWidgets.QApplication.instance().doubleClickInterval(),service_manager.on_single_click_preview_timeout) + @patch(u'openlp.core.ui.servicemanager.Settings') - @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') - def single_click_preview_test_false(self, mocked_make_preview, MockedSettings): + @patch(u'PyQt5.QtCore.QTimer.singleShot') + def single_click_preview_test_false(self, mocked_singleShot, MockedSettings): """ - Test that when "Preview items when clicked in Service Manager" is disabled that the item does not goes to preview + Test that when "Preview items when clicked in Service Manager" disabled the preview timer doesn't start """ # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. mocked_settings = MagicMock() @@ -570,5 +571,49 @@ class TestServiceManager(TestCase): service_manager = ServiceManager(None) # WHEN: on_single_click_preview() is called service_manager.on_single_click_preview() + # THEN: timer should not be started + self.assertEquals(mocked_singleShot.call_count, 0, 'Should not be called') + + @patch(u'openlp.core.ui.servicemanager.Settings') + @patch(u'PyQt5.QtCore.QTimer.singleShot') + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_live') + def single_click_preview_test_double(self, mocked_make_live, mocked_singleShot, MockedSettings): + """ + Test that when a double click has registered the preview timer doesn't start + """ + # GIVEN: A setting to enable "Preview items when clicked in Service Manager" and a service manager. + mocked_settings = MagicMock() + mocked_settings.value.return_value = True + MockedSettings.return_value = mocked_settings + service_manager = ServiceManager(None) + # WHEN: on_single_click_preview() is called following a double click + service_manager.on_double_click_live() + service_manager.on_single_click_preview() + # THEN: timer should not be started + self.assertEquals(mocked_singleShot.call_count, 0, 'Should not be called') + + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') + def single_click_timeout_test_single(self, mocked_make_preview): + """ + Test that when a single click has been registered, the item is sent to preview + """ + # GIVEN: A service manager. + service_manager = ServiceManager(None) + # WHEN: on_single_click_preview() is called + service_manager.on_single_click_preview_timeout() + # THEN: make_preview() should have been called + self.assertEquals(mocked_make_preview.call_count, 1, 'Should have been called once') + + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_preview') + @patch(u'openlp.core.ui.servicemanager.ServiceManager.make_live') + def single_click_timeout_test_double(self, mocked_make_live, mocked_make_preview): + """ + Test that when a double click has been registered, the item does not goes to preview + """ + # GIVEN: A service manager. + service_manager = ServiceManager(None) + # WHEN: on_single_click_preview() is called after a double click + service_manager.on_double_click_live() + service_manager.on_single_click_preview_timeout() # THEN: make_preview() should have been called self.assertEquals(mocked_make_preview.call_count, 0, 'Should not be called') From fbd3f9f3dde455dabfadc6a26f2ae1e2131da5c0 Mon Sep 17 00:00:00 2001 From: Ian Knight Date: Tue, 19 Jan 2016 17:32:47 +1030 Subject: [PATCH 4/5] Corrected pep8 fails --- openlp/core/ui/servicemanager.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index e75a24d9e..fdae5c069 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -1466,17 +1466,19 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ServiceMa def on_single_click_preview(self, field=None): """ - If single click previewing is enabled, and triggered by a tablewidget click event, start a timeout to verify a double-click hasn't triggered. + If single click previewing is enabled, and triggered by a tablewidget click event, + start a timeout to verify a double-click hasn't triggered. :param field: """ if Settings().value('advanced/single click service preview'): if not self.list_double_clicked: # If a double click has not registered start a timer, otherwise wait for the existing timer to finish. - QtCore.QTimer.singleShot(QtWidgets.QApplication.instance().doubleClickInterval(), self.on_single_click_preview_timeout) - + QtCore.QTimer.singleShot(QtWidgets.QApplication.instance().doubleClickInterval(), + self.on_single_click_preview_timeout) + def on_single_click_preview_timeout(self): """ - If a single click, but not a double click has been triggered, send the current item to the Preview slide controller. + If a single click ok, but double click not triggered, send the current item to the Preview slide controller. :param field: """ if self.list_double_clicked: From 3900c33083e695f26996a151043d50450bbf2ad9 Mon Sep 17 00:00:00 2001 From: Ian Knight Date: Tue, 19 Jan 2016 17:39:09 +1030 Subject: [PATCH 5/5] Corrected pep8 fails --- tests/functional/openlp_core_ui/test_servicemanager.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/functional/openlp_core_ui/test_servicemanager.py b/tests/functional/openlp_core_ui/test_servicemanager.py index f731f7761..822703443 100644 --- a/tests/functional/openlp_core_ui/test_servicemanager.py +++ b/tests/functional/openlp_core_ui/test_servicemanager.py @@ -556,7 +556,8 @@ class TestServiceManager(TestCase): # WHEN: on_single_click_preview() is called service_manager.on_single_click_preview() # THEN: timer should have been started - mocked_singleShot.assert_called_with(PyQt5.QtWidgets.QApplication.instance().doubleClickInterval(),service_manager.on_single_click_preview_timeout) + mocked_singleShot.assert_called_with(PyQt5.QtWidgets.QApplication.instance().doubleClickInterval(), + service_manager.on_single_click_preview_timeout) @patch(u'openlp.core.ui.servicemanager.Settings') @patch(u'PyQt5.QtCore.QTimer.singleShot')