ebookerr-sdk 3.0.0__tar.gz → 3.2.0__tar.gz

ebookerr_sdk-3.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ArcCdr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ebookerr_sdk-3.2.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: ebookerr-sdk
+Version: 3.2.0
+Summary: The ebookerr plugin SDK: the plugin contract, the plugin host, a test kit, the pack tool and helper kits.
+Author: ArcCdr
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/ArcCdr/lit-ebookerr/blob/main/docs/PLUGIN_DEV.md
+Project-URL: API reference, https://arccdr.github.io/lit-ebookerr/
+Project-URL: Source, https://github.com/ArcCdr/lit-ebookerr/tree/main/sdk
+Project-URL: Plugins, https://github.com/ArcCdr/ebookerr-plugins
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: defusedxml>=0.7
+Requires-Dist: tinycss2>=1.3
+Requires-Dist: requests>=2.31
+Requires-Dist: packaging>=24
+Provides-Extra: text
+Requires-Dist: charset-normalizer>=3.3; extra == "text"
+Provides-Extra: generation
+Requires-Dist: pillow>=10; extra == "generation"
+Dynamic: license-file
+
+# ebookerr-sdk
+
+The toolkit for writing [ebookerr](https://github.com/ArcCdr/lit-ebookerr) plugins: the plugin
+contract (`ebookerr_sdk.spi`), the host that runs a plugin (`ebookerr_sdk.host`), a test kit
+(`ebookerr_sdk.testing`), the `pack` command, and helper kits for EPUB files, downloads,
+validation, library servers and text generation.
+
+- Guide: <https://github.com/ArcCdr/lit-ebookerr/blob/main/docs/PLUGIN_DEV.md>
+- API reference: <https://arccdr.github.io/lit-ebookerr/>
+- Plugins: <https://github.com/ArcCdr/ebookerr-plugins>
+
+## Install
+
+```bash
+pip install "ebookerr-sdk==3.2.*"
+```
+
+The SDK's MAJOR.MINOR is the SPI version it speaks: `ebookerr-sdk` 3.2.x speaks SPI 3.2. It needs
+Python 3.11 or later.
+
+## Start a plugin
+
+```bash
+python -m ebookerr_sdk.pack new hello_book --type book
+pytest hello_book/tests
+python -m ebookerr_sdk.pack check hello_book
+python -m ebookerr_sdk.pack build hello_book --out dist
+```
+
+`new` writes a plugin that passes `check` and its own test; `--type` is `source`, `epub`, `book`
+or `catalog`. The guide explains what to write next and how to install the zip in ebookerr.
+
+## Compatibility
+
+| ebookerr | SPI | ebookerr-sdk |
+| --- | --- | --- |
+| 2.24 | 3.0 | 3.0.x |
+| 2.24.1 | 3.1 | 3.1.x |
+| 2.24.7 | 3.2 | 3.2.x |
+
+ebookerr loads a plugin when its `spi_version` has ebookerr's SPI MAJOR and a MINOR not above
+ebookerr's; otherwise it shows the plugin as incompatible and offers a compatible release.
+
+## Versioning
+
+1. A MINOR release only adds: an optional manifest key whose default keeps today's behaviour, or
+   a new protocol, role, operation, context method, event or trigger scope that you opt into.
+2. Anything else — removing or renaming, changing a default or a meaning, making a key required,
+   refusing a manifest that was valid — waits for the next MAJOR release.
+3. ebookerr ignores manifest keys it does not know, with a warning; your plugin should ignore
+   request keys it does not know. `python -m ebookerr_sdk.pack check` refuses unknown manifest
+   keys and settings-field types, so a typo is caught before you release.
+4. Before it is removed, a public item is deprecated: named in these release notes and logged
+   once per plugin as a warning when used, it keeps working for at least two MINOR releases and
+   six months.
+5. An ebookerr release supports one SPI MAJOR, and moves to a new MAJOR only once every official
+   plugin has a compatible release.
+6. A PATCH release of the SDK fixes defects only; it never changes the public API.
+7. The public API is `manifest.toml`, `ebookerr_sdk.spi`, `ebookerr_sdk.host`,
+   `ebookerr_sdk.testing`, `python -m ebookerr_sdk.pack` and the kits `ebookerr_sdk.epub`,
+   `.validate`, `.download`, `.generation`, `.providers` and `.domain`. `ebookerr_sdk.wire`,
+   `.readpos`, `.registry_index` and every `_`-prefixed name are internal and may change in any
+   release.
+
+## Release notes
+
+### 3.2.0
+
+SPI 3.2. A story can name the multi-part work it is one part of: `StoryPatch.work` and
+`StoryPatch.work_url`. `series` and `series_url` mean a series the site itself declares —
+separate works in a declared order — never the work a chapter belongs to. `BookView.work_url`
+carries the work a book is a chapter of. `ebookerr_sdk.domain.adoption` gains `same_series` and
+`same_work`; `AdoptionSide.work_url` and `Evidence.same_work` are new, and signal E5 is "same
+series or same work". `EBOOKERR_META_KEYS` gains `work_url`. A plugin written for SPI 3.1 needs
+no change.
+
+### 3.1.0
+
+SPI 3.1. A `[[ui_triggers]]` entry's `icon` is optional and defaults to the plugin's `icon`;
+declare one only when a plugin has more than one action. Every glyph name must be one the
+self-hosted Material Symbols font renders (`ebookerr_sdk/spi/material_symbols.txt`): `pack check`
+reports an unknown name, two actions of one scope showing the same glyph, and a trigger without
+`icon` in a manifest that still declares `spi_version = "3.0"`. `pack check` now reports a declared
+requirement that is not installed where it runs instead of guessing its module names. A plugin
+written for SPI 3.0 needs no change.
+
+### 3.0.0
+
+SPI 3.0. A plugin written for SPI 2.x declares `spi_version = "3.0"` and applies these changes:
+
+- `spi_version` is required.
+- Roles are declared only as `[roles.<name>]` tables. The top-level keys `exclusive_group`,
+  `provider`, `delete_mode`, `reader_url_template`, `handles_merge_proposals`, `catch_all` and
+  `extract_url_patterns` are gone (`provider`, `delete_mode` and `reader_url_template` remain keys
+  of `[roles.library_server]`).
+- `network`, `auth_methods`, `headless`, `headed` and `default_enabled` are no longer manifest
+  keys. A plugin runs on events when it declares `events`, and runs by hand when it declares a
+  `book_selection_action` or `cover_invalidate` trigger; `PluginManifest.headed` is derived from
+  its triggers.
+- Settings-field types are `string`, `textarea`, `int`, `float`, `bool`, `url`, `url_list`,
+  `threshold_list`, `record_list` and `command`: a secret is `secret = true` on a `string`, a
+  drop-down is `options` with `options_strict = true` on a `string`; the types `text`, `secret`
+  and `select` are gone. `SettingsGroup.collapsed` is gone.
+- `UiFilter` and `UiTrigger.filters` are gone.
+- `PluginContext.ask_yes_no` returns `True`, `False`, or `None` when the prompt was abandoned or
+  timed out; `PluginContext.ask_yes_no_answer` and `PluginContext.queue` are gone.
+- `UpdateCheckingSource.check_for_update` always receives `ctx`; its `cancel_event` parameter is
+  gone.
+- `BookView.erotica_tags` is gone; use `BookView.tags`.
+- `ProviderAnchor`, `ProviderBookmark` and `ReadPositionAnchoring` are imported from
+  `ebookerr_sdk.providers` only.
+- New: `PluginContext.credentials(url)` and `SiteCredential` — the stored sign-in for a site the
+  plugin may use: a host in its `auth_sites` (`"*"` for any site it processes) or the host of a
+  `credential = true` URL setting.
+- New: `python -m ebookerr_sdk.pack new` starts a plugin; `pack check` refuses unknown manifest
+  keys, settings-field types and trigger scopes.
+- `ebookerr_sdk.spi` is split into modules (`errors`, `settings`, `types`, `views`,
+  `declarations`, `context`, `protocols`); every name still imports from `ebookerr_sdk.spi`.
+- `ebookerr_sdk.wire`, `ebookerr_sdk.readpos` and `ebookerr_sdk.registry_index` are internal.
+
+## Licence
+
+`ebookerr-sdk` is released under the MIT licence. Each plugin carries its own licence.

ebookerr_sdk-3.2.0/README.md

@@ -0,0 +1,123 @@
+# ebookerr-sdk
+
+The toolkit for writing [ebookerr](https://github.com/ArcCdr/lit-ebookerr) plugins: the plugin
+contract (`ebookerr_sdk.spi`), the host that runs a plugin (`ebookerr_sdk.host`), a test kit
+(`ebookerr_sdk.testing`), the `pack` command, and helper kits for EPUB files, downloads,
+validation, library servers and text generation.
+
+- Guide: <https://github.com/ArcCdr/lit-ebookerr/blob/main/docs/PLUGIN_DEV.md>
+- API reference: <https://arccdr.github.io/lit-ebookerr/>
+- Plugins: <https://github.com/ArcCdr/ebookerr-plugins>
+
+## Install
+
+```bash
+pip install "ebookerr-sdk==3.2.*"
+```
+
+The SDK's MAJOR.MINOR is the SPI version it speaks: `ebookerr-sdk` 3.2.x speaks SPI 3.2. It needs
+Python 3.11 or later.
+
+## Start a plugin
+
+```bash
+python -m ebookerr_sdk.pack new hello_book --type book
+pytest hello_book/tests
+python -m ebookerr_sdk.pack check hello_book
+python -m ebookerr_sdk.pack build hello_book --out dist
+```
+
+`new` writes a plugin that passes `check` and its own test; `--type` is `source`, `epub`, `book`
+or `catalog`. The guide explains what to write next and how to install the zip in ebookerr.
+
+## Compatibility
+
+| ebookerr | SPI | ebookerr-sdk |
+| --- | --- | --- |
+| 2.24 | 3.0 | 3.0.x |
+| 2.24.1 | 3.1 | 3.1.x |
+| 2.24.7 | 3.2 | 3.2.x |
+
+ebookerr loads a plugin when its `spi_version` has ebookerr's SPI MAJOR and a MINOR not above
+ebookerr's; otherwise it shows the plugin as incompatible and offers a compatible release.
+
+## Versioning
+
+1. A MINOR release only adds: an optional manifest key whose default keeps today's behaviour, or
+   a new protocol, role, operation, context method, event or trigger scope that you opt into.
+2. Anything else — removing or renaming, changing a default or a meaning, making a key required,
+   refusing a manifest that was valid — waits for the next MAJOR release.
+3. ebookerr ignores manifest keys it does not know, with a warning; your plugin should ignore
+   request keys it does not know. `python -m ebookerr_sdk.pack check` refuses unknown manifest
+   keys and settings-field types, so a typo is caught before you release.
+4. Before it is removed, a public item is deprecated: named in these release notes and logged
+   once per plugin as a warning when used, it keeps working for at least two MINOR releases and
+   six months.
+5. An ebookerr release supports one SPI MAJOR, and moves to a new MAJOR only once every official
+   plugin has a compatible release.
+6. A PATCH release of the SDK fixes defects only; it never changes the public API.
+7. The public API is `manifest.toml`, `ebookerr_sdk.spi`, `ebookerr_sdk.host`,
+   `ebookerr_sdk.testing`, `python -m ebookerr_sdk.pack` and the kits `ebookerr_sdk.epub`,
+   `.validate`, `.download`, `.generation`, `.providers` and `.domain`. `ebookerr_sdk.wire`,
+   `.readpos`, `.registry_index` and every `_`-prefixed name are internal and may change in any
+   release.
+
+## Release notes
+
+### 3.2.0
+
+SPI 3.2. A story can name the multi-part work it is one part of: `StoryPatch.work` and
+`StoryPatch.work_url`. `series` and `series_url` mean a series the site itself declares —
+separate works in a declared order — never the work a chapter belongs to. `BookView.work_url`
+carries the work a book is a chapter of. `ebookerr_sdk.domain.adoption` gains `same_series` and
+`same_work`; `AdoptionSide.work_url` and `Evidence.same_work` are new, and signal E5 is "same
+series or same work". `EBOOKERR_META_KEYS` gains `work_url`. A plugin written for SPI 3.1 needs
+no change.
+
+### 3.1.0
+
+SPI 3.1. A `[[ui_triggers]]` entry's `icon` is optional and defaults to the plugin's `icon`;
+declare one only when a plugin has more than one action. Every glyph name must be one the
+self-hosted Material Symbols font renders (`ebookerr_sdk/spi/material_symbols.txt`): `pack check`
+reports an unknown name, two actions of one scope showing the same glyph, and a trigger without
+`icon` in a manifest that still declares `spi_version = "3.0"`. `pack check` now reports a declared
+requirement that is not installed where it runs instead of guessing its module names. A plugin
+written for SPI 3.0 needs no change.
+
+### 3.0.0
+
+SPI 3.0. A plugin written for SPI 2.x declares `spi_version = "3.0"` and applies these changes:
+
+- `spi_version` is required.
+- Roles are declared only as `[roles.<name>]` tables. The top-level keys `exclusive_group`,
+  `provider`, `delete_mode`, `reader_url_template`, `handles_merge_proposals`, `catch_all` and
+  `extract_url_patterns` are gone (`provider`, `delete_mode` and `reader_url_template` remain keys
+  of `[roles.library_server]`).
+- `network`, `auth_methods`, `headless`, `headed` and `default_enabled` are no longer manifest
+  keys. A plugin runs on events when it declares `events`, and runs by hand when it declares a
+  `book_selection_action` or `cover_invalidate` trigger; `PluginManifest.headed` is derived from
+  its triggers.
+- Settings-field types are `string`, `textarea`, `int`, `float`, `bool`, `url`, `url_list`,
+  `threshold_list`, `record_list` and `command`: a secret is `secret = true` on a `string`, a
+  drop-down is `options` with `options_strict = true` on a `string`; the types `text`, `secret`
+  and `select` are gone. `SettingsGroup.collapsed` is gone.
+- `UiFilter` and `UiTrigger.filters` are gone.
+- `PluginContext.ask_yes_no` returns `True`, `False`, or `None` when the prompt was abandoned or
+  timed out; `PluginContext.ask_yes_no_answer` and `PluginContext.queue` are gone.
+- `UpdateCheckingSource.check_for_update` always receives `ctx`; its `cancel_event` parameter is
+  gone.
+- `BookView.erotica_tags` is gone; use `BookView.tags`.
+- `ProviderAnchor`, `ProviderBookmark` and `ReadPositionAnchoring` are imported from
+  `ebookerr_sdk.providers` only.
+- New: `PluginContext.credentials(url)` and `SiteCredential` — the stored sign-in for a site the
+  plugin may use: a host in its `auth_sites` (`"*"` for any site it processes) or the host of a
+  `credential = true` URL setting.
+- New: `python -m ebookerr_sdk.pack new` starts a plugin; `pack check` refuses unknown manifest
+  keys, settings-field types and trigger scopes.
+- `ebookerr_sdk.spi` is split into modules (`errors`, `settings`, `types`, `views`,
+  `declarations`, `context`, `protocols`); every name still imports from `ebookerr_sdk.spi`.
+- `ebookerr_sdk.wire`, `ebookerr_sdk.readpos` and `ebookerr_sdk.registry_index` are internal.
+
+## Licence
+
+`ebookerr-sdk` is released under the MIT licence. Each plugin carries its own licence.

{ebookerr_sdk-3.0.0 → ebookerr_sdk-3.2.0}/ebookerr_sdk/__init__.py

@@ -19,7 +19,7 @@ ruff D, pdoc, mutmut and the traceability gate all cover the SDK; it has its own
   ``write_read_state``, ``convert``) and the progress, dialog, view, circuit, defer and state
   frames.
 - ``testing/`` — Test doubles for ebookerr plugins (``PMG-D26``).
-- ``pack/`` — Build, check and index ebookerr plugin packages (PMG-FR-72, PMG-FR-75).
+- ``pack/`` — Start, build, check and index ebookerr plugin packages (PMG-FR-72, PMG-FR-75).
 - ``epub/`` — the custom EPUB library: ``archive``, ``opf``, ``ncx``, ``xhtml``, ``document``,
   ``chapters``/``chapter_table()``, ``serialize``, ``roles``, ``titles``, ``fonts``, ``assets``,
   ``builder``, ``nav`` — every EPUB plugin's shared tooling.
@@ -44,4 +44,4 @@ ruff D, pdoc, mutmut and the traceability gate all cover the SDK; it has its own
   ``pack/``, so a fetched index and a built one are validated by exactly the same rules.
 """
 
-__version__ = "3.0.0"
+__version__ = "3.2.0"

{ebookerr_sdk-3.0.0 → ebookerr_sdk-3.2.0}/ebookerr_sdk/domain/adoption.py

@@ -4,6 +4,8 @@ This module provides pure functions for normalising chapter identifiers
 so they can be compared across different formatting conventions.
 Because these functions are pure (no database, no external dependencies),
 the adoption heuristic is fully unit-testable.
+
+It also provides ``same_series``/``same_work`` (the two halves of signal E5).
 """
 
 from __future__ import annotations
@@ -15,6 +17,7 @@ from dataclasses import dataclass
 from urllib.parse import urlsplit
 
 from ebookerr_sdk.domain.chapter_number import extract_chapter_info
+from ebookerr_sdk.domain.ids import normalise_url
 from ebookerr_sdk.domain.text_encoding import unicode_identity
 
 
@@ -103,7 +106,7 @@ class AdoptionSide:
 
     Attributes:
         book_id: The book's id.
-        title: The book title as stored, e.g. ``"Tending Bar Pt. 05"``.
+        title: The book title as stored, e.g. ``"Sample Alpha Pt. 05"``.
         author: The author as stored; ``""`` when unknown.
         site: The site as stored; ``""`` when unknown.
         series: The series as stored; ``""`` when unknown.
@@ -112,6 +115,7 @@ class AdoptionSide:
         numbers: Raw F8 chapter-number tokens. For an orphan this holds exactly the one
             number parsed from its title; for a target, every number in its EPUB table of
             contents, in table order.
+        work_url: The work this book is a chapter of; ``""`` when none (SPI 3.2).
     """
 
     book_id: str
@@ -122,6 +126,7 @@ class AdoptionSide:
     series_url: str
     story_url: str
     numbers: tuple[str, ...]
+    work_url: str = ""
 
 
 @dataclass(frozen=True, slots=True)
@@ -153,6 +158,8 @@ class Evidence:
         orphan_number: First chapter number from orphan, or empty string.
         target_numbers: All chapter numbers from target, in table order.
         stem: Normalized book title stem (title with chapter numbers removed).
+        same_work: The orphan is a chapter of the target's story or of its work (E5, optional;
+            SPI 3.2).
     """
 
     author_match: bool
@@ -165,13 +172,14 @@ class Evidence:
     orphan_number: str
     target_numbers: tuple[str, ...]
     stem: str
+    same_work: bool = False
 
     @property
     def score(self) -> int:
         """The optional-signal score: E4 +1, E5 +2, E6 +2, E7 +1 (0..6)."""
         return (
             (1 if self.same_site else 0)
-            + (2 if self.same_series else 0)
+            + (2 if self.same_series or self.same_work else 0)
             + (2 if self.url_affinity else 0)
             + (1 if self.adjacent else 0)
         )
@@ -194,6 +202,42 @@ def _common_prefix_len(a: str, b: str) -> int:
     return sum(1 for _ in itertools.takewhile(lambda p: p[0] == p[1], zip(a, b, strict=False)))
 
 
+def same_series(a_series: str, a_series_url: str, b_series: str, b_series_url: str) -> bool:
+    """Signal E5's series half: one non-empty normalised series name or series URL (``DEC-57``).
+
+    Args:
+        a_series: The first book's series.
+        a_series_url: The first book's series URL.
+        b_series: The second book's series.
+        b_series_url: The second book's series URL.
+
+    Returns:
+        ``True`` when the normalised names are equal and non-empty, or the URLs are.
+    """
+    return (normalize_key(a_series) == normalize_key(b_series) != "") or (
+        a_series_url == b_series_url != ""
+    )
+
+
+def same_work(orphan_work_url: str, *, target_story_url: str, target_work_url: str) -> bool:
+    """Signal E5's work half: the orphan is a chapter of the target's story or work (``DEC-57``).
+
+    URLs compare in their normalised form (``normalise_url``); an empty URL never matches.
+
+    Args:
+        orphan_work_url: The orphan's work URL.
+        target_story_url: The target's own story URL.
+        target_work_url: The target's work URL.
+
+    Returns:
+        ``True`` when the orphan's work is the target's story or the target's work.
+    """
+    if not orphan_work_url:
+        return False
+    key = normalise_url(orphan_work_url)
+    return any(url and normalise_url(url) == key for url in (target_story_url, target_work_url))
+
+
 def score_pair(orphan: AdoptionSide, target: AdoptionSide) -> Evidence:
     """Score one candidate adoption pair against the seven DEC-57 signals.
 
@@ -228,9 +272,10 @@ def score_pair(orphan: AdoptionSide, target: AdoptionSide) -> Evidence:
     # 7. Same site: normalized site must be non-empty and equal
     same_site = normalize_key(orphan.site) == normalize_key(target.site) != ""
 
-    # 8. Same series: either series match OR series_url match (both non-empty)
-    same_series = (normalize_key(orphan.series) == normalize_key(target.series) != "") or (
-        orphan.series_url == target.series_url != ""
+    # 8. E5: same series, or the orphan is a chapter of the target's story or work (SPI 3.2)
+    series_match = same_series(orphan.series, orphan.series_url, target.series, target.series_url)
+    work_match = same_work(
+        orphan.work_url, target_story_url=target.story_url, target_work_url=target.work_url
     )
 
     # 9. URL affinity: common prefix of slug keys >= 8 characters
@@ -251,12 +296,13 @@ def score_pair(orphan: AdoptionSide, target: AdoptionSide) -> Evidence:
         stem_match=stem_match,
         numbers_disjoint=numbers_disjoint,
         same_site=same_site,
-        same_series=same_series,
+        same_series=series_match,
         url_affinity=url_affinity,
         adjacent=adjacent,
         orphan_number=orphan_number,
         target_numbers=tuple(target.numbers),
         stem=orphan_stem,
+        same_work=work_match,
     )
 
 
@@ -275,7 +321,7 @@ def evidence_json(evidence: Evidence) -> str:
         "E2": evidence.stem_match,
         "E3": evidence.numbers_disjoint,
         "E4": evidence.same_site,
-        "E5": evidence.same_series,
+        "E5": evidence.same_series or evidence.same_work,
         "E6": evidence.url_affinity,
         "E7": evidence.adjacent,
         "orphan_number": evidence.orphan_number,

{ebookerr_sdk-3.0.0 → ebookerr_sdk-3.2.0}/ebookerr_sdk/domain/chapter_naming.py

@@ -52,8 +52,8 @@ def slugify(text: str, *, max_length: int = 80) -> str:
         Returns empty string for empty input or all-nonalnum input.
 
     Examples:
-        >>> slugify("Three Square Meals")
-        'three_square_meals'
+        >>> slugify("Sample Delta")
+        'sample_delta'
         >>> slugify("  A -- B!!  ")
         'a_b'
         >>> slugify("")

{ebookerr_sdk-3.0.0 → ebookerr_sdk-3.2.0}/ebookerr_sdk/domain/chapter_number.py

@@ -12,10 +12,10 @@ priority order:
   ``a``, ``Pt.02``->``b``), e.g. ``Ch. 03 Pt. 02`` -> ``03b``.
 * With no ``Ch``, a trailing ``Part`` / ``Pt.`` / ``Session`` number is the chapter
   (``Pt. 01`` -> ``01``). A ``Part``/``Book``/volume token *before* a ``Ch`` stays
-  in the book name (``Lady in Red Pt. 03 Ch. 05`` -> book ``Lady in Red Pt. 03``).
+  in the book name (``Sample Nettle Pt. 03 Ch. 05`` -> book ``Sample Nettle Pt. 03``).
 * A bare trailing number or range is a chapter only when each part is <= 3 digits
   (``Earth 22`` -> ``22``, ``Daughter 1-4`` -> ``1-4`` but ``Room 1203`` -> none);
-  the number may abut the book name directly (``AIF31`` -> ``31``), but a longer run
+  the number may abut the book name directly (``Gamma31`` -> ``31``), but a longer run
   of digits is never split; a number that lives only in the URL slug is ignored.
 * The number is preserved exactly as written (leading zeros kept, ranges keep
   their hyphen), with spaces stripped (``Ch. 023 - 025`` -> ``023-025``).
@@ -54,7 +54,7 @@ _CH_PT_RE = re.compile(r"(?<![A-Za-z])(?:chapter|ch)\.?\s*(\d+)\s+(?:part|pt)\.?
 _CH_RE = re.compile(rf"(?<![A-Za-z])(?:chapter|ch|c)\.?\s*({_ATOM})", re.I)
 # A part/session marker anywhere (only consulted when there is no chapter marker).
 _PT_RE = re.compile(rf"(?<![A-Za-z])(?:part|pt|session)\.?\s*({_ATOM})", re.I)
-# A bare trailing number or range; a letter may abut it ("AIF31"), another digit may not.
+# A bare trailing number or range; a letter may abut it ("Gamma31"), another digit may not.
 # The range alternative comes first so "1-4" is taken whole instead of just its "4" — a
 # merged anthology's own title is fed back through this function on the next merge.
 _BARE_RE = re.compile(r"(?<!\d)(\d{1,3}\s*-\s*\d{1,3}|\d+)\s*$")
@@ -258,73 +258,74 @@ def extract_chapter_info(
     Examples:
         The table below is the acceptance oracle for the module-level rules —
         every row is exercised verbatim by
-        ``tests/unit/test_chapter_number.py::TestExampleTable`` (real-world
-        story titles; the source URL is not shown as it is not consulted):
+        ``tests/unit/test_chapter_number.py::TestExampleTable`` (invented titles
+        that keep the numbering patterns of real chapter titles; the source URL is
+        not shown as it is not consulted):
 
         | Raw title                                | Book name                       | Number  |
         | ---------------------------------------- | ------------------------------- | ------- |
-        | Tending Bar Part 5                       | Tending Bar                     | 5       |
-        | Tending Bar Pt. 01                       | Tending Bar                     | 01      |
-        | The Sixth School Book II Ch. 052         | The Sixth School Book II        | 052     |
-        | Star Crossed Kindness (Part 10)          | Star Crossed Kindness           | 10      |
-        | Dude, You Slept With My Mom?! Ch.45      | Dude, You Slept With My Mom?!   | 45      |
-        | Xcite Pt. 02 - My Wife's New Job         | Xcite                           | 02      |
-        | Saving My Daughter From BBC Pt. 07a      | Saving My Daughter From BBC     | 07a     |
-        | The Cuckold Club Pt. 09 - The HW...      | The Cuckold Club                | 09      |
-        | The Lottery Winner - Pt. 01              | The Lottery Winner              | 01      |
-        | Eve's All Hollow                         | Eve's All Hollow                |         |
-        | Wednesday's Ass                          | Wednesday's Ass                 |         |
-        | The Black of Harts (2/5)                 | The Black of Harts              | 2       |
-        | Throne Challenger of Earth 22            | Throne Challenger of Earth      | 22      |
-        | I Want Her to Know What Love Is C33      | I Want Her to Know What Love Is | 33      |
-        | Before The Storm (Ch. 20)                | Before The Storm                | 20      |
-        | Collateral Damage – Dallas               | Collateral Damage – Dallas      |         |
-        | LifeSim: Breeding Expansion Ch 11        | LifeSim: Breeding Expansion     | 11      |
-        | Perfect Girlfriend Juice Ch. 03          | Perfect Girlfriend Juice        | 03      |
-        | Perfect Girlfriend Juice Ch. 03 Pt. 02   | Perfect Girlfriend Juice        | 03b     |
-        | Perfect Girlfriend Juice Ch. 05 Pt. 01   | Perfect Girlfriend Juice        | 05a     |
-        | Perfect Girlfriend Juice Ch. 05 Pt. 02   | Perfect Girlfriend Juice        | 05b     |
-        | Kingmaker (Ch. 02)                       | Kingmaker                       | 02      |
-        | A Professor Living Dangerously Pt 5      | A Professor Living Dangerously  | 5       |
-        | Wedded to the Pack, Ch 20                | Wedded to the Pack              | 20      |
-        | A Taste of Jamaica                       | A Taste of Jamaica              |         |
-        | Accidental Family                        | Accidental Family               |         |
-        | Quaranteam - Book Two (Ch. 46)           | Quaranteam - Book Two           | 46      |
-        | Watching Her (750 Word Challenge)        | Watching Her                    |         |
-        | The Choices in Life - Ch. 03             | The Choices in Life             | 03      |
-        | (The) Breast of Times                    | (The) Breast of Times           |         |
-        | Accidental Incest - The Bus              | Accidental Incest - The Bus     |         |
-        | Daddy's Special Touches Ch. 02: Breeding | Daddy's Special Touches         | 02      |
-        | The Game                                 | The Game                        |         |
-        | Mom's Massage                            | Mom's Massage                   |         |
-        | Summer Sister                            | Summer Sister                   |         |
-        | Family Sex Therapy - Session 1           | Family Sex Therapy              | 1       |
-        | A Big Surprise                           | A Big Surprise                  |         |
-        | Family Holiday                           | Family Holiday                  |         |
-        | Strings Attached - Ch. 04 Amsterdam      | Strings Attached                | 04      |
-        | Confessions & Commands (Pt. 3 of 3)      | Confessions & Commands          | 3       |
-        | The Eighth Warden Bk. 06 Ch. 09          | The Eighth Warden Bk. 06        | 09      |
-        | AMA - The Boyfriend Ch. 441-450          | AMA - The Boyfriend             | 441-450 |
-        | Welldark B2 Ch. 08                       | Welldark B2                     | 08      |
-        | The Queen                                | The Queen                       |         |
-        | First Date - Ch. 3 Sunday                | First Date                      | 3       |
-        | Lady in Red Pt. 03 Ch. 05                | Lady in Red Pt. 03              | 05      |
-        | The Keeper Ch. 32-34                     | The Keeper                      | 32-34   |
-        | Alistaire Too Ch. 02: Bridget & Petra    | Alistaire Too                   | 02      |
-        | Sentient 03                              | Sentient                        | 03      |
-        | AIF31                                    | AIF                             | 31      |
-        | AIF 30                                   | AIF                             | 30      |
-        | The Stand-In Pt. 01                      | The Stand-In                    | 01      |
-        | The Big Tits Club Pt. 02 Ch. 51-52       | The Big Tits Club Pt. 02        | 51-52   |
-        | One Night in Room 1203                   | One Night in Room 1203          |         |
-        | A Long Time from Home Pt. 02 Ch. 07      | A Long Time from Home Pt. 02    | 07      |
-        | The OF Girl Ch. 641-650                  | The OF Girl                     | 641-650 |
-        | My Little Ventrue Pt. 07 Ch. 16          | My Little Ventrue Pt. 07        | 16      |
-        | Dark Born - Ch. 023 - 025                | Dark Born                       | 023-025 |
-        | Surefoot 03: Field Trip Ch. 05           | Surefoot 03: Field Trip         | 05      |
-        | The Pleasures of Hell 03.041             | The Pleasures of Hell 03        | 041     |
-        | The Senator's Daughter 1-4               | The Senator's Daughter          | 1-4     |
-        | Tending Bar 3 - 5                        | Tending Bar                     | 3-5     |
+        | Sample Alpha Part 5                      | Sample Alpha                    | 5       |
+        | Sample Alpha Pt. 01                      | Sample Alpha                    | 01      |
+        | Sample Acorn Book II Ch. 052             | Sample Acorn Book II            | 052     |
+        | Sample Badger (Part 10)                  | Sample Badger                   | 10      |
+        | Sample Cinder, Really?! Ch.45            | Sample Cinder, Really?!         | 45      |
+        | Sample Dahlia Pt. 02 - A New Post        | Sample Dahlia                   | 02      |
+        | Sample Egret Pt. 07a                     | Sample Egret                    | 07a     |
+        | Sample Falcon Pt. 09 - The End...        | Sample Falcon                   | 09      |
+        | Sample Epsilon - Pt. 01                  | Sample Epsilon                  | 01      |
+        | Sample Garnet's Hollow                   | Sample Garnet's Hollow          |         |
+        | Sample Harbor's Edge                     | Sample Harbor's Edge            |         |
+        | Sample Indigo (2/5)                      | Sample Indigo                   | 2       |
+        | Sample Jasper Challenger 22              | Sample Jasper Challenger        | 22      |
+        | Sample Kestrel C33                       | Sample Kestrel                  | 33      |
+        | Sample Larch (Ch. 20)                    | Sample Larch                    | 20      |
+        | Sample Maple – Dallas                    | Sample Maple – Dallas           |         |
+        | Sample Nimbus: Expansion Ch 11           | Sample Nimbus: Expansion        | 11      |
+        | Sample Opal Ch. 03                       | Sample Opal                     | 03      |
+        | Sample Opal Ch. 03 Pt. 02                | Sample Opal                     | 03b     |
+        | Sample Opal Ch. 05 Pt. 01                | Sample Opal                     | 05a     |
+        | Sample Opal Ch. 05 Pt. 02                | Sample Opal                     | 05b     |
+        | Sample Pebble (Ch. 02)                   | Sample Pebble                   | 02      |
+        | Sample Quartz Pt 5                       | Sample Quartz                   | 5       |
+        | Sample Raven, Ch 20                      | Sample Raven                    | 20      |
+        | Sample Heath                             | Sample Heath                    |         |
+        | Sample Grove                             | Sample Grove                    |         |
+        | Sample Sable - Book Two (Ch. 46)         | Sample Sable - Book Two         | 46      |
+        | Sample Thistle (750 Word Challenge)      | Sample Thistle                  |         |
+        | Sample Umber - Ch. 03                    | Sample Umber                    | 03      |
+        | (The) Sample Violet                      | (The) Sample Violet             |         |
+        | Sample Willow - The Bus                  | Sample Willow - The Bus         |         |
+        | Sample Yarrow Ch. 02: Arrival            | Sample Yarrow                   | 02      |
+        | Sample Zephyr                            | Sample Zephyr                   |         |
+        | Sample Alder                             | Sample Alder                    |         |
+        | Sample Bramble                           | Sample Bramble                  |         |
+        | Sample Coral - Session 1                 | Sample Coral                    | 1       |
+        | Sample Dove                              | Sample Dove                     |         |
+        | Sample Elm                               | Sample Elm                      |         |
+        | Sample Flint - Ch. 04 Amsterdam          | Sample Flint                    | 04      |
+        | Sample Gale & Sons (Pt. 3 of 3)          | Sample Gale & Sons              | 3       |
+        | Sample Iris Bk. 06 Ch. 09                | Sample Iris Bk. 06              | 09      |
+        | Sample Jade - The Visitor Ch. 441-450    | Sample Jade - The Visitor       | 441-450 |
+        | Sample Kelp B2 Ch. 08                    | Sample Kelp B2                  | 08      |
+        | Sample Lark                              | Sample Lark                     |         |
+        | Sample Moss - Ch. 3 Sunday               | Sample Moss                     | 3       |
+        | Sample Nettle Pt. 03 Ch. 05              | Sample Nettle Pt. 03            | 05      |
+        | Sample Onyx Ch. 32-34                    | Sample Onyx                     | 32-34   |
+        | Sample Pine Ch. 02: Ada & Bea            | Sample Pine                     | 02      |
+        | Sample Quill 03                          | Sample Quill                    | 03      |
+        | Gamma31                                  | Gamma                           | 31      |
+        | Gamma 30                                 | Gamma                           | 30      |
+        | Sample Slate-Grey Pt. 01                 | Sample Slate-Grey               | 01      |
+        | Sample Tansy Pt. 02 Ch. 51-52            | Sample Tansy Pt. 02             | 51-52   |
+        | Sample Vale Room 1203                    | Sample Vale Room 1203           |         |
+        | Sample Wren Pt. 02 Ch. 07                | Sample Wren Pt. 02              | 07      |
+        | Sample Aster Ch. 641-650                 | Sample Aster                    | 641-650 |
+        | Sample Briar Pt. 07 Ch. 16               | Sample Briar Pt. 07             | 16      |
+        | Sample Clover - Ch. 023 - 025            | Sample Clover                   | 023-025 |
+        | Sample Drift 03: Field Trip Ch. 05       | Sample Drift 03: Field Trip     | 05      |
+        | Sample Frost 03.041                      | Sample Frost 03                 | 041     |
+        | Sample Fern 1-4                          | Sample Fern                     | 1-4     |
+        | Sample Alpha 3 - 5                       | Sample Alpha                    | 3-5     |
     """
     _ = chapter_url
     title = (chapter_title or "").strip()