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
|
spec <- function(spec,
env = caller_env(),
signaller = "signal_lifecycle",
error_call = caller_env()) {
ctxt <- list(
signaller = signaller,
call = error_call
)
if (inherits(spec, "AsIs")) {
list(
fn = spec,
arg = NULL,
pkg = spec_pkg(NULL, env, ctxt = ctxt),
reason = NULL,
from = signaller
)
} else {
what <- parse_what(spec, ctxt = ctxt)
list(
fn = spec_fn(what$call, ctxt = ctxt),
arg = spec_arg(what$call, ctxt = ctxt),
pkg = spec_pkg(what$pkg, env, ctxt = ctxt),
reason = spec_reason(what$call, ctxt = ctxt),
from = signaller
)
}
}
parse_what <- function(what, ctxt) {
check_string(what, call = ctxt$call)
call <- parse_expr(what)
if (!is_call(call)) {
what <- as_string(what)
cli::cli_abort(
c(
"{.arg what} must have function call syntax.",
"",
" " = "# Good:",
" " = "{ ctxt$signaller }(\"{what}()\")",
"",
" " = "# Bad:",
" " = "{ ctxt$signaller }(\"{what}\")"
),
call = ctxt$call,
arg = "what"
)
}
head <- call[[1]]
if (is_call(head, "::")) {
pkg <- as_string(head[[2]])
call[[1]] <- head[[3]]
} else {
pkg <- NULL
}
list(pkg = pkg, call = call)
}
spec_fn <- function(call, ctxt) {
fn <- node_car(call)
if (!is_symbol(fn) && !is_call(fn, "$")) {
cli::cli_abort(
"{.arg what} must be a function or method call.",
call = ctxt$call,
arg = "what"
)
}
# Deparse so non-syntactic names are backticked
expr_deparse(fn)
}
spec_arg <- function(call, ctxt) {
arg <- node_cdr(call)
if (is_null(arg)) {
return(NULL)
}
if (length(arg) != 1L) {
fn <- as_label(node_car(call))
n <- length(arg)
cli::cli_abort(
"Function in {.arg what} ({fn}) must have 1 argument, not {n}.",
call = ctxt$call
)
}
if (is_null(node_tag(arg))) {
as_string(node_car(arg))
} else {
as_string(node_tag(arg))
}
}
spec_reason <- function(call, ctxt) {
arg <- node_cdr(call)
if (is_null(arg)) {
return(NULL)
}
if (is_null(node_tag(arg))) {
return(NULL)
}
if (is_missing(node_car(arg))) {
return(NULL)
}
if (is_string(node_car(arg))) {
return(node_car(arg))
}
fn <- expr_deparse(node_car(call))
cli::cli_abort(
c(
"{.arg what} must contain reason as a string on the RHS of `=`.",
"",
" " = "# Good:",
" " = "{ctxt$signaller}(\"{fn}(arg = 'must be a string')\")",
"",
" " = "# Bad:",
" " = "{ctxt$signaller}(\"{fn}(arg = 42)\")"
),
call = ctxt$call
)
}
spec_pkg <- function(pkg, env, ctxt) {
if (!is_null(pkg) || is_null(env)) {
return(pkg)
}
env <- topenv(env)
if (is_reference(env, global_env())) {
# Convenient for experimenting interactively
return(getOption("lifecycle:::calling_package", "<NA>"))
}
if (is_namespace(env)) {
return(ns_env_name(env))
}
cli::cli_abort(
c(
"Can't detect the package of the deprecated function.",
"Please mention the namespace:",
"",
" " = "# Good:",
" " = "{ ctxt$signaller }(what = \"namespace::myfunction()\")",
"",
" " = "# Bad:",
" " = "{ ctxt$signaller }(what = \"myfunction()\")",
""
),
call = ctxt$call
)
}
|
