diff options
| author | Dennis Fink | 2026-11-11 19:57:38 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-11 19:57:38 +0100 |
| commit | e6215f84bf2cab0bbd8bb0a42ddae0ee6de3cfd6 (patch) | |
| tree | 83910d7fee66d210464318bc7ad568c713e25e2d /packages/responsive-image/tests | |
| parent | 8963ed31ce537a736ddba99baf68b31858b319b8 (diff) | |
| download | dennisfink.me-main.tar.gz dennisfink.me-main.zip | |
This adds the responsive-image plugin directly to the project, including
its source code, documentation, and tests, allowing it to be maintained
locally.
It also configures responsive image sizes, updates gallery images to use
srcset, and preserves original image URLs for full-resolution viewing.
Markdown images gain lazy loading while retaining compatibility with the
existing image viewer.
Diffstat (limited to '')
13 files changed, 394 insertions, 0 deletions
diff --git a/packages/responsive-image/tests/conftest.py b/packages/responsive-image/tests/conftest.py new file mode 100644 index 0000000..f7a81df --- /dev/null +++ b/packages/responsive-image/tests/conftest.py @@ -0,0 +1,48 @@ +import os +from contextlib import ExitStack + +import pytest +from lektor.builder import Builder +from lektor.context import Context +from lektor.project import Project + + +@pytest.fixture +def lektor_env(): + site_path = os.path.join(os.path.dirname(__file__), "test-site") + return Project.from_path(site_path).make_env(load_plugins=False) + + +@pytest.fixture +def lektor_pad(lektor_env): + return lektor_env.new_pad() + + +@pytest.fixture +def lektor_builder(lektor_pad, tmp_path): + return Builder(lektor_pad, str(tmp_path)) + + +@pytest.fixture +def lektor_build_state(lektor_builder): + build_state = lektor_builder.new_build_state() + with ExitStack() as stack: + if hasattr(build_state, "__enter__"): + build_state = stack.enter_context(build_state) # lektor < 3.4 + yield build_state + + +@pytest.fixture +def lektor_source(lektor_pad): + return lektor_pad.root + + +@pytest.fixture +def lektor_artifact(lektor_build_state, lektor_source): + return lektor_build_state.new_artifact("test.html", source_obj=lektor_source) + + +@pytest.fixture +def lektor_context(lektor_artifact): + with Context(lektor_artifact) as ctx: + yield ctx diff --git a/packages/responsive-image/tests/test-site/Test Site.lektorproject b/packages/responsive-image/tests/test-site/Test Site.lektorproject new file mode 100644 index 0000000..ca7db53 --- /dev/null +++ b/packages/responsive-image/tests/test-site/Test Site.lektorproject @@ -0,0 +1,2 @@ +[project] +name = Test Site diff --git a/packages/responsive-image/tests/test-site/assets/static/style.css b/packages/responsive-image/tests/test-site/assets/static/style.css new file mode 100644 index 0000000..7ff6e0b --- /dev/null +++ b/packages/responsive-image/tests/test-site/assets/static/style.css @@ -0,0 +1,42 @@ +body { + font-family: 'Verdana', sans-serif; + margin: 50px 25px; +} + +a { + color: #2a99b6; +} + +a:hover { + color: #33bbdf; +} + +header, footer, div.page { + width: 760px; + margin: 0 auto; + background: #daeef3; + padding: 20px 30px; +} + +header h1 { + color: #169bbd; + margin: 0; + font-weight: normal; + font-size: 42px; +} + +header nav ul { + list-style: none; + margin: 0; + padding: 0; +} + +header nav ul li { + display: inline; + margin: 0 8px 0 0; + padding: 0; +} + +div.page { + background: #f1fbfe; +} diff --git a/packages/responsive-image/tests/test-site/content/about/contents.lr b/packages/responsive-image/tests/test-site/content/about/contents.lr new file mode 100644 index 0000000..9edb4d5 --- /dev/null +++ b/packages/responsive-image/tests/test-site/content/about/contents.lr @@ -0,0 +1,7 @@ +title: About this Website +--- +body: + +This is a website that was made with the Lektor quickstart. + +And it does not contain a lot of information. diff --git a/packages/responsive-image/tests/test-site/content/contents.lr b/packages/responsive-image/tests/test-site/content/contents.lr new file mode 100644 index 0000000..0492efe --- /dev/null +++ b/packages/responsive-image/tests/test-site/content/contents.lr @@ -0,0 +1,6 @@ +title: Welcome to Test Site! +--- +body: + +This is a basic demo website that shows how to use Lektor for a basic +website with some pages. diff --git a/packages/responsive-image/tests/test-site/content/dummy.pdf b/packages/responsive-image/tests/test-site/content/dummy.pdf Binary files differnew file mode 100644 index 0000000..774c2ea --- /dev/null +++ b/packages/responsive-image/tests/test-site/content/dummy.pdf diff --git a/packages/responsive-image/tests/test-site/content/projects/contents.lr b/packages/responsive-image/tests/test-site/content/projects/contents.lr new file mode 100644 index 0000000..f3658c6 --- /dev/null +++ b/packages/responsive-image/tests/test-site/content/projects/contents.lr @@ -0,0 +1,9 @@ +title: Projects +--- +body: + +This is a list of the projects: + +* Project 1 +* Project 2 +* Project 3 diff --git a/packages/responsive-image/tests/test-site/content/test.jpg b/packages/responsive-image/tests/test-site/content/test.jpg Binary files differnew file mode 100644 index 0000000..b9132f3 --- /dev/null +++ b/packages/responsive-image/tests/test-site/content/test.jpg diff --git a/packages/responsive-image/tests/test-site/models/page.ini b/packages/responsive-image/tests/test-site/models/page.ini new file mode 100644 index 0000000..dcddfe8 --- /dev/null +++ b/packages/responsive-image/tests/test-site/models/page.ini @@ -0,0 +1,11 @@ +[model] +name = Page +label = {{ this.title }} + +[fields.title] +label = Title +type = string + +[fields.body] +label = Body +type = markdown diff --git a/packages/responsive-image/tests/test-site/templates/layout.html b/packages/responsive-image/tests/test-site/templates/layout.html new file mode 100644 index 0000000..509426a --- /dev/null +++ b/packages/responsive-image/tests/test-site/templates/layout.html @@ -0,0 +1,28 @@ +<!doctype html> +<meta charset="utf-8"> +<link rel="stylesheet" href="{{ '/static/style.css'|url }}"> +<title>{% block title %}Welcome{% endblock %} — Test Site</title> +<body> + <header> + <h1>Test Site</h1> + <nav> + <ul class="nav navbar-nav"> + <li{% if this._path == '/' %} class="active"{% endif + %}><a href="{{ '/'|url }}">Welcome</a></li> + {% for href, title in [ + ['/projects', 'Projects'], + ['/about', 'About'] + ] %} + <li{% if this.is_child_of(href) %} class="active"{% endif + %}><a href="{{ href|url }}">{{ title }}</a></li> + {% endfor %} + </ul> + </nav> + </header> + <div class="page"> + {% block body %}{% endblock %} + </div> + <footer> + © Copyright 2020 by Jeff Dairiki. + </footer> +</body> diff --git a/packages/responsive-image/tests/test-site/templates/macros/pagination.html b/packages/responsive-image/tests/test-site/templates/macros/pagination.html new file mode 100644 index 0000000..077cc5a --- /dev/null +++ b/packages/responsive-image/tests/test-site/templates/macros/pagination.html @@ -0,0 +1,15 @@ +{% macro render_pagination(pagination) %} + <div class="pagination"> + {% if pagination.has_prev %} + <a href="{{ pagination.prev|url }}">« Previous</a> + {% else %} + <span class="disabled">« Previous</span> + {% endif %} + | {{ pagination.page }} | + {% if pagination.has_next %} + <a href="{{ pagination.next|url }}">Next »</a> + {% else %} + <span class="disabled">Next »</span> + {% endif %} + </div> +{% endmacro %} diff --git a/packages/responsive-image/tests/test-site/templates/page.html b/packages/responsive-image/tests/test-site/templates/page.html new file mode 100644 index 0000000..0430577 --- /dev/null +++ b/packages/responsive-image/tests/test-site/templates/page.html @@ -0,0 +1,6 @@ +{% extends "layout.html" %} +{% block title %}{{ this.title }}{% endblock %} +{% block body %} + <h2>{{ this.title }}</h2> + {{ this.body }} +{% endblock %} diff --git a/packages/responsive-image/tests/test_plugin.py b/packages/responsive-image/tests/test_plugin.py new file mode 100644 index 0000000..c1e68c4 --- /dev/null +++ b/packages/responsive-image/tests/test_plugin.py @@ -0,0 +1,220 @@ +import re +from contextlib import ExitStack + +import pytest +from inifile import IniFile + +from lektor_responsive_image import HAVE_MISTUNE0 +from lektor_responsive_image import ImprovedRenderer +from lektor_responsive_image import MarkdownConfig +from lektor_responsive_image import resolve_image +from lektor_responsive_image import ResponsiveImage +from lektor_responsive_image import ResponsiveImageMixin +from lektor_responsive_image import ResponsiveImagePlugin + +try: + from lektor.markdown.controller import RendererContext +except ModuleNotFoundError: + RendererContext = None + + +class DummyImage: + def __init__(self, width, height, format="jpeg", quality=None): + self.width = width + self.height = height + self.format = format + self.quality = quality + + def thumbnail(self, width, quality=None, upscale=None): + height = int(self.height * width / self.width + 0.5) + return DummyImage(width, height, format=self.format, quality=quality) + + +class DummyContext: + def url_to(self, image): + return f"img-{image.width}.jpg" + + +class TestResponsiveImage: + @pytest.fixture + def width(self): + return 2400 + + @pytest.fixture + def image(self, width): + height = int(3 * width / 4) + return DummyImage(width, height) + + @pytest.fixture + def sizes(self): + return None + + @pytest.fixture + def resp_image(self, image, sizes): + config = ResponsiveImage.DEFAULT_CONFIG.copy() + config["sizes"] = sizes + return ResponsiveImage(image, config, ctx=DummyContext()) + + def test_init_no_config(self, image): + resp_image = ResponsiveImage(image) + assert resp_image.config == ResponsiveImage.DEFAULT_CONFIG + assert resp_image.config is not ResponsiveImage.DEFAULT_CONFIG + + @pytest.mark.parametrize("width", [480]) + def test_attrs_no_srcset(self, resp_image): + assert "srcset" not in resp_image.attrs + + @pytest.mark.parametrize("width", [800]) + def test_attrs_srcset(self, resp_image): + srcset = resp_image.attrs["srcset"] + assert srcset == "img-480.jpg 480w, img-800.jpg 800w" + + @pytest.mark.parametrize("sizes", [None]) + def test_attrs_no_sizes(self, resp_image): + assert "sizes" not in resp_image.attrs + + @pytest.mark.parametrize("sizes", ["600px"]) + def test_attrs_sizes(self, resp_image, sizes): + assert resp_image.attrs["sizes"] == sizes + + @pytest.mark.parametrize("sizes", ["50vw", None]) + def test_sizes(self, resp_image, sizes): + assert resp_image.sizes == sizes + + @pytest.mark.parametrize( + "width, widths", + [ + (120, [120]), + (480, [480]), + (1024, [480, 800, 1024]), + (3600, [480, 800, 1200, 2400]), + ], + ) + def test_iter_widths(self, resp_image, widths): + assert list(resp_image.iter_widths()) == widths + + def test_default_image_attrs(self, resp_image): + assert resp_image.default_image_attrs() == { + "width": 1200, + "height": 900, + "src": "img-1200.jpg", + } + + def test_resize_image(self, resp_image, image): + assert resp_image.resize_image(image.width) is image + assert resp_image.resize_image(image.width + 1) is image + resized = resp_image.resize_image(image.width - 1) + assert resized.width == image.width - 1 + assert resized.quality == 92 + + +class Test_resolve_image: + def test_no_record(self): + assert resolve_image(None, "test.jpg") is None + + def test_external_url(self, lektor_pad): + assert resolve_image(lektor_pad.root, "http://example.com/test.jpg") is None + + def test_not_image(self, lektor_pad): + assert resolve_image(lektor_pad.root, "dummy.pdf") is None + + def test_resolve(self, lektor_pad): + image = resolve_image(lektor_pad.root, "test.jpg") + assert image.path == "/test.jpg" + assert image.width == 800 + + def test_resolve_absolute(self, lektor_pad): + about = lektor_pad.get("/about") + image = resolve_image(about, "/test.jpg") + assert image.path == "/test.jpg" + + def test_resolve_relative(self, lektor_pad): + about = lektor_pad.get("/about") + image = resolve_image(about, "../test.jpg") + assert image.path == "/test.jpg" + + +@pytest.fixture +def load_plugin(lektor_env): + lektor_env.plugin_controller.instanciate_plugin( + "responsive-image", ResponsiveImagePlugin + ) + + +class RendererWithMixin(ResponsiveImageMixin, ImprovedRenderer): + pass + + +class TestResponsiveImageMixin: + @pytest.fixture + def record(self, lektor_pad): + return lektor_pad.root + + @pytest.fixture + def mixin(self, record): + with ExitStack() as stack: + renderer = RendererWithMixin() + if RendererContext is not None: + stack.enter_context(RendererContext(record, meta={}, field_options={})) + else: # lektor < 3.4 + renderer.record = record + yield renderer + + @pytest.mark.usefixtures("load_plugin", "lektor_context") + def test(self, mixin): + args = ("TITLE", "ALT") if HAVE_MISTUNE0 else ("ALT", "TITLE") + img = mixin.image("test.jpg", *args) + assert re.match(r"<img.*>", img) + assert 'alt="ALT"' in img + assert "srcset=" in img + + @pytest.mark.usefixtures("load_plugin", "lektor_context") + def test_not_resolvable(self, mixin): + args = ("TITLE", "ALT") if HAVE_MISTUNE0 else ("ALT", "TITLE") + img = mixin.image("foo.jpg", *args) + assert re.match(r"<img.*>", img) + assert 'alt="ALT"' in img + assert "srcset=" not in img + + +class TestResponsiveImagePlugin: + @pytest.fixture + def plugin(self, lektor_env): + return ResponsiveImagePlugin(lektor_env, "responsive-image") + + def test_on_setup_env(self, plugin, lektor_env): + plugin.on_setup_env() + jinja_globals = lektor_env.jinja_env.globals + assert "responsive_image" in jinja_globals + + def test_on_markdown_config(self, plugin): + config = MarkdownConfig() + plugin.on_markdown_config(config) + assert config.renderer_mixins == [ResponsiveImageMixin] + + def test_get_responsive_image_config(self, plugin): + config = plugin.get_responsive_image_config() + assert config == ResponsiveImage.DEFAULT_CONFIG + assert config is not ResponsiveImage.DEFAULT_CONFIG + + @pytest.fixture + def inifile(self, config, tmp_path): + ini = IniFile(str(tmp_path / "test.ini")) + for key, value in config.items(): + ini["default." + key] = value + ini.save() + return ini + + @pytest.mark.parametrize( + "config, expected", + [ + ({"widths": "10 20 "}, {"widths": [10, 20]}), + ({"widths": "10-20"}, {}), + ({"quality": "12"}, {"quality": 12}), + ({"quality": "twelve"}, {}), + ({"default_width": "10"}, {"default_width": 10}), + ({"sizes": "60vw"}, {"sizes": "60vw"}), + ], + ) + def test__parse_ini(self, plugin, inifile, expected): + assert plugin._parse_ini(inifile) == expected |
