R/update_documents.R

In NicolasJBM/teachR: Create and maintain teaching, learning, and testing materials

#' @name update_documents
#' @title Update document list
#' @author Nicolas Mangin
#' @description Function listing all the documents, checking whether they were changed, updating information about changed documents, and saving the document database on disk.
#' @param course_paths List. Paths to the different folders and databases on local disk.
#' @importFrom dplyr anti_join
#' @importFrom dplyr bind_rows
#' @importFrom dplyr everything
#' @importFrom dplyr group_by
#' @importFrom dplyr inner_join
#' @importFrom dplyr left_join
#' @importFrom dplyr mutate
#' @importFrom dplyr select
#' @importFrom dplyr summarise
#' @importFrom purrr map
#' @importFrom stringr str_remove_all
#' @importFrom tibble tibble
#' @importFrom tidyr replace_na
#' @importFrom tidyr separate
#' @importFrom tidyr unnest
#' @export

update_documents <- function(course_paths){
  
  path <- NA
  modified <- NA
  language <- NA
  tags <- NA
  code <- NA
  
  if (!base::file.exists(course_paths$databases$documents)){
    documents <- base::data.frame(
      file = base::character(0),
      code = base::character(0),
      language = base::character(0),
      translations = base::character(0),
      modified = base::character(0),
      title = base::character(0),
      type = base::character(0),
      document = base::character(0)
    )
    documents$modified <- base::as.Date(documents$modified)
    base::save(documents, file = course_paths$databases$documents)
  } else {
    base::load(course_paths$databases$documents)
  }
  
  if (!base::file.exists(course_paths$databases$propositions)){
    propositions <- tibble::tibble(
      item = base::character(0),
      code = base::character(0),
      type = base::character(0),
      document = base::character(0),
      language = base::character(0),
      modifications = base::numeric(0),
      proposition = base::character(0),
      value = base::numeric(0),
      scale = base::character(0),
      explanation = base::character(0),
      keywords = base::character(0)
    )
    base::save(propositions, file = course_paths$databases$propositions)
  }
  
  if (!base::file.exists(course_paths$databases$translations)){
    translations <- tibble::tibble(
      item = base::character(0),
      language = base::character(0),
      translated_proposition = base::character(0),
      translated_explanation = base::character(0)
    )
    base::save(translations, file = course_paths$databases$translations)
  }
  
  file_info <- tibble::tibble(
    path = base::list.files(course_paths$subfolders$original, full.names = TRUE),
    file = base::list.files(course_paths$subfolders$original, full.names = FALSE)
  ) |>
    dplyr::mutate(
      modified = purrr::map(path, function(x) base::file.info(x)$mtime)
    ) |>
    tidyr::unnest(modified)
  
  documents <-  dplyr::select(documents, -translations)
  
  unchanged <- file_info |>
    dplyr::inner_join(documents, by = c("file","modified"))
  
  changed <- file_info |>
    dplyr::anti_join(documents, by = c("file","modified"))
  
  if (base::nrow(changed) > 0){
    documents <- changed |>
      tidyr::separate(
        file, into = c("code","language"), sep = "_", remove = FALSE
      ) |>
      dplyr::mutate(
        language = stringr::str_remove_all(language, ".Rmd"),
        tags = purrr::map(path, editR::get_tags)
      ) |>
      tidyr::unnest(tags) |>
      dplyr::bind_rows(unchanged)
  } else {
    documents <- unchanged
  }
  
  translations <- tibble::tibble(
    file = base::list.files(course_paths$subfolders$translated)
  ) |>
    tidyr::separate(
    file, into = c("code","language"), sep = "_", remove = TRUE
  ) |>
    dplyr::mutate(
      language = stringr::str_remove_all(language, ".Rmd")
    ) |>
    dplyr::group_by(code) |>
    dplyr::summarise(translations = base::paste(language, collapse = " "))
  
  documents <- dplyr::left_join(documents, translations, by = "code") |>
    tidyr::replace_na(base::list(translations = "")) |>
    dplyr::select(file, code, language, translations, dplyr::everything()) |>
    dplyr::select(-path)
  
  if (!("tag_youtube" %in% base::names(documents))) documents$tag_youtube <- base::as.character(NA)
  
  base::save(documents, file = course_paths$databases$documents)
}