Fix bug with comparison (#55)

* Fix issues with comparison usage

* Make

* Update snapshot because of the order change

Sources/ChangeLogGenerator/Fetcher/Fetcher.swift

@@ -1,6 +1,6 @@
 //
 //  Fetcher.swift
-//  
+//
 //
 //  Created by Mahmood Tahir on 2021-01-19.
 //
@@ -94,12 +94,17 @@ struct Fetcher<Data: Decodable> {
         }
 
         Logger.log(level: .verbose, "received")
-        Logger.log(level: .verbose, String(data: data, encoding: .utf8) ?? "")
 
         let decoder = JSONDecoder()
         decoder.dateDecodingStrategy = .formatted(.formatter)
         decoder.keyDecodingStrategy = .convertFromSnakeCase
 
-        return try decoder.decode(Data.self, from: data)
+        let decodedValue = try decoder.decode(Data.self, from: data)
+
+        if let readableValue = decodedValue as? UserReadable {
+            Logger.log(level: .verbose, readableValue.userReadableString)
+        }
+
+        return decodedValue
     }
 }

Sources/ChangeLogGenerator/Generator/Generator.swift

@@ -84,6 +84,7 @@ public struct Generator {
         guard let tag = tags.first(where: { $0.name == tag }) else {
             return ""
         }
+        Logger.log(level: .verbose, "Found tag \(tag)")
         var allTags = tags
         var filteredTags = [Tag]()
         while allTags.isEmpty == false && allTags[0] != tag {
@@ -95,11 +96,20 @@ public struct Generator {
                 pulls.contains { $0.mergeCommitSha == tag.commit.sha } == false
             }
             .filter { $0.mergedAt != nil }
+            .sorted {
+                $0.mergedAt! > $1.mergedAt! // we have already filtered out all the ones that have `mergedAt` as nil
+            }
 
         var allPulls = pullRequests
+        Logger.log(level: .verbose, "All pulls \(allPulls.userReadableString)")
         var filteredPulls = [PullRequest]()
-        while allPulls.isEmpty == false && allPulls[0].mergeCommitSha != tag.commit.sha {
+        while allPulls.isEmpty == false {
             filteredPulls.append(allPulls.removeFirst())
+
+            if allPulls[0].mergeCommitSha == tag.commit.sha {
+                // we have reached the merge commit. We no longer need to append more pull requests
+                break
+            }
         }
 
         if let branch = branch {
@@ -109,6 +119,8 @@ public struct Generator {
                                  to: branch,
                                  maximumNumberOfPages: maximumNumberOfPages)
 
+            Logger.log(level: .verbose, "comparison commits \(comparison.commits.userReadableString)")
+            Logger.log(level: .verbose, "Filtered pulls \(filteredPulls.userReadableString)")
 
             filteredPulls = filteredPulls.filter { pull in
                 comparison.commits.contains { $0.sha == pull.mergeCommitSha }

Sources/ChangeLogGenerator/Models/Commit.swift

@@ -28,3 +28,15 @@ struct FullCommit: Decodable {
     let sha: String
     let commit: Details
 }
+
+extension FullCommit: UserReadable {
+    var userReadableString: String {
+        "FullCommit: \(sha) \(commit.message)"
+    }
+}
+
+extension Commit: UserReadable {
+    var userReadableString: String {
+        "Commit: \(sha)"
+    }
+}

Sources/ChangeLogGenerator/Models/Comparison.swift

@@ -17,3 +17,9 @@ struct Comparison: Decodable {
     let baseCommit: FullCommit
     let mergeBaseCommit: FullCommit
 }
+
+extension Comparison: UserReadable {
+    var userReadableString: String {
+        "Comparison: \(url)"
+    }
+}

Sources/ChangeLogGenerator/Models/Issue.swift

@@ -30,3 +30,9 @@ extension Issue: ChangelogConvertible {
     // this information is not exposed through issues
     var mergeCommitSha: String? { nil }
 }
+
+extension Issue: UserReadable {
+    var userReadableString: String {
+        "Issue#\(id), (\(url))"
+    }
+}

Sources/ChangeLogGenerator/Models/Label.swift

@@ -12,3 +12,9 @@ struct Label: Decodable {
     let name: String
     let color: String
 }
+
+extension Label: UserReadable {
+    var userReadableString: String {
+        "Label: \(name)"
+    }
+}

Sources/ChangeLogGenerator/Models/Milestone.swift

@@ -18,3 +18,9 @@ struct Milestone: Decodable {
     let closedIssues: UInt
     let state: State
 }
+
+extension Milestone: UserReadable {
+    var userReadableString: String {
+        "Milestone: \(title)"
+    }
+}

Sources/ChangeLogGenerator/Models/PullRequest.swift

@@ -27,3 +27,9 @@ struct PullRequest: Decodable {
 }
 
 extension PullRequest: ChangelogConvertible {}
+
+extension PullRequest: UserReadable {
+    var userReadableString: String {
+        "Pull: \(title) (\(url)) \(mergeCommitSha ?? "")"
+    }
+}

Sources/ChangeLogGenerator/Models/Release.swift

@@ -16,3 +16,9 @@ struct Release: Decodable {
     let publishedAt: Date?
     let draft: Bool
 }
+
+extension Release: UserReadable {
+    var userReadableString: String {
+        "Release: \(name)"
+    }
+}

Sources/ChangeLogGenerator/Models/SearchResult.swift

@@ -12,3 +12,13 @@ struct SearchResult<T: Decodable>: Decodable {
     let incompleteResults: Bool
     let items: [T]
 }
+
+extension SearchResult: UserReadable where T: UserReadable {
+    var userReadableString: String {
+        [
+            "Search Result: \(totalCount)",
+            items.userReadableString
+        ]
+            .joined()
+    }
+}

Sources/ChangeLogGenerator/Models/Tag.swift

@@ -11,3 +11,9 @@ struct Tag: Decodable, Equatable {
     let name: String
     let commit: Commit
 }
+
+extension Tag: UserReadable {
+    var userReadableString: String {
+        "Tag: \(name) \(commit.sha)"
+    }
+}

Sources/ChangeLogGenerator/Models/User.swift

@@ -12,3 +12,9 @@ struct User: Decodable {
     let login: String
     let htmlUrl: URL
 }
+
+extension User: UserReadable {
+    var userReadableString: String {
+        "User: \(htmlUrl)"
+    }
+}

Sources/ChangeLogGenerator/Models/UserReadable.swift

@@ -0,0 +1,23 @@
+//
+//  UserReadable.swift
+//  
+//
+//  Created by Mahmood Tahir on 2022-09-29.
+//
+
+import Foundation
+
+protocol UserReadable {
+    var userReadableString: String { get }
+}
+
+extension Array: UserReadable where Element: UserReadable {
+    var userReadableString: String {
+        [
+            "[\n",
+            reduce(into: "") { $0 += $1.userReadableString + ",\n"},
+            "]",
+        ]
+            .joined()
+    }
+}