add mdx-linkify to markdown extensions

this is really pushing my patience for CSS, but I've always thought this
looked nice, so I'm going to try to retain it

.gitignore

@@ -12,6 +12,7 @@ __pycache__/
 build/
 develop-eggs/
 dist/
+dist
 downloads/
 eggs/
 .eggs/

MANIFEST.in

@@ -1,5 +1,4 @@
 graft incorporealcms/static
 graft incorporealcms/templates
-include versioneer.py
 global-exclude *.pyc
 global-exclude *.swp

incorporealcms/__init__.py

@@ -1,8 +1,9 @@
-"""create_app application factory function and similar things."""
+"""An application for running my Markdown-based sites."""
 import logging
 import os
 from logging.config import dictConfig
 
+import markdown
 from flask import Flask, request, send_from_directory
 
 from ._version import get_versions
@@ -12,6 +13,7 @@ del get_versions
 
 
 def create_app(instance_path=None, test_config=None):
+    """Create the Flask app, with allowances for customizing path and test settings."""
     app = Flask(__name__, instance_relative_config=True, instance_path=instance_path)
 
     # if it doesn't already exist, create the instance folder
@@ -30,6 +32,10 @@ def create_app(instance_path=None, test_config=None):
 
     logger.debug("instance path: %s", app.instance_path)
 
+    # initialize markdown parser from config, but include
+    # extensions our app depends on, like the meta extension
+    app.config['md'] = markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'])
+
     @app.before_request
     def log_request():
         logger.info("REQUEST:  %s %s", request.method, request.path)

incorporealcms/config.py

@@ -32,5 +32,9 @@ class Config(object):
         },
     }
 
+    MARKDOWN_EXTENSIONS = ['mdx_linkify', 'tables']
+
+    DEFAULT_PAGE_STYLE = 'light'
+
     TITLE_SUFFIX = 'incorporeal.org'
     MEDIA_DIR = 'media'

incorporealcms/lib.py

@@ -0,0 +1,7 @@
+"""Miscellaneous helper functions and whatnot."""
+from flask import current_app as app
+
+
+def get_meta_str(key):
+    """Provide the page's metadata for the specified key, or '' if unset."""
+    return " ".join(app.config['md'].Meta.get(key)) if app.config['md'].Meta.get(key) else ""

incorporealcms/pages.py

@@ -3,20 +3,25 @@ import datetime
 import logging
 import os
 
-import markdown
+from flask import Blueprint, Markup, abort
-from flask import Blueprint, Markup, abort, current_app as app, render_template
+from flask import current_app as app
+from flask import make_response, redirect, render_template, request
 from tzlocal import get_localzone
 
+from incorporealcms.lib import get_meta_str
+
 logger = logging.getLogger(__name__)
 
 bp = Blueprint('pages', __name__, url_prefix='/')
-md = markdown.Markdown(extensions=['meta', 'tables'])
 
 
 @bp.route('/', defaults={'path': 'index'})
 @bp.route('/<path:path>')
 def display_page(path):
     """Get the file contents of the requested path and render the file."""
+    if is_file_path_actually_dir_path(path):
+        return redirect(f'{path}/', code=301)
+
     resolved_path = resolve_page_file(path)
     logger.debug("received request for path '%s', resolved to '%s'", path, resolved_path)
     try:
@@ -29,13 +34,38 @@ def display_page(path):
         logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
         abort(404)
     else:
-        content = Markup(md.convert(entry))
+        content = Markup(app.config['md'].convert(entry))
-        logger.debug("file metadata: %s", md.Meta)
+        logger.debug("file metadata: %s", app.config['md'].Meta)
-        title = " ".join(md.Meta.get('title')) if md.Meta.get('title') else ""
+
-        return render_template('base.html', title=title, content=content, navs=parent_navs,
+        return render('base.html', title=get_meta_str('title'), description=get_meta_str('description'),
+                      image=get_meta_str('image'), base_url=request.base_url, content=content, navs=parent_navs,
                       mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
 
 
+def render(template_name_or_list, **context):
+    """Wrap Flask's render_template.
+
+    * Determine the proper site theme to use in the template and provide it.
+    """
+    PAGE_STYLES = {
+        'dark': 'css/dark.css',
+        'light': 'css/light.css',
+    }
+
+    selected_style = request.args.get('style', None)
+    if selected_style:
+        user_style = selected_style
+    else:
+        user_style = request.cookies.get('user-style')
+        logger.debug("user style cookie: %s", user_style)
+    context['user_style'] = PAGE_STYLES.get(user_style, PAGE_STYLES.get(app.config['DEFAULT_PAGE_STYLE']))
+
+    resp = make_response(render_template(template_name_or_list, **context))
+    if selected_style:
+        resp.set_cookie('user-style', selected_style)
+    return resp
+
+
 def resolve_page_file(path):
     """Manipulate the request path to find appropriate page file.
 
@@ -50,6 +80,22 @@ def resolve_page_file(path):
     return path
 
 
+def is_file_path_actually_dir_path(path):
+    """Check if requested path which looks like a file is actually a directory.
+
+    If, for example, /foo used to be a file (foo.md) which later became a directory,
+    foo/, this returns True. Useful for when I make my structure more complicated
+    than it originally was, or if users are just weird.
+    """
+    if not path.endswith('/'):
+        logger.debug("requested path '%s' looks like a file", path)
+        if os.path.isdir(f'{app.instance_path}/pages/{path}'):
+            logger.debug("...and it's actually a dir")
+            return True
+
+    return False
+
+
 def generate_parent_navs(path):
     """Create a series of paths/links to navigate up from the given path."""
     # derive additional path/location stuff based on path
@@ -65,6 +111,6 @@ def generate_parent_navs(path):
     else:
         with app.open_instance_resource(resolved_path, 'r') as entry_file:
             entry = entry_file.read()
-        _ = Markup(md.convert(entry))
+        _ = Markup(app.config['md'].convert(entry))
-        page_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else f'/{path}'
+        page_name = " ".join(app.config['md'].Meta.get('title')) if app.config['md'].Meta.get('title') else f'/{path}'
         return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]

incorporealcms/static/css/dark.css

@@ -0,0 +1,61 @@
+html {
+    color: #DDD;
+}
+
+body {
+    background: black;
+}
+
+.site-wrap {
+    background: #111;
+
+    border: 1px solid #222;
+    border-top: none;
+    border-bottom: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    color: #B31D15;
+}
+
+a:link, a:visited {
+    color: #EEE;
+    border-bottom: 1px dotted #EEE;
+}
+
+a:hover, a:active {
+    color: #B31D15;
+    border-bottom: 1px dotted #EEE;
+}
+
+section.nav, section.styles {
+    color: #BBB;
+    background: #222;
+    border-bottom: 1px solid #222;
+}
+
+section.nav a, section.styles a {
+    color: #BBB;
+}
+
+table, th, td {
+    border: 1px solid #333;
+}
+
+th {
+    background: #333;
+}
+
+blockquote {
+    background-color: rgba(120, 120, 120, 0.3);
+    border: 1px solid #222;
+}
+
+figure {
+    background: #222;
+    border: 1px solid #333;
+}
+
+figcaption {
+    color: #BBB;
+}

incorporealcms/static/css/light.css

@@ -0,0 +1,61 @@
+html {
+    color: #222;
+}
+
+body {
+    background: #888;
+}
+
+.site-wrap {
+    background: white;
+
+    border: 1px solid #ddd;
+    border-top: none;
+    border-bottom: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    color: #811610;
+}
+
+a:link, a:visited {
+    color: #111;
+    border-bottom: 1px dotted #111;
+}
+
+a:hover, a:active {
+    color: #811610;
+    border-bottom: 1px dotted #111;
+}
+
+section.nav, section.styles {
+    color: #666;
+    background: #EEE;
+    border-bottom: 1px solid #CCC;
+}
+
+section.nav a, section.styles a {
+    color: #666;
+}
+
+table, th, td {
+    border: 1px solid #ccc;
+}
+
+th {
+    background: #eee;
+}
+
+blockquote {
+    background-color: rgba(120, 120, 120, 0.1);
+    border: 1px solid #CCC;
+}
+
+figure {
+    background: #EFEFEF;
+    border: 1px solid #CCCCCC;
+}
+
+figcaption {
+    color: #777777;
+}

incorporealcms/static/css/style.css

@@ -1,16 +1,22 @@
 html {
     font-family: sans-serif;
     padding: 0;
-    padding-bottom: 16px;
-    color: #222;
 }
 
 body {
     margin: 0;
+    text-size-adjust: 100%;
+    -ms-text-size-adjust: 100%;
+    -moz-text-size-adjust: 100%;
+    -webkit-text-size-adjust: 100%;
 }
 
-h1,h2,h3,h4,h5,h6 {
+.site-wrap {
-    color: #811610;
+    max-width: 70pc;
+    min-height: 100vh;
+    margin: 0;
+    margin-left: auto;
+    margin-right: auto;
 }
 
 h1 {
@@ -38,46 +44,39 @@ h6 {
 }
 
 a:link {
-    color: #222;
     font-weight: bold;
     text-decoration: none;
-    border-bottom: 1px dotted #222;
 }
 
 a:visited {
-    color: #222;
     font-weight: bold;
     text-decoration: none;
-    border-bottom: 1px dotted #222;
 }
 
 a:hover {
-    color: #811610;
     font-weight: bold;
     text-decoration: none;
-    border-bottom: 1px dotted #222;
 }
 
 a:active {
-    color: #811610;
     font-weight: bold;
     text-decoration: none;
-    border-bottom: 1px dotted #222;
 }
 
-section.nav {
+section.nav, section.styles {
-    color: #666;
-    background: #eee;
     font-size: 0.75em;
-    border-bottom: 1px solid #ccc;
+    border-bottom: 1px solid #444;
     padding: 0.25em 0.5em;
 }
 
-section.nav a {
+section.nav a, section.styles a {
-    color: #666;
     border-bottom: none;
 }
 
+section.styles {
+    float: right;
+}
+
 section.content {
     font-size: 11pt;
 
@@ -90,6 +89,8 @@ footer {
     font-size: 75%;
     color: #999;
     padding: 0 1em;
+    padding-bottom: 16px;
+    margin-top: 15px;
 }
 
 table {
@@ -98,10 +99,77 @@ table {
 
 table, th, td {
     padding: 5px;
-    border: 1px solid #222;
+    border: 1px solid #ccc;
     margin-bottom: 15px;
 }
 
-th {
+blockquote {
-    background: #eee;
+    background-color: rgba(120, 120, 120, 0.3);
+    padding: 1px 10px;
+}
+
+.splash {
+    margin-top: 1em;
+    margin-bottom: 1em;
+    text-align: center;
+}
+
+.splash img {
+    max-width: 100%;
+}
+
+.img-50 {
+    max-width: 50% !important;
+}
+
+/* For screens with width smaller than 400px */
+.figure-left .figure-right {
+    max-width: 95%;
+    float: none;
+    margin-left: 10px;
+    margin-right: 10px;
+}
+
+/* For larger screens */
+@media only screen and (min-width: 400px) {
+    .figure-left {
+        float: left;
+        margin-top: 0;
+        margin-left: 0;
+    }
+
+    .figure-right {
+        float: right;
+        margin-top: 0;
+        margin-right: 0;
+    }
+}
+
+figure {
+    max-width: 400px;
+    padding: 5px;
+    margin: 10px;
+    margin-top: 0;
+    margin-bottom: 5px;
+}
+
+figure img {
+    max-width: 100%;
+    height: auto;
+}
+
+figcaption {
+    font-family: "Times New Roman", serif;
+    color: #777777;
+    text-align: center;
+    font-style: italic;
+    line-height: 1.3em;
+    margin-top: 5px;
+}
+
+.thumbnail-image {
+    width: 150px;
+    height: auto;
+    margin: 5px;
+    display: inline;
 }

incorporealcms/templates/base.html

@@ -1,7 +1,20 @@
 <!doctype html>
 <title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
+{% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
+{% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
+{% if image %}<meta property="og:image" content="{{ image }}">{% endif %}
+<meta property="og:url" content="{{ base_url }}">
+<meta name="twitter:card" content="summary_large_image">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
+<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
 <link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
+
+<section class="site-wrap">
+    <section class="styles">
+        <a href="?style=dark">[dark]</a>
+        <a href="?style=light">[light]</a>
+    </section>
     <section class="nav">
         {% for nav in navs %}
         <a href="{{ nav.1 }}">{{ nav.0 }}</a>
@@ -14,3 +27,4 @@
     <footer>
         <i>Last modified: {{ mtime }}</i>
     </footer>
+</section>

requirements/requirements-dev.in

@@ -1,7 +1,24 @@
 -r requirements.in
 
-flake8                      # python code quality stuff
+# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
+pytest
+pytest-cov
+
+# linting and other static code analysis
+bandit
+dlint
+flake8
+flake8-blind-except
+flake8-builtins
+flake8-docstrings
+flake8-executable
+flake8-fixme
+flake8-isort
+flake8-logging-format
+flake8-mutable
+
+# maintenance utilities and tox
 pip-tools                   # pip-compile
-pytest                      # unit tests
+tox                         # CI stuff
-pytest-cov                  # coverage in unit tests
+tox-wheel                   # build wheels in tox
 versioneer                  # automatic version numbering

requirements/requirements-dev.txt

@@ -4,34 +4,149 @@
 #
 #    pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
 #
-attrs==19.3.0             # via pytest
+appdirs==1.4.4
-click==7.1.2              # via flask, pip-tools
+    # via virtualenv
-coverage==5.1             # via pytest-cov
+attrs==20.3.0
-flake8==3.8.2             # via -r requirements/requirements-dev.in
+    # via pytest
-flask==1.1.2              # via -r requirements/requirements.in
+bandit==1.7.0
-importlib-metadata==1.6.0  # via flake8, markdown, pluggy, pytest
+    # via -r requirements/requirements-dev.in
-itsdangerous==1.1.0       # via flask
+bleach==3.2.2
-jinja2==2.11.2            # via flask
+    # via mdx-linkify
-markdown==3.2.2           # via -r requirements/requirements.in
+click==7.1.2
-markupsafe==1.1.1         # via jinja2
+    # via
-mccabe==0.6.1             # via flake8
+    #   flask
-more-itertools==8.3.0     # via pytest
+    #   pip-tools
-packaging==20.4           # via pytest
+coverage==5.3.1
-pip-tools==5.2.0          # via -r requirements/requirements-dev.in
+    # via pytest-cov
-pluggy==0.13.1            # via pytest
+distlib==0.3.1
-py==1.8.1                 # via pytest
+    # via virtualenv
-pycodestyle==2.6.0        # via flake8
+dlint==0.11.0
-pyflakes==2.2.0           # via flake8
+    # via -r requirements/requirements-dev.in
-pyparsing==2.4.7          # via packaging
+filelock==3.0.12
-pytest-cov==2.9.0         # via -r requirements/requirements-dev.in
+    # via
-pytest==5.4.2             # via -r requirements/requirements-dev.in, pytest-cov
+    #   tox
-pytz==2020.1              # via tzlocal
+    #   virtualenv
-six==1.15.0               # via packaging, pip-tools
+flake8-blind-except==0.2.0
-tzlocal==2.1              # via -r requirements/requirements.in
+    # via -r requirements/requirements-dev.in
-versioneer==0.18          # via -r requirements/requirements-dev.in
+flake8-builtins==1.5.3
-wcwidth==0.1.9            # via pytest
+    # via -r requirements/requirements-dev.in
-werkzeug==1.0.1           # via flask
+flake8-docstrings==1.5.0
-zipp==3.1.0               # via importlib-metadata
+    # via -r requirements/requirements-dev.in
+flake8-executable==2.1.1
+    # via -r requirements/requirements-dev.in
+flake8-fixme==1.1.1
+    # via -r requirements/requirements-dev.in
+flake8-isort==4.0.0
+    # via -r requirements/requirements-dev.in
+flake8-logging-format==0.6.0
+    # via -r requirements/requirements-dev.in
+flake8-mutable==1.2.0
+    # via -r requirements/requirements-dev.in
+flake8==3.8.4
+    # via
+    #   -r requirements/requirements-dev.in
+    #   dlint
+    #   flake8-builtins
+    #   flake8-docstrings
+    #   flake8-executable
+    #   flake8-isort
+    #   flake8-mutable
+flask==1.1.2
+    # via -r requirements/requirements.in
+gitdb==4.0.5
+    # via gitpython
+gitpython==3.1.12
+    # via bandit
+iniconfig==1.1.1
+    # via pytest
+isort==5.7.0
+    # via flake8-isort
+itsdangerous==1.1.0
+    # via flask
+jinja2==2.11.2
+    # via flask
+markdown==3.3.3
+    # via
+    #   -r requirements/requirements.in
+    #   mdx-linkify
+markupsafe==1.1.1
+    # via jinja2
+mccabe==0.6.1
+    # via flake8
+mdx-linkify==2.1
+    # via -r requirements/requirements.in
+packaging==20.8
+    # via
+    #   bleach
+    #   pytest
+    #   tox
+pbr==5.5.1
+    # via stevedore
+pip-tools==5.5.0
+    # via -r requirements/requirements-dev.in
+pluggy==0.13.1
+    # via
+    #   pytest
+    #   tox
+py==1.10.0
+    # via
+    #   pytest
+    #   tox
+pycodestyle==2.6.0
+    # via flake8
+pydocstyle==5.1.1
+    # via flake8-docstrings
+pyflakes==2.2.0
+    # via flake8
+pyparsing==2.4.7
+    # via packaging
+pytest-cov==2.11.1
+    # via -r requirements/requirements-dev.in
+pytest==6.2.1
+    # via
+    #   -r requirements/requirements-dev.in
+    #   pytest-cov
+pytz==2020.5
+    # via tzlocal
+pyyaml==5.4.1
+    # via bandit
+six==1.15.0
+    # via
+    #   bandit
+    #   bleach
+    #   tox
+    #   virtualenv
+smmap==3.0.4
+    # via gitdb
+snowballstemmer==2.1.0
+    # via pydocstyle
+stevedore==3.3.0
+    # via bandit
+testfixtures==6.17.1
+    # via flake8-isort
+toml==0.10.2
+    # via
+    #   pytest
+    #   tox
+tox-wheel==0.6.0
+    # via -r requirements/requirements-dev.in
+tox==3.21.2
+    # via
+    #   -r requirements/requirements-dev.in
+    #   tox-wheel
+tzlocal==2.1
+    # via -r requirements/requirements.in
+versioneer==0.19
+    # via -r requirements/requirements-dev.in
+virtualenv==20.4.0
+    # via tox
+webencodings==0.5.1
+    # via bleach
+werkzeug==1.0.1
+    # via flask
+wheel==0.36.2
+    # via tox-wheel
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip
+# setuptools

requirements/requirements.in

@@ -1,3 +1,4 @@
 Flask                       # general purpose web service and web server stuff
 Markdown                    # markdown rendering in templates
+mdx-linkify                 # convert URLs in the text to clickable links
 tzlocal                     # identifying system's local timezone

requirements/requirements.txt

@@ -4,14 +4,35 @@
 #
 #    pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
 #
-click==7.1.2              # via flask
+bleach==3.2.2
-flask==1.1.2              # via -r requirements/requirements.in
+    # via mdx-linkify
-importlib-metadata==1.6.0  # via markdown
+click==7.1.2
-itsdangerous==1.1.0       # via flask
+    # via flask
-jinja2==2.11.2            # via flask
+flask==1.1.2
-markdown==3.2.2           # via -r requirements/requirements.in
+    # via -r requirements/requirements.in
-markupsafe==1.1.1         # via jinja2
+itsdangerous==1.1.0
-pytz==2020.1              # via tzlocal
+    # via flask
-tzlocal==2.1              # via -r requirements/requirements.in
+jinja2==2.11.2
-werkzeug==1.0.1           # via flask
+    # via flask
-zipp==3.1.0               # via importlib-metadata
+markdown==3.3.3
+    # via
+    #   -r requirements/requirements.in
+    #   mdx-linkify
+markupsafe==1.1.1
+    # via jinja2
+mdx-linkify==2.1
+    # via -r requirements/requirements.in
+packaging==20.8
+    # via bleach
+pyparsing==2.4.7
+    # via packaging
+pytz==2020.5
+    # via tzlocal
+six==1.15.0
+    # via bleach
+tzlocal==2.1
+    # via -r requirements/requirements.in
+webencodings==0.5.1
+    # via bleach
+werkzeug==1.0.1
+    # via flask

setup.cfg

@@ -1,23 +1,3 @@
-[coverage:run]
-branch = True
-omit =
-    .venv/*
-    incorporealcms/_version.py
-    setup.py
-    tests/*
-    versioneer.py
-source =
-    incorporealcms
-
-[flake8]
-exclude = .git,.venv,__pycache__,versioneer.py,incorporealcms/_version.py
-max-line-length = 120
-
-[tool:pytest]
-addopts = --cov=. --cov-report=term --cov-report=term-missing
-log_cli = 1
-log_cli_level = DEBUG
-
 [versioneer]
 VCS = git
 style = pep440-post

setup.py

@@ -1,5 +1,6 @@
 """Setuptools configuration."""
 import os
+
 from setuptools import find_packages, setup
 
 import versioneer
@@ -8,8 +9,8 @@ HERE = os.path.dirname(os.path.abspath(__file__))
 
 
 def extract_requires():
-    """Get pinned requirements from requirements.in."""
+    """Get pinned requirements from requirements.txt."""
-    with open(os.path.join(HERE, 'requirements/requirements.in'), 'r') as reqs:
+    with open(os.path.join(HERE, 'requirements/requirements.txt'), 'r') as reqs:
         return [line.split(' ')[0] for line in reqs if not line[0] in ('-', '#')]
 
 

tests/conftest.py

@@ -10,6 +10,7 @@ HERE = os.path.dirname(os.path.abspath(__file__))
 
 @pytest.fixture
 def app():
+    """Create the Flask application, with test settings."""
     app = create_app(instance_path=os.path.join(HERE, 'instance'))
 
     yield app
@@ -17,4 +18,5 @@ def app():
 
 @pytest.fixture
 def client(app):
+    """Create a test client based on the test app."""
     return app.test_client()

tests/functional_tests.py

@@ -0,0 +1,84 @@
+"""Test page requests."""
+import re
+
+
+def test_page_that_exists(client):
+    """Test that the app can serve a basic file at the index."""
+    response = client.get('/')
+    assert response.status_code == 200
+    assert b'<h1>test index</h1>' in response.data
+
+
+def test_page_that_doesnt_exist(client):
+    """Test that the app returns 404 for nonsense requests."""
+    response = client.get('/ohuesthaoeusth')
+    assert response.status_code == 404
+
+
+def test_page_with_title_metadata(client):
+    """Test that a page with title metadata has its title written."""
+    response = client.get('/')
+    assert response.status_code == 200
+    assert b'<title>Index - incorporeal.org</title>' in response.data
+
+
+def test_page_without_title_metadata(client):
+    """Test that a page without title metadata gets the default title."""
+    response = client.get('/no-title')
+    assert response.status_code == 200
+    assert b'<title>incorporeal.org</title>' in response.data
+    assert b'<h1>this page doesn\'t have a title!</h1>' in response.data
+
+
+def test_page_with_card_metadata(client):
+    """Test that a page with opengraph metadata."""
+    response = client.get('/more-metadata')
+    assert response.status_code == 200
+    assert b'<meta property="og:title" content="title for the page">' in response.data
+    assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
+    assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
+
+
+def test_page_has_modified_timestamp(client):
+    """Test that pages have modified timestamps in them."""
+    response = client.get('/')
+    assert response.status_code == 200
+    assert re.search(r'Last modified: ....-..-.. ..:..:.. ...', response.data.decode()) is not None
+
+
+def test_that_page_request_redirects_to_directory(client):
+    """Test that a request to /foo reirects to /foo/, if foo is a directory.
+
+    This might be useful in cases where a formerly page-only page has been
+    converted to a directory with subpages.
+    """
+    response = client.get('/subdir')
+    assert response.status_code == 301
+
+
+def test_that_dir_request_does_not_redirect(client):
+    """Test that a request to /foo/ serves the index page, if foo is a directory."""
+    response = client.get('/subdir/')
+    assert response.status_code == 200
+    assert b'another page' in response.data
+
+
+def test_setting_selected_style_includes_cookie(client):
+    """Test that a request with style=foo sets the cookie and renders appropriately."""
+    response = client.get('/')
+    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    assert style_cookie is None
+
+    response = client.get('/?style=light')
+    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    assert response.status_code == 200
+    assert b'light.css' in response.data
+    assert b'dark.css' not in response.data
+    assert style_cookie.value == 'light'
+
+    response = client.get('/?style=dark')
+    style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
+    assert response.status_code == 200
+    assert b'dark.css' in response.data
+    assert b'light.css' not in response.data
+    assert style_cookie.value == 'dark'

tests/instance/config.py

@@ -1,3 +1,5 @@
+"""Configure the test application."""
+
 LOGGING = {
     'version': 1,
     'formatters': {

tests/instance/pages/mdash-or-triple-dash.md

@@ -0,0 +1,3 @@
+Test page
+
+word --- word

tests/instance/pages/more-metadata.md

@@ -0,0 +1,6 @@
+Title:          title for the page
+Description:    description of this page
+                made even longer
+Image:          http://buh.com/test.img
+
+hello

tests/test_factory.py

@@ -13,6 +13,32 @@ def test_config():
     assert create_app(instance_path=instance_path, test_config={"TESTING": True}).testing
 
 
+def test_markdown_meta_extension_always():
+    """Test that the markdown meta extension is always loaded, even if not specified."""
+    app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                     test_config={'MARKDOWN_EXTENSIONS': []})
+    client = app.test_client()
+    response = client.get('/')
+    assert response.status_code == 200
+    assert b'<title>Index - incorporeal.org</title>' in response.data
+
+
+def test_extra_markdown_extensions_work():
+    """Test we can load more extensions via config, and that they work."""
+    app = create_app(instance_path=os.path.join(HERE, 'instance'))
+    client = app.test_client()
+    response = client.get('/mdash-or-triple-dash')
+    assert response.status_code == 200
+    assert b'word --- word' in response.data
+
+    app = create_app(instance_path=os.path.join(HERE, 'instance'),
+                     test_config={'MARKDOWN_EXTENSIONS': ['smarty']})
+    client = app.test_client()
+    response = client.get('/mdash-or-triple-dash')
+    assert response.status_code == 200
+    assert b'word &mdash; word' in response.data
+
+
 def test_title_override():
     """Test that a configuration with a specific title overrides the default."""
     instance_path = os.path.join(HERE, 'instance')
@@ -24,6 +50,7 @@ def test_title_override():
 
 
 def test_media_file_access(client):
+    """Test that media files are served, and properly."""
     response = client.get('/media/favicon.png')
     assert response.status_code == 200
     assert response.headers['content-type'] == 'image/png'

tests/test_pages.py

@@ -1,76 +1,100 @@
-"""Test page views and helper methods."""
+"""Unit test helper methods."""
-import re
+from werkzeug.http import dump_cookie
 
-from incorporealcms.pages import generate_parent_navs, resolve_page_file
+from incorporealcms.pages import generate_parent_navs, is_file_path_actually_dir_path, render, resolve_page_file
 
 
 def test_resolve_page_file_dir_to_index():
+    """Test that a request to a directory path results in the dir's index.md."""
     assert resolve_page_file('foo/') == 'pages/foo/index.md'
 
 
 def test_resolve_page_file_subdir_to_index():
+    """Test that a request to a dir's subdir path results in the subdir's index.md."""
     assert resolve_page_file('foo/bar/') == 'pages/foo/bar/index.md'
 
 
 def test_resolve_page_file_other_requests_fine():
+    """Test that a request to non-dir path results in a Markdown file."""
     assert resolve_page_file('foo/baz') == 'pages/foo/baz.md'
 
 
-def test_page_that_exists(client):
-    response = client.get('/')
-    assert response.status_code == 200
-    assert b'<h1>test index</h1>' in response.data
-
-
-def test_page_that_doesnt_exist(client):
-    response = client.get('/ohuesthaoeusth')
-    assert response.status_code == 404
-
-
-def test_page_with_title_metadata(client):
-    response = client.get('/')
-    assert response.status_code == 200
-    assert b'<title>Index - incorporeal.org</title>' in response.data
-
-
-def test_page_without_title_metadata(client):
-    response = client.get('/no-title')
-    assert response.status_code == 200
-    assert b'<title>incorporeal.org</title>' in response.data
-    assert b'<h1>this page doesn\'t have a title!</h1>' in response.data
-
-
-def test_page_has_modified_timestamp(client):
-    response = client.get('/')
-    assert response.status_code == 200
-    assert re.search(r'Last modified: ....-..-.. ..:..:.. ...', response.data.decode()) is not None
-
-
 def test_generate_page_navs_index(app):
+    """Test that the index page has navs to the root (itself)."""
     with app.app_context():
         assert generate_parent_navs('/') == [('incorporeal.org', '/')]
 
 
 def test_generate_page_navs_alternate_index(app):
+    """Test that the index page (as a page, not a path) also has navs only to the root (by path)."""
     with app.app_context():
         assert generate_parent_navs('index') == [('incorporeal.org', '/')]
 
 
 def test_generate_page_navs_subdir_index(app):
+    """Test that dir pages have navs to the root and themselves."""
     with app.app_context():
         assert generate_parent_navs('subdir/') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/')]
 
 
 def test_generate_page_navs_subdir_real_page(app):
+    """Test that real pages have navs to the root, their parent, and themselves."""
     with app.app_context():
         assert generate_parent_navs('subdir/page') == [('incorporeal.org', '/'), ('/subdir/', '/subdir/'),
                                                        ('Page', '/subdir/page')]
 
 
 def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
+    """Test that title metadata is used in the nav text."""
     with app.app_context():
         assert generate_parent_navs('subdir-with-title/page') == [
             ('incorporeal.org', '/'),
             ('SUB!', '/subdir-with-title/'),
             ('/subdir-with-title/page', '/subdir-with-title/page')
         ]
+
+
+def test_is_file_path_actually_dir_path_valid_file_is_yes(app):
+    """Test that a file request for what's actually a directory is detected as such."""
+    with app.app_context():
+        assert is_file_path_actually_dir_path('/subdir')
+
+
+def test_is_file_path_actually_dir_path_valid_dir_is_no(app):
+    """Test that a directory request is still a directory request."""
+    with app.app_context():
+        assert not is_file_path_actually_dir_path('/subdir/')
+
+
+def test_is_file_path_actually_dir_path_nonsense_file_is_no(app):
+    """Test that requests to nonsense file-looking paths aren't treated as dirs."""
+    with app.app_context():
+        assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax')
+
+
+def test_is_file_path_actually_dir_path_nonsense_dir_is_no(app):
+    """Test that a directory request is a directory request even if the dir doesn't exist."""
+    with app.app_context():
+        assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax/')
+
+
+def test_render_with_user_dark_theme(app):
+    """Test that a request with the dark theme selected renders the dark theme."""
+    cookie = dump_cookie("user-style", 'dark')
+    with app.test_request_context(headers={'COOKIE': cookie}):
+        assert b'dark.css' in render('base.html').data
+        assert b'light.css' not in render('base.html').data
+
+
+def test_render_with_user_light_theme(app):
+    """Test that a request with the light theme selected renders the light theme."""
+    with app.test_request_context():
+        assert b'light.css' in render('base.html').data
+        assert b'dark.css' not in render('base.html').data
+
+
+def test_render_with_no_user_theme(app):
+    """Test that a request with no theme set renders the light theme."""
+    with app.test_request_context():
+        assert b'light.css' in render('base.html').data
+        assert b'dark.css' not in render('base.html').data

tox.ini

@@ -0,0 +1,104 @@
+# tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = begin,py37,py38,coverage,security,lint,bundle
+
+[testenv]
+# build a wheel and test it
+wheel = true
+wheel_build_env = build
+
+# whitelist commands we need
+whitelist_externals = cp
+
+# install everything via requirements-dev.txt, so that developer environment
+# is the same as the tox environment (for ease of use/no weird gotchas in
+# local dev results vs. tox results) and also to avoid ticky-tacky maintenance
+# of "oh this particular env has weird results unless I install foo" --- just
+# shotgun blast install everything everywhere
+deps =
+    -rrequirements/requirements-dev.txt
+
+[testenv:build]
+# require setuptools when building
+deps = setuptools
+
+[testenv:begin]
+# clean up potential previous coverage runs
+skip_install = true
+commands = coverage erase
+
+[testenv:py37]
+# run pytest with coverage
+commands =
+    pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
+
+[testenv:py38]
+# run pytest with coverage
+commands =
+    pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
+
+[testenv:coverage]
+# report on coverage runs from above
+skip_install = true
+commands =
+    coverage report --fail-under=95 --show-missing
+
+[testenv:security]
+# run security checks
+#
+# again it seems the most valuable here to run against the packaged code
+commands =
+    bandit {envsitepackagesdir}/incorporealcms/ -r
+
+[testenv:lint]
+# run style checks
+commands =
+    flake8
+    - flake8 --disable-noqa --ignore= --select=E,W,F,C,D,A,G,B,I,T,M,DUO
+
+[testenv:bundle]
+# take extra actions (build sdist, sphinx, whatever) to completely package the app
+commands =
+    cp -r {distdir} .
+    python setup.py sdist
+
+[coverage:paths]
+source =
+    ./
+    .tox/**/site-packages/
+
+[coverage:run]
+branch = True
+
+# redundant with pytest --cov above, but this tricks the coverage.xml report into
+# using the full path, otherwise files with the same name in different paths
+# get clobbered. maybe appends would fix this, IDK
+include =
+    .tox/**/incorporealcms/
+
+omit =
+    **/_version.py
+
+[flake8]
+enable-extensions = G,M
+exclude =
+    .tox/
+    versioneer.py
+    _version.py
+    instance/
+extend-ignore = T101
+max-complexity = 10
+max-line-length = 120
+
+[isort]
+line_length = 120
+
+[pytest]
+python_files =
+    *_tests.py
+    tests.py
+    test_*.py