Return invisibly from write_xml

jimhester · jimhester · commit 8f137d8f104c · 2020-05-05T09:31:17.000-04:00
When we switched to `.Call` it inadvertently now returns `NULL` visibly, instead of invisibly. Fixes #307
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # xml2 (development version)
 
+* `write_xml()` and `write_html()` now return NULL invisibly, as they did prior to version 1.3.0 (#307)
+
 # xml2 1.3.2
 
 * `read_html()` and `read_xml()` now error if passed strings of length greater than one (#121)
diff --git a/R/xml_write.R b/R/xml_write.R
@@ -51,6 +51,8 @@ write_xml.xml_document <- function(x, file, ..., options = "format", encoding =
     }
     .Call(doc_write_file, x$doc, file, encoding, options)
   }
+
+  invisible()
 }
 
 #' @export
@@ -74,6 +76,8 @@ write_xml.xml_nodeset <- function(x, file, ..., options = "format", encoding = "
     }
     .Call(node_write_file, x[[1]]$node, file, encoding, options)
   }
+
+  invisible()
 }
 
 #' @export
@@ -93,6 +97,8 @@ write_xml.xml_node <- function(x, file, ..., options = "format", encoding = "UTF
     }
     .Call(node_write_file, x$node, file, encoding, options)
   }
+
+  invisible()
 }
 
 
diff --git a/tests/testthat/test-write_xml.R b/tests/testthat/test-write_xml.R
@@ -110,3 +110,14 @@ test_that("write_html work with html input", {
   expect_identical(readChar(file, 1000L),
     "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<html><head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n<title>Foo</title>\n</head></html>\n")
 })
+
+test_that("write_xml returns invisibly", {
+  x <- read_xml("<x>foo</x>")
+  tf <- tempfile()
+  on.exit(unlink(tf))
+
+  res <- withVisible(write_xml(x, tf))
+
+  expect_equal(res$value, NULL)
+  expect_equal(res$visible, FALSE)
+})

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,8 @@ write_xml.xml_document <- function(x, file, ..., options = "format", encoding =`
`51`	`51`	`}`
`52`	`52`	`.Call(doc_write_file, x$doc, file, encoding, options)`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+ invisible()`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`#' @export`
`@@ -74,6 +76,8 @@ write_xml.xml_nodeset <- function(x, file, ..., options = "format", encoding = "`
`74`	`76`	`}`
`75`	`77`	`.Call(node_write_file, x[[1]]$node, file, encoding, options)`
`76`	`78`	`}`
	`79`	`+`
	`80`	`+ invisible()`
`77`	`81`	`}`
`78`	`82`
`79`	`83`	`#' @export`
`@@ -93,6 +97,8 @@ write_xml.xml_node <- function(x, file, ..., options = "format", encoding = "UTF`
`93`	`97`	`}`
`94`	`98`	`.Call(node_write_file, x$node, file, encoding, options)`
`95`	`99`	`}`
	`100`	`+`
	`101`	`+ invisible()`
`96`	`102`	`}`
`97`	`103`
`98`	`104`