DefaultFormatter::__invoke() - Code Metrics - Inspection of "chore: Configure version-increment" - Voral/vs-version-incrementor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1a8193...4ba352 )

by Alexander

created 2025-03-28 12:13 UTC

DefaultFormatter::__invoke() A

↳ Parent: DefaultFormatter

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	9
c	1
b	0
f	1
dl	0
loc	14
ccs	10
cts	10
cp	1
rs	9.9666
cc	3
nc	3
nop	2
crap	3

<?php

declare(strict_types=1);

namespace Vasoft\VersionIncrement\Changelog;

use Vasoft\VersionIncrement\Commits\CommitCollection;
use Vasoft\VersionIncrement\Contract\ChangelogFormatterInterface;

/**
 * It generates a changelog in a default format by iterating through visible sections and their commits.
 * This formatter does not preserve or filter scopes; it simply lists all commits under their respective sections.
 */
final class DefaultFormatter implements ChangelogFormatterInterface
{
    /**
     * Generates a changelog in the default format.
     *
     * @param CommitCollection $commitCollection a collection of commits grouped into sections
     * @param string           $version          the version number for which the changelog is generated
     *
     * @return string The formatted changelog as a string.
     *
     * The changelog includes:
     * - The version number and date at the top.
     * - Sections with their titles.
     * - Commits listed under each section without preserving scopes.
     */
    public function __invoke(CommitCollection $commitCollection, string $version): string
    {
        $date = date('Y-m-d');
        $changelog = "# {$version} ({$date})\n\n";
        $sections = $commitCollection->getVisibleSections();
        foreach ($sections as $section) {
            $changelog .= sprintf("### %s\n", $section->title);
            foreach ($section->getCommits() as $commit) {
                $changelog .= "- {$commit->comment}\n";
            }
            $changelog .= "\n";
        }

        return $changelog;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Vasoft\VersionIncrement\Changelog;
6
7		use Vasoft\VersionIncrement\Commits\CommitCollection;
8		use Vasoft\VersionIncrement\Contract\ChangelogFormatterInterface;
9
10		/**
11		* It generates a changelog in a default format by iterating through visible sections and their commits.
12		* This formatter does not preserve or filter scopes; it simply lists all commits under their respective sections.
13		*/
14		final class DefaultFormatter implements ChangelogFormatterInterface
15		{
16		/**
17		* Generates a changelog in the default format.
18		*
19		* @param CommitCollection $commitCollection a collection of commits grouped into sections
20		* @param string $version the version number for which the changelog is generated
21		*
22		* @return string The formatted changelog as a string.
23		*
24		* The changelog includes:
25		* - The version number and date at the top.
26		* - Sections with their titles.
27		* - Commits listed under each section without preserving scopes.
28		*/
29	14	public function __invoke(CommitCollection $commitCollection, string $version): string
30		{
31	14	$date = date('Y-m-d');
32	14	$changelog = "# {$version} ({$date})\n\n";
33	14	$sections = $commitCollection->getVisibleSections();
34	14	foreach ($sections as $section) {
35	14	$changelog .= sprintf("### %s\n", $section->title);
36	14	foreach ($section->getCommits() as $commit) {
37	14	$changelog .= "- {$commit->comment}\n";
38		}
39	14	$changelog .= "\n";
40		}
41
42	14	return $changelog;
43		}
44		}
45

Voral / vs-version-incrementor

Push — master ( 1a8193...4ba352 )

DefaultFormatter::__invoke() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like