Add tests for all import combinations

Author: MichaelHatherly

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+
+- `ojs_define` support for any tabular data source, as defined by the `Tables.jl` `istable` interface [#285].
+- `ojs_define` support for rendering via `JSON3.jl`, in additional to the currently supported `JSON.jl` [#286].
+
 ## [v0.15.0] - 2025-03-14
 
 ### Added

src/QuartoNotebookWorker/Project.toml

@@ -44,6 +44,3 @@ QuartoNotebookWorkerRemoteREPL = "RemoteREPL"
 QuartoNotebookWorkerReviseExt = "Revise"
 QuartoNotebookWorkerSymPyCoreExt = "SymPyCore"
 QuartoNotebookWorkerTablesExt = "Tables"
-
-[compat]
-Tables = "1"

test/examples/integrations/ojs_define.qmd

@@ -1,3 +1,5 @@
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"

test/examples/integrations/ojs_define/Project.toml

@@ -0,0 +1,28 @@
+---
+title: Both imported
+---
+
+```{julia}
+import JSON
+import JSON3
+```
+
+```{julia}
+ojs_define(; key = "value")
+```
+
+```{julia}
+import Tables
+```
+
+```{julia}
+ojs_define(; table = (; a = [1, 2, 3]))
+```
+
+```{julia}
+import DataFrames
+```
+
+```{julia}
+ojs_define(; df = DataFrames.DataFrame(; a = [1, 2, 3]))
+```

test/examples/integrations/ojs_define/both_imported.qmd

@@ -0,0 +1,27 @@
+---
+title: JSON3 imported
+---
+
+```{julia}
+import JSON3
+```
+
+```{julia}
+ojs_define(; key = "value")
+```
+
+```{julia}
+import Tables
+```
+
+```{julia}
+ojs_define(; table = (; a = [1, 2, 3]))
+```
+
+```{julia}
+import DataFrames
+```
+
+```{julia}
+ojs_define(; df = DataFrames.DataFrame(; a = [1, 2, 3]))
+```

test/examples/integrations/ojs_define/json3_imported.qmd

@@ -0,0 +1,27 @@
+---
+title: JSON imported
+---
+
+```{julia}
+import JSON
+```
+
+```{julia}
+ojs_define(; key = "value")
+```
+
+```{julia}
+import Tables
+```
+
+```{julia}
+ojs_define(; table = (; a = [1, 2, 3]))
+```
+
+```{julia}
+import DataFrames
+```
+
+```{julia}
+ojs_define(; df = DataFrames.DataFrame(; a = [1, 2, 3]))
+```

test/examples/integrations/ojs_define/json_imported.qmd

@@ -0,0 +1,7 @@
+---
+title: No imports
+---
+
+```{julia}
+ojs_define(; key = "value")
+```

test/examples/integrations/ojs_define/no_imports.qmd

@@ -1,12 +1,43 @@
 include("../../utilities/prelude.jl")
 
-test_example(joinpath(@__DIR__, "../../examples/integrations/ojs_define.qmd")) do json
+test_example(
+    joinpath(@__DIR__, "../../examples/integrations/ojs_define/no_imports.qmd"),
+) do json
     cells = json["cells"]
-
     cell = cells[2]
-    @test contains(cell["outputs"][1]["data"]["text/plain"], "ojs_define")
+    @test length(cell["outputs"]) == 1
+    @test contains(cell["outputs"][1]["text"], "Please import either JSON.jl or JSON3.jl")
+end
+
+for file in ("json", "json3", "both")
+    test_example(
+        joinpath(@__DIR__, "../../examples/integrations/ojs_define/$(file)_imported.qmd"),
+    ) do json
+        cells = json["cells"]
+
+        function extract_json(str)
+            str = replace(str, "<script type='ojs-define'>" => "")
+            str = replace(str, "</script>" => "")
+            return JSON3.read(str, Dict{String,Any})
+        end
+
+        cell = cells[4]
+        data = cell["outputs"][1]["data"]
+        @test haskey(data, "text/html")
+        @test contains(data["text/html"], "<script type='ojs-define'>")
+        obj = extract_json(data["text/html"])
+        @test obj["contents"][1] == Dict("name" => "key", "value" => "value")
 
-    cell = cells[8]
-    @test !isempty(cell["outputs"][1]["data"]["text/plain"])
-    @test !isempty(cell["outputs"][1]["data"]["text/html"])
+        for (nth, name) in (8 => "table", 12 => "df")
+            cell = cells[nth]
+            data = cell["outputs"][1]["data"]
+            @test haskey(data, "text/html")
+            @test contains(data["text/html"], "<script type='ojs-define'>")
+            obj = extract_json(data["text/html"])
+            @test obj["contents"][1]["name"] == name
+            @test obj["contents"][1]["value"][1] == Dict("a" => 1)
+            @test obj["contents"][1]["value"][2] == Dict("a" => 2)
+            @test obj["contents"][1]["value"][3] == Dict("a" => 3)
+        end
+    end
 end