Merge pull request #70 from moremoban/make-dir-while-copying

Make dir while copying

Author: chfw

.moban.cd/changelog.yml

@@ -2,6 +2,9 @@ name: moban
 organisation: moremoban
 releases:
 - changes:
+  - action: Added
+    details:
+    - "`#31`: create directory if missing during copying"
   - action: Updated
     details:
     - "`#28`: if a template has been copied once before, it is skipped in the next moban call"

CHANGELOG.rst

@@ -4,6 +4,12 @@ Change log
 0.2.2 - unreleased
 --------------------------------------------------------------------------------
 
+Added
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. `#31 <https://github.com/moremoban/moban/issues/31>`_: create directory if
+   missing during copying
+
 Updated
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

docs/index.rst

@@ -23,6 +23,14 @@ examples folder.
    level-6-complex-configuration/README.rst
    level-7-use-custom-jinja2-filter-test-n-global/README.rst
 
+In pratice, the following use cases were found interesting to go along with.
+
+.. toctree::
+   :maxdepth: 1
+
+   misc-1-copying-templates
+
+
 For more complex use case, please look at `its usage in pyexcel project <http://pyexcel.readthedocs.io/en/latest/guide.html>`_
 
 Developer Guide
@@ -40,4 +48,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/misc-1-copying-templates/.moban.yml

@@ -0,0 +1,6 @@
+configuration:
+  template_dir:
+    - template-sources
+copy:
+  - simple.file.copy: file-in-template-sources-folder.txt
+  - "misc-1-copying/can-create-folder/if-not-exists.txt": file-in-template-sources-folder.txt

docs/misc-1-copying-templates/README.rst

@@ -0,0 +1,7 @@
+Misc 1: copying templates
+================================================================================
+
+With `.moban.yml`, you can copy templates to your destination.
+
+
+

docs/misc-1-copying-templates/template-sources/file-in-template-sources-folder.txt

@@ -0,0 +1 @@
+test file

moban/copier.py

@@ -1,6 +1,7 @@
 import os
 import shutil
 
+import moban.utils as utils
 import moban.reporter as reporter
 from moban.hashstore import HASH_STORE
 
@@ -9,17 +10,22 @@ class Copier(object):
 
     def __init__(self, template_dirs):
         self.template_dirs = template_dirs
+        self._file_count = 0
         self._count = 0
 
     def copy_files(self, file_list):
         for dest_src_pair in file_list:
             for dest, src in dest_src_pair.items():
+                self._file_count += 1
                 src_path = self._get_src_file(src)
                 if src_path is None:
                     reporter.report_error_message(
                         "{0} cannot be found".format(src)
                     )
                 elif HASH_STORE.are_two_file_different(src_path, dest):
+                    dest_folder = os.path.dirname(dest)
+                    if dest_folder:
+                        utils.mkdir_p(dest_folder)
                     reporter.report_copying(src_path, dest)
                     shutil.copy(src_path, dest)
                     self._count = self._count + 1
@@ -29,7 +35,7 @@ def number_of_copied_files(self):
 
     def report(self):
         if self._count:
-            reporter.report_copying_summary(self._count)
+            reporter.report_copying_summary(self._file_count, self._count)
         else:
             reporter.report_no_copying()
 

moban/reporter.py

@@ -9,6 +9,7 @@
 MESSAGE_NO_TEMPLATING = "No templating"
 MESSAGE_REPORT = "Templated {0} out of {1} files."
 MESSAGE_TEMPLATED_ALL = "Templated {0} files."
+MESSAGE_COPY_REPORT = "Copied {0} out of {1} files."
 MESSAGE_COPIED_ALL = "Copied {0} files."
 
 
@@ -69,10 +70,16 @@ def report_no_copying_done():
     print(crayons.red(MESSAGE_NO_COPY, bold=True))
 
 
-def report_copying_summary(file_count):
-    figure = crayons.green(str(file_count), bold=True)
-    message = MESSAGE_COPIED_ALL.format(figure)
-    print(_format_single(message, file_count))
+def report_copying_summary(total, copies):
+    if total == copies:
+        figure = crayons.green(str(total), bold=True)
+        message = MESSAGE_COPIED_ALL.format(figure)
+        print(_format_single(message, total))
+    else:
+        figure = crayons.green(str(copies), bold=True)
+        total_figure = crayons.yellow(str(total), bold=True)
+        message = MESSAGE_COPY_REPORT.format(figure, total_figure)
+        print(_format_single(message, total))
 
 
 def _format_single(message, count):

moban/utils.py

@@ -1,6 +1,7 @@
 import os
 import re
 import stat
+import errno
 
 import yaml
 
@@ -103,3 +104,13 @@ def write_file_out(filename, content, strip=True, encode=True):
         if encode:
             content = content.encode("utf-8")
         out.write(content)
+
+
+def mkdir_p(path):
+    try:
+        os.makedirs(path)
+    except OSError as exc:  # Python >2.5
+        if exc.errno == errno.EEXIST and os.path.isdir(path):
+            pass
+        else:
+            raise

tests/test_docs.py

@@ -87,6 +87,12 @@ def test_level_7(self):
         folder = "level-7-use-custom-jinja2-filter-test-n-global"
         self._raw_moban(["moban"], folder, expected, "test.output")
 
+    def test_misc_1(self):
+        expected = "test file\n"
+
+        folder = "misc-1-copying-templates"
+        self._raw_moban(["moban"], folder, expected, "simple.file.copy")
+
     def _moban(self, folder, expected):
         args = ["moban", "-c", "data.yml", "-t", "a.template"]
         self._raw_moban(args, folder, expected, "moban.output")