Add sorting order of commit subjects

- Commit subjects are listed unsorted or in ascending/descending order.
- PHPUnit testBuild split to testBuildAscendingCommitOrder and testBuildDescendingCommitOrder.

Author: DigiLive

src/GitChangeLog.php

@@ -148,6 +148,7 @@ class GitChangeLog
      *  addHashes           True includes commit hashes to the listed subjects.
      *  includeMergeCommits True includes merge commits in the subject lists.
      *  tagOrderDesc        True to sort the tags in descending order.
+     *  commitOrder         Set to 'ASC' or 'DESC' to sort the subjects in resp. ascending/descending order.
      *  </pre>
      */
     protected $options = [
@@ -158,6 +159,7 @@ class GitChangeLog
         'addHashes'           => true,
         'includeMergeCommits' => false,
         'tagOrderDesc'        => true,
+        'commitOrder'         => 'ASC',
     ];
 
     /**
@@ -271,6 +273,16 @@ public function build(): void
                 continue;
             }
 
+            // Sort commit subjects.
+            switch ($this->options['commitOrder']) {
+                case 'ASC':
+                    natsort($data['subjects']);
+                    break;
+                case 'DESC':
+                    natsort($data['subjects']);
+                    $data['subjects'] = array_reverse($data['subjects'], true);
+            }
+
             // Add commit subjects.
             foreach ($data['subjects'] as $subjectKey => &$subject) {
                 if ($this->options['addHashes']) {

tests/GitChangeLogTest.php

@@ -230,9 +230,10 @@ public function testSetFromTag()
         $changeLog->setFromTag('DoesNotExist');
     }
 
-    public function testBuild()
+    public function testBuildAscendingCommitOrder()
     {
         $changeLog      = new GitChangeLog();
+        $changeLog->setOptions('tagOrderDesc', false);
         $testValues     =
             [
                 // No tags.
@@ -263,6 +264,40 @@ public function testBuild()
         }
     }
 
+    public function testBuildDescendingCommitOrder()
+    {
+        $changeLog      = new GitChangeLog();
+        $changeLog->setOptions('commitOrder', 'DESC');
+        $testValues     =
+            [
+                // No tags.
+                [],
+                // Head Revision included.
+                ['HEAD' => ['date' => 'B', 'subjects' => ['C', 'D'], 'hashes' => [['E'], ['F']]]],
+                // Dummy tag, no commits.
+                ['A' => ['date' => 'B', 'subjects' => [], 'hashes' => []]],
+                // Dummy tag and commits.
+                ['A' => ['date' => 'B', 'subjects' => ['C', 'D'], 'hashes' => [['E', 'F'], ['G']]]],
+            ];
+        $expectedValues =
+            [
+                //No tags
+                "# Changelog\n\nNo changes.\n",
+                // Head Revision included.
+                "# Changelog\n\n## Upcoming changes (Undetermined)\n\n* D (F)\n* C (E)\n",
+                // Dummy tag, no commits.
+                "# Changelog\n\n## A (B)\n\n* No changes.\n",
+                // Dummy tag and commits.
+                "# Changelog\n\n## A (B)\n\n* D (G)\n* C (E, F)\n",
+            ];
+
+        foreach ($testValues as $key => $value) {
+            $this->setPrivateProperty($changeLog, 'commitData', $value);
+            $changeLog->build();
+            $this->assertEquals($expectedValues[$key], $changeLog->get());
+        }
+    }
+
     public function testProcessCommitData()
     {
         $changeLog = new ReflectionClass('DigiLive\GitChangeLog\GitChangeLog');