R/get-package-actions.R

In rstudio/packrat: A Dependency Management System for Projects and their R Package Dependencies

# returns a list of actions that would be performed if the given action were
# performed on the given project
getActions <- function(verb, project) {
  project <- getProjectDir(project)
  if (verb == "restore")
    actionFunc <- restore
  else if (verb == "snapshot")
    actionFunc <- snapshot
  else if (verb == "clean")
    actionFunc <- clean
  else
    stop("Unknown action '", verb, "'")
  suppressMessages(actionFunc(project = project, dry.run = TRUE))
}

getActionMessages <- function(verb, project) {
  records <- getActions(verb, project)
  suppressMessages(packageActionMessages(verb, records))
}

packageActionMessages <- function(verb, records) {

  if (!length(records$actions)) {
    message("No ", verb, " actions to perform!")
    return(invisible(NULL))
  }

  pkgNames <- names(records$actions)
  ip <- installed.packages()
  installedPkgInfo <- suppressWarnings(getInstalledPkgInfo(pkgNames, ip))

  #   pkgRecords
  #   |__ .
  #   |   |__ name
  #   |   |__ source
  #   |   |__ version
  #   |   |__ source_path
  #   |   \__ depends
  #   \__ .
  #       |__ name
  #       |__ source
  #       |__ version
  #       |__ source_path
  #       \__ depends
  #   actions
  #   repos
  #   project
  #   targetLib

  parens <- function(x) {
    paste("(", x, ")", sep = "", collapse = ", ")
  }

  n <- length(records$actions)
  msgs <- data.frame(
    package = names(records$actions),
    action = unname(records$actions),
    packrat.version = character(n),
    library.version = character(n),
    message = character(n),
    stringsAsFactors = FALSE
  )
  for (i in seq_along(records$actions)) {
    action <- records$actions[[i]]
    package <- names(records$actions)[[i]]
    record <- records$pkgRecords[sapply(records$pkgRecords, function(x) {
      x$name == package
    })]
    packrat.version <-
      if (length(record) == 1)
        record[[1]]$version
      else
        NA
    library.version <- installedPkgInfo[[package]][["Version"]] %||% NA
    if (verb == "snapshot")
    {
      msgs$message[[i]] <-
        switch(action,
               add = paste("Add", shQuote(package), parens(library.version), "to Packrat"),
               remove = paste("Remove", shQuote(package), parens(packrat.version), "from Packrat"),
               upgrade = paste("Replace", shQuote(package), parens(paste(packrat.version, "->", library.version)), "in Packrat"),
               downgrade = paste("Replace", shQuote(package), parens(paste(packrat.version, "->", library.version)), "in Packrat"),
               crossgrade = paste("Crossgrade", shQuote(package), parens(paste(packrat.version, "->", library.version)), "in Packrat"),
               stop("Unrecognized action")
        )
    }
    else
    {
      msgs$message[[i]] <-
        switch(action,
               add = paste("Install", shQuote(package), parens(packrat.version)),
               remove = paste("Uninstall", shQuote(package), parens(packrat.version)),
               upgrade = paste("Upgrade", shQuote(package), parens(paste(library.version, "->", packrat.version))),
               downgrade = paste("Downgrade", shQuote(package), parens(paste(library.version, "->", packrat.version))),
               crossgrade = paste("Crossgrade", shQuote(package), parens(paste(library.version, "->", packrat.version))),
               stop("Unrecognized action")
        )
    }
    msgs$packrat.version[[i]] <- packrat.version
    msgs$library.version[[i]] <- library.version
  }
  msgs
}