Sat, 06 Jan 2024 20:32:56 +0100
Added tag v1.2.2 for changeset 238de141d189
1 /*
2 * Copyright 2023 Mike Becker. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 */
27 package de.uapcore.lightpit.types
29 data class CommitRef(val hash: String, val issueId: Int, val message: String)
31 /**
32 * Takes a [commitLog] in format `::lpitref::{node}:{desc}` and parses commit references.
33 * Supported references are (in this example, 47 is the issue ID):
34 * - fixes #47
35 * - fix #47
36 * - closes #47
37 * - close #47
38 * - relates to #47
39 */
40 fun parseCommitRefs(commitLog: String): List<CommitRef> = buildList {
41 val marker = "::lpitref:"
42 var currentHash = ""
43 var currentDesc = ""
44 for (line in commitLog.split("\n")) {
45 // see if current line contains a new log entry
46 if (line.startsWith(marker)) {
47 val head = line.substring(marker.length).split(':', limit = 2)
48 currentHash = head[0]
49 currentDesc = head[1]
50 }
52 // skip possible preamble output
53 if (currentHash.isEmpty()) continue
55 // scan the lines for commit references
56 Regex("""(?:issue|relates? to|fix(?:e[sd])?|close(?:[sd])?) \#(\d+)""")
57 .findAll(line)
58 .map { it.groupValues[1] }
59 .map { it.toIntOrNull() }
60 .filterNotNull()
61 .forEach { commitId -> add(CommitRef(currentHash, commitId, currentDesc)) }
62 }
63 }