Merge pull request #22 from quantsch/fix-user-defined-macros

Fix user defined macros

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: Rd2md
 Title: Markdown Reference Manuals
-Version: 1.0.0
+Version: 1.0.1
 Authors@R: person("Julian", "Busch", email = "[email protected]", role = c("aut", "cre"))
 Description: Native R only allows PDF exports of reference manuals.
     The 'Rd2md' package converts the package documentation files into

R/rdfile-operations.R

@@ -7,12 +7,10 @@ read_package_rdfiles <- function(pkg = ".", subclass = NULL) {
 #'
 #' And return object of class `rdfile`
 #' @param path File path of `*.Rd`-file
-#' @param pkg_path Package path, required to load macros, see
-#' [tools::loadPkgRdMacros()].
 #' @param subclass Potential subclass of returned `rdfile` object
 #' @export
-read_rdfile <- function(path, pkg_path = NULL, subclass = NULL) {
-  parsed_rd <- parse_rd_file(path, pkg_path)
+read_rdfile <- function(path, subclass = NULL) {
+  parsed_rd <- tools::parse_Rd(path, encoding = "UTF-8")
   as_rdfile(parsed_rd, subclass = subclass)
 }
 
@@ -36,21 +34,6 @@ as_rdfragment <- function(x, subclass = NULL, ...) {
   )
 }
 
-parse_rd_file <- function(path, pkg_path = NULL) {
-  enc <- "UTF-8"
-  if (getRversion() >= "3.4.0") {
-    # loadPkgRdMacros returns NULL if input pkg_path is NULL
-    macros <- tools::loadPkgRdMacros(pkg_path)
-    parsed_rd <- tools::parse_Rd(path, macros = macros, encoding = enc)
-  } else if (getRversion() >= "3.2.0") {
-    macros <- tools::loadPkgRdMacros(pkg_path, TRUE)
-    parsed_rd <- tools::parse_Rd(path, macros = macros, encoding = enc)
-  } else {
-    parsed_rd <- tools::parse_Rd(path, encoding = enc)
-  }
-  parsed_rd
-}
-
 # Convert RD attributes to S3 classes -------------------------------------
 
 set_classes <- function(x) {

tests/testthat/test-rdfile.R

@@ -5,7 +5,6 @@ test_that("Output file of function is correct", {
   test_output_value <- as_markdown(
     read_rdfile(
       path = input_file,
-      pkg_path = "testdoc",
       subclass = "refman_rdfile"
     )
   )
@@ -16,14 +15,31 @@ test_that("Output file of function is correct", {
   )
 })
 
+test_that("System user-defined macros are handled correctly", {
+  input_file <- "testdoc/man/fundoc_with_ud_macro.Rd"
+  comp_file <- "testdoc-md/fundoc_with_ud_macro.md"
+
+  test_output_value <- as_markdown(
+    read_rdfile(
+      path = input_file,
+      subclass = "refman_rdfile"
+    )
+  )
+  test_expected_value <- read_file(comp_file, collapse = "\n")
+  expect_equal(
+    test_output_value,
+    test_expected_value
+  )
+})
+
+
 test_that("Output file of S4 class is correct", {
   input_file <- "testdoc/man/Account-class.Rd"
   comp_file <- "testdoc-md/Account-class.md"
 
   test_output_value <- as_markdown(
     read_rdfile(
       path = input_file,
-      pkg_path = "testdoc",
       subclass = "refman_rdfile"
     )
   )
@@ -40,7 +56,6 @@ test_that("Output file of R6 class is correct", {
   test_output_value <- as_markdown(
     read_rdfile(
       path = input_file,
-      pkg_path = "testdoc",
       subclass = "refman_rdfile"
     )
   )

tests/testthat/testdoc-md/fundoc_with_ud_macro.md

@@ -0,0 +1,20 @@
+# `fundoc_with_ud_macro`: Function With User Defined Macro In Description
+
+## Description
+
+CRANpkg macro: [`mycranpkg`](https://CRAN.R-project.org/package=mycranpkg)
+
+## Usage
+
+```r
+fundoc_with_ud_macro(Rd)
+```
+
+## Arguments
+
+* `Rd`: Object of class `Rd`
+
+## Value
+
+Some return value
+

tests/testthat/testdoc/R/fundoc.R

@@ -29,6 +29,14 @@ bind_cols <- function(
   .name_repair = c("unique", "universal", "check_unique", "minimal")
 ) ""
 
+#' Function With User Defined Macro In Description
+#'
+#' @description
+#' CRANpkg macro: \CRANpkg{mycranpkg}
+#' @param Rd Object of class `Rd`
+#' @return Some return value
+fundoc_with_ud_macro <- function(Rd) ""
+
 #' An S4 class to represent a bank account.
 #'
 #' @slot balance A length-one numeric vector