sort categories from new features, bugfixes and removed

Author: TomasVotruba

src/ChangelogContentsFactory.php

@@ -43,7 +43,13 @@ public function create(array $changelogLines): string
         Assert::allString($changelogLines);
 
         // summarize into "Added Features" and "Bugfixes" groups
-        $linesByCategory = [];
+        $linesByCategory = [
+            // set order clearly here
+            ChangelogCategory::NEW_FEATURES => [],
+            ChangelogCategory::BUGFIXES => [],
+            ChangelogCategory::REMOVED => [],
+            ChangelogCategory::SKIPPED => [],
+        ];
 
         foreach ($changelogLines as $changelogLine) {
             foreach (self::FILTER_KEYWORDS_BY_CATEGORY as $category => $filterKeywords) {
@@ -62,6 +68,9 @@ public function create(array $changelogLines): string
         // remove skipped lines
         unset($linesByCategory[ChangelogCategory::SKIPPED]);
 
+        // remove empty categories
+        $linesByCategory = array_filter($linesByCategory);
+
         return $this->generateFileContentsFromGroupedItems($linesByCategory);
     }
 
@@ -107,4 +116,26 @@ private function isKeywordsMatch(array $filterKeywords, string $changelogLine):
 
         return false;
     }
+
+    private function sortHeadlinesAsExpected(array $linesByCategory): array
+    {
+        // make sure the new features are first, bugfixes second and removed third
+        $newFeatures = $linesByCategory[ChangelogCategory::NEW_FEATURES] ?? [];
+        $bugfixes = $linesByCategory[ChangelogCategory::BUGFIXES] ?? [];
+        $removed = $linesByCategory[ChangelogCategory::REMOVED] ?? [];
+
+        $sortedLinesByCategory = [];
+        if ($newFeatures !== []) {
+            $sortedLinesByCategory[ChangelogCategory::NEW_FEATURES] = $newFeatures;
+        }
+
+        if ($bugfixes !== []) {
+            $sortedLinesByCategory[ChangelogCategory::BUGFIXES] = $bugfixes;
+        }
+
+        if ($removed !== []) {
+            $sortedLinesByCategory[ChangelogCategory::REMOVED] = $removed;
+        }
+        return $sortedLinesByCategory;
+    }
 }

tests/ChangelogContentsFactory/ChangelogContentsFactoryTest.php

@@ -19,9 +19,10 @@ protected function setUp(): void
     public function test(): void
     {
         $changelogLines = [
-            '* Add new rule',
             '* Fix bug',
+            '* Add new rule',
             '* Fixed another bug',
+            '* Removed old rule',
             '* Enable PHPStan on tests as well + add "unused public" ([#3238](https://github.com/rectorphp/rector-src/pull/3238))',
         ];
 

tests/ChangelogContentsFactory/Fixture/generated_changelog.md

@@ -8,3 +8,9 @@
 
 * Fix bug
 * Fixed another bug
+
+<br>
+
+## Removed :skull:
+
+* Removed old rule