prep for release

Author: s-fleck

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: lgr
 Title: A Fully Featured Logging Framework
-Version: 0.9.0.9000
+Version: 0.2.0
 Authors@R: 
     person(given = "Stefan",
            family = "Fleck",
@@ -37,6 +37,9 @@ Suggests:
     RSQLite,
     RMariaDB,
     RPostgres,
+    RMySQL, 
+    RPostgreSQL,
+    rprojroot,
     testthat,
     tibble,
     tools,

NEWS.md

@@ -1,28 +1,29 @@
-# lgr 0.2.0.9000
+# lgr 0.2.0
 
-* 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. 
-* `lg$parent` is now derived from `lg$name`, `lg$set_parent()` is no longer
-  possible.
+* `get_loggers()` registers new loggers in the lgr::loggers namespace, this 
+  is a more global and decoupled approach similar to how python logging handles 
+  loggers. 
 * removed `full_name` active binding for loggers. Loggers now only have 
   qualified names and `name` is now identical to what `full_name` was before.
   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 relevant fixes to finalizers)
-* finalize methods are now private
-* support for new ways to configure loggers, including YAML config files 
-  (experimental)
+* Logger inheritance is now derived from the qualified name of a logger. 
+  Consequently `lg$parent` is now derived from `lg$name`, `lg$set_parent()` 
+  is no longer possible.
+* If no threshold is set of r a new Logger, it now inherits the threshold
+  of its parent
+* Depend on R6 >= 2.4.0 which includes relevant fixes to finalizers. finalize 
+  methods are now private.
+* Logger now have a `config` method that allows configuring Loggers with config
+  objecgts and YAML files (experimental)
 * added `with_logging()`, the opposite of `without_logging()`. This can be
-  handy for automated tests
+  handy for automated tests where you might want so switch logging off/on only
+  for specific unit tests.
 
 
 # lgr 0.1.1
 
 * Added `show_data()` and `show_dt()` for quick access to the root loggers
   in memory log as `data.frame` or `data.table` respectively
 * numerous small fixes
-* removed non-breaking-spaces from .RD files. This caused unforseen problems 
-  with the compiling the .pdf manuall during the CRAN submission process.
+* removed non-breaking-spaces from .RD files. This caused unforeseen problems 
+  with the compiling the .pdf manual during the CRAN submission process.

R/Logger.R

@@ -151,7 +151,7 @@
 #'
 #'    \item{`spawn(...)`}{Spawn a child Logger.
 #'      `get_logger("foo/bar")$spawn("baz")` is equivalent to
-#'      `get_logger("foo/bar/baz")`, but can be convenient for programatic use
+#'      `get_logger("foo/bar/baz")`, but can be convenient for programmatic use
 #'      when the name of the parent Logger is not known.}
 #' }
 #'
@@ -818,7 +818,7 @@ LoggerGlue <- R6::R6Class(
 # LoggerRoot --------------------------------------------------------------
 
 #' Special logger subclass for the root logger. Currently exactly like a
-#' normale Logger, but prevents the threshold to be set to NULL
+#' normal Logger, but prevents the threshold to be set to NULL
 LoggerRoot <-
   R6::R6Class(
     "LoggerRoot",

R/logger_config.R

@@ -77,7 +77,7 @@ logger_config <- function(
 #'   * a Logger object, to clone its configuration.
 #'
 #' @rdname logger_config
-#' @seealso \url{https://www.yaml.org/}
+#' @seealso \url{https://yaml.org/}
 #' @return a logger_config object
 #' @export
 #'

R/simple_logging.R

@@ -16,7 +16,7 @@ NULL
 
 
 
-#' Basic Setup for the Logging Systen
+#' Basic Setup for the Logging System
 #'
 #' Quick and easy way to configure the root logger for logging to a file
 #'
@@ -28,7 +28,7 @@ NULL
 #'   (see [format.LogEvent])
 #' @inheritParams print.LogEvent
 #' @inheritParams Logger
-#' @param appenders a single [Appender] or a list thereof. Musst be `NULL` if
+#' @param appenders a single [Appender] or a list thereof. Must be `NULL` if
 #'   if `file` is already specified.
 #' @param threshold `character` or `integer` scalar.
 #'   The minimum [log level][log_levels] that should be processed by the root

README.Rmd

@@ -192,12 +192,12 @@ dependencies, and are well maintained :
     guessing the user name from various sources. You can also set the user name 
     manually if you want to use it for logging.
   - [desc](https://CRAN.R-project.org/package=desc) for the package development
-    convenince function `use_logger()`
+    convenience function `use_logger()`
   - [yaml](https://CRAN.R-project.org/package=yaml) for configuring loggers 
     via YAML files
 
   Other optional dependencies (future, future.apply) do not provide any extra
-  functionallity but had to be included for some of the automated unit tests
+  functionality but had to be included for some of the automated unit tests
   run by lgr.
 
 

README.md

@@ -32,13 +32,13 @@ To log an *event* with with lgr we call `lgr$<logging function>()`. Unnamed argu
 
 ``` r
 lgr$fatal("A critical error")
-#> FATAL [20:59:26.152] A critical error
+#> FATAL [08:36:29.158] A critical error
 lgr$error("A less severe error")
-#> ERROR [20:59:26.203] A less severe error
+#> ERROR [08:36:29.218] A less severe error
 lgr$warn("A potentially bad situation")
-#> WARN  [20:59:26.241] A potentially bad situation
+#> WARN  [08:36:29.262] A potentially bad situation
 lgr$info("iris has %s rows", nrow(iris))
-#> INFO  [20:59:26.243] iris has 150 rows
+#> INFO  [08:36:29.269] iris has 150 rows
 
 # the following log levels are hidden by default
 lgr$debug("A debug message")
@@ -51,19 +51,19 @@ A Logger can have several Appenders. For example, we can add a JSON appender to
 tf <- tempfile()
 lgr$add_appender(AppenderJson$new(tf))
 lgr$info("cars has %s rows", nrow(cars))
-#> INFO  [20:59:26.375] cars has 50 rows
+#> INFO  [08:36:29.414] cars has 50 rows
 cat(readLines(tf))
-#> {"level":400,"timestamp":"2019-03-21 20:59:26","logger":"root","caller":"eval","msg":"cars has 50 rows"}
+#> {"level":400,"timestamp":"2019-03-22 08:36:29","logger":"root","caller":"eval","msg":"cars has 50 rows"}
 ```
 
 JSON naturally supports custom fields. Named arguments passed to `info()`, `warn()`, etc... are interpreted as custom fields.
 
 ``` r
 lgr$info("loading cars", "cars", rows = nrow(cars), cols = ncol(cars))
-#> INFO  [20:59:26.396] loading cars {rows: 50, cols: 2}
+#> INFO  [08:36:29.463] loading cars {rows: 50, cols: 2}
 cat(readLines(tf), sep = "\n")
-#> {"level":400,"timestamp":"2019-03-21 20:59:26","logger":"root","caller":"eval","msg":"cars has 50 rows"}
-#> {"level":400,"timestamp":"2019-03-21 20:59:26","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
+#> {"level":400,"timestamp":"2019-03-22 08:36:29","logger":"root","caller":"eval","msg":"cars has 50 rows"}
+#> {"level":400,"timestamp":"2019-03-22 08:36:29","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
 ```
 
 For more examples please see the package [vignette](https://s-fleck.github.io/lgr/articles/lgr.html) and [documentation](https://s-fleck.github.io/lgr/)
@@ -125,9 +125,10 @@ Care was taken to choose packages that are slim, stable, have minimal dependenci
 -   [gmailr](https://cran.r-project.org/package=gmailr) or [sendmailR](https://cran.r-project.org/package=sendmailR) for email notifications.
 -   [RPushbullet](https://github.com/eddelbuettel/rpushbullet) for push notifications.
 -   [whoami](https://github.com/r-lib/whoami/blob/master/DESCRIPTION) for guessing the user name from various sources. You can also set the user name manually if you want to use it for logging.
--   [desc](https://CRAN.R-project.org/package=desc) for the package development convenince function `use_logger()`
+-   [desc](https://CRAN.R-project.org/package=desc) for the package development convenience function `use_logger()`
+-   [yaml](https://CRAN.R-project.org/package=yaml) for configuring loggers via YAML files
 
-Other optional dependencies (future, future.apply) do not provide any extra functionallity but had to be included for some of the automated unit tests run by lgr.
+Other optional dependencies (future, future.apply) do not provide any extra functionality but had to be included for some of the automated unit tests run by lgr.
 
 Installation
 ------------

cran-comments.md

@@ -10,5 +10,5 @@
 
 0 errors | 0 warnings | 0 notes
 
-* This is a resubmission that removes non-breaking-space characters from the
-  .rd files for R6 classes, which caused problems with the pdf manual.
+Loggers now live in a global loggers namespace, YAML configuration for Loggers,
+lots of small bugfixes and enhancements