Merge pull request #497 from lorenzwalthert/remove-git2r

Remove git2r

Author: lorenzwalthert

R/roxygen2.R

@@ -1,55 +1,12 @@
-extract_diff_one_line <- function(one_line) {
-  if (one_line$old_lineno < 0 || one_line$new_lineno < 0) {
-    one_line$content
-  } else {
-    NULL
-  }
-}
-
-extract_diff_lines <- function(lines) {
-  purrr::map(lines, extract_diff_one_line)
-}
-
-extract_diff_hunks <- function(hunks) {
-  purrr::map(hunks, ~ extract_diff_lines(.x$lines))
-}
-
-extract_diff_files <- function(files) {
-  purrr::map(files, ~ extract_diff_hunks(.x$hunks))
-}
-
-#' Extract old and new lines from `git diff --cached`
-#'
-#' This is useful to detect within a hook script if the core function from a
-#' hook such as [roxygen2::roxygenize()] must run at all or not.
-#' @param root The root of project.
-#' @keywords internal
-extract_diff_root <- function(root = ".") {
-  assert_is_git_repo(root)
-  repo <- git2r::repository(root)
-  if (length(git2r::reflog(repo)) == 0) {
-    # nothing committed yet
-    all_files <- git2r::status()$staged
-
-    purrr::map(all_files[grepl("^R/.*\\.[Rr]$", all_files)], readLines) %>%
-      unlist() %>%
-      unname()
-  } else {
-    diff <- git2r::diff(repo, index = TRUE)
-    extract_diff_files(diff$files) %>%
-      unlist()
-  }
-}
-
 #' Check if we should run roxygen.
 #'
 #' This is the case if a new or replaced/removed line contains a roxygen2
 #' comment in a file that is staged.
 #' This function is only exported for use in hook scripts, but it's not intended
 #' to be called by the end-user directly.
+#' @param root The root of the git repo.
 #' @return
 #' A logical vector of length 1.
-#' @inheritParams extract_diff_root
 #' @keywords internal
 #' @family hook script helpers
 #' @examples
@@ -58,34 +15,18 @@ extract_diff_root <- function(root = ".") {
 #' }
 #' @export
 diff_requires_run_roxygenize <- function(root = ".") {
-  if (rlang::with_handlers(withr::with_namespace("git2r", FALSE), error = function(...) TRUE)) {
-    generic <- paste0(
-      " Please add the package as a dependency to ",
-      "`.pre-commit-config.yaml` -> `id: roxygenize` -> ",
-      "`additional_dependencies` and try again. The package must be ",
-      "specified so `renv::install()` understands it, e.g. like this:\n\n",
-      "    -   id: roxygenize",
-      "
-        additional_dependencies:
-        - git2r\n\n"
-    )
-    msg <- paste0(
-      "The R package {git2r} must be available to benefit from caching of this hook.",
-      generic
-    )
-    rlang::warn(msg)
-    return(TRUE)
-  }
-  changed_lines_content <- extract_diff_root(root)
-  is_roxygen <- grepl("^#'", changed_lines_content)
+  git_raw_diff <- withr::with_dir(
+    root, call_and_capture("git", c("diff", "--cached"))
+  )$stdout
+  is_roxygen <- grepl("^(\\+|-)#'", git_raw_diff)
   if (any(is_roxygen)) {
     return(TRUE)
   } else {
     # check if formals were changed
     # we invalidate the cache on formal change, even if it is not sure they are
     # documented with roxygen. This is easy, cheap and safe. Might give false
     # positive (invalidates in cases where it's not necessary).
-    without_comments <- gsub("#.*", "", changed_lines_content)
+    without_comments <- gsub("#.*", "", git_raw_diff)
     any(grep("function(", without_comments, fixed = TRUE))
   }
 }

R/utils.R

@@ -38,10 +38,6 @@ is_package <- function(root = here::here()) {
     magrittr::not()
 }
 
-add_trailing_linebreak <- function(x) {
-  paste0(x, "\n")
-}
-
 #' Name the input
 #'
 #' @param x A vector.

inst/update-dependency-graph-existing-packages.R

@@ -7,7 +7,7 @@ hook_deps <- function(root) {
     "pkgdown", "mockery",
     "httr"
   )
-  out <- c(out, "roxygen2", "spelling", "styler", "pkgload", "lintr", "knitr", "git2r", "desc", "mockery")
+  out <- c(out, "roxygen2", "spelling", "styler", "pkgload", "lintr", "knitr", "desc", "mockery")
   out <- setdiff(c(unique(c(out, deps[deps$type == "Imports", ]$package))), dont)
   out <- names(renv:::renv_package_dependencies(out))
   return(sort(out))

inst/update-existing-hook-dependencies.R

@@ -2,8 +2,8 @@ options(
   repos = c(CRAN = "https://packagemanager.rstudio.com/all/latest"),
   install.packages.compile.from.source = "never"
 )
-install.packages("renv")
-install.packages("jsonlite")
+renv::install("renv")
+renv::install("jsonlite")
 renv_deps <- names(jsonlite::read_json("renv.lock")$Packages)
 renv::load()
 renv::restore(prompt = FALSE)

man/diff_requires_run_roxygenize.Rd

@@ -236,18 +236,6 @@
       ],
       "Hash": "47b5f30c720c23999b913a1a635cf0bb"
     },
-    "git2r": {
-      "Package": "git2r",
-      "Version": "0.32.0",
-      "Source": "Repository",
-      "Repository": "RSPM",
-      "Requirements": [
-        "R",
-        "graphics",
-        "utils"
-      ],
-      "Hash": "1882d7a76fd8c14b2322865f74c9a348"
-    },
     "glue": {
       "Package": "glue",
       "Version": "1.6.2",
@@ -333,14 +321,9 @@
     },
     "lintr": {
       "Package": "lintr",
-      "Version": "3.0.2.9000",
-      "Source": "GitHub",
-      "RemoteType": "github",
-      "RemoteHost": "api.github.com",
-      "RemoteUsername": "r-lib",
-      "RemoteRepo": "lintr",
-      "RemoteRef": "main",
-      "RemoteSha": "4ef15f9689e7384e83a8e3250825006e95293bf5",
+      "Version": "3.1.0",
+      "Source": "Repository",
+      "Repository": "RSPM",
       "Requirements": [
         "R",
         "backports",
@@ -355,7 +338,7 @@
         "xml2",
         "xmlparsedata"
       ],
-      "Hash": "fd19bcfedd9515297fdc318cbe7505d3"
+      "Hash": "2b4b803af6017e93b67ddaf0eacba918"
     },
     "magrittr": {
       "Package": "magrittr",

man/extract_diff_root.Rd

@@ -5,44 +5,37 @@ test_that("roxygen runs are done if necessary", {
     text <- c("#' Roxygen comment", "#'", "#' more things", "NULL")
     writeLines(text, "R/first.R")
     writeLines(text, "R/second.R")
-    expect_error(extract_diff_root("."), "is not a git repo")
     git_init(".")
-    expect_equal(extract_diff_root("."), NULL)
     expect_false(diff_requires_run_roxygenize("."))
     git2r::add(".", "R/first.R")
     git2r::status()
 
-    expect_equal(extract_diff_root("."), text)
     expect_true(diff_requires_run_roxygenize("."))
     git2r::commit(".", "add roxgen2 file")
 
     # when non roxygen lines are added
     text2 <- c("if (x) {", " TRUE", "} else {", "  not_TRue(sinux(-i))", "}")
     writeLines(text2, "R/third.R")
-    expect_equal(extract_diff_root("."), NULL)
+
     git2r::add(".", "R/third.R")
-    expect_equal(extract_diff_root("."), add_trailing_linebreak(text2))
     expect_false(diff_requires_run_roxygenize("."))
     git2r::commit(".", "add non-roxygen2 file")
 
     # when roxygen line is replaced
     text[1] <- "# not roxygen, but replaced old "
     writeLines(text, "R/first.R")
     writeLines(text[1], "R/fourth.R")
-    expect_equal(extract_diff_root("."), NULL)
+
     git2r::add(".", c("R/first.R", "R/fourth.R"))
     git2r::status()
-    expect_equal(length(extract_diff_root(".")), 3)
     expect_true(diff_requires_run_roxygenize("."))
     git2r::commit(".", "replaced")
 
 
     # when roxygen line is removed
     writeLines("#", "R/first.R")
 
-    expect_equal(extract_diff_root("."), NULL)
     git2r::add(".", "R/first.R")
-    expect_equal(length(extract_diff_root(".")), 5)
     expect_true(diff_requires_run_roxygenize("."))
     git2r::commit(".", "when reomved")
   })
@@ -56,19 +49,15 @@ test_that("change in formals alone triggers invalidation", {
     # when new lines are added
     text <- c("#' Roxygen comment", "#'", "#' more things", "x <- function(a = 2) {", "  a", "}")
     writeLines(text, "R/fifth.R")
-    expect_equal(length(extract_diff_root(".")), 0)
     expect_false(diff_requires_run_roxygenize("."))
     git2r::add(".", "R/fifth.R")
 
-    expect_equal(extract_diff_root("."), text)
     expect_true(diff_requires_run_roxygenize("."))
     git2r::commit(".", "add file 5")
     # change signature
     text <- c("#' Roxygen comment", "#'", "#' more things", "x <- function(a = 3) {", "  a", "}")
     writeLines(text, "R/fifth.R")
     git2r::add(".", "R/fifth.R")
-    expect_equal(extract_diff_root("."), add_trailing_linebreak(c("x <- function(a = 2) {", "x <- function(a = 3) {")))
-    expect_true(diff_requires_run_roxygenize("."))
     git2r::commit(".", "clear case 5")
   })
 })
@@ -139,7 +128,7 @@ test_that("fails gratefully when not installed package is required according to
     suppressWarnings(
       roxygenize_with_cache(list(getwd()), dirs = dirs_R.cache("roxygenize"))
     ),
-    "The package .* is required"
+    "The package .*required"
   )
 })
 
@@ -167,6 +156,6 @@ test_that("warns if there is any other warning", {
 
   expect_warning(
     roxygenize_with_cache(list(getwd()), dirs = dirs_R.cache("roxygenize")),
-    "with @name"
+    "(with|a) @name"
   )
 })