Skip to content

Commit 2f0a5df

Browse files
stibu81stibu81
committed
rename functions to read/write defaults
1 parent aa28446 commit 2f0a5df

6 files changed

Lines changed: 67 additions & 66 deletions

File tree

‎NAMESPACE‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ export(query_events)
1818
export(query_race)
1919
export(query_results)
2020
export(query_standings)
21-
export(read_defaults)
21+
export(read_fisdata_defaults)
2222
export(reset_fisdata_defaults)
2323
export(set_fisdata_defaults)
2424
export(show_url)
2525
export(summarise_results)
26-
export(write_current_defaults)
27-
export(write_defaults)
26+
export(write_current_fisdata_defaults)
27+
export(write_fisdata_defaults)
2828
importFrom(dplyr,"%>%")
2929
importFrom(rlang,":=")
3030
importFrom(rlang,.data)

‎R/defaults.R‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -110,44 +110,44 @@ fd_def <- function(name = c("sector", "season", "gender",
110110
#' file.
111111
#'
112112
#' @returns
113-
#' `write_defaults()` and `write_current_defaults()` return the json-string that
114-
#' was written to the file (invisibly). `read_defaults()` returns the default
113+
#' `write_fisdata_defaults()` and `write_current_fisdata_defaults()` return the json-string that
114+
#' was written to the file (invisibly). `read_fisdata_defaults()` returns the default
115115
#' values that were read as a tibble (invisibly).
116116
#'
117117
#' @export
118118

119-
write_defaults <- function(file = "~/.fisdata.json",
120-
overwrite = FALSE,
121-
sector = "",
122-
season = "",
123-
gender = "",
124-
category = "",
125-
discipline = "",
126-
active_only = FALSE) {
119+
write_fisdata_defaults <- function(file = "~/.fisdata.json",
120+
overwrite = FALSE,
121+
sector = "",
122+
season = "",
123+
gender = "",
124+
category = "",
125+
discipline = "",
126+
active_only = FALSE) {
127127
defs <- prepare_defaults(sector = sector,
128128
season = season,
129129
gender = gender,
130130
category = category,
131131
discipline = discipline,
132132
active_only = active_only)
133-
write_defaults_(defs, file, overwrite)
133+
write_fisdata_defaults_(defs, file, overwrite)
134134
}
135135

136136

137-
#' @rdname write_defaults
137+
#' @rdname write_fisdata_defaults
138138
#' @export
139139

140-
write_current_defaults <- function(file = "~/.fisdata.json",
141-
overwrite = FALSE) {
142-
write_defaults_(get_fisdata_defaults(), file, overwrite)
140+
write_current_fisdata_defaults <- function(file = "~/.fisdata.json",
141+
overwrite = FALSE) {
142+
write_fisdata_defaults_(get_fisdata_defaults(), file, overwrite)
143143
}
144144

145145

146146
# helper function that writes a list or tibble of defaults to a JSON file
147-
write_defaults_ <- function(defaults,
148-
file = "~/.fisdata.json",
149-
overwrite = FALSE,
150-
error_call = rlang::caller_env()) {
147+
write_fisdata_defaults_ <- function(defaults,
148+
file = "~/.fisdata.json",
149+
overwrite = FALSE,
150+
error_call = rlang::caller_env()) {
151151

152152
if (file.exists(file) && !overwrite) {
153153
cli::cli_abort("The file {file} exists. Use `overwrite = TRUE` to overwrite it.")
@@ -180,11 +180,11 @@ write_defaults_ <- function(defaults,
180180
#' @param apply should the defaults be applied?
181181
#' @param verbose should the function create output. This defaults
182182
#' to `TRUE` in interactive sessions or when `apply` is `FALSE`.
183-
#' @rdname write_defaults
183+
#' @rdname write_fisdata_defaults
184184
#'
185185
#' @export
186186

187-
read_defaults <- function(file = "~/.fisdata.json",
187+
read_fisdata_defaults <- function(file = "~/.fisdata.json",
188188
apply = TRUE,
189189
verbose = !apply || interactive()) {
190190

‎R/fisdata-package.R‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ cache <- new.env()
3737
# read defaults from it.
3838
if (interactive() && file.exists(defaults_file)) {
3939
cli::cli_alert_info("Reading default values from {defaults_file} ...")
40-
read_defaults(defaults_file, verbose = TRUE)
40+
read_fisdata_defaults(defaults_file, verbose = TRUE)
4141
}
4242
}
4343

man/write_defaults.Rd renamed to man/write_fisdata_defaults.Rd

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkgdown/_pkgdown.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ reference:
3232
- show_url
3333
- browse_url
3434
- set_fisdata_defaults
35+
- write_fisdata_defaults
3536

3637
- title: Datasets
3738
desc: Datasets describing values that can be used in the querying functions

‎tests/testthat/test-defaults.R‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ test_that("fd_def() works", {
198198
})
199199

200200

201-
test_that("write_current_defaults() works", {
201+
test_that("write_current_fisdata_defaults() works", {
202202
reset_fisdata_defaults()
203203
set_fisdata_defaults(sector = "AL", gender = "F", category = "WC")
204204
ref <- toJSON(
@@ -208,23 +208,23 @@ test_that("write_current_defaults() works", {
208208
pretty = TRUE
209209
)
210210
local_file("fisdata.json")
211-
expect_equal(write_current_defaults("fisdata.json"), ref)
211+
expect_equal(write_current_fisdata_defaults("fisdata.json"), ref)
212212
expect_true(file.exists("fisdata.json"))
213213
expect_equal(paste(readLines("fisdata.json"), collapse = "\n"), ref,
214214
ignore_attr = TRUE)
215215
})
216216

217217

218-
test_that("write_current_defaults() handles existing file", {
218+
test_that("write_current_fisdata_defaults() handles existing file", {
219219
local_file("fisdata.json")
220-
write_current_defaults("fisdata.json")
221-
expect_error(write_current_defaults("fisdata.json"),
220+
write_current_fisdata_defaults("fisdata.json")
221+
expect_error(write_current_fisdata_defaults("fisdata.json"),
222222
"The file fisdata.json exists.")
223-
expect_silent(write_current_defaults("fisdata.json", overwrite = TRUE))
223+
expect_silent(write_current_fisdata_defaults("fisdata.json", overwrite = TRUE))
224224
})
225225

226226

227-
test_that("write_defaults() works", {
227+
test_that("write_fisdata_defaults() works", {
228228
ref <- toJSON(
229229
list(sector = "CC", season = "", gender = "M", category = "WC",
230230
discipline = "", active_only = FALSE),
@@ -233,7 +233,7 @@ test_that("write_defaults() works", {
233233
)
234234
local_file("fisdata.json")
235235
expect_equal(
236-
write_defaults("fisdata.json", sector = "CC", gender = "M", category = "WC"),
236+
write_fisdata_defaults("fisdata.json", sector = "CC", gender = "M", category = "WC"),
237237
ref
238238
)
239239
expect_true(file.exists("fisdata.json"))
@@ -242,31 +242,31 @@ test_that("write_defaults() works", {
242242
})
243243

244244

245-
test_that("write_defaults() handles existing file", {
245+
test_that("write_fisdata_defaults() handles existing file", {
246246
local_file("fisdata.json")
247-
write_defaults("fisdata.json", sector = "CC", gender = "M")
248-
expect_error(write_defaults("fisdata.json", sector = "CC", gender = "M"),
247+
write_fisdata_defaults("fisdata.json", sector = "CC", gender = "M")
248+
expect_error(write_fisdata_defaults("fisdata.json", sector = "CC", gender = "M"),
249249
"The file fisdata.json exists.")
250-
expect_silent(write_current_defaults("fisdata.json", overwrite = TRUE))
250+
expect_silent(write_current_fisdata_defaults("fisdata.json", overwrite = TRUE))
251251
})
252252

253253

254-
test_that("write_defaults() rejects NULL as default", {
254+
test_that("write_fisdata_defaults() rejects NULL as default", {
255255
local_file("fisdata.json")
256-
expect_error(write_defaults("fisdata.json", sector = "CC", discipline = NULL),
256+
expect_error(write_fisdata_defaults("fisdata.json", sector = "CC", discipline = NULL),
257257
"Defaults must no be NULL.*NULL: discipline")
258258
expect_false(file.exists("fisdata.json"))
259259
})
260260

261261

262-
test_that("read_defaults() reads defaults without applying them", {
262+
test_that("read_fisdata_defaults() reads defaults without applying them", {
263263
local_file("fisdata.json")
264-
write_defaults("fisdata.json", sector = "AL", season = "2024", gender = "W",
264+
write_fisdata_defaults("fisdata.json", sector = "AL", season = "2024", gender = "W",
265265
category = "WC", discipline = "SL", active_only = TRUE)
266266
reset_fisdata_defaults()
267267

268268
expect_equal(
269-
read_defaults("fisdata.json", apply = FALSE, verbose = FALSE),
269+
read_fisdata_defaults("fisdata.json", apply = FALSE, verbose = FALSE),
270270
tibble(sector = "AL", season = "2024", gender = "W", category = "WC",
271271
discipline = "SL", active_only = TRUE)
272272
)
@@ -278,14 +278,14 @@ test_that("read_defaults() reads defaults without applying them", {
278278
})
279279

280280

281-
test_that("read_defaults() applies defaults", {
281+
test_that("read_fisdata_defaults() applies defaults", {
282282
local_file("fisdata.json")
283-
write_defaults("fisdata.json", sector = "CC", season = "2025", gender = "M",
283+
write_fisdata_defaults("fisdata.json", sector = "CC", season = "2025", gender = "M",
284284
category = "WC", discipline = "SP", active_only = TRUE)
285285
reset_fisdata_defaults()
286286

287287
expect_equal(
288-
read_defaults("fisdata.json", verbose = FALSE),
288+
read_fisdata_defaults("fisdata.json", verbose = FALSE),
289289
tibble(sector = "CC", season = "2025", gender = "M",
290290
category = "WC", discipline = "SP", active_only = TRUE)
291291
)
@@ -297,13 +297,13 @@ test_that("read_defaults() applies defaults", {
297297
})
298298

299299

300-
test_that("read_defaults() handles invalid files", {
300+
test_that("read_fisdata_defaults() handles invalid files", {
301301
local_file("fisdata.json")
302302

303-
expect_error(read_defaults("fisdata.json"), "does not exist")
303+
expect_error(read_fisdata_defaults("fisdata.json"), "does not exist")
304304

305305
writeLines("{", "fisdata.json")
306-
expect_error(read_defaults("fisdata.json"), "Failed to parse")
306+
expect_error(read_fisdata_defaults("fisdata.json"), "Failed to parse")
307307

308308
writeLines(
309309
toJSON(
@@ -313,7 +313,7 @@ test_that("read_defaults() handles invalid files", {
313313
),
314314
"fisdata.json"
315315
)
316-
expect_error(read_defaults("fisdata.json"), "Some defaults have no value set: active_only")
316+
expect_error(read_fisdata_defaults("fisdata.json"), "Some defaults have no value set: active_only")
317317

318318
writeLines(
319319
toJSON(
@@ -323,7 +323,7 @@ test_that("read_defaults() handles invalid files", {
323323
),
324324
"fisdata.json"
325325
)
326-
expect_error(read_defaults("fisdata.json"), "contents.*not valid")
326+
expect_error(read_fisdata_defaults("fisdata.json"), "contents.*not valid")
327327

328328
writeLines(
329329
toJSON(
@@ -333,21 +333,21 @@ test_that("read_defaults() handles invalid files", {
333333
),
334334
"fisdata.json"
335335
)
336-
expect_error(read_defaults("fisdata.json"), "'1940' is not a valid season")
336+
expect_error(read_fisdata_defaults("fisdata.json"), "'1940' is not a valid season")
337337
})
338338

339339

340-
test_that("read_defaults() creates output in the appropriate situations", {
340+
test_that("read_fisdata_defaults() creates output in the appropriate situations", {
341341
local_file("fisdata.json")
342-
write_defaults("fisdata.json", sector = "CC", season = "2025", gender = "M",
342+
write_fisdata_defaults("fisdata.json", sector = "CC", season = "2025", gender = "M",
343343
category = "WC", discipline = "SP", active_only = TRUE)
344344

345-
expect_silent(read_defaults("fisdata.json", apply = FALSE, verbose = FALSE))
346-
expect_silent(read_defaults("fisdata.json", apply = TRUE, verbose = FALSE))
347-
read_defaults("fisdata.json", apply = FALSE, verbose = TRUE) %>%
345+
expect_silent(read_fisdata_defaults("fisdata.json", apply = FALSE, verbose = FALSE))
346+
expect_silent(read_fisdata_defaults("fisdata.json", apply = TRUE, verbose = FALSE))
347+
read_fisdata_defaults("fisdata.json", apply = FALSE, verbose = TRUE) %>%
348348
expect_message("contains the following defaults") %>%
349349
expect_output("tibble.*sector +season +gender +category")
350-
read_defaults("fisdata.json", apply = TRUE, verbose = TRUE) %>%
350+
read_fisdata_defaults("fisdata.json", apply = TRUE, verbose = TRUE) %>%
351351
expect_message("sector.*CC.*Cross-Country") %>%
352352
expect_message("season.*2025") %>%
353353
expect_message("gender.*M") %>%

0 commit comments

Comments
 (0)