tests and fix for Issue #118 (#121)

* tests and fix for Issue #118

* add missing link for 0.11.1 and update "unreleased" link

Author: avendesora

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.11.1] - 2023-10-02
+
+The goal of this release was to address [Issue #118] (When trying to get the scripture text for a verse that is in a book that is not included in the given version, the entire scripture text for that version was returned.)
+
+### Added
+
+- VersionMissingVerseError exception
+
+### Fixed
+
+- Raise an error when trying to get scripture text for a verse that is in a book that is not included in the given version.
+
 ## [0.11.0] - 2023-06-27
 
 ### Changed
@@ -102,7 +114,8 @@ The goal of this release was to address [Issue #90], and to make things related
 
 ## [0.0.1] - 2020-10-08
 
-[unreleased]: https://github.com/avendesora/pythonbible/compare/v0.11.0...HEAD
+[unreleased]: https://github.com/avendesora/pythonbible/compare/v0.11.1...HEAD
+[0.11.1]: https://github.com/avendesora/pythonbible/compare/v0.11.0...v0.11.1
 [0.11.0]: https://github.com/avendesora/pythonbible/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/avendesora/pythonbible/compare/v0.9.1...v0.10.0
 [0.9.1]: https://github.com/avendesora/pythonbible/compare/v0.9.0...v0.9.1
@@ -135,3 +148,4 @@ The goal of this release was to address [Issue #90], and to make things related
 [0.0.1]: https://github.com/avendesora/pythonbible
 
 [issue #90]: https://github.com/avendesora/pythonbible/issues/90
+[issue #118]: https://github.com/avendesora/pythonbible/issues/118

docs/source/conf.py

@@ -23,7 +23,7 @@
 author = "Nathan Patton"
 
 # The full version, including alpha/beta/rc tags
-release = "0.11.0"
+release = "0.11.1"
 
 
 # -- General configuration ---------------------------------------------------

pythonbible/__init__.py

@@ -8,7 +8,7 @@
 
 from __future__ import annotations
 
-__version__ = "0.11.0"
+__version__ = "0.11.1"
 
 from .bible.bible import Bible
 from .book_groups import BOOK_GROUPS
@@ -26,6 +26,7 @@
 from .errors import InvalidVerseError
 from .errors import MissingBookFileError
 from .errors import MissingVerseFileError
+from .errors import VersionMissingVerseError
 from .formatter import format_scripture_references
 from .formatter import format_scripture_text
 from .formatter import format_single_reference

pythonbible/bible/bible.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING
 
 from pythonbible.errors import InvalidVerseError
+from pythonbible.errors import VersionMissingVerseError
 from pythonbible.validator import is_valid_verse_id
 
 if TYPE_CHECKING:
@@ -58,10 +59,29 @@ def get_scripture(
             )
 
         end_verse_id = end_verse_id or start_verse_id
+        start_index, end_index = self._get_start_and_end_indices(
+            start_verse_id,
+            end_verse_id,
+        )
+
+        return _clean(self.scripture_content[start_index:end_index], self.is_html)
+
+    def _get_start_and_end_indices(
+        self: Bible,
+        start_verse_id: int,
+        end_verse_id: int,
+    ) -> tuple[int, int]:
         start_index = self.verse_start_indices.get(start_verse_id)
+
+        if start_index is None:
+            raise VersionMissingVerseError(start_verse_id, self.version.value)
+
         end_index = self.verse_end_indices.get(end_verse_id)
 
-        return _clean(self.scripture_content[start_index:end_index], self.is_html)
+        if end_index is None:
+            raise VersionMissingVerseError(end_verse_id, self.version.value)
+
+        return start_index, end_index
 
 
 @lru_cache()

pythonbible/errors.py

@@ -58,3 +58,19 @@ class MissingVerseFileError(Exception):
 
 class MissingBookFileError(Exception):
     """Raised when the book file for a given version is not found."""
+
+
+class VersionMissingVerseError(Exception):
+    """Raised when the verse for a given version is missing from the version."""
+
+    def __init__(
+        self: VersionMissingVerseError,
+        version: str,
+        verse_id: int,
+    ) -> None:
+        """Initialize VersionMissingVerseError.
+
+        :param version: version string
+        :param verse_id: verse id
+        """
+        super().__init__(f"{version} is missing verse {verse_id}.")

tests/bible_test.py

@@ -36,3 +36,13 @@ def test_get_scripture_cross_book() -> None:
 def test_get_scripture_missing_verse_in_version() -> None:
     scripture = asv_html_readers_bible.get_scripture(40017021, 40017021)
     assert not scripture
+
+
+def test_get_scripture_missing_book_in_version_start_index() -> None:
+    with pytest.raises(bible.VersionMissingVerseError):
+        asv_html_readers_bible.get_scripture(67001001, 67001001)
+
+
+def test_get_scripture_missing_book_in_version_end_index() -> None:
+    with pytest.raises(bible.VersionMissingVerseError):
+        asv_html_readers_bible.get_scripture(66001001, 67001001)

tests/formatter_test.py

@@ -180,12 +180,35 @@ def test_get_verse_text_no_version_file(verse_id: int) -> None:
     # Given a valid verse id and a version that doesn't have a file
     version: bible.Version = bible.Version.MESSAGE
 
-    # When using that verse id and version to the get the verse text
+    # When using that verse id and version to get the verse text
     # Then a MissingVerseFileError is raised.
     with pytest.raises(bible.MissingVerseFileError):
         bible.get_verse_text(verse_id, version=version)
 
 
+def test_get_verse_text_verse_omitted_from_version() -> None:
+    # Given a valid verse id for a verse that has been omitted from the given version
+    version: bible.Version = bible.Version.AMERICAN_STANDARD
+    verse_id: int = 40018011
+
+    # When using that verse id and version to get the verse text
+    verse_text: str = bible.get_verse_text(verse_id, version=version)
+
+    # Then the verse text is empty.
+    assert not verse_text
+
+
+def test_get_verse_text_version_not_include_book() -> None:
+    # Given a valid verse id for a verse in a book not included in the given version
+    version: bible.Version = bible.Version.AMERICAN_STANDARD
+    verse_id: int = 67001009
+
+    # When using that verse id and version to get the verse text
+    # Then a VersionMissingVerseError is raised.
+    with pytest.raises(bible.VersionMissingVerseError):
+        bible.get_verse_text(verse_id, version=version)
+
+
 def test_verse_text_caching() -> None:
     # Given a lengthy reference
     references: list[bible.NormalizedReference] = bible.get_references("Jeremiah 29")