Merge lp:~tcf38012/openlp/stretchimage into lp:openlp

[Theodore Frederick]

Add option to ignore aspect ratio and stretch image.

Adds option to ignore aspect ratio and stretch image.

[Tim Bentley (trb143)]

Looks good but all commits need tests to help build up our bank of tests,
These tests ideally should cover the area changed.
If you need help with the tests ask on our IRC channel.

I am wondering if we need a hover text as well as you change will impact Theme backgrounds and Images.

review: Needs Fixing

[lp:~tcf38012/openlp/stretchimage]

2735. By Theodore Frederick on 2017-04-30

Add Tests for Ignoring Aspect Ratio

[Theodore Frederick (tcf38012)]

Everything else seems to be covered by previous tests.

[Raoul Snyman (raoul-snyman)]

Sorry for not coming back to this, but this looks good now.

review: Approve

[Tim Bentley (trb143)]

review: Approve

=== modified file 'openlp/core/common/settings.py'
--- openlp/core/common/settings.py	2017-02-18 07:23:15 +0000
+++ openlp/core/common/settings.py	2017-04-30 17:33:52 +0000
@@ -121,6 +121,7 @@
         'advanced/enable exit confirmation': True,
         'advanced/expand service item': False,
         'advanced/hide mouse': True,
+        'advanced/ignore aspect ratio': False,
         'advanced/is portable': False,
         'advanced/max recent files': 20,
         'advanced/print file meta data': False,

=== modified file 'openlp/core/lib/__init__.py'
--- openlp/core/lib/__init__.py	2016-12-31 11:01:36 +0000
+++ openlp/core/lib/__init__.py	2017-04-30 17:33:52 +0000
@@ -227,7 +227,7 @@
     return image_date <= thumb_date
 
 
-def resize_image(image_path, width, height, background='#000000'):
+def resize_image(image_path, width, height, background='#000000', ignore_aspect_ratio=False):
     """
     Resize an image to fit on the current screen.
 
@@ -244,7 +244,7 @@
     image_ratio = reader.size().width() / reader.size().height()
     resize_ratio = width / height
     # Figure out the size we want to resize the image to (keep aspect ratio).
-    if image_ratio == resize_ratio:
+    if image_ratio == resize_ratio or ignore_aspect_ratio:
         size = QtCore.QSize(width, height)
     elif image_ratio < resize_ratio:
         # Use the image's height as reference for the new size.

=== modified file 'openlp/core/lib/imagemanager.py'
--- openlp/core/lib/imagemanager.py	2016-12-31 11:01:36 +0000
+++ openlp/core/lib/imagemanager.py	2017-04-30 17:33:52 +0000
@@ -31,7 +31,7 @@
 
 from PyQt5 import QtCore
 
-from openlp.core.common import Registry
+from openlp.core.common import Registry, Settings
 from openlp.core.lib import ScreenList, resize_image, image_to_byte
 
 log = logging.getLogger(__name__)
@@ -306,7 +306,8 @@
             # Let's see if the image was requested with specific dimensions
             width = self.width if image.width == -1 else image.width
             height = self.height if image.height == -1 else image.height
-            image.image = resize_image(image.path, width, height, image.background)
+            image.image = resize_image(image.path, width, height, image.background,
+                                       Settings().value('advanced/ignore aspect ratio'))
             # Set the priority to Lowest and stop here as we need to process more important images first.
             if image.priority == Priority.Normal:
                 self._conversion_queue.modify_priority(image, Priority.Lowest)

=== modified file 'openlp/core/ui/advancedtab.py'
--- openlp/core/ui/advancedtab.py	2016-12-31 11:01:36 +0000
+++ openlp/core/ui/advancedtab.py	2017-04-30 17:33:52 +0000
@@ -224,6 +224,9 @@
         self.display_workaround_group_box.setObjectName('display_workaround_group_box')
         self.display_workaround_layout = QtWidgets.QVBoxLayout(self.display_workaround_group_box)
         self.display_workaround_layout.setObjectName('display_workaround_layout')
+        self.ignore_aspect_ratio_check_box = QtWidgets.QCheckBox(self.display_workaround_group_box)
+        self.ignore_aspect_ratio_check_box.setObjectName('ignore_aspect_ratio_check_box')
+        self.display_workaround_layout.addWidget(self.ignore_aspect_ratio_check_box)
         self.x11_bypass_check_box = QtWidgets.QCheckBox(self.display_workaround_group_box)
         self.x11_bypass_check_box.setObjectName('x11_bypass_check_box')
         self.display_workaround_layout.addWidget(self.x11_bypass_check_box)
@@ -333,6 +336,7 @@
             translate('OpenLP.AdvancedTab', '<strong>WARNING:</strong> New data directory location contains '
                       'OpenLP data files.  These files WILL be replaced during a copy.'))
         self.display_workaround_group_box.setTitle(translate('OpenLP.AdvancedTab', 'Display Workarounds'))
+        self.ignore_aspect_ratio_check_box.setText(translate('OpenLP.AdvancedTab', 'Ignore Aspect Ratio'))
         self.x11_bypass_check_box.setText(translate('OpenLP.AdvancedTab', 'Bypass X11 Window Manager'))
         self.alternate_rows_check_box.setText(translate('OpenLP.AdvancedTab', 'Use alternating row colours in lists'))
         # Slide Limits
@@ -377,6 +381,7 @@
         default_service_enabled = settings.value('default service enabled')
         self.service_name_check_box.setChecked(default_service_enabled)
         self.service_name_check_box_toggled(default_service_enabled)
+        self.ignore_aspect_ratio_check_box.setChecked(settings.value('ignore aspect ratio'))
         self.x11_bypass_check_box.setChecked(settings.value('x11 bypass wm'))
         self.slide_limits = settings.value('slide limits')
         self.is_search_as_you_type_enabled = settings.value('search as type')
@@ -433,6 +438,7 @@
         settings.setValue('hide mouse', self.hide_mouse_check_box.isChecked())
         settings.setValue('alternate rows', self.alternate_rows_check_box.isChecked())
         settings.setValue('slide limits', self.slide_limits)
+        settings.setValue('ignore aspect ratio', self.ignore_aspect_ratio_check_box.isChecked())
         if self.x11_bypass_check_box.isChecked() != settings.value('x11 bypass wm'):
             settings.setValue('x11 bypass wm', self.x11_bypass_check_box.isChecked())
             self.settings_form.register_post_process('config_screen_changed')

=== modified file 'tests/functional/openlp_core_lib/test_lib.py'
--- tests/functional/openlp_core_lib/test_lib.py	2016-12-31 11:01:36 +0000
+++ tests/functional/openlp_core_lib/test_lib.py	2017-04-30 17:33:52 +0000
@@ -672,6 +672,27 @@
         self.assertEqual(wanted_width, result_size.width(), 'The image should have the requested width.')
         self.assertEqual(image.pixel(0, 0), wanted_background_rgb, 'The background should be white.')
 
+    def test_resize_thumb_ignoring_aspect_ratio(self):
+        """
+        Test the resize_thumb() function ignoring aspect ratio
+        """
+        # GIVEN: A path to an image.
+        image_path = os.path.join(TEST_PATH, 'church.jpg')
+        wanted_width = 1000
+        wanted_height = 1000
+        # We want the background to be white.
+        wanted_background_hex = '#FFFFFF'
+        wanted_background_rgb = QtGui.QColor(wanted_background_hex).rgb()
+
+        # WHEN: Resize the image and add a background.
+        image = resize_image(image_path, wanted_width, wanted_height, wanted_background_hex, True)
+
+        # THEN: Check if the size is correct and the background was set.
+        result_size = image.size()
+        self.assertEqual(wanted_height, result_size.height(), 'The image should have the requested height.')
+        self.assertEqual(wanted_width, result_size.width(), 'The image should have the requested width.')
+        self.assertEqual(image.pixel(0, 0), wanted_background_rgb, 'The background should be white.')
+
     def test_create_separated_list_qlocate(self):
         """
         Test the create_separated_list function using the Qt provided method