Add simple plugin test case

Author: rnorth

src/__init__.py codeinclude/__init__.pysrc/__init__.py renamed to codeinclude/__init__.py

@@ -0,0 +1,71 @@
+import re
+import os
+import shlex
+import textwrap
+
+from mkdocs.plugins import BasePlugin
+from codeinclude.resolver import select
+
+RE_SNIPPET = r"""(?x)
+    ^
+    (?P<leading_space>\s*)
+    (?P<marker><!--codeinclude-->)
+    (?P<ignored_space>\s*)
+    \[(?P<title>[^\]]*)\]\((?P<filename>[^)]+)\)
+    ([\t ]+(?P<params>.*))?
+    $
+"""
+
+
+def get_substitute(page, title, filename, lines, block, inside_block):
+
+    page_parent_dir = os.path.dirname(page.file.abs_src_path)
+    import_path = os.path.join(page_parent_dir, filename)
+    with open(import_path) as f:
+        content = f.read()
+
+    selected_content = select(
+        content, lines=lines, block=block, inside_block=inside_block
+    )
+
+    dedented = textwrap.dedent(selected_content)
+
+    return '\n```java tab="' + title + '"\n' + dedented + "\n```\n\n"
+
+
+class CodeIncludePlugin(BasePlugin):
+    def on_page_markdown(self, markdown, page, config, site_navigation=None, **kwargs):
+        "Provide a hook for defining functions from an external module"
+
+        results = ""
+        for line in markdown.splitlines():
+
+            # handle each line
+            snippet_match = re.match(RE_SNIPPET, line)
+            if snippet_match:
+                title = snippet_match.group("title")
+                filename = snippet_match.group("filename")
+                indent = snippet_match.group("leading_space")
+                raw_params = snippet_match.group("params")
+
+                if raw_params:
+                    params = dict(token.split(":") for token in shlex.split(raw_params))
+                    lines = params.get("lines", "")
+                    block = params.get("block", "")
+                    inside_block = params.get("inside_block", "")
+                else:
+                    lines = ""
+                    block = ""
+                    inside_block = ""
+
+                code_block = get_substitute(
+                    page, title, filename, lines, block, inside_block
+                )
+
+                # re-indent
+                code_block = re.sub("^", indent, code_block, flags=re.MULTILINE)
+                results += code_block
+            else:
+                results += line + "\n"
+
+        return results

codeinclude/plugin.py

@@ -83,4 +83,7 @@ def select(
         result += source_lines[i - 1] + "\n"
         last_selected = i
 
+    if result == "":
+        return text
+
     return result

src/codeinclude/resolver.py codeinclude/resolver.pysrc/codeinclude/resolver.py renamed to codeinclude/resolver.py

@@ -0,0 +1,44 @@
+import os
+import textwrap
+import unittest
+
+from mkdocs.config import Config, DEFAULT_SCHEMA
+from mkdocs.structure.files import File
+from mkdocs.structure.pages import Page
+
+from codeinclude.plugin import CodeIncludePlugin
+
+MARKDOWN_EXAMPLE = """
+# hello world
+
+some text before
+<!--codeinclude--> [foo](Foo.java)
+and some text after
+
+"""
+
+c = Config(schema=DEFAULT_SCHEMA)
+c["site_url"] = "http://example.org/"
+
+PAGE_EXAMPLE = Page("", File(os.path.abspath("./fixture/text.md"), "/src", "/dest", False), c)
+
+class PluginTextCase(unittest.TestCase):
+
+    def test_simple_case(self):
+        plugin = CodeIncludePlugin()
+        result = plugin.on_page_markdown(MARKDOWN_EXAMPLE, PAGE_EXAMPLE, dict())
+
+        print(result)
+        self.assertEqual(result.strip(), textwrap.dedent("""
+                                  # hello world
+                                  
+                                  some text before
+                                  
+                                  ```java tab=\"foo\"
+                                  public class Foo {
+                                  
+                                  }
+                                  ```
+                                  
+                                  and some text after
+                                  """).strip())

src/codeinclude/plugin.py

@@ -1,5 +1,3 @@
-import unittest
-
 from codeinclude.resolver import select
 
 CODE_BLOCK_EXAMPLE = """

tests/codeinclude/test_plugin.py

@@ -0,0 +1,3 @@
+public class Foo {
+
+}