Fix Songbook search

bzr-revno: 2366
Fixes: https://launchpad.net/bugs/1306958

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:

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/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>