Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add separate renderers for GitChangelog
- Refactored filename of GitChangelog.php - Renderer interface added. - Markdown renderer moved from GitChangelog to its own class. - Html interface added.
- Loading branch information
DigiLive
committed
Oct 28, 2020
1 parent
f8ec9f7
commit 2df97ee
Showing
4 changed files
with
379 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * BSD 3-Clause License | ||
| * | ||
| * Copyright (c) 2020, Ferry Cools (DigiLive) | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * | ||
| * 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following disclaimer in the documentation | ||
| * and/or other materials provided with the distribution. | ||
| * | ||
| * 3. Neither the name of the copyright holder nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
| * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| * | ||
| */ | ||
|
|
||
| namespace DigiLive\GitChangelog\Renderers; | ||
|
|
||
| use DigiLive\GitChangelog\GitChangelog; | ||
| use DigiLive\GitChangelog\Utilities; | ||
| use Exception; | ||
|
|
||
| /** | ||
| * Class Html | ||
| * | ||
| * Renderer for GitChangelog. | ||
| * The rendered changelog is formatted in markdown. | ||
| * | ||
| * @package DigiLive\GitChangelog\Renderers | ||
| */ | ||
| class Html extends GitChangelog implements RendererInterface | ||
| { | ||
| /** | ||
| * @var string Format of a single commit hash. {hash} is replaced by the commit hash. | ||
| */ | ||
| public $formatHash = '{hash}'; | ||
|
|
||
| /** | ||
| * Generate the changelog. | ||
| * | ||
| * The generated changelog will be stored into a class property. | ||
| * | ||
| * @throws Exception When the defined From- or To-tag doesn't exist in the git repository. | ||
| */ | ||
| public function build(): void | ||
| { | ||
| $logContent = "<h1>{$this->options['logHeader']}<h1>"; | ||
|
|
||
| $commitData = $this->fetchCommitData(); | ||
|
|
||
| if (!$commitData) { | ||
| $this->changelog = "<p>$logContent{$this->options['noChangesMessage']}</p>"; | ||
| } | ||
|
|
||
| if (!$this->options['tagOrderDesc']) { | ||
| $commitData = array_reverse($commitData); | ||
| } | ||
|
|
||
| foreach ($commitData as $tag => $data) { | ||
| // Add tag header and date. | ||
| if ($tag == 'HEAD') { | ||
| $tag = $this->options['headSubject']; | ||
| $data['date'] = $this->options['nextTagDate']; | ||
| } | ||
|
|
||
| $logContent .= "<h2>$tag ({$data['date']})</h2><ul>"; | ||
|
|
||
| // No subjects present for this tag. | ||
| if (!$data['subjects']) { | ||
| $logContent .= "<li>{$this->options['noChangesMessage']}</li></ul>"; | ||
| continue; | ||
| } | ||
|
|
||
| // Sort commit subjects. | ||
| Utilities::natSort($data['subjects'], $this->options['commitOrder']); | ||
|
|
||
| // Add commit subjects. | ||
| foreach ($data['subjects'] as $subjectKey => $subject) { | ||
| $logContent .= "<li>$subject (" . $this->formatHashes($data['hashes'][$subjectKey]) . ")</li>"; | ||
| } | ||
|
|
||
| $logContent .= '</ul>'; | ||
| } | ||
|
|
||
| $this->changelog = $logContent; | ||
| } | ||
|
|
||
| /** | ||
| * Format the hashes of a commit subject into a string. | ||
| * | ||
| * Each hash is formatted as defined by property formatHash. | ||
| * After formatting, all hashes are concatenated to a single line, comma separated. | ||
| * | ||
| * @param array $hashes Hashes to format | ||
| * | ||
| * @return string Formatted hash string. | ||
| * @see GitChangelog::$formatHash | ||
| */ | ||
| protected function formatHashes(array $hashes): string | ||
| { | ||
| if (!$this->options['addHashes']) { | ||
| return ''; | ||
| } | ||
|
|
||
| foreach ($hashes as &$hash) { | ||
| $hash = str_replace('{hash}', $hash, $this->formatHash); | ||
| } | ||
| unset($hash); | ||
|
|
||
| return implode(', ', $hashes); | ||
| } | ||
| } |
Oops, something went wrong.