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
168
169
170
171
172
|
local_load_all_quiet()
test_that("shim_help behaves the same as utils::help for non-devtools-loaded packages", {
# stats wasn't loaded with devtools. There are many combinations of calling
# with quotes and without; make sure they're the same both ways. Need to index
# in using [1] to drop attributes for which there are unimportant differences.
expect_identical(shim_help(lm)[1], utils::help(lm)[1])
expect_identical(shim_help(lm, stats)[1], utils::help(lm, stats)[1])
expect_identical(shim_help(lm, 'stats')[1], utils::help(lm, 'stats')[1])
expect_identical(shim_help('lm')[1], utils::help('lm')[1])
expect_identical(shim_help('lm', stats)[1], utils::help('lm', stats)[1])
expect_identical(shim_help('lm', 'stats')[1], utils::help('lm', 'stats')[1])
expect_identical(shim_help(, "stats")[1], utils::help(, "stats")[1])
# Works for :: and ::: as well (#72)
expect_identical(shim_help("::")[1], utils::help("::")[1])
expect_identical(shim_help(":::")[1], utils::help(":::")[1])
})
test_that("shim_help behaves the same as utils::help for nonexistent objects", {
expect_equal(length(shim_help(foofoo)), 0)
expect_equal(length(shim_help("foofoo")), 0)
})
test_that("shim_help works with complex NULL `package = ` argument (#266)", {
expect_equal(
class(pkgload:::shim_help(list, package = (NULL))),
"help_files_with_topic"
)
package <- "base"
expect_equal(
class(pkgload:::shim_help(list, package = (package))),
"help_files_with_topic"
)
})
test_that("shim_question behaves the same as utils::? for non-devtools-loaded packages", {
skip_on_cran()
expect_identical(shim_question(lm)[1], utils::`?`(lm)[1])
expect_identical(shim_question(stats::lm)[1], utils::`?`(stats::lm)[1])
expect_identical(shim_question(lm(123))[1], utils::`?`(lm(123))[1])
expect_identical(shim_question(`lm`)[1], utils::`?`(`lm`)[1])
expect_identical(shim_question('lm')[1], utils::`?`('lm')[1])
expect_identical(shim_question(base::min)[1], utils::`?`(base::min)[1])
})
test_that("shim_question behaves like util::? for searches", {
expect_identical(shim_question(?lm), utils::`?`(?lm))
})
test_that("shim_question behaves the same as utils::? for nonexistent objects", {
expect_equal(length(shim_question(foofoo)), 0)
expect_equal(length(shim_question(`foofoo`)), 0)
expect_equal(length(shim_question("foofoo")), 0)
# If given a function call with nonexistent function, error
expect_snapshot({
(expect_error(utils::`?`(foofoo(123))))
(expect_error(shim_question(foofoo(123))))
})
})
test_that("show_help and shim_question files for devtools-loaded packages", {
load_all(test_path('testHelp'))
defer(unload(test_path('testHelp')))
h1 <- shim_help("foofoo")
expect_s3_class(h1, "dev_topic")
expect_equal(h1$topic, "foofoo")
expect_equal(h1$pkg, "testHelp")
expect_identical(shim_help(foofoo), h1)
expect_identical(shim_help(foofoo, "testHelp"), h1)
expect_identical(shim_question(testHelp::foofoo), h1)
pager_fun <- function(files, header, title, delete.file) {
expect_equal(title, "testHelp:foofoo.Rd")
}
local_options(pager = pager_fun)
suppressMessages(print(h1, type = 'text'))
})
test_that("shim_help and shim_questions works if topic moves", {
load_all(test_path('testHelp'))
defer(unload(test_path('testHelp')))
path_man <- test_path("testHelp/man/")
base_rd_path <- function(x) basename(x$path)
expect_equal(base_rd_path(shim_help("foofoo")), "foofoo.Rd")
expect_equal(base_rd_path(shim_question("foofoo")), "foofoo.Rd")
fs::file_move(
fs::path(path_man, "foofoo.Rd"),
fs::path(path_man, "barbar.Rd")
)
defer(fs::file_move(
fs::path(path_man, "barbar.Rd"),
fs::path(path_man, "foofoo.Rd")
))
expect_equal(base_rd_path(shim_help("foofoo")), "barbar.Rd")
expect_equal(base_rd_path(shim_question("foofoo")), "barbar.Rd")
})
test_that("dev_help works with package and function help with the same name", {
load_all(test_path('testHelp'))
defer(unload(test_path('testHelp')))
h1 <- dev_help("testHelp")
expect_identical(shim_question(testHelp::testHelp), h1)
})
test_that("dev_help gives clear error if no packages loaded", {
local_mocked_bindings(dev_packages = function() character())
expect_snapshot(dev_help("foo"), error = TRUE)
})
test_that("unknown macros don't trigger warnings (#119)", {
load_all(test_path("testUnknownMacro"))
expect_no_warning(
out <- dev_help("testUnknownMacro")
)
# Because we're testing internal behaviour in `tools`
skip_on_cran()
# Because on RStudio the print method uses a different method
skip_if(is_rstudio())
# We should still be displaying a warning when rendering the documentation
local_options(pager = function(...) "")
suppress_output(
expect_warning(print(out), "unknown macro")
)
})
test_that("complex expressions are checked", {
expect_snapshot({
(expect_error(
shim_help({
foo
bar
}),
"must be a name"
))
})
})
test_that("can use macros in other packages (#120)", {
expect_true(has_rd_macros(test_path("testMacroDownstream/")))
skip_if_not_installed("mathjaxr")
load_all(test_path("testMacroDownstream"))
topic <- dev_help("macro_downstream")
text_lines <- topic_lines(topic, "text")
html_lines <- topic_lines(topic, "html")
expect_match(text_lines, "foreign macro success", all = FALSE)
expect_match(html_lines, "foreign macro.*success", all = FALSE)
})
test_that("httpdPort() is available", {
skip_on_cran()
# We're using this unexported function to open help pages in RStudio
expect_true(is.function(httpdPort))
})
|
