merges as.promise.mirai() from mirai.promises

DESCRIPTION

@@ -25,7 +25,10 @@ Depends:
 Imports: 
     nanonext (>= 0.10.2.9000),
     parallel
-Suggests:
+Enhances: 
+    promises
+Suggests: 
+    later,
     knitr,
     rmarkdown
 VignetteBuilder: knitr

NAMESPACE

@@ -1,19 +1,16 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(as.promise,mirai)
 S3method(print,mirai)
 S3method(print,miraiCluster)
 S3method(print,miraiError)
 S3method(print,miraiInterrupt)
 S3method(print,miraiLaunchCmd)
 S3method(print,miraiNode)
-S3method(print,resolvedExpr)
-S3method(print,unresolvedExpr)
 S3method(recvData,miraiNode)
 S3method(recvOneData,miraiCluster)
 S3method(sendData,miraiNode)
 S3method(stopCluster,miraiCluster)
-export("%>>%")
-export(.)
 export(.daemon)
 export(call_mirai)
 export(daemon)

NEWS.md

@@ -1,6 +1,8 @@
 # mirai 0.11.0.9000 (development)
 
+* Adds 'mirai' method for 'as.promise()' from the `promises` package (if both packages `promises` and `later` are available). This functionality is merged from the package `mirai.promises` for convenience, and allows use of the promise pipe `%...>%` with a 'mirai'.
 * Eliminates the 'exitlinger' period that still applied to ephemeral daemons. These now synchronise with host and exit as soon as permissible.
+* Removes the deprecated deferred evaluation pipe `%>>%`.
 * Requires nanonext >= 0.10.2.9000.
 
 # mirai 0.11.0

R/mirai-package.R

@@ -93,6 +93,9 @@ NULL
     registerS3method("recvOneData", "miraiCluster", recvOneData.miraiCluster, ns)
   }
 
+  if (requireNamespace("promises", quietly = TRUE) && requireNamespace("later", quietly = TRUE))
+    registerS3method("as.promise", "mirai", as.promise.mirai, getNamespace("promises"))
+
 }
 
 # nocov end
@@ -133,3 +136,6 @@ NULL
 recvData <- NULL
 recvOneData <- NULL
 sendData <- NULL
+
+as.promise <- NULL
+

R/promises.R

@@ -0,0 +1,66 @@
+# Copyright (C) 2023 Hibiki AI Limited <[email protected]>
+#
+# This file is part of mirai.
+#
+# mirai is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# mirai is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# mirai. If not, see <https://www.gnu.org/licenses/>.
+
+# mirai.promises ---------------------------------------------------------------
+
+#' Make 'Mirai' 'Promise'
+#'
+#' Creates a 'promise' from a 'mirai'.
+#'
+#' @param x an object of class 'mirai'.
+#'
+#' @return A 'promise' object.
+#'
+#' @details This function is an S3 method for the generic \code{as.promise} for
+#'     class 'mirai'.
+#'
+#'     Requires the packages \CRANpkg{promises} and \CRANpkg{later}.
+#'
+#'     Allows a 'mirai' to be used with the promise pipe \code{\%...>\%}, which
+#'     schedules a function to run upon resolution of the 'mirai'.
+#'
+#' @examples
+#' if (interactive() &&
+#'   requireNamespace("promises", quietly = TRUE) &&
+#'   requireNamespace("later", quietly = TRUE)) {
+#'
+#' library(promises)
+#'
+#' p <- as.promise(mirai("example"))
+#' print(p)
+#' is.promise(p)
+#'
+#' p2 <- mirai("completed") %...>% identity()
+#' p2$then(cat)
+#' is.promise(p2)
+#'
+#' }
+#'
+#' @method as.promise mirai
+#' @export
+#'
+as.promise.mirai <- function(x)
+  promises::promise(
+    function(resolve, reject) {
+      query <- function()
+        if (unresolved(x))
+          later::later(query, delay = 0.1) else
+            if (is_error_value(value <- .subset2(x, "value")))
+              reject(value) else
+                resolve(value)
+      query()
+    }
+  )