Add an option to display the songbook in the footer

bzr-revno: 2381

openlp/plugins/songs/lib/mediaitem.py

@@ -36,8 +36,8 @@ from PyQt4 import QtCore, QtGui
 from sqlalchemy.sql import or_
 
 from openlp.core.common import Registry, AppLocation, Settings, check_directory_exists, UiStrings, translate
-from openlp.core.lib import MediaManagerItem, ItemCapabilities, PluginStatus, ServiceItemContext, check_item_selected, \
+from openlp.core.lib import MediaManagerItem, ItemCapabilities, PluginStatus, ServiceItem, ServiceItemContext, \
-    create_separated_list
+    check_item_selected, create_separated_list
 from openlp.core.lib.ui import create_widget_action
 from openlp.plugins.songs.forms.editsongform import EditSongForm
 from openlp.plugins.songs.forms.songmaintenanceform import SongMaintenanceForm
@@ -124,7 +124,8 @@ class SongMediaItem(MediaManagerItem):
         log.debug('config_updated')
         self.search_as_you_type = Settings().value(self.settings_section + '/search as type')
         self.update_service_on_edit = Settings().value(self.settings_section + '/update service on edit')
-        self.add_song_from_service = Settings().value(self.settings_section + '/add song from service',)
+        self.add_song_from_service = Settings().value(self.settings_section + '/add song from service')
+        self.display_songbook = Settings().value(self.settings_section + '/display songbook')
 
     def retranslateUi(self):
         self.search_text_label.setText('%s:' % UiStrings().Search)
@@ -506,6 +507,8 @@ class SongMediaItem(MediaManagerItem):
             item.raw_footer.append("%s: %s" % (AuthorType.Types[AuthorType.Translation],
                                                create_separated_list(authors_translation)))
         item.raw_footer.append(song.copyright)
+        if self.display_songbook and song.book:
+            item.raw_footer.append("%s #%s" % (song.book.name, song.song_number))
         if Settings().value('core/ccli number'):
             item.raw_footer.append(translate('SongsPlugin.MediaItem',
                                              'CCLI License: ') + Settings().value('core/ccli number'))

openlp/plugins/songs/lib/songstab.py

@@ -59,6 +59,9 @@ class SongsTab(SettingsTab):
         self.add_from_service_check_box = QtGui.QCheckBox(self.mode_group_box)
         self.add_from_service_check_box.setObjectName('add_from_service_check_box')
         self.mode_layout.addWidget(self.add_from_service_check_box)
+        self.display_songbook_check_box = QtGui.QCheckBox(self.mode_group_box)
+        self.display_songbook_check_box.setObjectName('songbook_check_box')
+        self.mode_layout.addWidget(self.display_songbook_check_box)
         self.left_layout.addWidget(self.mode_group_box)
         self.left_layout.addStretch()
         self.right_layout.addStretch()
@@ -66,6 +69,7 @@ class SongsTab(SettingsTab):
         self.tool_bar_active_check_box.stateChanged.connect(self.on_tool_bar_active_check_box_changed)
         self.update_on_edit_check_box.stateChanged.connect(self.on_update_on_edit_check_box_changed)
         self.add_from_service_check_box.stateChanged.connect(self.on_add_from_service_check_box_changed)
+        self.display_songbook_check_box.stateChanged.connect(self.on_songbook_check_box_changed)
 
     def retranslateUi(self):
         self.mode_group_box.setTitle(translate('SongsPlugin.SongsTab', 'Songs Mode'))
@@ -75,6 +79,7 @@ class SongsTab(SettingsTab):
         self.update_on_edit_check_box.setText(translate('SongsPlugin.SongsTab', 'Update service from song edit'))
         self.add_from_service_check_box.setText(translate('SongsPlugin.SongsTab',
                                                           'Import missing songs from service files'))
+        self.display_songbook_check_box.setText(translate('SongsPlugin.SongsTab', 'Display songbook in footer'))
 
     def on_search_as_type_check_box_changed(self, check_state):
         self.song_search = (check_state == QtCore.Qt.Checked)
@@ -88,6 +93,9 @@ class SongsTab(SettingsTab):
     def on_add_from_service_check_box_changed(self, check_state):
         self.update_load = (check_state == QtCore.Qt.Checked)
 
+    def on_songbook_check_box_changed(self, check_state):
+        self.display_songbook = (check_state == QtCore.Qt.Checked)
+
     def load(self):
         settings = Settings()
         settings.beginGroup(self.settings_section)
@@ -95,10 +103,12 @@ class SongsTab(SettingsTab):
         self.tool_bar = settings.value('display songbar')
         self.update_edit = settings.value('update service on edit')
         self.update_load = settings.value('add song from service')
+        self.display_songbook = settings.value('display songbook')
         self.search_as_type_check_box.setChecked(self.song_search)
         self.tool_bar_active_check_box.setChecked(self.tool_bar)
         self.update_on_edit_check_box.setChecked(self.update_edit)
         self.add_from_service_check_box.setChecked(self.update_load)
+        self.display_songbook_check_box.setChecked(self.display_songbook)
         settings.endGroup()
 
     def save(self):
@@ -108,6 +118,7 @@ class SongsTab(SettingsTab):
         settings.setValue('display songbar', self.tool_bar)
         settings.setValue('update service on edit', self.update_edit)
         settings.setValue('add song from service', self.update_load)
+        settings.setValue('display songbook', self.display_songbook)
         settings.endGroup()
         if self.tab_visited:
             self.settings_form.register_post_process('songs_config_updated')

openlp/plugins/songs/songsplugin.py

@@ -63,6 +63,7 @@ __default_settings__ = {
     'songs/search as type': False,
     'songs/add song from service': True,
     'songs/display songbar': True,
+    'songs/display songbook': False,
     'songs/last directory import': '',
     'songs/last directory export': '',
     'songs/songselect username': '',

tests/functional/openlp_plugins/songs/test_mediaitem.py

@@ -1,8 +1,6 @@
 """
 This module contains tests for the lib submodule of the Songs plugin.
 """
-import os
-from tempfile import mkstemp
 from unittest import TestCase
 
 from PyQt4 import QtCore, QtGui
@@ -29,6 +27,7 @@ class TestMediaItem(TestCase, TestMixin):
         with patch('openlp.core.lib.mediamanageritem.MediaManagerItem._setup'), \
                 patch('openlp.plugins.songs.forms.editsongform.EditSongForm.__init__'):
             self.media_item = SongMediaItem(None, MagicMock())
+            self.media_item.display_songbook = False
         self.get_application()
         self.build_settings()
         QtCore.QLocale.setDefault(QtCore.QLocale('en_GB'))
@@ -128,3 +127,29 @@ class TestMediaItem(TestCase, TestMixin):
         # THEN: I would get an amended footer string
         self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright', 'CCLI License: 4321'],
                          'The array should be returned correctly with a song, an author, copyright and amended ccli')
+
+    def build_song_footer_base_songbook_test(self):
+        """
+        Test build songs footer with basic song and a songbook
+        """
+        # GIVEN: A Song and a Service Item
+        mock_song = MagicMock()
+        mock_song.title = 'My Song'
+        mock_song.copyright = 'My copyright'
+        mock_song.book = MagicMock()
+        mock_song.book.name = "My songbook"
+        mock_song.song_number = 12
+        service_item = ServiceItem(None)
+
+        # WHEN: I generate the Footer with default settings
+        self.media_item.generate_footer(service_item, mock_song)
+
+        # THEN: The songbook should not be in the footer
+        self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright'])
+
+        # WHEN: I activate the "display songbook" option
+        self.media_item.display_songbook = True
+        self.media_item.generate_footer(service_item, mock_song)
+
+        # THEN: The songbook should be in the footer
+        self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright', 'My songbook #12'])