cookiecutter's gh: support (#70)

* ✨ support gh:audreyr/cookiecutter-pypackage. fix #53

* This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst

* update

* 💚 update format.sh

* 💚 test new syntax and update 📚

* This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst

* Update test_main.py

Co-authored-by: chfw <[email protected]>

Author: chfw

.isort.cfg

@@ -9,4 +9,4 @@
  include_trailing_comma=true
  default_section=FIRSTPARTY
  no_lines_before=LOCALFOLDER
- sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+ sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER

.moban.d/yehua.feature.rst

@@ -23,7 +23,7 @@ Europython. Simply there is tons of cookiecutter templates out there.
 What you do is to replace 'cookiecutter' with 'yh'::
 
     $ pip install yehua[cookiecutter]
-    $ yh git://github.com/audreyr/cookiecutter-pypackage.git
+    $ yh gh:audreyr/cookiecutter-pypackage
 
 And what moremoban promise is, whenever your source template changes, you
 can `synchronize` them any time with another moremoban's command 'moban'::

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Change log
 ================================================================================
 
+0.1.4 - 14.09.2020
+--------------------------------------------------------------------------------
+
+**Updated**
+
+#. `#53 <https://github.com/moremoban/yehua/issues/53>`_: parity with
+   cookiecutter: support gh:audreyr/cookiecutter-pypackage
+
 0.1.3 - 13.09.2020
 --------------------------------------------------------------------------------
 

README.rst

@@ -55,7 +55,7 @@ Europython. Simply there is tons of cookiecutter templates out there.
 What you do is to replace 'cookiecutter' with 'yh'::
 
     $ pip install yehua[cookiecutter]
-    $ yh git://github.com/audreyr/cookiecutter-pypackage.git
+    $ yh gh:audreyr/cookiecutter-pypackage
 
 And what moremoban promise is, whenever your source template changes, you
 can `synchronize` them any time with another moremoban's command 'moban'::

changelog.yml

@@ -1,6 +1,12 @@
 name: yehua
 organisation: moremoban
 releases:
+- changes:
+  - action: Updated
+    details:
+    - "`#53`: parity with cookiecutter: support gh:audreyr/cookiecutter-pypackage"
+  date: 14.09.2020
+  version: 0.1.4
 - changes:
   - action: Updated
     details:

docs/source/conf.py

@@ -16,8 +16,8 @@
 spelling_word_list_filename = 'spelling_wordlist.txt'
 project = u'yehua'
 copyright = u'2017-2020 Onni Software Ltd.'
-version = '0.1.3'
-release = '0.1.3'
+version = '0.1.4'
+release = '0.1.4'
 exclude_patterns = []
 pygments_style = 'sphinx'
 html_theme = 'default'

docs/source/index.rst

@@ -57,7 +57,7 @@ Europython. Simply there is tons of cookiecutter templates out there.
 What you do is to replace 'cookiecutter' with 'yh'::
 
     $ pip install yehua[cookiecutter]
-    $ yh git://github.com/audreyr/cookiecutter-pypackage.git
+    $ yh gh:audreyr/cookiecutter-pypackage
 
 And what moremoban promise is, whenever your source template changes, you
 can `synchronize` them any time with another moremoban's command 'moban'::

format.sh

@@ -1,3 +1,3 @@
-isort $(find yehua -name "*.py"|xargs echo) $(find tests -name "*.py"|xargs echo)
+isort $(find yehua -name "*.py"|xargs echo) $(find tests -name "*.py"|grep -v 'project_'| xargs echo)
 black -l 79 yehua
-black -l 79 tests  --exclude=tests/fixtures/project_
+black --exclude "/tests\/fixtures\/project_.*/" -l 79 tests

setup.py

@@ -32,7 +32,7 @@
 
 NAME = "yehua"
 AUTHOR = "chfw"
-VERSION = "0.1.3"
+VERSION = "0.1.4"
 EMAIL = "[email protected]"
 LICENSE = "New BSD"
 ENTRY_POINTS = {
@@ -44,7 +44,7 @@
     "Yet another a project template tool for an organisation."
 )
 URL = "https://github.com/moremoban/yehua"
-DOWNLOAD_URL = "%s/archive/0.1.3.tar.gz" % URL
+DOWNLOAD_URL = "%s/archive/0.1.4.tar.gz" % URL
 FILES = ["README.rst","CONTRIBUTORS.rst", "CHANGELOG.rst"]
 KEYWORDS = [
     "python",
@@ -90,8 +90,8 @@
 }
 # You do not need to read beyond this line
 PUBLISH_COMMAND = "{0} setup.py sdist bdist_wheel upload -r pypi".format(sys.executable)
-GS_COMMAND = ("gs yehua v0.1.3 " +
-              "Find 0.1.3 in changelog for more details")
+GS_COMMAND = ("gs yehua v0.1.4 " +
+              "Find 0.1.4 in changelog for more details")
 NO_GS_MESSAGE = ("Automatic github release is disabled. " +
                  "Please install gease to enable it.")
 UPLOAD_FAILED_MSG = (

tests/cutie_tests/__init__.py

@@ -1,7 +1,7 @@
-from yehua.thirdparty import cutie
-
 import readchar
 
+from yehua.thirdparty import cutie
+
 
 def PrintCall(states):
     def func(msg=None, state="selectable"):

tests/cutie_tests/test_get_number.py

@@ -2,7 +2,6 @@
 from unittest import mock
 
 from yehua.thirdparty import cutie
-
 from . import MockException
 
 

tests/cutie_tests/test_prompt_yes_or_no.py

@@ -2,6 +2,7 @@
 from unittest import mock
 
 import readchar
+
 from . import PrintCall, InputContext, cutie
 
 print_call = PrintCall(

tests/cutie_tests/test_select.py

@@ -3,6 +3,7 @@
 from unittest import mock
 
 import readchar
+
 from . import PrintCall, InputContext, MockException, cutie
 
 print_call = PrintCall(

tests/cutie_tests/test_select_multiple.py

@@ -2,6 +2,7 @@
 from unittest import mock
 
 import readchar
+
 from . import PrintCall, InputContext, MockException, cutie
 
 print_call = PrintCall(

tests/fixtures/project_yehua/docs/source/conf.py

@@ -59,4 +59,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = ['static']

tests/fixtures/project_yehua/project_yehua/__init__.py

@@ -1,3 +1,2 @@
 # flake8: noqa
-from project_yehua._version import __version__
-from project_yehua._version import __author__
+from project_yehua._version import __author__, __version__

tests/test_cookie_cutter.py

@@ -2,12 +2,12 @@
 import sys
 import shutil
 
-from yehua.main import main
+from mock import patch
+from nose.tools import eq_
 from moban.externals.file_system import is_dir, url_join, read_unicode
 
 import fs
-from mock import patch
-from nose.tools import eq_
+from yehua.main import main
 
 
 @patch("yehua.cookiecutter.get_user_inputs")
@@ -79,7 +79,7 @@ def test_reference_pypi_package(fake_inputs):
         "create_author_file": "y",
         "open_source_license": "MIT license",
     }
-    path = "git://github.com/moremoban/cookiecutter-pypackage.git"
+    path = "gh:moremoban/cookiecutter-pypackage"
     with patch.object(sys, "argv", ["yh", path]):
         main()
 

tests/test_main.py

@@ -1,12 +1,12 @@
 import os
 import sys
 
-from yehua.main import HELP_TEXT, main, control_c_quit, get_yehua_file
-
-from six import StringIO
 from mock import patch
 from nose.tools import eq_, raises
 
+from six import StringIO
+from yehua.main import HELP_TEXT, main, control_c_quit, get_yehua_file
+
 
 @patch("yehua.project.os.chdir")
 @patch("yehua.project._run_command")
@@ -63,6 +63,18 @@ def test_yehua_file_passed_in_command_line():
             mocked_project.assert_called()
 
 
+@patch("yehua.main.Project")
+@patch("yehua.main.cookiecutter_json_to_yehua_file")
+def test_gh_url(cookie_cutter_handler, mocked_project):
+    from moban.exceptions import FileNotFound
+
+    args = ["yehua", "gh:org/repo"]
+    cookie_cutter_handler.side_effect = FileNotFound
+    with patch.object(sys, "argv", args):
+        main()
+        mocked_project.assert_called_with("git://github.com/org/repo.git")
+
+
 @raises(Exception)
 def test_a_directory_is_passed_in_command_line():
     args = ["yehua", "/"]
@@ -87,7 +99,7 @@ def test_get_yehua_file_2():
 
 
 def test_get_yehua_file_3():
-    default_yehua_file = 'pypi://pypi-mobans-pkg/resources/yehua.yml'
+    default_yehua_file = "pypi://pypi-mobans-pkg/resources/yehua.yml"
     yehua_file = get_yehua_file()
     eq_(default_yehua_file, yehua_file)
 

tests/test_project.py

@@ -3,12 +3,12 @@
 import codecs
 import unittest
 
-from yehua.main import get_yehua_file
-from yehua.project import Project
-
 from mock import patch
 from nose.tools import eq_, raises
 
+from yehua.main import get_yehua_file
+from yehua.project import Project
+
 
 @patch("yehua.utils.mkdir")
 @patch("yehua.project.get_user_inputs")

tests/test_yehua.py

@@ -3,10 +3,10 @@
 import shutil
 from filecmp import dircmp
 
-from yehua.main import main
-
 from mock import patch
 
+from yehua.main import main
+
 
 @patch("yehua.project.get_user_inputs")
 def test_reference_pypi_package(fake_inputs):

yehua.yaml

@@ -4,9 +4,9 @@ organisation: "moremoban"
 author: chfw
 contact: "[email protected]"
 company: "Onni Software Ltd."
-version: "0.1.3"
-current_version: "0.1.3"
-release: "0.1.3"
+version: "0.1.4"
+current_version: "0.1.4"
+release: "0.1.4"
 copyright_year: 2017-2020
 command_line_interface: "yh"
 entry_point: "yehua.main:main"

yehua/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 __author__ = "chfw"

yehua/cookiecutter.py

@@ -2,12 +2,12 @@
 import logging
 from copy import deepcopy
 
+from jinja2 import Environment
+
 import yehua.utils as utils
 from yehua.utils import dump_yaml, get_user_inputs
 from yehua.project import Project
 
-from jinja2 import Environment
-
 MOBAN_FILE_FOR_COOKIE_CUTTER = """
 configuration:
   template_dir:

yehua/cookiecutter_to_yehua.py

@@ -1,10 +1,10 @@
 import json
 from io import StringIO
 
-from yehua.utils import dump_yaml, find_project_name
 from moban.externals.file_system import is_dir, url_join, read_unicode
 
 import fs
+from yehua.utils import dump_yaml, find_project_name
 
 INTRODUCTION = """
 [info]Yehua /'jɛhwa/[/info] will walk you through cookiecutter template wizard

yehua/main.py

@@ -3,10 +3,11 @@
 import logging
 import argparse
 
+from moban.exceptions import FileNotFound
+
 from yehua.utils import get_yehua_file
 from yehua.project import Project
 from yehua._version import __version__
-from moban.exceptions import FileNotFound
 from yehua.cookiecutter import CookieCutter
 from yehua.cookiecutter_to_yehua import cookiecutter_json_to_yehua_file
 
@@ -50,6 +51,11 @@ def main():
         if yehua_file.endswith("git") and yehua_file.startswith("https"):
             yehua_file = yehua_file.replace("https://", "git://")
 
+        if yehua_file.startswith("gh:"):
+            yehua_file = yehua_file.replace("gh:", "git://github.com/")
+            if not yehua_file.endswith(".git"):
+                yehua_file = yehua_file + ".git"
+
         yehua = cookiecutter_json_to_yehua_file(yehua_file)
         project = CookieCutter(yehua, yehua_file)
     except FileNotFound:

yehua/project.py

@@ -2,12 +2,12 @@
 import subprocess
 from datetime import datetime
 
-import yehua.utils as utils
-from yehua.utils import get_user_inputs
+from jinja2 import Environment
 from moban.externals.file_system import exists, is_dir, read_unicode
 
 import fs
-from jinja2 import Environment
+import yehua.utils as utils
+from yehua.utils import get_user_inputs
 from jinja2_fsloader import FSLoader
 
 
@@ -130,7 +130,7 @@ def _create_jj2_environment(self, path):
             loader=template_loader,
             keep_trailing_newline=True,
             trim_blocks=True,
-            lstrip_blocks=True
+            lstrip_blocks=True,
         )
         return environment
 

yehua/utils.py

@@ -4,16 +4,16 @@
 import shutil
 import logging
 
-from yehua.theme import THEME
-from yehua.thirdparty import cutie
-
-import fs
 import colorful
 from jinja2 import Environment
 from ruamel.yaml import YAML
 
+import fs
+from yehua.theme import THEME
+from yehua.thirdparty import cutie
+
 DEFAULT_FILE = "yehua.yml"
-DEFAULT_PYPI_YEHUA_FILE = 'pypi://pypi-mobans-pkg/resources/yehua.yml'
+DEFAULT_PYPI_YEHUA_FILE = "pypi://pypi-mobans-pkg/resources/yehua.yml"
 ENVIRONMENT_KEY = "YEHUA_FILE"
 LOG = logging.getLogger(__name__)
 
@@ -108,9 +108,7 @@ def get_user_inputs(questions):  # refactor this later
                     # {"foo": "foo [{{yehua.hello}}]"},
                     # {"bar": "bar [{{cookiecutter.hello}}]"}
                     template = env.from_string(question)
-                    question = template.render(
-                        cookiecutter=answers, **answers
-                    )
+                    question = template.render(cookiecutter=answers, **answers)
 
                 match = re.match(r"(.*)\[(.*)\].*", question)
                 if match: