Vasoft\VersionIncrement\Changelog\ScopePreservingFormatter

Complexity

Total Complexity

7

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	1	1
A	__invoke()	0	23	6

<?php

declare(strict_types=1);

namespace Vasoft\VersionIncrement\Changelog;

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

/**
 * It generates a changelog while preserving specific scopes passed to the constructor.
 * If no scopes are specified, all scopes are preserved.
 */
class ScopePreservingFormatter implements ChangelogFormatterInterface
{
    /**
     * Constructs a new ScopePreservingFormatter instance.
     *
     * @param array $preservedScopes An optional array of scopes to preserve in the changelog.
     *                               If empty, all scopes will be included.
     */
    public function __construct(private readonly array $preservedScopes = []) {}

    /**
     * Generates a changelog while preserving specified scopes.
     *
     * @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, with scopes preserved based on the constructor configuration.
     *   If a commit has a scope that matches one of the preserved scopes, it is included in the output.
     *   Otherwise, the scope is omitted unless no scopes are specified (all scopes are preserved).
     */
    public function __invoke(CommitCollection $commitCollection, string $version): string
    {
        $date = date('Y-m-d');
        $changelog = "# {$version} ({$date})\n\n";
        $sections = $commitCollection->getVisibleSections();
        $allScopes = empty($this->preservedScopes);
        foreach ($sections as $section) {
            $changelog .= sprintf("### %s\n", $section->title);
            foreach ($section->getCommits() as $commit) {
                if ('' !== $commit->scope
                    && ($allScopes || in_array($commit->scope, $this->preservedScopes, true))
                ) {
                    $scope = sprintf('%s: ', $commit->scope);
                } else {
                    $scope = '';
                }

                $changelog .= "- {$scope}{$commit->comment}\n";
            }
            $changelog .= "\n";
        }

        return $changelog;
    }
}