Merge branch feature/better_lists into devel

Author: guyzmo

git_repo/repo.py

@@ -16,14 +16,14 @@
     {self} [--path=<path>] [-v...] <target> add <user>/<repo> [<name>] [--tracking=<branch>] [-a]
     {self} [--path=<path>] [-v...] <target> request (list|ls)
     {self} [--path=<path>] [-v...] <target> request fetch <request> [-f]
-    {self} [--path=<path>] [-v...] <target> request create <title> [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request create <local_branch> <title> [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request create <remote_branch> <local_branch> <title> [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request create [--title=<title>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request create <local_branch> [--title=<title>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request create <remote_branch> <local_branch> [--title=<title>] [--message=<message>]
     {self} [--path=<path>] [-v...] <target> request <user>/<repo> (list|ls)
     {self} [--path=<path>] [-v...] <target> request <user>/<repo> fetch <request> [-f]
-    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <title> [--branch=<remote>] [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <local_branch> <title> [--branch=<remote>] [--message=<message>]
-    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <remote_branch> <local_branch> <title> [--branch=<remote>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create [--title=<title>] [--branch=<remote>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <local_branch> [--title=<title>] [--branch=<remote>] [--message=<message>]
+    {self} [--path=<path>] [-v...] <target> request <user>/<repo> create <remote_branch> <local_branch> [--title=<title>] [--branch=<remote>] [--message=<message>]
     {self} [--path=<path>] [-v...] <target> (gist|snippet) (list|ls) [<gist>]
     {self} [--path=<path>] [-v...] <target> (gist|snippet) clone <gist>
     {self} [--path=<path>] [-v...] <target> (gist|snippet) fetch <gist> [<gist_file>]
@@ -89,7 +89,7 @@
     --secret                 Do not publicize gist when pushing
 
 Options for request:
-    <title>                  Title to give to the request for merge
+    -t,--title=<title>       Title to give to the request for merge
     -m,--message=<message>   Description for the request for merge
 
 Configuration options:
@@ -137,31 +137,16 @@
 from .exceptions import ArgumentError, ResourceNotFoundError
 from .services.service import RepositoryService
 
+from .tools import print_tty, print_iter, loop_input, confirm
 from .kwargparse import KeywordArgumentParser, store_parameter, register_action
 
 from git import Repo, Git
-from git.exc import InvalidGitRepositoryError, NoSuchPathError
+from git.exc import InvalidGitRepositoryError, NoSuchPathError, BadName
 
 import re
 
 EXTRACT_URL_RE = re.compile('[^:]*(://|@)[^/]*/')
 
-def confirm(what, where):
-    '''
-    Method to show a CLI based confirmation message, waiting for a yes/no answer.
-    "what" and "where" are used to better define the message.
-    '''
-    ans = input('Are you sure you want to delete the '
-                '{} {} from the service?\n[yN]> '.format(what, where))
-    if 'y' in ans:
-        ans = input('Are you really sure? there\'s no coming back!\n'
-                    '[type \'burn!\' to proceed]> ')
-        if 'burn!' != ans:
-            return False
-    else:
-        return False
-    return True
-
 
 class GitRepoRunner(KeywordArgumentParser):
 
@@ -283,8 +268,7 @@ def store_gitconfig(self, val):
     @register_action('ls')
     @register_action('list')
     def do_list(self):
-        service = self.get_service(False)
-        service.list(self.user, self.long)
+        print_iter(self.get_service(False).list(self.user, self.long))
         return 0
 
     @register_action('add')
@@ -403,26 +387,70 @@ def do_open(self):
     @register_action('request', 'list')
     def do_request_list(self):
         service = self.get_service(lookup_repository=self.repo_slug == None)
-        log.info('List of open requests to merge:')
-        log.info(" {}\t{}\t{}".format('id', 'title'.ljust(60), 'URL'))
-        for pr in service.request_list(self.user_name, self.repo_name):
-            print("{}\t{}\t{}".format(pr[0].rjust(3), pr[1][:60].ljust(60), pr[2]))
+        print_tty('List of open requests to merge:')
+        print_iter(service.request_list(self.user_name, self.repo_name))
         return 0
 
     @register_action('request', 'create')
     def do_request_create(self):
+        def request_edition(repository, from_branch):
+            try:
+                commit = repository.commit(from_branch)
+                title, *body = commit.message.split('\n')
+            except BadName:
+                log.error('Couldn\'t find local source branch {}'.format(from_branch))
+                return None
+            from tempfile import NamedTemporaryFile
+            from subprocess import call
+            with NamedTemporaryFile(
+                    prefix='git-repo-issue-',
+                    suffix='.md',
+                    mode='w+b') as request_file:
+                request_file.write((
+                    '# Request for Merge Title ##########################\n'
+                    '{}\n'
+                    '\n'
+                    '# Request for Merge Body ###########################\n'
+                    '{}\n'
+                    '####################################################\n'
+                    '## Filled with commit:\n'
+                    '## {}\n'
+                    '####################################################\n'
+                    '## * All lines starting with # will be ignored.\n'
+                    '## * First non-ignored line is the title of the request.\n'
+                        ).format(title, '\n'.join(body), commit.name_rev).encode('utf-8'))
+                request_file.flush()
+                rv = call("{} {}".format(os.environ['EDITOR'], request_file.name), shell=True)
+                if rv != 0:
+                    raise ArgumentError("Aborting request, as editor exited abnormally.")
+                request_file.seek(0)
+                request_message = map(lambda l: l.decode('utf-8'),
+                        filter(lambda l: not l.strip().startswith(b'#'), request_file.readlines()))
+                try:
+                    title = next(request_message)
+                    body = ''.join(request_message)
+                except Exception:
+                    raise ResourceError("Format of the request message cannot be parsed.")
+
+                return title, body
+
+
         service = self.get_service(resolve_targets=('upstream', '{service}', 'origin'))
+
         new_request = service.request_create(self.user_name,
                 self.repo_name,
                 self.local_branch,
                 self.remote_branch,
                 self.title,
                 self.message,
-                self.repo_slug != None)
+                self.repo_slug != None,
+                request_edition)
         log.info('Successfully created request of `{local}` onto `{}:{remote}`, with id `{ref}`!'.format(
             '/'.join([self.user_name, self.repo_name]),
             **new_request)
         )
+        if 'url' in new_request:
+            log.info('available at: {url}'.format(**new_request))
         return 0
 
     @register_action('request', 'fetch')
@@ -442,16 +470,7 @@ def do_request_fetch(self):
     @register_action('snippet', 'list')
     def do_gist_list(self):
         service = self.get_service(lookup_repository=False)
-        if 'github' == service.name and self.gist_ref:
-            log.info("{:15}\t{:>7}\t{}".format('language', 'size', 'name'))
-        else:
-            log.info("{:56}\t{}".format('id', 'title'.ljust(60)))
-        if self.gist_ref:
-            for gist_file in service.gist_list(self.gist_ref):
-                print("{:15}\t{:7}\t{}".format(*gist_file))
-        else:
-            for gist in service.gist_list():
-                print( "{:56}\t{}".format(gist[0], gist[1]))
+        print_iter(service.gist_list(self.gist_ref or None))
         return 0
 
     @register_action('gist', 'clone')
@@ -496,12 +515,6 @@ def do_gist_delete(self):
     def do_config(self):
         from getpass import getpass
 
-        def loop_input(*args, method=input, **kwarg):
-            out = ''
-            while len(out) == 0:
-                out = method(*args, **kwarg)
-            return out
-
         def setup_service(service):
             new_conf = dict(
                     fqdn=None,
@@ -592,7 +605,8 @@ def cli(): #pragma: no cover
         sys.exit(main(docopt(__doc__.format(self=sys.argv[0].split('/')[-1], version=__version__))))
     finally:
         # Whatever happens, make sure that the cursor reappears with some ANSI voodoo
-        sys.stdout.write('\033[?25h')
+        if sys.stdout.isatty():
+            sys.stdout.write('\033[?25h')
 
 if __name__ == '__main__': #pragma: no cover
     cli()

git_repo/services/ext/github.py

@@ -4,12 +4,15 @@
 log = logging.getLogger('git_repo.github')
 
 from ..service import register_target, RepositoryService, os
-from ...exceptions import ResourceError, ResourceExistsError, ResourceNotFoundError
+from ...exceptions import ResourceError, ResourceExistsError, ResourceNotFoundError, ArgumentError
+from ...tools import columnize
 
 import github3
 
 from git.exc import GitCommandError
 
+from datetime import datetime
+
 @register_target('hub', 'github')
 class GithubService(RepositoryService):
     fqdn = 'github.com'
@@ -75,37 +78,18 @@ def delete(self, repo, user=None):
             raise ResourceError('Unhandled exception: {}'.format(err)) from err
 
     def list(self, user, _long=False):
-        import shutil, sys
-        from datetime import datetime
-        term_width = shutil.get_terminal_size((80, 20)).columns
-        def col_print(lines, indent=0, pad=2):
-            # prints a list of items in a fashion similar to the dir command
-            # borrowed from https://gist.github.com/critiqjo/2ca84db26daaeb1715e1
-            n_lines = len(lines)
-            if n_lines == 0:
-                return
-            col_width = max(len(line) for line in lines)
-            n_cols = int((term_width + pad - indent)/(col_width + pad))
-            n_cols = min(n_lines, max(1, n_cols))
-            col_len = int(n_lines/n_cols) + (0 if n_lines % n_cols == 0 else 1)
-            if (n_cols - 1) * col_len >= n_lines:
-                n_cols -= 1
-            cols = [lines[i*col_len : i*col_len + col_len] for i in range(n_cols)]
-            rows = list(zip(*cols))
-            rows_missed = zip(*[col[len(rows):] for col in cols[:-1]])
-            rows.extend(rows_missed)
-            for row in rows:
-                print(" "*indent + (" "*pad).join(line.ljust(col_width) for line in row))
-
         if not self.gh.user(user):
             raise ResourceNotFoundError("User {} does not exists.".format(user))
 
         repositories = self.gh.iter_user_repos(user)
         if not _long:
-            repositories = list(repositories)
-            col_print(["/".join([user, repo.name]) for repo in repositories])
+            repositories = list(["/".join([user, repo.name]) for repo in repositories])
+            yield "{}"
+            yield "Total repositories: {}".format(len(repositories))
+            yield from columnize(repositories)
         else:
-            print('Status\tCommits\tReqs\tIssues\tForks\tCoders\tWatch\tLikes\tLang\tModif\t\tName', file=sys.stderr)
+            yield "{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t{}\t\t{}"
+            yield ['Status', 'Commits', 'Reqs', 'Issues', 'Forks', 'Coders', 'Watch', 'Likes', 'Lang', 'Modif', 'Name']
             for repo in repositories:
                 try:
                     if repo.updated_at.year < datetime.now().year:
@@ -119,7 +103,7 @@ def col_print(lines, indent=0, pad=2):
                     ])
                     nb_pulls = len(list(repo.iter_pulls()))
                     nb_issues = len(list(repo.iter_issues())) - nb_pulls
-                    print('\t'.join([
+                    yield [
                         # status
                         status,
                         # stats
@@ -134,10 +118,10 @@ def col_print(lines, indent=0, pad=2):
                         repo.language or '?',                      # language
                         repo.updated_at.strftime(date_fmt),      # date
                         '/'.join([user, repo.name]),             # name
-                    ]))
+                    ]
                 except Exception as err:
                     if 'Git Repository is empty.' == err.args[0].json()['message']:
-                        print('\t'.join([
+                        yield [
                             # status
                             'E',
                             # stats
@@ -152,7 +136,7 @@ def col_print(lines, indent=0, pad=2):
                             '?',     # language
                             repo.updated_at.strftime(date_fmt),      # date
                             '/'.join([user, repo.name]),             # name
-                        ]))
+                        ]
                     else:
                         print("Cannot show repository {}: {}".format('/'.join([user, repo.name]), err))
 
@@ -167,12 +151,16 @@ def _format_gist(self, gist):
 
     def gist_list(self, gist=None):
         if not gist:
+            yield "{:45.45} {}"
+            yield 'title', 'url'
             for gist in self.gh.iter_gists(self.gh.user().login):
-                yield (gist.html_url, gist.description)
+                yield gist.description, gist.html_url
         else:
             gist = self.gh.gist(self._format_gist(gist))
             if gist is None:
                 raise ResourceNotFoundError('Gist does not exists.')
+            yield "{:15}\t{:7}\t{}"
+            yield 'language', 'size', 'name'
             for gist_file in gist.iter_files():
                 yield (gist_file.language if gist_file.language else 'Raw text',
                         gist_file.size,
@@ -233,7 +221,7 @@ def gist_delete(self, gist_id):
             raise ResourceNotFoundError('Could not find gist')
         gist.delete()
 
-    def request_create(self, user, repo, from_branch, onto_branch, title, description=None, auto_slug=False):
+    def request_create(self, user, repo, from_branch, onto_branch, title=None, description=None, auto_slug=False, edit=None):
         repository = self.gh.repository(user, repo)
         if not repository:
             raise ResourceNotFoundError('Could not find repository `{}/{}`!'.format(user, repo))
@@ -255,6 +243,10 @@ def request_create(self, user, repo, from_branch, onto_branch, title, descriptio
             onto_branch = repository.default_branch or 'master'
         if self.username != repository.owner.login:
             from_branch = ':'.join([self.username, from_branch])
+        if not title and not description and edit:
+            title, description = edit(self.repository, from_branch)
+            if not title and not description:
+                raise ArgumentError('Missing message for request creation')
         try:
             request = repository.create_pull(title,
                     base=onto_branch,
@@ -276,12 +268,15 @@ def request_create(self, user, repo, from_branch, onto_branch, title, descriptio
                     raise ResourceError("Unhandled formatting error: {}".format(err.errors))
             raise ResourceError(err.message)
 
-        return {'local': from_branch, 'remote': onto_branch, 'ref': request.number}
+        return {'local': from_branch, 'remote': onto_branch, 'ref': request.number,
+                'url': request.html_url}
 
     def request_list(self, user, repo):
         repository = self.gh.repository(user, repo)
+        yield "{}\t{:<60}\t{}"
+        yield 'id', 'title', 'URL'
         for pull in repository.iter_pulls():
-            yield ( str(pull.number), pull.title, pull.links['html'] )
+            yield str(pull.number), pull.title, pull.links['html']
 
     def request_fetch(self, user, repo, request, pull=False, force=False):
         if pull: