add mdx-linkify to markdown extensions

test multi-line metadata entries
add opengraph metadata to pages, via Markdown meta
2021-01-22 09:51:53 -06:00 · 2021-01-17 23:58:57 -06:00 · 2021-01-17 23:02:14 -06:00
9 changed files with 209 additions and 65 deletions
--- a/incorporealcms/config.py
+++ b/incorporealcms/config.py
@@ -32,7 +32,7 @@ class Config(object):
        },
    }

-    MARKDOWN_EXTENSIONS = ['meta', 'tables']
+    MARKDOWN_EXTENSIONS = ['mdx_linkify', 'tables']

    DEFAULT_PAGE_STYLE = 'light'

--- a/incorporealcms/lib.py
+++ b/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 ""
--- a/incorporealcms/pages.py
+++ b/incorporealcms/pages.py
@@ -8,6 +8,8 @@ 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='/')
@@ -34,8 +36,9 @@ def display_page(path):
    else:
        content = Markup(app.config['md'].convert(entry))
        logger.debug("file metadata: %s", app.config['md'].Meta)
-        title = " ".join(app.config['md'].Meta.get('title')) if app.config['md'].Meta.get('title') else ""
-        return render('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'))


--- a/incorporealcms/templates/base.html
+++ b/incorporealcms/templates/base.html
@@ -1,9 +1,15 @@
 <!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/requirements/requirements-dev.txt
+++ b/requirements/requirements-dev.txt
@@ -4,59 +4,148 @@
 #
 #    pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
 #
-appdirs==1.4.4            # via virtualenv
-attrs==20.3.0             # via pytest
-bandit==1.6.3             # via -r requirements/requirements-dev.in
-click==7.1.2              # via flask, pip-tools
-coverage==5.3             # via pytest-cov
-distlib==0.3.1            # via virtualenv
-dlint==0.11.0             # via -r requirements/requirements-dev.in
-filelock==3.0.12          # via tox, virtualenv
-flake8-blind-except==0.1.1  # via -r requirements/requirements-dev.in
-flake8-builtins==1.5.3    # via -r requirements/requirements-dev.in
-flake8-docstrings==1.5.0  # via -r requirements/requirements-dev.in
-flake8-executable==2.1.0  # 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.11         # via bandit
-iniconfig==1.1.1          # via pytest
-isort==5.6.4              # via flake8-isort
-itsdangerous==1.1.0       # via flask
-jinja2==2.11.2            # via flask
-markdown==3.3.3           # via -r requirements/requirements.in
-markupsafe==1.1.1         # via jinja2
-mccabe==0.6.1             # via flake8
-packaging==20.7           # via pytest, tox
-pbr==5.5.1                # via stevedore
-pip-tools==5.4.0          # via -r requirements/requirements-dev.in
-pluggy==0.13.1            # via pytest, tox
-py==1.9.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.10.1        # via -r requirements/requirements-dev.in
-pytest==6.1.2             # via -r requirements/requirements-dev.in, pytest-cov
-pytz==2020.4              # via tzlocal
-pyyaml==5.3.1             # via bandit
-six==1.15.0               # via bandit, pip-tools, tox, virtualenv
-smmap==3.0.4              # via gitdb
-snowballstemmer==2.0.0    # via pydocstyle
-stevedore==3.3.0          # via bandit
-testfixtures==6.15.0      # via flake8-isort
-toml==0.10.2              # via pytest, tox
-tox-wheel==0.6.0          # via -r requirements/requirements-dev.in
-tox==3.20.1               # 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.2.2        # via tox
-werkzeug==1.0.1           # via flask
-wheel==0.36.1             # via tox-wheel
+appdirs==1.4.4
+    # via virtualenv
+attrs==20.3.0
+    # via pytest
+bandit==1.7.0
+    # via -r requirements/requirements-dev.in
+bleach==3.2.2
+    # via mdx-linkify
+click==7.1.2
+    # via
+    #   flask
+    #   pip-tools
+coverage==5.3.1
+    # via pytest-cov
+distlib==0.3.1
+    # via virtualenv
+dlint==0.11.0
+    # via -r requirements/requirements-dev.in
+filelock==3.0.12
+    # via
+    #   tox
+    #   virtualenv
+flake8-blind-except==0.2.0
+    # via -r requirements/requirements-dev.in
+flake8-builtins==1.5.3
+    # via -r requirements/requirements-dev.in
+flake8-docstrings==1.5.0
+    # 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
--- a/requirements/requirements.in
+++ b/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
--- a/requirements/requirements.txt
+++ b/requirements/requirements.txt
@@ -4,12 +4,35 @@
 #
 #    pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
 #
-click==7.1.2              # via flask
-flask==1.1.2              # via -r requirements/requirements.in
-itsdangerous==1.1.0       # via flask
-jinja2==2.11.2            # via flask
-markdown==3.3.3           # via -r requirements/requirements.in
-markupsafe==1.1.1         # via jinja2
-pytz==2020.4              # via tzlocal
-tzlocal==2.1              # via -r requirements/requirements.in
-werkzeug==1.0.1           # via flask
+bleach==3.2.2
+    # via mdx-linkify
+click==7.1.2
+    # via flask
+flask==1.1.2
+    # via -r requirements/requirements.in
+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
+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
--- a/tests/functional_tests.py
+++ b/tests/functional_tests.py
@@ -30,6 +30,15 @@ def test_page_without_title_metadata(client):
    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('/')
--- a/tests/instance/pages/more-metadata.md
+++ b/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
Author	SHA1	Message	Date
Brian S. Stephan	87ad48d8d2	add mdx-linkify to markdown extensions	2021-01-22 09:51:53 -06:00
Brian S. Stephan	8a6f4d6b45	test multi-line metadata entries	2021-01-17 23:58:57 -06:00
Brian S. Stephan	c25fefa9e3	add opengraph metadata to pages, via Markdown meta	2021-01-17 23:02:14 -06:00