roxygen2/tests/testthat/test-object-defaults.R at d7e95be08f2a0295a4dd39687c30385964aa09d2 · r-lib/roxygen2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
test_that("@docType data automatically adds sensible defaults", {
  out <- roc_proc_text(
    rd_roclet(),
    "
    #' Title.
    #'
    #' @docType data
    a <- data.frame(a = 1:10)
  "
  )[[1]]

  expect_equal(out$get_value("usage"), rd("a"))
  expect_equal(out$get_value("keyword"), "datasets")
  expect_false(is.null(out$get_value("format")))
})

test_that("@docType data automatically added to data objects", {
  out <- roc_proc_text(
    rd_roclet(),
    "
    #' Title.
    a <- data.frame(a = 1:10)
  "
  )[[1]]

  expect_equal(out$get_value("docType"), "data")
})

test_that("@docType data automatically added to data objects created elsewhere", {
  out <- roc_proc_text(
    rd_roclet(),
    "
    a <- data.frame(a = 1:10)
    #' Title.
    'a'
  "
  )[[1]]

  expect_equal(out$get_value("docType"), "data")
  expect_equal(out$get_value("usage"), rd("a"))
  expect_equal(out$get_value("keyword"), "datasets")
})

# Reference classes ----------------------------------------------------------

test_that("@docType class automatically added to reference class objects", {
  out <- roc_proc_text(
    rd_roclet(),
    "
    #' Title.
    #'
    a <- setRefClass('a')"
  )[[1]]

  expect_equal(out$get_value("docType"), "class")
})


# imports -----------------------------------------------------------------

test_that("only generates re-exports if no @name or @rdname", {
  block <- "
    #' @export
    stats::median
  "
  out <- roc_proc_text(rd_roclet(), block)[[1]]
  expect_equal(out$get_value("name"), "reexports")
  expect_equal(out$get_value("keyword"), "internal")

  block <- "
    #' Title
    #' @name stats-imports
    #' @export
    stats::median

    #' @rdname stats-imports
    stats::acf
  "
  out <- roc_proc_text(rd_roclet(), block)[[1]]
  expect_equal(out$get_value("name")[[1]], "stats-imports")
  expect_equal(out$get_value("alias"), c("stats-imports", "median", "acf"))
  expect_equal(out$get_value("keyword"), NULL)
})

test_that("imports are automatically imported", {
  block <- "
    #' @export
    stats::median
  "
  out <- roc_proc_text(namespace_roclet(), block)
  expect_equal(out, c("export(median)", "importFrom(stats,median)"))

  block <- "
    #' @export
    #' @name foo
    stats::median
  "
  out <- roc_proc_text(namespace_roclet(), block)
  expect_equal(out, c("export(median)", "importFrom(stats,median)"))
})

# packages -----------------------------------------------------------------

test_that("can create package documentation", {
  path <- local_package_copy(test_path("empty"))
  desc::desc_set(
    file = path,
    Package = "roxygendevtest",
    Title = "Package Title",
    Description = "Package description."
  )

  block <- "
    #' @details Details.
  '_PACKAGE'
  "
  withr::with_dir(
    path,
    blocks <- parse_text(block, env = new.env())
  )
  out <- roclet_process(rd_roclet(), blocks, env = new.env(), base_path = ".")[[
    1
  ]]

  expect_equal(out$get_value("name"), "roxygendevtest-package")
  expect_equal(
    out$get_value("alias"),
    c("roxygendevtest", "roxygendevtest-package")
  )
  expect_equal(out$get_value("title"), "roxygendevtest: Package Title")
  expect_equal(out$get_value("description"), "Package description.")
  expect_equal(out$get_value("docType"), "package")
  expect_equal(out$get_value("details"), "Details.")
})

test_that("package doc prefers logo.svg over logo.png (#1640)", {
  path <- local_package_copy(test_path("empty"))
  desc::desc_set(
    file = path,
    Package = "roxygendevtest",
    Title = "Package Title",
    Description = "Package description."
  )
  block <- "
    #' @details Details.
    '_PACKAGE'
  "

  # No logo
  withr::with_dir(path, blocks <- parse_text(block))
  out <- roclet_process(rd_roclet(), blocks)[[1]]
  expect_no_match(out$get_value("description"), "figure")

  # Only png
  dir.create(file.path(path, "man", "figures"), recursive = TRUE)
  file.create(file.path(path, "man", "figures", "logo.png"))
  withr::with_dir(path, blocks <- parse_text(block, env = new.env()))
  out <- roclet_process(rd_roclet(), blocks)[[1]]
  expect_match(out$get_value("description"), "logo.png")

  # Both svg and png: svg wins
  file.create(file.path(path, "man", "figures", "logo.svg"))
  withr::with_dir(path, blocks <- parse_text(block, env = new.env()))
  out <- roclet_process(rd_roclet(), blocks)[[1]]
  expect_match(out$get_value("description"), "logo.svg")
  expect_no_match(out$get_value("description"), "logo.png")
})