"""
This module contains tests for the versereferencelist submodule of the Bibles plugin.
"""
from unittest import TestCase
from openlp.plugins.bibles.lib.versereferencelist import VerseReferenceList

class TestVerseReferenceList(TestCase):
    def setUp(self):
        """
        Initializes all we need
        """
        
    def add_first_verse_test(self):
        """
        Test the addition of a verse to the empty list
        """
        # GIVEN: an empty list
        reference_list = VerseReferenceList()
        book = u'testBook'
        chapter = 1
        verse = 1
        version = u'testVersion'
        copyright = u'testCopyright'
        permission = u'testPermision'
        
        # WHEN: We add it to the verse list
        reference_list.add(book, chapter, verse, version, copyright, permission)
        
        # THEN: The entries should be in the first entry of the list
        self.assertEqual(reference_list.current_index, 0, u'The current index should be 0')
        self.assertEqual(reference_list.verse_list[0][u'book'], book, u'The book in first entry should be %s' % book)
        self.assertEqual(reference_list.verse_list[0][u'chapter'], chapter, u'The chapter in first entry should be %u' % chapter)
        self.assertEqual(reference_list.verse_list[0][u'start'], verse, u'The start in first entry should be %u' % verse)
        self.assertEqual(reference_list.verse_list[0][u'version'], version, u'The version in first entry should be %s' % version)
        self.assertEqual(reference_list.verse_list[0][u'end'], verse, u'The end in first entry should be %u' % verse)
        
    def add_next_verse_test(self):
        """
        Test the addition of the following verse
        """
        # GIVEN: 1 line in the list of verses
        book = u'testBook'
        chapter = 1
        verse = 1
        next_verse = 2
        version = u'testVersion'
        copyright = u'testCopyright'
        permission = u'testPermision'
        reference_list = VerseReferenceList()
        reference_list.add(book, chapter, verse, version, copyright, permission)

        # WHEN: We add the following verse to the verse list
        reference_list.add(book, chapter, next_verse, version, copyright, permission)
        
        # THEN: The current index should be 0 and the end pointer of the entry should be '2'
        self.assertEqual(reference_list.current_index, 0, u'The current index should be 0')
        self.assertEqual(reference_list.verse_list[0][u'end'], next_verse, u'The end in first entry should be %u' % next_verse)

    def add_another_verse_test(self):
        """
        Test the addition of a verse in another book
        """
        # GIVEN: 1 line in the list of verses
        book = u'testBook'
        chapter = 1
        verse = 1
        next_verse = 2
        another_book = u'testBook2'
        another_chapter = 2
        another_verse = 5
        version = u'testVersion'
        copyright = u'testCopyright'
        permission = u'testPermision'
        reference_list = VerseReferenceList()
        reference_list.add(book, chapter, verse, version, copyright, permission)

        # WHEN: We add a verse of another book to the verse list
        reference_list.add(another_book, another_chapter, another_verse, version, copyright, permission)
        
        # THEN: the current index should be 1
        self.assertEqual(reference_list.current_index, 1, u'The current index should be 1')

    def add_version_test(self):
        """
        Test the addition of a version to the list
        """
        # GIVEN: version, copyright and permission
        reference_list = VerseReferenceList()
        version = u'testVersion'
        copyright = u'testCopyright'
        permission = u'testPermision'

        # WHEN: a not existing version will be added
        reference_list.add_version(version, copyright, permission)
        
        # THEN: the data will be appended to the list
        self.assertEqual(len(reference_list.version_list), 1, u'The version data should be appended')
        self.assertEqual(reference_list.version_list[0], {u'version': version, u'copyright': copyright, u'permission': permission},
            u'The version data should be appended')
        
    def add_existing_version_test(self):
        """
        Test the addition of an existing version to the list
        """
        # GIVEN: version, copyright and permission, added to the version list
        reference_list = VerseReferenceList()
        version = u'testVersion'
        copyright = u'testCopyright'
        permission = u'testPermision'
        reference_list.add_version(version, copyright, permission)
        
        # WHEN: an existing version will be added
        reference_list.add_version(version, copyright, permission)
        
        # THEN: the data will not be appended to the list
        self.assertEqual(len(reference_list.version_list), 1, u'The version data should not be appended')