openlp-core team mailing list archive
-
openlp-core team
-
Mailing list archive
-
Message #23585
[Merge] lp:~tomasgroth/openlp/zefania-import into lp:openlp
Tomas Groth has proposed merging lp:~tomasgroth/openlp/zefania-import into lp:openlp.
Requested reviews:
OpenLP Core (openlp-core)
For more details, see:
https://code.launchpad.net/~tomasgroth/openlp/zefania-import/+merge/220411
Support for importing Zefania bible XML format.
--
https://code.launchpad.net/~tomasgroth/openlp/zefania-import/+merge/220411
Your team OpenLP Core is requested to review the proposed merge of lp:~tomasgroth/openlp/zefania-import into lp:openlp.
=== modified file 'openlp/core/ui/wizard.py'
--- openlp/core/ui/wizard.py 2014-05-03 15:01:43 +0000
+++ openlp/core/ui/wizard.py 2014-05-21 09:40:04 +0000
@@ -51,6 +51,7 @@
CSV = 'CSV'
OS = 'OpenSong'
OSIS = 'OSIS'
+ ZEF = 'Zefania'
# These strings should need a good reason to be retranslated elsewhere.
FinishedImport = translate('OpenLP.Ui', 'Finished import.')
FormatLabel = translate('OpenLP.Ui', 'Format:')
=== modified file 'openlp/plugins/bibles/forms/bibleimportform.py'
--- openlp/plugins/bibles/forms/bibleimportform.py 2014-04-02 07:04:12 +0000
+++ openlp/plugins/bibles/forms/bibleimportform.py 2014-05-21 09:40:04 +0000
@@ -110,6 +110,7 @@
self.csv_books_button.clicked.connect(self.on_csv_books_browse_button_clicked)
self.csv_verses_button.clicked.connect(self.on_csv_verses_browse_button_clicked)
self.open_song_browse_button.clicked.connect(self.on_open_song_browse_button_clicked)
+ self.zefania_browse_button.clicked.connect(self.on_zefania_browse_button_clicked)
def add_custom_pages(self):
"""
@@ -125,7 +126,7 @@
self.format_label = QtGui.QLabel(self.select_page)
self.format_label.setObjectName('FormatLabel')
self.format_combo_box = QtGui.QComboBox(self.select_page)
- self.format_combo_box.addItems(['', '', '', ''])
+ self.format_combo_box.addItems(['', '', '', '', ''])
self.format_combo_box.setObjectName('FormatComboBox')
self.format_layout.addRow(self.format_label, self.format_combo_box)
self.spacer = QtGui.QSpacerItem(10, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum)
@@ -247,6 +248,25 @@
self.web_proxy_layout.setWidget(2, QtGui.QFormLayout.FieldRole, self.web_password_edit)
self.web_tab_widget.addTab(self.web_proxy_tab, '')
self.select_stack.addWidget(self.web_tab_widget)
+ self.zefania_widget = QtGui.QWidget(self.select_page)
+ self.zefania_widget.setObjectName('ZefaniaWidget')
+ self.zefania_layout = QtGui.QFormLayout(self.zefania_widget)
+ self.zefania_layout.setMargin(0)
+ self.zefania_layout.setObjectName('ZefaniaLayout')
+ self.zefania_file_label = QtGui.QLabel(self.zefania_widget)
+ self.zefania_file_label.setObjectName('ZefaniaFileLabel')
+ self.zefania_file_layout = QtGui.QHBoxLayout()
+ self.zefania_file_layout.setObjectName('ZefaniaFileLayout')
+ self.zefania_file_edit = QtGui.QLineEdit(self.zefania_widget)
+ self.zefania_file_edit.setObjectName('ZefaniaFileEdit')
+ self.zefania_file_layout.addWidget(self.zefania_file_edit)
+ self.zefania_browse_button = QtGui.QToolButton(self.zefania_widget)
+ self.zefania_browse_button.setIcon(self.open_icon)
+ self.zefania_browse_button.setObjectName('ZefaniaBrowseButton')
+ self.zefania_file_layout.addWidget(self.zefania_browse_button)
+ self.zefania_layout.addRow(self.zefania_file_label, self.zefania_file_layout)
+ self.zefania_layout.setItem(5, QtGui.QFormLayout.LabelRole, self.spacer)
+ self.select_stack.addWidget(self.zefania_widget)
self.select_page_layout.addLayout(self.select_stack)
self.addPage(self.select_page)
# License Page
@@ -294,11 +314,13 @@
self.format_combo_box.setItemText(BibleFormat.OpenSong, WizardStrings.OS)
self.format_combo_box.setItemText(BibleFormat.WebDownload, translate('BiblesPlugin.ImportWizardForm',
'Web Download'))
+ self.format_combo_box.setItemText(BibleFormat.Zefania, WizardStrings.ZEF)
self.osis_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:'))
self.csv_books_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Books file:'))
self.csv_verses_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Verses file:'))
self.open_song_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:'))
self.web_source_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Location:'))
+ self.zefania_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:'))
self.web_source_combo_box.setItemText(WebDownload.Crosswalk, translate('BiblesPlugin.ImportWizardForm',
'Crosswalk'))
self.web_source_combo_box.setItemText(WebDownload.BibleGateway, translate('BiblesPlugin.ImportWizardForm',
@@ -331,7 +353,8 @@
self.osis_file_label.minimumSizeHint().width(),
self.csv_books_label.minimumSizeHint().width(),
self.csv_verses_label.minimumSizeHint().width(),
- self.open_song_file_label.minimumSizeHint().width())
+ self.open_song_file_label.minimumSizeHint().width(),
+ self.zefania_file_label.minimumSizeHint().width())
self.spacer.changeSize(label_width, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
def validateCurrentPage(self):
@@ -366,6 +389,11 @@
critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.OS)
self.open_song_file_edit.setFocus()
return False
+ elif self.field('source_format') == BibleFormat.Zefania:
+ if not self.field('zefania_file'):
+ critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.ZEF)
+ self.zefania_file_edit.setFocus()
+ return False
elif self.field('source_format') == BibleFormat.WebDownload:
self.version_name_edit.setText(self.web_translation_combo_box.currentText())
return True
@@ -447,6 +475,13 @@
self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.OS, self.open_song_file_edit,
'last directory import')
+ def on_zefania_browse_button_clicked(self):
+ """
+ Show the file open dialog for the Zefania file.
+ """
+ self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.ZEF, self.zefania_file_edit,
+ 'last directory import')
+
def register_fields(self):
"""
Register the bible import wizard fields.
@@ -456,6 +491,7 @@
self.select_page.registerField('csv_booksfile', self.csv_books_edit)
self.select_page.registerField('csv_versefile', self.csv_verses_edit)
self.select_page.registerField('opensong_file', self.open_song_file_edit)
+ self.select_page.registerField('zefania_file', self.zefania_file_edit)
self.select_page.registerField('web_location', self.web_source_combo_box)
self.select_page.registerField('web_biblename', self.web_translation_combo_box)
self.select_page.registerField('proxy_server', self.web_server_edit)
@@ -479,6 +515,7 @@
self.setField('csv_booksfile', '')
self.setField('csv_versefile', '')
self.setField('opensong_file', '')
+ self.setField('zefania_file', '')
self.setField('web_location', WebDownload.Crosswalk)
self.setField('web_biblename', self.web_translation_combo_box.currentIndex())
self.setField('proxy_server', settings.value('proxy address'))
@@ -562,6 +599,10 @@
proxy_username=self.field('proxy_username'),
proxy_password=self.field('proxy_password')
)
+ elif bible_type == BibleFormat.Zefania:
+ # Import an Zefania bible.
+ importer = self.manager.import_bible(BibleFormat.Zefania, name=license_version,
+ filename=self.field('zefania_file'))
if importer.do_import(license_version):
self.manager.save_meta_data(license_version, license_version, license_copyright, license_permissions)
self.manager.reload_bibles()
=== modified file 'openlp/plugins/bibles/lib/manager.py'
--- openlp/plugins/bibles/lib/manager.py 2014-05-01 17:49:43 +0000
+++ openlp/plugins/bibles/lib/manager.py 2014-05-21 09:40:04 +0000
@@ -38,6 +38,7 @@
from .http import HTTPBible
from .opensong import OpenSongBible
from .osis import OSISBible
+from .zefania import ZefaniaBible
log = logging.getLogger(__name__)
@@ -52,6 +53,7 @@
CSV = 1
OpenSong = 2
WebDownload = 3
+ Zefania = 4
@staticmethod
def get_class(bible_format):
@@ -68,6 +70,8 @@
return OpenSongBible
elif bible_format == BibleFormat.WebDownload:
return HTTPBible
+ elif bible_format == BibleFormat.Zefania:
+ return ZefaniaBible
else:
return None
@@ -81,6 +85,7 @@
BibleFormat.CSV,
BibleFormat.OpenSong,
BibleFormat.WebDownload,
+ BibleFormar.Zefania,
]
=== modified file 'openlp/plugins/bibles/lib/opensong.py'
--- openlp/plugins/bibles/lib/opensong.py 2014-04-16 19:56:54 +0000
+++ openlp/plugins/bibles/lib/opensong.py 2014-05-21 09:40:04 +0000
@@ -81,6 +81,13 @@
import_file = open(self.filename, 'rb')
opensong = objectify.parse(import_file)
bible = opensong.getroot()
+ # Check that we're not trying to import a Zefania XML bible, it is sometimes refered to as 'OpenSong'
+ if bible.tag.upper() == 'XMLBIBLE':
+ critical_error_message_box(
+ message=translate('BiblesPlugin.OpenSongImport',
+ 'Incorrect Bible file type supplied. This looks like a Zefania XML bible, '
+ 'please use the Zefania import option.'))
+ return False
language_id = self.get_language(bible_name)
if not language_id:
log.error('Importing books from "%s" failed' % self.filename)
=== added file 'openlp/plugins/bibles/lib/zefania.py'
--- openlp/plugins/bibles/lib/zefania.py 1970-01-01 00:00:00 +0000
+++ openlp/plugins/bibles/lib/zefania.py 2014-05-21 09:40:04 +0000
@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+
+import logging
+from lxml import etree, objectify
+
+from openlp.core.common import translate
+from openlp.core.lib.ui import critical_error_message_box
+from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB
+
+
+log = logging.getLogger(__name__)
+
+
+class ZefaniaBible(BibleDB):
+ """
+ Zefania Bible format importer class.
+ """
+ def __init__(self, parent, **kwargs):
+ """
+ Constructor to create and set up an instance of the ZefaniaBible class. This class is used to import Bibles
+ from ZefaniaBible's XML format.
+ """
+ log.debug(self.__class__.__name__)
+ BibleDB.__init__(self, parent, **kwargs)
+ self.filename = kwargs['filename']
+
+ def do_import(self, bible_name=None):
+ """
+ Loads a Bible from file.
+ """
+ log.debug('Starting Zefania import from "%s"' % self.filename)
+ if not isinstance(self.filename, str):
+ self.filename = str(self.filename, 'utf8')
+ import_file = None
+ success = True
+ try:
+ # NOTE: We don't need to do any of the normal encoding detection here, because lxml does it's own encoding
+ # detection, and the two mechanisms together interfere with each other.
+ import_file = open(self.filename, 'rb')
+ language_id = self.get_language(bible_name)
+ if not language_id:
+ log.error('Importing books from "%s" failed' % self.filename)
+ return False
+ zefania_bible_tree = etree.parse(import_file)
+ num_books = int(zefania_bible_tree.xpath("count(//BIBLEBOOK)"))
+ # Strip tags we don't use - keep content
+ etree.strip_tags(zefania_bible_tree, ('STYLE', 'GRAM', 'NOTE', 'SUP', 'XREF'))
+ # Strip tags we don't use - remove content
+ etree.strip_elements(zefania_bible_tree, ('PROLOG', 'REMARK', 'CAPTION', 'MEDIA'), with_tail=False)
+ xmlbible = zefania_bible_tree.getroot()
+ for BIBLEBOOK in xmlbible:
+ book_ref_id = self.get_book_ref_id_by_name(str(BIBLEBOOK.get('bname')), num_books)
+ if not book_ref_id:
+ book_ref_id = self.get_book_ref_id_by_localised_name(str(BIBLEBOOK.get('bname')))
+ if not book_ref_id:
+ log.error('Importing books from "%s" failed' % self.filename)
+ return False
+ book_details = BiblesResourcesDB.get_book_by_id(book_ref_id)
+ db_book = self.create_book(book_details['name'], book_ref_id, book_details['testament_id'])
+ for CHAPTER in BIBLEBOOK:
+ if self.stop_import_flag:
+ break
+ chapter_number = CHAPTER.get("cnumber")
+ for VERS in CHAPTER:
+ verse_number = VERS.get("vnumber")
+ self.create_verse(db_book.id, chapter_number, verse_number, VERS.text.replace('<BR/>', '\n'))
+ self.wizard.increment_progress_bar(
+ translate('BiblesPlugin.Zefnia', 'Importing %(bookname)s %(chapter)s...' %
+ {'bookname': db_book.name, 'chapter': chapter_number}))
+ self.session.commit()
+ self.application.process_events()
+ except Exception as e:
+ print(str(e))
+ critical_error_message_box(
+ message=translate('BiblesPlugin.ZefaniaImport',
+ 'Incorrect Bible file type supplied. Zefania Bibles may be '
+ 'compressed. You must decompress them before import.'))
+ log.exception(str(e))
+ success = False
+ finally:
+ if import_file:
+ import_file.close()
+ if self.stop_import_flag:
+ return False
+ else:
+ return success
=== modified file 'openlp/plugins/songs/lib/ewimport.py'
--- openlp/plugins/songs/lib/ewimport.py 2014-05-05 17:29:57 +0000
+++ openlp/plugins/songs/lib/ewimport.py 2014-05-21 09:40:04 +0000
@@ -344,7 +344,7 @@
try:
decoded_words = words.decode()
except UnicodeDecodeError:
- # The unicode chars in the rtf was not escaped in the expected manor
+ # The unicode chars in the rtf was not escaped in the expected manner
self.entry_error_log = translate('SongsPlugin.EasyWorshipSongImport',
'Unexpected data formatting.')
return
=== added file 'tests/functional/openlp_plugins/bibles/test_opensongimport.py'
--- tests/functional/openlp_plugins/bibles/test_opensongimport.py 1970-01-01 00:00:00 +0000
+++ tests/functional/openlp_plugins/bibles/test_opensongimport.py 2014-05-21 09:40:04 +0000
@@ -0,0 +1,140 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+This module contains tests for the OpenSong Bible importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.bibles.lib.opensong import OpenSongBible
+from openlp.plugins.bibles.lib.db import BibleDB
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+ '..', '..', '..', 'resources', 'bibles'))
+OPENSONG_TEST_DATA = {
+ 'opensong-dk1933.xml': {
+ 'book': 'Genesis',
+ 'chapter': 1,
+ 'verses': [
+ (1, 'I Begyndelsen skabte Gud Himmelen og Jorden.'),
+ (2, 'Og Jorden var øde og tom, og der var Mørke over Verdensdybet. '
+ 'Men Guds Ånd svævede over Vandene.'),
+ (3, 'Og Gud sagde: "Der blive Lys!" Og der blev Lys.'),
+ (4, 'Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,'),
+ (5, 'og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, '
+ 'og det blev Morgen, første Dag.'),
+ (6, 'Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"'),
+ (7, 'Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen '
+ 'fra Vandet over Hvælvingen;'),
+ (8, 'og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.'),
+ (9, 'Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" '
+ 'Og således skete det;'),
+ (10, 'og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, '
+ 'at det var godt.')
+ ]
+ }
+}
+
+
+class TestOpenSongImport(TestCase):
+ """
+ Test the functions in the :mod:`opensongimport` module.
+ """
+
+ def setUp(self):
+ self.registry_patcher = patch('openlp.plugins.bibles.lib.db.Registry')
+ self.registry_patcher.start()
+ self.manager_patcher = patch('openlp.plugins.bibles.lib.db.Manager')
+ self.manager_patcher.start()
+
+ def tearDown(self):
+ self.registry_patcher.stop()
+ self.manager_patcher.stop()
+
+ def create_importer_test(self):
+ """
+ Test creating an instance of the OpenSong file importer
+ """
+ # GIVEN: A mocked out "manager"
+ mocked_manager = MagicMock()
+
+ # WHEN: An importer object is created
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+
+ # THEN: The importer should be an instance of BibleDB
+ self.assertIsInstance(importer, BibleDB)
+
+ def file_import_test(self):
+ """
+ Test the actual import of real song files
+ """
+ # GIVEN: Test files with a mocked out "manager", "import_wizard", and mocked functions
+ # get_book_ref_id_by_name, create_verse, create_book, session and get_language.
+ with patch('openlp.plugins.bibles.lib.opensong.OpenSongBible.application'):
+ for bible_file in OPENSONG_TEST_DATA:
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+ importer.wizard = mocked_import_wizard
+ importer.get_book_ref_id_by_name = MagicMock()
+ importer.create_verse = MagicMock()
+ importer.create_book = MagicMock()
+ importer.session = MagicMock()
+ importer.get_language = MagicMock()
+ importer.get_language.return_value = 'Danish'
+
+ # WHEN: Importing bible file
+ importer.filename = os.path.join(TEST_PATH, bible_file)
+ importer.do_import()
+
+ # THEN: The create_verse() method should have been called with each verse in the file.
+ self.assertTrue(importer.create_verse.called)
+ for verse_tag, verse_text in OPENSONG_TEST_DATA[bible_file]['verses']:
+ importer.create_verse.assert_any_call(importer.create_book().id, 1, verse_tag, verse_text)
+
+ def zefania_import_error_test(self):
+ """
+ Test that we give an error message if trying to import a zefania bible
+ """
+ # GIVEN: A mocked out "manager" and mocked out critical_error_message_box and an import
+ with patch('openlp.plugins.bibles.lib.opensong.critical_error_message_box') as \
+ mocked_critical_error_message_box:
+ mocked_manager = MagicMock()
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+
+ # WHEN: An trying to import a zefania bible
+ importer.filename = os.path.join(TEST_PATH, 'zefania-dk1933.xml')
+ importer.do_import()
+
+ # THEN: The importer should have "shown" an error message
+ mocked_critical_error_message_box.assert_called_with(message='Incorrect Bible file type supplied. '
+ 'This looks like a Zefania XML bible, '
+ 'please use the Zefania import option.')
=== added file 'tests/functional/openlp_plugins/bibles/test_zefaniaimport.py'
--- tests/functional/openlp_plugins/bibles/test_zefaniaimport.py 1970-01-01 00:00:00 +0000
+++ tests/functional/openlp_plugins/bibles/test_zefaniaimport.py 2014-05-21 09:40:04 +0000
@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+This module contains tests for the Zefania Bible importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.bibles.lib.zefania import ZefaniaBible
+from openlp.plugins.bibles.lib.db import BibleDB
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+ '..', '..', '..', 'resources', 'bibles'))
+ZEFANIA_TEST_DATA = {
+ 'zefania-dk1933.xml': {
+ 'book': 'Genesis',
+ 'chapter': 1,
+ 'verses': [
+ ('1', 'I Begyndelsen skabte Gud Himmelen og Jorden.'),
+ ('2', 'Og Jorden var øde og tom, og der var Mørke over Verdensdybet. '
+ 'Men Guds Ånd svævede over Vandene.'),
+ ('3', 'Og Gud sagde: "Der blive Lys!" Og der blev Lys.'),
+ ('4', 'Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,'),
+ ('5', 'og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, '
+ 'og det blev Morgen, første Dag.'),
+ ('6', 'Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"'),
+ ('7', 'Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen '
+ 'fra Vandet over Hvælvingen;'),
+ ('8', 'og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.'),
+ ('9', 'Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" '
+ 'Og således skete det;'),
+ ('10', 'og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, '
+ 'at det var godt.')
+ ]
+ }
+}
+
+
+class TestZefaniaImport(TestCase):
+ """
+ Test the functions in the :mod:`zefaniaimport` module.
+ """
+
+ def setUp(self):
+ self.registry_patcher = patch('openlp.plugins.bibles.lib.db.Registry')
+ self.registry_patcher.start()
+ self.manager_patcher = patch('openlp.plugins.bibles.lib.db.Manager')
+ self.manager_patcher.start()
+
+ def tearDown(self):
+ self.registry_patcher.stop()
+ self.manager_patcher.stop()
+
+ def create_importer_test(self):
+ """
+ Test creating an instance of the Zefania file importer
+ """
+ # GIVEN: A mocked out "manager"
+ mocked_manager = MagicMock()
+
+ # WHEN: An importer object is created
+ importer = ZefaniaBible(mocked_manager, path='.', name='.', filename='')
+
+ # THEN: The importer should be an instance of BibleDB
+ self.assertIsInstance(importer, BibleDB)
+
+ def file_import_test(self):
+ """
+ Test the actual import of real song files
+ """
+ # GIVEN: Test files with a mocked out "manager", "import_wizard", and mocked functions
+ # get_book_ref_id_by_name, create_verse, create_book, session and get_language.
+ with patch('openlp.plugins.bibles.lib.zefania.ZefaniaBible.application'):
+ for bible_file in ZEFANIA_TEST_DATA:
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = ZefaniaBible(mocked_manager, path='.', name='.', filename='')
+ importer.wizard = mocked_import_wizard
+ importer.get_book_ref_id_by_name = MagicMock()
+ importer.create_verse = MagicMock()
+ importer.create_book = MagicMock()
+ importer.session = MagicMock()
+ importer.get_language = MagicMock()
+ importer.get_language.return_value = 'Danish'
+
+ # WHEN: Importing bible file
+ importer.filename = os.path.join(TEST_PATH, bible_file)
+ importer.do_import()
+
+ # THEN: The create_verse() method should have been called with each verse in the file.
+ self.assertTrue(importer.create_verse.called)
+ for verse_tag, verse_text in ZEFANIA_TEST_DATA[bible_file]['verses']:
+ importer.create_verse.assert_any_call(importer.create_book().id, '1', verse_tag, verse_text)
=== added file 'tests/resources/bibles/opensong-dk1933.xml'
--- tests/resources/bibles/opensong-dk1933.xml 1970-01-01 00:00:00 +0000
+++ tests/resources/bibles/opensong-dk1933.xml 2014-05-21 09:40:04 +0000
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Visit the online documentation for Zefania XML Markup-->
+<!--http://bgfdb.de/zefaniaxml/bml/-->
+<!--Download another Zefania XML files from-->
+<!--http://sourceforge.net/projects/zefania-sharp-->
+<bible>
+ <!-- The INFORMATION-tag is a leftover from the original zefania bible, but is ignored by opensong format -->
+ <INFORMATION>
+ <title>Danish Version</title>
+ <creator>
+ </creator>
+ <subject>The Holy Bible</subject>
+ <description>The electronic edition of this Bible comes from the Danish 1933 edition. The Old Testament is an update from the 1931 edition, and the New Testament is an update from the 1907 edition.</description>
+ <publisher>Free Bible Software Group</publisher>
+ <contributors>
+ The Unbound Bible
+ Biola University: Administrative Computing
+ 13800 Biola Ave.
+ La Mirada, CA 90639
+ United States of America
+ 562-903-4722
+ </contributors>
+ <date>2009-01-20</date>
+ <format>Zefania XML Bible Markup Language</format>
+ <identifier>DAN</identifier>
+ <source>ftp://unboundftp.biola.edu/pub/danish1933_utf8.zip</source>
+ <language>DAN</language>
+ <coverage>provide the bible to the world</coverage>
+ <rights></rights>
+ <type />
+ </INFORMATION>
+ <b n="Genesis">
+ <c n="1">
+ <v n="1">I Begyndelsen skabte Gud Himmelen og Jorden.</v>
+ <v n="2">Og Jorden var øde og tom, og der var Mørke over Verdensdybet. Men Guds Ånd svævede over Vandene.</v>
+ <v n="3">Og Gud sagde: "Der blive Lys!" Og der blev Lys.</v>
+ <v n="4">Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,</v>
+ <v n="5">og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, og det blev Morgen, første Dag.</v>
+ <v n="6">Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"</v>
+ <v n="7">Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen fra Vandet over Hvælvingen;</v>
+ <v n="8">og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.</v>
+ <v n="9">Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" Og således skete det;</v>
+ <v n="10">og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, at det var godt.</v>
+ </c>
+ </b>
+</bible>
=== added file 'tests/resources/bibles/zefania-dk1933.xml'
--- tests/resources/bibles/zefania-dk1933.xml 1970-01-01 00:00:00 +0000
+++ tests/resources/bibles/zefania-dk1933.xml 2014-05-21 09:40:04 +0000
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Visit the online documentation for Zefania XML Markup-->
+<!--http://bgfdb.de/zefaniaxml/bml/-->
+<!--Download another Zefania XML files from-->
+<!--http://sourceforge.net/projects/zefania-sharp-->
+<XMLBIBLE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:noNamespaceSchemaLocation="C:\Users\tgc\Downloads\zef2005.xsd" biblename="Danish Version" status="v" version="2.0.1.18" type="x-bible" revision="0">
+ <INFORMATION>
+ <title>Danish Version</title>
+ <creator>
+ </creator>
+ <subject>The Holy Bible</subject>
+ <description>The electronic edition of this Bible comes from the Danish 1933 edition. The Old Testament is an update from the 1931 edition, and the New Testament is an update from the 1907 edition.</description>
+ <publisher>Free Bible Software Group</publisher>
+ <contributors>
+ The Unbound Bible
+ Biola University: Administrative Computing
+ 13800 Biola Ave.
+ La Mirada, CA 90639
+ United States of America
+ 562-903-4722
+ </contributors>
+ <date>2009-01-20</date>
+ <format>Zefania XML Bible Markup Language</format>
+ <identifier>DAN</identifier>
+ <source>ftp://unboundftp.biola.edu/pub/danish1933_utf8.zip</source>
+ <language>DAN</language>
+ <coverage>provide the bible to the world</coverage>
+ <rights></rights>
+ <type />
+ </INFORMATION>
+ <BIBLEBOOK bnumber="1" bname="Genesis" bsname="1Mo">
+ <CHAPTER cnumber="1">
+ <VERS vnumber="1">I <STYLE css="font-style:italic">Begyndelsen</STYLE> skabte Gud Himmelen og Jorden.</VERS>
+ <VERS vnumber="2">Og Jorden var øde og tom, og der var Mørke over Verdensdybet. Men Guds Ånd svævede over Vandene.</VERS>
+ <VERS vnumber="3">Og Gud sagde: "Der blive Lys!" Og der blev Lys.</VERS>
+ <VERS vnumber="4">Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,</VERS>
+ <VERS vnumber="5">og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, og det blev Morgen, første Dag.</VERS>
+ <VERS vnumber="6">Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"</VERS>
+ <VERS vnumber="7">Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen fra Vandet over Hvælvingen;</VERS>
+ <VERS vnumber="8">og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.</VERS>
+ <VERS vnumber="9">Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" Og således skete det;</VERS>
+ <VERS vnumber="10">og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, at det var godt.</VERS>
+ </CHAPTER>
+ </BIBLEBOOK>
+</XMLBIBLE>
\ No newline at end of file
References
