R/notify.R

In ShaulAb/alphabetter: Collection of 'Rstudio' Addins

#' Notify On Read/Write Lines.
#'
#' @description Addin to notify on read/write Lines
#'
#' @export
#'
notify_io_addin <- function() {

  context <- rstudioapi::getActiveDocumentContext()
  text <- unlist(context$contents)
  rstudioapi::insertText(notify_io(text))
}

#' Notify On Used/Loaded Libraries.
#'
#' @description Addin to notify on used/loaded libraries
#'
#' @export
#'
notify_libraries_addin <- function() {

  context <- rstudioapi::getActiveDocumentContext()
  text <- unlist(context$contents)
  rstudioapi::insertText(notify_libraries(text))
}

#' Notify on IO components in the code
#'
#' @param text String
#'
#' @return String
#' @export
#'
#' @examples
#' cat(
#'   notify_io(
#'     'df <- read.csv("my_data.csv")
#'     write.csv(df, "your_data.csv")
#'     write_variable <- "will not be mixed up with write function"'))
#'
notify_io <- function(text) {

  # object to store I/O matches
  matched <- list()

  # unlist and trim whitespaces
  txt <- unlist(stringr::str_split(text, pattern = "\n"))
  txt <- stringr::str_trim(txt)

  # lines containing read/write methods
  reg_patterns  <- paste0(io_patterns, collapse = "|")
  matched_lines <- which(re2r::re2_detect(string = txt, pattern = reg_patterns))

  # extract line No., I/O function, and artifact (if qouted)
  for (line in matched_lines) {
    content <- txt[line]
    cmd <-
      re2r::re2_extract(content, reg_patterns) %>%
      re2r::re2_replace("\\(", "")
    file  <- noquote(re2r::re2_extract(content, in_quotes))
    matched <- append(matched, paste0("# line ", line, ":\t", cmd, "\t", file))
  }

  return(paste(matched, collapse = "\n"))
}

#' Detect and Display Libraries Used Throughout the Script.
#'
#' @param text String
#'
#' @return String
#' @export
#'
#' @examples
#' cat(
#'   notify_libraries(
#'     'require(dplyr)
#'     library(magrittr)
#'     stringr::str_replace("1", "ONE")'))
#'
notify_libraries <- function(text) {

  # const
  EXPLICIT_GROUP <- 3L

  # object to store libraries matches
  matched <- list()

  # unlist and trim whitespaces
  txt <- unlist(stringr::str_split(text, pattern = "\n"))
  txt <- stringr::str_trim(txt)

  # lines with explicit or implicit library usage
  matched_lines <- union(
    which(re2r::re2_detect(string = txt, pattern = library_explicit)),
    which(re2r::re2_detect(string = txt, pattern = library_implicit))
  )

  # extract line No. and library name
  for (line in matched_lines) {
    content <- txt[line]
    lib <-
      re2r::re2_extract(content, library_implicit) %>%
      re2r::re2_replace("\\:\\:", "")
    if (is.na(lib))
      lib <- re2r::re2_match(content, library_explicit)[[EXPLICIT_GROUP]]
    matched <- append(matched, paste0("# line ", line, ": ", lib))
  }

  return(paste(matched, collapse = "\n"))
}