fix: Writing binary files & subdirectories (#2)

* Add new `write_file_content()` function to handle writing text & binary files.

Also, handle writing files out to subdirectories if present in the path to the file.

* Explicitly use `encoding = "UTF-8"` in `httr::content()` and use `useBytes = TRUE` in `writeBin()`.

* Add NEWS file

Author: coatless

NEWS.md

@@ -0,0 +1,13 @@
+# peeky 0.1.0
+
+- `peeky` is a package that allows users to peek at the source code of a
+  Shinylive application.
+  - It works with both standalone and embedded
+    Shinylive applications written using either R or Python.
+- The package provides the following functions:
+  - `peek_shinylive_app()` is the primary function for examining Shinylive
+    applications.
+  - `peek_standalone_shinylive_app()` is the primary function for examining 
+     standalone Shinylive applications.
+  - `peek_quarto_shinylive_app()` is the primary function for examining 
+     Quarto documents with embedded Shinylive applications.

R/find.R

@@ -56,7 +56,7 @@ find_shinylive_app_json <- function(base_url) {
 
             # If this is already JSON content, verify it's a valid app.json
             if (grepl("application/json", httr::headers(resp)[["content-type"]], fixed = TRUE)) {
-                content <- httr::content(resp, "text")
+                content <- httr::content(resp, "text", encoding = "UTF-8")
                 # Try to parse as JSON and validate structure
                 json_data <- jsonlite::fromJSON(content, simplifyDataFrame = FALSE)
                 if (validate_app_json(json_data)) {

R/peek.R

@@ -89,7 +89,7 @@ peek_shinylive_app <- function(url, output_dir = "converted_shiny_app") {
 
     # If HTML, determine if it's a Quarto document
     if (grepl("text/html", content_type, fixed = TRUE)) {
-        html_content <- httr::content(resp, "text")
+        html_content <- httr::content(resp, "text", encoding = "UTF-8")
         doc <- rvest::read_html(html_content)
 
         # Check if it's a Quarto document (has main.content and quarto-specific elements)
@@ -215,7 +215,7 @@ peek_quarto_shinylive_app <- function(url,
         ))
     }
 
-    html_content <- httr::content(resp, "text")
+    html_content <- httr::content(resp, "text", encoding = "UTF-8")
 
     # Find and parse all shinylive code blocks
     apps <- find_shinylive_code(html_content)

R/writers.R

@@ -1,3 +1,74 @@
+#' Write File Content in a Shinylive App to Disk
+#'
+#' Writes file content extracted from Shinylive applications to disk, handling both
+#' text and binary content appropriately. Creates any necessary parent directories
+#' and ensures proper encoding of content. For binary files, automatically decodes
+#' the base64-encoded content before writing.
+#'
+#' @param content Character string containing the file content. For binary files,
+#'   this should be base64-encoded content. For text files, this should be the raw
+#'   text content.
+#' @param file_path Character string specifying the path where the file should be
+#'   written. Parent directories will be created if they don't exist.
+#' @param type Character string specifying the file type, either "text" (default)
+#'   or "binary". Binary files are assumed to be base64 encoded, as this is the
+#'   standard format for binary content in Shinylive applications.
+#'
+#' @return Invisible NULL, called for its side effect of writing a file to disk.
+#'
+#' @details
+#' The function handles two types of content:
+#'
+#' * Text files (`type = "text"`):
+#'   - Content is converted to UTF-8 encoding using `enc2utf8()`
+#'   - Written using `writeLines()` with `useBytes = TRUE`
+#'
+#' * Binary files (`type = "binary"`):
+#'   - Content is decoded from base64 using `jsonlite::base64_dec()`
+#'   - Written as raw binary data using `writeBin()`
+#'
+#' Parent directories in the file path are automatically created if they don't
+#' exist using `fs::dir_create()` with `recurse = TRUE`.
+#'
+#' @examples
+#' \dontrun{
+#' # Writing a text file
+#' write_file_content(
+#'   content = "library(shiny)\n\nui <- fluidPage()",
+#'   file_path = "app/app.R",
+#'   type = "text"
+#' )
+#'
+#' # Writing a binary file (base64-encoded content)
+#' write_file_content(
+#'   content = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
+#'   file_path = "app/www/image.png",
+#'   type = "binary"
+#' )
+#' }
+#'
+#' @keywords internal
+write_file_content <- function(content, file_path, type = "text") {
+    # Ensure parent directory exists
+    parent_dir <- dirname(file_path)
+    if (!dir.exists(parent_dir)) {
+        fs::dir_create(parent_dir, recurse = TRUE)
+    }
+
+    # Handle content based on type
+    if (type == "binary") {
+        # Decode base64 content and write as binary
+        decoded <- jsonlite::base64_dec(content)
+        writeBin(decoded, file_path, useBytes = TRUE)
+    } else {
+        # Write as text
+        writeLines(enc2utf8(content), file_path, useBytes = TRUE)
+    }
+
+    invisible(NULL)
+}
+
+
 #' Write Shinylive Applications to a Quarto Document
 #'
 #' Converts a list of parsed Shinylive applications into a single Quarto document.
@@ -253,8 +324,7 @@ write_apps_to_quarto <- function(apps, qmd_path) {
 #' write_apps_to_dirs(apps, "extracted_apps")
 #' }
 write_apps_to_dirs <- function(apps, base_dir) {
-    fs::dir_create(base_dir)
-
+    fs::dir_create(base_dir, recurse = TRUE)
 
     # Calculate padding width based on number of apps
     number_padding <- padding_width(length(apps))
@@ -266,18 +336,19 @@ write_apps_to_dirs <- function(apps, base_dir) {
 
         # Create numbered subdirectory using dynamic padding
         app_dir <- file.path(base_dir, sprintf(dir_format, i))
-        fs::dir_create(app_dir)
+        fs::dir_create(app_dir, recurse = TRUE)
 
         # Write each file in the app
         for (file_name in names(app$files)) {
             file_data <- app$files[[file_name]]
             file_path <- file.path(app_dir, file_name)
 
-            # Ensure parent directory exists
-            fs::dir_create(dirname(file_path))
-
-            # Write file content
-            writeLines(file_data$content, file_path)
+            # Write file as either a binary or text file
+            write_file_content(
+                content = file_data$content,
+                file_path = file_path,
+                type = file_data$type
+            )
         }
 
         # Write metadata
@@ -379,12 +450,18 @@ write_apps_to_dirs <- function(apps, base_dir) {
 #' @keywords internal
 write_standalone_shinylive_app <- function(json_data, source_url, output_dir = "converted_shiny_app") {
     # Create output directory
-    fs::dir_create(output_dir)
+    fs::dir_create(output_dir, recurse = TRUE)
 
     # Extract files
     for (file in json_data) {
         file_path <- file.path(output_dir, file$name)
-        writeLines(file$content, file_path)
+
+        # Write file as either a binary or text file
+        write_file_content(
+            content = file$content,
+            file_path = file_path,
+            type = file$type
+        )
     }
 
     # Return standalone command object

man/write_file_content.Rd

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: 5f42eb5f-9f68-4233-a26b-6b6ad0403d55
 
 RestoreWorkspace: Default
 SaveWorkspace: Default