update name of main class to plumber2

Author: thomasp85

NAMESPACE

@@ -38,7 +38,7 @@ S3method(roxy_tag_parse,roxy_tag_tag)
 S3method(roxy_tag_parse,roxy_tag_trace)
 export(Break)
 export(Next)
-export(Plumber)
+export(Plumber2)
 export(abort_bad_request)
 export(abort_conflict)
 export(abort_forbidden)

R/Plumber.R

@@ -1,27 +1,27 @@
-#' The Plumber Class
+#' The Plumber2 Class
 #'
 #' @description
 #' This class encapsulates all of the logic of a plumber2 api, and is what gets
-#' passed around in the functional api of plumber2. The Plumber class is a
+#' passed around in the functional api of plumber2. The Plumber2 class is a
 #' subclass of the [fiery::Fire] class. Please consult the documentation for
 #' this for additional information on what this type of server is capable of.
-#' Note that the Plumber objects are reference objects, meaning that any change
+#' Note that the Plumber2 objects are reference objects, meaning that any change
 #' to it will change all instances of the object.
 #'
 #' ## Initialization
-#' A new 'Plumber'-object is initialized using the `new()` method on the
+#' A new 'Plumber2'-object is initialized using the `new()` method on the
 #' generator:
 #'
 #' \tabular{l}{
-#'  `api <- Plumber$new()`
+#'  `api <- Plumber2$new()`
 #' }
 #'
 #' However, most users will use the functional api of the package and thus
 #' construct one using [api()]
 #'
 #' ## Copying
-#' As `Plumber` objects are using reference semantics new copies of an api cannot
-#' be made simply be assigning it to a new variable. If a true copy of a `Plumber`
+#' As `Plumber2` objects are using reference semantics new copies of an api cannot
+#' be made simply be assigning it to a new variable. If a true copy of a `Plumber2`
 #' object is desired, use the `clone()` method.
 #'
 #' @importFrom R6 R6Class
@@ -32,11 +32,11 @@
 #'
 #' @export
 #'
-Plumber <- R6Class(
-  "Plumber",
+Plumber2 <- R6Class(
+  "Plumber2",
   inherit = Fire,
   public = list(
-    #' @description Create a new `Plumber` api
+    #' @description Create a new `Plumber2` api
     #' @param host A string overriding the default host
     #' @param port An port number overriding the default port
     #' @param doc_type The type of API documentation to generate. Can be either
@@ -72,7 +72,7 @@ Plumber <- R6Class(
     #' handling
     #' @param env An environment that will be used as the default execution
     #' environment for the API
-    #' @return A `Plumber` object
+    #' @return A `Plumber2` object
     initialize = function(
       host = get_opts("host", "127.0.0.1"),
       port = get_opts("port", 8080),
@@ -176,7 +176,7 @@ Plumber <- R6Class(
 
       if (!silent)
         cli::cli_text(
-          "Plumber server started at http://{self$host}:{self$port}"
+          "Plumber2 server started at http://{self$host}:{self$port}"
         )
       super$ignite(block = block, showcase = showcase, ..., silent = TRUE)
     },

R/api.R

@@ -1,7 +1,8 @@
 #' Create a new plumber API, optionally based on one or more plumber files
 #'
-#' This is the main way to create a new Plumber object that encapsulates your
+#' This is the main way to create a new Plumber2 object that encapsulates your
 #' full api. It is also possible to add files to the API after creation using
+#' `api_parse()`
 #'
 #' @param ... plumber files or directories containing plumber files to be parsed
 #' in the given order. The order of parsing determines the final order of the
@@ -47,7 +48,7 @@
 #' evaluated in. Each file will be evaluated in it's own environment so they
 #' don't interfere with each other
 #'
-#' @return A Plumber object
+#' @return A [Plumber2] object
 #'
 #' @export
 #'
@@ -82,7 +83,7 @@ api <- function(
         )
       }
     } else {
-      api <- Plumber$new(
+      api <- Plumber2$new(
         host = server_yml$options$host %||% host,
         port = server_yml$options$port %||% port,
         doc_type = server_yml$options$docType %||% doc_type,
@@ -105,7 +106,7 @@ api <- function(
       server_yml$routes
     )
   } else {
-    api <- Plumber$new(
+    api <- Plumber2$new(
       host = host,
       port = port,
       doc_type = doc_type,
@@ -125,7 +126,7 @@ api <- function(
 #' @param x An object to test for whether it is a plumber api
 #' @export
 #'
-is_plumber_api <- function(x) inherits(x, "Plumber")
+is_plumber_api <- function(x) inherits(x, "Plumber2")
 
 #' @rdname api
 #' @param api A plumber2 api object to parse files into

R/api_handlers.R

@@ -150,7 +150,7 @@ handle_constructor <- function(method, header = FALSE) {
 #'   object
 #' * `response`: The response being returned to the client as a
 #'   [reqres::Response] object
-#' * `server`: The [Plumber] object representing your server implementation
+#' * `server`: The [Plumber2] object representing your server implementation
 #' * `client_id`: A string uniquely identifying the session the request comes
 #'   from
 #' * `query`: A list giving any additional arguments passed into the handler as
@@ -389,7 +389,7 @@ api_add_route <- function(
 #' The handler can take any of the following arguments:
 #' * `message`: Either a raw vector if the message recieved is in binary form or
 #'   a single string, giving the message sent from the client
-#' * `server`: The [Plumber] object representing your server implementation
+#' * `server`: The [Plumber2] object representing your server implementation
 #' * `client_id`: A string uniquely identifying the session the request comes
 #'   from
 #' * `request`: The request that was initially used to establish the websocket

R/api_logger.R

@@ -1,6 +1,6 @@
 #' Set logging function and access log format for the API
 #'
-#' Plumber has a build-in logging facility that takes care of logging any
+#' Plumber2 has a build-in logging facility that takes care of logging any
 #' conditions that are caught, as well as access logs. Further it is possible to
 #' log custom messages using the `log()` method on the api object. However, the
 #' actual logging is handled by a customizable function that can be set. You can

R/parse_plumber_file.R

@@ -94,7 +94,7 @@ parse_plumber_file <- function(
   modifier <- function(api) {
     for (mod in modifiers) {
       api <- mod(api)
-      if (!inherits(api, "Plumber")) {
+      if (!is_plumber_api(api)) {
         cli::cli_abort("All modifiers must return the plumber api")
       }
     }

_pkgdown.yml

@@ -59,7 +59,7 @@ reference:
       - async_evaluaters
   - title: "Advanced"
     contents:
-      - Plumber
+      - Plumber2
       - api_logger
       - api_doc_add
       - api_on