chore(tests): add tests

CHANGELOG.md

@@ -10,6 +10,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 (unreleased)=
 ## [Unreleased](https://github.com/jeertmans/manim-slides/compare/v5.1.9...HEAD)
 
+(unreleased-added)=
+### Added
+
+- Added `--offline` option to `manim-slides convert` for offline
+  HTML presentations.
+  [#440](https://github.com/jeertmans/manim-slides/pull/440)
+
 (v5.1.9)=
 ## [v5.1.9](https://github.com/jeertmans/manim-slides/compare/v5.1.8...v5.1.9)
 

manim_slides/convert.py

@@ -390,7 +390,7 @@ def load_template(self) -> str:
     def open(self, file: Path) -> None:
         webbrowser.open(file.absolute().as_uri())
 
-    def convert_to(self, dest: Path) -> None:
+    def convert_to(self, dest: Path) -> None:  # noqa: C901
         """
         Convert this configuration into a RevealJS HTML presentation, saved to
         DEST.
@@ -616,7 +616,7 @@ def xpath(el: etree.Element, query: str) -> etree.XPath:
 
 
 def show_config_options(function: Callable[..., Any]) -> Callable[..., Any]:
-    """Wrap a function to add a `--show-config` option."""
+    """Wrap a function to add a '--show-config' option."""
 
     def callback(ctx: Context, param: Parameter, value: bool) -> None:
         if not value or ctx.resilient_parsing:
@@ -647,7 +647,7 @@ def callback(ctx: Context, param: Parameter, value: bool) -> None:
 
 
 def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
-    """Wrap a function to add a `--show-template` option."""
+    """Wrap a function to add a '--show-template' option."""
 
     def callback(ctx: Context, param: Parameter, value: bool) -> None:
         if not value or ctx.resilient_parsing:
@@ -699,15 +699,21 @@ def callback(ctx: Context, param: Parameter, value: bool) -> None:
     multiple=True,
     callback=validate_config_option,
     help="Configuration options passed to the converter. "
-    "E.g., pass ``-cslide_number=true`` to display slide numbers.",
+    "E.g., pass '-cslide_number=true' to display slide numbers.",
 )
 @click.option(
     "--use-template",
     "template",
     metavar="FILE",
     type=click.Path(exists=True, dir_okay=False, path_type=Path),
     help="Use the template given by FILE instead of default one. "
-    "To echo the default template, use ``--show-template``.",
+    "To echo the default template, use '--show-template'.",
+)
+@click.option(
+    "--offline",
+    is_flag=True,
+    help="Download any remote content and store it in the assets folder. "
+    "The is a convenient alias to '-coffline=true'.",
 )
 @show_template_option
 @show_config_options
@@ -720,6 +726,7 @@ def convert(
     open_result: bool,
     config_options: dict[str, str],
     template: Optional[Path],
+    offline: bool,
 ) -> None:
     """Convert SCENE(s) into a given format and writes the result in DEST."""
     presentation_configs = get_scenes_presentation_config(scenes, folder)
@@ -737,6 +744,13 @@ def convert(
         else:
             cls = Converter.from_string(to)
 
+        if (
+            offline
+            and issubclass(cls, (RevealJS, HtmlZip))
+            and "offline" not in config_options
+        ):
+            config_options["offline"] = "true"
+
         converter = cls(
             presentation_configs=presentation_configs,
             template=template,

pyproject.toml

@@ -18,6 +18,7 @@ classifiers = [
 ]
 dependencies = [
   "av>=9.0.0",
+  "beautifulsoup4>=4.12.3",
   "click>=8.1.3",
   "click-default-group>=1.2.2",
   "jinja2>=3.1.2",

tests/test_convert.py

@@ -156,6 +156,24 @@ def test_revealjs_converter(
         file_contents = out_file.read_text()
         assert "manim" in file_contents.casefold()
 
+    def test_revealjs_offline_converter(
+        self, tmp_path: Path, presentation_config: PresentationConfig
+    ) -> None:
+        out_file = tmp_path / "slides.html"
+        RevealJS(presentation_configs=[presentation_config], offline=True).convert_to(
+            out_file
+        )
+        assert out_file.exists()
+        assets_dir = Path(tmp_path / "slides_assets")
+        assert assets_dir.is_dir()
+        for file in [
+            "black.min.css",
+            "reveal.min.css",
+            "reveal.min.js",
+            "zenbun.min.css",
+        ]:
+            assert (assets_dir / file).exists()
+
     def test_htmlzip_converter(
         self, tmp_path: Path, presentation_config: PresentationConfig
     ) -> None: