feat: Introduce write_docx function to convert RTF content to DOCX format and add corresponding tests.

Author: elong0527

.gitignore

@@ -10,3 +10,4 @@ r2rtf.Rcheck/
 r2rtf*.tar.gz
 r2rtf*.tgz
 revdep/
+Rplots.pdf

DESCRIPTION

@@ -52,4 +52,4 @@ Suggests:
     xml2
 Config/testthat/edition: 3
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3

NAMESPACE

@@ -17,6 +17,7 @@ export(rtf_source)
 export(rtf_subline)
 export(rtf_title)
 export(utf8Tortf)
+export(write_docx)
 export(write_rtf)
 importFrom(grDevices,colors)
 importFrom(utils,tail)

R/rtf_convert_format.R

@@ -25,7 +25,8 @@
 #' @param output_file A vector of filename for the output file.
 #' Default is the same filename for input.
 #' @param output_dir The output directory for the converted `output_dir`.
-#' @param format Converted file format extension. Currently support "pdf" or "docx"
+#' @param format Converted file format extension. Currently support "pdf"
+#'   or "docx" or "html"
 #' @param overwrite logical; should existing destination files be overwritten?
 #'
 #' @return A vector of file paths for the converted files.

R/write_rtf.R

@@ -72,3 +72,61 @@ write_rtf_para <- function(rtf, file) {
 
   invisible(file)
 }
+
+#' Write an RTF Table or Figure to a DOCX File
+#'
+#' @description
+#' The write_docx function writes an RTF encoding string to a .docx file
+#' by first writing to a temporary RTF file and then converting it to DOCX
+#' using LibreOffice.
+#'
+#' @section Specification:
+#' \if{latex}{
+#'  \itemize{
+#'    \item Write RTF encoding to a temporary RTF file.
+#'    \item Convert RTF to DOCX using LibreOffice command-line tool via \code{rtf_convert_format()}.
+#'  }
+#'  }
+#' \if{html}{The contents of this section are shown in PDF user manual only.}
+#'
+#' @param rtf A character rtf encoding string rendered by `rtf_encode()`.
+#' @param file A character string naming a file to save docx file.
+#'
+#' @details
+#' This function requires LibreOffice to be installed on the system.
+#' The function uses the internal \code{rtf_convert_format()} function
+#' to perform the conversion from RTF to DOCX format.
+#'
+#' Currently only Unix/Linux/macOS systems are supported.
+#'
+#' @export
+write_docx <- function(rtf, file) {
+  # Normalize the output file path
+  file <- normalizePath(file, mustWork = FALSE)
+
+  # Create output directory if it doesn't exist
+  output_dir <- dirname(file)
+  if (!dir.exists(output_dir)) {
+    dir.create(output_dir, recursive = TRUE)
+  }
+
+  # Create a temporary RTF file
+  tmpdir <- tempfile(pattern = "r2rtf_")
+  dir.create(tmpdir)
+  on.exit(unlink(tmpdir, recursive = TRUE), add = TRUE)
+
+  file_basename <- tools::file_path_sans_ext(basename(file))
+  rtf_path <- file.path(tmpdir, paste0(file_basename, ".rtf"))
+  write_rtf(rtf, rtf_path)
+
+  # Convert RTF to DOCX using existing rtf_convert_format function
+  rtf_convert_format(
+    input = rtf_path,
+    output_file = basename(file),
+    output_dir = output_dir,
+    format = "docx",
+    overwrite = TRUE
+  )
+
+  invisible(file)
+}

man/assemble_docx.Rd

@@ -40,3 +40,76 @@ test_that("Write function test for dataset input", {
 
   expect_equal(y, z)
 })
+
+test_that("write_docx creates DOCX file from RTF encoding", {
+  skip_on_os("windows") # rtf_convert_format only supports Unix/Linux/macOS
+  skip_if_not(
+    nzchar(Sys.which("libreoffice")) ||
+      nzchar(Sys.which("libreoffice24.8")) ||
+      nzchar(Sys.which("libreoffice7.6")),
+    "LibreOffice is not installed"
+  )
+
+  # Create RTF encoding
+  rtf <- head(iris) |>
+    rtf_body() |>
+    rtf_encode()
+
+  # Write to DOCX
+  docx_file <- file.path(tempdir(), "test_table.docx")
+  result <- write_docx(rtf, docx_file)
+
+  # Verify file was created
+  expect_true(file.exists(docx_file))
+  expect_equal(result, docx_file)
+
+  # Clean up
+  unlink(docx_file)
+})
+
+test_that("write_docx creates output directory if needed", {
+  skip_on_os("windows") # rtf_convert_format only supports Unix/Linux/macOS
+  skip_if_not(
+    nzchar(Sys.which("libreoffice")) ||
+      nzchar(Sys.which("libreoffice24.8")) ||
+      nzchar(Sys.which("libreoffice7.6")),
+    "LibreOffice is not installed"
+  )
+
+  # Create RTF encoding
+  rtf <- head(cars) |>
+    rtf_body() |>
+    rtf_encode()
+
+  # Create nested path
+  nested_path <- file.path(tempdir(), "test_output_dir", "nested", "test.docx")
+
+  # Write to DOCX
+  result <- write_docx(rtf, nested_path)
+
+  # Verify directory and file were created
+  expect_true(dir.exists(dirname(nested_path)))
+  expect_true(file.exists(nested_path))
+
+  # Clean up
+  unlink(file.path(tempdir(), "test_output_dir"), recursive = TRUE)
+})
+
+test_that("write_docx fails gracefully when LibreOffice is not available", {
+  skip_on_os("windows") # rtf_convert_format only supports Unix/Linux/macOS
+  skip_if(
+    nzchar(Sys.which("libreoffice")) ||
+      nzchar(Sys.which("libreoffice24.8")) ||
+      nzchar(Sys.which("libreoffice7.6")),
+    "Skip if LibreOffice IS installed"
+  )
+
+  rtf <- head(iris) |>
+    rtf_body() |>
+    rtf_encode()
+
+  expect_error(
+    write_docx(rtf, file.path(tempdir(), "test.docx")),
+    "Can't find libreoffice"
+  )
+})