Initial Development (#1)

Tests, README, etc.

src/ViewEngine.Htmx.Tests/Tests.fs

@@ -0,0 +1,245 @@
+module Giraffe.ViewEngine.Htmx.Tests
+
+open Giraffe.ViewEngine
+open Xunit
+
+/// Tests for the HxEncoding module
+module Encoding =
+  
+  [<Fact>]
+  let ``Form is correct`` () =
+    Assert.Equal ("application/x-www-form-urlencoded", HxEncoding.Form)
+  
+  [<Fact>]
+  let ``MultipartForm is correct`` () =
+    Assert.Equal ("multipart/form-data", HxEncoding.MultipartForm)
+
+
+/// Tests for the HxParams module
+module Params =
+  
+  [<Fact>]
+  let ``All is correct`` () =
+    Assert.Equal ("*", HxParams.All)
+  
+  [<Fact>]
+  let ``None is correct`` () =
+    Assert.Equal ("none", HxParams.None)
+
+  [<Fact>]
+  let ``With succeeds with empty list`` () =
+    Assert.Equal ("", HxParams.With [])
+  
+  [<Fact>]
+  let ``With succeeds with one list item`` () =
+    Assert.Equal ("boo", HxParams.With [ "boo" ])
+  
+  [<Fact>]
+  let ``With succeeds with multiple list items`` () =
+    Assert.Equal ("foo,bar,baz", HxParams.With [ "foo"; "bar"; "baz" ])
+
+  [<Fact>]
+  let ``Except succeeds with empty list`` () =
+    Assert.Equal ("not ", HxParams.Except [])
+  
+  [<Fact>]
+  let ``Except succeeds with one list item`` () =
+    Assert.Equal ("not that", HxParams.Except [ "that" ])
+  
+  [<Fact>]
+  let ``Except succeeds with multiple list items`` () =
+    Assert.Equal ("not blue,green", HxParams.Except [ "blue"; "green" ])
+
+
+/// Tests for the HxSwap module
+module Swap =
+  
+  [<Fact>]
+  let ``InnerHtml is correct`` () =
+    Assert.Equal ("innerHTML", HxSwap.InnerHtml)
+
+  [<Fact>]
+  let ``OuterHtml is correct`` () =
+    Assert.Equal ("outerHTML", HxSwap.OuterHtml)
+
+  [<Fact>]
+  let ``BeforeBegin is correct`` () =
+    Assert.Equal ("beforebegin", HxSwap.BeforeBegin)
+
+  [<Fact>]
+  let ``BeforeEnd is correct`` () =
+    Assert.Equal ("beforeend", HxSwap.BeforeEnd)
+
+  [<Fact>]
+  let ``AfterBegin is correct`` () =
+    Assert.Equal ("afterbegin", HxSwap.AfterBegin)
+
+  [<Fact>]
+  let ``AfterEnd is correct`` () =
+    Assert.Equal ("afterend", HxSwap.AfterEnd)
+
+  [<Fact>]
+  let ``None is correct`` () =
+    Assert.Equal ("none", HxSwap.None)
+
+
+/// Tests for the HxTrigger module
+module Trigger =
+  
+  [<Fact>]
+  let ``Click is correct`` () =
+    Assert.Equal ("click", HxTrigger.Click)
+  
+  [<Fact>]
+  let ``Load is correct`` () =
+    Assert.Equal ("load", HxTrigger.Load)
+  
+  [<Fact>]
+  let ``Filter.Alt succeeds`` () =
+    Assert.Equal ("click[altKey]", HxTrigger.Filter.Alt HxTrigger.Click)
+  
+  [<Fact>]
+  let ``Filter.Ctrl succeeds`` () =
+    Assert.Equal ("click[ctrlKey]", HxTrigger.Filter.Ctrl HxTrigger.Click)
+  
+  [<Fact>]
+  let ``Filter.Shift succeeds`` () =
+    Assert.Equal ("click[shiftKey]", HxTrigger.Filter.Shift HxTrigger.Click)
+  
+  [<Fact>]
+  let ``Filter.CtrlAlt succeeds`` () =
+    Assert.Equal ("click[ctrlKey&&altKey]", HxTrigger.Filter.CtrlAlt HxTrigger.Click)
+
+  [<Fact>]
+  let ``Filter.CtrlShift succeeds`` () =
+    Assert.Equal ("click[ctrlKey&&shiftKey]", HxTrigger.Filter.CtrlShift HxTrigger.Click)
+
+  [<Fact>]
+  let ``Filter.CtrlAltShift succeeds`` () =
+    Assert.Equal ("click[ctrlKey&&altKey&&shiftKey]", HxTrigger.Filter.CtrlAltShift HxTrigger.Click)
+
+  [<Fact>]
+  let ``Filter.AltShift succeeds`` () =
+    Assert.Equal ("click[altKey&&shiftKey]", HxTrigger.Filter.AltShift HxTrigger.Click)
+
+
+/// Tests for the HtmxAttrs module
+module Attributes =
+  
+  /// Pipe-able assertion for a rendered node 
+  let shouldRender expected node = Assert.Equal (expected, RenderView.AsString.htmlNode node)
+  
+  [<Fact>]
+  let ``_hxBoost succeeds`` () =
+    div [ _hxBoost ] [] |> shouldRender """<div hx-boost="true"></div>"""
+
+  [<Fact>]
+  let ``_hxConfirm succeeds`` () =
+    button [ _hxConfirm "REALLY?!?" ] [] |> shouldRender """<button hx-confirm="REALLY?!?"></button>"""
+
+  [<Fact>]
+  let ``_hxDelete succeeds`` () =
+    span [ _hxDelete "/this-endpoint" ] [] |> shouldRender """<span hx-delete="/this-endpoint"></span>"""
+  
+  [<Fact>]
+  let ``_hxDisable succeeds`` () =
+    p [ _hxDisable ] [] |> shouldRender """<p hx-disable></p>"""
+  
+  [<Fact>]
+  let ``_hxEncoding succeeds`` () =
+    form [ _hxEncoding "utf-7" ] [] |> shouldRender """<form hx-encoding="utf-7"></form>"""
+  
+  [<Fact>]
+  let ``_hxExt succeeds`` () =
+    section [ _hxExt "extendme" ] [] |> shouldRender """<section hx-ext="extendme"></section>"""
+  
+  [<Fact>]
+  let ``_hxGet succeeds`` () =
+    article [ _hxGet "/the-text" ] [] |> shouldRender """<article hx-get="/the-text"></article>"""
+  
+  [<Fact>]
+  let ``_hxHeaders succeeds`` () =
+    figure [ _hxHeaders """{ "X-Special-Header": "some-header" }""" ] []
+    |> shouldRender """<figure hx-headers="{ &quot;X-Special-Header&quot;: &quot;some-header&quot; }"></figure>"""
+  
+  [<Fact>]
+  let ``_hxHistoryElt succeeds`` () =
+    table [ _hxHistoryElt ] [] |> shouldRender """<table hx-history-elt></table>"""
+  
+  [<Fact>]
+  let ``_hxInclude succeeds`` () =
+    a [ _hxInclude ".extra-stuff" ] [] |> shouldRender """<a hx-include=".extra-stuff"></a>"""
+  
+  [<Fact>]
+  let ``_hxIndicator succeeds`` () =
+    aside [ _hxIndicator "#spinner" ] [] |> shouldRender """<aside hx-indicator="#spinner"></aside>"""
+  
+  [<Fact>]
+  let ``_hxNoBoost succeeds`` () =
+    td [ _hxNoBoost ] [] |> shouldRender """<td hx-boost="false"></td>"""
+  
+  [<Fact>]
+  let ``_hxParams succeeds`` () =
+    br [ _hxParams "[p1,p2]" ] |> shouldRender """<br hx-params="[p1,p2]">"""
+  
+  [<Fact>]
+  let ``_hxPatch succeeds`` () =
+    div [ _hxPatch "/arrrgh" ] [] |> shouldRender """<div hx-patch="/arrrgh"></div>"""
+  
+  [<Fact>]
+  let ``_hxPost succeeds`` () =
+    hr [ _hxPost "/hear-ye-hear-ye" ] |> shouldRender """<hr hx-post="/hear-ye-hear-ye">"""
+  
+  [<Fact>]
+  let ``_hxPreserve succeeds`` () =
+    img [ _hxPreserve ] |> shouldRender """<img hx-preserve="true">"""
+  
+  [<Fact>]
+  let ``_hxPrompt succeeds`` () =
+    strong [ _hxPrompt "Who goes there?" ] [] |> shouldRender """<strong hx-prompt="Who goes there?"></strong>"""
+  
+  [<Fact>]
+  let ``_hxPushUrl succeeds`` () =
+    dl [ _hxPushUrl ] [] |> shouldRender """<dl hx-push-url></dl>"""
+  
+  [<Fact>]
+  let ``_hxPut succeeds`` () =
+    s [ _hxPut "/take-this" ] [] |> shouldRender """<s hx-put="/take-this"></s>"""
+  
+  [<Fact>]
+  let ``_hxRequest succeeds`` () =
+    u [ _hxRequest "noHeaders" ] [] |> shouldRender """<u hx-request="noHeaders"></u>"""
+  
+  [<Fact>]
+  let ``_hxSelect succeeds`` () =
+    nav [ _hxSelect "#navbar" ] [] |> shouldRender """<nav hx-select="#navbar"></nav>"""
+  
+  [<Fact>]
+  let ``_hxSse succeeds`` () =
+    footer [ _hxSse "connect:/my-events" ] [] |> shouldRender """<footer hx-sse="connect:/my-events"></footer>"""
+  
+  [<Fact>]
+  let ``_hxSwap succeeds`` () =
+    del [ _hxSwap "innerHTML" ] [] |> shouldRender """<del hx-swap="innerHTML"></del>"""
+
+  [<Fact>]
+  let ``_hxSwapOob succeeds`` () =
+    li [ _hxSwapOob "true" ] [] |> shouldRender """<li hx-swap-oob="true"></li>"""
+  
+  [<Fact>]
+  let ``_hxTarget succeeds`` () =
+    header [ _hxTarget "#somewhereElse" ] [] |> shouldRender """<header hx-target="#somewhereElse"></header>"""
+
+  [<Fact>]  
+  let ``_hxTrigger succeeds`` () =
+    figcaption [ _hxTrigger "load" ] [] |> shouldRender """<figcaption hx-trigger="load"></figcaption>"""
+  
+  [<Fact>]
+  let ``_hxVals succeeds`` () =
+    dt [ _hxVals """{ "extra": "values" }""" ] []
+    |> shouldRender """<dt hx-vals="{ &quot;extra&quot;: &quot;values&quot; }"></dt>"""
+  
+  [<Fact>]
+  let ``_hxWs succeeds`` () =
+    ul [ _hxWs "connect:/web-socket" ] [] |> shouldRender """<ul hx-ws="connect:/web-socket"></ul>"""
+