show some navigation on every page

closes #1

incorporealcms/__init__.py

@@ -3,7 +3,7 @@ import logging
 import os
 from logging.config import dictConfig
 
-from flask import Flask, request
+from flask import Flask, request, send_from_directory
 
 from ._version import get_versions
 
@@ -17,12 +17,11 @@ def create_app(instance_path=None, test_config=None):
     # if it doesn't already exist, create the instance folder
     os.makedirs(app.instance_path, exist_ok=True)
 
-    if test_config is None:
     # load defaults from config provided with the application
     app.config.from_object('incorporealcms.config.Config')
     # load specific instance configurations
     app.config.from_pyfile('config.py', silent=True)
-    else:
+    if test_config:
         app.config.from_mapping(test_config)
 
     dictConfig(app.config['LOGGING'])
@@ -33,7 +32,17 @@ def create_app(instance_path=None, test_config=None):
 
     @app.before_request
     def log_request():
-        logger.info("REQUEST: [ %s ]", request.path)
+        logger.info("REQUEST:  %s %s", request.method, request.path)
+
+    @app.after_request
+    def log_response(response):
+        logger.info("RESPONSE: %s %s: %s", request.method, request.path, response.status)
+        return response
+
+    @app.route(f'/{app.config["MEDIA_DIR"]}/<path:filename>')
+    def media_files(filename):
+        return send_from_directory(os.path.join(app.instance_path, app.config['MEDIA_DIR']),
+                                   filename)
 
     from . import pages
     app.register_blueprint(pages.bp)

incorporealcms/config.py

@@ -31,3 +31,6 @@ class Config(object):
             },
         },
     }
+
+    TITLE_SUFFIX = 'incorporeal.org'
+    MEDIA_DIR = 'media'

incorporealcms/pages.py

@@ -17,8 +17,9 @@ md = markdown.Markdown(extensions=['meta'])
 @bp.route('/<path:path>')
 def display_page(path):
     """Get the file contents of the requested path and render the file."""
-    resolved_path = page_file_resolver(path)
+    resolved_path = resolve_page_file(path)
-    logger.info("received request for path '%s', resolved to '%s'", path, resolved_path)
+    parent_navs = generate_parent_navs(resolved_path)
+    logger.debug("received request for path '%s', resolved to '%s'", path, resolved_path)
     try:
         with app.open_instance_resource(resolved_path, 'r') as entry_file:
             logger.debug("file '%s' found", resolved_path)
@@ -31,10 +32,11 @@ def display_page(path):
         content = Markup(md.convert(entry))
         logger.debug("file metadata: %s", md.Meta)
         title = " ".join(md.Meta.get('title')) if md.Meta.get('title') else ""
-        return render_template('base.html', title=title, content=content, mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
+        return render_template('base.html', title=title, content=content, navs=parent_navs,
+                               mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
 
 
-def page_file_resolver(path):
+def resolve_page_file(path):
     """Manipulate the request path to find appropriate page file.
 
     * convert dir requests to index files
@@ -46,3 +48,21 @@ def page_file_resolver(path):
         path = f'{path}index'
     path = f'pages/{path}.md'
     return path
+
+
+def generate_parent_navs(path):
+    """Create a series of paths/links to navigate up from the given path."""
+    parent_dir = os.path.dirname(path)
+    if parent_dir == 'pages':
+        return [(app.config['TITLE_SUFFIX'], '/')]
+    elif path.endswith('index.md'):
+        # if we're on an index.md, don't link to ourselves as we're our own parent
+        return generate_parent_navs(parent_dir)
+    else:
+        parent_path = f'{parent_dir}/'.replace('pages/', '/', 1)
+        resolved_parent_path = resolve_page_file(parent_path)
+        with app.open_instance_resource(resolved_parent_path, 'r') as entry_file:
+            entry = entry_file.read()
+        _ = Markup(md.convert(entry))
+        parent_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else os.path.basename(parent_dir)
+        return generate_parent_navs(parent_dir) + [(parent_name, parent_path)]

incorporealcms/static/css/style.css

@@ -1,14 +1,66 @@
 html {
     font-family: sans-serif;
-    padding: 0 1em;
+    padding: 0;
+    padding-bottom: 16px;
+    color: #222;
+}
+
+body {
+    margin: 0;
 }
 
 h1,h2,h3,h4,h5,h6 {
     color: #811610;
 }
 
+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 {
+    color: #666;
+    background: #eee;
+    font-size: 0.75em;
+    border-bottom: 1px solid #ccc;
+    padding: 0.25em 0.5em;
+}
+
+section.nav a {
+    color: #666;
+    border-bottom: none;
+}
+
+section.content {
+    padding: 0 1em;
+}
+
 footer {
     display: block;
     font-size: 75%;
     color: #999;
+    padding: 0 1em;
 }

incorporealcms/templates/base.html

@@ -1,7 +1,13 @@
 <!doctype html>
-<title>{{ title }}{% if title %} - {% endif %}incorporeal.org</title>
+<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
 <link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
 <link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
+<section class="nav">
+    {% for nav in navs %}
+    <a href="{{ nav.1 }}">{{ nav.0 }}</a>
+    {% if not loop.last %} &raquo; {% endif %}
+    {% endfor %}
+</section>
 <section class="content">
 {{ content }}
 </section>

setup.py

@@ -15,7 +15,7 @@ def extract_requires():
 
 setup(
     name='incorporeal-cms',
-    description='Flask project for running https://incorporeal.org.',
+    description='Flask project for running https://suou.net (and eventually others).',
     url='https://git.incorporeal.org/bss/incorporeal-cms',
     license='GPL3',
     author='Brian S. Stephan',

tests/instance/pages/subdir-with-title/index.md

@@ -0,0 +1,3 @@
+Title:  SUB!
+
+# subdir-with-title

tests/instance/pages/subdir-with-title/page.md

@@ -0,0 +1 @@
+test page

tests/instance/pages/subdir/index.md

@@ -0,0 +1 @@
+# another page

tests/instance/pages/subdir/page.md

@@ -0,0 +1,3 @@
+Title:  Page
+
+# hello

tests/test_factory.py

@@ -0,0 +1,29 @@
+"""Test basic configuration stuff."""
+import os
+
+from incorporealcms import create_app
+
+HERE = os.path.dirname(os.path.abspath(__file__))
+
+
+def test_config():
+    """Test create_app without passing test config."""
+    instance_path = os.path.join(HERE, 'instance')
+    assert not create_app(instance_path=instance_path).testing
+    assert create_app(instance_path=instance_path, test_config={"TESTING": True}).testing
+
+
+def test_title_override():
+    """Test that a configuration with a specific title overrides the default."""
+    instance_path = os.path.join(HERE, 'instance')
+    app = create_app(instance_path=instance_path, test_config={'TITLE_SUFFIX': 'suou.net'})
+    client = app.test_client()
+    response = client.get('/no-title')
+    assert response.status_code == 200
+    assert b'<title>suou.net</title>' in response.data
+
+
+def test_media_file_access(client):
+    response = client.get('/media/favicon.png')
+    assert response.status_code == 200
+    assert response.headers['content-type'] == 'image/png'

tests/test_pages.py

@@ -1,19 +1,19 @@
 """Test page views and helper methods."""
 import re
 
-from incorporealcms.pages import page_file_resolver
+from incorporealcms.pages import generate_parent_navs, resolve_page_file
 
 
-def test_page_file_resolver_dir_to_index():
+def test_resolve_page_file_dir_to_index():
-    assert page_file_resolver('foo/') == 'pages/foo/index.md'
+    assert resolve_page_file('foo/') == 'pages/foo/index.md'
 
 
-def test_page_file_resolver_subdir_to_index():
+def test_resolve_page_file_subdir_to_index():
-    assert page_file_resolver('foo/bar/') == 'pages/foo/bar/index.md'
+    assert resolve_page_file('foo/bar/') == 'pages/foo/bar/index.md'
 
 
-def test_page_file_resolver_other_requests_fine():
+def test_resolve_page_file_other_requests_fine():
-    assert page_file_resolver('foo/baz') == 'pages/foo/baz.md'
+    assert resolve_page_file('foo/baz') == 'pages/foo/baz.md'
 
 
 def test_page_that_exists(client):
@@ -44,3 +44,24 @@ 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):
+    with app.app_context():
+        assert generate_parent_navs('pages/index.md') == [('incorporeal.org', '/')]
+
+
+def test_generate_page_navs_subdir_index(app):
+    with app.app_context():
+        assert generate_parent_navs('pages/subdir/index.md') == [('incorporeal.org', '/')]
+
+
+def test_generate_page_navs_subdir_real_page(app):
+    with app.app_context():
+        assert generate_parent_navs('pages/subdir/page.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/')]
+
+
+def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
+    with app.app_context():
+        assert generate_parent_navs('pages/subdir-with-title/page.md') == [('incorporeal.org', '/'),
+                                                                           ('SUB!', '/subdir-with-title/')]