Merge lp:~vila/bzr-update-copyright/506041-copyright-5-first-lines into lp:bzr-update-copyright

[Vincent Ladeuil]

Support copyright line in the 5 first lines of the project.

This fix allows the copyright lines to be in the 5 first lines of a file.

It also fixes compatibility with recent bzr versions.

I've been using this fix for quite some time now (uncommitted in my local version, bad vila ;)

[Vincent Ladeuil (vila)]

Forget the compatibility bit, I didn't noticed the same fix was already in trunk (which I discovered when fixing the conflicts ;-)

[lp:~vila/bzr-update-copyright/506041-copyright-5-first-lines]

14. By Vincent Ladeuil on 2014-04-10

Merge trunk resolving conflicts.

[John A Meinel (jameinel)]

review: Approve

=== modified file '__init__.py'
--- __init__.py	2013-05-02 16:17:25 +0000
+++ __init__.py	2014-04-10 08:19:04 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Canonical Ltd
+# Copyright (C) 2010, 2014 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
@@ -67,7 +67,6 @@
 
         tree, relpaths = workingtree.WorkingTree.open_containing_paths(
             path_list)
-
         if relpaths == ['']:
             # Selecting just the root selects everything
             relpaths = None

=== modified file 'test_update_copyright.py'
--- test_update_copyright.py	2010-01-12 16:05:09 +0000
+++ test_update_copyright.py	2014-04-10 08:19:04 +0000
@@ -160,6 +160,37 @@
         self.assertFileEqual('Copyright (c) 2008, 2009, %d Foo Bar\n'
                              'different content\n' % (year,), 'file')
 
+    def test_update_copyright_not_first_line(self):
+        t, rev_ids = self.make_old_modified_tree()
+        self.build_tree_contents([('file',
+            '\n\n\nCopyright (c) 2008 Foo Bar\nultimate content\n')])
+        rev_ids.append(
+            t.commit('remod file', timestamp=1231353864, timezone=0)) # 2010
+        bt = t.basis_tree()
+        bt.lock_read()
+        self.addCleanup(bt.unlock)
+        self.assertEqual('updated',
+                         update_copyright.update_copyright(t, bt, 'file'))
+        year = datetime.datetime.now().year
+        self.assertFileEqual(
+            '\n\n\nCopyright (c) 2008, 2009, %d Foo Bar\n'
+            'ultimate content\n' % (year,), 'file')
+
+    def test_update_copyright_after_max_line(self):
+        t, rev_ids = self.make_old_modified_tree()
+        self.build_tree_contents([('file',
+            '\n\n\n\n\nCopyright (c) 2008 Foo Bar\nultimate content\n')])
+        rev_ids.append(
+            t.commit('remod file', timestamp=1231353864, timezone=0)) # 2010
+        bt = t.basis_tree()
+        bt.lock_read()
+        self.addCleanup(bt.unlock)
+        self.assertEqual('no-copyright',
+                         update_copyright.update_copyright(t, bt, 'file'))
+        self.assertFileEqual(
+            '\n\n\n\n\nCopyright (c) 2008 Foo Bar\n'
+            'ultimate content\n', 'file')
+
     def test_no_copyright(self):
         t, rev_ids = self.make_old_modified_tree()
         self.build_tree_contents([('file', 'No cc line\n')])

=== modified file 'update_copyright.py'
--- update_copyright.py	2010-01-12 16:05:09 +0000
+++ update_copyright.py	2014-04-10 08:19:04 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Canonical Ltd
+# Copyright (C) 2010, 2014 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
@@ -143,10 +143,19 @@
         return 'not-versioned'
     this_year = datetime.datetime.now().year
     f = tree.get_file(file_id, path=filename)
+    max_lines = 5
+    cur_line = 0
+    before_copyright = ''
+    copyright_line = None
     try:
-        copyright_line = f.readline()
-        m = copyright_re.match(copyright_line)
-        if m is None:
+        while copyright_line is None and cur_line < max_lines:
+            copyright_line = f.readline()
+            cur_line += 1
+            m = copyright_re.match(copyright_line)
+            if m is None:
+                before_copyright += copyright_line
+                copyright_line = None
+        if copyright_line is None:
             return 'no-copyright'
         # Determine the actual dates that this file was modified
         # There really should be a better way to determine the revision of a
@@ -178,7 +187,7 @@
             # It seems this may already be updated
             if copyright_line == new_copyright_line:
                 return 'copyright-correct'
-        new_content = new_copyright_line + f.read()
+        new_content = before_copyright + new_copyright_line + f.read()
     finally:
         f.close()
     # TODO: We could probably do this 'safer' with a big TreeTransform over