R/results.R

In r-lib/revdepcheck: Automated Reverse Dependency Checking

#' Display revdep results
#'
#' Use this to see nicely formatted results of processed packages while
#' [revdep_check()] is running in another process. `revdep_summary()`
#' displays summary results for all complete checks. `revdep_details()`
#' shows you the details for one
#'
#' @export
#' @param pkg Path to package
#' @param revdep Name of revdep package.

revdep_details <- function(pkg = ".", revdep) {
  assert_that(is_string(revdep))

  structure(
    db_results(pkg, revdep)[[1]],
    class = "revdepcheck_details"
  )
}

#' @export

print.revdepcheck_results <- function(x, ...) {
  for (package in x) print(summary(package))
  invisible(x)
}

#' @export
#' @rdname revdep_details

revdep_summary <- function(pkg = ".") {
  structure(
    db_results(pkg, NULL),
    class = "revdepcheck_results"
  )
}

#' @export
#' @importFrom cli rule
#' @importFrom crayon cyan

print.revdepcheck_details <- function(x, ...) {
  ## Header
  cat_rule(
    left = cyan("Reverse dependency check"),
    right = cyan(x$package, x$versions[[1]]),
    line_col = "cyan",
    line = 2
  )

  ## First a summary
  cat_line()
  print(structure(x, class = "rcmdcheck_comparison"), header = FALSE)

  ## Old version
  cat_rule(left = "Before")
  if (inherits(x$old, "error")) {
    cat_line(red("<Error before the package check started>"))
  } else {
    print(x$old[[1]], header = FALSE)
    print_install_out(x$old[[1]])
  }
  cat_line()

  ## New version
  cat_rule(left = "After")
  if (inherits(x$new, "error")) {
    cat_line(red("<Error before the package check started>"))
  } else {
    print(x$new, header = FALSE)
    print_install_out(x$new)
  }
}

#' @importFrom rcmdcheck check_details
#' @importFrom utils tail

print_install_out <- function(x) {
  details <- check_details(x)
  if (any(grepl("Installation failed.*00install.out.*for details",
                details$errors))) {
    out <- strsplit(details$install_out, "\n")[[1]]
    cat("\n", symbol$line, symbol$line, sep = "")
    if (length(out) > 15) {
      cat(" 'install.out' contents (last 13 lines):\n")
      out <- c("...", tail(out, 13))
    } else {
      cat(" 'install.out' contents:\n")
    }
    cat(out, sep = "\n")
  }
}