Merge lp:~mbp/bzr/611127-2.2-progress into lp:bzr/2.2

[Martin Pool]

fix bug 611127, clearing progress bars

Fix a regression with progress bars not being cleared off properly. This just restores this method pretty much to how it was in 2.1.

I would like to merge this before 2.2.0.

Fixes https://bugs.edge.launchpad.net/bzr/+bug/611127

[Robert Collins (lifeless)]

+1

[Andrew Bennetts (spiv)]

I suppose theoretically if _avail_width is None this could remember the width of the last uncleared message(s), but then terminals that can't report widths probably aren't used here anyway. Anyway, this seems like a clear and simple improvement, so +1.

review: Approve

[Martin Pool (mbp)]

sent to pqm by email

=== modified file 'NEWS'
--- NEWS	2010-08-02 19:56:52 +0000
+++ NEWS	2010-08-05 08:31:42 +0000
@@ -5,11 +5,11 @@
 .. contents:: List of Releases
    :depth: 1
 
-bzr 2.2rc1
-##########
+bzr 2.2.0
+#########
 
 :Codename: ???
-:2.2rc1: NOT RELEASED YET
+:2.2.0: NOT RELEASED YET
 
 Compatibility Breaks
 ********************
@@ -48,7 +48,8 @@
 
 * Progress bars prefer to truncate the text message rather than the
   counters.  The spinner is shown between the network transfer indicator
-  and the progress message.  (Martin Pool)
+  and the progress message.  Progress bars are correctly cleared off when 
+  they finish.  (Martin Pool, #611127)
 
 * Recursive binding for checkouts is now detected by bzr. A clear error
   message is shown to the user. (Parth Malwankar, #405192)

=== modified file 'bzrlib/tests/test_progress.py'
--- bzrlib/tests/test_progress.py	2010-07-09 15:47:01 +0000
+++ bzrlib/tests/test_progress.py	2010-08-05 08:31:42 +0000
@@ -70,6 +70,21 @@
         task.total_cnt = total
         return task
 
+    def test_clear(self):
+        # <https://bugs.launchpad.net/bzr/+bug/611127> clear must actually
+        # send spaces to clear the line
+        out, view = self.make_view()
+        task = self.make_task(None, view, 'reticulating splines', 5, 20)
+        view.show_progress(task)
+        self.assertEqual(
+'\r/ reticulating splines 5/20                                                    \r'
+            , out.getvalue())
+        view.clear()
+        self.assertEqual(
+'\r/ reticulating splines 5/20                                                    \r'
+            + '\r' + 79 * ' ' + '\r',
+            out.getvalue())
+
     def test_render_progress_no_bar(self):
         """The default view now has a spinner but no bar."""
         out, view = self.make_view()

=== modified file 'bzrlib/ui/text.py'
--- bzrlib/ui/text.py	2010-07-09 15:47:01 +0000
+++ bzrlib/ui/text.py	2010-08-05 08:31:42 +0000
@@ -304,11 +304,15 @@
         # we need one extra space for terminals that wrap on last char
         w = osutils.terminal_width() 
         if w is None:
-            return w
+            return None
         else:
             return w - 1
 
     def _show_line(self, s):
+        # sys.stderr.write("progress %r\n" % s)
+        width = self._avail_width()
+        if width is not None:
+            s = '%-*.*s' % (width, width, s)
         self._term_file.write('\r' + s + '\r')
 
     def clear(self):