Fix issue #1 and #2

This makes the git-sweep help menus more useful and also addresses an
issue where the command that git-sweep recommended you use to cleanup
was missing the arguments that you may have used to preview. This could
have some nasty side effects.

Author: robmadole

README.rst

@@ -103,7 +103,7 @@ Tell it to skip the ``git fetch`` that it does by default.
 
       branch1
 
-    To delete them, run again with `git-sweep cleanup`
+    To delete them, run again with `git-sweep cleanup --nofetch`
 
 Make it skip certain branches.
 
@@ -117,7 +117,36 @@ Make it skip certain branches.
       upgrade-libs
       derp-removal
 
-    To delete them, run again with `git-sweep cleanup`
+    To delete them, run again with `git-sweep cleanup --skip=develop`
+
+Once git-sweep finds the branches, you'll be asked to confirm that you wish to
+delete them.
+
+::
+
+    Delete these branches? (y/n)
+
+You can use the ``--force`` option to bypass this and start deleting
+immediately.
+
+::
+
+    $ git-sweep cleanup --skip=develop --force
+    Fetching from the remote
+    These branches have been merged into master:
+
+      important-upgrade
+      upgrade-libs
+      derp-removal
+
+      deleting important-upgrade (done)
+      deleting upgrade-libs (done)
+      deleting derp-removal (done)
+
+    All done!
+
+    Tell everyone to run `git fetch --prune` to sync with this remote.
+    (you don't have to, yours is synced)
 
 Development
 -----------
@@ -138,16 +167,23 @@ To run the tests, bootstrap Buildout and run this command:
     ...
     $ ./bin/test
 
+We also use Tox_. It will run the tests for Python 2.6 and 2.7.
+
+::
+
+    $ ./bin/tox
+
 Requirements
 ------------
 
 * Git >= 1.7
 * Python >= 2.6
 
-.. _GitHub Flow: http://scottchacon.com/2011/08/31/github-flow.html
-.. _git-flow: http://nvie.com/posts/a-successful-git-branching-model/
-
 License
 -------
 
 Friendly neighborhood MIT license.
+
+.. _GitHub Flow: http://scottchacon.com/2011/08/31/github-flow.html
+.. _git-flow: http://nvie.com/posts/a-successful-git-branching-model/
+.. _Tox: http://pypi.python.org/pypi/tox

src/gitsweep/cli.py

@@ -1,6 +1,7 @@
 import sys
 from os import getcwd
 from argparse import ArgumentParser
+from textwrap import dedent
 
 from git import Repo, InvalidGitRepositoryError
 
@@ -15,8 +16,9 @@ class CommandLine(object):
 
     """
     parser = ArgumentParser(
-        description='Clean up your Git repository remote branches',
-        prog='git-sweep')
+        description='Clean up your Git remote branches.',
+        usage='git-sweep <action> [-h]',
+        )
 
     _sub_parsers = parser.add_subparsers(title='action',
         description='Preview changes or perform clean up')
@@ -42,16 +44,30 @@ class CommandLine(object):
         'action': 'store_false',
         'default': True}
 
+    _preview_usage = dedent('''
+        git-sweep preview [-h] [--nofetch] [--skip SKIPS]
+                              [--master MASTER] [--origin ORIGIN]
+        '''.strip())
+
     _preview = _sub_parsers.add_parser('preview',
-        help='Preview the branches that will be deleted')
+        help='Preview the branches that will be deleted',
+        usage=_preview_usage)
     _preview.add_argument('--origin', **_origin_kwargs)
     _preview.add_argument('--master', **_master_kwargs)
     _preview.add_argument('--nofetch', **_no_fetch_kwargs)
     _preview.add_argument('--skip', **_skip_kwargs)
     _preview.set_defaults(action='preview')
 
+    _cleanup_usage = dedent('''
+        git-sweep cleanup [-h] [--nofetch] [--skip SKIPS] [--force]
+                              [--master MASTER] [--origin ORIGIN]
+        '''.strip())
+
     _cleanup = _sub_parsers.add_parser('cleanup',
-        help='Delete merged branches from the remote')
+        help='Delete merged branches from the remote',
+        usage=_cleanup_usage)
+    _cleanup.add_argument('--force', action='store_true', default=False,
+        dest='force', help='Do not ask, cleanup immediately')
     _cleanup.add_argument('--origin', **_origin_kwargs)
     _cleanup.add_argument('--master', **_master_kwargs)
     _cleanup.add_argument('--nofetch', **_no_fetch_kwargs)
@@ -66,6 +82,10 @@ def run(self):
         Runs git-sweep.
         """
         try:
+            if not self.args:
+                self.parser.print_help()
+                sys.exit(1)
+
             self._sweep()
 
             sys.exit(0)
@@ -120,9 +140,10 @@ def _sweep(self):
             deleter = Deleter(repo, remote_name=remote_name,
                 master_branch=master_branch)
 
-            sys.stdout.write('\nDelete these branches? (y/n) ')
-            answer = raw_input()
-            if answer.lower().startswith('y'):
+            if not args.force:
+                sys.stdout.write('\nDelete these branches? (y/n) ')
+                answer = raw_input()
+            if args.force or answer.lower().startswith('y'):
                 sys.stdout.write('\n')
                 for ref in ok_to_delete:
                     sys.stdout.write('  deleting {0}'.format(ref.remote_head))
@@ -136,5 +157,10 @@ def _sweep(self):
             else:
                 sys.stdout.write('\nOK, aborting.\n')
         elif ok_to_delete:
+            # Replace the first argument with cleanup
+            sysv_copy = self.args[:]
+            sysv_copy[0] = 'cleanup'
+            command = 'git-sweep {0}'.format(' '.join(sysv_copy))
+
             sys.stdout.write(
-                '\nTo delete them, run again with `git-sweep cleanup`\n')
+                '\nTo delete them, run again with `{0}`\n'.format(command))

src/gitsweep/tests/test_cli.py

@@ -1,5 +1,4 @@
 from mock import patch
-from nose.plugins.attrib import attr
 
 from gitsweep.tests.testcases import CommandTestCase
 
@@ -17,9 +16,9 @@ def test_help(self):
         (retcode, stdout, stderr) = self.gscommand('git-sweep -h')
 
         self.assertResults('''
-            usage: git-sweep [-h] {preview,cleanup} ...
+            usage: git-sweep <action> [-h]
 
-            Clean up your Git repository remote branches
+            Clean up your Git remote branches.
 
             optional arguments:
               -h, --help         show this help message and exit
@@ -80,6 +79,35 @@ def test_will_preview(self):
             To delete them, run again with `git-sweep cleanup`
             ''', stdout)
 
+    def test_will_preserve_arguments(self):
+        """
+        The recommended cleanup command contains the same arguments given.
+        """
+        for i in range(1, 6):
+            self.command('git checkout -b branch{0}'.format(i))
+            self.make_commit()
+            self.command('git checkout master')
+            self.make_commit()
+            self.command('git merge branch{0}'.format(i))
+
+        preview = 'git-sweep preview --master=master --origin=origin'
+        cleanup = 'git-sweep cleanup --master=master --origin=origin'
+
+        (retcode, stdout, stderr) = self.gscommand(preview)
+
+        self.assertResults('''
+            Fetching from the remote
+            These branches have been merged into master:
+
+              branch1
+              branch2
+              branch3
+              branch4
+              branch5
+
+            To delete them, run again with `{0}`
+            '''.format(cleanup), stdout)
+
     def test_will_preview_none_found(self):
         """
         Will preview the proposed deletes.
@@ -131,7 +159,7 @@ def test_will_cleanup(self):
             All done!
 
             Tell everyone to run `git fetch --prune` to sync with this remote.
-            (you don't have to, your's is synced)
+            (you don't have to, yours is synced)
             ''', stdout)
 
     def test_will_abort_cleanup(self):
@@ -163,7 +191,6 @@ def test_will_abort_cleanup(self):
             OK, aborting.
             ''', stdout)
 
-    @attr('focus')
     def test_will_skip_certain_branches(self):
         """
         Can be forced to skip certain branches.
@@ -178,6 +205,8 @@ def test_will_skip_certain_branches(self):
         (retcode, stdout, stderr) = self.gscommand(
             'git-sweep preview --skip=branch1,branch2')
 
+        cleanup = 'git-sweep cleanup --skip=branch1,branch2'
+
         self.assertResults('''
             Fetching from the remote
             These branches have been merged into master:
@@ -186,5 +215,40 @@ def test_will_skip_certain_branches(self):
               branch4
               branch5
 
-            To delete them, run again with `git-sweep cleanup`
+            To delete them, run again with `{0}`
+            '''.format(cleanup), stdout)
+
+    def test_will_force_clean(self):
+        """
+        Will cleanup immediately if forced.
+        """
+        for i in range(1, 6):
+            self.command('git checkout -b branch{0}'.format(i))
+            self.make_commit()
+            self.command('git checkout master')
+            self.make_commit()
+            self.command('git merge branch{0}'.format(i))
+
+        (retcode, stdout, stderr) = self.gscommand('git-sweep cleanup --force')
+
+        self.assertResults('''
+            Fetching from the remote
+            These branches have been merged into master:
+
+              branch1
+              branch2
+              branch3
+              branch4
+              branch5
+
+              deleting branch1 (done)
+              deleting branch2 (done)
+              deleting branch3 (done)
+              deleting branch4 (done)
+              deleting branch5 (done)
+
+            All done!
+
+            Tell everyone to run `git fetch --prune` to sync with this remote.
+            (you don't have to, yours is synced)
             ''', stdout)