Skip to content

glue-ify string handling #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxheld83 merged 6 commits into from
Nov 29, 2024
Merged

glue-ify string handling #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
09d2dbe
factor out some glue
maxheld83 Nov 29, 2024
a0d8251
fix snap
maxheld83 Nov 29, 2024
77491a0
improve indentation
maxheld83 Nov 29, 2024
747163b
fix lint
maxheld83 Nov 29, 2024
8d3aa68
refactor tex-writing
maxheld83 Nov 29, 2024
601d4df
fix lint
maxheld83 Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions R/shiny2screenshot.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,14 +210,24 @@ roxy_tag_rd.roxy_tag_crowInsertSnaps <- function(x, base_path, env) {
)
}

glue_latex <- function(..., .envir = parent.frame()) {
glue::glue(..., .envir = .envir, .open = "[", .close = "]")
}

#' @export
format.rd_section_crowInsertSnaps <- function(x, ...) {
paste0(
"\\section{Screenshots from Tests}{\n",
"\\if{html}",
paste(x$value, collapse = "\n"),
"\\if{latex}{Screenshots cannot be shown in this output format.}",
"}\n"
inner <- glue::glue_collapse(x$value, sep = "\n")
# appease check
inner
glue_latex(
"\\section{Screenshots from Tests}{
\\if{html}{
[inner]
}
\\if{latex}{
Screenshots cannot be shown in this output format.
}
}"
)
}

Expand Down Expand Up @@ -279,7 +289,7 @@ snap_alt_text <- function() "Screenshot from App"
#' @export
snaps2md <- function(...) {
path <- snaps2fig(...)
paste0("![", snap_alt_text(), "](", path, ")", collapse = "")
glue::glue("![{snap_alt_text()}]({path})")
}

#' @describeIn get_screenshot_from_snaps
Expand All @@ -300,19 +310,11 @@ snaps2rd <- function(test_file = character(),
variant = variant,
fps = fps
)
glue::glue_collapse(
c(
glue::glue("{{name: \\code{{{name}}}, variant: \\code{{{variant}}}"),
paste0(
"\\figure{",
path,
"}{options: width='100\\%' alt=",
snap_alt_text(),
"}}",
collapse = ""
)
),
sep = " "
# appease make check
path
glue_latex(
"name: \\code{[name]}, variant: \\code{[variant]}
\\figure{[path]}{options: width='100\\%' alt=[snap_alt_text()]}"
)
}

Expand Down
25 changes: 19 additions & 6 deletions tests/testthat/_snaps/shiny2screenshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,23 +64,36 @@
topic$get_section("crowInsertSnaps")
Output
\section{Screenshots from Tests}{
\if{html}{name: \code{bins}, variant: \code{linux} \figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}}\if{latex}{Screenshots cannot be shown in this output format.}}

\if{html}{
name: \code{bins}, variant: \code{linux}
\figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}
}
\if{latex}{
Screenshots cannot be shown in this output format.
}
}

# roxy_tag_crowInsertSnaps: can be formatted with multiple tags joined

Code
topic$get_section("crowInsertSnaps")
Output
\section{Screenshots from Tests}{
\if{html}{name: \code{bins}, variant: \code{linux} \figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}}
{name: \code{bins}, variant: \code{mac} \figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}}\if{latex}{Screenshots cannot be shown in this output format.}}

\if{html}{
name: \code{bins}, variant: \code{linux}
\figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}
name: \code{bins}, variant: \code{mac}
\figure{crow_screenshots/helpers/bins.gif}{options: width='100\%' alt=Screenshot from App}
}
\if{latex}{
Screenshots cannot be shown in this output format.
}
}

# snaps2fig and friends work: writes out markdown syntax

Code
res
Output
[1] "![Screenshot from App](crow_screenshots/helpers/bins.gif)"
![Screenshot from App](crow_screenshots/helpers/bins.gif)