webdev 2.0.1__tar.gz → 2.1.0__tar.gz

{webdev-2.0.1 → webdev-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: webdev
-Version: 2.0.1
+Version: 2.1.0
 Summary: Small, fast development web server with a modern dark directory index
 Project-URL: Homepage, https://github.com/kuralabs/webdev
 Project-URL: Repository, https://github.com/kuralabs/webdev
@@ -94,6 +94,9 @@ Features
   startup so you can open the site on your phone.
 - 🌈 **Colorized, level-aware logs** for readable output.
 - ⚡ **No-cache headers** for always-fresh development content.
+- 👀 **Previews text inline** — plain-text, config and template files (``.txt``,
+  ``.json``, ``.yaml``, ``.ini``, ``.toml``, ``.j2``/``.jinja2``, ``.template``,
+  ``.config`` and more) open in the browser instead of being downloaded.
 - 🧭 **SPA fallback** — optionally serve ``index.html`` for unknown routes.
 - 📦 **Gzip**, **CORS** and optional **HTTPS** (self-signed if no cert/key is
   given).
@@ -191,6 +194,15 @@ installs only what it needs.
 Changelog
 =========
 
+2.1.0
+-----
+
+**New**
+
+- Plain-text, config and template files (such as ``.yaml``, ``.tpl``, ``.j2``,
+  ``.jinja2``, ``.template`` and ``.config``) now open inline in the browser
+  instead of being downloaded (issue #8). Thanks to zaro0508 for the report.
+
 2.0.1
 -----
 

{webdev-2.0.1 → webdev-2.1.0}/README.rst

@@ -64,6 +64,9 @@ Features
   startup so you can open the site on your phone.
 - 🌈 **Colorized, level-aware logs** for readable output.
 - ⚡ **No-cache headers** for always-fresh development content.
+- 👀 **Previews text inline** — plain-text, config and template files (``.txt``,
+  ``.json``, ``.yaml``, ``.ini``, ``.toml``, ``.j2``/``.jinja2``, ``.template``,
+  ``.config`` and more) open in the browser instead of being downloaded.
 - 🧭 **SPA fallback** — optionally serve ``index.html`` for unknown routes.
 - 📦 **Gzip**, **CORS** and optional **HTTPS** (self-signed if no cert/key is
   given).
@@ -161,6 +164,15 @@ installs only what it needs.
 Changelog
 =========
 
+2.1.0
+-----
+
+**New**
+
+- Plain-text, config and template files (such as ``.yaml``, ``.tpl``, ``.j2``,
+  ``.jinja2``, ``.template`` and ``.config``) now open inline in the browser
+  instead of being downloaded (issue #8). Thanks to zaro0508 for the report.
+
 2.0.1
 -----
 

webdev-2.1.0/tests/test_mime.py

@@ -0,0 +1,47 @@
+"""
+Serve the committed ``testfiles`` fixtures and assert plain-text, config and
+template files load inline in the browser instead of being downloaded.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+from starlette.testclient import TestClient
+
+from webdev.config import Settings
+from webdev.server import create_app
+from webdev.static import guess_media_type
+
+TESTFILES = Path(__file__).parent / 'testfiles'
+
+#: Every committed fixture, discovered dynamically.
+FIXTURES = sorted(p for p in TESTFILES.iterdir() if p.is_file())
+
+#: Content types browsers render inline rather than offering to download.
+INLINE_TYPES = {'text/plain', 'application/json'}
+
+
+@pytest.fixture
+def testfiles_client() -> TestClient:
+    settings = Settings(
+        path=str(TESTFILES),
+        reload=False,
+        qr=False,
+        gzip=False,
+    ).normalized()
+    return TestClient(create_app(settings))
+
+
+@pytest.mark.parametrize('fixture', FIXTURES, ids=lambda p: p.name)
+def test_file_served_inline(testfiles_client: TestClient, fixture: Path) -> None:
+    with testfiles_client as c:
+        resp = c.get('/{}'.format(fixture.name))
+    assert resp.status_code == 200
+
+    content_type = resp.headers['content-type'].split(';')[0]
+    assert content_type == guess_media_type(fixture)
+    assert content_type in INLINE_TYPES
+    # The browser must render the file, never download it.
+    assert 'attachment' not in resp.headers.get('content-disposition', '')

{webdev-2.0.1 → webdev-2.1.0}/tests/test_static.py

@@ -46,10 +46,35 @@ def test_find_index_file(served_dir: Path) -> None:
 
 
 def test_guess_media_type_registered_extensions(tmp_path: Path) -> None:
-    for name in ('conf.toml', 'setup.ini', 'app.cfg', 'notes.log'):
+    extensions = (
+        'conf.toml',
+        'setup.ini',
+        'app.cfg',
+        'notes.log',
+        'config.yaml',
+        'config.yml',
+        'site.template',
+        'page.tmpl',
+        'legacy.tpl',
+        'email.j2',
+        'base.jinja',
+        'newsletter.jinja2',
+        'app.config',
+    )
+    for name in extensions:
         f = tmp_path / name
         f.write_text('key = 1')
-        assert guess_media_type(f) == 'text/plain'
+        assert guess_media_type(f) == 'text/plain', name
+
+
+def test_guess_media_type_txt_and_json(tmp_path: Path) -> None:
+    txt = tmp_path / 'notes.txt'
+    txt.write_text('hello')
+    assert guess_media_type(txt) == 'text/plain'
+
+    data = tmp_path / 'data.json'
+    data.write_text('{"ok": true}')
+    assert guess_media_type(data) == 'application/json'
 
 
 def test_guess_media_type_known_binary(tmp_path: Path) -> None:

webdev-2.1.0/tests/testfiles/app.config

@@ -0,0 +1,2 @@
+debug = true
+host = localhost

webdev-2.1.0/tests/testfiles/config.yaml

@@ -0,0 +1,2 @@
+name: webdev
+enabled: true

webdev-2.1.0/tests/testfiles/config.yml

@@ -0,0 +1,2 @@
+name: webdev
+enabled: true

webdev-2.1.0/tests/testfiles/data.json

@@ -0,0 +1,4 @@
+{
+  "name": "webdev",
+  "ok": true
+}

webdev-2.1.0/tests/testfiles/email.j2

@@ -0,0 +1 @@
+Hello {{ name }}, this is a Jinja2 template.

webdev-2.1.0/tests/testfiles/newsletter.jinja2

@@ -0,0 +1 @@
+<p>Hello {{ name }}</p>

webdev-2.1.0/tests/testfiles/page.tpl

@@ -0,0 +1 @@
+Hello {{ name }}, this is a .tpl template.

webdev-2.1.0/tests/testfiles/sample.toml

@@ -0,0 +1,2 @@
+[tool.webdev]
+port = 8080

webdev-2.1.0/tests/testfiles/sample.txt

@@ -0,0 +1 @@
+Just a plain text note.

webdev-2.1.0/tests/testfiles/setup.ini

@@ -0,0 +1,2 @@
+[server]
+port = 8080

webdev-2.1.0/tests/testfiles/site.template

@@ -0,0 +1 @@
+Hello {{ name }}, this is a .template file.

{webdev-2.0.1 → webdev-2.1.0}/webdev/__init__.py

@@ -25,6 +25,6 @@ index, optional HTTPS, and more.
 
 from __future__ import annotations
 
-__version__ = '2.0.1'
+__version__ = '2.1.0'
 
 __all__ = ['__version__']

{webdev-2.0.1 → webdev-2.1.0}/webdev/static.py

@@ -50,6 +50,13 @@ EXTRA_MIME_TYPES = {
     '.svelte': 'text/plain',
     '.yml': 'text/plain',
     '.yaml': 'text/plain',
+    '.template': 'text/plain',
+    '.tmpl': 'text/plain',
+    '.tpl': 'text/plain',
+    '.j2': 'text/plain',
+    '.jinja': 'text/plain',
+    '.jinja2': 'text/plain',
+    '.config': 'text/plain',
 }
 
 #: Number of bytes inspected when sniffing whether an unknown file is text.