Merge lp:~parthm/bzr/403687-shelve-summary-in-status into lp:bzr

[Parth Malwankar]

'bzr status' now displays shelve summary (#403687).

=== Fixes bug #403687 ===
This patch adds a post_status hook to display a one line summary of shelves. If there are no shelves then nothing is displayed.

E.g.
[bzr-grep]% bzr st
modified:
  features.py
3 shelves exist. See "bzr shelve --list" for details.
[bzr-grep]%

[Alexander Belchenko (bialix)]

+* ``bzr status`` now displays a summary of existing shelves after
+ the other status information. This us done using a ``post_status``

This *is* done, I guess.

I think you need to add direct test for list_shelves because it's a new public API.

[Martin Pool (mbp)]

Does this cope with tree types that don't support shelves, or is that
done automatically for all classes?

--
Martin

[Parth Malwankar (parthm)]

> +* ``bzr status`` now displays a summary of existing shelves after
> + the other status information. This us done using a ``post_status``
>
> This *is* done, I guess.
>
> I think you need to add direct test for list_shelves because it's a new public
> API.

Thanks for the review Alexander. I have made the above fixes.

[Parth Malwankar (parthm)]

> Does this cope with tree types that don't support shelves, or is that
> done automatically for all classes?
>

Good point. I am not too sure. What would be a good way to test this?

[Alexander Belchenko (bialix)]

Good for me.

review: Approve

[Vincent Ladeuil (vila)]

Sorry to come late in the game, but I don't understand why list_shelves is needed at all.
Is this because you used it previously for 'bzr status' ?

status needs only a number of shelves so active_shelves() is enough (no need to build more
data just to throw it away).

review: Needs Fixing

[Parth Malwankar (parthm)]

> Sorry to come late in the game, but I don't understand why list_shelves is
> needed at all.
> Is this because you used it previously for 'bzr status' ?
>
> status needs only a number of shelves so active_shelves() is enough (no need
> to build more
> data just to throw it away).

I was not aware of active_shelves. This is definitely shorter and cleaner. Thanks. Fixed.

[Alexander Belchenko (bialix)]

I think Vincent or somebody else should look the last time on the patch and just approve this. I believe Parth has fixed all issues now.

[Vincent Ladeuil (vila)]

Doh !
This looks straight forward now ! Well done.

Check that the NEWS entry is for the right release and land !

review: Approve

[Parth Malwankar (parthm)]

sent to pqm by email

[Parth Malwankar (parthm)]

sent to pqm by email

=== modified file 'NEWS'
--- NEWS	2010-09-24 02:19:28 +0000
+++ NEWS	2010-09-24 15:15:56 +0000
@@ -18,10 +18,15 @@
 
 * Add ``mainline`` revision specifier, which selects the revision that
   merged a specified revision into the mainline.  (Aaron Bentley)
-  
+
 * Add ``annotate`` revision specifier, which selects the revision that
   introduced a specified line of a file.  (Aaron Bentley)
 
+* ``bzr status`` now displays a summary of existing shelves after
+  the other status information. This is done using a ``post_status``
+  hook.
+  (Parth Malwankar, #403687)
+
 Bug Fixes
 *********
 

=== modified file 'bzrlib/shelf.py'
--- bzrlib/shelf.py	2010-04-30 11:03:59 +0000
+++ bzrlib/shelf.py	2010-09-24 15:15:56 +0000
@@ -18,6 +18,8 @@
 import errno
 import re
 
+from bzrlib.lazy_import import lazy_import
+lazy_import(globals(), """
 from bzrlib import (
     bencode,
     errors,
@@ -26,6 +28,7 @@
     pack,
     transform,
 )
+""")
 
 
 class ShelfCreator(object):

=== modified file 'bzrlib/status.py'
--- bzrlib/status.py	2010-08-31 13:49:48 +0000
+++ bzrlib/status.py	2010-09-24 15:15:56 +0000
@@ -398,9 +398,6 @@
             (2, 3), None))
 
 
-hooks = StatusHooks()
-
-
 class StatusHookParams(object):
     """Object holding parameters passed to post_status hooks.
 
@@ -441,3 +438,22 @@
             self.old_tree, self.new_tree, self.to_file, self.versioned,
             self.show_ids, self.short, self.verbose)
 
+
+def _show_shelve_summary(params):
+    """post_status hook to display a summary of shelves.
+
+    :param params: StatusHookParams.
+    """
+    manager = params.new_tree.get_shelf_manager()
+    shelves = manager.active_shelves()
+    if shelves:
+        params.to_file.write('%d shelves exist. '
+            'See "bzr shelve --list" for details.\n' % len(shelves))
+
+
+hooks = StatusHooks()
+
+
+hooks.install_named_hook('post_status', _show_shelve_summary,
+    'bzr status')
+

=== modified file 'bzrlib/tests/blackbox/test_status.py'
--- bzrlib/tests/blackbox/test_status.py	2010-06-24 06:57:31 +0000
+++ bzrlib/tests/blackbox/test_status.py	2010-09-24 15:15:56 +0000
@@ -33,6 +33,7 @@
     conflicts,
     errors,
     osutils,
+    status,
     )
 import bzrlib.branch
 from bzrlib.osutils import pathjoin
@@ -520,6 +521,27 @@
         out, err = self.run_bzr('status branch1 -rbranch:branch2')
         self.assertEqual('', out)
 
+    def test_status_with_shelves(self):
+        """Ensure that _show_shelve_summary handler works.
+        """
+        wt = self.make_branch_and_tree('.')
+        self.build_tree(['hello.c'])
+        wt.add('hello.c')
+        self.run_bzr(['shelve', '--all', '-m', 'foo'])
+        self.build_tree(['bye.c'])
+        wt.add('bye.c')
+        # As TestCase.setUp clears all hooks, we install this default
+        # post_status hook handler for the test.
+        status.hooks.install_named_hook('post_status',
+            status._show_shelve_summary,
+            'bzr status')
+        self.assertStatus([
+                'added:\n',
+                '  bye.c\n',
+                '1 shelves exist. See "bzr shelve --list" for details.\n',
+            ],
+            wt)
+
 
 class CheckoutStatus(BranchStatus):