feat: Clean up Item dates

Closes #22

BREAKING CHANGE: Item.published has been renamed to Item.date.

Author: kevinrenskers

Sources/Saga/Item.swift

@@ -10,22 +10,24 @@ public struct EmptyMetadata: Metadata {
 
 /// A type-erased version of ``Item``.
 public protocol AnyItem: AnyObject {
+  var absoluteSource: Path { get }
   var relativeSource: Path { get }
   var filenameWithoutExtension: String { get }
   var relativeDestination: Path { get set }
   var title: String { get set }
-  var rawContent: String { get set }
   var body: String { get set }
-  var published: Date { get set }
-  var created: Date { get set }
-  var lastModified: Date { get set }
+  var date: Date { get set }
+  var lastModified: Date { get }
   var url: String { get }
 }
 
 /// A model reprenting an item.
 ///
 /// An item can be any text file (like a Markdown or RestructedText file). ``Reader``s will turn the file into an ``Item``, and ``Writer``s will turn the ``Item`` into a `String` (for example HTML or RSS) to be written to disk.
 public class Item<M: Metadata>: AnyItem {
+  /// The absolute path of the file
+  public let absoluteSource: Path
+
   /// The path of the file, relative to the site's `input`.
   public let relativeSource: Path
 
@@ -35,32 +37,27 @@ public class Item<M: Metadata>: AnyItem {
   /// The title of the item.
   public var title: String
 
-  /// The raw contents of the file, not parsed in any way.
-  public var rawContent: String
-
   /// The body of the file, without the metadata header, and without the first title.
   public var body: String
 
-  /// The published date of the item.
-  public var published: Date
-
-  /// The creation date of the item.
-  public var created: Date
+  /// The date of the item, defaults to the creation date.
+  /// Pleaae note that the creation date value can be inconsistent when cloning or pulling from git, see https://github.com/loopwerk/Saga/issues/21.
+  public var date: Date
 
   /// The last modified date of the item.
-  public var lastModified: Date
+  /// Pleaae note that this value can be inconsistent when cloning or pulling from git, see https://github.com/loopwerk/Saga/issues/21.
+  public let lastModified: Date
 
   /// The parsed metadata. ``Metadata`` can be any `Codable` object.
   public var metadata: M
 
-  public init(relativeSource: Path, relativeDestination: Path, title: String, rawContent: String, body: String, published: Date, created: Date, lastModified: Date, metadata: M) {
+  public init(absoluteSource: Path, relativeSource: Path, relativeDestination: Path, title: String, body: String, date: Date, lastModified: Date, metadata: M) {
+    self.absoluteSource = absoluteSource
     self.relativeSource = relativeSource
     self.relativeDestination = relativeDestination
     self.title = title
-    self.rawContent = rawContent
     self.body = body
-    self.published = published
-    self.created = created
+    self.date = date
     self.lastModified = lastModified
     self.metadata = metadata
   }

Sources/Saga/ProcessingStep.swift

@@ -44,14 +44,30 @@ internal class AnyProcessStep {
         unhandledFileContainer.handled = true
 
         do {
-          // Turn the file into an Item
-          let item = try await reader.convert(unhandledFileContainer.path, unhandledFileContainer.relativePath, unhandledFileContainer.relativePath.makeOutputPath(itemWriteMode: itemWriteMode))
+          // Use the Reader to convert the contents of the file to HTML
+          let partialItem = try await reader.convert(unhandledFileContainer.path)
+
+          // Then we try to decode the frontmatter (which is just a [String: String] dict) to proper metadata
+          let decoder = makeMetadataDecoder(for: partialItem.frontmatter ?? [:])
+          let date = try resolveDate(from: decoder)
+          let metadata = try M(from: decoder)
+
+          // Create the Item instance
+          let item = Item(
+            absoluteSource: unhandledFileContainer.path,
+            relativeSource: unhandledFileContainer.relativePath,
+            relativeDestination: unhandledFileContainer.relativePath.makeOutputPath(itemWriteMode: itemWriteMode),
+            title: partialItem.title ?? "",
+            body: partialItem.body,
+            date: date ?? unhandledFileContainer.path.creationDate ?? Date(),
+            lastModified: unhandledFileContainer.path.modificationDate ?? Date(),
+            metadata: metadata)
 
           // Process the Item if there's an itemProcessor
           if let itemProcessor = step.itemProcessor {
             await itemProcessor(item)
           }
-          
+
           // Store the generated Item if it passes the filter
           if step.filter(item) {
             unhandledFileContainer.item = item
@@ -67,13 +83,13 @@ internal class AnyProcessStep {
         }
       }
 
-      step.items = items.sorted(by: { left, right in left.published > right.published })
+      step.items = items.sorted(by: { left, right in left.date > right.date })
     }
 
     runWriters = {
       let allItems = fileStorage
         .compactMap(\.item)
-        .sorted(by: { left, right in left.published > right.published })
+        .sorted(by: { left, right in left.date > right.date })
 
       for writer in step.writers {
         try writer.run(step.items, allItems, fileStorage, outputPath, step.folder ?? "", fileIO)

Sources/Saga/Reader.swift

@@ -42,7 +42,7 @@ public struct Reader<M: Metadata> {
   /// Which file extensions can be handled by this reader? For example `md` or `rst`.
   var supportedExtensions: [String]
 
-  public typealias Converter = (_ absoluteSource: Path, _ relativeSource: Path, _ relativeDestination: Path) async throws -> Item<M>
+  public typealias Converter = (_ absoluteSource: Path) async throws -> (title: String?, body: String, frontmatter: [String:String]?)
 
   /// The function that will do the actual work of reading and converting a file path into an ``Item``.
   var convert: Converter

Sources/Saga/Writer.swift

@@ -69,7 +69,7 @@ public extension Writer {
       var itemsPerYear = [Int: [Item<M>]]()
 
       for item in items {
-        let year = item.published.year
+        let year = item.date.year
         if var itemsArray = itemsPerYear[year] {
           itemsArray.append(item)
           itemsPerYear[year] = itemsArray

Sources/Saga/utils.swift

@@ -36,7 +36,7 @@ public func publicationDateInFilename<M>(item: Item<M>) async {
   }
 
   // Set the date
-  item.published = date
+  item.date = date
 
   // And remove the first 11 characters from the filename
   let first11 = String(item.relativeSource.lastComponentWithoutExtension.prefix(11))