added with_logging() for symmetry with without_logging()

Author: Stefan Fleck

NAMESPACE

@@ -80,5 +80,6 @@ export(unsuspend_logging)
 export(use_logger)
 export(with_log_level)
 export(with_log_value)
+export(with_logging)
 export(without_logging)
 importFrom(stats,setNames)

NEWS.md

@@ -1,4 +1,6 @@
-# lgr 0.1.1.9000
+# lgr 0.2.0.9000
+
+* to be released as 1.0.0
 
 * `get_loggers()` registeres new loggers in the lgr::loggers namespace, this 
   is a more global and decoupled approach to loggers. 
@@ -9,8 +11,12 @@
   For consistency the format method of `ancestry` has also been revised.
 * New Loggers now inherit the log level of their parent unless one is set
 * added a `config` method for Loggers.
-* Depend on R6 >= 2.4.0 (which includes some relevant fixes to finalizers)
+* Depend on R6 >= 2.4.0 (which includes relevant fixes to finalizers)
 * finalize methods are now private
+* support for new ways to configure loggers, including YAML config files 
+  (experimental)
+* added `with_logging()`, the opposite of `without_logging()`. This can be
+  handy for automated tests
 
 
 # lgr 0.1.1

R/utils-logging.R

@@ -1,12 +1,29 @@
 #' Suspend All Logging
 #'
 #' Completely disable logging for all loggers. This is for example useful for
-#' automated test code.
+#' automated test code. `suspend_logging()` globally disables all logging with
+#' lgr until `unsuspend_logging()` is invoked, while `without_logging()` and
+#' `with_logging()` temporarily disable/enable logging.
 #'
 #' @return
 #'   `suspend_logging()` and `unsuspend_logging()` return `NULL` (invisibly),
-#'   `without_logging` returns whatever `code` returns
+#'   `without_logging()` and `with_logging()` returns whatever `code` returns.
 #' @export
+#' @examples
+#' lg <- get_logger("test")
+#'
+#' # temporarily disable logging
+#' lg$fatal("foo")
+#' without_logging(lg$fatal("bar"))
+#'
+#' # globally disable logging
+#' suspend_logging()
+#' lg$fatal("bar")
+#' with_logging(lg$fatal("foo"))  # log anyways
+#'
+#' # globally enable logging again
+#' unsuspend_logging()
+#' lg$fatal("foo")
 suspend_logging <- function(){
   options("lgr.logging_suspended" = TRUE)
   invisible()
@@ -29,10 +46,6 @@ unsuspend_logging <- function(){
 #' @param code Any \R code
 #' @export
 #' @examples
-#' without_logging({
-#'   FATAL("FOO")
-#'   INFO("BAR")
-#' })
 #'
 without_logging <- function(code){
   old <- getOption("lgr.logging_suspended")
@@ -44,6 +57,25 @@ without_logging <- function(code){
 
 
 
+
+#'
+#'
+#' @rdname suspend_logging
+#' @param code Any \R code
+#' @export
+#' @examples
+#'
+with_logging <- function(code){
+  old <- getOption("lgr.logging_suspended")
+  on.exit(options(lgr.logging_suspended = old))
+  unsuspend_logging()
+  force(code)
+}
+
+
+
+
+
 #' Inject Values into Logging Calls
 #'
 #' `with_log_level` temporarily overrides the log level of all [LogEvents]

man/as_logger_config.Rd

@@ -4,14 +4,21 @@ context("utils-logging")
 
 
 test_that("log suppression", {
-  expect_output(FATAL("test"), "FATAL")
-  expect_silent(without_logging(FATAL("test")))
-  expect_output(FATAL("test"), "FATAL")
+  lg <- get_logger("test")
 
+  # without_logging() suppresses log messages temporarily
+  expect_output(lg$fatal("test"), "FATAL")
+  expect_silent(without_logging(lg$fatal("test")))
+  expect_output(lg$fatal("test"), "FATAL")
+
+  # suspending works and can be ignored with with_logging()
   suspend_logging()
-  expect_silent(FATAL("test"))
+  expect_silent(lg$fatal("test"))
+  expect_output(with_logging(lg$fatal("test")))
+
+  # unsuspending logging works
   unsuspend_logging()
-  expect_output(FATAL("test"), "FATAL")
+  expect_output(lg$fatal("test"), "FATAL")
 })