Merge lp:~allenap/bzr-update-copyright/force-ranges-on-commit into lp:bzr-update-copyright

[Gavin Panella]

Allow optional --force-range behaviour in commit hooks.

[Richard Wilbur (richard-wilbur)]

I like the changes. Please update the documentation in __init__.py docstring to describe the new capability. If you can't get to that right now, let me know and I can do it.

review: Needs Fixing

[lp:~allenap/bzr-update-copyright/force-ranges-on-commit]

18. By Gavin Panella on 2016-05-31

Update documentation for commit hook.

[Gavin Panella (allenap)]

> Please update the documentation in __init__.py docstring to describe
> the new capability.

Done.

Thanks!

[Richard Wilbur (richard-wilbur)]

Looks great, Gavin! Thanks for the new, documented functionality.
+2

review: Approve

[Gavin Panella (allenap)]

Richard, I don't have write access to lp:bzr-update-copyright. Would you merge it for me? Thanks.

[Richard Wilbur (richard-wilbur)]

Gavin, I'll be happy to merge it for you tomorrow. I've been very
busy lately or I would have merged it the day I approved it.

[Gavin Panella (allenap)]

Thanks, that's grand.

=== modified file '__init__.py'
--- __init__.py	2015-05-07 11:37:32 +0000
+++ __init__.py	2016-05-31 19:12:18 +0000
@@ -34,6 +34,7 @@
     mutabletree,  # I wish we could make the hook registration fully lazy
     option,
     trace,
+    ui,
     )
 
 version_info = (0, 1, 0, 'dev', 0)
@@ -88,16 +89,33 @@
 def _update_copyright_start_commit_hook(tree):
     """A hook that will update copyrights at commit time.
 
-    This is configured via "auto_update_copyright=True" in your configuration
-    files.
+    This is configured by setting "auto_update_copyright" in your
+    configuration files:
+
+      # Update copyright headers in changed files when committing:
+      auto_update_copyright = true
+
+      # As above, but force the use of a range of years, like
+      # using --force-range at the command-line.
+      auto_update_copyright = force-range
+
+      # Don't update copyright headers; override configuration
+      # set in a wider scope.
+      auto_update_copyright = false
+
     """
     conf = tree.branch.get_config()
-    auto_update = conf.get_user_option_as_bool('auto_update_copyright')
-    if auto_update is None or not auto_update:
+    auto_update = conf.get_user_option('auto_update_copyright')
+    if ui.bool_from_string(auto_update):
+        force_range = False
+    elif auto_update == "force-range":
+        force_range = True
+    else:
         trace.mutter('Auto-update set to %s' % (auto_update,))
         return
     import update_copyright
-    res = update_copyright.update_tree_copyright(tree, None, only_changed=True)
+    res = update_copyright.update_tree_copyright(
+        tree, None, only_changed=True, force_range=force_range)
     # TODO: Consider only muttering if something is actually changed...
     trace.mutter('Auto-updating copyright:\n'
                  '  Checked %(count)d files\n'

=== modified file 'test_update_copyright.py'
--- test_update_copyright.py	2015-05-07 11:37:32 +0000
+++ test_update_copyright.py	2016-05-31 19:12:18 +0000
@@ -368,6 +368,23 @@
         self.assertFileEqual('Copyright 2008 Bar\n'
                              'content\n', 'dir/subdir/foo')
 
+    def test_auto_update_hook_disabled_with_false(self):
+        t, rev_ids = self.make_tree_with_dirs_modified()
+        # We have to install it here, because the test suite clears out hooks
+        # as part of its isolation mechanism.
+        mutabletree.MutableTree.hooks.install_named_hook(
+            'start_commit', _update_copyright_start_commit_hook,
+            'update-copyright')
+        t.branch.get_config().set_user_option('auto_update_copyright', 'false')
+        # Without a false-like config, nothing should be modified.
+        t.commit('Modified content')
+        self.assertFileEqual('Copyright (c) 2008 Foo Bar\n'
+                             'different content\n', 'file')
+        self.assertFileEqual('Copyright 2008 Foo\r\n'
+                             'modified content\r\n', 'dir/file')
+        self.assertFileEqual('Copyright 2008 Bar\n'
+                             'content\n', 'dir/subdir/foo')
+
     def test_auto_update_hook_enabled(self):
         t, rev_ids = self.make_tree_with_dirs_modified()
         # We have to install it here, because the test suite clears out hooks
@@ -381,6 +398,20 @@
         # modified file
         self.check_tree_with_dirs_modified()
 
+    def test_auto_update_hook_enabled_with_force_range(self):
+        t, rev_ids = self.make_tree_with_dirs_modified()
+        # We have to install it here, because the test suite clears out hooks
+        # as part of its isolation mechanism.
+        mutabletree.MutableTree.hooks.install_named_hook(
+            'start_commit', _update_copyright_start_commit_hook,
+            'update-copyright')
+        t.branch.get_config().set_user_option(
+            'auto_update_copyright', 'force-range')
+        t.commit('Modified content')
+        # With the hook enabled, commit should update the copyright in the
+        # modified file
+        self.check_tree_with_dirs_modified_using_ranges()
+
     def test_blackbox(self):
         t, rev_ids = self.make_old_modified_tree()
         # We need to unlock so that run_bzr can grab a lock