Issue 3681 - Add suport for "Fixes XXXX - ..." commit messages

sitescripts/hg/bin/update_issues.py

 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-2016 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 """Hooks for integrating Mercurial with Trac.
 
 Update the issues that are referenced in commit messages when the commits
-are pushed and and "master" bookmark is moved. See README.md for more

[Felix Dahlke, 2016/05/17 20:12:06]

Nit: One "and" should do :) Also, "the master bookmark" I guess.

[Vasily Kuznetsov, 2016/05/18 08:30:44]

Done :)

Also changed the quotes around "master" to be consistent with how it's written
in the README.

+are pushed and `master` bookmark is moved. See README.md for more
 information on behavior and configuration.
 """
 
 import collections
 import contextlib
 import posixpath
 import re
 import xmlrpclib
 
 from sitescripts.utils import get_config, get_template
 
 
 _IssueRef = collections.namedtuple('IssueRef', 'id commits is_fixed')

[Felix Dahlke, 2016/05/17 20:12:06]

AFAIK we mostly use double quotes (same as in JS where the two are also
functionally equivalent), I think we should stick to that consistently in new
code.

[Sebastian Noack, 2016/05/17 20:39:39]

We use single quotes consistently in new Python code (except when avoiding
escaping of embedded quotes). Frankly I did that ever since except when aiming
to be consistent with surrounding legacy code. But it's in the coding style now.
Also keep in mind that this matches the behaviour of repr() i.e. the natural
representation of literals in Python.

[Felix Dahlke, 2016/05/17 21:24:08]

I see. Makes more sense to me to do this consistently across languages, but it
doesn't matter much. From some quick grepping, it looks like around 60% of our
Python code uses single quotes, so it's the more popular thing already.

Had a quick look at some code in cpython to see what they use. Seems totally
inconsistent. Guess that explains why PEP-8 doesn't specify it :D

[Sebastian Noack, 2016/05/18 06:52:39]

I believe that PEP-8 doesn't dictates which quotes to use simply because it
isn't too important, and enforcing it could alienate some adopters. However,
still using single quotes is more natural in Python as this is what the repl and
built-in APIs do when preparing strings to be displayed. Also, most Python
documentation uses single quotes. While its exactly the other way around in
JavaScript, where browsers use double quotes when displaying strings in the
console, and most JavaScript documentation uses double quotes as well. So there
might actually be a reason to do it differently in different languages, in order
to stick to what's common in the context of those individual languages.

[Vasily Kuznetsov, 2016/05/18 08:30:44]

Fully agree with Sebastian here. Regarding JavaScript, I would also add that
JSON requires double quotes so there's another incentive to use double quotes
everywhere for consistency. So given that there's some, rather remote, but
still, similarity between `JSON.stringify` and `repr`, we're sort of doing the
same thing in our approach to Python strings.

Anyway, I like how our style guide is quite definite about the quotes and
(bonus!) we even have flake8-abp that automatically enforces it.

 
 ISSUE_NUMBER_REGEX = re.compile(r'\b(issue|fixes)\s+(\d+)\b', re.I)
 NOISSUE_REGEX = re.compile(r'^noissue\b', re.I)
 COMMIT_MESSAGE_REGEX = re.compile(r'\[\S+\ ([^\]]+)\]')
 
 
 @contextlib.contextmanager
 def _trac_proxy(ui, config, action_descr):
     trac_url = config.get('hg', 'trac_xmlrpc_url')
     try:
@@ skipping 132 matching lines @@
 def changegroup_hook(ui, repo, node, **kwargs):
     config = get_config()
     first_rev = repo[node].rev()
     pushed_commits = repo[first_rev:]
     refs = _collect_references(ui, pushed_commits)
     _post_comments(ui, repo, config, refs)
 
 
 def pushkey_hook(ui, repo, **kwargs):
     if (kwargs['namespace'] != 'bookmarks' or  # Not a bookmark move.
-            kwargs['key'] != 'master' or       # Not master bookmark.
+            kwargs['key'] != 'master' or       # Not `master` bookmark.
             not kwargs['old']):                # The bookmark is just created.
         return
 
     config = get_config()
     old_master_rev = repo[kwargs['old']].rev()
     new_master_rev = repo[kwargs['new']].rev()
     added_revs = repo.changelog.findmissingrevs([old_master_rev],
                                                 [new_master_rev])
     added_commits = [repo[rev] for rev in added_revs]
     refs = [ref for ref in _collect_references(ui, added_commits)
             if ref.is_fixed]
     _declare_fixed(ui, config, refs)
 
 
 # Alias for backward compatibility.
 hook = changegroup_hook