Refine how macros are discovered

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rd2markdown
 Title: Convert Rd Files into Markdown
-Version: 0.0.9
+Version: 0.1.0
 Authors@R:
     c(
       person(
@@ -40,4 +40,4 @@ License: MIT + file LICENSE
 VignetteBuilder: knitr
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2

NEWS.md

@@ -1,3 +1,9 @@
+rd2markdown 0.1.0
+-----------------
+
+* Add `find_package_root` helper and rebuild how the package discovers
+  default macros locations.
+
 rd2markdown 0.0.9
 -----------------
 

R/documentation_to_markdown.R

@@ -7,7 +7,7 @@
 #' output list. Use \code{fragments} parameter whenever you want to limit
 #' extracted documentation only to some parts.
 #'
-#' @param rdfilepaths A character vector of Rd documentation file paths
+#' @param rdfilepaths A character vector of Rd documentation file paths.
 #' @inheritParams rd2markdown
 #'
 #' @return A named list of character vectors of length one with the markdown content.
@@ -28,8 +28,9 @@
 #'   fragments = c("details"))
 #'
 #' @seealso \code{\link[rd2markdown]{rd2markdown}} \code{\link[rd2markdown]{get_rd}}
-documentation_to_markdown <- function(rdfilepaths,
-                                      fragments = c("title", "usage", "description", "details")) {
+documentation_to_markdown <- function(
+    rdfilepaths,
+    fragments = c("title", "usage", "description", "details")) {
 
   rds <- mapply(get_rd, file = rdfilepaths, SIMPLIFY = FALSE)
   max_n <- nchar(length(rdfilepaths))

R/get_rd.R

@@ -33,18 +33,28 @@ DEFAULT_R_MACROS <- file.path(R.home("share"), "Rd", "macros", "system.Rd")
 #' rd2markdown::get_rd(file = rd_file_example, macros = NA)
 #'   
 #' @export
-get_rd <- function(topic, package, file = NULL, macros = DEFAULT_R_MACROS) {
+get_rd <- function(
+    topic,
+    package,
+    file = NULL,
+    # Deafult R macros location defined in R documentation
+    macros = NULL) {
   if (!is.null(file)) {
-    potential_macros <- list.files(file.path(dirname(file), "macros"), pattern = "\\.Rd$|\\.rd$")
-    if (!is.null(macros) && is.na(macros) && length(potential_macros) > 0) {
-      # Extract first element as tools::parse_Rd accepts only a single file 
-      macros <- file.path(dirname(file), "macros", potential_macros)[1]
+    macros <- if (is.null(macros) && (root <- find_package_root(file)) != "") {
+      tools::loadPkgRdMacros(root)
+    } else if (is.null(macros)) {
+      tools::loadRdMacros(DEFAULT_R_MACROS)
+    } else if (!is.null(macros) && is.character(macros)) {
+      tools::loadRdMacros(macros)
+    } else {
+      macros
     }
+
     rd <- tools::parse_Rd(file = file, permissive = TRUE, macros = macros)
     .tools$processRdSexprs(
       rd,
       stage = "render",
-      macros = tools::loadRdMacros(DEFAULT_R_MACROS)
+      macros = tools::loadRdMacros(DEFAULT_R_MACROS, macros = macros)
     )
   } else {
     tryCatch({

R/utils.R

@@ -9,3 +9,13 @@ vcapply <- function(..., FUN.VALUE = character(1L)) {
 triml <- function(x, ..., which = "left") {
   trimws(x, ...)
 }
+
+find_package_root <- function(file, depth = 3) {
+  if (depth == 0) {
+    ""
+  } else if (!file.exists(file.path(dirname(file), "DESCRIPTION"))) {
+    find_package_root(dirname(file), depth - 1)
+  } else {
+    dirname(file)
+  }
+}

tests/testthat/test-get_rd.R

@@ -12,8 +12,9 @@ test_that("Can find relevant R documentation files, given a .Rd filepath", {
 
 test_that("get_rd find macros properly", {
   rd_filepath <- system.file("examples", "rd_file_sample_2.Rd", package = "rd2markdown")
-  expect_s3_class(get_rd(file = rd_filepath, macros = NA), "Rd")
-  expect_silent(rd <- get_rd(file = rd_filepath, macros = NA))
+  rd_macro <- system.file("examples", "macros", "macros.Rd", package = "rd2markdown")
+  expect_s3_class(get_rd(file = rd_filepath, macros = rd_macro), "Rd")
+  expect_silent(rd <- get_rd(file = rd_filepath, macros = rd_macro))
   expect_equivalent(
     rd[[17]][[3]],
     structure(c("\\code{\\link[=#1]{#1()}}", "rnorm"), Rd_tag = "USERMACRO", macro = "\\function")