scripts: create a commit-solution script

This change adds a script to commit messages based on a template.

Fixes #294

Signed-off-by: Christopher Friedt <[email protected]>

Author: cfriedt

.github/workflows/ci.yml

@@ -38,6 +38,9 @@ jobs:
             git checkout -b master origin/master
             git checkout ${REF}
         fi
+        # problem.py requires 'git config user.name' and 'git config user.email' to work
+        git config user.name 'GitHub Actions'
+        git config user.email '[email protected]'
         pytest .scripts/*_test.py
 
     - name: Setup C++ CEnvironment

.scripts/commit-solution

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+
+import sys
+
+import problem
+
+if __name__ == '__main__':
+    problem.commit_solution()
+    sys.exit(0)

.scripts/problem.py

@@ -10,13 +10,18 @@
 import os
 import re
 import sys
+import tempfile
 import types
 
+repo = Repo()
+assert(repo.bare == False)
+git = repo.git
 
 LEETCODE_URL_BASE = 'https://leetcode.com/problems'
 GITHUB_URL_BASE = 'https://github.com/cfriedt/leetcode'
 SPDX_LICENSE_IDENTIFIER = 'MIT'
-COPYRIGHT_HOLDER = 'Christopher Friedt'
+GIT_USER_NAME = git.config('user.name')
+GIT_USER_EMAIL = git.config('user.email')
 
 NAME_RE = re.compile(r'^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]+$')
 
@@ -127,7 +132,7 @@ def create_impl_and_test(self):
 
                 # write the copyright and license info in SPDX format
                 f.write('/*\n')
-                f.write(' * Copyright (c) {}, {}\n'.format(year, COPYRIGHT_HOLDER))
+                f.write(' * Copyright (c) {}, {}\n'.format(year, GIT_USER_NAME))
                 f.write(' *\n')
                 f.write(
                     ' * SPDX-License-Identifier: {}\n'.format(SPDX_LICENSE_IDENTIFIER))
@@ -159,7 +164,7 @@ def create_impl_and_test(self):
 
                 # write the copyright and license info in SPDX format
                 f.write('/*\n')
-                f.write(' * Copyright (c) {}, {}\n'.format(year, COPYRIGHT_HOLDER))
+                f.write(' * Copyright (c) {}, {}\n'.format(year, GIT_USER_NAME))
                 f.write(' *\n')
                 f.write(
                     ' * SPDX-License-Identifier: {}\n'.format(SPDX_LICENSE_IDENTIFIER))
@@ -195,9 +200,6 @@ def create_impl_and_test(self):
             raise
 
     def checkout_branch(self, create=True):
-        repo = Repo(os.getcwd())
-        git = repo.git
-
         try:
             # stash any uncommitted changes
             git.add('*')
@@ -206,14 +208,59 @@ def checkout_branch(self, create=True):
             pass
 
         git.checkout('master')
-        git.fetch('-p')
-        git.pull()
+
+        in_ci = False
+        try:
+            in_ci = os.environ['CI']
+        except:
+            pass
+
+        if not in_ci:
+            git.fetch()
+            git.pull()
 
         if create:
             git.checkout('-b', self._branch)
         else:
             git.checkout(self._branch)
 
+    def create_commit_message(self):
+        msg = '''\
+Implement {}
+
+name: {}
+url: {}
+difficulty: {}
+
+time: {} ms
+time-rank: {} %
+time-complexity: {}
+
+space: {} MB
+space-rank: {} %
+space-complexity: {}
+
+Fixes #{}
+
+Signed-off-by: {} <{}>
+'''.format(self._name, self._name, self._url, self._difficulty, self._time, self._time_rank, self._time_complexity, self._space, self._space_rank, self._space_complexity, self._issue, GIT_USER_NAME, GIT_USER_EMAIL)
+        return msg
+
+
+def new_problem_args(name, issue, difficulty, tmpl):
+    args = Problem.default_args()
+    args.name = name
+    args.issue = issue
+    args.difficulty = difficulty
+    args.problem_template = tmpl
+
+    p = Problem(args)
+    p.checkout_branch()
+    p.create_impl_and_test()
+
+    return p
+
+
 def new_problem():
     args = Problem.default_args()
 
@@ -240,8 +287,92 @@ def new_problem():
             break
         args.problem_template += line
 
-    p = Problem(args)
-    p.checkout_branch()
-    p.create_impl_and_test()
+    p = new_problem_args(args.name, args.issue,
+                         args.difficulty, args.problem_template)
 
     return p
+
+
+def commit_solution_args(issue, name, difficulty, time, time_rank, time_complexity, space, space_rank, space_complexity):
+
+    args = Problem.default_args()
+    args.issue = issue
+    args.name = name
+    args.difficulty = difficulty
+    args.time = time
+    args.time_rank = time_rank
+    args.time_complexity = time_complexity
+    args.space = space
+    args.space_rank = space_rank
+    args.space_complexity = space_complexity
+
+    p = Problem(args)
+
+    msg = p.create_commit_message()
+    f = tempfile.NamedTemporaryFile(mode='w', delete=False)
+    try:
+        f.write(msg)
+        f.close()
+        git.commit('-F', f.name)
+        os.remove(f.name)
+    except Exception as e:
+        try:
+            os.remove(f.name)
+        except:
+            pass
+        raise e
+
+
+def commit_solution():
+    args = Problem.default_args()
+
+    branch = git.rev_parse('--abbrev-ref', 'HEAD')
+
+    if not branch.startswith('issue/'):
+        raise ValueError('invalid branch name "{}"'.format(branch))
+
+    if len(branch.split('/')) != 3:
+        raise ValueError('invalid branch name "{}"'.format(branch))
+
+    args.issue = branch.split('/')[1]
+    args.name = branch.split('/')[2]
+
+    impl_cpp = args.name + '.cpp'
+
+    with open(impl_cpp) as f:
+        for line in f.readlines():
+            if line.startswith('// difficulty: '):
+                args.difficulty = line.replace('// difficulty: ', '')
+
+    print('Enter the time (ms): ', end='', flush=True)
+    for line in sys.stdin:
+        args.time = int(line.rstrip())
+        break
+
+    print('Enter the time-rank (%): ', end='', flush=True)
+    for line in sys.stdin:
+        args.time = float(line.rstrip())
+        break
+
+    print('Enter the time-complexity: ', end='', flush=True)
+    for line in sys.stdin:
+        args.time_complexity = line.rstrip()
+        break
+
+    print('Enter the space (MB): ', end='', flush=True)
+    for line in sys.stdin:
+        args.space = float(line.rstrip())
+        break
+
+    print('Enter the space-rank (%): ', end='', flush=True)
+    for line in sys.stdin:
+        args.space_rank = float(line.rstrip())
+        break
+
+    print('Enter the space-complexity: ', end='', flush=True)
+    for line in sys.stdin:
+        args.space_complexity = line.rstrip()
+        break
+
+    commit_solution_args(args.issue, args.name, args.difficulty, args.time, args.time_rank,
+                         args.time_complexity, args.space, args.space_rank, args.space_complexity)