-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommitFormatter.php
More file actions
148 lines (115 loc) · 4.46 KB
/
CommitFormatter.php
File metadata and controls
148 lines (115 loc) · 4.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
namespace PHPWatch\PHPCommitBuilder;
use stdClass;
class CommitFormatter {
use FormatterHelpers;
private array $commitsList = [];
private array $commitsGroupedByAuthor = [];
private array $nameReplacements;
public function __construct(array $inputCommits, array $nameReplacements = []) {
$this->nameReplacements = $nameReplacements;
$this->process($inputCommits);
}
private function process(array $inputCommits): void {
$formattedCommits = [];
$i = 0;
foreach ($inputCommits as $commit) {
$commitArray = $this->splitCommit($commit);
if ($this->shouldSkip($commitArray['subject'])) {
continue;
}
$commitArray['formatted'] = KeywordEnhancer::enhanceCommit(
$commitArray['subject'],
substr($commitArray['hash'], 0, 10)
);
$formattedCommits[$i] = $commitArray;
if (!isset($this->commitsGroupedByAuthor[$commitArray['author']])) {
$this->commitsGroupedByAuthor[$commitArray['author']] = [];
}
$this->commitsGroupedByAuthor[$commitArray['author']][] = $i;
$i++;
}
$this->commitsList = $formattedCommits;
$this->groupByAuthorNames($this->commitsList, $this->nameReplacements);
}
private function groupByAuthorNames(): void {
foreach ($this->nameReplacements as $originalName => $newName) {
if (isset($this->commitsGroupedByAuthor[$originalName])) {
$this->commitsGroupedByAuthor[$newName] = $this->commitsGroupedByAuthor[$originalName];
unset($this->commitsGroupedByAuthor[$originalName]);
}
}
ksort($this->commitsGroupedByAuthor, SORT_NATURAL | SORT_FLAG_CASE);
}
private function splitCommit(stdClass $commit): array {
$commitMessage = $commit->commit->message;
$commitMessageParts = explode("\n", $commitMessage, 2);
return [
'subject' => trim(trim($commitMessageParts[0]), '.'),
'author' => trim($commit->commit->author->name),
'hash' => trim($commit->sha),
'message' => trim($commitMessage),
];
}
private function shouldSkip(string $commitMessage): bool {
if ($commitMessage === '') {
return true;
}
// Skip merge commits
if (str_starts_with($commitMessage, 'Merge branch')) {
return true;
}
// Skip merge commits
if (str_starts_with($commitMessage, 'Merge remote-tracking branch')) {
return true;
}
// Skip "[ci skip]" messages
if (str_contains($commitMessage, '[ci skip]') || str_contains($commitMessage, '[skip ci]')) {
return true;
}
if (
str_contains($commitMessage, 'is now for PHP 8')
|| str_contains($commitMessage, 'is now for PHP-8')
|| str_contains($commitMessage, 'PHP-8.0 is now for 8')
) {
return true;
}
if (str_starts_with($commitMessage, 'Update NEWS for ')) {
return true;
}
return false;
}
public function getFormattedCommitList(): array {
return $this->commitsList;
}
public function getFormattedCommitListMarkup(): string {
$output = '';
foreach ($this->getFormattedCommitList() as $commit) {
$output .= self::markdownListItem(
$commit['formatted'] . ' by ' . ($this->nameReplacements[$commit['author']] ?? $commit['author'])
);
}
return $output;
}
public function getFormattedCommitListGroupedByAuthor(): array {
$return = $this->commitsGroupedByAuthor;
foreach ($return as $author => &$commitList) {
foreach ($commitList as $key => &$commitI) {
$commitI = $this->commitsList[$commitI];
}
}
return $return;
}
public function getFormattedCommitListGroupedByAuthorMarkup(): string {
$commitsByAuthor = $this->getFormattedCommitListGroupedByAuthor();
$output = '';
foreach ($commitsByAuthor as $author => $commitList) {
$output .= self::markdownTitle($author);
foreach ($commitList as $commit) {
$output .= self::markdownListItem($commit['formatted']);
}
$output .= self::EOL . self::EOL;
}
return $output;
}
}