tests/testthat/test-rd.R

test_that("empty file gives empty list", {
  out <- roc_proc_text(rd_roclet(), "")
  expect_identical(out, list())
})

test_that("NULL gives empty list", {
  out <- roc_proc_text(rd_roclet(), "NULL")
  expect_identical(out, list())
})

test_that("@noRd inhibits documentation", {
  out <- roc_proc_text(rd_roclet(), "
    #' Would be title
    #' @title Overridden title
    #' @name a
    #' @noRd
    NULL")

  expect_equal(length(out), 0)
})

test_that("deleted objects not documented", {
  out <- roc_proc_text(rd_roclet(), "
    f <- function(){
      .a <- 0
      function(x = 1){
        .a <<- .a + x
        .a
      }
    }

    #' Addition function.
    f2 <- f()
    rm(f)
  ")
  expect_equal(names(out), "f2.Rd")
})

test_that("documenting unknown function requires name", {
  expect_warning(
    roc_proc_text(rd_roclet(), "
      #' Virtual Class To Enforce Max Slot Length
      setClass('A')

      #' Validity function.
      setValidity('A', function(object) TRUE)"
    ),
    "Missing name"
  )
})

test_that("documenting NA gives useful error message (#194)", {
  expect_warning(
    roc_proc_text(rd_roclet(), "
      #' Missing value
      NA"
      ),
    "Missing name"
  )
})

test_that("@description NULL", {
  # Just ignore in this case
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #'
    #' @description NULL
    #' @format NULL
    foobar <- 1:10
  ")
  expect_identical(out[[1]]$get_value("description"), "Title")

  # Still ignore
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #' @description NULL
    #' @description desc
    #' @format NULL
    foobar <- 1:10
  ")
  expect_identical(out[[1]]$get_value("description"), "desc")

  # Still ignore for objects as well
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #' @description NULL
    #' @format NULL
    foobar <- 1:10
  ")
  expect_identical(out[[1]]$get_value("description"), "Title")

  # But drop for package docs
  with_mock(
    `roxygen2::read.description` = function(...)
      list(Package = "roxygen_devtest",
           Title = "Package Title",
           Description = "Package description."),
    out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
      #' Title
      #'
      #' @docType package
      #' @description NULL
      #' @name pkg
      '_PACKAGE'
    ")
  )
  expect_null(out[[1]]$get_value("description"))
})

test_that("@details NULL", {
  # Just ignore in this case
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #'
    #' @details NULL
    #' @format NULL
    foobar <- 1:10
  ")
  expect_null(out[[1]]$get_value("details"))

  # Still ignore
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #' @details NULL
    #' @details desc
    #' @format NULL
    foobar <- 1:10
  ")
  expect_identical(out[[1]]$get_value("details"), "desc")

  # Still ignore for objects as well
  out <- roxygen2::roc_proc_text(roxygen2::rd_roclet(), "
    #' Title
    #' @details NULL
    #' @format NULL
    foobar <- 1:10
  ")
  expect_null(out[[1]]$get_value("details"))
})

# UTF-8 -------------------------------------------------------------------

test_that("can generate nonASCII document", {
  test_pkg <- temp_copy_pkg(test_path('testNonASCII'))
  on.exit(unlink(test_pkg, recursive = TRUE), add = TRUE)

  expect_output(roxygenise(test_pkg, roclets = "rd"), "printChineseMsg[.]Rd")

  rd_path <- file.path(test_pkg, "man", "printChineseMsg.Rd")
  expect_true(file.exists(rd_path))
  rd <- read_lines(rd_path)

  expect_true(any(grepl("\u6211\u7231\u4e2d\u6587", rd)))
  expect_true(any(grepl("\u4e2d\u6587\u6ce8\u91ca", rd)))

  # Shouldn't change again
  expect_output(roxygenise(test_pkg, roclets = "rd"), NA)
})

test_that("unicode escapes are ok", {
  test_pkg <- temp_copy_pkg(test_path('testUtf8Escape'))
  on.exit(unlink(test_pkg, recursive = TRUE), add = TRUE)

  expect_output(roxygenise(test_pkg, roclets = "rd"), "a[.]Rd")

  rd_path <- file.path(test_pkg, "man", "a.Rd")
  expect_true(file.exists(rd_path))
  rd <- read_lines(rd_path)

  expect_true(any(grepl("7\u00b0C", rd)))

  # Shouldn't change again
  expect_output(roxygenise(test_pkg, roclets = "rd"), NA)
})

test_that("write_lines writes unix-style line endings.", {
  path <- test_path("escapes.Rd")

  # skip if checked on windows with autocrlf = true
  skip_if(detect_line_ending(path) == "\r\n")

  temp_filename <- tempfile()
  old_binary <- readBin(path, "raw", n = file.info(path)$size)
  old_text <- read_lines(path)
  write_lines(old_text, temp_filename)
  on.exit(unlink(temp_filename), add = TRUE)
  new_binary <- readBin(temp_filename, "raw", n = file.info(temp_filename)$size)
  expect_identical(new_binary, old_binary)
})

Try the roxygen2 package in your browser

Any scripts or data that you put into this service are public.

roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.