pre-commit/pre_commit/resources/empty_template_activate.R at v5 · pre-commit/pre-commit · GitHub

Repository navigation

History

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

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

local({

# the requested version of renv

version <- "0.12.5"

# the project directory

project <- getwd()

# avoid recursion

if (!is.na(Sys.getenv("RENV_R_INITIALIZING", unset = NA)))

return(invisible(TRUE))

# signal that we're loading renv during R startup

Sys.setenv("RENV_R_INITIALIZING" = "true")

on.exit(Sys.unsetenv("RENV_R_INITIALIZING"), add = TRUE)

# signal that we've consented to use renv

options(renv.consent = TRUE)

# load the 'utils' package eagerly -- this ensures that renv shims, which

# mask 'utils' packages, will come first on the search path

library(utils, lib.loc = .Library)

# check to see if renv has already been loaded

if ("renv" %in% loadedNamespaces()) {

# if renv has already been loaded, and it's the requested version of renv,

# nothing to do

spec <- .getNamespaceInfo(.getNamespace("renv"), "spec")

if (identical(spec[["version"]], version))

return(invisible(TRUE))

# otherwise, unload and attempt to load the correct version of renv

unloadNamespace("renv")

}

# load bootstrap tools

bootstrap <- function(version, library) {

# attempt to download renv

tarball <- tryCatch(renv_bootstrap_download(version), error = identity)

if (inherits(tarball, "error"))

stop("failed to download renv ", version)

# now attempt to install

status <- tryCatch(renv_bootstrap_install(version, tarball, library), error = identity)

if (inherits(status, "error"))

stop("failed to install renv ", version)

}

renv_bootstrap_tests_running <- function() {

getOption("renv.tests.running", default = FALSE)

}

renv_bootstrap_repos <- function() {

# check for repos override

repos <- Sys.getenv("RENV_CONFIG_REPOS_OVERRIDE", unset = NA)

if (!is.na(repos))

return(repos)

# if we're testing, re-use the test repositories

if (renv_bootstrap_tests_running())

return(getOption("renv.tests.repos"))

# retrieve current repos

repos <- getOption("repos")

# ensure @CRAN@ entries are resolved

repos[repos == "@CRAN@"] <- "https://cloud.r-project.org"

# add in renv.bootstrap.repos if set

default <- c(CRAN = "https://cloud.r-project.org")

extra <- getOption("renv.bootstrap.repos", default = default)

repos <- c(repos, extra)

# remove duplicates that might've snuck in

dupes <- duplicated(repos) | duplicated(names(repos))

repos[!dupes]

}

renv_bootstrap_download <- function(version) {

# if the renv version number has 4 components, assume it must

# be retrieved via github

nv <- numeric_version(version)

components <- unclass(nv)[[1]]

methods <- if (length(components) == 4L) {

list(

renv_bootstrap_download_github

)

} else {

list(

renv_bootstrap_download_cran_latest,

renv_bootstrap_download_cran_archive

)

}

for (method in methods) {

path <- tryCatch(method(version), error = identity)

if (is.character(path) && file.exists(path))

return(path)

}

stop("failed to download renv ", version)

}

renv_bootstrap_download_impl <- function(url, destfile) {

mode <- "wb"

# https://bugs.r-project.org/bugzilla/show_bug.cgi?id=17715

fixup <-

Sys.info()[["sysname"]] == "Windows" &&

substring(url, 1L, 5L) == "file:"

if (fixup)

mode <- "w+b"

utils::download.file(

url = url,

destfile = destfile,

mode = mode,

quiet = TRUE

)

}

renv_bootstrap_download_cran_latest <- function(version) {

repos <- renv_bootstrap_download_cran_latest_find(version)

message("* Downloading renv ", version, " from CRAN ... ", appendLF = FALSE)

info <- tryCatch(

utils::download.packages(

pkgs = "renv",

repos = repos,

destdir = tempdir(),

quiet = TRUE

condition = identity

)

if (inherits(info, "condition")) {

message("FAILED")

return(FALSE)

}

message("OK")

info[1, 2]

}

renv_bootstrap_download_cran_latest_find <- function(version) {

all <- renv_bootstrap_repos()

for (repos in all) {

db <- tryCatch(

as.data.frame(

x = utils::available.packages(repos = repos),

stringsAsFactors = FALSE

error = identity

)

if (inherits(db, "error"))

entry <- db[db$Package %in% "renv" & db$Version %in% version, ]

if (nrow(entry) == 0)

return(repos)

}

fmt <- "renv %s is not available from your declared package repositories"

stop(sprintf(fmt, version))

}

renv_bootstrap_download_cran_archive <- function(version) {

name <- sprintf("renv_%s.tar.gz", version)

repos <- renv_bootstrap_repos()

urls <- file.path(repos, "src/contrib/Archive/renv", name)

destfile <- file.path(tempdir(), name)

message("* Downloading renv ", version, " from CRAN archive ... ", appendLF = FALSE)

for (url in urls) {

status <- tryCatch(

renv_bootstrap_download_impl(url, destfile),

condition = identity

)

if (identical(status, 0L)) {

message("OK")

return(destfile)

}

message("FAILED")

return(FALSE)

}

renv_bootstrap_download_github <- function(version) {

enabled <- Sys.getenv("RENV_BOOTSTRAP_FROM_GITHUB", unset = "TRUE")

if (!identical(enabled, "TRUE"))

return(FALSE)

# prepare download options

pat <- Sys.getenv("GITHUB_PAT")

if (nzchar(Sys.which("curl")) && nzchar(pat)) {

fmt <- "--location --fail --header \"Authorization: token %s\""

extra <- sprintf(fmt, pat)

saved <- options("download.file.method", "download.file.extra")

options(download.file.method = "curl", download.file.extra = extra)

on.exit(do.call(base::options, saved), add = TRUE)

} else if (nzchar(Sys.which("wget")) && nzchar(pat)) {

fmt <- "--header=\"Authorization: token %s\""

extra <- sprintf(fmt, pat)

saved <- options("download.file.method", "download.file.extra")

options(download.file.method = "wget", download.file.extra = extra)

on.exit(do.call(base::options, saved), add = TRUE)

}

message("* Downloading renv ", version, " from GitHub ... ", appendLF = FALSE)

url <- file.path("https://api.github.com/repos/rstudio/renv/tarball", version)

name <- sprintf("renv_%s.tar.gz", version)

destfile <- file.path(tempdir(), name)

status <- tryCatch(

renv_bootstrap_download_impl(url, destfile),

condition = identity

)

if (!identical(status, 0L)) {

message("FAILED")

return(FALSE)

}

message("OK")

return(destfile)

}

renv_bootstrap_install <- function(version, tarball, library) {

# attempt to install it into project library

message("* Installing renv ", version, " ... ", appendLF = FALSE)

dir.create(library, showWarnings = FALSE, recursive = TRUE)

# invoke using system2 so we can capture and report output

bin <- R.home("bin")

exe <- if (Sys.info()[["sysname"]] == "Windows") "R.exe" else "R"

r <- file.path(bin, exe)

args <- c("--vanilla", "CMD", "INSTALL", "-l", shQuote(library), shQuote(tarball))

output <- system2(r, args, stdout = TRUE, stderr = TRUE)

message("Done!")

# check for successful install

status <- attr(output, "status")

if (is.numeric(status) && !identical(status, 0L)) {

header <- "Error installing renv:"

lines <- paste(rep.int("=", nchar(header)), collapse = "")

text <- c(header, lines, output)

writeLines(text, con = stderr())

}

status

}

renv_bootstrap_prefix <- function() {

# construct version prefix

version <- paste(R.version$major, R.version$minor, sep = ".")

prefix <- paste("R", numeric_version(version)[1, 1:2], sep = "-")

# include SVN revision for development versions of R

# (to avoid sharing platform-specific artefacts with released versions of R)

devel <-

identical(R.version[["status"]], "Under development (unstable)") ||

identical(R.version[["nickname"]], "Unsuffered Consequences")

if (devel)

prefix <- paste(prefix, R.version[["svn rev"]], sep = "-r")

# build list of path components

components <- c(prefix, R.version$platform)

# include prefix if provided by user

prefix <- Sys.getenv("RENV_PATHS_PREFIX")

if (nzchar(prefix))

components <- c(prefix, components)

# build prefix

paste(components, collapse = "/")

}

renv_bootstrap_library_root_name <- function(project) {

# use project name as-is if requested

asis <- Sys.getenv("RENV_PATHS_LIBRARY_ROOT_ASIS", unset = "FALSE")

if (asis)

return(basename(project))

# otherwise, disambiguate based on project's path

id <- substring(renv_bootstrap_hash_text(project), 1L, 8L)

paste(basename(project), id, sep = "-")

}

renv_bootstrap_library_root <- function(project) {

path <- Sys.getenv("RENV_PATHS_LIBRARY", unset = NA)

if (!is.na(path))

return(path)

path <- Sys.getenv("RENV_PATHS_LIBRARY_ROOT", unset = NA)

if (!is.na(path)) {

name <- renv_bootstrap_library_root_name(project)

return(file.path(path, name))

}

file.path(project, "renv/library")

}

renv_bootstrap_validate_version <- function(version) {

loadedversion <- utils::packageDescription("renv", fields = "Version")

if (version == loadedversion)

return(TRUE)

# assume four-component versions are from GitHub; three-component

# versions are from CRAN

components <- strsplit(loadedversion, "[.-]")[[1]]

remote <- if (length(components) == 4L)

paste("rstudio/renv", loadedversion, sep = "@")

else

paste("renv", loadedversion, sep = "@")

fmt <- paste(

"renv %1$s was loaded from project library, but this project is configured to use renv %2$s.",

"Use `renv::record(\"%3$s\")` to record renv %1$s in the lockfile.",

"Use `renv::restore(packages = \"renv\")` to install renv %2$s into the project library.",

sep = "\n"

)

msg <- sprintf(fmt, loadedversion, version, remote)

warning(msg, call. = FALSE)

FALSE

}

renv_bootstrap_hash_text <- function(text) {

hashfile <- tempfile("renv-hash-")

on.exit(unlink(hashfile), add = TRUE)

writeLines(text, con = hashfile)

tools::md5sum(hashfile)

}

renv_bootstrap_load <- function(project, libpath, version) {

# try to load renv from the project library

if (!requireNamespace("renv", lib.loc = libpath, quietly = TRUE))

return(FALSE)

# warn if the version of renv loaded does not match

renv_bootstrap_validate_version(version)

# load the project

renv::load(project)

TRUE

}

# construct path to library root

root <- renv_bootstrap_library_root(project)

# construct library prefix for platform

prefix <- renv_bootstrap_prefix()

# construct full libpath

libpath <- file.path(root, prefix)

# attempt to load

if (renv_bootstrap_load(project, libpath, version))

return(TRUE)

# load failed; inform user we're about to bootstrap

prefix <- paste("# Bootstrapping renv", version)

postfix <- paste(rep.int("-", 77L - nchar(prefix)), collapse = "")

header <- paste(prefix, postfix)

message(header)

# perform bootstrap

bootstrap(version, libpath)

# exit early if we're just testing bootstrap

if (!is.na(Sys.getenv("RENV_BOOTSTRAP_INSTALL_ONLY", unset = NA)))

return(TRUE)

# try again to load

if (requireNamespace("renv", lib.loc = libpath, quietly = TRUE)) {

message("* Successfully installed and loaded renv ", version, ".")

return(renv::load())

}

# failed to download or load renv; warn the user

msg <- c(

"Failed to find an renv installation: the project will not be loaded.",

"Use `renv::activate()` to re-initialize the project."

)

warning(paste(msg, collapse = "\n"), call. = FALSE)

})

pre-commit/pre_commit/resources/empty_template_activate.R at v5 · pre-commit/pre-commit · GitHub

Repository navigation

Expand file tree

Breadcrumbs

empty_template_activate.R

Latest commit

History

Breadcrumbs

empty_template_activate.R

File metadata and controls