feat: add exercise for "I committed to the wrong branch" (#12)

NAMESPACE

@@ -2,6 +2,7 @@
 
 export(create_all_exercises)
 export(exo_committed_to_main)
+export(exo_committed_to_wrong)
 export(exo_latest_message)
 export(exo_one_small_change)
 export(exo_split_changes)

R/committed-to-wrong-branch.R

@@ -0,0 +1,64 @@
+#' "Oh shit, I accidentally committed to the wrong branch!"
+#'
+#' @description
+#' To go with <https://ohshitgit.com/#accidental-commit-wrong-branch>
+#'
+#'
+#' @inheritParams exo_one_small_change
+#' @section Git commands:
+#' `git cherry-pick`, `git reset`, `git checkout`
+#'
+#' @return The path to the new project
+#' @export
+#'
+#' @examplesIf interactive()
+#' parent_path <- withr::local_tempdir()
+#' path <- exo_committed_to_wrong(parent_path = parent_path)
+exo_committed_to_wrong <- function(parent_path) {
+
+  path <- file.path(parent_path, "committed-to-wrong")
+
+  withr::local_options(usethis.quiet = TRUE)
+
+  dir_create(path)
+  original_dir <- getwd()
+
+  withr::local_dir(path)
+  gert::git_init()
+
+  file.copy(
+    system.file("exo_committed_to_wrong-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("feat-bla")
+  gert::git_branch_checkout("main")
+
+  gert::git_branch_create("hot-fix")
+  brio::write_lines("lala", "fix.txt")
+  gert::git_add("fix.txt")
+  git_commit("fix things")
+
+  fs::file_create("bla")
+  brio::write_lines(
+    text = c("thing 1", "thing 2"),
+    path = "bla"
+  )
+  gert::git_add("bla")
+  git_commit("feat: add bla")
+
+  usethis::local_project(original_dir, force = TRUE)
+
+  cli::cli_alert_info("Follow along in {path}!")
+
+  return(path)
+}

_pkgdown.yml

@@ -7,6 +7,7 @@ reference:
   contents:
   - exo_time_machine
   - exo_committed_to_main
+  - exo_committed_to_wrong
   - exo_latest_message
   - exo_one_small_change
 - title: Other exercises

inst/exo_committed_to_wrong-Rprofile.R

@@ -0,0 +1,22 @@
+if (file.exists("~/.Rprofile")) {
+  base::sys.source("~/.Rprofile", envir = environment())
+}
+
+cli::cli_alert_danger('"Oh shit, I accidentally committed to the wrong branch!"')
+cli::cli_alert_danger("I wanted my last commit, that created bla, to be on the feat-bla branch not hot-fix!")
+cli::cli_alert_info("See {.url https://ohshitgit.com/#accidental-commit-wrong-branch}")
+cli::cli_alert_info("For more help use {.run tip()}")
+
+tip <- function() {
+  cli::cli_li(
+    items = c(
+      "Examine Git history.",
+      "{.code git checkout feat-bla}",
+      "{.code git cherry-pick hot-fix}",
+      "{.code git checkout hot-fix}",
+      "{.code git reset HEAD~ --hard}",
+      "Examine Git history of the hot-fix and feat-bla branches."
+    )
+  )
+
+}

tests/testthat/_snaps/committed-to-wrong-branch.md

@@ -0,0 +1,9 @@
+# exo_committed_to_wrong() works
+
+    Code
+      gert::git_log(repo = path)[["commit"]]
+    Output
+      [1] "83ee0e3cc5afed932cd9e3f2f34274c60bfe1166"
+      [2] "e48ac924412914278ed7d3ee6e82d0fe3122741a"
+      [3] "e227ecc55e421f70b6e30602e6a2eee02aad42e0"
+

tests/testthat/_snaps/create-all.md

@@ -7,6 +7,10 @@
       +-- committed-to-main
       |   +-- R
       |   \-- bla
+      +-- committed-to-wrong
+      |   +-- R
+      |   +-- bla
+      |   \-- fix.txt
       +-- latest-message
       |   +-- R
       |   \-- bla

tests/testthat/test-committed-to-wrong-branch.R

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