Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GitCommitBear: Refactor issue regexes #2459

Merged
merged 1 commit into from
May 4, 2018
Merged

GitCommitBear: Refactor issue regexes #2459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 22 additions & 11 deletions bears/vcs/git/GitCommitBear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ class GitCommitBear(GlobalBear):
LICENSE = 'AGPL-3.0'
ASCIINEMA_URL = 'https://asciinema.org/a/e146c9739ojhr8396wedsvf0d'
CAN_DETECT = {'Formatting'}
ISSUE_INFO = {
'github': {
'issue': r'(?:\w+/\w+)?#(\S+)',
'full issue': r'https?://github\S+/issues/(\S+)',
},
'gitlab': {
'issue': r'(?:\w+/\w+)?#(\S+)',
'full issue': r'https?://gitlab\S+/issues/(\S+)',
},
}
SUPPORTED_HOST_KEYWORD_REGEX = {
'github': (r'[Cc]lose[sd]?'
r'|[Rr]esolve[sd]?'
Expand Down Expand Up @@ -305,9 +315,15 @@ def check_issue_reference(self, body,
return

host = self.get_host_from_remotes()
if host not in self.SUPPORTED_HOST_KEYWORD_REGEX:
if (host not in self.SUPPORTED_HOST_KEYWORD_REGEX or
host not in self.ISSUE_INFO):
return

if body_close_issue_full_url:
self.issue_type = 'full issue'
else:
self.issue_type = 'issue'

if body_close_issue_on_last_line:
if body:
body = body.splitlines()[-1]
Expand All @@ -317,13 +333,7 @@ def check_issue_reference(self, body,
result_message = ('Body of HEAD commit does not contain any {} '
'reference.')

if body_close_issue_full_url:
result_info = 'full issue'
issue_ref_regex = (
r'https?://{}\S+/issues/(\S+)'.format(re.escape(host)))
else:
result_info = 'issue'
issue_ref_regex = r'(?:\w+/\w+)?#(\S+)'
result_message = result_message.format(self.issue_type)

concat_regex = '|'.join(kw for kw in self.CONCATENATION_KEYWORDS)
compiled_joint_regex = re.compile(
Expand All @@ -346,10 +356,11 @@ def check_issue_reference(self, body,
matches = compiled_joint_regex.findall(body)

if body_enforce_issue_reference and len(matches) == 0:
yield Result(self, result_message.format(result_info))
yield Result(self, result_message)
return

compiled_issue_ref_regex = re.compile(issue_ref_regex)
compiled_issue_ref_regex = re.compile(
self.ISSUE_INFO[host][self.issue_type])
compiled_issue_no_regex = re.compile(r'[1-9][0-9]*')
compiled_concat_regex = re.compile(
r'\s*(?:{})\s*'.format(concat_regex))
Expand All @@ -359,7 +370,7 @@ def check_issue_reference(self, body,
reference = compiled_issue_ref_regex.fullmatch(issue)
if not reference:
yield Result(self, 'Invalid {} reference: '
'{}'.format(result_info, issue))
'{}'.format(self.issue_type, issue))
elif not compiled_issue_no_regex.fullmatch(reference.group(1)):
yield Result(self, 'Invalid issue number: '
'{}'.format(issue))