Merge lp:~jelmer/brz/bundle-commitfromnews into lp:brz

[Jelmer Vernooij]

Bundle the bzr-commitfromnews plugin.

Bundle the bzr-commitfromnews plugin.

I've changed the behaviour slightly so you have to set the "commit.template_from_files" setting to a shell glob rather than it being enabled by default.

To use with bzr:

echo "commit.template_from_files = doc/en/release-notes/*.txt" >> .bzr/branch/branch.conf

[Martin Packman (gz)]

Bundling seems fine, couple of issues inline.

review: Approve

=== added directory 'breezy/plugins/commitfromnews'
=== added file 'breezy/plugins/commitfromnews/__init__.py'
--- breezy/plugins/commitfromnews/__init__.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/commitfromnews/__init__.py	2017-07-23 22:07:30 +0000
@@ -0,0 +1,86 @@
+# Copyright (C) 2010 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""bzr-commitfromnews - make commit messages from the changes in a NEWS file.
+
+commitfromnews is enabled by default when installed.
+
+To use, set the ``commit.template_from_files`` setting to a path and
+just do a commit where the NEWS file for your project has a new section
+added without providing a message to commit.
+
+E.g.::
+  $ echo "commit.template_from_files = NEWS" >> .bzr/branch/branch.conf
+  $ echo "\n* new thing\n" >> NEWS
+  $ bzr commit
+  # editor pops open to let you tweak the message, and it starts with
+    "* new thing" as the message to edit.
+
+commitfromnews attempts to create a sensible default commit message by
+including sections from a NEWS or ChangeLog file.
+"""
+
+from __future__ import absolute_import
+
+from ... import hooks
+from ...config import (
+    option_registry,
+    ListOption,
+    )
+
+option_registry.register(
+    ListOption('commit.template_from_files', default=[], help="""\
+List of fnmatch(2)-style shell file patterns to use when creating commit
+templates.
+"""))
+
+
+def commit_template(commit, message):
+    """Create a commit message for commit based on changes in the tree."""
+    config_stack = commit.work_tree.get_config_stack()
+    filespec = config_stack.get('commit.template_from_files')
+    if filespec:
+        from .committemplate import CommitTemplate
+        template = CommitTemplate(commit, message, filespec)
+        return template.make()
+    return message
+
+
+def load_tests(loader, basic_tests, pattern):
+    testmod_names = [
+        'tests',
+        ]
+    basic_tests.addTest(loader.loadTestsFromModuleNames(
+            ["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
+    return basic_tests
+
+
+_registered = False
+
+
+def register():
+    """Register the plugin."""
+    global _registered
+    # Does not check registered because only tests call this, and they are
+    # isolated.
+    _registered = True
+    hooks.install_lazy_named_hook(
+        'breezy.msgeditor', 'hooks',
+        'commit_message_template',
+        commit_template, 'commitfromnews template')
+
+
+register()

=== added file 'breezy/plugins/commitfromnews/committemplate.py'
--- breezy/plugins/commitfromnews/committemplate.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/commitfromnews/committemplate.py	2017-07-23 22:07:30 +0000
@@ -0,0 +1,110 @@
+# Copyright (C) 2010 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Logic to create commit templates."""
+
+from __future__ import absolute_import
+
+from ... import bugtracker, osutils, patiencediff
+import re
+
+_BUG_MATCH = re.compile(r'lp:(\d+)')
+
+
+class CommitTemplate(object):
+
+    def __init__(self, commit, message, file_matches):
+        """Create a commit template for commit with initial message message.
+
+        :param commit: A Commit object for the in progress commit.
+        :param message: The current message (which may be None).
+        :param file_matches: Check whether file matches
+        """
+        self.commit = commit
+        self.message = message
+        self.file_matches = file_matches
+
+    def make(self):
+        """Make the template.
+
+        If NEWS is missing or not not modified, the original template is
+        returned unaltered. Otherwise the changes from NEWS are concatenated
+        with whatever message was provided to __init__.
+        """
+        delta = self.commit.builder.get_basis_delta()
+        found_old_path = None
+        found_entry = None
+        for old_path, new_path, fileid, entry in delta:
+            if self.file_matches(new_path):
+                found_entry = entry
+                found_old_path = old_path
+                break
+        if not found_entry:
+            return self.message
+        if found_old_path is None:
+            # New file
+            _, new_chunks = list(
+                self.commit.builder.repository.iter_files_bytes(
+                    [(found_entry.file_id, found_entry.revision, None)]))[0]
+            content = ''.join(new_chunks)
+            return self.merge_message(content)
+        else:
+            # Get a diff. XXX Is this hookable? I thought it was, can't find it
+            # though.... add DiffTree.diff_factories. Sadly thats not at the 
+            # right level: we want to identify the changed lines, not have the
+            # final diff: because we want to grab the sections for regions 
+            # changed in new version of the file. So for now a direct diff
+            # using patiencediff is done.
+            old_revision = self.commit.basis_tree.get_file_revision(
+                found_entry.file_id)
+            needed = [(found_entry.file_id, found_entry.revision, 'new'),
+                      (found_entry.file_id, old_revision, 'old')]
+            contents = self.commit.builder.repository.iter_files_bytes(needed)
+            lines = {}
+            for name, chunks in contents:
+                lines[name] = osutils.chunks_to_lines(chunks)
+            new = lines['new']
+            sequence_matcher = patiencediff.PatienceSequenceMatcher(
+                None, lines['old'], new)
+            new_lines = []
+            for group in sequence_matcher.get_opcodes():
+                tag, i1, i2, j1, j2 = group
+                if tag == 'equal':
+                    continue
+                if tag == 'delete':
+                    continue
+                new_lines.extend(new[j1:j2])
+            if not self.commit.revprops.get('bugs'):
+                # TODO: Allow the user to configure the bug tracker to use
+                # rather than hardcoding Launchpad.
+                bt = bugtracker.tracker_registry.get('launchpad')
+                bugids = []
+                for line in new_lines:
+                    bugids.extend(_BUG_MATCH.findall(line))
+                self.commit.revprops['bugs'] = \
+                    bugtracker.encode_fixes_bug_urls(
+                        [bt.get_bug_url(bugid) for bugid in bugids])
+            return self.merge_message(''.join(new_lines))
+
+    def merge_message(self, new_message):
+        """Merge new_message with self.message.
+
+        :param new_message: A string message to merge with self.message.
+        :return: A string with the merged messages.
+        """
+        if self.message is None:
+            return new_message
+        return self.message + new_message

=== added directory 'breezy/plugins/commitfromnews/tests'
=== added file 'breezy/plugins/commitfromnews/tests/__init__.py'
--- breezy/plugins/commitfromnews/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/commitfromnews/tests/__init__.py	2017-07-23 22:07:30 +0000
@@ -0,0 +1,29 @@
+# Copyright (C) 2010 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Tests for commitfromnews."""
+
+from __future__ import absolute_import
+
+def load_tests(loader, basic_tests, pattern):
+    testmod_names = [
+        'test_committemplate',
+        'test_msgeditor',
+        ]
+    basic_tests.addTest(loader.loadTestsFromModuleNames(
+            ["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
+    return basic_tests
+

=== added file 'breezy/plugins/commitfromnews/tests/test_committemplate.py'
--- breezy/plugins/commitfromnews/tests/test_committemplate.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/commitfromnews/tests/test_committemplate.py	2017-07-23 22:07:30 +0000
@@ -0,0 +1,155 @@
+# Copyright (C) 2010 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Tests for the commit template creation."""
+
+from __future__ import absolute_import
+
+from ... import commitfromnews
+from .... import msgeditor
+from ....tests import TestCaseWithTransport
+
+INITIAL_NEWS_CONTENT = """----------------------------
+commitfromnews release notes
+----------------------------
+
+NEXT (In development)
+---------------------
+
+IMPROVEMENTS
+~~~~~~~~~~~~
+
+* Created plugin, basic functionality of looking for NEWS and including the
+  NEWS diff.
+"""
+
+
+class TestCommitTemplate(TestCaseWithTransport):
+
+    def capture_template(self, commit, message):
+        self.commits.append(commit)
+        self.messages.append(message)
+        if message is None:
+            message = 'let this commit succeed I command thee.'
+        return message
+
+    def setup_capture(self):
+        commitfromnews.register()
+        msgeditor.hooks.install_named_hook('commit_message_template',
+            self.capture_template, 'commitfromnews test template')
+        self.messages = []
+        self.commits = []
+
+    def test_initial(self):
+        self.setup_capture()
+        builder = self.make_branch_builder('test')
+        builder.start_series()
+        builder.build_snapshot('BASE-id', None,
+            [('add', ('', None, 'directory', None)),
+             ('add', ('foo', 'foo-id', 'file', 'a\nb\nc\nd\ne\n')),
+             ],
+            message_callback=msgeditor.generate_commit_message_template)
+        builder.finish_series()
+        self.assertEqual([None], self.messages)
+
+    def test_added_NEWS(self):
+        self.setup_capture()
+        builder = self.make_branch_builder('test')
+        builder.start_series()
+        content = INITIAL_NEWS_CONTENT
+        builder.build_snapshot('BASE-id', None,
+            [('add', ('', None, 'directory', None)),
+             ('add', ('NEWS', 'foo-id', 'file', content)),
+             ],
+            message_callback=msgeditor.generate_commit_message_template)
+        builder.finish_series()
+        self.assertEqual([content], self.messages)
+
+    def test_changed_NEWS(self):
+        self.setup_capture()
+        builder = self.make_branch_builder('test')
+        builder.start_series()
+        orig_content = INITIAL_NEWS_CONTENT
+        mod_content = """----------------------------
+commitfromnews release notes
+----------------------------
+
+NEXT (In development)
+---------------------
+
+IMPROVEMENTS
+~~~~~~~~~~~~
+
+* Added a new change to the system.
+
+* Created plugin, basic functionality of looking for NEWS and including the
+  NEWS diff.
+"""
+        change_content = """* Added a new change to the system.
+
+"""
+        builder.build_snapshot('BASE-id', None,
+            [('add', ('', None, 'directory', None)),
+             ('add', ('NEWS', 'foo-id', 'file', orig_content)),
+             ])
+        builder.build_snapshot(None, None,
+            [('modify', ('foo-id', mod_content)),
+             ],
+            message_callback=msgeditor.generate_commit_message_template)
+        builder.finish_series()
+        self.assertEqual([change_content], self.messages)
+
+    def test_fix_bug(self):
+        self.setup_capture()
+        builder = self.make_branch_builder('test')
+        builder.start_series()
+        orig_content = INITIAL_NEWS_CONTENT
+        mod_content = """----------------------------
+commitfromnews release notes
+----------------------------
+
+NEXT (In development)
+---------------------
+
+IMPROVEMENTS
+~~~~~~~~~~~~
+
+* Created plugin, basic functionality of looking for NEWS and including the
+  NEWS diff.
+
+* Fixed a horrible bug. (lp:523423)
+
+"""
+        change_content = """
+* Fixed a horrible bug. (lp:523423)
+
+"""
+        builder.build_snapshot('BASE-id', None,
+            [('add', ('', None, 'directory', None)),
+             ('add', ('NEWS', 'foo-id', 'file', orig_content)),
+             ])
+        builder.build_snapshot(None, None,
+            [('modify', ('foo-id', mod_content)),
+             ],
+            message_callback=msgeditor.generate_commit_message_template)
+        builder.finish_series()
+        self.assertEqual([change_content], self.messages)
+        self.assertEqual(1, len(self.commits))
+        self.assertEquals('https://launchpad.net/bugs/523423 fixed',
+                          self.commits[0].revprops['bugs'])
+
+    def _todo_test_passes_messages_through(self):
+        pass

=== added file 'breezy/plugins/commitfromnews/tests/test_msgeditor.py'
--- breezy/plugins/commitfromnews/tests/test_msgeditor.py	1970-01-01 00:00:00 +0000
+++ breezy/plugins/commitfromnews/tests/test_msgeditor.py	2017-07-23 22:07:30 +0000
@@ -0,0 +1,36 @@
+# Copyright (C) 2010 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
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Tests for msg editor interactions.."""
+
+from __future__ import absolute_import
+
+from ... import commitfromnews
+from .... import msgeditor
+from ....tests import TestCaseWithTransport
+
+
+class TestRegisters(TestCaseWithTransport):
+
+    def test_registered_at_import(self):
+        self.assertTrue(commitfromnews._registered)
+
+    def test_register_registers_for_commit_message_template(self):
+        commitfromnews._registered = False
+        # Registers only within the plugin
+        commitfromnews.register()
+        self.assertLength(1, msgeditor.hooks['commit_message_template'])
+        self.assertTrue(commitfromnews._registered)

=== modified file 'doc/en/release-notes/brz-3.0.txt'
--- doc/en/release-notes/brz-3.0.txt	2017-07-20 00:00:04 +0000
+++ doc/en/release-notes/brz-3.0.txt	2017-07-23 22:07:30 +0000
@@ -86,6 +86,10 @@
  * The 'fetch-ghosts' command is now bundled with brz.
    Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij)
 
+ * The 'commitfromnews' plugin is now bundled and
+   can be enabled by setting ``commit.template_from_files = NEWS``.
+   (Jelmer Vernooij)
+
  * The functionality from ``bzr-guess`` is now merged into Breezy.
    It will provide suggestions if the user typoes a command.
    (Jelmer Vernooij)