requirements bump for latest release

the new way to do the links without adding links to images is probably
dumb and/or missing some stuff, but it works and does what I want, and I
think I like the old look of the colors better, so time to try it and
see if it sticks still

CONTRIBUTING.md

@@ -1,7 +1,10 @@
 # How to Contribute
 
 incorporeal-cms is a personal project seeking to implement a simpler, cleaner form of what would
-commonly be called a "CMS". I appreciate any help in making incorporeal-cms better.
+commonly be called a "CMS". I appreciate any help in making it better.
+
+incorporeal-cms is made available under the GNU Affero General Public License version 3, or any
+later version.
 
 ## Opening Issues
 
@@ -10,8 +13,24 @@ Issues should be posted to my Gitea instance at
 recommend starting the title with "Improvement:", "Bug:", or similar, so I can do a high level of
 prioritization.
 
-## Guidelines for Patches, etc.
+## Contributions
 
+I don't expect contributors to sign up for my personal Gitea in order to send contributions, but it
+of course makes it easier. If you wish to go this route, please sign up at
+<https://git.incorporeal.org/bss/incorporeal-cms> and fork the project. People planning on
+contributing often are also welcome to request access to the project directly.
+
+Otherwise, contact me via any means you know to reach me at, or <bss@incorporeal.org>, to discuss
+your change and to tell me how to pull your changes.
+
+### Guidelines for Patches, etc.
+
+* Cloning
+    * Clone the project. I would advise using a pull-based workflow where I have access to the hosted
+      repository --- using my Gitea, cloning to a public GitHub, etc. --- rather than doing this over
+      email, but that works too if we must.
+    * Make your contributions in a new branch, generally off of `master`.
+    * Send me a pull request when you're ready, and we'll go through a code review.
 * Code:
     * Keep in mind that I strive for simplicity in the software. It serves files and renders
       Markdown, that's pretty much it. Features around that function are good; otherwise, I need
@@ -27,22 +46,31 @@ prioritization.
     * Squash tiny commits if you'd like. I prefer commits that make one atomic conceptual change
       that doesn't affect the rest of the code, assembling multiple of those commits into larger
       changes.
-    * Follow something like [Chris Beams'](https://chris.beams.io/posts/git-commit/) post on
+    * Follow something like [Chris Beams's post](https://chris.beams.io/posts/git-commit/) on
       formatting a good commit message.
+    * Please make sure your Author contact information is stable, in case I need to reach you.
+    * Consider cryptographically signing (`git commit -S`) your commits.
 
-## Contributions
+### Custody of Contributions
 
-I don't expect contributors to sign up for my personal Gitea in order to send contributions, but it
-of course makes it easier. If you wish to go this route, please sign up at
-<https://git.incorporeal.org/bss/incorporeal-cms> and fork the project. People planning on
-contributing often are also welcome to request access to the project directly.
+I do not request the copyright of contributions be assigned to me or to the project, and I require no
+provision that I be allowed to relicense your contributions. My personal oath is to maintain
+inbound=outbound in my open source projects, and the expectation is authors are responsible for their
+contributions.
 
-Otherwise, contact me via any means you know to reach me at, or <bss@incorporeal.org>, to discuss
-your change and to tell me how to pull your changes.
+I am following the *spirit* of the [Developer Certificate of Origin](https://developercertificate.org/),
+but in a simplified fashion:
 
-### Copyright of Contributions
+By making a contribution to this project, you certify that:
 
-Accepted changes remain the copyright of the original author, but please include appropriate contact
-methods in the event I choose to provide the project under a new license and need to contact you
-to approve the new license terms. Please note that the software is provided under the GNU AGPLv3 (or
-later).
+1. The contribution was created by you and you have the right to submit it under the open source license
+   indicated in the LICENSE file; or
+2. The contribution is based upon previous work that is covered under an appropriate open source license
+   compatible with the license indicated in the LICENSE file, and you have the right to contribute that
+   work with or without modifications, under the terms of that same open source license; or
+3. The contribution was provided directly to you by some other person who certified points 1, 2, or 3, and
+   you have not modified it.
+
+In the event of point 3, your commit **must** include the Signed-off-by line(s) as a chain of custody,
+via `git commit -s`. For points 1 and 2, your commit with accurate Author information doubles as direct
+custody.

incorporealcms/config.py

@@ -32,10 +32,9 @@ class Config(object):
         },
     }
 
-    MARKDOWN_EXTENSIONS = ['extra', 'sane_lists', 'smarty', 'tables']
+    MARKDOWN_EXTENSIONS = ['extra', 'incorporealcms.mdx.figures', 'sane_lists', 'smarty', 'toc']
     MARKDOWN_EXTENSION_CONFIGS = {
         'extra': {
-            'attr_list': {},
             'footnotes': {
                 'UNIQUE_IDS': True,
             },

incorporealcms/mdx/figures.py

@@ -0,0 +1,60 @@
+"""Create generic figures with captions."""
+import re
+from xml.etree.ElementTree import SubElement
+
+import markdown
+
+
+class FigureExtension(markdown.Extension):
+    """Wrap the markdown prepcoressor."""
+
+    def extendMarkdown(self, md):
+        """Add FigureBlockProcessor to the Markdown instance."""
+        md.parser.blockprocessors.register(FigureBlockProcessor(md.parser), 'figure', 100)
+
+
+class FigureBlockProcessor(markdown.blockprocessors.BlockProcessor):
+    """Process figures."""
+
+    # |> thing to put in the figure
+    # |: optional caption for the figure
+    # optional whatever else, like maybe an attr_list
+    figure_regex = re.compile(r'^[ ]{0,3}\|>[ ]{0,3}(?P<content>[^\n]*)')
+    caption_regex = re.compile(r'^[ ]{0,3}\|:[ ]{0,3}(?P<caption>[^\n]*)')
+
+    def test(self, parent, block):
+        """Determine if we should process this block."""
+        lines = block.split('\n')
+        return bool(self.figure_regex.search(lines[0]))
+
+    def run(self, parent, blocks):
+        """Replace the top block with HTML."""
+        block = blocks.pop(0)
+        lines = block.split('\n')
+
+        # consume line and create a figure
+        figure_match = self.figure_regex.search(lines[0])
+        lines.pop(0)
+        content = figure_match.group('content')
+        figure = SubElement(parent, 'figure')
+        figure.text = content
+        if lines:
+            if caption_match := self.caption_regex.search(lines[0]):
+                # consume line and add the caption as a child of the figure
+                lines.pop(0)
+                caption = caption_match.group('caption')
+                figcaption = SubElement(figure, 'figcaption')
+                figcaption.text = caption
+        if lines:
+            # other lines are mysteries, might be attr_list, so re-append
+            # make sure there's a child to hang the rest (which is maybe an attr_list?) off of
+            # this is probably a bad hack
+            if not len(list(figure)):
+                SubElement(figure, 'span')
+            rest = '\n'.join(lines)
+            figure[-1].tail = f'\n{rest}'
+
+
+def makeExtension(*args, **kwargs):
+    """Provide the extension to the markdown extension loader."""
+    return FigureExtension(*args, **kwargs)

incorporealcms/mdx/pydot.py

@@ -20,14 +20,17 @@ class InlinePydot(markdown.Extension):
 class InlinePydotPreprocessor(markdown.preprocessors.Preprocessor):
     """Identify dot codeblocks and run them through pydot."""
 
-    BLOCK_RE = re.compile(r'~~~pydot:(?P<filename>[^\s]+)\n(?P<content>.*?)~~~', re.DOTALL)
+    BLOCK_RE = re.compile(r'~~~{\s+pydot:(?P<filename>[^\s]+)\s+}\n(?P<content>.*?)~~~', re.DOTALL)
 
     def run(self, lines):
         """Match and generate diagrams from dot code blocks."""
         text = '\n'.join(lines)
-        for match in self.BLOCK_RE.finditer(text):
-            filename = match.group(1)
-            dot_string = match.group(2)
+        out = text
+        for block_match in self.BLOCK_RE.finditer(text):
+            filename = block_match.group(1)
+            dot_string = block_match.group(2)
+            logger.debug("matched markdown block: %s", dot_string)
+            logger.debug("match start/end: %s/%s", block_match.start(), block_match.end())
 
             # use pydot to turn the text into pydot
             graphs = pydot.graph_from_dot_data(dot_string)
@@ -41,9 +44,9 @@ class InlinePydotPreprocessor(markdown.preprocessors.Preprocessor):
             inline_image = f'![{filename}]({data_path})'
 
             # replace the image in the output markdown
-            text = f'{text[:match.start()]}\n{inline_image}\n{text[match.end():]}'
+            out = out.replace(block_match.group(0), inline_image)
 
-        return text.split('\n')
+        return out.split('\n')
 
 
 def makeExtension(*args, **kwargs):

incorporealcms/static/css/base.css

@@ -12,11 +12,11 @@ body {
 }
 
 .site-wrap-normal-width {
-    max-width: 70pc;
+    max-width: 65pc;
 }
 
 .site-wrap-double-width {
-    max-width: 140pc;
+    max-width: 130pc;
 }
 
 .site-wrap {
@@ -26,22 +26,7 @@ body {
     margin-right: auto;
 }
 
-a:link {
-    font-weight: bold;
-    text-decoration: none;
-}
-
-a:visited {
-    font-weight: bold;
-    text-decoration: none;
-}
-
-a:hover {
-    font-weight: bold;
-    text-decoration: none;
-}
-
-a:active {
+a {
     font-weight: bold;
     text-decoration: none;
 }
@@ -49,8 +34,8 @@ a:active {
 div.header {
     display: flex;
     justify-content: space-between;
-    font-size: 0.75em;
-    padding: 0.25em 0.5em;
+    font-size: 0.9em;
+    padding: 1rem 1rem;
 }
 
 div.header a {
@@ -59,8 +44,12 @@ div.header a {
 
 div.content {
     font-size: 11pt;
-    padding: 0 1em;
-    line-height: 1.5em;
+    padding: 0 1rem;
+    line-height: 1.6em;
+}
+
+div.content p {
+    margin: 1.25em 0;
 }
 
 sup, sub {
@@ -79,7 +68,7 @@ footer {
     color: #999;
     padding: 0 1em;
     padding-bottom: 16px;
-    margin-top: 15px;
+    margin-top: 30px;
 }
 
 table {
@@ -135,39 +124,26 @@ img {
     margin-left: 1em;
 }
 
-.img-frame {
-    padding: 5px;
-}
-
-/* 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: 0;
     margin-bottom: 5px;
+    text-align: center;
+    max-width: 30%;
+    min-width: 10em;
+    display: inline-block;
+}
+
+figure.right {
+    float: right;
+    margin-left: 10px;
+    display: block;
+}
+
+figure.left {
+    float: left;
+    margin-right: 10px;
+    display: block;
 }
 
 figure img {
@@ -176,19 +152,8 @@ figure img {
 }
 
 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;
+    font-size: 0.9em;
 }
 
 .footnote {

incorporealcms/static/css/dark.css

@@ -6,38 +6,28 @@ html {
 }
 
 body {
-    background: #090909;
-}
-
-strong {
-    color: #EEE;
-}
-
-.site-wrap {
-    background: black;
-
-    border: 1px solid #222;
-    border-top: none;
-    border-bottom: none;
+    background: #111;
 }
 
 h1, h2, h3, h4, h5, h6 {
     color: #B31D15;
 }
 
-a:link, a:visited {
-    color: #EEE;
-    border-bottom: 1px dotted #EEE;
+p a, ul a, ol a {
+    color: #DDD;
+    border-bottom: 1px solid #DDD;
 }
 
-a:hover, a:active {
+p a:hover, ul a:hover, ol a:hover {
     color: #B31D15;
-    border-bottom: 1px dotted #B31D15;
+    border-bottom: 1px solid #B31D15;
+}
+
+div.site-wrap {
+    background: black;
 }
 
 div.header {
-    background: #222;
-    border-bottom: 1px solid #222;
     color: #BBB;
 }
 
@@ -45,6 +35,10 @@ div.header a {
     color: #BBB;
 }
 
+div.header a:hover, div.header a:active {
+    border-bottom: 1px solid #BBB;
+}
+
 table, th, td {
     border: 1px solid #333;
 }
@@ -58,7 +52,11 @@ blockquote {
     border: 1px solid #222;
 }
 
-.img-frame {
+figure {
     background-color: rgba(255, 255, 255, 0.1);
     border: 1px solid #333;
 }
+
+figcaption {
+    color: #AAAAAA;
+}

incorporealcms/static/css/light.css

@@ -6,38 +6,28 @@ html {
 }
 
 body {
-    background: #F6F6F6;
-}
-
-strong {
-    color: #111;
-}
-
-.site-wrap {
-    background: white;
-
-    border: 1px solid #DDD;
-    border-top: none;
-    border-bottom: none;
+    background: #EEE;
 }
 
 h1, h2, h3, h4, h5, h6 {
     color: #811610;
 }
 
-a:link, a:visited {
-    color: #111;
-    border-bottom: 1px dotted #111;
+p a, ul a, ol a {
+    color: #222;
+    border-bottom: 1px solid #222;
 }
 
-a:hover, a:active {
+p a:hover, ul a:hover, ol a:hover {
     color: #811610;
-    border-bottom: 1px dotted #811610;
+    border-bottom: 1px solid #811610;
+}
+
+div.site-wrap {
+    background: white;
 }
 
 div.header {
-    background: #DDD;
-    border-bottom: 1px solid #DDD;
     color: #444;
 }
 
@@ -45,6 +35,10 @@ div.header a {
     color: #444;
 }
 
+div.header a:hover, div.header a:active {
+    border-bottom: 1px solid #444;
+}
+
 table, th, td {
     border: 1px solid #CCC;
 }
@@ -58,7 +52,11 @@ blockquote {
     border: 1px solid #DDD;
 }
 
-.img-frame {
+figure {
     background-color: rgba(0, 0, 0, 0.1);
     border: 1px solid #CCC;
 }
+
+figcaption {
+    color: #666666;
+}

requirements/requirements-dev.in

@@ -6,7 +6,7 @@ pytest
 pytest-cov
 
 # linting and other static code analysis
-bandit==1.6.2               # pinned because 1.7.0 wasn't running right in tox
+bandit
 dlint
 flake8
 flake8-blind-except

requirements/requirements-dev.txt

@@ -6,18 +6,18 @@
 #
 attrs==21.4.0
     # via pytest
-bandit==1.6.2
+bandit==1.7.4
     # via -r requirements/requirements-dev.in
-certifi==2021.10.8
+certifi==2022.5.18.1
     # via requests
 charset-normalizer==2.0.12
     # via requests
-click==8.0.4
+click==8.1.3
     # via
     #   flask
     #   pip-tools
     #   safety
-coverage[toml]==6.3.2
+coverage[toml]==6.4
     # via pytest-cov
 distlib==0.3.4
     # via virtualenv
@@ -25,7 +25,7 @@ dlint==0.12.0
     # via -r requirements/requirements-dev.in
 dparse==0.5.1
     # via safety
-filelock==3.6.0
+filelock==3.7.0
     # via
     #   tox
     #   virtualenv
@@ -54,7 +54,7 @@ flake8-logging-format==0.6.0
     # via -r requirements/requirements-dev.in
 flake8-mutable==1.2.0
     # via -r requirements/requirements-dev.in
-flask==2.0.3
+flask==2.1.2
     # via -r requirements/requirements.in
 gitdb==4.0.9
     # via gitpython
@@ -68,9 +68,9 @@ isort==5.10.1
     # via flake8-isort
 itsdangerous==2.1.2
     # via flask
-jinja2==3.1.0
+jinja2==3.1.2
     # via flask
-markdown==3.3.6
+markdown==3.3.7
     # via -r requirements/requirements.in
 markupsafe==2.1.1
     # via jinja2
@@ -82,13 +82,13 @@ packaging==21.3
     #   pytest
     #   safety
     #   tox
-pbr==5.8.1
+pbr==5.9.0
     # via stevedore
 pep517==0.12.0
     # via pip-tools
-pip-tools==6.5.1
+pip-tools==6.6.2
     # via -r requirements/requirements-dev.in
-platformdirs==2.5.1
+platformdirs==2.5.2
     # via virtualenv
 pluggy==1.0.0
     # via
@@ -106,11 +106,11 @@ pydot==1.4.2
     # via -r requirements/requirements-dev.in
 pyflakes==2.4.0
     # via flake8
-pyparsing==3.0.7
+pyparsing==3.0.9
     # via
     #   packaging
     #   pydot
-pytest==7.1.1
+pytest==7.1.2
     # via
     #   -r requirements/requirements-dev.in
     #   pytest-cov
@@ -126,7 +126,6 @@ safety==1.10.3
     # via -r requirements/requirements-dev.in
 six==1.16.0
     # via
-    #   bandit
     #   tox
     #   virtualenv
 smmap==5.0.0
@@ -146,7 +145,7 @@ tomli==2.0.1
     #   coverage
     #   pep517
     #   pytest
-tox==3.24.5
+tox==3.25.0
     # via
     #   -r requirements/requirements-dev.in
     #   tox-wheel
@@ -156,9 +155,9 @@ urllib3==1.26.9
     # via requests
 versioneer==0.22
     # via -r requirements/requirements-dev.in
-virtualenv==20.13.4
+virtualenv==20.14.1
     # via tox
-werkzeug==2.0.3
+werkzeug==2.1.2
     # via flask
 wheel==0.37.1
     # via

requirements/requirements.txt

@@ -4,17 +4,17 @@
 #
 #    pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
 #
-click==8.0.4
+click==8.1.3
     # via flask
-flask==2.0.3
+flask==2.1.2
     # via -r requirements/requirements.in
 itsdangerous==2.1.2
     # via flask
-jinja2==3.1.0
+jinja2==3.1.2
     # via flask
-markdown==3.3.6
+markdown==3.3.7
     # via -r requirements/requirements.in
 markupsafe==2.1.1
     # via jinja2
-werkzeug==2.0.3
+werkzeug==2.1.2
     # via flask

tests/functional_markdown_tests.py

@@ -29,6 +29,17 @@ def test_graphviz_is_rendered():
     assert b'data:image/png;base64' in response.data
 
 
+def test_two_graphviz_are_rendered():
+    """Test two images are rendered."""
+    app = app_with_pydot()
+    client = app.test_client()
+
+    response = client.get('/test-two-graphviz')
+    assert response.status_code == 200
+    assert b'~~~pydot' not in response.data
+    assert b'data:image/png;base64' in response.data
+
+
 def test_invalid_graphviz_is_not_rendered():
     """Check that invalid graphviz doesn't blow things up."""
     app = app_with_pydot()
@@ -37,3 +48,16 @@ def test_invalid_graphviz_is_not_rendered():
     response = client.get('/test-invalid-graphviz')
     assert response.status_code == 500
     assert b'INTERNAL SERVER ERROR' in response.data
+
+
+def test_figures_are_rendered(client):
+    """Test that a page with my figure syntax renders as expected."""
+    response = client.get('/figures')
+    assert response.status_code == 200
+    assert (b'<figure class="right"><img alt="fancy captioned logo" src="bss-square-no-bg.png" />'
+            b'<figcaption>this is my cool logo!</figcaption></figure>') in response.data
+    assert (b'<figure><img alt="vanilla captioned logo" src="bss-square-no-bg.png" />'
+            b'<figcaption>this is my cool logo without an attr!</figcaption>\n</figure>') in response.data
+    assert (b'<figure class="left"><img alt="fancy logo" src="bss-square-no-bg.png" />'
+            b'<span></span></figure>') in response.data
+    assert b'<figure><img alt="just a logo" src="bss-square-no-bg.png" /></figure>' in response.data

tests/functional_tests.py

@@ -7,7 +7,7 @@ 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
+    assert b'<h1 id="test-index">test index</h1>' in response.data
 
 
 def test_direct_file_that_exists(client):
@@ -134,32 +134,32 @@ def test_that_page_request_redirects_to_directory(client):
     """
     response = client.get('/subdir')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/subdir/'
+    assert response.location == '/subdir/'
 
 
 def test_that_request_to_symlink_redirects_markdown(client):
     """Test that a request to /foo redirects to /what-foo-points-at."""
     response = client.get('/symlink-to-no-title')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/no-title'
+    assert response.location == '/no-title'
 
 
 def test_that_request_to_symlink_redirects_file(client):
     """Test that a request to /foo.txt redirects to /what-foo-points-at.txt."""
     response = client.get('/symlink-to-foo.txt')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/foo.txt'
+    assert response.location == '/foo.txt'
 
 
 def test_that_request_to_symlink_redirects_directory(client):
     """Test that a request to /foo/ redirects to /what-foo-points-at/."""
     response = client.get('/symlink-to-subdir/')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/subdir'
+    assert response.location == '/subdir'
     # sadly, this location also redirects
     response = client.get('/subdir')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/subdir/'
+    assert response.location == '/subdir/'
     # but we do get there
     response = client.get('/subdir/')
     assert response.status_code == 200
@@ -169,7 +169,7 @@ def test_that_request_to_symlink_redirects_subdirectory(client):
     """Test that a request to /foo/bar redirects to /what-foo-points-at/bar."""
     response = client.get('/symlink-to-subdir/page-no-title')
     assert response.status_code == 301
-    assert response.location == 'http://localhost/subdir/page-no-title'
+    assert response.location == '/subdir/page-no-title'
     response = client.get('/subdir/page-no-title')
     assert response.status_code == 200
 

tests/instance/config.py

@@ -15,6 +15,10 @@ LOGGING = {
         },
     },
     'loggers': {
+        'incorporealcms.mdx': {
+            'level': 'DEBUG',
+            'handlers': ['console'],
+        },
         'incorporealcms.pages': {
             'level': 'DEBUG',
             'handlers': ['console'],

tests/instance/pages/figures.md

@@ -0,0 +1,13 @@
+# test of figures
+
+|> ![fancy captioned logo](bss-square-no-bg.png)
+|: this is my cool logo!
+{: .right }
+
+|> ![vanilla captioned logo](bss-square-no-bg.png)
+|: this is my cool logo without an attr!
+
+|> ![fancy logo](bss-square-no-bg.png)
+{: .left }
+
+|> ![just a logo](bss-square-no-bg.png)

tests/instance/pages/test-graphviz.md

@@ -1,7 +1,7 @@
 # test
 
 test
-~~~pydot:attack-plan
+~~~{ pydot:attack-plan }
 digraph G {
     rankdir=LR
     Earth

tests/instance/pages/test-invalid-graphviz.md

@@ -1,7 +1,7 @@
 # test
 
 test
-~~~pydot:attack-plan
+~~~{ pydot:attack-plan }
     rankdir=LR
     Earth
     Mars

tests/instance/pages/test-two-graphviz.md

@@ -0,0 +1,25 @@
+# test
+
+test
+
+~~~{ pydot:attack-plan }
+digraph G {
+    rankdir=LR
+    Earth
+    Mars
+    Earth -> Mars
+}
+~~~
+
+more test
+
+~~~{ pydot:new-attack-plan }
+digraph H {
+    rankdir=LR
+    Venus
+    Mars
+    Venus -> Mars
+}
+~~~
+
+done