template the output files

Author: davidhyman

.gitignore

@@ -101,7 +101,7 @@ ENV/
 .mypy_cache/
 
 # pytest
-*.pytest
+*.pytest*
 
 # editors
 *.idea

src/snippet/config.py

@@ -9,10 +9,12 @@ class Config:
     # IO
     project_root = '.'  # the project root used for relative IO paths (set by commandline)
     input_glob = 'tests/example/*.py'
-    output_template = '```python\n# example: {{{name}}}\n{{{code}}}\n```\n'  # a mustache template for each file
-    output_append = False  # if the output file exists, append to it
+    output_append = True  # if the output file exists, append to it
     output_dir = '.'
-    output_file_ext = 'md'
+    output_file_name_template = '{{name}}.md'  # a mustache template for the output file name
+
+    # Language and style
+    output_template = '```python\n# example: {{{name}}}\n{{{code}}}\n```\n'  # a mustache template for each file
 
     # Logging
     log_level = logging.INFO

src/snippet/file_wrangler.py

@@ -7,18 +7,23 @@
 from snippet.config import Config
 
 
-def write_example(config: Config, path, example_name, example_block):
+def write_example(config: Config, example_name, example_block):
     """Writes example to file"""
     output = pystache.render(
         config.output_template,
         name=example_name,
         code=example_block
     )
+
+    output_file_name = pystache.render(
+        config.output_file_name_template,
+        name=example_name.strip().replace(' ', '')
+    )
+
     if not os.path.exists(config.output_dir):
+        logging.info('creating output directory %s', config.output_dir)
         os.makedirs(config.output_dir)
-    # TODO: this, properly...
-    clean_name = example_name.strip().replace(' ', '')
-    output_file = os.path.join(config.output_dir, clean_name) + os.extsep + config.output_file_ext
+    output_file = os.path.join(config.output_dir, output_file_name)
     logging.info('writing %r to %s', example_name, output_file)
     with open(output_file, 'a' if config.output_append else 'w') as fh:
         fh.write(output)

src/snippet/workflow.py

@@ -43,7 +43,7 @@ def run(config: Config):
         logging.debug('example code: %s', example_block)
 
         wrap(config, failures, path, partial(
-            file_wrangler.write_example, config, path, example_name, example_block
+            file_wrangler.write_example, config, example_name, example_block
         ))
 
     return examples, paths, failures

tests/__init__.py

@@ -1,4 +1,4 @@
 import os
 tmp_test_dirname = 'tmp_test_dir'
-tmp_test_dir = os.path.join(os.path.dirname(__file__), tmp_test_dirname)
-sample_input_dir = os.path.join(os.path.dirname(__file__), 'samples')
+tmp_test_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), tmp_test_dirname))
+sample_input_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'samples'))

tests/test_direct.py

@@ -21,12 +21,12 @@ def test_run(self):
         config.output_append = True
 
         # only detect the python file
-        config.input_glob = 'tests/samples/example.py'
+        config.input_glob = os.path.join(sample_input_dir, 'example.py')
         snippet.main(config=config)
 
         # only detect the java file
         config.output_template = '```java\n# example: {{{name}}}\n{{{code}}}\n```'
-        config.input_glob = 'tests/samples/example.java'
+        config.input_glob = os.path.join(sample_input_dir, 'example.java')
         snippet.main(config=config)
 
         self.assertTrue(filecmp.cmp(