R/log-tools.R

In texor: Converting 'LaTeX' 'R Journal' Articles into 'RJ-web-articles'

#' @title texor log setup
#' @description a wrapper function for logger package to set up log file for
#' logging
#' @param article_dir path to the directory which contains tex article
#' @param file_name name of the log file
#' @param namespace namespace of log file
#' @param idx index of log level
#' @return NULL but also creates a log file in the article_dir
#' @export
#'
#' @examples
#' dir.create(your_article_folder <- file.path(tempdir(), "exampledir"))
#' example_files <-  system.file("examples/article", package = "texor")
#' x <- file.copy(from = example_files,to=your_article_folder,recursive = TRUE)
#' your_article_path <- paste(your_article_folder,"article",sep="/")
#'  texor::log_setup(your_article_path, "log-file.log", "texor", 2)
#' unlink(your_article_folder,recursive = TRUE)
log_setup <- function(article_dir, file_name, namespace, idx) {
    article_dir <- xfun::normalize_path(article_dir)
    log_file_path <- paste(article_dir, file_name, sep = "/")
    if(! file.exists(log_file_path)) {
        file.create(log_file_path,showWarnings = T)
    } else {
        #pass
    }
    logger::log_threshold(namespace = namespace, index = idx)
    logger::log_appender(logger::appender_file(log_file_path),
                         namespace = namespace,
                         index=idx)
}



#' @title log messages for various categories
#' @description a wrapper function for logging different types of log entries
#' @param message message to be sent
#' @param category category of the log message
#' @param idx index of log level
#' @return NUll, but also appends message to the log file in article_dir
#' @export
#'
#' @examples
#' dir.create(your_article_folder <- file.path(tempdir(), "exampledir"))
#' example_files <- system.file("examples/article", package = "texor")
#' x <- file.copy(from = example_files,to=your_article_folder,recursive = TRUE)
#' your_article_path <- paste(your_article_folder,"article",sep="/")
#' texor::log_setup(your_article_path, "log-file.log", "texor" , 2)
#' texor::texor_log("Hello", "INFO", 2)
#' cat(readLines(paste(your_article_path,"/log-file.log",sep="")),sep="\n")
#' unlink(your_article_folder,recursive = TRUE)
texor_log <- function(message, category, idx) {
    if (identical(tolower(category), "info")) {
        logger::log_info(message, namespace = "texor")
        logger::log_appender(namespace = "texor",index = idx)
    }
    if (identical(tolower(category), "success")) {
        logger::log_success(message, namespace = "texor")
        logger::log_appender(namespace = "texor",index = idx)
    }
    if (identical(tolower(category), "warning")) {
        logger::log_warn(message, namespace = "texor")
        logger::log_appender(namespace = "texor",index = idx)
    }
    if (identical(tolower(category), "debug")) {
        logger::log_debug(message,namespace = "texor",index =2)
        logger::log_appender(namespace = "texor",index = idx)
    }
    if (identical(tolower(category), "error")) {
        logger::log_error(message, namespace = "texor")
        logger::log_appender(namespace = "texor",index = idx)
    }
    if (identical(tolower(category), "failure")) {
        logger::log_failure(message, namespace = "texor")
        logger::log_appender(namespace = "texor",index = idx)
    } else {
        #pass
        #logger::log_info(message)
    }
}