bumped version

Fix autoreload

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/python-package.yaml

@@ -19,6 +19,7 @@ jobs:
         python-version:
           - 3.8
           - 3.9
+          - "3.10"
 
     steps:
     - uses: actions/checkout@v2

CHANGELOG.md

@@ -1,6 +1,35 @@
 # Changelog
 
-## [0.0.0] - YYYY-MM-DD
+## [1.2.0] - 2021-11-06
 
-*
+* `make serve` now rebuilds immediately once after called to avoid serving
+  stale files
+* updated dependencies:
+  * feedgenerator 2.0.0
+  * jinja2 3.0.1
+  * pytest-cov 3.0.0
+  * flake8 4.0.1
+  * twine 3.5.0
 
+## [1.1.0] - 2021-10-06
+
+* added Python 3.10 to list of supported versions to test against
+* added dependabot to github workflows
+* updated various dependencies:
+  * pygments 2.10.0
+  * sphinx 4.2.0
+  * twine 3.4.2
+  * wheel 0.37.0
+  * pytest 6.2.5
+
+## [1.0.0] - 2021-08-18
+
+* first 1.0 release!
+* bump requirements of feedgenerator to 1.9.2. this version uses the
+  description to provide a subtitle for the feed
+
+## [0.0.9] - 2021-06-22
+
+* updated to jinja 3.0
+* updated to sphinx 4.0
+* added link to changelog

blag/blag.py

@@ -289,7 +289,7 @@ def process_markdown(convertibles, input_dir, output_dir,
             articles.append((dst, context))
             result = article_template.render(context)
         else:
-            pages.append((dst, content))
+            pages.append((dst, context))
             result = page_template.render(context)
         with open(f'{output_dir}/{dst}', 'w') as fh_dest:
             fh_dest.write(result)
@@ -392,7 +392,7 @@ def generate_tags(articles, tags_template, tag_template, output_dir):
     # get tags number of occurrences
     all_tags = {}
     for _, context in articles:
-        tags = context.get('tags', None)
+        tags = context.get('tags', [])
         for tag in tags:
             all_tags[tag] = all_tags.get(tag, 0) + 1
     # sort by occurrence
@@ -405,7 +405,7 @@ def generate_tags(articles, tags_template, tag_template, output_dir):
     # get tags and archive per tag
     all_tags = {}
     for dst, context in articles:
-        tags = context.get('tags', None)
+        tags = context.get('tags', [])
         for tag in tags:
             archive = all_tags.get(tag, [])
             entry = context.copy()

blag/devserver.py

@@ -55,6 +55,9 @@ def autoreload(args):
     last modified time). If the last modified time has changed, a
     rebuild is triggered.
 
+    A rebuild is also performed immediately when this method is called
+    to avoid serving stale contents.
+
     Parameters
     ----------
     args : argparse.Namespace
@@ -62,12 +65,14 @@ def autoreload(args):
     """
     dirs = [args.input_dir, args.template_dir, args.static_dir]
     logger.info(f'Monitoring {dirs} for changes...')
-    last_mtime = get_last_modified(dirs)
+    # make sure we trigger the rebuild immediately when we enter the
+    # loop to avoid serving stale contents
+    last_mtime = 0
     while True:
         mtime = get_last_modified(dirs)
         if mtime > last_mtime:
             last_mtime = mtime
-            logger.debug('Change detected, rebuilding...')
+            logger.info('Change detected, rebuilding...')
             blag.build(args)
         time.sleep(1)
 
@@ -84,4 +89,5 @@ def serve(args):
                        directory=args.output_dir))
     proc = multiprocessing.Process(target=autoreload, args=(args,))
     proc.start()
+    logger.info("\n\n  Devserver Started -- visit http://localhost:8000\n")
     httpd.serve_forever()

blag/markdown.py

@@ -30,7 +30,7 @@ def markdown_factory():
     """
     md = Markdown(
         extensions=[
-            'meta', 'fenced_code', 'codehilite',
+            'meta', 'fenced_code', 'codehilite', 'smarty',
             MarkdownLinkExtension()
         ],
         output_format='html5',

blag/version.py

@@ -1 +1 @@
-__VERSION__ = '0.0.6'
+__VERSION__ = '1.2.0'

requirements-dev.txt

@@ -1,6 +1,6 @@
-sphinx==3.5.3
+sphinx==4.2.0
-twine==3.4.1
+twine==3.5.0
-wheel==0.36.2
+wheel==0.37.0
-pytest==6.2.2
+pytest==6.2.5
-pytest-cov==2.11.1
+pytest-cov==3.0.0
-flake8==3.9.0
+flake8==4.0.1

requirements.txt

@@ -1,4 +1,4 @@
 markdown==3.3.4
-feedgenerator==1.9.1
+feedgenerator==2.0.0
-jinja2==2.11.3
+jinja2==3.0.2
-pygments==2.8.1
+pygments==2.10.0

setup.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
 
-
 from setuptools import setup
 
 meta = {}
@@ -20,6 +19,8 @@ setup(
     project_urls={
         'Documentation': 'https://blag.readthedocs.io/',
         'Source': 'https://github.com/venthur/blag',
+        'Changelog':
+            'https://github.com/venthur/blag/blob/master/CHANGELOG.md',
     },
     python_requires='>=3.8',
     package_data={

tests/conftest.py

@@ -0,0 +1,86 @@
+from tempfile import TemporaryDirectory
+import os
+
+import pytest
+
+from blag import blag
+
+
+@pytest.fixture
+def environment():
+    site = {
+        'base_url': 'site base_url',
+        'title': 'site title',
+        'description': 'site description',
+        'author': 'site author',
+    }
+    env = blag.environment_factory(globals_=dict(site=site))
+    yield env
+
+
+@pytest.fixture
+def page_template(environment):
+    yield environment.get_template('page.html')
+
+
+@pytest.fixture
+def article_template(environment):
+    yield environment.get_template('article.html')
+
+
+@pytest.fixture
+def archive_template(environment):
+    yield environment.get_template('archive.html')
+
+
+@pytest.fixture
+def tags_template(environment):
+    yield environment.get_template('tags.html')
+
+
+@pytest.fixture
+def tag_template(environment):
+    yield environment.get_template('tag.html')
+
+
+@pytest.fixture
+def cleandir():
+    """Create a temporary workind directory and cwd.
+
+    """
+    config = """
+[main]
+base_url = https://example.com/
+title = title
+description = description
+author = a. u. thor
+    """
+
+    with TemporaryDirectory() as dir:
+        for d in 'content', 'build', 'static', 'templates':
+            os.mkdir(f'{dir}/{d}')
+        with open(f'{dir}/config.ini', 'w') as fh:
+            fh.write(config)
+        # change directory
+        old_cwd = os.getcwd()
+        os.chdir(dir)
+        yield dir
+        # and change back afterwards
+        os.chdir(old_cwd)
+
+
+@pytest.fixture
+def args(cleandir):
+
+    class NameSpace:
+        def __init__(self, **kwargs):
+            for name in kwargs:
+                setattr(self, name, kwargs[name])
+
+    args = NameSpace(
+            input_dir='content',
+            output_dir='build',
+            static_dir='static',
+            template_dir='templates',
+    )
+    yield args

tests/test_blag.py

@@ -7,19 +7,13 @@ import pytest
 from blag import blag
 
 
-@pytest.fixture
+def test_generate_feed(cleandir):
-def outdir():
-    with TemporaryDirectory() as dir:
-        yield dir
-
-
-def test_generate_feed(outdir):
     articles = []
-    blag.generate_feed(articles, outdir, ' ', ' ', ' ', ' ')
+    blag.generate_feed(articles, 'build', ' ', ' ', ' ', ' ')
-    assert os.path.exists(f'{outdir}/atom.xml')
+    assert os.path.exists('build/atom.xml')
 
 
-def test_feed(outdir):
+def test_feed(cleandir):
     articles = [
         [
             'dest1.html',
@@ -40,9 +34,9 @@ def test_feed(outdir):
 
     ]
 
-    blag.generate_feed(articles, outdir, 'https://example.com/', 'blog title',
+    blag.generate_feed(articles, 'build', 'https://example.com/',
-                       'blog description', 'blog author')
+                       'blog title', 'blog description', 'blog author')
-    with open(f'{outdir}/atom.xml') as fh:
+    with open('build/atom.xml') as fh:
         feed = fh.read()
 
     assert '<title>blog title</title>' in feed
@@ -66,7 +60,7 @@ def test_feed(outdir):
     assert '<link href="https://example.com/dest2.html"' in feed
 
 
-def test_generate_feed_with_description(outdir):
+def test_generate_feed_with_description(cleandir):
     # if a description is provided, it will be used as the summary in
     # the feed, otherwise we simply use the title of the article
     articles = [[
@@ -78,9 +72,9 @@ def test_generate_feed_with_description(outdir):
             'content': 'content',
         }
     ]]
-    blag.generate_feed(articles, outdir, ' ', ' ', ' ', ' ')
+    blag.generate_feed(articles, 'build', ' ', ' ', ' ', ' ')
 
-    with open(f'{outdir}/atom.xml') as fh:
+    with open('build/atom.xml') as fh:
         feed = fh.read()
 
     assert '<title>title</title>' in feed
@@ -180,3 +174,106 @@ def test_environment_factory():
     env = blag.environment_factory(globals_=globals_)
     assert env.globals['foo'] == 'bar'
     assert env.globals['test'] == 'me'
+
+
+def test_process_markdown(cleandir, page_template, article_template):
+    page1 = """\
+title: some page
+
+some text
+foo bar
+    """
+
+    article1 = """\
+title: some article1
+date: 2020-01-01
+
+some text
+foo bar
+    """
+
+    article2 = """\
+title: some article2
+date: 2021-01-01
+
+some text
+foo bar
+    """
+
+    convertibles = []
+    for i, txt in enumerate((page1, article1, article2)):
+        i = str(i)
+        with open(f'content/{i}', 'w') as fh:
+            fh.write(txt)
+        convertibles.append([i, i])
+
+    articles, pages = blag.process_markdown(
+            convertibles,
+            'content',
+            'build',
+            page_template,
+            article_template
+    )
+
+    assert isinstance(articles, list)
+    assert len(articles) == 2
+    for dst, context in articles:
+        assert isinstance(dst, str)
+        assert isinstance(context, dict)
+        assert 'content' in context
+
+    assert isinstance(pages, list)
+    assert len(pages) == 1
+    for dst, context in pages:
+        assert isinstance(dst, str)
+        assert isinstance(context, dict)
+        assert 'content' in context
+
+
+def test_build(args):
+    page1 = """\
+title: some page
+
+some text
+foo bar
+    """
+
+    article1 = """\
+title: some article1
+date: 2020-01-01
+tags: foo, bar
+
+some text
+foo bar
+    """
+
+    article2 = """\
+title: some article2
+date: 2021-01-01
+tags: baz
+
+some text
+foo bar
+    """
+
+    # write some convertibles
+    convertibles = []
+    for i, txt in enumerate((page1, article1, article2)):
+        i = str(i)
+        with open(f'{args.input_dir}/{i}.md', 'w') as fh:
+            fh.write(txt)
+        convertibles.append([i, i])
+
+    # some static files
+    with open(f'{args.static_dir}/test', 'w') as fh:
+        fh.write('hello')
+
+    os.mkdir(f'{args.input_dir}/testdir')
+    with open(f'{args.input_dir}/testdir/test', 'w') as fh:
+        fh.write('hello')
+
+    blag.build(args)
+
+
+def test_main(cleandir):
+    blag.main(['build'])

tests/test_devserver.py

@@ -1,30 +1,66 @@
 import time
+import threading
 
 import pytest
 
-from tempfile import TemporaryDirectory
 from blag import devserver
 
 
-@pytest.fixture
+def test_get_last_modified(cleandir):
-def tempdir():
-    with TemporaryDirectory() as dir:
-        yield dir
-
-
-def test_get_last_modified(tempdir):
     # take initial time
-    t1 = devserver.get_last_modified([tempdir])
+    t1 = devserver.get_last_modified(['content'])
 
     # wait a bit, create a file and measure again
     time.sleep(0.1)
-    with open(f'{tempdir}/test', 'w') as fh:
+    with open('content/test', 'w') as fh:
         fh.write('boo')
-    t2 = devserver.get_last_modified([tempdir])
+    t2 = devserver.get_last_modified(['content'])
 
     # wait a bit and take time again
     time.sleep(0.1)
-    t3 = devserver.get_last_modified([tempdir])
+    t3 = devserver.get_last_modified(['content'])
 
     assert t2 > t1
     assert t2 == t3
+
+
+def test_autoreload_builds_immediately(args):
+    # create a dummy file that can be build
+    with open('content/test.md', 'w') as fh:
+        fh.write('boo')
+
+    t = threading.Thread(target=devserver.autoreload,
+                         args=(args, ),
+                         daemon=True,)
+    t0 = devserver.get_last_modified(['build'])
+    t.start()
+    # try for 5 seconds...
+    for i in range(5):
+        time.sleep(1)
+        t1 = devserver.get_last_modified(['build'])
+        print(t1)
+        if t1 > t0:
+            break
+    assert t1 > t0
+
+
+@pytest.mark.filterwarnings("ignore::pytest.PytestUnhandledThreadExceptionWarning")  # noqa
+def test_autoreload(args):
+    t = threading.Thread(target=devserver.autoreload,
+                         args=(args, ),
+                         daemon=True,)
+    t.start()
+
+    t0 = devserver.get_last_modified(['build'])
+
+    # create a dummy file that can be build
+    with open('content/test.md', 'w') as fh:
+        fh.write('boo')
+
+    # try for 5 seconds to see if we rebuild once...
+    for i in range(5):
+        time.sleep(1)
+        t1 = devserver.get_last_modified(['build'])
+        if t1 > t0:
+            break
+    assert t1 > t0

tests/test_markdown.py

@@ -49,3 +49,31 @@ def test_convert_metadata(input_, expected):
 def test_markdown_factory():
     md = markdown_factory()
     assert isinstance(md, markdown.Markdown)
+
+
+def test_smarty():
+    md = markdown_factory()
+
+    md1 = """
+
+this --- is -- a test ...
+
+    """
+    html, meta = convert_markdown(md, md1)
+    assert 'mdash' in html
+    assert 'ndash' in html
+    assert 'hellip' in html
+
+
+def test_smarty_code():
+    md = markdown_factory()
+
+    md1 = """
+```
+this --- is -- a test ...
+```
+    """
+    html, meta = convert_markdown(md, md1)
+    assert 'mdash' not in html
+    assert 'ndash' not in html
+    assert 'hellip' not in html

tests/test_templates.py

@@ -1,46 +1,5 @@
 import datetime
 
-import pytest
-
-from blag import blag
-
-
-@pytest.fixture
-def environment():
-    site = {
-        'base_url': 'site base_url',
-        'title': 'site title',
-        'description': 'site description',
-        'author': 'site author',
-    }
-    env = blag.environment_factory(globals_=dict(site=site))
-    yield env
-
-
-@pytest.fixture
-def page_template(environment):
-    yield environment.get_template('page.html')
-
-
-@pytest.fixture
-def article_template(environment):
-    yield environment.get_template('article.html')
-
-
-@pytest.fixture
-def archive_template(environment):
-    yield environment.get_template('archive.html')
-
-
-@pytest.fixture
-def tags_template(environment):
-    yield environment.get_template('tags.html')
-
-
-@pytest.fixture
-def tag_template(environment):
-    yield environment.get_template('tag.html')
-
 
 def test_page(page_template):
     ctx = {