elf/R/installed.R at main · dataheld/elf · 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
# installed ====

#' Check if a package is installed
#'
#' Wrapper around [rlang::is_installed()].
#' @family dependencies helper
#' @name pkg_installed
NULL

#' @describeIn pkg_installed returns `TRUE` or the error message as a string.
#' @param x Name of the package.
#' @export
check_pkg_installed <- function(x = character(1L)) {
  res <- checkmate::check_string(x)
  if (!isTRUE(res)) {
    return(res)
  }
  if (rlang::is_installed(x)) {
    return(TRUE)
  } else {
    glue::glue("Package {x} is not installed")
  }
}

#' @describeIn pkg_installed returns `x` invisibly or errors out.
#' @inheritParams checkmate::makeAssertion
#' @inheritParams checkmate::assert
#' @export
assert_pkg_installed <- checkmate::makeAssertionFunction(check_pkg_installed)

#' @describeIn pkg_installed returns `TRUE` or `FALSE`
#' @inheritParams checkmate::makeTest
#' @export
test_pkg_installed <- checkmate::makeTestFunction(check_pkg_installed)

#' @describeIn pkg_installed returns an [testthat::expectation()]
#' @inheritParams checkmate::makeExpectation
#' @export
expect_pkg_installed <- checkmate::makeExpectationFunction(check_pkg_installed)

#' @describeIn pkg_installed
#' skips test if package is *not* installed.
#' Same as [testthat::skip_if_not_installed()],
#' except using [rlang::is_installed()] under the hood.
#' @include tests.R
#' @export
skip_if_pkg_not_installed2 <- make_skip_if_not_function(check_pkg_installed)

# installed but not via load_all ====

#' Check if a package is installed, but not via [pkgload::load_all()]
#'
#' To speed up development,
#' [pkgload::load_all()] simulates installing a package.
#' This simulation is usually sufficient,
#' but there are edge cases which it cannot cover.
#' Use this family of predicates to guard against these edge cases.
#'
#' @details
#' A frequent example of an edge case for [pkgload::load_all()]
#' occurs when child processes are launched during development,
#' such as in [shinytest2](https://rstudio.github.io/shinytest2/).
#' These child processes may not "know" that their parent
#' used the `load_all()`d version of an in-development package,
#' but may instead use whichever version was last installed.
#' This can lead to inconsistent results and painful confusion.
#' @family dependencies helper
#' @name pkg_installed_but_not_via_loadall
NULL

#' @describeIn pkg_installed_but_not_via_loadall
#' returns `TRUE` or the error message as a string.
#' @inheritParams pkg_installed
#' @export
check_pkg_installed_but_not_via_loadall <- function(x = character(1L)) {
  res <- check_pkg_installed(x)
  if (!isTRUE(res)) {
    return(res)
  }
  if (pkgload::is_dev_package(x)) {
    glue::glue(
      "The version of package {x} was loaded from `pkgload::load_all()`.",
      "It is not the installed version."
    )
  } else {
    TRUE
  }
}

#' @describeIn pkg_installed_but_not_via_loadall
#' returns `x` invisibly or errors out.
#' @inheritParams checkmate::makeAssertion
#' @inheritParams checkmate::assert
#' @export
assert_pkg_installed_but_not_via_loadall <- checkmate::makeAssertionFunction(
  check_pkg_installed_but_not_via_loadall
)

#' @describeIn pkg_installed_but_not_via_loadall
#' returns `TRUE` or `FALSE`
#' @inheritParams checkmate::makeTest
#' @export
test_pkg_installed_but_not_via_loadall <- checkmate::makeTestFunction(
  check_pkg_installed_but_not_via_loadall
)

#' @describeIn pkg_installed_but_not_via_loadall
#' returns an [testthat::expectation()]
#' @inheritParams checkmate::makeExpectation
#' @export
expect_pkg_installed_but_not_via_loadall <- checkmate::makeExpectationFunction(
  check_pkg_installed_but_not_via_loadall
)

#' @describeIn pkg_installed_but_not_via_loadall
#' skips test if package is *not* installed.
#' @include tests.R
#' @export
skip_if_pkg_installed_but_not_via_loadall <- make_skip_if_not_function(
  check_pkg_installed_but_not_via_loadall
)