Tests, minor doc changes, readme

- Add print method so it's not so obtuse to look at the output of div and span functions
- Add test for mdapply
- Minor refactor of with_*
- Use new print method in README

.Rbuildignore

@@ -5,3 +5,4 @@
 ^LICENSE\.md$
 ^\.lintr$
 ^codecov\.yml$
+^vignettes/articles$

.gitignore

@@ -47,3 +47,4 @@ po/*~
 
 # RStudio Connect folder
 rsconnect/
+inst/doc

DESCRIPTION

@@ -12,7 +12,10 @@ RoxygenNote: 7.2.3.9000
 Imports:
     rlang
 Suggests:
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 URL: https://github.com/ElianHugh/quartools
 BugReports: https://github.com/ElianHugh/quartools/issues
+VignetteBuilder: knitr

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(print,quarto_block)
 export(as_markdown)
 export(div)
 export(mdapply)

R/elements.R

@@ -30,7 +30,7 @@ div <- function(..., attr = NULL) {
 
     structure(
         sprintf(template_string, attribs, content),
-        class = "knit_asis"
+        class = c("knit_asis", "quarto_block")
     )
 }
 
@@ -58,6 +58,6 @@ span <- function(..., attr = NULL) {
 
     structure(
         sprintf(template_string, content, attribs),
-        class = "knit_asis"
+        class = c("knit_asis", "quarto_block")
     )
 }

R/misc.R

@@ -12,7 +12,7 @@
 as_markdown <- function(x, collapse = "") {
     structure(
         paste0(x, collapse = collapse),
-        class = "knit_asis"
+        class = c("knit_asis", "quarto_block")
     )
 }
 

R/print.R

@@ -0,0 +1,4 @@
+#' @export
+print.quarto_block <- function(x, ...) {
+    cat(x, sep = "\n")
+}

R/with.R

@@ -5,7 +5,7 @@
 #' See [the Quarto documentation for a full list
 #' of available extension options](https://quarto.org/docs/authoring/article-layout.html#available-columns).
 #' @param outset should the outset affix be applied to the column class?
-#' @param extension affix class to apply to column class
+#' @param extension affix to apply to column class
 #' @inheritParams div
 #' @export
 #' @examples
@@ -16,9 +16,7 @@ with_body_column <- function(..., attr = NULL, outset = FALSE, extension = NULL)
     check_extension_arg(extension, c("left", "right"))
     outset_string <- ifelse(isTRUE(outset), "-outset", "")
     extension_string <- ifelse(!is.null(extension), paste0("-", extension), "")
-    cls <- ".column-body%s%s" |>
-        sprintf(outset_string, extension_string)
-
+    cls <- sprintf(".column-body%s%s", outset_string, extension_string)
     div(..., attr = c(cls, attr))
 }
 
@@ -27,9 +25,7 @@ with_body_column <- function(..., attr = NULL, outset = FALSE, extension = NULL)
 with_page_column <- function(..., attr = NULL, extension = NULL) {
     check_extension_arg(extension, c("left", "right"))
     extension_string <- ifelse(!is.null(extension), paste0("-", extension), "")
-    cls <- ".column-page%s" |>
-        sprintf(extension_string)
-
+    cls <- sprintf(".column-page%s", extension_string)
     div(..., attr = c(cls, attr))
 }
 
@@ -38,8 +34,7 @@ with_page_column <- function(..., attr = NULL, extension = NULL) {
 with_screen_inset_column <- function(..., attr = NULL, extension = NULL) {
     check_extension_arg(extension, c("left", "right", "shaded"))
     extension_string <- ifelse(!is.null(extension), paste0("-", extension), "")
-    cls <- ".column-screen-inset%s" |>
-        sprintf(extension_string)
+    cls <- sprintf(".column-screen-inset%s", extension_string)
     div(..., attr = c(cls, attr))
 }
 
@@ -48,8 +43,7 @@ with_screen_inset_column <- function(..., attr = NULL, extension = NULL) {
 with_screen_column <- function(..., attr = NULL, extension = NULL) {
     check_extension_arg(extension, c("left", "right"))
     extension_string <- ifelse(!is.null(extension), paste0("-", extension), "")
-    cls <- ".column-screen%s" |>
-        sprintf(extension_string)
+    cls <- sprintf(".column-screen%s", extension_string)
     div(..., attr = c(cls, attr))
 }
 

README.md

@@ -46,38 +46,24 @@ devtools::install_github("ElianHugh/quartools")
 
 ### My First Div
 
-``` r
-library(quartools)
-div(
-    "The simplest way to create a div block element with quartools is via the `div` function.",
-    "Note that the chunk configuration of `results: asis` is not necessary."
-)
-```
-
-<div>
-
 The simplest way to create a div block element with quartools is via the
-`div` function.
-
-Note that the chunk configuration of `results: asis` is not necessary.
-
-</div>
+`div` function. Note that the chunk configuration of `results: asis` is
+not necessary.
 
 ``` r
 div(
     "It is also possible to supply attributes to the div block element via the `attr` parameter.",
     attr = ".callout-tip"
-)
+) |> print()
 ```
 
-<div>
 
-> **Tip**
->
-> It is also possible to supply attributes to the div block element via
-> the `attr` parameter.
 
-</div>
+    :::{.callout-tip}
+
+    It is also possible to supply attributes to the div block element via the `attr` parameter.
+
+    :::
 
 ### Apply
 
@@ -89,24 +75,33 @@ apply”) which allows for directly printing the result as valid markdown
 content.
 
 ``` r
-my_favourite_letters <- letters[1L:3L]
-mdapply(my_favourite_letters, div)
+input <- list(
+    list(type = "tip", msg = "a tip"),
+    list(type = "warning", msg = "a warning"),
+    list(type = "message", msg = "a message")
+)
+mdapply(input, function(x) div(x$msg, attr = sprintf(".callout-%s", x$type))) |>
+    print()
 ```
 
-<div>
 
-a
 
-</div>
+    :::{.callout-tip}
+
+    a tip
+
+    :::
+
+
+    :::{.callout-warning}
 
-<div>
+    a warning
 
-b
+    :::
 
-</div>
 
-<div>
+    :::{.callout-message}
 
-c
+    a message
 
-</div>
+    :::

README.qmd

@@ -38,27 +38,30 @@ devtools::install_github("ElianHugh/quartools")
 
 ### My First Div
 
+The simplest way to create a div block element with quartools is via the `div` function. Note that the chunk configuration of `results: asis` is not necessary.
 
 ```{r example}
+#| echo: false
 library(quartools)
-div(
-    "The simplest way to create a div block element with quartools is via the `div` function.",
-    "Note that the chunk configuration of `results: asis` is not necessary."
-)
 ```
 
 ```{r}
 div(
     "It is also possible to supply attributes to the div block element via the `attr` parameter.",
     attr = ".callout-tip"
-)
+) |> print()
 ```
 
 ### Apply
 
 We can leverage the `apply` family of functions ability to loop over list elements to simplify creating many divs at once. Normally this would require a workaround to allow for printing directly as markdown content, but _quartools_ exports the `mdapply` function (read: "markdown apply") which allows for directly printing the result as valid markdown content.
 
 ```{r}
-my_favourite_letters <- letters[1L:3L]
-mdapply(my_favourite_letters, div)
+input <- list(
+    list(type = "tip", msg = "a tip"),
+    list(type = "warning", msg = "a warning"),
+    list(type = "message", msg = "a message")
+)
+mdapply(input, function(x) div(x$msg, attr = sprintf(".callout-%s", x$type))) |>
+    print()
 ```

tests/testthat/test_misc.R

@@ -0,0 +1,17 @@
+
+test_that("mdapply works", {
+    input <- list(
+        list(type = "tip", msg = "a tip"),
+        list(type = "warning", msg = "a warning"),
+        list(type = "message", msg = "a message")
+    )
+    res <- mdapply(
+        input,
+        function(x) {
+            div(x$msg, attr = sprintf(".callout-%s", x$type))
+        }
+    )
+    expect_true(
+        res == "\n\n:::{.callout-tip}\n\na tip\n\n:::\n\n\n:::{.callout-warning}\n\na warning\n\n:::\n\n\n:::{.callout-message}\n\na message\n\n:::\n" # nolint: line_length_linter.
+    )
+})

tests/testthat/test_with.R

@@ -31,4 +31,3 @@ test_that("with_*() disallows invalid extensions", {
         expect_error(eval(x))
     })
 })
-

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R