Merge pull request #116 from ambiorix-web/115-prepare-for-cran

115 prepare for cran

Author: JohnCoene

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 2.1.1
-Date: 2024-05-23 15:09:58 UTC
-SHA: d09a2416c75f8ff57fc320c60e48bbb0b2c2cf46
+Version: 2.2.0
+Date: 2025-03-13 10:51:19 UTC
+SHA: af4c92f41ab95127d65e236edffbb2ce4c19acd3

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ambiorix
 Title: Web Framework Inspired by 'Express.js'
-Version: 2.1.1
+Version: 2.2.0
 Authors@R: 
   c(
     person(given = "John",
@@ -41,6 +41,6 @@ Suggests:
   commonmark,
   htmlwidgets,
   testthat (>= 3.0.0)
-URL: https://github.com/devOpifex/ambiorix, https://ambiorix.dev
-BugReports: https://github.com/devOpifex/ambiorix/issues
+URL: https://github.com/ambiorix-web/ambiorix, https://ambiorix.dev
+BugReports: https://github.com/ambiorix-web/ambiorix/issues
 Config/testthat/edition: 3

NAMESPACE

@@ -33,7 +33,6 @@ export(copy_websocket_client)
 export(create_dockerfile)
 export(default_cookie_parser)
 export(forward)
-export(get_websocket_clients)
 export(import)
 export(jobj)
 export(mockRequest)

NEWS.md

@@ -1,3 +1,29 @@
+# ambiorix 2.2.0
+
+__New Features__
+
+- Enable nesting of Routers, [pull/73](https://github.com/ambiorix-web/ambiorix/pull/73).
+- Enable full support for htmltools tags, no need for html templates, [pull/78](https://github.com/ambiorix-web/ambiorix/pull/78), [pull/92](https://github.com/ambiorix-web/ambiorix/pull/92).
+- Add `engine()` method set custom renderers, [pull/66](https://github.com/ambiorix-web/ambiorix/pull/66).
+- Add `set_error()` method to set a global error handler, [pull/64](https://github.com/ambiorix-web/ambiorix/pull/64).
+- Add a default error handler, [pull/88](https://github.com/ambiorix-web/ambiorix/pull/88).
+
+__Changes__
+
+- Resolve port to bind server on in a specific order, [pull/75](https://github.com/ambiorix-web/ambiorix/pull/75).
+- Switch to {yyjsonr} for faster serialization & de-serialization, [pull/100](https://github.com/ambiorix-web/ambiorix/pull/100).
+- Switch to {webutils} for faster parsing of multipart & urlencoded request bodies, [pull/100](https://github.com/ambiorix-web/ambiorix/pull/100).
+- Continually process requests using `httpuv::service()` instead of a while loop, [pull/98](https://github.com/ambiorix-web/ambiorix/pull/98).
+- Remove syntactic sugar to improve backwards compatibility with R <= 4.1.0, [pull/113](https://github.com/ambiorix-web/ambiorix/pull/113).
+- Deprecate `create_dockerfile()`, [pull/116](https://github.com/ambiorix-web/ambiorix/pull/116)
+
+__Bug Fixes__
+
+- Fix bug hindering change of the max body size of a request,
+[pull/69](https://github.com/ambiorix-web/ambiorix/pull/69).
+- Fix issue causing pattern matching in routes to throw error, [pull/82](https://github.com/ambiorix-web/ambiorix/pull/82), [pull/110](https://github.com/ambiorix-web/ambiorix/pull/110).
+- Fix bug on error condition messaging when promise evaluation fails, [pull/88](https://github.com/ambiorix-web/ambiorix/pull/88).
+
 # ambiorix 2.1.1
 
 - Added `cache_templates` method to cache templates
@@ -6,7 +32,7 @@ in memory.
 rendering.
 - Custom renderers (`as_renderer`) are now more robust.
 - Add `limit` field to protect against large uploads.
-- Fix issue with setting custom websocket handler [#62](https://github.com/devOpifex/ambiorix/issues/62).
+- Fix issue with setting custom websocket handler [#62](https://github.com/ambiorix-web/ambiorix/issues/62).
 - Add `engine` method on router to set custom renderers (`use` deprecated for custom renderers).
 
 # ambiorix 2.1.0
@@ -38,16 +64,16 @@ No longer force render data as JSON if using an HTML template.
 - Export `serialise`
 - Fixed issue where wrong path pattern was matched.
 - Catch error if no route is specified.
-- Do not force body to character fixes [#44](https://github.com/devOpifex/ambiorix/issues/44)
-- Do no force content type on response fixes [#45](https://github.com/devOpifex/ambiorix/issues/45)
+- Do not force body to character fixes [#44](https://github.com/ambiorix-web/ambiorix/issues/44)
+- Do no force content type on response fixes [#45](https://github.com/ambiorix-web/ambiorix/issues/45)
 - Deprecate passing headers to `response` or `send`-like functions, use
 `header` method.
 - Deprecate `set_header` in favour of `header` method.
 - Added family of `header_content*` methods to easily set `Content-Type`.
 - Request `HEADERS` is always a `list`.
-- Deprecate `set` and `get` on Response and Request, this is no longer 
+- Deprecate `set` and `get` on Response and Request, this is no longer
 needed the environments are no longer locked; `res$myVar <- 2L`.
-- Deprecate `status` argument of responses, the active binding should 
+- Deprecate `status` argument of responses, the active binding should
 be used instead; `res$status <- 404L`.
 - Partially improved route matching.
 - Allow customising the path to pattern converter.
@@ -64,9 +90,9 @@ of said router.
 - Empty cookie is empty list instead of empty string.
 - Added `mockRequest` to for testing purposes.
 - Fixed `port`, `host`, and `websocket` active bindings.
-- Add ability to create custom renderer, see 
-[jader](https://github.com/devOpifex/jader), and 
-[pugger](https://github.com/devOpifex/pugger).
+- Add ability to create custom renderer, see
+[jader](https://github.com/ambiorix-web/jader), and
+[pugger](https://github.com/ambiorix-web/pugger).
 
 # ambiorix 2.0.0
 
@@ -76,7 +102,7 @@ The `render` and `send_file` methods of the `Response` object now
 expect the full path to the template, with the file extension.
 Where one would before `res$render("home")`, now one
 `res$render("templates/home.html")`.
-Similarly, in said templates, to import partials, 
+Similarly, in said templates, to import partials,
 use full path relative to the template in which the partial is used
 e.g.: from `[! header.html !]` to `[! partials/header.html !]`.
 
@@ -90,15 +116,15 @@ locking variables when using `set`.
 - Remove the deprecated `Logger` class, see [log](https://github.com/devOpifex/log) package.
 - Pass `host` to free port fetch function.
 - Add hidden option to force change port for upcoming related service.
-- Internals of calls reworked to share response object. 
-This is how it should always have worked, it allows middlewares to 
+- Internals of calls reworked to share response object.
+This is how it should always have worked, it allows middlewares to
 updatre request and response to be used/passed to subsequent calls.
 - Middleware check for run has been fixed.
 - Document and export the `Response` class.
 - Added pre-hook to response.
 - Document and export `Request` class.
 - `set` and `get` methods on `Request` and `Response` accept character
-strings as `name`. 
+strings as `name`.
 - Use R 4.1.0 + add `Depends`
 - Allow passing a list of functions to `use` to easily se multiple
 middlewares at once.
@@ -124,19 +150,19 @@ with `sprintf`.
 # ambiorix 1.0.2
 
 - Reaches CRAN
-- Removed `create_ambiorix`, see [ambiorix.generator](https://github.com/devOpifex/ambiorix.generator).
-- Removed `add_template`, see [ambiorix.generator](https://github.com/devOpifex/ambiorix.generator).
+- Removed `create_ambiorix`, see [ambiorix.generator](https://github.com/ambiorix-web/ambiorix.generator).
+- Removed `add_template`, see [ambiorix.generator](https://github.com/ambiorix-web/ambiorix.generator).
 - Deprecate the `Logger` class in favour of the [log](https://github.com/devOpifex/log) package.
-- Fixed `parse_json` [#36](https://github.com/devOpifex/ambiorix/issues/36)
+- Fixed `parse_json` [#36](https://github.com/ambiorix-web/ambiorix/issues/36)
 
 # ambiorix 1.0.1
 
-- Deprecate `create_ambiorix`: moving to [ambiorix.generator](https://github.com/devOpifex/ambiorix.generator) package.
-- Deprecate `add_template`: moving to [ambiorix.generator](https://github.com/devOpifex/ambiorix.generator) package.
+- Deprecate `create_ambiorix`: moving to [ambiorix.generator](https://github.com/ambiorix-web/ambiorix.generator) package.
+- Deprecate `add_template`: moving to [ambiorix.generator](https://github.com/ambiorix-web/ambiorix.generator) package.
 - Added `all` method to define route and handler for all methods `GET`, `POST`, `PUT`, `DELETE`, and `PATCH`.
 - The `use` method now accepts a function which is run every time the server receives a request.
 - Add `set` and `get` to request to add and retrieve params (namely with the middleware)
-- Fix `check_installed`, see [#33](https://github.com/devOpifex/ambiorix/issues/33)
+- Fix `check_installed`, see [#33](https://github.com/ambiorix-web/ambiorix/issues/33)
 
 # ambiorix 1.0.0
 

R/content.R

@@ -15,7 +15,7 @@
 #'  )
 #' 
 #' @name content
-#' 
+#' @return Length 1 character vector.
 #' @export 
 content_html <- function() {
   "text/html"

R/cookie.R

@@ -3,9 +3,26 @@
 #' Parses the cookie string.
 #' 
 #' @param req A [Request].
-#' 
+#' @examples
+#' if (interactive()) {
+#'   library(ambiorix)
+#' 
+#'   #' Handle GET at '/greet'
+#'   #'
+#'   #' @export
+#'   say_hello <- function(req, res) {
+#'     cookies <- default_cookie_parser(req)
+#'     print(cookies)
+#' 
+#'     res$send("hello there!")
+#'   }
+#' 
+#'   app <- Ambiorix$new()
+#'   app$get("/greet", say_hello)
+#'   app$start()
+#' }
+#'
 #' @return A `list` of key value pairs or cookie values.
-#' 
 #' @export 
 default_cookie_parser <- function(req) {
   cookie_new <- list()
@@ -18,7 +35,7 @@ default_cookie_parser <- function(req) {
 
   split <- strsplit(req$HTTP_COOKIE, ";")[[1]]
   split <- strsplit(split, "=")
-  for(i in 1:length(split)) {
+  for(i in seq_along(split)) {
     value <- trimws(split[[i]])
 
     if(length(value) < 2)
@@ -54,6 +71,7 @@ default_cookie_parser <- function(req) {
 #' app <- Ambiorix$new()
 #' app$use(parser)
 #' 
+#' @return Object of class "cookieParser".
 #' @export 
 as_cookie_parser <- function(fn) {
   assert_that(not_missing(fn))
@@ -76,6 +94,7 @@ print.cookieParser <- function(x, ...) {
 }
 
 #' @keywords internal
+#' @noRd
 is_cookie_parser <- function(obj) {
   inherits(obj, "cookieParser")
 }
@@ -99,6 +118,7 @@ is_cookie_parser <- function(obj) {
 #' app <- Ambiorix$new()
 #' app$use(prep)
 #' 
+#' @return Object of class "cookiePreprocessor".
 #' @export 
 as_cookie_preprocessor <- function(fn) {
   assert_that(not_missing(fn))
@@ -154,6 +174,7 @@ is_cookie_preprocessor <- function(obj) {
 #' attacks (CSRF). Accepts `Strict`, `Lax`, or `None`.
 #' 
 #' @keywords internal
+#' @noRd
 cookie <- function(
   name,
   value,

R/docker.R

@@ -9,14 +9,21 @@
 #' @details Reads the `DESCRIPTION` file of the project to produce the `Dockerfile`.
 #' 
 #' @param port,host Port and host to serve the application.
+#' @param file_path String. Path to file to write to.
 #' 
 #' @examples 
-#' \dontrun{create_dockerfile()}
+#' if (interactive()) {
+#'   create_dockerfile(port = 5000L, host = "0.0.0.0", file_path = tempfile())
+#'   # create_dockerfile(port = 5000L, host = "0.0.0.0", file_path = "Dockerfile") 
+#' }
 #' 
+#' @return `NULL` (invisibly)
 #' @export
-create_dockerfile <- function(port, host = "0.0.0.0"){
+create_dockerfile <- function(port, host = "0.0.0.0", file_path){
+  .Deprecated(msg = "'create_dockerfile' is deprecated. Please write the Dockerfile manually.")
   assert_that(has_file("DESCRIPTION"))
   assert_that(not_missing(port))
+  assert_that(not_missing(file_path))
 
   cli::cli_alert_warning("Ensure your {.file DESCRIPTION} file is up to date with {.fun devtools::check}")
 
@@ -25,30 +32,14 @@ create_dockerfile <- function(port, host = "0.0.0.0"){
 
   dockerfile <- c(
     "FROM jcoenep/ambiorix",
-    "RUN echo \"options(repos = c(CRAN = 'https://packagemanager.rstudio.com/all/latest'))\" >> /usr/local/lib/R/etc/Rprofile.site",
-    "RUN R -e 'install.packages(\"remotes\")'"
+    "RUN echo \"options(repos = c(CRAN = 'https://packagemanager.rstudio.com/all/latest'))\" >> /usr/local/lib/R/etc/Rprofile.site"
   )
 
   # CRAN packages
   desc <- read.dcf("DESCRIPTION")
   pkgs <- desc[, "Imports"]
   pkgs <- strsplit(pkgs, ",")[[1]]
   pkgs <- gsub("\\\n", "", pkgs)
-  cran <- sapply(pkgs, function(pkg){
-    sprintf("RUN R -e \"install.packages('%s')\"", pkg)
-  })
-
-  # remotes
-  rmts <- tryCatch(desc[, 'Remotes'], error = function(e) NULL)
-  if(!is.null(rmts)){
-    rmts <- strsplit(rmts, ",")[[1]]
-    rmts <- gsub("\\\n", "", rmts)
-    rmts <- rmts[rmts != "ambiorix"]
-    rmts <- sapply(rmts, function(pkg){
-      sprintf("RUN R -e \"remotes::install_github('%s', force=FALSE)\"", pkg)
-    })
-    cran <- c(cran, rmts)
-  }
 
   cmd <- sprintf(
     "CMD R -e \"options(ambiorix.host='%s', 'ambiorix.port'=%s);source('app.R')\"", 
@@ -57,14 +48,13 @@ create_dockerfile <- function(port, host = "0.0.0.0"){
 
   dockerfile <- c(
     dockerfile,
-    cran,
     "COPY . .",
     cmd
   )
 
-  x <- writeLines(dockerfile, "Dockerfile")
+  x <- writeLines(dockerfile, file_path)
 
   cli::cli_alert_success("Created {.file Dockerfile}")
 
   invisible()
-}
+}

R/import.R

@@ -1,17 +1,19 @@
 #' Import Files
-#' 
+#'
 #' Import all R-files in a directory.
-#' 
+#'
 #' @param ... Directory from which to import `.R` or `.r` files.
-#' 
-#' @examples 
-#' \dontrun{import("views")}
-#' 
+#'
+#' @examples
+#' if (interactive()) {
+#'   import("views")
+#' }
+#'
 #' @return Invisibly returns `NULL`.
-#' 
+#'
 #' @export
-import <- function(...){{
-  files <- fs::dir_ls(..., regexp = "\\.R$|\\.r$") 
+import <- function(...) {
+  files <- fs::dir_ls(..., regexp = "\\.R$|\\.r$")
   sapply(files, source)
   invisible()
-}}
+}

R/log.R

@@ -51,7 +51,21 @@ new_log <- function(
 #' [log::Logger].
 #' 
 #' @name set_log
+#' @return The `log` object.
+#' @examples
+#' # define custom loggers:
+#' info_logger <- log::Logger$new("INFO")
+#' success_logger <- log::Logger$new("SUCCESS")
+#' error_logger <- log::Logger$new("ERROR")
 #' 
+#' info_logger$log("This is an info message.")
+#' success_logger$log("This is a success message.")
+#' error_logger$log("This is an error message.")
+#' 
+#' # set custom loggers for Ambiorix:
+#' set_log_info(info_logger)
+#' set_log_success(success_logger)
+#' set_log_error(error_logger)
 #' @export
 set_log_info <- function(log) {
   assert_that(not_missing(log))
@@ -83,21 +97,25 @@ set_log_error <- function(log) {
 #' CLI Symbols for log
 #' 
 #' @keywords internal
+#' @noRd
 success <- function() {
   cli::col_green(cli::symbol$tick)
 }
 
 #' @keywords internal
+#' @noRd
 error <- function() {
   cli::col_red(cli::symbol$cross)
 }
 
 #' @keywords internal
+#' @noRd
 info <- function() {
   cli::col_blue(cli::symbol$info)
 }
 
 #' @keywords internal
+#' @noRd
 warn <- function() {
   cli::col_yellow(cli::symbol$warning)
 }