✨ initial prototype

Author: chfw

.moban.yml

@@ -1,8 +1,6 @@
-requires:
-  - pypi-mobans-pkg==0.0.7
 configuration:
   template_dir:
-  - "pypi://pypi-mobans-pkg/resources/templates"
+  - "git://github.com/moremoban/pypi-mobans.git?submodule=true!/templates"
   - ".moban.d"
   configuration: gitfs2.yml
 targets:

Pipfile

@@ -7,6 +7,9 @@ name = 'pypi'
 python_version= '3.6'
 
 [packages]
+fs = "*"
+crayons = "*"
+GitPython = "*"
 
 [dev-packages]
 nose = "*"

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']

gitfs2.yml

@@ -8,6 +8,12 @@ current_version: "0.0.1"
 release: "0.0.0"
 copyright_year: 2019
 license: MIT
-dependencies: []
+dependencies:
+  - fs
+  - crayons
+  - GitPython
+entry_points:
+  fs.opener:
+    - "git = gitfs2:GitFSOpener"
 description: "Python file system 2 over GitPython"
 moban_command: make format git-diff-check

gitfs2/__init__.py

@@ -1,3 +1,4 @@
 # flake8: noqa
 from gitfs2._version import __version__
 from gitfs2._version import __author__
+from gitfs2.opener import GitFSOpener

gitfs2/constants.py

@@ -0,0 +1,5 @@
+PROGRAM_NAME = "fs.gitpython"
+REPOS_DIR_NAME = "repos"
+
+MESSAGE_INVALID_GIT_URL = 'An invalid git url: "%s" in mobanfile'
+DEFAULT_CLONE_DEPTH = 2

gitfs2/opener.py

@@ -0,0 +1,30 @@
+from gitfs2 import repo
+from fs.osfs import OSFS
+from fs.opener import Opener
+
+
+class GitFSOpener(Opener):
+    protocols = ["git"]
+    update = True
+
+    def open_fs(self, fs_url, parse_result, writeable, create, cwd):
+        repo_name, _, dir_path = parse_result.resource.partition("/")
+        git_url = "{protocol}://{resource}".format(
+            protocol=parse_result.protocol,
+            resource=parse_result.resource
+        )
+        require = repo.GitRequire(
+            git_url=git_url,
+            branch=parse_result.params.get('branch'),
+            submodule=parse_result.params.get('submodule'),
+            reference=parse_result.params.get('reference')
+        )
+        local_folder = repo.git_clone(
+            require,
+            action_required=GitFSOpener.update)
+        if GitFSOpener.update:
+            GitFSOpener.update = False
+        if parse_result.path:
+            local_folder = local_folder+parse_result.path
+        osfs = OSFS(root_path=local_folder)
+        return osfs

gitfs2/repo.py

@@ -0,0 +1,123 @@
+import os
+import sys
+import errno
+import subprocess
+
+import fs
+import fs.path
+from gitfs2 import constants, reporter
+
+
+class GitRequire(object):
+    def __init__(
+        self, git_url=None, branch=None, submodule="False", reference=None
+    ):
+        self.git_url = git_url
+        self.submodule = convert_submodule(submodule)
+        self.branch = branch
+        self.reference = reference
+
+    def clone_params(self):
+        clone_params = {
+            "single_branch": True,
+            "depth": constants.DEFAULT_CLONE_DEPTH,
+        }
+        if self.branch is not None:
+            clone_params["branch"] = self.branch
+        elif self.reference is not None:
+            clone_params["reference"] = self.reference
+        return clone_params
+
+    def __eq__(self, other):
+        return (
+            self.git_url == other.git_url
+            and self.submodule == other.submodule
+            and self.branch == other.branch
+            and self.reference == other.reference
+        )
+
+    def __repr__(self):
+        return "%s,%s,%s" % (self.git_url, self.branch, self.submodule)
+
+
+def convert_submodule(submodule_string):
+    if submodule_string in ['1', 'True', 'true']:
+        return True
+    return False
+
+
+def git_clone(require, action_required=True):
+    from git import Repo
+
+    if sys.platform != "win32":
+        # Unfortunately for windows user, the following function
+        # needs shell=True, which expose security risk. I would
+        # rather not to trade it with its marginal benefit
+        make_sure_git_is_available()
+
+    app_home = get_app_home()
+    mkdir_p(app_home)
+
+    repo_name = get_repo_name(require.git_url)
+    local_repo_folder = os.path.join(app_home, repo_name)
+
+    if action_required:
+        if os.path.exists(local_repo_folder):
+            reporter.info("Found repo in %s" % local_repo_folder)
+            repo = Repo(local_repo_folder)
+            repo.git.pull()
+            if require.reference:
+                repo.git.checkout(require.reference)
+            elif require.branch:
+                repo.git.checkout(require.branch)
+            if require.submodule:
+                reporter.info("updating submodule")
+                repo.git.submodule("update")
+        else:
+            reporter.info("git clone %s" % require.git_url)
+            repo = Repo.clone_from(
+                require.git_url, local_repo_folder, **require.clone_params()
+            )
+            if require.submodule:
+                reporter.info("checking out submodule")
+                repo.git.submodule("update", "--init")
+
+    return local_repo_folder
+
+
+def get_repo_name(repo_url):
+    import giturlparse
+    from giturlparse.parser import ParserError
+
+    try:
+        repo = giturlparse.parse(repo_url.rstrip("/"))
+        return repo.name
+    except ParserError:
+        reporter.error(
+            constants.MESSAGE_INVALID_GIT_URL % repo_url
+        )
+        raise
+
+
+def get_app_home():
+    from appdirs import user_cache_dir
+
+    home_dir = user_cache_dir(appname=constants.PROGRAM_NAME)
+    return fs.path.join(home_dir, constants.REPOS_DIR_NAME)
+
+
+def make_sure_git_is_available():
+    try:
+        subprocess.check_output(["git", "--help"])
+    except Exception:
+        raise Exception("Please install git command")
+
+
+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

gitfs2/reporter.py

@@ -0,0 +1,13 @@
+import crayons
+
+
+def error(message):
+    print(crayons.white("Error: ", bold=True) + crayons.red(message))
+
+
+def warn(message):
+    print(crayons.white("Warning: ", bold=True) + crayons.yellow(message))
+
+
+def info(message):
+    print(crayons.white("Info: ") + crayons.green(message))

requirements.txt

@@ -0,0 +1,3 @@
+fs
+crayons
+GitPython