clld-markdown-plugin 0.2.0__tar.gz → 0.3.0__tar.gz

{clld_markdown_plugin-0.2.0 → clld_markdown_plugin-0.3.0}/PKG-INFO

@@ -1,21 +1,21 @@
 Metadata-Version: 2.1
 Name: clld_markdown_plugin
-Version: 0.2.0
+Version: 0.3.0
 Summary: Render CLDF markdown in clld apps.
 Home-page: https://github.com/clld/clld-markdown-plugin
 Author: Robert Forkel, Florian Matter
-Author-email: forkel@shh.mpg.de, florianmatter@gmail.com
+Author-email: robert_forkel@eva.mpg.de, florianmatter@gmail.com
 Project-URL: Bug Tracker, https://github.com/clld/clld-markdown-plugin/issues
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 Provides-Extra: dev
 Provides-Extra: test

{clld_markdown_plugin-0.2.0 → clld_markdown_plugin-0.3.0}/setup.cfg

@@ -1,17 +1,17 @@
 [metadata]
 author = Robert Forkel, Florian Matter
-author_email = forkel@shh.mpg.de, florianmatter@gmail.com
+author_email = robert_forkel@eva.mpg.de, florianmatter@gmail.com
 classifiers = 
 	Development Status :: 2 - Pre-Alpha
 	Intended Audience :: Science/Research
 	License :: OSI Approved :: Apache Software License
 	Natural Language :: English
 	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.7
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 description = Render CLDF markdown in clld apps.
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -19,7 +19,7 @@ name = clld_markdown_plugin
 project_urls = 
 	Bug Tracker = https://github.com/clld/clld-markdown-plugin/issues
 url = https://github.com/clld/clld-markdown-plugin
-version = 0.2.0
+version = 0.3.0
 
 [options]
 zip_safe = False
@@ -66,7 +66,7 @@ source =
 show_missing = true
 
 [tox:tox]
-envlist = py37, py38, py39, py310, py311
+envlist = py38, py39, py310, py311, py312
 isolated_build = true
 skip_missing_interpreter = true
 

{clld_markdown_plugin-0.2.0 → clld_markdown_plugin-0.3.0}/src/clld_markdown_plugin/__init__.py

@@ -7,12 +7,13 @@ from pycldf.ext.markdown import CLDFMarkdownLink
 from clld.db.meta import DBSession
 from clld.db.models import common
 from clld.web.util.helpers import rendered_sentence
+from clld.web.util.htmllib import HTML, literal
 
 log = logging.getLogger(__name__)
 
 __author__ = "Robert Forkel, Florian Matter"
 __email__ = "robert_forkel@eva.mpg.de, florianmatter@gmail.com"
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __all__ = ['markdown', 'includeme']
 
 
@@ -82,18 +83,21 @@ def link_entity(req, objid, route, model, session, decorate=None, ids=None, **kw
     if objid == "__all__":
         if ids:
             md_strs = [
-                link_entity(req, mid, route, model, session, decorate=decorate)
+                link_entity(req, mid, route, model, session, decorate=decorate, **kwargs)
                 for mid in ids[0].split(",")
             ]
             return comma_and_list(md_strs)
         raise NotImplementedError("Table not yet implemented")  # pragma: no cover
     else:
-        entity = session.query(model).filter(model.id == objid)[0]
-        anchor = kwargs.pop("_anchor", None)
-        if isinstance(anchor, list):
-            anchor = anchor[0]
+        try:
+            entity = session.query(model).filter(model.id == objid)[0]
+        except IndexError:
+            raise ValueError(objid)  # pragma: no cover
+        label = kwargs.pop("label", [None])[0]
+        anchor = kwargs.pop("_anchor", [None])[0]
         url = req.route_url(route, id=objid, _anchor=anchor, **kwargs)
-        md_str = f"""<a class="{model.__tablename__.capitalize()}" href="{url}">{entity.name}</a>"""
+        md_str = '<a class="{}" href="{}">{}</a>'.format(
+            model.__tablename__.capitalize(), url, label or entity.name)
         return decorate(md_str) if decorate else md_str
 
 
@@ -120,6 +124,7 @@ def markdown(req, s: str, session=None) -> str:
             '{} must be included in the app config to use the "markdown" function.'.format(
                 __name__))
     settings = req.registry.settings[__name__]
+    source_ids = set()
 
     def repl(ml):
         if ml.is_cldf_link:
@@ -130,6 +135,17 @@ def markdown(req, s: str, session=None) -> str:
                         req, ml.objid, table, session or DBSession, **ml.parsed_url_query)
                 elif table in settings['model_map']:
                     decorate = settings['model_map'][table].get("decorate", None)
+                    kw = {k: v for k, v in ml.parsed_url_query.items()}
+                    if table == 'Source':
+                        if ml.objid != '__all__':
+                            source_ids.add(ml.objid)
+                        elif 'cited_only' in ml.parsed_url.query:
+                            model = settings['model_map'][table]["model"]
+                            return HTML.ul(*[
+                                HTML.li(literal(
+                                    (session or DBSession).query(model)
+                                    .filter(model.id == sid)[0].bibtex().text()))
+                                for sid in sorted(source_ids)])
                     return link_entity(
                         req,
                         ml.objid,
@@ -137,7 +153,7 @@ def markdown(req, s: str, session=None) -> str:
                         settings['model_map'][table]["model"],
                         session or DBSession,
                         decorate=decorate,
-                        **ml.parsed_url_query,
+                        **kw,
                     )
                 log.error(f"Can't handle [{ml.objid}] ({table}).")
                 return f"{table}:{ml.objid}"

{clld_markdown_plugin-0.2.0 → clld_markdown_plugin-0.3.0}/src/clld_markdown_plugin.egg-info/PKG-INFO

@@ -1,21 +1,21 @@
 Metadata-Version: 2.1
 Name: clld-markdown-plugin
-Version: 0.2.0
+Version: 0.3.0
 Summary: Render CLDF markdown in clld apps.
 Home-page: https://github.com/clld/clld-markdown-plugin
 Author: Robert Forkel, Florian Matter
-Author-email: forkel@shh.mpg.de, florianmatter@gmail.com
+Author-email: robert_forkel@eva.mpg.de, florianmatter@gmail.com
 Project-URL: Bug Tracker, https://github.com/clld/clld-markdown-plugin/issues
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 Provides-Extra: dev
 Provides-Extra: test

clld_markdown_plugin-0.3.0/tests/test_unit.py

@@ -0,0 +1,31 @@
+import pytest
+
+from clld_markdown_plugin import *
+
+
+@pytest.mark.parametrize(
+    'model_map,renderer_map,md,substring,notsubstring',
+    [
+        (dict(LanguageTable=None), {}, '[xyz](LanguageTable#cldf:l1)', 'xyz', None),
+        ({}, {}, '[xyz](LanguageTable#cldf:l1)', 'The Language', None),
+        ({}, {}, '[xyz](LanguageTable?_anchor=abc#cldf:l1)', '#abc', None),
+        ({}, {}, '[xyz](LanguageTable?ids=l1,l2,l3#cldf:__all__)', ' and ', None),
+        ({}, {}, '[xyz](ExampleTable#cldf:s1)', 'A sentence', None),
+        ({}, {}, '[xyz](ExampleTable?as_link#cldf:s1)', 'href=', None),
+        ({}, {}, '[xyz](ExampleTable?ids=s1#cldf:__all__)', '', None),
+        ({}, {}, '[xyz](NopeTable#cldf:1)', 'NopeTable', None),
+        (
+            {},
+            {},
+            '[](Source#cldf:Meier2012)\n[](Source?cited_only#cldf:__all__)',
+            'Meier',
+            'Mueller'),
+        ({}, {}, '[xyz](http://example.org)', 'http://example.org', None),
+    ]
+)
+def test_markdown(model_map, renderer_map, md, substring, notsubstring, dbsession, req_factory):
+    res = markdown(
+        req_factory(dict(model_map=model_map, renderer_map=renderer_map)), md, session=dbsession)
+    assert substring in res
+    if notsubstring:
+        assert notsubstring not in res

clld_markdown_plugin-0.2.0/tests/test_unit.py

@@ -1,22 +0,0 @@
-import pytest
-
-from clld_markdown_plugin import *
-
-
-@pytest.mark.parametrize(
-    'model_map,renderer_map,md,substring',
-    [
-        (dict(LanguageTable=None), {}, '[xyz](LanguageTable#cldf:l1)', 'xyz'),
-        ({}, {}, '[xyz](LanguageTable#cldf:l1)', 'The Language'),
-        ({}, {}, '[xyz](LanguageTable?_anchor=abc#cldf:l1)', '#abc'),
-        ({}, {}, '[xyz](LanguageTable?ids=l1,l2,l3#cldf:__all__)', ' and '),
-        ({}, {}, '[xyz](ExampleTable#cldf:s1)', 'A sentence'),
-        ({}, {}, '[xyz](ExampleTable?as_link#cldf:s1)', 'href='),
-        ({}, {}, '[xyz](ExampleTable?ids=s1#cldf:__all__)', ''),
-        ({}, {}, '[xyz](NopeTable#cldf:1)', 'NopeTable'),
-        ({}, {}, '[xyz](http://example.org)', 'http://example.org'),
-    ]
-)
-def test_markdown(model_map, renderer_map, md, substring, dbsession, req_factory):
-    assert substring in markdown(
-        req_factory(dict(model_map=model_map, renderer_map=renderer_map)), md, session=dbsession)