status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Properly detect GitHub references at start of line (#477) 

Summary:
The `^` metacharacter only matches the start of a non-initial line when
the `m` (“multiline”) flag is set on the RegExp. This flag was set only
for the GitHub URL RegExp.

Test Plan:
Regression tests added. They fail before this patch and pass with it.

wchargin-branch: fix-sol-github-references
This commit is contained in:
William Chargin 2018-07-03 11:20:59 -07:00 committed by GitHub
parent 664b8ac8d0
commit 6ab78b85da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 78 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/github/parseReferences.js
View File

@ -20,7 +20,7 @@ export function parseReferences(body: string): ParsedReference[] {
function findRepoNumericReferences(body: string): ParsedReference[] {
return findAllMatches(
/(?:\W|^)([a-zA-Z0-9-]+\/[a-zA-Z0-9-]+#\d+)(?:\W|$)/g,
/(?:\W|^)([a-zA-Z0-9-]+\/[a-zA-Z0-9-]+#\d+)(?:\W|$)/gm,
body
).map((x) => ({
refType: "BASIC",
@ -29,7 +29,7 @@ function findRepoNumericReferences(body: string): ParsedReference[] {
}
function findNumericReferences(body: string): ParsedReference[] {
return findAllMatches(/(?:\W|^)(#\d+)(?:\W|$)/g, body).map((x) => ({
return findAllMatches(/(?:\W|^)(#\d+)(?:\W|$)/gm, body).map((x) => ({
refType: "BASIC",
ref: x[1],
}));
@ -37,11 +37,11 @@ function findNumericReferences(body: string): ParsedReference[] {
function findUsernameReferences(body: string): ParsedReference[] {
const pairedWithRefs = findAllMatches(
/(?:\W|^)(?:P|p)aired(?:-| )(?:w|W)ith:? (@[a-zA-Z0-9-]+)(?:\W|$)/g,
/(?:\W|^)(?:P|p)aired(?:-| )(?:w|W)ith:? (@[a-zA-Z0-9-]+)(?:\W|$)/gm,
body
).map((x) => ({ref: x[1], refType: "PAIRED_WITH"}));
const basicRefs = findAllMatches(
/(?:\W|^)(@[a-zA-Z0-9-]+)(?:\W|$)/g,
/(?:\W|^)(@[a-zA-Z0-9-]+)(?:\W|$)/gm,
body
).map((x) => ({ref: x[1], refType: "BASIC"}));
for (const {ref} of pairedWithRefs) {

74
src/plugins/github/parseReferences.test.js
View File

@ -228,4 +228,78 @@ https://github.com/sourcecred/example-github/pull/3#issuecomment-369162222
{refType: "PAIRED_WITH", ref: "@decentralion"},
]);
});
describe("finds references at the start of a non-initial line", () => {
it("for repo-numeric references", () => {
const f = (number: number) => `sourcecred/example-github#${number}`;
const input = `${f(1)}\n${f(2)}\n${f(3)}\r\n${f(4)}\r\n${f(5)}`;
expect(parseReferences(input)).toEqual([
{refType: "BASIC", ref: "sourcecred/example-github#1"},
{refType: "BASIC", ref: "sourcecred/example-github#2"},
{refType: "BASIC", ref: "sourcecred/example-github#3"},
{refType: "BASIC", ref: "sourcecred/example-github#4"},
{refType: "BASIC", ref: "sourcecred/example-github#5"},
]);
});
it("for numeric references", () => {
const f = (number: number) => `#${number}`;
const input = `${f(1)}\n${f(2)}\n${f(3)}\r\n${f(4)}\r\n${f(5)}`;
expect(parseReferences(input)).toEqual([
{refType: "BASIC", ref: "#1"},
{refType: "BASIC", ref: "#2"},
{refType: "BASIC", ref: "#3"},
{refType: "BASIC", ref: "#4"},
{refType: "BASIC", ref: "#5"},
]);
});
it("for username references", () => {
const f = (number: number) => `@user${number}`;
const input = `${f(1)}\n${f(2)}\n${f(3)}\r\n${f(4)}\r\n${f(5)}`;
expect(parseReferences(input)).toEqual([
{refType: "BASIC", ref: "@user1"},
{refType: "BASIC", ref: "@user2"},
{refType: "BASIC", ref: "@user3"},
{refType: "BASIC", ref: "@user4"},
{refType: "BASIC", ref: "@user5"},
]);
});
it("for paired-with references", () => {
const f = (number: number) => `Paired-with: @user${number}`;
const input = `${f(1)}\n${f(2)}\n${f(3)}\r\n${f(4)}\r\n${f(5)}`;
expect(parseReferences(input)).toEqual([
{refType: "PAIRED_WITH", ref: "@user1"},
{refType: "PAIRED_WITH", ref: "@user2"},
{refType: "PAIRED_WITH", ref: "@user3"},
{refType: "PAIRED_WITH", ref: "@user4"},
{refType: "PAIRED_WITH", ref: "@user5"},
]);
});
it("for GitHub URL references", () => {
const f = (number: number) =>
"https://github.com/sourcecred/example-github/issues/" + number;
const input = `${f(1)}\n${f(2)}\n${f(3)}\r\n${f(4)}\r\n${f(5)}`;
expect(parseReferences(input)).toEqual([
{
refType: "BASIC",
ref: "https://github.com/sourcecred/example-github/issues/1",
},
{
refType: "BASIC",
ref: "https://github.com/sourcecred/example-github/issues/2",
},
{
refType: "BASIC",
ref: "https://github.com/sourcecred/example-github/issues/3",
},
{
refType: "BASIC",
ref: "https://github.com/sourcecred/example-github/issues/4",
},
{
refType: "BASIC",
ref: "https://github.com/sourcecred/example-github/issues/5",
},
]);
});
});
});