fix: Add versioning to site.yaml (#133)

inseven · Sep 1, 2023 · d791ffa · d791ffa
1 parent b1f9300
commit d791ffa
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/Sources/InContextCore/Settings.swift b/Sources/InContextCore/Settings.swift
@@ -28,19 +28,25 @@ import Foundation
 struct Settings: Decodable {
 
     private enum CodingKeys: String, CodingKey {
+        case version
         case title
         case author
         case url
         case metadata
     }
 
+    let version: Int
     let title: String
     let author: String?
     let url: URL
     let metadata: [String: Any]
 
     init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.version = try container.decode(Int.self, forKey: .version)
+        guard version == 1 else {
+            throw InContextError.internalInconsistency("Unsupported settings version (\(version)).")
+        }
         self.title = try container.decode(String.self, forKey: .title)
         self.author = try container.decodeIfPresent(String.self, forKey: .author)
         self.url = try container.decode(URL.self, forKey: .url)

diff --git a/Tests/InContextTests/Tests/ImageImporterTests.swift b/Tests/InContextTests/Tests/ImageImporterTests.swift
@@ -30,6 +30,7 @@ class ImageImporterTests: ContentTestCase {
     func testExtractTitle() async throws {
 
         _ = try defaultSourceDirectory.add("site.yaml", contents: """
+version: 1
 title: Example
 url: http://example.com
 build_steps:

diff --git a/Tests/InContextTests/Tests/MarkdownImporterTests.swift b/Tests/InContextTests/Tests/MarkdownImporterTests.swift
@@ -29,6 +29,7 @@ class MarkdownImporterTests: ContentTestCase {
 
     func testMarkdownTitleOverride() async throws {
         _ = try defaultSourceDirectory.add("site.yaml", contents: """
+version: 1
 title: Example
 url: http://example.com
 build_steps:
@@ -59,6 +60,7 @@ These are the contents of the file.
 
     func testMarkdownTitleFromFile() async throws {
         _ = try defaultSourceDirectory.add("site.yaml", contents: """
+version: 1
 title: Example
 url: http://example.com
 build_steps: