From 48a87780d4e11e049bd1ae80bfdc0e1092494193 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 13 May 2017 08:47:22 +0100 Subject: [PATCH 01/14] theme clean up --- openlp/core/common/__init__.py | 10 + openlp/core/lib/theme.py | 515 +++++++++--------- openlp/core/ui/thememanager.py | 36 +- .../functional/openlp_core_lib/test_theme.py | 51 +- 4 files changed, 330 insertions(+), 282 deletions(-) diff --git a/openlp/core/common/__init__.py b/openlp/core/common/__init__.py index b7d38ad4f..ac61d9519 100644 --- a/openlp/core/common/__init__.py +++ b/openlp/core/common/__init__.py @@ -438,3 +438,13 @@ def get_file_encoding(filename): return detector.result except OSError: log.exception('Error detecting file encoding') + + +def json_default(o): + """ + Function to help save objects as JSON + + :param o: object + :return: the object dictionary + """ + return o.__dict__ diff --git a/openlp/core/lib/theme.py b/openlp/core/lib/theme.py index 421086e2b..a4397ea0f 100644 --- a/openlp/core/lib/theme.py +++ b/openlp/core/lib/theme.py @@ -150,7 +150,7 @@ INTEGER_LIST = ['size', 'line_adjustment', 'x', 'height', 'y', 'width', 'shadow_ 'horizontal_align', 'vertical_align', 'wrap_style'] -class ThemeXML(object): +class Theme(object): """ A class to encapsulate the Theme XML. """ @@ -195,183 +195,183 @@ class ThemeXML(object): self.background_filename = self.background_filename.strip() self.background_filename = os.path.join(path, self.theme_name, self.background_filename) - def _new_document(self, name): - """ - Create a new theme XML document. - """ - self.theme_xml = Document() - self.theme = self.theme_xml.createElement('theme') - self.theme_xml.appendChild(self.theme) - self.theme.setAttribute('version', '2.0') - self.name = self.theme_xml.createElement('name') - text_node = self.theme_xml.createTextNode(name) - self.name.appendChild(text_node) - self.theme.appendChild(self.name) + # def _new_document(self, name): + # """ + # Create a new theme XML document. + # """ + # self.theme_xml = Document() + # self.theme = self.theme_xml.createElement('theme') + # self.theme_xml.appendChild(self.theme) + # self.theme.setAttribute('version', '2.0') + # self.name = self.theme_xml.createElement('name') + # text_node = self.theme_xml.createTextNode(name) + # self.name.appendChild(text_node) + # self.theme.appendChild(self.name) - def add_background_transparent(self): - """ - Add a transparent background. - """ - background = self.theme_xml.createElement('background') - background.setAttribute('type', 'transparent') - self.theme.appendChild(background) + # def add_background_transparent(self): + # """ + # Add a transparent background. + # """ + # background = self.theme_xml.createElement('background') + # background.setAttribute('type', 'transparent') + # self.theme.appendChild(background) - def add_background_solid(self, bkcolor): - """ - Add a Solid background. + # def add_background_solid(self, bkcolor): + # """ + # Add a Solid background. + # + # :param bkcolor: The color of the background. + # """ + # background = self.theme_xml.createElement('background') + # background.setAttribute('type', 'solid') + # self.theme.appendChild(background) + # self.child_element(background, 'color', str(bkcolor)) - :param bkcolor: The color of the background. - """ - background = self.theme_xml.createElement('background') - background.setAttribute('type', 'solid') - self.theme.appendChild(background) - self.child_element(background, 'color', str(bkcolor)) + # def add_background_gradient(self, startcolor, endcolor, direction): + # """ + # Add a gradient background. + # + # :param startcolor: The gradient's starting colour. + # :param endcolor: The gradient's ending colour. + # :param direction: The direction of the gradient. + # """ + # background = self.theme_xml.createElement('background') + # background.setAttribute('type', 'gradient') + # self.theme.appendChild(background) + # # Create startColor element + # self.child_element(background, 'startColor', str(startcolor)) + # # Create endColor element + # self.child_element(background, 'endColor', str(endcolor)) + # # Create direction element + # self.child_element(background, 'direction', str(direction)) - def add_background_gradient(self, startcolor, endcolor, direction): - """ - Add a gradient background. + # def add_background_image(self, filename, border_color): + # """ + # Add a image background. + # + # :param filename: The file name of the image. + # :param border_color: + # """ + # background = self.theme_xml.createElement('background') + # background.setAttribute('type', 'image') + # self.theme.appendChild(background) + # # Create Filename element + # self.child_element(background, 'filename', filename) + # # Create endColor element + # self.child_element(background, 'borderColor', str(border_color)) + # + # def add_background_video(self, filename, border_color): + # """ + # Add a video background. + # + # :param filename: The file name of the video. + # :param border_color: + # """ + # background = self.theme_xml.createElement('background') + # background.setAttribute('type', 'video') + # self.theme.appendChild(background) + # # Create Filename element + # self.child_element(background, 'filename', filename) + # # Create endColor element + # self.child_element(background, 'borderColor', str(border_color)) - :param startcolor: The gradient's starting colour. - :param endcolor: The gradient's ending colour. - :param direction: The direction of the gradient. - """ - background = self.theme_xml.createElement('background') - background.setAttribute('type', 'gradient') - self.theme.appendChild(background) - # Create startColor element - self.child_element(background, 'startColor', str(startcolor)) - # Create endColor element - self.child_element(background, 'endColor', str(endcolor)) - # Create direction element - self.child_element(background, 'direction', str(direction)) - - def add_background_image(self, filename, border_color): - """ - Add a image background. - - :param filename: The file name of the image. - :param border_color: - """ - background = self.theme_xml.createElement('background') - background.setAttribute('type', 'image') - self.theme.appendChild(background) - # Create Filename element - self.child_element(background, 'filename', filename) - # Create endColor element - self.child_element(background, 'borderColor', str(border_color)) - - def add_background_video(self, filename, border_color): - """ - Add a video background. - - :param filename: The file name of the video. - :param border_color: - """ - background = self.theme_xml.createElement('background') - background.setAttribute('type', 'video') - self.theme.appendChild(background) - # Create Filename element - self.child_element(background, 'filename', filename) - # Create endColor element - self.child_element(background, 'borderColor', str(border_color)) - - def add_font(self, name, color, size, override, fonttype='main', bold='False', italics='False', - line_adjustment=0, xpos=0, ypos=0, width=0, height=0, outline='False', outline_color='#ffffff', - outline_pixel=2, shadow='False', shadow_color='#ffffff', shadow_pixel=5): - """ - Add a Font. - - :param name: The name of the font. - :param color: The colour of the font. - :param size: The size of the font. - :param override: Whether or not to override the default positioning of the theme. - :param fonttype: The type of font, ``main`` or ``footer``. Defaults to ``main``. - :param bold: - :param italics: The weight of then font Defaults to 50 Normal - :param line_adjustment: Does the font render to italics Defaults to 0 Normal - :param xpos: The X position of the text block. - :param ypos: The Y position of the text block. - :param width: The width of the text block. - :param height: The height of the text block. - :param outline: Whether or not to show an outline. - :param outline_color: The colour of the outline. - :param outline_pixel: How big the Shadow is - :param shadow: Whether or not to show a shadow. - :param shadow_color: The colour of the shadow. - :param shadow_pixel: How big the Shadow is - """ - background = self.theme_xml.createElement('font') - background.setAttribute('type', fonttype) - self.theme.appendChild(background) - # Create Font name element - self.child_element(background, 'name', name) - # Create Font color element - self.child_element(background, 'color', str(color)) - # Create Proportion name element - self.child_element(background, 'size', str(size)) - # Create weight name element - self.child_element(background, 'bold', str(bold)) - # Create italics name element - self.child_element(background, 'italics', str(italics)) - # Create indentation name element - self.child_element(background, 'line_adjustment', str(line_adjustment)) - # Create Location element - element = self.theme_xml.createElement('location') - element.setAttribute('override', str(override)) - element.setAttribute('x', str(xpos)) - element.setAttribute('y', str(ypos)) - element.setAttribute('width', str(width)) - element.setAttribute('height', str(height)) - background.appendChild(element) - # Shadow - element = self.theme_xml.createElement('shadow') - element.setAttribute('shadowColor', str(shadow_color)) - element.setAttribute('shadowSize', str(shadow_pixel)) - value = self.theme_xml.createTextNode(str(shadow)) - element.appendChild(value) - background.appendChild(element) - # Outline - element = self.theme_xml.createElement('outline') - element.setAttribute('outlineColor', str(outline_color)) - element.setAttribute('outlineSize', str(outline_pixel)) - value = self.theme_xml.createTextNode(str(outline)) - element.appendChild(value) - background.appendChild(element) - - def add_display(self, horizontal, vertical, transition): - """ - Add a Display options. - - :param horizontal: The horizontal alignment of the text. - :param vertical: The vertical alignment of the text. - :param transition: Whether the slide transition is active. - """ - background = self.theme_xml.createElement('display') - self.theme.appendChild(background) - # Horizontal alignment - element = self.theme_xml.createElement('horizontalAlign') - value = self.theme_xml.createTextNode(str(horizontal)) - element.appendChild(value) - background.appendChild(element) - # Vertical alignment - element = self.theme_xml.createElement('verticalAlign') - value = self.theme_xml.createTextNode(str(vertical)) - element.appendChild(value) - background.appendChild(element) - # Slide Transition - element = self.theme_xml.createElement('slideTransition') - value = self.theme_xml.createTextNode(str(transition)) - element.appendChild(value) - background.appendChild(element) - - def child_element(self, element, tag, value): - """ - Generic child element creator. - """ - child = self.theme_xml.createElement(tag) - child.appendChild(self.theme_xml.createTextNode(value)) - element.appendChild(child) - return child + # def add_font(self, name, color, size, override, fonttype='main', bold='False', italics='False', + # line_adjustment=0, xpos=0, ypos=0, width=0, height=0, outline='False', outline_color='#ffffff', + # outline_pixel=2, shadow='False', shadow_color='#ffffff', shadow_pixel=5): + # """ + # Add a Font. + # + # :param name: The name of the font. + # :param color: The colour of the font. + # :param size: The size of the font. + # :param override: Whether or not to override the default positioning of the theme. + # :param fonttype: The type of font, ``main`` or ``footer``. Defaults to ``main``. + # :param bold: + # :param italics: The weight of then font Defaults to 50 Normal + # :param line_adjustment: Does the font render to italics Defaults to 0 Normal + # :param xpos: The X position of the text block. + # :param ypos: The Y position of the text block. + # :param width: The width of the text block. + # :param height: The height of the text block. + # :param outline: Whether or not to show an outline. + # :param outline_color: The colour of the outline. + # :param outline_pixel: How big the Shadow is + # :param shadow: Whether or not to show a shadow. + # :param shadow_color: The colour of the shadow. + # :param shadow_pixel: How big the Shadow is + # """ + # background = self.theme_xml.createElement('font') + # background.setAttribute('type', fonttype) + # self.theme.appendChild(background) + # # Create Font name element + # self.child_element(background, 'name', name) + # # Create Font color element + # self.child_element(background, 'color', str(color)) + # # Create Proportion name element + # self.child_element(background, 'size', str(size)) + # # Create weight name element + # self.child_element(background, 'bold', str(bold)) + # # Create italics name element + # self.child_element(background, 'italics', str(italics)) + # # Create indentation name element + # self.child_element(background, 'line_adjustment', str(line_adjustment)) + # # Create Location element + # element = self.theme_xml.createElement('location') + # element.setAttribute('override', str(override)) + # element.setAttribute('x', str(xpos)) + # element.setAttribute('y', str(ypos)) + # element.setAttribute('width', str(width)) + # element.setAttribute('height', str(height)) + # background.appendChild(element) + # # Shadow + # element = self.theme_xml.createElement('shadow') + # element.setAttribute('shadowColor', str(shadow_color)) + # element.setAttribute('shadowSize', str(shadow_pixel)) + # value = self.theme_xml.createTextNode(str(shadow)) + # element.appendChild(value) + # background.appendChild(element) + # # Outline + # element = self.theme_xml.createElement('outline') + # element.setAttribute('outlineColor', str(outline_color)) + # element.setAttribute('outlineSize', str(outline_pixel)) + # value = self.theme_xml.createTextNode(str(outline)) + # element.appendChild(value) + # background.appendChild(element) + # + # def add_display(self, horizontal, vertical, transition): + # """ + # Add a Display options. + # + # :param horizontal: The horizontal alignment of the text. + # :param vertical: The vertical alignment of the text. + # :param transition: Whether the slide transition is active. + # """ + # background = self.theme_xml.createElement('display') + # self.theme.appendChild(background) + # # Horizontal alignment + # element = self.theme_xml.createElement('horizontalAlign') + # value = self.theme_xml.createTextNode(str(horizontal)) + # element.appendChild(value) + # background.appendChild(element) + # # Vertical alignment + # element = self.theme_xml.createElement('verticalAlign') + # value = self.theme_xml.createTextNode(str(vertical)) + # element.appendChild(value) + # background.appendChild(element) + # # Slide Transition + # element = self.theme_xml.createElement('slideTransition') + # value = self.theme_xml.createTextNode(str(transition)) + # element.appendChild(value) + # background.appendChild(element) + # + # def child_element(self, element, tag, value): + # """ + # Generic child element creator. + # """ + # child = self.theme_xml.createElement(tag) + # child.appendChild(self.theme_xml.createTextNode(value)) + # element.appendChild(child) + # return child def set_default_header_footer(self): """ @@ -386,25 +386,34 @@ class ThemeXML(object): self.font_footer_y = current_screen['size'].height() * 9 / 10 self.font_footer_height = current_screen['size'].height() / 10 - def dump_xml(self): - """ - Dump the XML to file used for debugging - """ - return self.theme_xml.toprettyxml(indent=' ') + # def dump_xml(self): + # """ + # Dump the XML to file used for debugging + # """ + # return self.theme_xml.toprettyxml(indent=' ') - def extract_xml(self): - """ - Print out the XML string. - """ - self._build_xml_from_attrs() - return self.theme_xml.toxml('utf-8').decode('utf-8') + # def extract_xml(self): + # """ + # Print out the XML string. + # """ + # self._build_xml_from_attrs() + # return self.theme_xml.toxml('utf-8').decode('utf-8') + # + # def extract_formatted_xml(self): + # """ + # Pull out the XML string formatted for human consumption + # """ + # self._build_xml_from_attrs() + # return self.theme_xml.toprettyxml(indent=' ', newl='\n', encoding='utf-8') - def extract_formatted_xml(self): + def load_theme(self, theme): """ Pull out the XML string formatted for human consumption + + :param theme: the theme string """ - self._build_xml_from_attrs() - return self.theme_xml.toprettyxml(indent=' ', newl='\n', encoding='utf-8') + jsn = json.loads(theme) + self.expand_json(jsn) def parse(self, xml): """ @@ -461,7 +470,8 @@ class ThemeXML(object): if element.tag == 'name': self._create_attr('theme', element.tag, element.text) - def _translate_tags(self, master, element, value): + @staticmethod + def _translate_tags(master, element, value): """ Clean up XML removing and redefining tags """ @@ -514,71 +524,70 @@ class ThemeXML(object): theme_strings = [] for key in dir(self): if key[0:1] != '_': - # TODO: Due to bound methods returned, I don't know how to write a proper test theme_strings.append('{key:>30}: {value}'.format(key=key, value=getattr(self, key))) return '\n'.join(theme_strings) - def _build_xml_from_attrs(self): - """ - Build the XML from the varables in the object - """ - self._new_document(self.theme_name) - if self.background_type == BackgroundType.to_string(BackgroundType.Solid): - self.add_background_solid(self.background_color) - elif self.background_type == BackgroundType.to_string(BackgroundType.Gradient): - self.add_background_gradient( - self.background_start_color, - self.background_end_color, - self.background_direction - ) - elif self.background_type == BackgroundType.to_string(BackgroundType.Image): - filename = os.path.split(self.background_filename)[1] - self.add_background_image(filename, self.background_border_color) - elif self.background_type == BackgroundType.to_string(BackgroundType.Video): - filename = os.path.split(self.background_filename)[1] - self.add_background_video(filename, self.background_border_color) - elif self.background_type == BackgroundType.to_string(BackgroundType.Transparent): - self.add_background_transparent() - self.add_font( - self.font_main_name, - self.font_main_color, - self.font_main_size, - self.font_main_override, 'main', - self.font_main_bold, - self.font_main_italics, - self.font_main_line_adjustment, - self.font_main_x, - self.font_main_y, - self.font_main_width, - self.font_main_height, - self.font_main_outline, - self.font_main_outline_color, - self.font_main_outline_size, - self.font_main_shadow, - self.font_main_shadow_color, - self.font_main_shadow_size - ) - self.add_font( - self.font_footer_name, - self.font_footer_color, - self.font_footer_size, - self.font_footer_override, 'footer', - self.font_footer_bold, - self.font_footer_italics, - 0, # line adjustment - self.font_footer_x, - self.font_footer_y, - self.font_footer_width, - self.font_footer_height, - self.font_footer_outline, - self.font_footer_outline_color, - self.font_footer_outline_size, - self.font_footer_shadow, - self.font_footer_shadow_color, - self.font_footer_shadow_size - ) - self.add_display( - self.display_horizontal_align, - self.display_vertical_align, - self.display_slide_transition - ) + # def _build_xml_from_attrs(self): + # """ + # Build the XML from the varables in the object + # """ + # self._new_document(self.theme_name) + # if self.background_type == BackgroundType.to_string(BackgroundType.Solid): + # self.add_background_solid(self.background_color) + # elif self.background_type == BackgroundType.to_string(BackgroundType.Gradient): + # self.add_background_gradient( + # self.background_start_color, + # self.background_end_color, + # self.background_direction + # ) + # elif self.background_type == BackgroundType.to_string(BackgroundType.Image): + # filename = os.path.split(self.background_filename)[1] + # self.add_background_image(filename, self.background_border_color) + # elif self.background_type == BackgroundType.to_string(BackgroundType.Video): + # filename = os.path.split(self.background_filename)[1] + # self.add_background_video(filename, self.background_border_color) + # elif self.background_type == BackgroundType.to_string(BackgroundType.Transparent): + # self.add_background_transparent() + # self.add_font( + # self.font_main_name, + # self.font_main_color, + # self.font_main_size, + # self.font_main_override, 'main', + # self.font_main_bold, + # self.font_main_italics, + # self.font_main_line_adjustment, + # self.font_main_x, + # self.font_main_y, + # self.font_main_width, + # self.font_main_height, + # self.font_main_outline, + # self.font_main_outline_color, + # self.font_main_outline_size, + # self.font_main_shadow, + # self.font_main_shadow_color, + # self.font_main_shadow_size + # ) + # self.add_font( + # self.font_footer_name, + # self.font_footer_color, + # self.font_footer_size, + # self.font_footer_override, 'footer', + # self.font_footer_bold, + # self.font_footer_italics, + # 0, # line adjustment + # self.font_footer_x, + # self.font_footer_y, + # self.font_footer_width, + # self.font_footer_height, + # self.font_footer_outline, + # self.font_footer_outline_color, + # self.font_footer_outline_size, + # self.font_footer_shadow, + # self.font_footer_shadow_color, + # self.font_footer_shadow_size + # ) + # self.add_display( + # self.display_horizontal_align, + # self.display_vertical_align, + # self.display_slide_transition + # ) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index f5eca3656..ba31d1954 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -22,6 +22,7 @@ """ The Theme Manager manages adding, deleteing and modifying of themes. """ +import json import os import zipfile import shutil @@ -30,10 +31,10 @@ from xml.etree.ElementTree import ElementTree, XML from PyQt5 import QtCore, QtGui, QtWidgets from openlp.core.common import Registry, RegistryProperties, AppLocation, Settings, OpenLPMixin, RegistryMixin, \ - check_directory_exists, UiStrings, translate, is_win, get_filesystem_encoding, delete_file + check_directory_exists, UiStrings, translate, is_win, get_filesystem_encoding, delete_file, json_default from openlp.core.lib import FileDialog, ImageSource, ValidationError, get_text_file_string, build_icon, \ check_item_selected, create_thumb, validate_thumb -from openlp.core.lib.theme import ThemeXML, BackgroundType +from openlp.core.lib.theme import Theme, BackgroundType from openlp.core.lib.ui import critical_error_message_box, create_widget_action from openlp.core.ui import FileRenameForm, ThemeForm from openlp.core.ui.lib import OpenLPToolbar @@ -245,7 +246,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage their customisations. :param field: """ - theme = ThemeXML() + theme = Theme() theme.set_default_header_footer() self.theme_form.theme = theme self.theme_form.exec() @@ -452,7 +453,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage files = AppLocation.get_files(self.settings_section, '.png') # No themes have been found so create one if not files: - theme = ThemeXML() + theme = Theme() theme.theme_name = UiStrings().Default self._write_theme(theme, None, None) Settings().setValue(self.settings_section + '/global theme', theme.theme_name) @@ -515,7 +516,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage xml = get_text_file_string(xml_file) if not xml: self.log_debug('No theme data - using default theme') - return ThemeXML() + return Theme() else: return self._create_theme_from_xml(xml, self.path) @@ -646,16 +647,16 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage :param image_to: Where the Theme Image is to be saved to """ name = theme.theme_name - theme_pretty_xml = theme.extract_formatted_xml() + theme_pretty = json.dumps(theme, default=json_default) theme_dir = os.path.join(self.path, name) check_directory_exists(theme_dir) - theme_file = os.path.join(theme_dir, name + '.xml') + theme_file = os.path.join(theme_dir, name + '.json') if self.old_background_image and image_to != self.old_background_image: delete_file(self.old_background_image) out_file = None try: out_file = open(theme_file, 'w', encoding='utf-8') - out_file.write(theme_pretty_xml.decode('utf-8')) + out_file.write(theme_pretty) except IOError: self.log_exception('Saving theme to file failed') finally: @@ -717,7 +718,8 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage """ return os.path.join(self.path, theme + '.png') - def _create_theme_from_xml(self, theme_xml, image_path): + @staticmethod + def _create_theme_from_xml(theme_xml, image_path): """ Return a theme object using information parsed from XML @@ -725,11 +727,25 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage :param image_path: Where the theme image is stored :return: Theme data. """ - theme = ThemeXML() + theme = Theme() theme.parse(theme_xml) theme.extend_image_filename(image_path) return theme + @staticmethod + def _create_theme_from_json(theme_json, image_path): + """ + Return a theme object using information parsed from JSON + + :param theme_json: The Theme data object. + :param image_path: Where the theme image is stored + :return: Theme data. + """ + theme = Theme() + theme.load_theme(theme_json) + theme.extend_image_filename(image_path) + return theme + def _validate_theme_action(self, select_text, confirm_title, confirm_text, test_plugin=True, confirm=True): """ Check to see if theme has been selected and the destructive action is allowed. diff --git a/tests/functional/openlp_core_lib/test_theme.py b/tests/functional/openlp_core_lib/test_theme.py index 7401698d9..04a31c5d5 100644 --- a/tests/functional/openlp_core_lib/test_theme.py +++ b/tests/functional/openlp_core_lib/test_theme.py @@ -22,39 +22,35 @@ """ Package to test the openlp.core.lib.theme package. """ +import json from unittest import TestCase import os -from openlp.core.lib.theme import ThemeXML +from openlp.core.common import json_default +from openlp.core.lib.theme import Theme -class TestThemeXML(TestCase): +class TestTheme(TestCase): """ - Test the ThemeXML class + Test the ThemeL class """ def test_new_theme(self): """ - Test the ThemeXML constructor + Test the Theme constructor """ # GIVEN: The ThemeXML class # WHEN: A theme object is created - default_theme = ThemeXML() + default_theme = Theme() # THEN: The default values should be correct - self.assertEqual('#000000', default_theme.background_border_color, - 'background_border_color should be "#000000"') - self.assertEqual('solid', default_theme.background_type, 'background_type should be "solid"') - self.assertEqual(0, default_theme.display_vertical_align, 'display_vertical_align should be 0') - self.assertEqual('Arial', default_theme.font_footer_name, 'font_footer_name should be "Arial"') - self.assertFalse(default_theme.font_main_bold, 'font_main_bold should be False') - self.assertEqual(47, len(default_theme.__dict__), 'The theme should have 47 attributes') + self.check_theme(default_theme) def test_expand_json(self): """ Test the expand_json method """ # GIVEN: A ThemeXML object and some JSON to "expand" - theme = ThemeXML() + theme = Theme() theme_json = { 'background': { 'border_color': '#000000', @@ -77,18 +73,14 @@ class TestThemeXML(TestCase): theme.expand_json(theme_json) # THEN: The attributes should be set on the object - self.assertEqual('#000000', theme.background_border_color, 'background_border_color should be "#000000"') - self.assertEqual('solid', theme.background_type, 'background_type should be "solid"') - self.assertEqual(0, theme.display_vertical_align, 'display_vertical_align should be 0') - self.assertFalse(theme.font_footer_bold, 'font_footer_bold should be False') - self.assertEqual('Arial', theme.font_main_name, 'font_main_name should be "Arial"') + self.check_theme(theme) def test_extend_image_filename(self): """ Test the extend_image_filename method """ # GIVEN: A theme object - theme = ThemeXML() + theme = Theme() theme.theme_name = 'MyBeautifulTheme ' theme.background_filename = ' video.mp4' theme.background_type = 'video' @@ -101,3 +93,24 @@ class TestThemeXML(TestCase): expected_filename = os.path.join(path, 'MyBeautifulTheme', 'video.mp4') self.assertEqual(expected_filename, theme.background_filename) self.assertEqual('MyBeautifulTheme', theme.theme_name) + + def test_save_retrieve(self): + """ + Load a dummy theme, save it and reload it + """ + # GIVEN: The default Theme class + # WHEN: A theme object is created + default_theme = Theme() + # THEN: The default values should be correct + save_theme_json = json.dumps(default_theme, default=json_default) + lt = Theme() + lt.load_theme(save_theme_json) + self.check_theme(lt) + + def check_theme(self, theme): + self.assertEqual('#000000', theme.background_border_color, 'background_border_color should be "#000000"') + self.assertEqual('solid', theme.background_type, 'background_type should be "solid"') + self.assertEqual(0, theme.display_vertical_align, 'display_vertical_align should be 0') + self.assertFalse(theme.font_footer_bold, 'font_footer_bold should be False') + self.assertEqual('Arial', theme.font_main_name, 'font_main_name should be "Arial"') + self.assertEqual(47, len(theme.__dict__), 'The theme should have 47 attributes') From 3d1be586fefc45c88a66b7757e1e6f7ac661c943 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 13 May 2017 09:22:48 +0100 Subject: [PATCH 02/14] fix editing themes --- openlp/core/ui/thememanager.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index ba31d1954..c02be62e2 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -512,13 +512,20 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage :return: The theme object. """ self.log_debug('get theme data for theme {name}'.format(name=theme_name)) - xml_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.xml') - xml = get_text_file_string(xml_file) - if not xml: + theme_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.json') + jsn = True + if not theme_file: + theme_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.xml') + jsn = False + theme_data = get_text_file_string(theme_file) + if not theme_data: self.log_debug('No theme data - using default theme') return Theme() else: - return self._create_theme_from_xml(xml, self.path) + if jsn: + return self._create_theme_from_json(theme_data, self.path) + else: + return self._create_theme_from_xml(theme_data, self.path) def over_write_message_box(self, theme_name): """ From 08a58844c6aead18167af2aa4d579dada9e7629b Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 13 May 2017 09:37:38 +0100 Subject: [PATCH 03/14] fix editing theme load and save --- openlp/core/ui/thememanager.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index c02be62e2..d6d05d1bb 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -513,11 +513,12 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage """ self.log_debug('get theme data for theme {name}'.format(name=theme_name)) theme_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.json') - jsn = True - if not theme_file: - theme_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.xml') - jsn = False theme_data = get_text_file_string(theme_file) + jsn = True + if not theme_data: + theme_file = os.path.join(self.path, str(theme_name), str(theme_name) + '.xml') + theme_data = get_text_file_string(theme_file) + jsn = False if not theme_data: self.log_debug('No theme data - using default theme') return Theme() From fa89be414cfc0e769bd1f18d830cea61b61fecfe Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 May 2017 08:11:36 +0100 Subject: [PATCH 04/14] Clean up theme export --- openlp/core/ui/servicemanager.py | 2 +- openlp/core/ui/thememanager.py | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index a5da351c7..cf30245bf 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -698,7 +698,7 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ServiceMa translate('OpenLP.ServiceManager', 'OpenLP Service Files (*.osz);; OpenLP Service Files - lite (*.oszl)')) else: - file_name, filter_uesd = QtWidgets.QFileDialog.getSaveFileName( + file_name, filter_used = QtWidgets.QFileDialog.getSaveFileName( self.main_window, UiStrings().SaveService, path, translate('OpenLP.ServiceManager', 'OpenLP Service Files (*.osz);;')) if not file_name: diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index d6d05d1bb..415b4b726 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -379,11 +379,10 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage critical_error_message_box(message=translate('OpenLP.ThemeManager', 'You have not selected a theme.')) return theme = item.data(QtCore.Qt.UserRole) - path = QtWidgets.QFileDialog.getExistingDirectory(self, - translate('OpenLP.ThemeManager', - 'Save Theme - ({name})').format(name=theme), - Settings().value(self.settings_section + - '/last directory export')) + path, filter_used = QtWidgets.QFileDialog.getSaveFileName(self.main_window, + translate('OpenLP.ThemeManager', 'Save Theme - ({name})').format(name=theme), + Settings().value(self.settings_section + '/last directory export'), + translate('OpenLP.ThemeManager', 'OpenLP Themes (*.otz)')) self.application.set_busy_cursor() if path: Settings().setValue(self.settings_section + '/last directory export', path) @@ -394,13 +393,12 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage 'Your theme has been successfully exported.')) self.application.set_normal_cursor() - def _export_theme(self, path, theme): + def _export_theme(self, theme_path, theme): """ Create the zipfile with the theme contents. - :param path: Location where the zip file will be placed + :param theme_path: Location where the zip file will be placed :param theme: The name of the theme to be exported """ - theme_path = os.path.join(path, theme + '.otz') theme_zip = None try: theme_zip = zipfile.ZipFile(theme_path, 'w') From 0387286a93db53d8c3583d9bfd1140b2ec80a687 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 May 2017 16:30:02 +0100 Subject: [PATCH 05/14] fix up import functionality --- openlp/core/ui/thememanager.py | 35 ++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index 415b4b726..c8b2eaa38 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -556,16 +556,24 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage abort_import = True try: theme_zip = zipfile.ZipFile(file_name) - xml_file = [name for name in theme_zip.namelist() if os.path.splitext(name)[1].lower() == '.xml'] - if len(xml_file) != 1: - self.log_error('Theme contains "{val:d}" XML files'.format(val=len(xml_file))) - raise ValidationError - xml_tree = ElementTree(element=XML(theme_zip.read(xml_file[0]))).getroot() - theme_version = xml_tree.get('version', default=None) - if not theme_version or float(theme_version) < 2.0: - self.log_error('Theme version is less than 2.0') - raise ValidationError - theme_name = xml_tree.find('name').text.strip() + json_theme = False + json_file = [name for name in theme_zip.namelist() if os.path.splitext(name)[1].lower() == '.json'] + if len(json_file) != 1: + xml_file = [name for name in theme_zip.namelist() if os.path.splitext(name)[1].lower() == '.xml'] + if len(xml_file) != 1: + self.log_error('Theme contains "{val:d}" theme files'.format(val=len(xml_file))) + raise ValidationError + xml_tree = ElementTree(element=XML(theme_zip.read(xml_file[0]))).getroot() + theme_version = xml_tree.get('version', default=None) + if not theme_version or float(theme_version) < 2.0: + self.log_error('Theme version is less than 2.0') + raise ValidationError + theme_name = xml_tree.find('name').text.strip() + else: + theme = Theme() + theme.load_theme(theme_zip.read(json_file[0]).decode("utf-8")) + theme_name = theme.theme_name + json_theme = True theme_folder = os.path.join(directory, theme_name) theme_exists = os.path.exists(theme_folder) if theme_exists and not self.over_write_message_box(theme_name): @@ -581,7 +589,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage continue full_name = os.path.join(directory, out_name) check_directory_exists(os.path.dirname(full_name)) - if os.path.splitext(name)[1].lower() == '.xml': + if os.path.splitext(name)[1].lower() == '.xml' or os.path.splitext(name)[1].lower() == '.json': file_xml = str(theme_zip.read(name), 'utf-8') out_file = open(full_name, 'w', encoding='utf-8') out_file.write(file_xml) @@ -604,7 +612,10 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage if not abort_import: # As all files are closed, we can create the Theme. if file_xml: - theme = self._create_theme_from_xml(file_xml, self.path) + if json_theme: + theme = self._create_theme_from_json(file_xml, self.path) + else: + theme = self._create_theme_from_xml(file_xml, self.path) self.generate_and_save_image(theme_name, theme) # Only show the error message, when IOError was not raised (in # this case the error message has already been shown). From 7fbeb10207bfcc217c43e2213091a4fb922a03f1 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 May 2017 17:02:02 +0100 Subject: [PATCH 06/14] text fixes --- tests/functional/openlp_core_lib/test_renderer.py | 4 ++-- tests/functional/openlp_core_lib/test_theme.py | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/tests/functional/openlp_core_lib/test_renderer.py b/tests/functional/openlp_core_lib/test_renderer.py index a2a156094..69d93ab5e 100644 --- a/tests/functional/openlp_core_lib/test_renderer.py +++ b/tests/functional/openlp_core_lib/test_renderer.py @@ -29,7 +29,7 @@ from PyQt5 import QtCore from openlp.core.common import Registry from openlp.core.lib import Renderer, ScreenList, ServiceItem, FormattingTags from openlp.core.lib.renderer import words_split, get_start_tags -from openlp.core.lib.theme import ThemeXML +from openlp.core.lib.theme import Theme from tests.functional import MagicMock, patch @@ -189,7 +189,7 @@ class TestRenderer(TestCase): # GIVEN: test object and data mock_lyrics_css.return_value = ' FORMAT CSS; ' mock_outline_css.return_value = ' OUTLINE CSS; ' - theme_data = ThemeXML() + theme_data = Theme() theme_data.font_main_name = 'Arial' theme_data.font_main_size = 20 theme_data.font_main_color = '#FFFFFF' diff --git a/tests/functional/openlp_core_lib/test_theme.py b/tests/functional/openlp_core_lib/test_theme.py index 04a31c5d5..28da8e505 100644 --- a/tests/functional/openlp_core_lib/test_theme.py +++ b/tests/functional/openlp_core_lib/test_theme.py @@ -38,7 +38,7 @@ class TestTheme(TestCase): """ Test the Theme constructor """ - # GIVEN: The ThemeXML class + # GIVEN: The Theme class # WHEN: A theme object is created default_theme = Theme() @@ -49,7 +49,7 @@ class TestTheme(TestCase): """ Test the expand_json method """ - # GIVEN: A ThemeXML object and some JSON to "expand" + # GIVEN: A Theme object and some JSON to "expand" theme = Theme() theme_json = { 'background': { @@ -69,7 +69,7 @@ class TestTheme(TestCase): } } - # WHEN: ThemeXML.expand_json() is run + # WHEN: Theme.expand_json() is run theme.expand_json(theme_json) # THEN: The attributes should be set on the object @@ -86,7 +86,7 @@ class TestTheme(TestCase): theme.background_type = 'video' path = os.path.expanduser('~') - # WHEN: ThemeXML.extend_image_filename is run + # WHEN: Theme.extend_image_filename is run theme.extend_image_filename(path) # THEN: The filename of the background should be correct From cad03b9abd04bcaa94e744d3dfa94432bbfe7595 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 May 2017 17:06:40 +0100 Subject: [PATCH 07/14] fix tests --- openlp/core/lib/theme.py | 264 ------------------ .../functional/openlp_core_lib/test_theme.py | 2 +- .../openlp_core_ui_lib/test_thememanager.py | 37 +++ 3 files changed, 38 insertions(+), 265 deletions(-) create mode 100644 tests/functional/openlp_core_ui_lib/test_thememanager.py diff --git a/openlp/core/lib/theme.py b/openlp/core/lib/theme.py index a4397ea0f..ff803acd8 100644 --- a/openlp/core/lib/theme.py +++ b/openlp/core/lib/theme.py @@ -26,7 +26,6 @@ import os import logging import json -from xml.dom.minidom import Document from lxml import etree, objectify from openlp.core.common import AppLocation, de_hump @@ -195,184 +194,6 @@ class Theme(object): self.background_filename = self.background_filename.strip() self.background_filename = os.path.join(path, self.theme_name, self.background_filename) - # def _new_document(self, name): - # """ - # Create a new theme XML document. - # """ - # self.theme_xml = Document() - # self.theme = self.theme_xml.createElement('theme') - # self.theme_xml.appendChild(self.theme) - # self.theme.setAttribute('version', '2.0') - # self.name = self.theme_xml.createElement('name') - # text_node = self.theme_xml.createTextNode(name) - # self.name.appendChild(text_node) - # self.theme.appendChild(self.name) - - # def add_background_transparent(self): - # """ - # Add a transparent background. - # """ - # background = self.theme_xml.createElement('background') - # background.setAttribute('type', 'transparent') - # self.theme.appendChild(background) - - # def add_background_solid(self, bkcolor): - # """ - # Add a Solid background. - # - # :param bkcolor: The color of the background. - # """ - # background = self.theme_xml.createElement('background') - # background.setAttribute('type', 'solid') - # self.theme.appendChild(background) - # self.child_element(background, 'color', str(bkcolor)) - - # def add_background_gradient(self, startcolor, endcolor, direction): - # """ - # Add a gradient background. - # - # :param startcolor: The gradient's starting colour. - # :param endcolor: The gradient's ending colour. - # :param direction: The direction of the gradient. - # """ - # background = self.theme_xml.createElement('background') - # background.setAttribute('type', 'gradient') - # self.theme.appendChild(background) - # # Create startColor element - # self.child_element(background, 'startColor', str(startcolor)) - # # Create endColor element - # self.child_element(background, 'endColor', str(endcolor)) - # # Create direction element - # self.child_element(background, 'direction', str(direction)) - - # def add_background_image(self, filename, border_color): - # """ - # Add a image background. - # - # :param filename: The file name of the image. - # :param border_color: - # """ - # background = self.theme_xml.createElement('background') - # background.setAttribute('type', 'image') - # self.theme.appendChild(background) - # # Create Filename element - # self.child_element(background, 'filename', filename) - # # Create endColor element - # self.child_element(background, 'borderColor', str(border_color)) - # - # def add_background_video(self, filename, border_color): - # """ - # Add a video background. - # - # :param filename: The file name of the video. - # :param border_color: - # """ - # background = self.theme_xml.createElement('background') - # background.setAttribute('type', 'video') - # self.theme.appendChild(background) - # # Create Filename element - # self.child_element(background, 'filename', filename) - # # Create endColor element - # self.child_element(background, 'borderColor', str(border_color)) - - # def add_font(self, name, color, size, override, fonttype='main', bold='False', italics='False', - # line_adjustment=0, xpos=0, ypos=0, width=0, height=0, outline='False', outline_color='#ffffff', - # outline_pixel=2, shadow='False', shadow_color='#ffffff', shadow_pixel=5): - # """ - # Add a Font. - # - # :param name: The name of the font. - # :param color: The colour of the font. - # :param size: The size of the font. - # :param override: Whether or not to override the default positioning of the theme. - # :param fonttype: The type of font, ``main`` or ``footer``. Defaults to ``main``. - # :param bold: - # :param italics: The weight of then font Defaults to 50 Normal - # :param line_adjustment: Does the font render to italics Defaults to 0 Normal - # :param xpos: The X position of the text block. - # :param ypos: The Y position of the text block. - # :param width: The width of the text block. - # :param height: The height of the text block. - # :param outline: Whether or not to show an outline. - # :param outline_color: The colour of the outline. - # :param outline_pixel: How big the Shadow is - # :param shadow: Whether or not to show a shadow. - # :param shadow_color: The colour of the shadow. - # :param shadow_pixel: How big the Shadow is - # """ - # background = self.theme_xml.createElement('font') - # background.setAttribute('type', fonttype) - # self.theme.appendChild(background) - # # Create Font name element - # self.child_element(background, 'name', name) - # # Create Font color element - # self.child_element(background, 'color', str(color)) - # # Create Proportion name element - # self.child_element(background, 'size', str(size)) - # # Create weight name element - # self.child_element(background, 'bold', str(bold)) - # # Create italics name element - # self.child_element(background, 'italics', str(italics)) - # # Create indentation name element - # self.child_element(background, 'line_adjustment', str(line_adjustment)) - # # Create Location element - # element = self.theme_xml.createElement('location') - # element.setAttribute('override', str(override)) - # element.setAttribute('x', str(xpos)) - # element.setAttribute('y', str(ypos)) - # element.setAttribute('width', str(width)) - # element.setAttribute('height', str(height)) - # background.appendChild(element) - # # Shadow - # element = self.theme_xml.createElement('shadow') - # element.setAttribute('shadowColor', str(shadow_color)) - # element.setAttribute('shadowSize', str(shadow_pixel)) - # value = self.theme_xml.createTextNode(str(shadow)) - # element.appendChild(value) - # background.appendChild(element) - # # Outline - # element = self.theme_xml.createElement('outline') - # element.setAttribute('outlineColor', str(outline_color)) - # element.setAttribute('outlineSize', str(outline_pixel)) - # value = self.theme_xml.createTextNode(str(outline)) - # element.appendChild(value) - # background.appendChild(element) - # - # def add_display(self, horizontal, vertical, transition): - # """ - # Add a Display options. - # - # :param horizontal: The horizontal alignment of the text. - # :param vertical: The vertical alignment of the text. - # :param transition: Whether the slide transition is active. - # """ - # background = self.theme_xml.createElement('display') - # self.theme.appendChild(background) - # # Horizontal alignment - # element = self.theme_xml.createElement('horizontalAlign') - # value = self.theme_xml.createTextNode(str(horizontal)) - # element.appendChild(value) - # background.appendChild(element) - # # Vertical alignment - # element = self.theme_xml.createElement('verticalAlign') - # value = self.theme_xml.createTextNode(str(vertical)) - # element.appendChild(value) - # background.appendChild(element) - # # Slide Transition - # element = self.theme_xml.createElement('slideTransition') - # value = self.theme_xml.createTextNode(str(transition)) - # element.appendChild(value) - # background.appendChild(element) - # - # def child_element(self, element, tag, value): - # """ - # Generic child element creator. - # """ - # child = self.theme_xml.createElement(tag) - # child.appendChild(self.theme_xml.createTextNode(value)) - # element.appendChild(child) - # return child - def set_default_header_footer(self): """ Set the header and footer size into the current primary screen. @@ -386,26 +207,6 @@ class Theme(object): self.font_footer_y = current_screen['size'].height() * 9 / 10 self.font_footer_height = current_screen['size'].height() / 10 - # def dump_xml(self): - # """ - # Dump the XML to file used for debugging - # """ - # return self.theme_xml.toprettyxml(indent=' ') - - # def extract_xml(self): - # """ - # Print out the XML string. - # """ - # self._build_xml_from_attrs() - # return self.theme_xml.toxml('utf-8').decode('utf-8') - # - # def extract_formatted_xml(self): - # """ - # Pull out the XML string formatted for human consumption - # """ - # self._build_xml_from_attrs() - # return self.theme_xml.toprettyxml(indent=' ', newl='\n', encoding='utf-8') - def load_theme(self, theme): """ Pull out the XML string formatted for human consumption @@ -526,68 +327,3 @@ class Theme(object): if key[0:1] != '_': theme_strings.append('{key:>30}: {value}'.format(key=key, value=getattr(self, key))) return '\n'.join(theme_strings) - - # def _build_xml_from_attrs(self): - # """ - # Build the XML from the varables in the object - # """ - # self._new_document(self.theme_name) - # if self.background_type == BackgroundType.to_string(BackgroundType.Solid): - # self.add_background_solid(self.background_color) - # elif self.background_type == BackgroundType.to_string(BackgroundType.Gradient): - # self.add_background_gradient( - # self.background_start_color, - # self.background_end_color, - # self.background_direction - # ) - # elif self.background_type == BackgroundType.to_string(BackgroundType.Image): - # filename = os.path.split(self.background_filename)[1] - # self.add_background_image(filename, self.background_border_color) - # elif self.background_type == BackgroundType.to_string(BackgroundType.Video): - # filename = os.path.split(self.background_filename)[1] - # self.add_background_video(filename, self.background_border_color) - # elif self.background_type == BackgroundType.to_string(BackgroundType.Transparent): - # self.add_background_transparent() - # self.add_font( - # self.font_main_name, - # self.font_main_color, - # self.font_main_size, - # self.font_main_override, 'main', - # self.font_main_bold, - # self.font_main_italics, - # self.font_main_line_adjustment, - # self.font_main_x, - # self.font_main_y, - # self.font_main_width, - # self.font_main_height, - # self.font_main_outline, - # self.font_main_outline_color, - # self.font_main_outline_size, - # self.font_main_shadow, - # self.font_main_shadow_color, - # self.font_main_shadow_size - # ) - # self.add_font( - # self.font_footer_name, - # self.font_footer_color, - # self.font_footer_size, - # self.font_footer_override, 'footer', - # self.font_footer_bold, - # self.font_footer_italics, - # 0, # line adjustment - # self.font_footer_x, - # self.font_footer_y, - # self.font_footer_width, - # self.font_footer_height, - # self.font_footer_outline, - # self.font_footer_outline_color, - # self.font_footer_outline_size, - # self.font_footer_shadow, - # self.font_footer_shadow_color, - # self.font_footer_shadow_size - # ) - # self.add_display( - # self.display_horizontal_align, - # self.display_vertical_align, - # self.display_slide_transition - # ) diff --git a/tests/functional/openlp_core_lib/test_theme.py b/tests/functional/openlp_core_lib/test_theme.py index 28da8e505..85692f0a2 100644 --- a/tests/functional/openlp_core_lib/test_theme.py +++ b/tests/functional/openlp_core_lib/test_theme.py @@ -32,7 +32,7 @@ from openlp.core.lib.theme import Theme class TestTheme(TestCase): """ - Test the ThemeL class + Test the Theme class """ def test_new_theme(self): """ diff --git a/tests/functional/openlp_core_ui_lib/test_thememanager.py b/tests/functional/openlp_core_ui_lib/test_thememanager.py new file mode 100644 index 000000000..51face165 --- /dev/null +++ b/tests/functional/openlp_core_ui_lib/test_thememanager.py @@ -0,0 +1,37 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2017 OpenLP Developers # +# --------------------------------------------------------------------------- # +# This program is free software; you can redistribute it and/or modify it # +# under the terms of the GNU General Public License as published by the Free # +# Software Foundation; version 2 of the License. # +# # +# 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 General Public License for # +# more details. # +# # +# You should have received a copy of the GNU General Public License along # +# with this program; if not, write to the Free Software Foundation, Inc., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +""" +Package to test the openlp.core.ui.lib.theme package. +""" +import json +from unittest import TestCase +import os + +from openlp.core.common import json_default +from openlp.core.lib.theme import Theme + + +class TestThemeManager(TestCase): + """ + Test the ThemeManager class + """ + From b7001116da284557c2a451a29efb9620b90fea30 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 23 May 2017 05:59:35 +0100 Subject: [PATCH 08/14] start to fix tests --- openlp/core/common/__init__.py | 9 ++++++--- openlp/core/ui/thememanager.py | 10 ++++++---- tests/functional/openlp_core_ui/test_thememanager.py | 8 ++++---- 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/openlp/core/common/__init__.py b/openlp/core/common/__init__.py index ac61d9519..8b4a223eb 100644 --- a/openlp/core/common/__init__.py +++ b/openlp/core/common/__init__.py @@ -440,11 +440,14 @@ def get_file_encoding(filename): log.exception('Error detecting file encoding') -def json_default(o): +def json_default(obj): """ Function to help save objects as JSON - :param o: object + :param obj: object :return: the object dictionary """ - return o.__dict__ + try: + return obj.__dict__ + except: + raise TypeError("Unserializable object {} of type {}".format(obj, type(obj))) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index c8b2eaa38..3b2c19222 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -379,10 +379,12 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage critical_error_message_box(message=translate('OpenLP.ThemeManager', 'You have not selected a theme.')) return theme = item.data(QtCore.Qt.UserRole) - path, filter_used = QtWidgets.QFileDialog.getSaveFileName(self.main_window, - translate('OpenLP.ThemeManager', 'Save Theme - ({name})').format(name=theme), - Settings().value(self.settings_section + '/last directory export'), - translate('OpenLP.ThemeManager', 'OpenLP Themes (*.otz)')) + path, filter_used = \ + QtWidgets.QFileDialog.getSaveFileName(self.main_window, + translate('OpenLP.ThemeManager', 'Save Theme - ({name})'). + format(name=theme), + Settings().value(self.settings_section + '/last directory export'), + translate('OpenLP.ThemeManager', 'OpenLP Themes (*.otz)')) self.application.set_busy_cursor() if path: Settings().setValue(self.settings_section + '/last directory export', path) diff --git a/tests/functional/openlp_core_ui/test_thememanager.py b/tests/functional/openlp_core_ui/test_thememanager.py index 264a9f3ce..c9254e4d0 100644 --- a/tests/functional/openlp_core_ui/test_thememanager.py +++ b/tests/functional/openlp_core_ui/test_thememanager.py @@ -26,7 +26,6 @@ import os import shutil from unittest import TestCase -from tempfile import mkdtemp from PyQt5 import QtWidgets from tempfile import mkdtemp @@ -65,7 +64,7 @@ class TestThemeManager(TestCase): mocked_zipfile_init.return_value = None # WHEN: The theme is exported - theme_manager._export_theme(os.path.join('some', 'path'), 'Default') + theme_manager._export_theme(os.path.join('some', 'path', 'Default.otz'), 'Default') # THEN: The zipfile should be created at the given path mocked_zipfile_init.assert_called_with(os.path.join('some', 'path', 'Default.otz'), 'w') @@ -128,8 +127,9 @@ class TestThemeManager(TestCase): theme_manager.path = '' mocked_theme = MagicMock() mocked_theme.theme_name = 'themename' - mocked_theme.extract_formatted_xml = MagicMock() - mocked_theme.extract_formatted_xml.return_value = 'fake_theme_xml'.encode() + mocked_theme.filename = "filename" + # mocked_theme.extract_formatted_xml = MagicMock() + # mocked_theme.extract_formatted_xml.return_value = 'fake_theme_xml'.encode() # WHEN: Calling _write_theme with path to different images file_name1 = os.path.join(TEST_RESOURCES_PATH, 'church.jpg') From 32668193c642872152535e3d568097f6f1fea63d Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 24 May 2017 20:31:48 +0100 Subject: [PATCH 09/14] fix up tests --- openlp/core/lib/theme.py | 12 +++++++++++- openlp/core/ui/thememanager.py | 2 +- tests/functional/openlp_core_lib/test_theme.py | 2 +- tests/functional/openlp_core_ui/test_thememanager.py | 5 ++--- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/openlp/core/lib/theme.py b/openlp/core/lib/theme.py index 808086fd8..541cd8fab 100644 --- a/openlp/core/lib/theme.py +++ b/openlp/core/lib/theme.py @@ -209,13 +209,23 @@ class Theme(object): def load_theme(self, theme): """ - Pull out the XML string formatted for human consumption + Convert the JSON file and expand it. :param theme: the theme string """ jsn = json.loads(theme) self.expand_json(jsn) + def export_theme(self): + """ + Loop through the fields and build a dictionary of them + + """ + theme_data = {} + for attr, value in self.__dict__.items(): + theme_data["{attr}".format(attr=attr)] = value + return json.dumps(theme_data) + def parse(self, xml): """ Read in an XML string and parse it. diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index 3b2c19222..3fb2da1c9 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -666,7 +666,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage :param image_to: Where the Theme Image is to be saved to """ name = theme.theme_name - theme_pretty = json.dumps(theme, default=json_default) + theme_pretty = theme.export_theme() theme_dir = os.path.join(self.path, name) check_directory_exists(theme_dir) theme_file = os.path.join(theme_dir, name + '.json') diff --git a/tests/functional/openlp_core_lib/test_theme.py b/tests/functional/openlp_core_lib/test_theme.py index 85692f0a2..db5291d23 100644 --- a/tests/functional/openlp_core_lib/test_theme.py +++ b/tests/functional/openlp_core_lib/test_theme.py @@ -102,7 +102,7 @@ class TestTheme(TestCase): # WHEN: A theme object is created default_theme = Theme() # THEN: The default values should be correct - save_theme_json = json.dumps(default_theme, default=json_default) + save_theme_json = default_theme.export_theme() lt = Theme() lt.load_theme(save_theme_json) self.check_theme(lt) diff --git a/tests/functional/openlp_core_ui/test_thememanager.py b/tests/functional/openlp_core_ui/test_thememanager.py index 393d60ecd..a30eda7fa 100644 --- a/tests/functional/openlp_core_ui/test_thememanager.py +++ b/tests/functional/openlp_core_ui/test_thememanager.py @@ -149,14 +149,13 @@ class TestThemeManager(TestCase): theme_manager.path = self.temp_folder mocked_theme = MagicMock() mocked_theme.theme_name = 'theme 愛 name' - mocked_theme.extract_formatted_xml = MagicMock() - mocked_theme.extract_formatted_xml.return_value = 'fake theme 愛 XML'.encode() + mocked_theme.export_theme.return_value = "{}" # WHEN: Calling _write_theme with a theme with a name with special characters in it theme_manager._write_theme(mocked_theme, None, None) # THEN: It should have been created - self.assertTrue(os.path.exists(os.path.join(self.temp_folder, 'theme 愛 name', 'theme 愛 name.xml')), + self.assertTrue(os.path.exists(os.path.join(self.temp_folder, 'theme 愛 name', 'theme 愛 name.json')), 'Theme with special characters should have been created!') def test_over_write_message_box_yes(self): From 3b7852b569a05f3cae44249aaeb5ce00bc47d114 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 24 May 2017 20:55:30 +0100 Subject: [PATCH 10/14] clean up pep8 --- openlp/core/lib/theme.py | 2 +- openlp/core/ui/lib/pathedit.py | 6 +++--- openlp/plugins/presentations/presentationplugin.py | 2 +- openlp/plugins/songusage/forms/songusagedetaildialog.py | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/openlp/core/lib/theme.py b/openlp/core/lib/theme.py index 541cd8fab..fb78f7443 100644 --- a/openlp/core/lib/theme.py +++ b/openlp/core/lib/theme.py @@ -210,7 +210,7 @@ class Theme(object): def load_theme(self, theme): """ Convert the JSON file and expand it. - + :param theme: the theme string """ jsn = json.loads(theme) diff --git a/openlp/core/ui/lib/pathedit.py b/openlp/core/ui/lib/pathedit.py index 238bcb00d..74f37c581 100755 --- a/openlp/core/ui/lib/pathedit.py +++ b/openlp/core/ui/lib/pathedit.py @@ -46,16 +46,16 @@ class PathEdit(QtWidgets.QWidget): :param parent: The parent of the widget. This is just passed to the super method. :type parent: QWidget or None - + :param dialog_caption: Used to customise the caption in the QFileDialog. :param dialog_caption: str - + :param default_path: The default path. This is set as the path when the revert button is clicked :type default_path: str :param show_revert: Used to determin if the 'revert button' should be visible. :type show_revert: bool - + :return: None :rtype: None """ diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 884f155a2..210f8a531 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -1,4 +1,4 @@ - # -*- coding: utf-8 -*- +# -*- coding: utf-8 -*- # vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 ############################################################################### diff --git a/openlp/plugins/songusage/forms/songusagedetaildialog.py b/openlp/plugins/songusage/forms/songusagedetaildialog.py index 74c8c89c8..082173bf5 100644 --- a/openlp/plugins/songusage/forms/songusagedetaildialog.py +++ b/openlp/plugins/songusage/forms/songusagedetaildialog.py @@ -69,7 +69,7 @@ class Ui_SongUsageDetailDialog(object): self.file_horizontal_layout.setSpacing(8) self.file_horizontal_layout.setContentsMargins(8, 8, 8, 8) self.file_horizontal_layout.setObjectName('file_horizontal_layout') - self.report_path_edit = PathEdit(self.file_group_box, path_type = PathType.Directories, show_revert=False) + self.report_path_edit = PathEdit(self.file_group_box, path_type=PathType.Directories, show_revert=False) self.file_horizontal_layout.addWidget(self.report_path_edit) self.vertical_layout.addWidget(self.file_group_box) self.button_box = create_button_box(song_usage_detail_dialog, 'button_box', ['cancel', 'ok']) From 7c1fffdf41d0c037ad96e1e3574869258994014b Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 24 May 2017 21:01:46 +0100 Subject: [PATCH 11/14] clean up pep8 --- openlp/core/common/__init__.py | 13 ------------- openlp/core/ui/lib/pathedit.py | 2 +- 2 files changed, 1 insertion(+), 14 deletions(-) diff --git a/openlp/core/common/__init__.py b/openlp/core/common/__init__.py index aab74d004..fde02506d 100644 --- a/openlp/core/common/__init__.py +++ b/openlp/core/common/__init__.py @@ -482,16 +482,3 @@ def get_file_encoding(filename): return detector.result except OSError: log.exception('Error detecting file encoding') - - -def json_default(obj): - """ - Function to help save objects as JSON - - :param obj: object - :return: the object dictionary - """ - try: - return obj.__dict__ - except: - raise TypeError("Unserializable object {} of type {}".format(obj, type(obj))) diff --git a/openlp/core/ui/lib/pathedit.py b/openlp/core/ui/lib/pathedit.py index 74f37c581..c489daa33 100755 --- a/openlp/core/ui/lib/pathedit.py +++ b/openlp/core/ui/lib/pathedit.py @@ -72,7 +72,7 @@ class PathEdit(QtWidgets.QWidget): Set up the widget :param show_revert: Show or hide the revert button :type show_revert: bool - + :return: None :rtype: None """ From 2faf588c99e2d0ccf72d1fda1e30cc8d63652ba0 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 24 May 2017 21:04:48 +0100 Subject: [PATCH 12/14] clean up files --- openlp/core/ui/thememanager.py | 2 +- tests/functional/openlp_core_lib/test_theme.py | 2 -- tests/functional/openlp_core_ui_lib/test_thememanager.py | 6 +----- 3 files changed, 2 insertions(+), 8 deletions(-) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index 3fb2da1c9..73056568f 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -31,7 +31,7 @@ from xml.etree.ElementTree import ElementTree, XML from PyQt5 import QtCore, QtGui, QtWidgets from openlp.core.common import Registry, RegistryProperties, AppLocation, Settings, OpenLPMixin, RegistryMixin, \ - check_directory_exists, UiStrings, translate, is_win, get_filesystem_encoding, delete_file, json_default + check_directory_exists, UiStrings, translate, is_win, get_filesystem_encoding, delete_file from openlp.core.lib import FileDialog, ImageSource, ValidationError, get_text_file_string, build_icon, \ check_item_selected, create_thumb, validate_thumb from openlp.core.lib.theme import Theme, BackgroundType diff --git a/tests/functional/openlp_core_lib/test_theme.py b/tests/functional/openlp_core_lib/test_theme.py index db5291d23..bb90e574a 100644 --- a/tests/functional/openlp_core_lib/test_theme.py +++ b/tests/functional/openlp_core_lib/test_theme.py @@ -22,11 +22,9 @@ """ Package to test the openlp.core.lib.theme package. """ -import json from unittest import TestCase import os -from openlp.core.common import json_default from openlp.core.lib.theme import Theme diff --git a/tests/functional/openlp_core_ui_lib/test_thememanager.py b/tests/functional/openlp_core_ui_lib/test_thememanager.py index 51face165..d8924fe58 100644 --- a/tests/functional/openlp_core_ui_lib/test_thememanager.py +++ b/tests/functional/openlp_core_ui_lib/test_thememanager.py @@ -22,12 +22,8 @@ """ Package to test the openlp.core.ui.lib.theme package. """ -import json -from unittest import TestCase -import os -from openlp.core.common import json_default -from openlp.core.lib.theme import Theme +from unittest import TestCase class TestThemeManager(TestCase): From a775f0ddb8881a46d7c17a67b7898a3efec50753 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 24 May 2017 21:09:54 +0100 Subject: [PATCH 13/14] remove extra file --- .../openlp_core_ui_lib/test_thememanager.py | 33 ------------------- 1 file changed, 33 deletions(-) delete mode 100644 tests/functional/openlp_core_ui_lib/test_thememanager.py diff --git a/tests/functional/openlp_core_ui_lib/test_thememanager.py b/tests/functional/openlp_core_ui_lib/test_thememanager.py deleted file mode 100644 index d8924fe58..000000000 --- a/tests/functional/openlp_core_ui_lib/test_thememanager.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 - -############################################################################### -# OpenLP - Open Source Lyrics Projection # -# --------------------------------------------------------------------------- # -# Copyright (c) 2008-2017 OpenLP Developers # -# --------------------------------------------------------------------------- # -# This program is free software; you can redistribute it and/or modify it # -# under the terms of the GNU General Public License as published by the Free # -# Software Foundation; version 2 of the License. # -# # -# 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 General Public License for # -# more details. # -# # -# You should have received a copy of the GNU General Public License along # -# with this program; if not, write to the Free Software Foundation, Inc., 59 # -# Temple Place, Suite 330, Boston, MA 02111-1307 USA # -############################################################################### -""" -Package to test the openlp.core.ui.lib.theme package. -""" - -from unittest import TestCase - - -class TestThemeManager(TestCase): - """ - Test the ThemeManager class - """ - From fc5c6561e766debdad2bc8ea57d883200e817de0 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 30 May 2017 14:55:39 +0100 Subject: [PATCH 14/14] Minor tweeks --- openlp/core/ui/thememanager.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index 73056568f..59576808b 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -506,7 +506,7 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage def get_theme_data(self, theme_name): """ - Returns a theme object from an XML file + Returns a theme object from an XML or JSON file :param theme_name: Name of the theme to load from file :return: The theme object. @@ -556,11 +556,13 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage out_file = None file_xml = None abort_import = True + json_theme = False + theme_name = "" try: theme_zip = zipfile.ZipFile(file_name) - json_theme = False json_file = [name for name in theme_zip.namelist() if os.path.splitext(name)[1].lower() == '.json'] if len(json_file) != 1: + # TODO: remove XML handling at some point but would need a auto conversion to run first. xml_file = [name for name in theme_zip.namelist() if os.path.splitext(name)[1].lower() == '.xml'] if len(xml_file) != 1: self.log_error('Theme contains "{val:d}" theme files'.format(val=len(xml_file))) @@ -572,9 +574,9 @@ class ThemeManager(OpenLPMixin, RegistryMixin, QtWidgets.QWidget, Ui_ThemeManage raise ValidationError theme_name = xml_tree.find('name').text.strip() else: - theme = Theme() - theme.load_theme(theme_zip.read(json_file[0]).decode("utf-8")) - theme_name = theme.theme_name + new_theme = Theme() + new_theme.load_theme(theme_zip.read(json_file[0]).decode("utf-8")) + theme_name = new_theme.theme_name json_theme = True theme_folder = os.path.join(directory, theme_name) theme_exists = os.path.exists(theme_folder)