R/gh_remove_from_GPcatalog.R

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

#' Check for and remove project from GP Catalog
#'
#' Useful for when you rename a github repo of a lesson project and you have an orphaned <catalog.galacticpolymath.com> folder.
#'
#' @param gh_proj_name The (OLD) unique project title of this lesson as it is named on [https://github.com/galacticpolymath](https://github.com/galacticpolymath).
#' @returns logical; TRUE= success, FALSE= fail, NA= project not found
#' @export

gh_remove_from_GPcatalog <- function(gh_proj_name) {
  is_path <- grepl("/|\\\\", gh_proj_name)
  if (is_path) {
    stop(
      "Don't supply a path for gh_proj_name; should just be the the (old/outdated) GitHub Project name for the lesson."
    )
  }

  #Get catalog info from latest Catalog build
  current_catalog <-
    jsonlite::read_json("https://gp-catalog.vercel.app/index.json")
  current_cat_names <-
    sapply(1:length(current_catalog), function(i) {
      gsub("^.*/(.*)\\.git$", "\\1", current_catalog[[i]]$GitHubURL)
    })
  #Is the current project in the catalog?
  #This function is currently questionable...need to walk through it next time I use it
  browser()
  proj_in_cat <- gh_proj_name %in% current_cat_names
  if (!proj_in_cat) {
    message("Project '", gh_proj_name, "' not found in gp-catalog\n\nHere are the listings:\n -",paste0(sort(current_cat_names),collapse="\n -"))

    pull_success <-
      test_proj_is_local <-
      test_rm <- test_commit <- test_push <- FALSE
  } else{
    #Check for virtualized Google Drive catalog repo
    catalog_path <- Sys.getenv("galacticPubs_gdrive_catalog_dir")
    if (is_empty(catalog_path)) {
      message("\nGP Catalog path not set. Calling init_galacticPubs().")
      init_galacticPubs()
      catalog_path <- Sys.getenv("galacticPubs_gdrive_catalog_dir")
    }
    checkmate::assert_character(catalog_path,
                                min.chars = 2,
                                any.missing = FALSE)

    catalog_lessons_path <- fs::path(catalog_path, "lessons")
    loc_cat_exists <- dir.exists(catalog_lessons_path)
    if (!loc_cat_exists) {
      message("Directory not found!\nMake sure you have access to:\n ",
              catalog_lessons_path)
      pull_success <-  FALSE
    } else{
      #Pull latest
      message("Updating local gp-catalog")

      test_pull <-
        catch_err(gert::git_pull(repo = catalog_path), keep_results = T)

      #Try to recover from unsuccessful pull
      if (test_pull$success) {
        pull_success <- TRUE
      } else{
        message("Git pull unsuccessful.")
        #Check for detached state
        is_detached <-
          grepl("detached head state", test_pull$result)

        #Attempt to reinitialize detached catalog
        if (is_detached) {
          message(
            "Git repository, '",
            basename(catalog_path),
            "' is detached. Trying to reinitialize..."
          )
          test_reinit <-
            catch_err(gert::git_init(path = catalog_path))
          if (test_reinit) {
            message("Git repository successfully reinitialized. Trying to pull again.")
            test_pull <-
              catch_err(gert::git_pull(repo = catalog_path),
                        keep_results = T)
            if (test_pull$success) {
              message("Pull succeeded this time!")
              pull_success <- TRUE
            } else{
              message(
                "Pull failed again. Check GitHub setup for this repo. Possibly need to rebase."
              )
              pull_success <- FALSE
            }
          } else{
            message("Git repository reinitialization failed. Unable to update GPCatalog.")
            pull_success <- FALSE
          }
        } else{
          message(
            "Something weird going on. Check GitHub setup with this repo. Possibly need to rebase."
          )
          pull_success <- FALSE
        }
      }
    }

    #If pull didn't succeed, pass fail tests
    if (!pull_success) {
      test_proj_is_local <- test_rm <- test_commit <- test_push <- FALSE
    } else{
      #Check again that the directory in question exists
      local_proj_path <-
        fs::path(catalog_lessons_path, gh_proj_name)
      test_proj_is_local <- dir.exists(local_proj_path)

      if (!test_proj_is_local) {
        message("Project not found on virtualized folder: \n ",
                catalog_lessons_path)
        test_rm <- test_commit <- test_push <- FALSE
      } else{

        #if the local github project in question exists, delete it
        to_delete <- fs::dir_ls(local_proj_path, recurse = TRUE)
        test_rm <- catch_err(fs::dir_delete(local_proj_path))

        test_commit <-
          catch_err(gert::git_commit_all(
            message = paste0(
              "galacticPubs::gh_remove_from_GPcatalog --*Delete gp-catalog entry: ",
              gh_proj_name
            ),
            repo = catalog_lessons_path
          ))

        test_push <-
          catch_err(gert::git_push(repo = catalog_lessons_path))
      }
    }
  }

  if (test_rm & test_commit & test_push) {
    out <- TRUE
  } else{
    message("Something doesn't look right.")
    out <- FALSE
  }
  print(dplyr::tibble(
    Status = convert_T_to_check(
      c(
        pull_success,
        test_proj_is_local,
        test_rm,
        test_commit,
        test_push
      )
    ),
    Test = c(
      "Catalog pulled latest from web",
      "Project found",
      "Deleted locally",
      "Committed",
      "Pushed to the Web"
    )
  ))


  #output TRUE/FALSE success
  out
}