R/write_autonewsmd.R

In autonewsmd: Auto-Generate Changelog using Conventional Commits

# Auto-Generate Changelog using Conventional Commits
# Copyright (C) 2022 Lorenz A. Kapsner
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

write_autonewsmd <- function(self, private, force, con) {

  stopifnot(
    "`repo_list` is missing or `NULL`" = !is.null(self$repo_list),
    "`repo_url` is missing or `NULL`" = !is.null(private$repo_url),
    "`repo_name` is missing or `NULL`" = !is.null(self$repo_name),
    "`file_name` is missing or `NULL`" = !is.null(self$file_name),
    "`force` must be a boolean value" = is.logical(force)
  )

  # check for presence of quarto
  if (is.null(quarto::quarto_path())) {
    stop(
      paste0(
        "Quarto command-line tools path not found! ",
        "Please make sure you have installed and added Quarto to your PATH ",
        "or set the QUARTO_PATH environment variable."
      )
    )
  }

  if (isFALSE(force)) {
    full_path <- file.path(
      private$repo_path,
      paste0(self$file_name, self$file_ending)
    )
    msg <- paste0(
      "Do you want to write the file '", full_path, "'?"
    )
    if (file.exists(full_path)) {
      msg <- paste(
        msg, "CAUTION: this overwrites the existing file!",
        sep = "\n"
      )
    }
    msg <- paste(
      msg, "(Use `force = TRUE` to omit this interactive question.)",
      sep = "\n"
    )
    if (is.null(con) && interactive()) {
      answer <- utils::askYesNo(
        msg = message(msg),
        default = NA
      )
    } else if (inherits(con, c("file", "connection"))) {
      # display prompt and options
      optlist <- paste(c("Yes", "no", "cancel"), collapse = "/")
      prompt_opt <- paste0(msg, " (", optlist, ")\n")
      message(prompt_opt)
      read_con <- readLines(con = con, n = 1)
      if (read_con %in% c("Yes", "yes", "y", "ye")) {
        answer <- TRUE
      } else {
        answer <- FALSE
      }
    } else {
      stop(paste0(
        "Please provide a valid connection containing the ",
        "answer to the interactive question, if the newly generated ",
        "changelog file should be written to the file system."
      ))
    }

    if (!isTRUE(answer)) {
      return(invisible())
    }
  }

  # nolint start
  repo_path <- private$repo_path
  file_name <- self$file_name
  file_ending <- self$file_ending
  # nolint end

  # address issues on some systems when rendering the markdown with the
  # template as input
  template_file <- tempfile(
    pattern = "autonewsmd-",
    tmpdir = tempdir(),
    fileext = "-news-md-template.qmd"
  )

  # copy template file from package directory to tempdir()
  file.copy(
    from = system.file(
      file.path("templates", "news-md-template.qmd"),
      package = "autonewsmd"
    ),
    to = template_file,
    overwrite = TRUE
  )

  outfile <- file.path(
    repo_path,
    I(paste0(file_name, file_ending))
  )

  prepare_rda(self, private)
  quarto::quarto_render(
    input = template_file,
    output_format = "md"
  )

  md_temp_file <- gsub("\\.qmd$", ".md", template_file)

  file.copy(
    from = md_temp_file,
    to = outfile,
    overwrite = TRUE
  )
  message(paste0(
    "Copied generated '", I(paste0(file_name, file_ending)),
    "' to '", outfile, "'."))

  invisible(file.remove(template_file))
  invisible(file.remove(md_temp_file))
  invisible(file.remove(file.path(tempdir(), "autonewsmd.Rda")))
}