update README reflecting recent changes, and...

- fixed HTMX attribute behaviors that accept a boolean or the value is empty

Author: RandomHashTags

README.md

@@ -103,16 +103,16 @@ Using String Interpolation.
 > You will get a compiler warning saying *interpolation may introduce raw HTML*.
 > 
 > Its up to you whether or not to suppress this warning or escape the HTML at runtime using an method described above.
+> 
+> Swift HTMLKit tries to [replace](https://github.com/RandomHashTags/swift-htmlkit/blob/94793984763308ef5275dd9f71ea0b5e83fea417/Sources/HTMLKitMacros/HTMLElement.swift#L423) known interpolation at compile time with a compile time equivalent for the best performance. It is currently limited due to macro expansions being sandboxed and lexical contexts/AST not being available for macro arguments. This means referencing content known at compile time in a html macro won't get replaced by its literal contents. [Read more about this limitation](https://forums.swift.org/t/swift-lexical-lookup-for-referenced-stuff-located-outside-scope-current-file/75776/6).
 
 #### Example
 ```swift
-let string:String = "any string value", integer:Int = -69, float:Float = 3.14159
+let string:String = "any string value", integer:Int = -69, float:Float = 3.141592
 
-// ✅ DO
 let _:String = #p("\(string); \(integer); \(float)")
 let _:String = #p("\(string)", "; ", String(describing: integer), "; ", float.description)
-
-// ❌ DON'T; compiler error: String Interpolation required
+// the below also works
 let integer_string:String = String(describing: integer), float_string:String = String(describing: float)
 let _:String = #p(string, "; ", integer_string, "; ", float_string)
 
@@ -186,6 +186,46 @@ Use a different html macro. Currently supported types (more to come with new lan
 
 </details>
 
+### HTMX
+
+<details>
+
+<summary>How do I use HTMX?</summary>
+
+Use the `.htmx(<htmx attribute>)` global attribute. All HTMX 2.0 attributes are supported (including web socket).
+
+#### Examples
+```swift
+
+// <div hx-boost="true"></div>
+var string:StaticString = #div(attributes: [.htmx(.boost(.true))])
+
+// <div hx-get="/test"></div>
+string = #div(attributes: [.htmx(.get("/test"))])
+
+// <div hx-on::abort="bruh()"></div>
+string = #div(attributes: [.htmx(.on(.abort, "bruh()"))])
+
+// <div hx-on::after-on-load="test()"></div>
+string = #div(attributes: [.htmx(.on(.afterOnLoad, "test()"))])
+
+// <div hx-on:click="thing()"></div>
+string = #div(attributes: [.htmx(.onevent(.click, "thing()"))])
+
+// <div hx-preserve></div>
+string = #div(attributes: [.htmx(.preserve(true))])
+
+// <div ws-connect="/chatroom"></div>
+string = #div(attributes: [.htmx(.ws(.connect("/chatroom")))])
+
+// <div hx-ext="ws" ws-send></div>
+string = #div(attributes: [.htmx(.ext("ws")), .htmx(.ws(.send(true)))])
+
+```
+
+</details>
+
+
 ## Benchmarks
 - Libraries tested
   - [BinaryBuilds/swift-html](https://github.com/BinaryBirds/swift-html) v1.7.0 (patched version [here](https://github.com/RandomHashTags/fork-bb-swift-html))

Sources/HTMLKitMacros/HTMLElement.swift

@@ -186,18 +186,40 @@ private extension HTMLElement {
                             if let htmx:HTMLElementAttribute.HTMX = HTMLElementAttribute.HTMX(rawValue: string) {
                                 key = "hx-" + htmx.key
                                 let htmlValue:String = htmx.htmlValue
-                                var delimiter:String = "\\\""
+                                var delimiter:String = "\\\"", isBoolean:Bool = false
+                                func check_boolean(_ boolean: Bool) {
+                                    isBoolean = true
+                                    if !boolean {
+                                        value = ""
+                                    }
+                                }
                                 switch htmx {
+                                    case .disable(let boolean),
+                                            .historyElt(let boolean),
+                                            .preserve(let boolean):
+                                        check_boolean(boolean)
+                                        break
                                     case .request(_, _, _, _), .headers(_, _):
                                         delimiter = "'"
                                         break
-                                    case .ws(let value):
-                                        key = "ws-" + value.key
+                                    case .ws(let ws_value):
+                                        key = "ws-" + ws_value.key
+                                        switch ws_value {
+                                            case .send(let boolean):
+                                                check_boolean(boolean)
+                                                break
+                                            default:
+                                                break
+                                        }
                                         break
                                     default:
                                         break
                                 }
-                                value = key + (htmlValue.isEmpty ? "" : "=" + delimiter + htmlValue + delimiter)
+                                if isBoolean {
+                                    value = value == nil || !value.isEmpty ? key : nil // only allow the value to be added if the boolean value is true
+                                } else {
+                                    value = key + "=" + delimiter + htmlValue + delimiter
+                                }
                             }
                         } else if let string:String = parse_attribute(context: context, elementType: elementType, key: key, expression: first_expression, lookupFiles: lookupFiles) {
                             value = string

Sources/HTMLKitUtilities/HTMX.swift

@@ -510,7 +510,7 @@ public extension HTMLElementAttribute.HTMX {
 public extension HTMLElementAttribute.HTMX {
     enum WebSocket {
         case connect(String)
-        case send(String)
+        case send(Bool)
 
         public init?(rawValue: String) {
             guard rawValue.last == ")" else { return nil }
@@ -519,9 +519,12 @@ public extension HTMLElementAttribute.HTMX {
             func string() -> String {
                 return String(rawValue[rawValue.index(start, offsetBy: key.count + 2)..<end_minus_one])
             }
+            func boolean() -> Bool {
+                return rawValue[rawValue.index(start, offsetBy: key.count + 1)..<end] == "true"
+            }
             switch key {
                 case "connect": self = .connect(string())
-                case "send": self = .send(string())
+                case "send": self = .send(boolean())
                 default: return nil
             }
         }
@@ -536,7 +539,7 @@ public extension HTMLElementAttribute.HTMX {
         public var htmlValue : String {
             switch self {
                 case .connect(let value): return value
-                case .send(let value): return value
+                case .send(_): return ""
             }
         }
 

Tests/HTMLKitTests/HTMXTests.swift

@@ -9,6 +9,7 @@ import Testing
 import HTMLKit
 
 struct HTMXTests {
+    // MARK: boost
     @Test func boost() {
         var string:StaticString = #div(attributes: [.htmx(.boost(.true))])
         #expect(string == "<div hx-boost=\"true\"></div>")
@@ -17,10 +18,22 @@ struct HTMXTests {
         #expect(string == "<div hx-boost=\"false\"></div>")
     }
 
+    // MARK: disable
+    @Test func disable() {
+        var string:StaticString = #div(attributes: [.htmx(.disable(true))])
+        #expect(string == "<div hx-disable></div>")
+
+        string = #div(attributes: [.htmx(.disable(false))])
+        #expect(string == "<div></div>")
+    }
+
     // MARK: get
     @Test func get() {
-        let string:StaticString = #div(attributes: [.htmx(.get("/test"))])
+        var string:StaticString = #div(attributes: [.htmx(.get("/test"))])
         #expect(string == "<div hx-get=\"/test\"></div>")
+
+        string = #div(attributes: [.htmx(.get(""))])
+        #expect(string == "<div hx-get=\"\"></div>")
     }
 
     // MARK: headers
@@ -66,6 +79,15 @@ struct HTMXTests {
         return set
     }
 
+    // MARK: history-elt
+    @Test func historyElt() {
+        var string:StaticString = #div(attributes: [.htmx(.historyElt(true))])
+        #expect(string == "<div hx-history-elt></div>")
+
+        string = #div(attributes: [.htmx(.historyElt(false))])
+        #expect(string == "<div></div>")
+    }
+
     // MARK: on
     @Test func on() {
         var string:StaticString = #div(attributes: [.htmx(.on(.abort, "bruh"))])
@@ -90,6 +112,15 @@ struct HTMXTests {
         #expect(string == "<div hx-post=\"https://github.com/RandomHashTags\"></div>")
     }
 
+    // MARK: preserve
+    @Test func preserve() {
+        var string:StaticString = #div(attributes: [.htmx(.preserve(true))])
+        #expect(string == "<div hx-preserve></div>")
+
+        string = #div(attributes: [.htmx(.preserve(false))])
+        #expect(string == "<div></div>")
+    }
+
     // MARK: replaceURL
     @Test func replaceURL() {
         var string:StaticString = #div(attributes: [.htmx(.replaceURL(.true))])
@@ -125,10 +156,13 @@ struct HTMXTests {
 
     // MARK: ws
     @Test func ws() {
-        var string:StaticString = #div(attributes: [.htmx(.ws(.connect("https://paradigm-app.com")))])
-        #expect(string == "<div ws-connect=\"https://paradigm-app.com\"></div>")
+        var string:StaticString = #div(attributes: [.htmx(.ws(.connect("/chatroom")))])
+        #expect(string == "<div ws-connect=\"/chatroom\"></div>")
+
+        string = #div(attributes: [.htmx(.ext("ws")), .htmx(.ws(.send(true)))])
+        #expect(string == "<div hx-ext=\"ws\" ws-send></div>")
 
-        string = #div(attributes: [.htmx(.ext("ws")), .htmx(.ws(.send("https://linktr.ee/anderson_evan")))])
-        #expect(string == "<div hx-ext=\"ws\" ws-send=\"https://linktr.ee/anderson_evan\"></div>")
+        string = #div(attributes: [.htmx(.ext("ws")), .htmx(.ws(.send(false)))])
+        #expect(string == "<div hx-ext=\"ws\"></div>")
     }
 }