default to std out for moban cli - a single rendering target (#391)

* ✨ print to stdout if it is a single render action. resolves #390

* ✨ error output to stderr. at cli, pipe output won't accidentally get the error message. user can use shell stderr direction to get error message

* 📚 update readme

* :greenheart: make ci pass by update unit tests

Author: chfw

.moban.cd/changelog.yml

@@ -1,6 +1,12 @@
 name: moban
 organisation: moremoban
 releases:
+  - changes:
+      - action: Updated
+        details:
+          - "`#390`: single render action will print to stdout by defafult"
+    date: 06.08.2020
+    version: 0.7.9
   - changes:
       - action: Added
         details:

.moban.cd/moban.yml

@@ -4,9 +4,9 @@ organisation: moremoban
 author: C. W.
 contact: [email protected]
 license: MIT
-version: 0.7.8
-current_version: 0.7.8
-release: 0.7.8
+version: 0.7.9
+current_version: 0.7.9
+release: 0.7.9
 branch: master
 master: index
 command_line_interface: "moban"

.moban.d/moban_readme.jj2

@@ -44,16 +44,11 @@ versions lower than 0.7.0 if you are still using python 2.
 Quick start
 ================================================================================
 
-.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-intro.gif
-
 {% raw %}
 .. code-block:: bash
 
     $ export HELLO="world"
     $ moban "{{HELLO}}"
-    Templating {{HELLO}}... to moban.output
-    Templated 1 file.
-    $ cat moban.output
     world
 
 Or
@@ -76,7 +71,6 @@ A bit formal example:
 .. code-block:: bash
 
 	$ moban -c data.yml -t my.template
-	$ cat moban.output
 
 Given data.yml as:
 

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Change log
 ================================================================================
 
+0.7.9 - 06.08.2020
+--------------------------------------------------------------------------------
+
+**Updated**
+
+#. `#390 <https://github.com/moremoban/moban/issues/390>`_: single render action
+   will print to stdout by defafult
+
 0.7.8 - 09.06.2020
 --------------------------------------------------------------------------------
 

README.rst

@@ -44,16 +44,11 @@ versions lower than 0.7.0 if you are still using python 2.
 Quick start
 ================================================================================
 
-.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-intro.gif
-
 
 .. code-block:: bash
 
     $ export HELLO="world"
     $ moban "{{HELLO}}"
-    Templating {{HELLO}}... to moban.output
-    Templated 1 file.
-    $ cat moban.output
     world
 
 Or
@@ -75,7 +70,6 @@ A bit formal example:
 .. code-block:: bash
 
 	$ moban -c data.yml -t my.template
-	$ cat moban.output
 
 Given data.yml as:
 

docs/conf.py

@@ -25,9 +25,9 @@
 copyright = '2017-2020 Onni Software Ltd.'
 author = 'C. W.'
 # The short X.Y version
-version = '0.7.8'
+version = '0.7.9'
 # The full version, including alpha/beta/rc tags
-release = '0.7.8'
+release = '0.7.9'
 
 # -- General configuration ---------------------------------------------------
 

moban/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.7.8"
+__version__ = "0.7.9"
 __author__ = "C. W."

moban/constants.py

@@ -56,7 +56,7 @@
         file_system.path_join(".", DEFAULT_TEMPLATE_DIRNAME),
     ],
     # moban.output, default output file name
-    LABEL_OUTPUT: "%s.output" % PROGRAM_NAME,
+    LABEL_OUTPUT: "-",
     # data.yml, default data input file
     LABEL_CONFIG: "data%s" % DEFAULT_YAML_SUFFIX,
     LABEL_TEMPLATE_TYPE: DEFAULT_TEMPLATE_TYPE,

moban/externals/buffered_writer.py

@@ -11,7 +11,9 @@ def __init__(self):
         self.fs_list = {}
 
     def write_file_out(self, filename, content):
-        if file_system.is_zip_alike_url(filename):
+        if filename == "-":
+            print(content.decode())
+        elif file_system.is_zip_alike_url(filename):
             self.write_file_out_to_zip(filename, content)
         else:
             write_file_out(filename, content)

moban/externals/reporter.py

@@ -1,3 +1,5 @@
+import sys
+
 import crayons
 
 import moban.constants as constants
@@ -13,6 +15,8 @@
 MESSAGE_FILE_EXTENSION_NOT_NEEDED = "File extension is not required for ad-hoc\
  type"
 
+GLOBAL = {"PRINT": True}
+
 
 def report_templating(
     action_in_present_continuous_tense, source_file, destination_file
@@ -49,11 +53,13 @@ def report_partial_run(action_in_past_tense, file_count, total):
 
 
 def report_error_message(message):
-    do_print(crayons.white("Error: ", bold=True) + crayons.red(message))
+    error_print(crayons.white("Error: ", bold=True) + crayons.red(message))
 
 
 def report_warning_message(message):
-    do_print(crayons.white("Warning: ", bold=True) + crayons.yellow(message))
+    error_print(
+        crayons.white("Warning: ", bold=True) + crayons.yellow(message)
+    )
 
 
 def report_info_message(message):
@@ -98,4 +104,9 @@ def report_file_extension_not_needed():
 
 
 def do_print(message):
-    print(message)
+    if GLOBAL["PRINT"]:
+        print(message)
+
+
+def error_print(message):
+    sys.stderr.write(message + "\n")