Fix gitprof when running on Linux

Author: TheGreatCabbage

gitprof/cli/clone.py

@@ -27,26 +27,37 @@
 import click
 
 from gitprof import command_utils
+from gitprof import os_utils
 from gitprof import ssh
 from gitprof import ux
 from gitprof.cli import root
 from gitprof.files import Config, Profile
 from gitprof.vcs import services
 
 
+def _create_clone_command(ssh_command, repo, dest) -> str:
+    if os_utils.is_windows():
+        return (
+            f"powershell -c "
+            + f'"git -c core.sshCommand="""{ssh_command}""" clone {repo}" "{dest}"'
+        )
+
+    return f'git -c core.sshCommand="{ssh_command}" clone "{repo}" "{dest}"'
+
+
 def do_clone(
     ssh_command: str, repo: str, profile: Profile, dest: str, add_to_known_hosts=False
 ):
     if add_to_known_hosts:
         ssh_command = f"{ssh_command} -o StrictHostKeyChecking=no"
 
-    cmd = (
-        f"powershell -c "
-        f'"git -c core.sshCommand="""{ssh_command}""" clone {repo}" "{dest}"'
-    )
+    cmd = _create_clone_command(ssh_command, repo, dest)
 
     pipes = subprocess.Popen(
-        cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        shell=True,
     )
     stdout, stderr = pipes.communicate()
 
@@ -128,7 +139,9 @@ def advice():
 @click.argument("repo")
 @click.option("-p", "--profile", help="Which profile to clone the repo with")
 def clone(repo: str, profile: str):
-    profile = command_utils.create_profile_interactive(profile)
+    profile = command_utils.choose_profile_interactive(
+        profile, title="Choose a profile to clone with"
+    )
 
     click.echo(f"Cloning '{repo}' with profile: {profile}")
     profile: Profile = Config().get_profile(name=profile)

gitprof/cli/config.py

@@ -24,6 +24,8 @@
 
 import click
 
+from gitprof import os_utils
+from gitprof import ux
 from gitprof import files
 from gitprof.cli import root
 
@@ -43,7 +45,13 @@ def edit_config(editor: str):
     if editor:
         return os.system(fr'"{editor}" {files.config_file}')
 
-    os.system(f'start "" "{files.config_file}"')
+    if os_utils.is_windows():
+        return os.system(f'start "" "{files.config_file}"')
+
+    editor = ux.get_simple_input(
+        question="Please enter the command for your text editor (e.g. 'vi')"
+    )
+    return os.system(f'"{editor}" "{files.config_file}"')
 
 
 @config.command("rm", help="Delete the config file")

gitprof/cli/profile.py

@@ -98,7 +98,7 @@ def create_profile(name: str, username: str = None):
         print(f"Trying to find your Git committer name and email...")
         result = github_utils.get_name_and_email(username)
 
-        if len(result) == 2:
+        if result and len(result) == 2:
             name, email = result
 
             profile.git_name = name
@@ -107,6 +107,10 @@ def create_profile(name: str, username: str = None):
             click.echo(
                 f"\nYour name and email were found and are set as the defaults for the next questions."
             )
+        else:
+            click.echo(
+                f"Failed to find name and email. You'll need to enter them manually.\n"
+            )
 
     profile.git_name = ux.get_simple_input(
         "Enter your Git committer name", default=profile.git_name
@@ -139,7 +143,9 @@ def create_profile(name: str, username: str = None):
 @profile.command("apply", help="Apply profile to current repository")
 @click.option("-p", "--profile", help="The profile to apply")
 def apply_profile(profile: str):
-    profile = command_utils.create_profile_interactive(profile)
+    profile = command_utils.choose_profile_interactive(
+        profile, title="Choose a profile to apply"
+    )
 
     profile: Profile = Config().get_profile(name=profile)
     command_utils.set_git_configs(profile)

gitprof/command_utils.py

@@ -30,7 +30,11 @@
 
 def run_command(args: str):
     raw = subprocess.check_output(
-        args, stdin=None, stderr=None, shell=False, universal_newlines=False
+        args,
+        stdin=None,
+        stderr=None,
+        shell=True,
+        universal_newlines=False,
     ).decode("utf-8")
     return "".join(raw).strip().replace("\r\n", "")
 
@@ -49,7 +53,7 @@ def set_git_configs(profile: Profile):
     run_command(f'git config --local core.sshCommand "{ssh_command}"')
 
 
-def create_profile_interactive(profile: str) -> str:
+def choose_profile_interactive(profile: str, title: str) -> str:
     config = Config()
 
     while not profile:
@@ -65,7 +69,7 @@ def create_profile_interactive(profile: str) -> str:
                     options[index] = f"{options[index]}{whitespace}({profile.service})"
 
             chosen = ux.get_input_from_list(
-                title="Choose a profile to clone with",
+                title=title,
                 options=options,
                 fallback="create new profile",
                 fallback_index=-1,

gitprof/files.py

@@ -28,9 +28,14 @@
 from os.path import join
 from typing import List, Any, Dict, Optional
 
-config_dir = os.path.expanduser(r"~\AppData\Local\gitprof")
-os.makedirs(config_dir, exist_ok=True)
+from gitprof import os_utils
+
+if os_utils.is_windows():
+    config_dir = os.path.expanduser(r"~\AppData\Local\gitprof")
+else:
+    config_dir = os.path.expanduser(r"~/.config/gitprof")
 
+os.makedirs(config_dir, exist_ok=True)
 config_file = join(config_dir, "config.json")
 
 

gitprof/os_utils.py

@@ -0,0 +1,26 @@
+#  MIT License
+#
+#  Copyright (c) 2020 Sam McCormack
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+import platform
+
+
+def is_windows() -> bool:
+    return platform.system().lower() == "windows"

gitprof/ssh.py

@@ -24,6 +24,7 @@
 from typing import List
 
 ssh_dir = os.path.expanduser("~/.ssh")
+os.makedirs(ssh_dir, exist_ok=True)
 
 
 def create_ssh_key(name: str) -> str:

gitprof/vcs/github_utils.py

@@ -19,34 +19,37 @@
 #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
-from typing import List
+from typing import List, Optional, Tuple
 
 from github import Github, GitAuthor, GitCommit
 from github.Repository import Repository
 
 g = Github()
 
 
-def get_name_and_email(username: str):
-    user = g.get_user(username)
-    repos: List[Repository] = user.get_repos()
+def get_name_and_email(username: str) -> Optional[Tuple[str, str]]:
+    try:
+        user = g.get_user(username)
+        repos: List[Repository] = user.get_repos()
 
-    name, email = None, None
+        name, email = None, None
 
-    for r in repos:
-        commits = r.get_commits(author=user)
-        size = commits.totalCount
+        for r in repos:
+            commits = r.get_commits(author=user)
+            size = commits.totalCount
 
-        if size <= 0:
-            continue
+            if size <= 0:
+                continue
 
-        last_commit: GitCommit = commits[size - 1].commit
-        author: GitAuthor = last_commit.author
+            last_commit: GitCommit = commits[size - 1].commit
+            author: GitAuthor = last_commit.author
 
-        name = author.name
-        email = author.email
+            name = author.name
+            email = author.email
 
-        if name and email:
-            break
+            if name and email:
+                break
 
-    return name, email
+        return name, email
+    except:
+        return None