Tutorials and dependencies updates

Package.resolved

@@ -3,10 +3,10 @@
     {
       "identity" : "async-http-client",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/swift-server/async-http-client.git",
+      "location" : "https://github.com/swift-server/async-http-client",
       "state" : {
-        "revision" : "fb308ee72f3d4c082a507033f94afa7395963ef3",
-        "version" : "1.21.0"
+        "revision" : "a22083713ee90808d527d0baa290c2fb13ca3096",
+        "version" : "1.21.1"
       }
     },
     {
@@ -77,8 +77,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-nio.git",
       "state" : {
-        "revision" : "fc63f0cf4e55a4597407a9fc95b16a2bc44b4982",
-        "version" : "2.64.0"
+        "revision" : "359c461e5561d22c6334828806cc25d759ca7aa6",
+        "version" : "2.65.0"
       }
     },
     {
@@ -95,8 +95,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-nio-http2.git",
       "state" : {
-        "revision" : "0904bf0feb5122b7e5c3f15db7df0eabe623dd87",
-        "version" : "1.30.0"
+        "revision" : "c6afe04165c865faaa687b42c32ed76dfcc91076",
+        "version" : "1.31.0"
       }
     },
     {

Package.swift

@@ -11,8 +11,8 @@ let package = Package(
 		.library(name: "CouchDBClient", targets: ["CouchDBClient"]),
 	],
 	dependencies: [
-		.package(url: "https://github.com/swift-server/async-http-client", from: "1.21.0"),
-		.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0")
+		.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.21.0"),
+		.package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.3.0")
 	],
 	targets: [
 		// Targets are the basic building blocks of a package. A target can define a module or a test suite.

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-1.swift

@@ -0,0 +1,13 @@
+import SwiftUI
+
+struct ContentView: View {
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+        }
+        .padding()
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-2.swift

@@ -0,0 +1,14 @@
+import SwiftUI
+import CouchDBClient
+
+struct ContentView: View {
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+        }
+        .padding()
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-3.swift

@@ -0,0 +1,24 @@
+import SwiftUI
+import CouchDBClient
+
+let couchDBClient = CouchDBClient(
+    couchProtocol: .http,
+    couchHost: "127.0.0.1",
+    couchPort: 5984,
+    userName: "admin",
+    userPassword: "yourPassword"
+)
+
+let dbName = "fortests"
+
+struct ContentView: View {
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+        }
+        .padding()
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-4.swift

@@ -0,0 +1,30 @@
+import SwiftUI
+import CouchDBClient
+
+let couchDBClient = CouchDBClient(
+    couchProtocol: .http,
+    couchHost: "127.0.0.1",
+    couchPort: 5984,
+    userName: "admin",
+    userPassword: "yourPassword"
+)
+
+let dbName = "fortests"
+
+class MyDoc: Identifiable, CouchDBRepresentable {
+    var _id: String?
+    var _rev: String?
+    var title: String
+}
+
+struct ContentView: View {
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+        }
+        .padding()
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-5.swift

@@ -0,0 +1,57 @@
+import SwiftUI
+import CouchDBClient
+
+let couchDBClient = CouchDBClient(
+    couchProtocol: .http,
+    couchHost: "127.0.0.1",
+    couchPort: 5984,
+    userName: "admin",
+    userPassword: "yourPassword"
+)
+
+let dbName = "fortests"
+
+class MyDoc: Identifiable, CouchDBRepresentable {
+    var _id: String?
+    var _rev: String?
+    var title: String
+}
+
+@Observable class DocsStore {
+    var docs = [MyDoc]()
+
+    func getDocs() async throws {
+        let response = try await couchDBClient.get(
+            fromDB: dbName,
+            uri: "_design/all/_view/list"
+        )
+
+        let expectedBytes = response.headers
+            .first(name: "content-length")
+            .flatMap(Int.init) ?? 1024 * 1024 * 10
+        var bytes = try await response.body.collect(upTo: expectedBytes)
+
+        guard let data = bytes.readData(length: bytes.readableBytes) else { return }
+
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = .secondsSince1970
+
+        let decodeResponse = try decoder.decode(RowsResponse<MyDoc>.self, from: data)
+
+        await MainActor.run { [self] in
+            docs = decodeResponse.rows.map({ $0.value })
+        }
+    }
+}
+
+struct ContentView: View {
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+        }
+        .padding()
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial-6.swift

@@ -0,0 +1,69 @@
+import SwiftUI
+import CouchDBClient
+
+let couchDBClient = CouchDBClient(
+    couchProtocol: .http,
+    couchHost: "127.0.0.1",
+    couchPort: 5984,
+    userName: "admin",
+    userPassword: "yourPassword"
+)
+
+let dbName = "fortests"
+
+class MyDoc: Identifiable, CouchDBRepresentable {
+    var _id: String?
+    var _rev: String?
+    var title: String
+}
+
+@Observable class DocsStore {
+    var docs = [MyDoc]()
+
+    func getDocs() async throws {
+        let response = try await couchDBClient.get(
+            fromDB: dbName,
+            uri: "_design/all/_view/list"
+        )
+
+        let expectedBytes = response.headers
+            .first(name: "content-length")
+            .flatMap(Int.init) ?? 1024 * 1024 * 10
+        var bytes = try await response.body.collect(upTo: expectedBytes)
+
+        guard let data = bytes.readData(length: bytes.readableBytes) else { return }
+
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = .secondsSince1970
+
+        let decodeResponse = try decoder.decode(RowsResponse<MyDoc>.self, from: data)
+
+        await MainActor.run { [self] in
+            docs = decodeResponse.rows.map({ $0.value })
+        }
+    }
+}
+
+struct ContentView: View {
+    @State var docsStore = DocsStore()
+    var body: some View {
+        VStack {
+            Image(systemName: "globe")
+                .imageScale(.large)
+                .foregroundStyle(.tint)
+            Text("Hello, world!")
+
+            List(docsStore.docs) { doc in
+                Text(doc.title)
+            }
+        }
+        .padding()
+        .task {
+            do {
+                try await docsStore.getDocs()
+            } catch {
+                print(error.localizedDescription)
+            }
+        }
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/SwiftUI/SwiftUITutorial.tutorial

@@ -0,0 +1,65 @@
+@Tutorial(time: 10) {
+    @Intro(title: "Using with a SwiftUI app") {
+		A SwiftUI app example
+
+		@Image(source: curlybraces.square.fill.svg, alt: "Application icon")
+    }
+
+    @Section(title: "Initialization") {
+        @ContentAndMedia {
+			Adding CouchDBClient to your project.
+
+            @Image(source: swift.svg, alt: "Swift icon")
+        }
+
+        @Steps {
+            @Step {
+				Open the "Package Dependencies" tab in Xcode.
+
+                @Image(source: swiftui-example-1.png, alt: "Xcode")
+            }
+
+			@Step {
+				Add `CouchDBClient` as a Swift Package dependency.
+
+				@Image(source: swiftui-example-2.png, alt: "Add CouchDBClient as a Swift Package dependency.")
+			}
+
+			@Step {
+				Open your View file.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-1.swift)
+			}
+
+			@Step {
+				Import `CouchDBClient`.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-2.swift)
+			}
+
+			@Step {
+				Create a CouchDBClient object, define connection settings and database name.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-3.swift)
+			}
+
+			@Step {
+				Define a model for your CouchDB document. It should conform to the `CouchDBRepresentable` and `Identifiable`  protocols.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-4.swift)
+			}
+
+			@Step {
+				Add a data source for your View.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-5.swift)
+			}
+
+			@Step {
+				Add getting the data and displaying it in the UI.
+
+				@Code(name: "ContentView.swift", file: SwiftUITutorial-6.swift)
+			}
+        }
+    }
+}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/Tutorial Table of Contents.tutorial

@@ -11,6 +11,7 @@
 		@Image(source: curlybraces.square.fill.svg, alt: "CouchDBClient logo")
 
         @TutorialReference(tutorial: "doc:macOSTutorial")
+		@TutorialReference(tutorial: "doc:SwiftUITutorial")
 		@TutorialReference(tutorial: "doc:VaporTutorial")
     }
 

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/macOS/macOSTutorial.tutorial

@@ -1,6 +1,6 @@
 @Tutorial(time: 10) {
-	@Intro(title: "Using in macOS app") {
-		Learn how to use CouchDBClient in your macOS app
+	@Intro(title: "macOS app example") {
+		Learn how to use `CouchDBClient` in a macOS app
 
 		@Image(source: curlybraces.square.fill.svg, alt: "Application icon")
 	}
@@ -32,7 +32,7 @@
 			}
 
 			@Step {
-				Create a CouchDBClient object, define database name and create a worker to perform requests.
+				Create a CouchDBClient object, define connection settings and database name.
 
 				@Code(name: "main.swift", file: macOSTutorial-3.swift)
 			}

Sources/CouchDBClient/CouchDBClient.docc/Tutorials/vapor/VaporTutorial-package-1.swift

@@ -0,0 +1,28 @@
+// swift-tools-version:5.10
+import PackageDescription
+
+let package = Package(
+	name: "spaceinbox.me",
+	platforms: [
+	   .macOS(.v13)
+	],
+	dependencies: [
+		// 💧 A server-side Swift web framework.
+		.package(url: "https://github.com/vapor/vapor", from: "4.0.0"),
+		.package(url: "https://github.com/vapor/leaf", from: "4.0.0"),
+	],
+	targets: [
+		.target(
+			name: "App",
+			dependencies: [
+				.product(name: "Leaf", package: "leaf"),
+				.product(name: "Vapor", package: "vapor"),
+			]
+		),
+		.executableTarget(name: "Run", dependencies: [.target(name: "App")]),
+		.testTarget(name: "AppTests", dependencies: [
+			.target(name: "App"),
+			.product(name: "XCTVapor", package: "vapor"),
+		])
+	]
+)