Change qenv as environment "type" -- adds names(qenv/qenv.error), get() and $ S3 methods

DESCRIPTION

@@ -63,6 +63,7 @@ Collate:
     'qenv-get_var.R'
     'qenv-get_warnings.R'
     'qenv-join.R'
+    'qenv-names.R'
     'qenv-show.R'
     'qenv-within.R'
     'teal.code-package.R'

NAMESPACE

@@ -1,6 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method("[[",qenv.error)
+S3method(names,qenv)
+S3method(names,qenv.error)
 S3method(within,qenv)
 S3method(within,qenv.error)
 export(concat)

NEWS.md

@@ -4,6 +4,7 @@
 
 * `get_code()` was extended with `names` parameter and allows the code extraction to be limited to objects stored in
 `qenv` but limited to `names`.
+* Added `names()` function for `qenv` objects, which dynamically determines the visible objects in the environment.
 
 # teal.code 0.5.0
 

R/qenv-eval_code.R

@@ -80,7 +80,6 @@ setMethod("eval_code", signature = c("qenv", "character"), function(object, code
     }
   }
 
-
   object@warnings <- c(object@warnings, current_warnings)
   object@messages <- c(object@messages, current_messages)
 

R/qenv-names.R

@@ -0,0 +1,33 @@
+#' The Names of a `qenv` or `qenv_error` Object
+#'
+#' Functions to get the names of a `qenv` or `qenv_error` object.
+#' The names are extrapolated from the objects in the `qenv` environment and
+#' are not stored statically, unlike the normal behavior of `names()` function.
+#'
+#' Objects named with a `.` (dot) prefix will be ignored and not returned.
+#'
+#' @param x (`qenv` or `qenv_error`) object.
+#' @return A character vector of names.
+#'
+#' @seealso [base::names()]
+#'
+#' @examples
+#' q1 <- within(qenv(), iris <- iris)
+#' names(q1)
+#'
+#' q2 <- within(q1, {
+#'   mtcars <- mtcars
+#'   CO2 <- CO2
+#' })
+#' names(q2)
+#'
+#' @export
+names.qenv <- function(x) {
+  ls(get_env(x))
+}
+
+#' @rdname names.qenv
+#' @export
+names.qenv.error <- function(x) {
+  NULL
+}

_pkgdown.yml

@@ -34,6 +34,7 @@ reference:
       - get_var
       - get_warnings
       - join
+      - names.qenv
       - new_qenv
       - qenv
       - show,qenv-method

inst/WORDLIST

@@ -1,7 +1,7 @@
 Forkers
-Hoffmann
-Reproducibility
 funder
+Hoffmann
 qenv
 repo
+Reproducibility
 reproducibility

tests/testthat/test-qenv_get_code.R

@@ -120,7 +120,7 @@ testthat::test_that("extracts the code without downstream usage", {
   )
 })
 
-testthat::test_that("works for datanames of length > 1", {
+testthat::test_that("works for names of length > 1", {
   code <- c(
     "a <- 1",
     "b <- 2"