Merge lp:~richard-wilbur/bzr/branches-uncommitted into lp:bzr

[Richard Wilbur]

Fixed up Aaron Bentley's branches-uncommitted code (from 2 years ago) to merge into current trunk.

Updated Aaron Bentley's branches-uncommitted branch from 2013 to work with new trunk: 2 new tests on trunk failed because of change in 'branches' command output formatting and content. Fixed regression in test suite caused by unintentional change in behaviour of 'branches' command (original behaviour restored). Added documentation for status flags in output.

Implemented John Arbash-Meinel's recommendation for code style uniformity.

[lp:~richard-wilbur/bzr/branches-uncommitted]

6608. By Richard Wilbur on 2015-05-19

Provide a little more explanation in documentation.

6609. By Richard Wilbur on 2015-05-20

Update copyright dates.

[Richard Wilbur (richard-wilbur)]

John, you and I had already approved of Aaron Bentley's changes that this branch is based on--with the suggestion of reformatting part of it to make the code style more consistent.

I fixed an unnoticed regression in that code, the attendant bit rot of two years, and added a little polish to the documentation.

[Richard Wilbur (richard-wilbur)]

I guess John is pretty busy. On the authority that the concept was already approved and these are relatively trivial changes, I'll approve this and go ahead an merge it.

review: Approve (concept already approved on another branch.)

[Richard Wilbur (richard-wilbur)]

sent to pqm by email

[Vincent Ladeuil (vila)]

I can't help but think that 'uncommitted' in not part of the branch domain.

I can see dragons around shelves rotting in side a branch.

shelves are working tree related, it's expected that they rot there and the tools to deal with that are related to working trees.

If one want to keep some unfinished work, I can't see the cons about committing it.

As a bzr user I know how to resume work from this revision as well as stepping back from it to continue work without that revision.

review: Needs Fixing

Unmerged revisions

6609. By Richard Wilbur on 2015-05-20

Update copyright dates.

6608. By Richard Wilbur on 2015-05-19

Provide a little more explanation in documentation.

6607. By Richard Wilbur on 2015-05-08

Make boolean->visual flag conversion with consistent syntax. Document flags.

6606. By Richard Wilbur on 2015-05-08

Fix branches command handling of active flags.

6605. By Richard Wilbur on 2015-05-08

Fix 2 trivial test failures simply due to change in branches output format.

6604. By Richard Wilbur on 2015-05-07

Show uncommitted changes in branches.(Aaron Bentley) Suffers from some test breakage(3).

=== modified file 'bzrlib/branch.py'
--- bzrlib/branch.py	2013-05-23 10:04:17 +0000
+++ bzrlib/branch.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2005-2012 Canonical Ltd
+# Copyright (C) 2005-2013, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -261,6 +261,9 @@
         """
         raise NotImplementedError(self.store_uncommitted)
 
+    def has_uncommitted(self):
+        return False
+
     def get_unshelver(self, tree):
         """Return a shelf.Unshelver for this branch and tree.
 
@@ -2412,6 +2415,10 @@
         else:
             return self
 
+    @staticmethod
+    def _has_uncommitted(branch):
+        return branch._transport.has('stored-transform')
+
     def store_uncommitted(self, creator):
         """Store uncommitted changes from a ShelfCreator.
 
@@ -2423,13 +2430,17 @@
         if creator is None:
             branch._transport.delete('stored-transform')
             return
-        if branch._transport.has('stored-transform'):
+        if self._has_uncommitted(branch):
             raise errors.ChangesAlreadyStored
         transform = StringIO()
         creator.write_shelf(transform)
         transform.seek(0)
         branch._transport.put_file('stored-transform', transform)
 
+    def has_uncommitted(self):
+        branch = self._uncommitted_branch()
+        return self._has_uncommitted(branch)
+
     def get_unshelver(self, tree):
         """Return a shelf.Unshelver for this branch and tree.
 
 
=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py	2013-05-23 10:04:17 +0000
+++ bzrlib/builtins.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2005-2012 Canonical Ltd
+# Copyright (C) 2005-2013, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -1547,7 +1547,8 @@
     __doc__ = """List the branches available at the current location.
 
     This command will print the names of all the branches at the current
-    location.
+    location.  Flags colocated branches:  '*' for active (current working
+    tree) and 'U' for uncommitted changes.
     """
 
     takes_args = ['location?']
@@ -1578,17 +1579,17 @@
                     continue
                 active = (active_branch is not None and
                           active_branch.base == branch.base)
-                names[name] = active
+                names[name] = active, branch.has_uncommitted()
+            branch_list = sorted(names.items())
             # Only mention the current branch explicitly if it's not
             # one of the colocated branches
-            if not any(names.values()) and active_branch is not None:
-                self.outf.write("* %s\n" % gettext("(default)"))
-            for name in sorted(names.keys()):
-                active = names[name]
-                if active:
-                    prefix = "*"
-                else:
-                    prefix = " "
+            if not any([active for (active, u) in names.values()]) and active_branch is not None:
+                branch_list.insert(0,
+                    (gettext("(default)"),
+                        (True, active_branch.has_uncommitted())))
+            for name, (active, uncommitted) in branch_list:
+                prefix = "*" if active else " "
+                prefix += 'U' if uncommitted else ' '
                 self.outf.write("%s %s\n" % (
                     prefix, name.encode(self.outf.encoding)))
 
 
=== modified file 'bzrlib/remote.py'
--- bzrlib/remote.py	2012-09-19 07:58:27 +0000
+++ bzrlib/remote.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2006-2012 Canonical Ltd
+# Copyright (C) 2006-2013, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -3403,6 +3403,10 @@
         self._ensure_real()
         return self._real_branch.store_uncommitted(creator)
 
+    def has_uncommitted(self):
+        self._ensure_real()
+        return self._real_branch.has_uncommitted()
+
     def get_unshelver(self, tree):
         self._ensure_real()
         return self._real_branch.get_unshelver(tree)
 
=== modified file 'bzrlib/tests/blackbox/test_branch.py'
--- bzrlib/tests/blackbox/test_branch.py	2012-02-23 23:26:35 +0000
+++ bzrlib/tests/blackbox/test_branch.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2006-2012 Canonical Ltd
+# Copyright (C) 2006-2012, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -87,7 +87,7 @@
         self.assertEqual('', out)
         self.assertEqual('Branched 2 revisions.\n', err)
         out, err = self.run_bzr('branches b')
-        self.assertEqual("  orig\n  thiswasa\n", out)
+        self.assertEqual("   orig\n   thiswasa\n", out)
         self.assertEqual('', err)
         out,err = self.run_bzr('branch a file:b,branch=orig', retcode=3)
         self.assertEqual('', out)
 
=== modified file 'bzrlib/tests/blackbox/test_branches.py'
--- bzrlib/tests/blackbox/test_branches.py	2012-02-13 17:34:46 +0000
+++ bzrlib/tests/blackbox/test_branches.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2011 Canonical Ltd
+# Copyright (C) 2011-2013, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -19,6 +19,7 @@
 
 from bzrlib.bzrdir import BzrDir
 from bzrlib.tests import TestCaseWithTransport
+from bzrlib.tests.per_branch.test_branch import FakeShelfCreator
 
 
 class TestBranches(TestCaseWithTransport):
@@ -28,7 +29,7 @@
         # support.
         self.run_bzr('init a')
         out, err = self.run_bzr('branches a')
-        self.assertEquals(out, "* (default)\n")
+        self.assertEquals(out, "*  (default)\n")
 
     def test_no_branch(self):
         # Listing the branches in a control directory without branches.
@@ -65,9 +66,9 @@
         t.bzrdir.create_branch(name='another')
         t.bzrdir.create_branch(name='colocated')
         out, err = self.run_bzr('branches a')
-        self.assertEquals(out, "* (default)\n"
-                               "  another\n"
-                               "  colocated\n")
+        self.assertEquals(out, "*  (default)\n"
+                               "   another\n"
+                               "   colocated\n")
 
     def test_indicates_branch(self):
         t = self.make_repository('a', format='development-colo')
@@ -75,8 +76,18 @@
         branch = t.bzrdir.create_branch(name='colocated')
         t.bzrdir.set_branch_reference(target_branch=branch)
         out, err = self.run_bzr('branches a')
-        self.assertEquals(out, "  another\n"
-                               "* colocated\n")
+        self.assertEquals(out, "   another\n"
+                               "*  colocated\n")
+
+    def test_indicates_uncommitted(self):
+        t = self.make_repository('a', format='development-colo')
+        t.bzrdir.create_branch(name='another')
+        branch = t.bzrdir.create_branch(name='colocated')
+        branch.store_uncommitted(FakeShelfCreator(branch))
+        t.bzrdir.set_branch_reference(target_branch=branch)
+        out, err = self.run_bzr('branches a')
+        self.assertEquals(out, "   another\n"
+                               "*U colocated\n")
 
     def test_shared_repos(self):
         self.make_repository('a', shared=True)
@@ -84,10 +95,26 @@
         b = BzrDir.create_branch_convenience('a/branch2')
         b.create_checkout(lightweight=True, to_location='b')
         out, err = self.run_bzr('branches b')
-        self.assertEquals(out, "  branch1\n"
-                               "* branch2\n")
+        self.assertEquals(out, "   branch1\n"
+                               "*  branch2\n")
+
+    def test_shared_repos_uncommitted(self):
+        self.make_repository('a', shared=True)
+        BzrDir.create_branch_convenience('a/branch1')
+        b = BzrDir.create_branch_convenience('a/branch2')
+        b.create_checkout(lightweight=True, to_location='b')
+        b.store_uncommitted(FakeShelfCreator(b))
+        out, err = self.run_bzr('branches b')
+        self.assertEquals(out, "   branch1\n"
+                               "*U branch2\n")
 
     def test_standalone_branch(self):
         self.make_branch('a')
         out, err = self.run_bzr('branches a')
-        self.assertEquals(out, "* (default)\n")
+        self.assertEquals(out, "*  (default)\n")
+
+    def test_standalone_branch_uncommitted(self):
+        b = self.make_branch('a')
+        b.store_uncommitted(FakeShelfCreator(b))
+        out, err = self.run_bzr('branches a')
+        self.assertEquals(out, "*U (default)\n")
 
=== modified file 'bzrlib/tests/blackbox/test_init.py'
--- bzrlib/tests/blackbox/test_init.py	2012-08-23 14:24:38 +0000
+++ bzrlib/tests/blackbox/test_init.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2006-2011 Canonical Ltd
+# Copyright (C) 2006-2012, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -61,7 +61,7 @@
             out)
         self.assertEqual('', err)
         out, err = self.run_bzr('branches')
-        self.assertEqual("  abranch\n", out)
+        self.assertEqual("   abranch\n", out)
         self.assertEqual('', err)
 
     def test_init_at_repository_root(self):
 
=== modified file 'bzrlib/tests/per_branch/test_branch.py'
--- bzrlib/tests/per_branch/test_branch.py	2012-07-19 19:27:22 +0000
+++ bzrlib/tests/per_branch/test_branch.py	2015-05-20 19:29:33 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2005-2012 Canonical Ltd
+# Copyright (C) 2005-2013, 2015 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -1125,6 +1125,15 @@
         branch.store_uncommitted(None)
         self.assertIs(None, branch.get_unshelver(None))
 
+    def test_has_uncommitted(self):
+        branch = self.make_branch('b')
+        self.assertFalse(branch.has_uncommitted())
+        with skip_if_storing_uncommitted_unsupported():
+            branch.store_uncommitted(FakeShelfCreator(branch))
+        self.assertTrue(branch.has_uncommitted())
+        branch.store_uncommitted(None)
+        self.assertFalse(branch.has_uncommitted())
+
     def test_get_unshelver(self):
         tree = self.make_branch_and_tree('tree')
         tree.commit('')