Add guard to export when called outside of module

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: modules
 Title: Self Contained Units of Source Code
-Version: 0.12.0
+Version: 0.12.1
 Authors@R: person("Sebastian", "Warnholz", email = "[email protected]", role = c("aut", "cre"))
 Description: Provides modules as an organizational unit for source code. Modules
     enforce to be more rigorous when defining dependencies and have

NEWS

@@ -1,3 +1,7 @@
+Version 0.13.0
+- 'export' no raises a warning when called from outside of a module instead of
+  raising an error. #47
+
 Version 0.12.0
 - Bugfix when exporting object with special characters of length 1, e.g. `!` #45
 

R/export.R

@@ -16,6 +16,9 @@
 #' declared. A regular expression is denoted, as a convention, as character
 #' vector of length one with a leading "^".
 #'
+#' When \code{export} is called outside of a module, it has no effect and
+#' returns early. A warning is raised in this case.
+#'
 #' @examples
 #' module({
 #'   export("foo")
@@ -48,6 +51,7 @@
 #' })
 #' @export
 export <- function(..., where = parent.frame()) {
+  if (exportCalledOutsideOfModule(where)) return(invisible(NULL))
   exportWarnOnNonStandardCalls(match.call())
   objectsToExport <- deparseEllipsis(match.call(), "where")
   currentExports <- exportGetCurrentValue(where)
@@ -60,6 +64,14 @@ export <- function(..., where = parent.frame()) {
   invisible(NULL)
 }
 
+exportCalledOutsideOfModule <- function(where) {
+  calledOutsideOfModule <- !exists(exportNameWithinModule(), where, inherits = FALSE)
+  if (calledOutsideOfModule) {
+    warning("Calling 'export' outside of a module has no effect.")
+  }
+  calledOutsideOfModule
+}
+
 exportWarnOnNonStandardCalls <- function(call) {
   # exporting with do.call is not working properly, so we throw a warning, in
   # case we can detect it. Consider the following examples:
@@ -71,7 +83,7 @@ exportWarnOnNonStandardCalls <- function(call) {
   #   do.call(export, list(fun = sm$fun))
   # })
   # It will not work, although `export(fun = sm$fun)` does work as expected.
-  # This is extremely difficult to dubug and it seems to be better to turn it
+  # This is extremely difficult to debug and it seems to be better to turn it
   # off until someone can fix it.
   if (length(deparse(call[[1]])) > 1) {
     warning(
@@ -110,13 +122,13 @@ exportResolveFinalValue <- function(envir) {
 exportExtractElement <- function(where) {
   function(element, name) {
     name <- if (name == "") element else name
-    # we need to make sure that special names, 
-    # - infix operators: %*%, 
-    # - S3 methods for binary operators: ==.foo 
-    # - names with whitespaces 
+    # we need to make sure that special names,
+    # - infix operators: %*%,
+    # - S3 methods for binary operators: ==.foo
+    # - names with whitespace
     # - single character punctuation: !
     # are parsed correctly
-    regexp <- "^%.*%$|^[[:alnum:][:space:]]+$|^[[:punct:]]{2,}.*$|^[[:punct:]]$" 
+    regexp <- "^%.*%$|^[[:alnum:][:space:]]+$|^[[:punct:]]{2,}.*$|^[[:punct:]]$"
     element <- if (grepl(regexp, element)) paste0("`", element, "`") else element # Exclude Linting
     object <- tryCatch(
       eval(parse(text = element), where, baseenv()),

tests/testthat/test-export.R

@@ -1,7 +1,14 @@
+testthat::test_that("export can be called savely outside of module #47", {
+  testthat::expect_warning(
+    modules::export("something"),
+    "Calling 'export' outside of a module has no effect."
+  )
+})
+
 test_that("Exports of special names #43", {
   m <- module({
     "==.foo" <- function(lhs, rhs) base::`==`(lhs, rhs) # Exclude Linting
-    "!.foo" <- function(lhs, rhs) base::`!=`(lhs, rhs)  # Exclude Linting
+    "!.foo" <- function(lhs, rhs) base::`!=`(lhs, rhs) # Exclude Linting
   })
   testthat::expect_true(m$`==.foo`(1, 1))
   testthat::expect_true(m$`!.foo`(1, 2))