fix: There is no reason for Reader to have the generic type M any longer

loopwerk · Feb 21, 2025 · 17daf71 · 17daf71
1 parent bc4d411
commit 17daf71
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 140 deletions.
diff --git a/Sources/Saga/ProcessingStep.swift b/Sources/Saga/ProcessingStep.swift
@@ -3,13 +3,13 @@ import PathKit
 
 internal class ProcessStep<M: Metadata> {
   let folder: Path?
-  let readers: [Reader<M>]
+  let readers: [Reader]
   let filter: (Item<M>) -> Bool
   let itemProcessor: ((Item<M>) async -> Void)?
   let writers: [Writer<M>]
   var items: [Item<M>]
 
-  init(folder: Path?, readers: [Reader<M>], itemProcessor: ((Item<M>) async -> Void)?, filter: @escaping (Item<M>) -> Bool, writers: [Writer<M>]) {
+  init(folder: Path?, readers: [Reader], itemProcessor: ((Item<M>) async -> Void)?, filter: @escaping (Item<M>) -> Bool, writers: [Writer<M>]) {
     self.folder = folder
     self.readers = readers
     self.itemProcessor = itemProcessor

diff --git a/Sources/Saga/Reader.swift b/Sources/Saga/Reader.swift
@@ -16,29 +16,21 @@ import PathKit
 /// ```swift
 /// public extension Reader {
 ///   static func myMarkdownReader() -> Self {
-///     Reader(supportedExtensions: ["md", "markdown"], convert: { absoluteSource, relativeSource, relativeDestination in
+///     Reader(supportedExtensions: ["md", "markdown"], convert: { absoluteSource in
 ///       let content: String = try absoluteSource.read()
 ///
-///       // Somehow turn `content` into an ``Item``, and return it:
-///       let item = Item(
-///         relativeSource: ...,
-///         relativeDestination: ...,
-///         title: ...,
-///         rawContent: ...,
-///         body: ...,
-///         date: ...,
-///         lastModified: ...,
-///         metadata: ...
-///       )
+///       // Parse `content` markdown
+///       // ...
 ///
-///       return item
+///       // and return the parts:
+///       return (title: "...", body: "...", frontmatter: [:])
 ///     })
 ///   }
 /// }
 /// ```
 ///
 /// > Note: Instead of constructing your own `Reader` from scratch for your website, you should probably install one such as [SagaParsleyMarkdownReader](https://github.com/loopwerk/SagaParsleyMarkdownReader), [SagaPythonMarkdownReader](https://github.com/loopwerk/SagaPythonMarkdownReader), or [SagaInkMarkdownReader](https://github.com/loopwerk/SagaInkMarkdownReader).
-public struct Reader<M: Metadata> {
+public struct Reader {
   /// Which file extensions can be handled by this reader? For example `md` or `rst`.
   var supportedExtensions: [String]
 

diff --git a/Sources/Saga/Saga.swift b/Sources/Saga/Saga.swift
@@ -70,7 +70,7 @@ public class Saga {
   ///   - writers: The writers that will be used by this step.
   /// - Returns: The Saga instance itself, so you can chain further calls onto it.
   @discardableResult
-  public func register<M: Metadata>(folder: Path? = nil, metadata: M.Type = EmptyMetadata.self, readers: [Reader<M>], itemProcessor: ((Item<M>) async -> Void)? = nil, filter: @escaping ((Item<M>) -> Bool) = { _ in true }, itemWriteMode: ItemWriteMode = .moveToSubfolder, writers: [Writer<M>]) throws -> Self {
+  public func register<M: Metadata>(folder: Path? = nil, metadata: M.Type = EmptyMetadata.self, readers: [Reader], itemProcessor: ((Item<M>) async -> Void)? = nil, filter: @escaping ((Item<M>) -> Bool) = { _ in true }, itemWriteMode: ItemWriteMode = .moveToSubfolder, writers: [Writer<M>]) throws -> Self {
     let step = ProcessStep(folder: folder, readers: readers, itemProcessor: itemProcessor, filter: filter, writers: writers)
     self.processSteps.append(
       .init(

diff --git a/docs/data/documentation/saga/reader.json b/docs/data/documentation/saga/reader.json
@@ -80,40 +80,6 @@
             {
               "kind" : "identifier",
               "text" : "Reader"
-            },
-            {
-              "kind" : "text",
-              "text" : "<"
-            },
-            {
-              "kind" : "genericParameter",
-              "text" : "M"
-            },
-            {
-              "kind" : "text",
-              "text" : "> "
-            },
-            {
-              "kind" : "keyword",
-              "text" : "where"
-            },
-            {
-              "kind" : "text",
-              "text" : " "
-            },
-            {
-              "kind" : "typeIdentifier",
-              "text" : "M"
-            },
-            {
-              "kind" : "text",
-              "text" : " : "
-            },
-            {
-              "identifier" : "doc:\/\/Saga\/documentation\/Saga\/Metadata",
-              "kind" : "typeIdentifier",
-              "preciseIdentifier" : "s:4Saga8MetadataP",
-              "text" : "Metadata"
             }
           ]
         }
@@ -170,22 +136,14 @@
           "code" : [
             "public extension Reader {",
             "  static func myMarkdownReader() -> Self {",
-            "    Reader(supportedExtensions: [\"md\", \"markdown\"], convert: { absoluteSource, relativeSource, relativeDestination in",
+            "    Reader(supportedExtensions: [\"md\", \"markdown\"], convert: { absoluteSource in",
             "      let content: String = try absoluteSource.read()",
             "",
-            "      \/\/ Somehow turn `content` into an ``Item``, and return it:",
-            "      let item = Item(",
-            "        relativeSource: ...,",
-            "        relativeDestination: ...,",
-            "        title: ...,",
-            "        rawContent: ...,",
-            "        body: ...,",
-            "        date: ...,",
-            "        lastModified: ...,",
-            "        metadata: ...",
-            "      )",
+            "      \/\/ Parse `content` markdown",
+            "      \/\/ ...",
             "",
-            "      return item",
+            "      \/\/ and return the parts:",
+            "      return (title: \"...\", body: \"...\", frontmatter: [:])",
             "    })",
             "  }",
             "}"
@@ -544,15 +502,7 @@
     },
     {
       "kind" : "text",
-      "text" : "<"
-    },
-    {
-      "kind" : "typeIdentifier",
-      "text" : "M"
-    },
-    {
-      "kind" : "text",
-      "text" : ">."
+      "text" : "."
     },
     {
       "kind" : "typeIdentifier",

diff --git a/docs/data/documentation/saga/reader/init(supportedextensions:convert:).json b/docs/data/documentation/saga/reader/init(supportedextensions:convert:).json
@@ -19,7 +19,7 @@
   },
   "kind" : "symbol",
   "metadata" : {
-    "externalID" : "s:4Saga6ReaderV19supportedExtensions7convertACyxGSaySSG_SSSg5title_SS4bodySDyS2SGSg11frontmattert7PathKit0I0VYaKctcfc",
+    "externalID" : "s:4Saga6ReaderV19supportedExtensions7convertACSaySSG_SSSg5title_SS4bodySDyS2SGSg11frontmattert7PathKit0I0VYaKctcfc",
     "fragments" : [
       {
         "kind" : "identifier",
@@ -61,15 +61,7 @@
       },
       {
         "kind" : "text",
-        "text" : "<"
-      },
-      {
-        "kind" : "typeIdentifier",
-        "text" : "M"
-      },
-      {
-        "kind" : "text",
-        "text" : ">."
+        "text" : "."
       },
       {
         "kind" : "typeIdentifier",
@@ -151,15 +143,7 @@
             },
             {
               "kind" : "text",
-              "text" : "<"
-            },
-            {
-              "kind" : "typeIdentifier",
-              "text" : "M"
-            },
-            {
-              "kind" : "text",
-              "text" : ">."
+              "text" : "."
             },
             {
               "identifier" : "doc:\/\/Saga\/documentation\/Saga\/Reader\/Converter",
@@ -369,15 +353,7 @@
     },
     {
       "kind" : "text",
-      "text" : "<"
-    },
-    {
-      "kind" : "typeIdentifier",
-      "text" : "M"
-    },
-    {
-      "kind" : "text",
-      "text" : ">."
+      "text" : "."
     },
     {
       "kind" : "typeIdentifier",

diff --git a/docs/data/documentation/saga/saga.json b/docs/data/documentation/saga/saga.json
@@ -519,15 +519,7 @@
     },
     {
       "kind" : "text",
-      "text" : "<"
-    },
-    {
-      "kind" : "typeIdentifier",
-      "text" : "M"
-    },
-    {
-      "kind" : "text",
-      "text" : ">], "
+      "text" : "], "
     },
     {
       "kind" : "externalParam",

diff --git a/...a/saga/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:).json b/...a/saga/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:).json
@@ -19,7 +19,7 @@
   },
   "kind" : "symbol",
   "metadata" : {
-    "externalID" : "s:4SagaAAC8register6folder8metadata7readers13itemProcessor6filter0F9WriteMode7writersABXD7PathKit0L0VSg_xmSayAA6ReaderVyxGGyAA4ItemCyxGYacSgSbAUcAA0oiJ0OSayAA6WriterVyxGGtKAA8MetadataRzlF",
+    "externalID" : "s:4SagaAAC8register6folder8metadata7readers13itemProcessor6filter0F9WriteMode7writersABXD7PathKit0L0VSg_xmSayAA6ReaderVGyAA4ItemCyxGYacSgSbATcAA0oiJ0OSayAA6WriterVyxGGtKAA8MetadataRzlF",
     "fragments" : [
       {
         "kind" : "keyword",
@@ -93,15 +93,7 @@
       },
       {
         "kind" : "text",
-        "text" : "<"
-      },
-      {
-        "kind" : "typeIdentifier",
-        "text" : "M"
-      },
-      {
-        "kind" : "text",
-        "text" : ">], "
+        "text" : "], "
       },
       {
         "kind" : "externalParam",
@@ -336,15 +328,7 @@
             },
             {
               "kind" : "text",
-              "text" : "<"
-            },
-            {
-              "kind" : "typeIdentifier",
-              "text" : "M"
-            },
-            {
-              "kind" : "text",
-              "text" : ">], "
+              "text" : "], "
             },
             {
               "kind" : "externalParam",
@@ -1029,15 +1013,7 @@
     },
     {
       "kind" : "text",
-      "text" : "<"
-    },
-    {
-      "kind" : "typeIdentifier",
-      "text" : "M"
-    },
-    {
-      "kind" : "text",
-      "text" : ">], "
+      "text" : "], "
     },
     {
       "kind" : "externalParam",

diff --git a/docs/index/index.json b/docs/index/index.json
@@ -33,7 +33,7 @@
               },
               {
                 "path" : "\/documentation\/saga\/reader\/init(supportedextensions:convert:)",
-                "title" : "init(supportedExtensions: [String], convert: Reader<M>.Converter)",
+                "title" : "init(supportedExtensions: [String], convert: Reader.Converter)",
                 "type" : "init"
               },
               {
@@ -232,7 +232,7 @@
               },
               {
                 "path" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)",
-                "title" : "func register<M>(folder: Path?, metadata: M.Type, readers: [Reader<M>], itemProcessor: ((Item<M>) async -> Void)?, filter: ((Item<M>) -> Bool), itemWriteMode: ItemWriteMode, writers: [Writer<M>]) throws -> Self",
+                "title" : "func register<M>(folder: Path?, metadata: M.Type, readers: [Reader], itemProcessor: ((Item<M>) async -> Void)?, filter: ((Item<M>) -> Bool), itemWriteMode: ItemWriteMode, writers: [Writer<M>]) throws -> Self",
                 "type" : "method"
               },
               {