extend comments testing and remove |>

Author: m7pr

R/qenv-get_code.R

@@ -18,8 +18,8 @@
 #'
 #' _Case 1: Usual assignments._
 #' ```r
-#' q1 <- qenv() |>
-#'   within({
+#' q1 <-
+#'   within(qenv(), {
 #'     foo <- function(x) {
 #'       x + 1
 #'     }
@@ -33,8 +33,8 @@
 #'
 #' _Case 2: Some objects are created by a function's side effects._
 #' ```r
-#' q2 <- qenv() |>
-#'   within({
+#' q2 <-
+#'   within(qenv(){
 #'     foo <- function() {
 #'       x <<- x + 1
 #'     }
@@ -52,8 +52,8 @@
 #' In order to include comments in code one must use the `eval_code` function instead.
 #'
 #' ```r
-#' q3 <- qenv() |>
-#'   eval_code("
+#' q3 <-
+#'   eval_code(qenv(), "
 #'     foo <- function() {
 #'       x <<- x + 1
 #'     }

README.md

@@ -56,7 +56,7 @@ Below is the showcase of the example usage
 
 ```r
 library(teal.code)
-my_qenv <- qenv() |> eval_code("x <- 5")
+my_qenv <- eval_code(qenv(), "x <- 5")
 my_qenv
 #> <environment: 0x00000225cc85c7a0> [L]
 #> Parent: <environment: package:teal.code>
@@ -69,7 +69,8 @@ ls(get_env(my_qenv))
 ```
 
 ```r
-qenv_2 <- eval_code(my_qenv, "y <- x * 2") |> eval_code("z <- y * 2")
+qenv_2 <- eval_code(my_qenv, "y <- x * 2") 
+qenv_2 <- eval_code(qenv_2, "z <- y * 2")
 qenv_2
 #> <environment: 0x00000225ca866d68> [L]
 #> Parent: <environment: package:teal.code>

tests/testthat/test-qenv_eval_code.R

@@ -170,3 +170,104 @@ testthat::test_that(
     )
   }
 )
+
+
+
+# comments --------------------------------------------------------------------------------------------------------
+
+
+# comments --------------------------------------------------------------------------------------------------------
+
+testthat::test_that("comments fall into proper calls", {
+  # If comment is on top, it gets moved to the first call.
+  # Any other comment gets moved to the call above.
+  code <- "
+    # initial comment
+    a <- 1
+    b <- 2 # inline comment
+    c <- 3
+    # inbetween comment
+    d <- 4
+    # finishing comment
+  "
+
+  q <- eval_code(qenv(), code)
+  testthat::expect_identical(
+    get_code(q),
+    code
+  )
+})
+
+testthat::test_that("comments get pasted when they fall into calls", {
+  # If comment is on top, it gets moved to the first call.
+  # Any other comment gets moved to the call above.
+  # Comments get pasted if there are two assigned to the same call.
+  code <- "
+    # initial comment
+    a <- 1 # A comment
+    b <- 2 # inline comment
+    c <- 3 # C comment
+    # inbetween comment
+    d <- 4
+    # finishing comment
+  "
+
+  q <- eval_code(qenv(), code)
+  testthat::expect_identical(
+    get_code(q),
+    code
+  )
+})
+
+testthat::test_that("comments alone are pasted to the next/following call element",{
+  code <- c("x <- 5", "# comment", "y <- 6")
+  q <- eval_code(qenv(), code)
+  testthat::expect_identical(
+    unlist(q@code)[2],
+    pasten(code[2:3])
+  )
+  testthat::expect_identical(
+    get_code(q),
+    pasten(code)
+  )
+})
+
+testthat::test_that("comments at the end of src are added to the previous call element",{
+  code <- c("x <- 5", "# comment")
+  q <- eval_code(qenv(), code)
+  testthat::expect_identical(
+    unlist(q@code),
+    pasten(code[1:2])
+  )
+  testthat::expect_identical(
+    get_code(q),
+    pasten(code)
+  )
+})
+
+testthat::test_that("comments from the same line are associated with it's call",{
+  code <- c("x <- 5", " y <- 4 # comment", "z <- 5")
+  q <- eval_code(qenv(), code)
+  testthat::expect_identical(
+    unlist(q@code)[2],
+    paste0(code[2], "\n")
+  )
+  testthat::expect_identical(
+    get_code(q),
+    pasten(code)
+  )
+})
+
+testthat::test_that("comments alone passed to eval_code are skipped",{
+  code <- c("x <- 5", "# comment")
+  q <- eval_code(eval_code(qenv(), code[1]), code[2])
+  testthat::expect_identical(
+    unlist(q@code),
+    pasten(code[1:2])
+  )
+  testthat::expect_identical(
+    get_code(q),
+    pasten(code)
+  )
+})
+

tests/testthat/test-qenv_extract.R

@@ -41,7 +41,7 @@ testthat::test_that("`[.` extracts the code only needed to recreate objects pass
   )
 })
 
-testthat::test_that("`[.` preservers comments in the code", {
+testthat::test_that("`[.` comments are preserved in the code and associated with the following call", {
   q <- qenv()
   code <- c("x<-1 #comment", "a<-1;b<-2")
   q <- eval_code(q, code)

tests/testthat/test-qenv_get_code.R

@@ -1,9 +1,9 @@
 pasten <- function(...) paste(..., collapse = "\n")
 
 testthat::test_that("get_code returns code (character by default) of qenv object", {
-  q <- qenv() |>
-    eval_code(quote(x <- 1)) |>
-    eval_code(quote(y <- x))
+  q <- qenv()
+  q <- eval_code(q, quote(x <- 1))
+  q <- eval_code(q, quote(y <- x))
   testthat::expect_equal(get_code(q), pasten(c("x <- 1", "y <- x")))
 })
 
@@ -456,50 +456,6 @@ testthat::test_that(
   }
 )
 
-
-# comments --------------------------------------------------------------------------------------------------------
-
-testthat::test_that("comments fall into proper calls", {
-  # If comment is on top, it gets moved to the first call.
-  # Any other comment gets moved to the call above.
-  code <- "
-    # initial comment
-    a <- 1
-    b <- 2 # inline comment
-    c <- 3
-    # inbetween comment
-    d <- 4
-    # finishing comment
-  "
-
-  q <- eval_code(qenv(), code)
-  testthat::expect_identical(
-    get_code(q),
-    code
-  )
-})
-
-testthat::test_that("comments get pasted when they fall into calls", {
-  # If comment is on top, it gets moved to the first call.
-  # Any other comment gets moved to the call above.
-  # Comments get pasted if there are two assigned to the same call.
-  code <- "
-    # initial comment
-    a <- 1 # A comment
-    b <- 2 # inline comment
-    c <- 3 # C comment
-    # inbetween comment
-    d <- 4
-    # finishing comment
-  "
-
-  q <- qenv() |> eval_code(code)
-  testthat::expect_identical(
-    get_code(q),
-    code
-  )
-})
-
 # functions -------------------------------------------------------------------------------------------------------
 
 testthat::test_that("ignores occurrence in a function definition", {