[read-me] Updated the read-me and minor changes to the tests

vapor-community · Dec 29, 2019 · ac88557 · ac88557
1 parent 6f807d4
commit ac88557
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -11,36 +11,37 @@ By using Swift's powerful language features and a pre-rendering algorithm, HTMLK
 
 Add the following in your `Package.swift` file
 ```swift
-.package(url: "https://github.com/vapor-community/HTMLKit.git", from: "2.0.0-alpha.9"),
+.package(url: "https://github.com/vapor-community/HTMLKit.git", from: "2.0.0-beta.2"),
 ```
-And register the provider and the different templates with in `configure.swift`
-```swift
-try services.register(HTMLKitProvider())
 
-// Or you can do it manually with
-let renderer = HTMLRenderer()
-try renderer.add(view: MyTemplate())
-services.register(renderer)
-```
+You can use the following providers in order to use HTMLKit with [Vapor 3](https://github.com/MatsMoll/htmlkit-vapor-3-provider) and for [Vapor 4](https://github.com/MatsMoll/htmlkit-vapor-provider)
 
 ## Usage
 
 To create a HTML template, conform to the `HTMLTemplate` protocol.
 
 ```swift
+struct TemplateData {
+    let name: String
+    let handle: String
+    let title: String?
+}
+
 struct SimpleTemplate: HTMLTemplate {
 
-    @TemplateValue(String?.self)
+    @TemplateValue(TemplateData.self)
     var context
 
     var body: HTML {
         Document(type: .html5) {
             Head {
-                Title { context }
+                Title { context.title }
+                Author { context.name }
+                    .twitter(handle: context.handle)
             }
             Body {
-                Unwrap(context) { string in
-                    P { string }
+                Unwrap(context.title) { title in
+                    P { title }
                 }
             }
         }
@@ -51,6 +52,23 @@ struct SimpleTemplate: HTMLTemplate {
 try SimpleTemplate().render(with: "Some string", for: req)
 ```
 
+This will render somehing like this
+```html
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Some Title</title>
+        <meta property='og:title' content='Some Title'>
+        <meta name='twitter:title' content='Some Title'>
+        <meta name='author' content='Mats'>
+        <meta name='twitter:creator' content='@SomeTwitterHandle'>
+    </head>
+    <body>
+        <p>Some Title</p>
+    </body>
+</html>
+```
+
 And to create a HTML component, just comform to the `HTMLComponent` protocol. 
 
 ```swift
@@ -89,7 +107,7 @@ struct SomePage: HTMLPage {
     var body: HTML {
         Div {
             Alert(isDismissable: false) {
-                H3("Some Title")
+                H3 { "Some Title" }
             }
         }
     }
@@ -164,3 +182,7 @@ struct LocalizedDateView: HTMLTemplate {
 * [BootstrapKit](https://github.com/MatsMoll/BootstrapKit) - A higher level library that makes it easier to work with Boostrap 4.
 * [Vapor TIL fork](https://github.com/MatsMoll/vapor-til) - Compare Leaf to HTMLKit in this fork of the TIL app.
 * Convert pure HTML code to HTMLKit code using this [HTML-to-HTMLKit converter](https://github.com/MatsMoll/HTMLKit-code-converter).
+
+## Known Issues
+
+* Linux compiler can sometimes struggle with compiling the code when a combination of complex use of generics, default values or deeply nested function builders are used.
diff --git a/Sources/HTMLKit/HTMLDocument.swift b/Sources/HTMLKit/HTMLDocument.swift
@@ -35,6 +35,9 @@ public struct Document: HTMLPage {
     }
 
     public var body: HTML {
-        "<!DOCTYPE \(type.rawValue)>" + content
+        [
+            "<!DOCTYPE \(type.rawValue)>",
+            HTMLNode { content }
+        ]
     }
 }
diff --git a/Tests/HTMLKitTests/HTMLKitTests.swift b/Tests/HTMLKitTests/HTMLKitTests.swift
@@ -173,11 +173,6 @@ final class HTMLKitTests: XCTestCase {
 //        }
 //    }
 
-    func testMakeOptional() throws {
-        let metadataPageDynamic = try renderer.render(raw: MetadataTestDynamic.self,        with: .init(name: "Mats", handle: "@MatsMoll"))
-        XCTAssertEqual(metadataPageDynamic, "<!DOCTYPE html><head><meta name='author' content='Mats'><meta name='twitter:creator' content='@MatsMoll'><title>Some title</title><meta property='og:title' content='Some title'><meta name='twitter:title' content='Some title'><meta name='description' content='Some description'><meta property='og:description' content='Some description'><meta name='twitter:description' content='Some description'></head>")
-    }
-
     func testHtmlRenderingTests() throws {
 
         let testDate = Date()
@@ -248,8 +243,8 @@ final class HTMLKitTests: XCTestCase {
 //        XCTAssertEqual(markdown.replacingOccurrences(of: "\n", with: ""), "<div><h1>Title: Hello</h1><h2>Description here:</h2><p>World</p></div>")
         XCTAssertEqual(english, "<div><h1>Hello World!</h1><p>You have 3 unread messages.</p><p>You have 2 unread messages.</p><p>You have an unread message</p></div>")
         XCTAssertEqual(norwegian, "<div><h1>Hei Verden!</h1><p>Du har 3 uleste meldinger.</p><p>Du har 2 uleste meldinger.</p><p>Du har en ulest melding</p></div>")
-        XCTAssertEqual(metadataPage, "<!DOCTYPE html><head><meta name='author' content='Mats'><meta name='twitter:creator' content='@MatsMoll'><title>Some title</title><meta property='og:title' content='Some title'><meta name='twitter:title' content='Some title'><meta name='description' content='Some description'><meta property='og:description' content='Some description'><meta name='twitter:description' content='Some description'></head>")
-        XCTAssertEqual(metadataPageDynamic, "<!DOCTYPE html><head><meta name='author' content='Mats'><meta name='twitter:creator' content='@MatsMoll'><title>Some title</title><meta property='og:title' content='Some title'><meta name='twitter:title' content='Some title'><meta name='description' content='Some description'><meta property='og:description' content='Some description'><meta name='twitter:description' content='Some description'></head>")
+        XCTAssertEqual(metadataPage, "<!DOCTYPE html><html><head><meta name='author' content='Mats'><meta name='twitter:creator' content='@MatsMoll'><title>Some title</title><meta property='og:title' content='Some title'><meta name='twitter:title' content='Some title'><meta name='description' content='Some description'><meta property='og:description' content='Some description'><meta name='twitter:description' content='Some description'></head></html>")
+        XCTAssertEqual(metadataPageDynamic, "<!DOCTYPE html><html><head><meta name='author' content='Mats'><meta name='twitter:creator' content='@MatsMoll'><title>Some title</title><meta property='og:title' content='Some title'><meta name='twitter:title' content='Some title'><meta name='description' content='Some description'><meta property='og:description' content='Some description'><meta name='twitter:description' content='Some description'></head></html>")
         XCTAssertEqual(date, "<div><p>\(shortDateFormatter.string(from: testDate))</p><p>\(customDateFormatter.string(from: testDate))</p></div>")
         XCTAssertEqual(optionalDateNil, "<div><p></p><p></p></div>")
         XCTAssertEqual(optionalDate, "<div><p>\(shortDateFormatter.string(from: testDate))</p><p>\(customDateFormatter.string(from: testDate))</p></div>")

diff --git a/Tests/HTMLKitTests/HTMLTestDocuments.swift b/Tests/HTMLKitTests/HTMLTestDocuments.swift
@@ -75,19 +75,17 @@ struct BaseView: HTMLComponent {
 
     var body: HTML {
         Document(type: .html5) {
-            HTMLNode {
-                Head {
-                    Title { context }
-                        .useTwitter(metadata: false)
-                        .useOpenGraph(metadata: false)
-                    Stylesheet(url: "some url")
-                    Meta()
-                        .name(.viewport)
-                        .content("width=device-width, initial-scale=1.0")
-                }
-                Body {
-                    content
-                }
+            Head {
+                Title { context }
+                    .useTwitter(metadata: false)
+                    .useOpenGraph(metadata: false)
+                Stylesheet(url: "some url")
+                Meta()
+                    .name(.viewport)
+                    .content("width=device-width, initial-scale=1.0")
+            }
+            Body {
+                content
             }
         }
     }