merge trunk

openlp/plugins/bibles/lib/opensong.py

@@ -73,13 +73,13 @@ class OpenSongBible(BibleDB):
         log.debug('Starting OpenSong import from "%s"' % self.filename)
         if not isinstance(self.filename, str):
             self.filename = str(self.filename, 'utf8')
-        file = None
+        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.
-            file = open(self.filename, 'r')
+            import_file = open(self.filename, 'rb')
-            opensong = objectify.parse(file)
+            opensong = objectify.parse(import_file)
             bible = opensong.getroot()
             language_id = self.get_language(bible_name)
             if not language_id:
@@ -93,7 +93,7 @@ class OpenSongBible(BibleDB):
                     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(str(book.attrib['n']), book_ref_id, book_details['testament_id'])
+                db_book = self.create_book(book.attrib['n'], book_ref_id, book_details['testament_id'])
                 chapter_number = 0
                 for chapter in book.c:
                     if self.stop_import_flag:
@@ -122,8 +122,8 @@ class OpenSongBible(BibleDB):
                             verse_number += 1
                         self.create_verse(db_book.id, chapter_number, verse_number, self.get_text(verse))
                     self.wizard.increment_progress_bar(
-                        translate('BiblesPlugin.Opensong', 'Importing %s %s...',
+                        translate('BiblesPlugin.Opensong', 'Importing %(bookname)s %(chapter)s...' %
-                                  'Importing <book name> <chapter>...')) % (db_book.name, chapter_number)
+                                  {'bookname': db_book.name, 'chapter': chapter_number}))
                 self.session.commit()
             self.application.process_events()
         except etree.XMLSyntaxError as inst:
@@ -137,8 +137,8 @@ class OpenSongBible(BibleDB):
             log.exception('Loading Bible from OpenSong file failed')
             success = False
         finally:
-            if file:
+            if import_file:
-                file.close()
+                import_file.close()
         if self.stop_import_flag:
             return False
         else:

openlp/plugins/songs/lib/mediaitem.py

@@ -192,7 +192,7 @@ class SongMediaItem(MediaManagerItem):
             song_number = False
             if not search_results:
                 search_keywords = search_keywords.rpartition(' ')
-                search_string = '%' + search_keywords + '%'
+                search_string = '%' + search_keywords[0] + '%'
                 search_results = self.plugin.manager.get_all_objects(Book,
                                                                      Book.name.like(search_string), Book.name.asc())
                 song_number = re.sub(r'[^0-9]', '', search_keywords[2])

openlp/plugins/songs/lib/openlyricsimport.py

@@ -53,7 +53,7 @@ class OpenLyricsImport(SongImport):
         Initialise the Open Lyrics importer.
         """
         log.debug('initialise OpenLyricsImport')
-        SongImport.__init__(self, manager, **kwargs)
+        super(OpenLyricsImport, self).__init__(manager, **kwargs)
         self.open_lyrics = OpenLyrics(self.manager)
 
     def do_import(self):
@@ -69,7 +69,7 @@ class OpenLyricsImport(SongImport):
             try:
                 # Pass a file object, because lxml does not cope with some
                 # special characters in the path (see lp:757673 and lp:744337).
-                parsed_file = etree.parse(open(file_path, 'r'), parser)
+                parsed_file = etree.parse(open(file_path, 'rb'), parser)
                 xml = etree.tostring(parsed_file).decode()
                 self.open_lyrics.xml_to_song(xml)
             except etree.XMLSyntaxError:

scripts/translation_utils.py

@@ -96,7 +96,7 @@ class CommandStack(object):
         return len(self.data)
 
     def __getitem__(self, index):
-        if not index in self.data:
+        if index not in self.data:
             return None
         elif self.data[index].get('arguments'):
             return self.data[index]['command'], self.data[index]['arguments']

tests/functional/openlp_core_common/test_common.py

@@ -79,5 +79,5 @@ class TestCommonFunctions(TestCase):
             trace_error_handler(mocked_logger)
 
             # THEN: The mocked_logger.error() method should have been called with the correct parameters
-            mocked_logger.error.assert_called_with('OpenLP Error trace\n   File openlp.fake at line 56 \n\t called trace_error_handler_test')
+            mocked_logger.error.assert_called_with(
-
+                'OpenLP Error trace\n   File openlp.fake at line 56 \n\t called trace_error_handler_test')

tests/functional/openlp_plugins/songs/test_ewimport.py

@@ -403,8 +403,8 @@ class TestEasyWorshipSongImport(TestCase):
                 if song_copyright:
                     self.assertEqual(importer.copyright, song_copyright)
                 if ccli_number:
-                    self.assertEqual(importer.ccli_number, ccli_number, 'ccli_number for %s should be %s'
+                    self.assertEqual(importer.ccli_number, ccli_number,
-                                                                         % (title, ccli_number))
+                                     'ccli_number for %s should be %s' % (title, ccli_number))
                 for verse_text, verse_tag in add_verse_calls:
                     mocked_add_verse.assert_any_call(verse_text, verse_tag)
                 if verse_order_list:

tests/functional/openlp_plugins/songs/test_lib.py

@@ -129,7 +129,6 @@ class TestLib(TestCase):
         # THEN: The result should be a tuple of songs..
         assert result == (self.song1, self.song2), 'The result should be the tuble of songs'
 
-
     def songs_probably_equal_different_song_test(self):
         """
         Test the songs_probably_equal function with two different songs.

tests/functional/openlp_plugins/songs/test_openlyricsimport.py

@@ -0,0 +1,99 @@
+# -*- 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 OpenLyrics song importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.songs.lib.openlyricsimport import OpenLyricsImport
+from openlp.plugins.songs.lib.songimport import SongImport
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+                                         '..', '..', '..', 'resources', 'openlyricssongs'))
+SONG_TEST_DATA = {
+    'What a friend we have in Jesus.xml': {
+        'title': 'What A Friend We Have In Jesus',
+        'verses': [
+            ('What a friend we have in Jesus, All ours sins and griefs to bear;\n\
+             What a privilege to carry, Everything to God in prayer!\n\
+             O what peace we often forfeit, O what needless pain we bear;\n\
+             All because we do not carry, Everything to God in prayer!', 'v1'),
+            ('Have we trials and temptations? Is there trouble anywhere?\n\
+             We should never be discouraged, Take it to the Lord in prayer.\n\
+             Can we find a friend so faithful? Who will all our sorrows share?\n\
+             Jesus knows our every weakness; Take it to the Lord in prayer.', 'v2'),
+            ('Are we weak and heavy laden, Cumbered with a load of care?\n\
+             Precious Saviour still our refuge; Take it to the Lord in prayer.\n\
+             Do thy friends despise forsake thee? Take it to the Lord in prayer!\n\
+             In His arms He’ll take and shield thee; Thou wilt find a solace there.', 'v3')
+        ]
+    }
+}
+
+
+class TestOpenLyricsImport(TestCase):
+    """
+    Test the functions in the :mod:`openlyricsimport` module.
+    """
+    def create_importer_test(self):
+        """
+        Test creating an instance of the OpenLyrics file importer
+        """
+        # GIVEN: A mocked out SongImport class, and a mocked out "manager"
+        with patch('openlp.plugins.songs.lib.songbeamerimport.SongImport'):
+            mocked_manager = MagicMock()
+
+            # WHEN: An importer object is created
+            importer = OpenLyricsImport(mocked_manager, filenames=[])
+
+            # THEN: The importer should be an instance of SongImport
+            self.assertIsInstance(importer, SongImport)
+
+    def file_import_test(self):
+        """
+        Test the actual import of real song files
+        """
+        # GIVEN: Test files with a mocked out "manager" and a mocked out "import_wizard"
+        for song_file in SONG_TEST_DATA:
+            mocked_manager = MagicMock()
+            mocked_import_wizard = MagicMock()
+            importer = OpenLyricsImport(mocked_manager, filenames=[])
+            importer.import_wizard = mocked_import_wizard
+            importer.open_lyrics = MagicMock()
+            importer.open_lyrics.xml_to_song = MagicMock()
+
+            # WHEN: Importing each file
+            importer.import_source = [os.path.join(TEST_PATH, song_file)]
+            importer.do_import()
+
+            # THEN: The xml_to_song() method should have been called
+            self.assertTrue(importer.open_lyrics.xml_to_song.called)

tests/functional/openlp_plugins/songs/test_songbeamerimport.py

@@ -49,7 +49,8 @@ SONG_TEST_DATA = {
             ('4. Lobsingt seiner Treu´,\ndie immerdar neu,\nbis Er uns zur Herrlichket führet!\n\n', 'v')
         ],
         'song_book_name': 'Glaubenslieder I',
-        'song_number': "1"
+        'song_number': "1",
+        'authors': ['Carl Brockhaus', 'Johann Jakob Vetter']
     }
 }
 
@@ -140,6 +141,7 @@ class TestSongBeamerImport(TestCase):
                 add_verse_calls = SONG_TEST_DATA[song_file]['verses']
                 song_book_name = SONG_TEST_DATA[song_file]['song_book_name']
                 song_number = SONG_TEST_DATA[song_file]['song_number']
+                song_authors = SONG_TEST_DATA[song_file]['authors']
 
                 # THEN: do_import should return none, the song data should be as expected, and finish should have been
                 #       called.
@@ -148,11 +150,14 @@ class TestSongBeamerImport(TestCase):
                 for verse_text, verse_tag in add_verse_calls:
                     mocked_add_verse.assert_any_call(verse_text, verse_tag)
                 if song_book_name:
-                    self.assertEqual(importer.song_book_name, song_book_name, 'song_book_name for %s should be "%s"' %
+                    self.assertEqual(importer.song_book_name, song_book_name,
-                                                                               (song_file, song_book_name))
+                                     'song_book_name for %s should be "%s"' % (song_file, song_book_name))
                 if song_number:
-                    self.assertEqual(importer.song_number, song_number, 'song_number for %s should be %s' %
+                    self.assertEqual(importer.song_number, song_number,
-                                                                         (song_file, song_number))
+                                     'song_number for %s should be %s' % (song_file, song_number))
+                if song_authors:
+                    for author in importer.authors:
+                        self.assertIn(author, song_authors)
                 mocked_finish.assert_called_with()
 
     def check_verse_marks_test(self):

tests/helpers/songfileimport.py

@@ -116,24 +116,24 @@ class SongImportTestHelper(TestCase):
         if song_copyright:
             self.mocked_add_copyright.assert_called_with(song_copyright)
         if ccli_number:
-            self.assertEqual(importer.ccli_number, ccli_number, 'ccli_number for %s should be %s' %
+            self.assertEqual(importer.ccli_number, ccli_number,
-                                                                 (source_file_name, ccli_number))
+                             'ccli_number for %s should be %s' % (source_file_name, ccli_number))
         for verse_text, verse_tag in add_verse_calls:
             self.mocked_add_verse.assert_any_call(verse_text, verse_tag)
         if topics:
             self.assertEqual(importer.topics, topics, 'topics for %s should be %s' % (source_file_name, topics))
         if comments:
-            self.assertEqual(importer.comments, comments, 'comments for %s should be "%s"' %
+            self.assertEqual(importer.comments, comments,
-                                                           (source_file_name, comments))
+                             'comments for %s should be "%s"' % (source_file_name, comments))
         if song_book_name:
-            self.assertEqual(importer.song_book_name, song_book_name, 'song_book_name for %s should be "%s"' %
+            self.assertEqual(importer.song_book_name, song_book_name,
-                                                                       (source_file_name, song_book_name))
+                             'song_book_name for %s should be "%s"' % (source_file_name, song_book_name))
         if song_number:
-            self.assertEqual(importer.song_number, song_number, 'song_number for %s should be %s' %
+            self.assertEqual(importer.song_number, song_number,
-                                                                 (source_file_name, song_number))
+                             'song_number for %s should be %s' % (source_file_name, song_number))
         if verse_order_list:
-            self.assertEqual(importer.verse_order_list, [], 'verse_order_list for %s should be %s' %
+            self.assertEqual(importer.verse_order_list, [],
-                                                             (source_file_name, verse_order_list))
+                             'verse_order_list for %s should be %s' % (source_file_name, verse_order_list))
         self.mocked_finish.assert_called_with()
 
     def _get_data(self, data, key):

tests/interfaces/openlp_plugins/bibles/test_lib_parse_reference.py

@@ -103,5 +103,5 @@ class TestBibleManager(TestCase, TestMixin):
         # WHEN asking to parse the bible reference
         results = parse_reference('1 Timothy 1:1-2:1', self.manager.db_cache['tests'], MagicMock(), 54)
         # THEN a verse array should be returned
-        self.assertEqual([(54, 1, 1, -1), (54, 2, 1, 1)], results, "The bible verses should matches the expected "
+        self.assertEqual([(54, 1, 1, -1), (54, 2, 1, 1)], results,
-                                                                    "results")
+                         "The bible verses should match the expected results")

tests/resources/openlyricssongs/What a friend we have in Jesus.xml

@@ -0,0 +1,44 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<song xmlns="http://openlyrics.info/namespace/2009/song" version="0.8" createdIn="opensong2openlyrics.py 0.1" modifiedIn="convert-schema.py" modifiedDate="2013-03-12T09:13:04.212538">
+  <properties>
+    <titles>
+      <title>What A Friend We Have In Jesus</title>
+    </titles>
+    <authors>
+      <author>Joseph M. Scriven</author>
+      <author>Charles C. Convers</author>
+    </authors>
+    <copyright>Public Domain</copyright>
+    <ccliNo>27714</ccliNo>
+    <themes>
+      <theme>Christ: Love/Mercy</theme>
+      <theme>Fruit: Peace/Comfort</theme>
+    </themes>
+  </properties>
+  <lyrics>
+    <verse name="v1">
+      <lines>
+        What a friend we have in Jesus, All ours sins and griefs to bear;<br/>
+        What a privilege to carry, Everything to God in prayer!<br/>
+        O what peace we often forfeit, O what needless pain we bear;<br/>
+        All because we do not carry, Everything to God in prayer!
+      </lines>
+    </verse>
+    <verse name="v2">
+      <lines>
+        Have we trials and temptations? Is there trouble anywhere?<br/>
+        We should never be discouraged, Take it to the Lord in prayer.<br/>
+        Can we find a friend so faithful? Who will all our sorrows share?<br/>
+        Jesus knows our every weakness; Take it to the Lord in prayer.
+      </lines>
+    </verse>
+    <verse name="v3">
+      <lines>
+        Are we weak and heavy laden, Cumbered with a load of care?<br/>
+        Precious Saviour still our refuge; Take it to the Lord in prayer.<br/>
+        Do thy friends despise forsake thee? Take it to the Lord in prayer!<br/>
+        In His arms He’ll take and shield thee; Thou wilt find a solace there.
+      </lines>
+    </verse>
+  </lyrics>
+</song>

tests/resources/songbeamersongs/Lobsinget dem Herrn.sng

@@ -1,5 +1,7 @@
 #LangCount=1
 #Title=GL 1 - Lobsinget dem Herrn
+#Author=Carl Brockhaus
+#Melody=Johann Jakob Vetter
 #Editor=SongBeamer 4.20
 #Version=3
 #Format=F/K//