feat: add function for reset --mixed

Author: maelle

DESCRIPTION

@@ -10,7 +10,7 @@ Description: Holds functions creating Git messes, that users would then solve, t
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2.9000
 Imports: 
     brio,
     cli,

NAMESPACE

@@ -9,6 +9,7 @@ export(exo_conflict)
 export(exo_latest_message)
 export(exo_one_small_change)
 export(exo_rebase_i)
+export(exo_reset)
 export(exo_revert_file)
 export(exo_split_changes)
 export(exo_time_machine)

R/reset.R

@@ -0,0 +1,91 @@
+#' "Hey I'd like to restart from scratch"
+#'
+#' @description
+#' I am working in a feature branch that's all my own.
+#' I made many small commits as I was figuring things out.
+#' Now I want the commits to tell a story for the PR reviewers,
+#' and not a story of how many stupid mistakes I made!
+#' Instead of `git base --interactive` also available as `git rebase -i`.¡,
+#' I can also use `git reset --mixed` and then build the commits.
+#' Useful links:
+#' - <https://github.blog/2022-06-30-write-better-commits-build-better-projects/>
+#' - <https://masalmon.eu/2024/06/11/rewrite-git-history/>
+#'
+#' @inheritParams exo_one_small_change
+#'
+#' @section Git commands:
+#' `git reset --mixed`
+#' @return The path to the new project
+#' @export
+#'
+#' @examplesIf interactive()
+#' parent_path <- withr::local_tempdir()
+#' path <- exo_reset(parent_path = parent_path)
+exo_reset <- function(parent_path) {
+
+  path <- file.path(parent_path, "reset")
+
+  withr::local_options(usethis.quiet = TRUE)
+
+  dir_create(path)
+  original_dir <- getwd()
+
+  withr::local_dir(path)
+  gert::git_init()
+
+  file.copy(
+    system.file("exo_reset-Rprofile.R", package = "saperlipopette"),
+    ".Rprofile"
+  )
+
+  create_project(path = getwd())
+  # Ignore Rproj that might otherwise get edited when we open the project
+  rproj <- fs::dir_ls(glob = "*.Rproj")
+  usethis::local_project(getwd(), force = TRUE)
+  usethis::use_git_ignore(rproj)
+  usethis::use_git_ignore(".Rprofile")
+  gert::git_add("*")
+  git_commit("First commit")
+
+  gert::git_branch_create("feature")
+
+  ci_file1 <- "ci.yml"
+
+  fs::file_create(ci_file1)
+  brio::write_lines(text = c("do: yes"), path = ci_file1)
+  gert::git_add(ci_file1)
+  git_commit("add ci configuration")
+
+  script <- "bla.R"
+
+  fs::file_create(script)
+  brio::write_lines(text = c("1/0"), path = script)
+  gert::git_add(script)
+  git_commit("add script")
+
+
+  brio::write_lines(text = c("do: true"), path = ci_file1)
+  gert::git_add(ci_file1)
+  git_commit("try to fix ci")
+  brio::write_lines(text = c("do: 1"), path = ci_file1)
+  gert::git_add(ci_file1)
+  git_commit("try to fix ci")
+
+  brio::write_lines(text = c("1/Inf"), path = script)
+  gert::git_add(script)
+  git_commit("try to fix script")
+
+  brio::write_lines(text = c(c("do: 1", "save: 1")), path = ci_file1)
+  gert::git_add(ci_file1)
+  git_commit("add a ci thing")
+
+  brio::write_lines(text = c("1/2"), path = script)
+  gert::git_add(script)
+  git_commit("fix script")
+
+  usethis::local_project(original_dir, force = TRUE)
+
+  cli::cli_alert_info("Follow along in {path}!")
+
+  return(path)
+}

_pkgdown.yml

@@ -18,6 +18,7 @@ reference:
   - exo_clean_dir
   - exo_conflict
   - exo_rebase_i
+  - exo_reset
   - exo_bisect
 - title: All exercises at once
   contents:

inst/exo_reset-Rprofile.R

@@ -0,0 +1,20 @@
+if (file.exists("~/.Rprofile")) {
+  base::sys.source("~/.Rprofile", envir = environment())
+}
+
+cli::cli_alert_danger('"Hey I want the commit history of the feature branch to look smarter!"')
+cli::cli_alert_info("I can undo the commits and keep the changes.")
+cli::cli_alert_info("For more help use {.run tip()}")
+
+tip <- function() {
+  cli::cli_li(
+    items = c(
+      "Examine Git history.",
+      "Find last commit before the changes.",
+      "{.code git reset --mixed <commit-id>}.",
+      "Do one commit per file.",
+      "Examine Git history and your files."
+    )
+  )
+
+}

man/exo_bisect.Rd

@@ -0,0 +1,14 @@
+# exo_reset() works
+
+    Code
+      gert::git_log(repo = path)[["commit"]]
+    Output
+      [1] "3c424b0d6d98b6cf1697450b6e4cbd8a59621f82"
+      [2] "413db3e0c49f844a7318982d727b6b42774465b9"
+      [3] "c8468fa173677eeefd57b046272ca0cae4ae1b23"
+      [4] "928960e78f882031ce3e08ee50dcb41778da22c5"
+      [5] "e3f09954c724515769879d72d77e48ade0db69d9"
+      [6] "ceb5f9c47cb6e28f0f63f668bd7e04b9a7fa87d1"
+      [7] "0579b6610db201fc2591ebb9f7c535abd0bc70f8"
+      [8] "e227ecc55e421f70b6e30602e6a2eee02aad42e0"
+

man/exo_clean_dir.Rd

@@ -0,0 +1,7 @@
+test_that("exo_reset() works", {
+  rlang::local_options(cli.default_handler = function(msg) invisible(NULL))
+  parent_path <- withr::local_tempdir()
+  path <- exo_reset(parent_path = parent_path)
+  expect_equal(fs::path_file(path), "reset")
+  expect_snapshot(gert::git_log(repo = path)[["commit"]])
+})