Introducing class vertical

.gitignore

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 inst/doc
+docs

DESCRIPTION

@@ -53,5 +53,6 @@ Collate:
     'transform.R'
     'unindent.R'
     'utils.R'
+    'vertical.R'
     'visit.R'
     'ws.R'

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(print,vertical)
 export(create_style_guide)
 export(style_dir)
 export(style_file)

R/serialized_tests.R

@@ -100,7 +100,8 @@ transform_and_check <- function(in_item, out_item,
       write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE)
   }
   transformed <- read_in %>%
-    transformer(...)
+    transformer(...) %>%
+    unclass()
   transformed <- suppressMessages(utf8::transform_lines_enc(out_item,
     function(x) transformed,
     write_back = write_back))

R/vertical.R

@@ -0,0 +1,14 @@
+#' Construct an object of class vertical
+#'
+#' Sole puropse of the class vertical is to have a print method that
+#' aligns the output vertically.
+#' @param x A character vector or an object of class "vertical".
+construct_vertical <- function(x) {
+  stopifnot(inherits(x, what = c("character", "vertical")))
+  structure(x, class = "vertical")
+}
+
+#' @export
+print.vertical <- function(x, ...) {
+  cat(x, sep = "\n")
+}

R/ws.R

@@ -80,7 +80,8 @@ style_text <- function(text,
                        transformers = style(...)) {
 
   transformer <- make_transformer(transformers)
-  transformer(text)
+  styled_text <- transformer(text)
+  construct_vertical(styled_text)
 }
 
 #' Prettify arbitrary R code

README.Rmd

@@ -39,14 +39,12 @@ You can style a simple character vector of code with `style_text()`:
 ```{r echo=FALSE, message=FALSE}
 pkgload::load_all()
 library("magrittr")
-#knitr::opts_chunk$set(comment = NA)
 ```
 
 
 ```{r}
 ugly_code <- "a<-function( x){1+1}           "
-style_text(ugly_code) %>%
-  cat(sep = "\n")
+style_text(ugly_code)
 
 ```
 

README.md

@@ -18,8 +18,7 @@ You can style a simple character vector of code with `style_text()`:
 
 ``` r
 ugly_code <- "a<-function( x){1+1}           "
-style_text(ugly_code) %>%
-  cat(sep = "\n")
+style_text(ugly_code)
 #> a <- function(x) {
 #>   1 + 1
 #> }

tests/testthat/spacing/spacing_comma-in.R

@@ -0,0 +1 @@
+c(    1,       16    , 333 , 33 ,  1)

tests/testthat/spacing/spacing_comma-out.R

@@ -0,0 +1 @@
+c(1, 16, 333, 33, 1)

tests/testthat/spacing/spacing_if-in.R

@@ -0,0 +1 @@
+if(TRUE) x else y

tests/testthat/spacing/spacing_if-out.R

@@ -0,0 +1 @@
+if (TRUE) x else y

tests/testthat/strict/eof-in.R

@@ -0,0 +1 @@
+blabla

tests/testthat/strict/eof-out.R

@@ -0,0 +1 @@
+blabla

tests/testthat/strict/eol-in.R

@@ -0,0 +1,2 @@
+a()   
+b # comment   

tests/testthat/strict/eol-out.R

@@ -0,0 +1,2 @@
+a()
+b # comment

tests/testthat/test-spacing.R

@@ -18,3 +18,16 @@ test_that("comments and strict = FALSE", {
     "spacing", "comments",
     transformer = style_text, stric = FALSE), NA)
 })
+
+test_that("Space placed after 'if' and before '('", {
+  expect_warning(test_collection(
+    "spacing", "spacing_if",
+    transformer = style_text), NA)
+})
+
+test_that("space before comma is removed", {
+  expect_warning(test_collection(
+    "spacing", "spacing_comma",
+    transformer = style_text), NA)
+})
+

tests/testthat/test-strict.R

@@ -15,20 +15,15 @@ test_that("can style example source file with strict = FALSE", {
 })
 
 test_that("removes space at EOL", {
-  expect_equal(style_text("a() "), "a()")
-  expect_equal(style_text("a() # comment "), "a() # comment")
+  expect_warning(test_collection(
+    "strict", "eol",
+    transformer = style_text,
+    strict = FALSE), NA)
 })
 
 test_that("removes blank lines at EOF", {
-  expect_equal(style_text(c("a() ", "", "")), "a()")
-})
-
-
-test_that("Space placed after 'if' and before '('", {
-  expect_equal(style_text(c("if(TRUE) x else y")), "if (TRUE) x else y")
-})
-
-test_that("space before comma is removed", {
-  expect_equal(style_text("c(    1,       16    , 333 , 33 ,  1)"),
-                          "c(1, 16, 333, 33, 1)")
+  expect_warning(test_collection(
+    "strict", "eof",
+    transformer = style_text,
+    strict = FALSE), NA)
 })