prep for release

Author: s-fleck

.travis.yml

@@ -1,6 +1,11 @@
 # R for travis: see documentation at https://docs.travis-ci.com/user/languages/r
 # https://gist.github.com/gaborcsardi/68960fb01bec74d89611bb9c2b0b7e5a
 language: R
+addons:
+  apt:
+    packages:
+      - libharfbuzz-dev # for pkgdown
+      - libfribidi-dev
 matrix:
   include:
   - r: devel
@@ -11,15 +16,14 @@ matrix:
       - Rscript -e 'covr::codecov()'
     deploy:
       provider: script
-      script: Rscript -e 'remotes::install_cran("pkgdown");pkgdown::deploy_site_github(ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY", ""))'
+      script: Rscript -e 'pkgdown::deploy_site_github(ssh_id = Sys.getenv("TRAVIS_DEPLOY_KEY", ""))'
       skip_cleanup: true
   - r: 3.5
   - r: 3.4
   - r: 3.3
   - r: 3.2
 r_github_packages:
-  - s-fleck/lgrExtra
-  - s-fleck/rotor
+  - s-fleck/lgrExtra  # for building the documentation that has links to lgrExtra
 sudo: false
 after_success:
   - Rscript -e 'devtools::install();devtools::test()'

DESCRIPTION

@@ -16,8 +16,8 @@ Description: A flexible, feature-rich yet light-weight logging
     appenders that support logging to databases, email and push
     notifications see the the package lgr.app.
 License: MIT + file LICENSE
-URL: https://s-fleck.github.io/lgr
-BugReports: https://github.com/s-fleck/lgr/issues
+URL: https://s-fleck.github.io/lgr/
+BugReports: https://github.com/s-fleck/lgr/issues/
 Depends:
     R (>= 3.2.0)
 Imports: 
@@ -34,7 +34,7 @@ Suggests:
     jsonlite,
     knitr,
     rmarkdown,
-    rotor (>= 0.2.4.9002),
+    rotor (>= 0.3.0),
     rprojroot,
     testthat,
     tibble,

NEWS.md

@@ -1,4 +1,4 @@
-# lgr (development version)
+# lgr 0.4.0
 
 * Moved more complex Appenders to package 
   [lgrExtra](https://github.com/s-fleck/lgrExtra). This includes database 
@@ -40,12 +40,15 @@
   `should_flush` function. `default_should_flush()` is no longer necessary
   and has been removed.
 
-* Updated AppenderFileRotating to use new **rotor** 2.5.0
+* Updated AppenderFileRotating and co for compatibility with **rotor** 0.3.0
 
 * Most errors now have appropriate subclasses
 
-* Logger$log() dispatches to all appenders, even if some throw an error (instead
-  of aborting after the first Appender that throws an error)
+* `Logger$log()` dispatches to all appenders - even if some throw an error -
+  instead of aborting after the first Appender that throws an error
+  
+* complete rewrite of the documentation to use the new roxgen2 features for
+  R6 classes.
 
 
 # lgr 0.3.4

R/Appender.R

@@ -399,8 +399,8 @@ AppenderJson <- R6::R6Class(
 #'
 #' @description AppenderTable is extended by Appenders that write to a data
 #' source that can be interpreted as tables, (usually a `data.frame`). Examples
-#' are [lgrExtra::AppenderDbi], [lgrExtra::AppenderRjdbc] and
-#' [lgrExtra::AppenderDt].
+#' are `AppenderDbi`, `AppenderRjdbc` and `AppenderDt` from the
+#' [lgrExtra](https://github.com/s-fleck/lgrExtra) package.
 #'
 #' @family Appenders
 #' @export
@@ -461,7 +461,8 @@ AppenderTable <- R6::R6Class(
 #'
 #' @description
 #' AppenderMemory is extended by Appenders that retain an in-memory event
-#' buffer, such as [AppenderBuffer] and [lgrExtra::AppenderPushbullet].
+#' buffer, such as [AppenderBuffer] and `AppenderPushbullet` from the
+#' [lgrExtra](https://github.com/s-fleck/lgrExtra) package.
 #'
 #' @export
 #' @seealso [LayoutFormat]
@@ -958,7 +959,7 @@ AppenderBuffer <- R6::R6Class(
 #'
 #' @export
 #' @seealso [AppenderFileRotatingDate], [AppenderFileRotatingTime], [rotor::rotate()]
-#' @family Appenders, Rotating Appenders
+#' @family Appenders
 #' @export
 AppenderFileRotating <- R6::R6Class(
   "AppenderFileRotating",
@@ -1140,7 +1141,7 @@ AppenderFileRotating <- R6::R6Class(
 # AppenderFileRotatingTime ------------------------------------------------
 
 #' Log to a time-stamped rotating file
-#'
+#' @family Appenders
 #' @seealso [AppenderFileRotatingDate], [AppenderFileRotating], [rotor::rotate()]
 #' @export
 AppenderFileRotatingTime <- R6::R6Class(
@@ -1303,7 +1304,7 @@ AppenderFileRotatingTime <- R6::R6Class(
 #'
 #' This is a simpler version of AppenderFileRotatingTime when the timestamps
 #' do not need to include sub-day accuracy.
-#'
+#' @family Appenders
 #' @seealso [AppenderFileRotatingTime], [AppenderFileRotating], [rotor::rotate()]
 #' @export
 AppenderFileRotatingDate <- R6::R6Class(

R/Layout.R

@@ -304,11 +304,11 @@ LayoutGlue <- R6::R6Class(
 #'
 #' @description
 #' A format for formatting LogEvents as
-#' [jsonlines](http://jsonlines.org/) log files. This provides a
+#' [jsonlines](https://jsonlines.org/) log files. This provides a
 #' nice balance between human- an machine-readability.
 #'
 #' @family Layouts
-#' @seealso [read_json_lines()], [http://jsonlines.org/](http://jsonlines.org/)
+#' @seealso [read_json_lines()], [https://jsonlines.org/](https://jsonlines.org/)
 #' @export
 #' @examples
 #' # setup a dummy LogEvent

R/Logger.R

@@ -1010,7 +1010,7 @@ is_Logger <- function(x){
 #'
 #'
 #' @param x any \R Object
-#' @param color `TRUE` or `FALSE`: Output with color? Requires the package
+#' @param color `TRUE` or `FALSE`: Output with color? Requi<- the Package
 #'   **crayon**
 #' @param ... ignored
 #'

R/basic_config.R

@@ -6,7 +6,7 @@
 #'
 #' @param file `character` scalar: If not `NULL` a [AppenderFile] will be
 #'   created that logs to this file. If the filename ends in `.jsonl`, the
-#'   Appender will be set up to use the [JSON Lines](http://jsonlines.org/)
+#'   Appender will be set up to use the [JSON Lines](https://jsonlines.org/)
 #'   format instead of plain text (see [AppenderFile] and [AppenderJson]).
 #' @param fmt `character` scalar: Format to use if `file` is supplied and not a
 #'   `.jsonl` file. If `NULL` it defaults to `"%L [%t] %m"` (see
@@ -100,7 +100,7 @@ basic_config <- function(
         "Please use `.jsonl` and not `.json` as file extension for JSON log",
         "files. The reason is that that JSON files created",
         "by lgr are not true JSON files but JSONlines files.",
-        "See http://jsonlines.org/ for more infos."
+        "See https://jsonlines.org/ for more infos."
       )
 
     } else if (identical(tolower(ext), "jsonl")){

README.Rmd

@@ -147,13 +147,9 @@ file.remove(logfile)
 ## Development status
 
 lgr in general is stable and safe for use, but some Appenders are still 
-experimental. This especially concerns database appenders which are currently 
-being moved into to their own package 
+experimental. This especially concerns database appenders which are available
+from the sepparate package
 [lgrExtra](https://github.com/s-fleck/lgrExtra). 
-**Please install the stable version from CRAN if you want to try out lgr**
-
-The documentation needs a rewrite and will be ported to roxygen 7.x.x soon. 
-If you have questions please file an issue.
 
 
 

README.md

@@ -65,13 +65,13 @@ vignette.
 
 ``` r
 lgr$fatal("A critical error")
-#> FATAL [09:29:16.642] A critical error
+#> FATAL [10:55:49.023] A critical error
 lgr$error("A less severe error")
-#> ERROR [09:29:16.732] A less severe error
+#> ERROR [10:55:49.145] A less severe error
 lgr$warn("A potentially bad situation")
-#> WARN  [09:29:16.742] A potentially bad situation
+#> WARN  [10:55:49.202] A potentially bad situation
 lgr$info("iris has %s rows", nrow(iris))
-#> INFO  [09:29:16.745] iris has 150 rows
+#> INFO  [10:55:49.217] iris has 150 rows
 
 # the following log levels are hidden by default
 lgr$debug("A debug message")
@@ -85,9 +85,9 @@ appender to log to a file with little effort.
 tf <- tempfile()
 lgr$add_appender(AppenderFile$new(tf, layout = LayoutJson$new()))
 lgr$info("cars has %s rows", nrow(cars))
-#> INFO  [09:29:16.803] cars has 50 rows
+#> INFO  [10:55:49.270] cars has 50 rows
 cat(readLines(tf))
-#> {"level":400,"timestamp":"2020-07-30 09:29:16","logger":"root","caller":"eval","msg":"cars has 50 rows"}
+#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"cars has 50 rows"}
 ```
 
 By passing a named argument to `info()`, `warn()`, and co you can log
@@ -97,10 +97,10 @@ logfiles that are machine as well as (somewhat) human readable.
 
 ``` r
 lgr$info("loading cars", "cars", rows = nrow(cars), cols = ncol(cars))
-#> INFO  [09:29:16.851] loading cars {rows: 50, cols: 2}
+#> INFO  [10:55:49.322] loading cars {rows: 50, cols: 2}
 cat(readLines(tf), sep = "\n")
-#> {"level":400,"timestamp":"2020-07-30 09:29:16","logger":"root","caller":"eval","msg":"cars has 50 rows"}
-#> {"level":400,"timestamp":"2020-07-30 09:29:16","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
+#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"cars has 50 rows"}
+#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
 ```
 
 For more examples please see the package
@@ -137,12 +137,8 @@ file.remove(logfile)
 
 lgr in general is stable and safe for use, but some Appenders are still
 experimental. This especially concerns database appenders which are
-currently being moved into to their own package
-[lgrExtra](https://github.com/s-fleck/lgrExtra). **Please install the
-stable version from CRAN if you want to try out lgr**
-
-The documentation needs a rewrite and will be ported to roxygen 7.x.x
-soon. If you have questions please file an issue.
+available from the sepparate package
+[lgrExtra](https://github.com/s-fleck/lgrExtra).
 
 ## Dependencies