Task 3 - Feature: Add COMMENT (#81)

* Task 3 - Feature: Add COMMENT

* Adding comment ending dot

* Fixed newlines in COMMENT

Author: jcrodriguez1989

R/add.R

@@ -114,6 +114,11 @@ add_custom <- function(base, cmd) {
   glue("{base} {cmd}")
 }
 
+
+add_comment <- function(comment) {
+  paste0("# ", strsplit(comment, "\n")[[1]], collapse = "\n")
+}
+
 switch_them <- function(vec, a, b) {
   what <- vec[a]
   whbt <- vec[b]

R/dockerfile.R

@@ -155,6 +155,13 @@ custom = function(base, cmd) {
 self$Dockerfile <- c(self$Dockerfile, add_custom(base, cmd))
 },
 #' @description
+#' Add a comment.
+#' @param comment The comment to add.
+#' @return the Dockerfile object, invisibly.
+COMMENT = function(comment) {
+self$Dockerfile <- c(self$Dockerfile, add_comment(comment))
+},
+#' @description
 #' Print the Dockerfile.
 #' @return used for side effect
 print = function() {

README.Rmd

@@ -66,6 +66,12 @@ my_dock <- Dockerfile$new()
 my_dock$MAINTAINER("Colin FAY", "[email protected]")
 ```
 
+Add comments to your Dockerfile
+
+```{r}
+my_dock$COMMENT("Install required R package.")
+```
+
 Wrap your raw R Code inside the `r()` function to turn it into a bash command with `R -e`.
 
 ```{r}
@@ -75,10 +81,12 @@ my_dock$RUN(r(install.packages("attempt", repo = "http://cran.irsn.fr/")))
 Classical Docker stuffs:
 
 ```{r}
+my_dock$COMMENT("Copy Plumber API and main script to container.")
 my_dock$RUN("mkdir /usr/scripts")
 my_dock$RUN("cd /usr/scripts")
 my_dock$COPY("plumberfile.R", "/usr/scripts/plumber.R")
 my_dock$COPY("torun.R", "/usr/scripts/torun.R")
+my_dock$COMMENT("Expose the API port and run the main script when the container starts.")
 my_dock$EXPOSE(8000)
 my_dock$CMD("Rscript /usr/scripts/torun.R ")
 ```

README.md

@@ -60,6 +60,12 @@ my_dock <- Dockerfile$new()
 my_dock$MAINTAINER("Colin FAY", "[email protected]")
 ```
 
+Add comments to your Dockerfile
+
+``` r
+my_dock$COMMENT("Install required R package.")
+```
+
 Wrap your raw R Code inside the `r()` function to turn it into a bash
 command with `R -e`.
 
@@ -70,10 +76,12 @@ my_dock$RUN(r(install.packages("attempt", repo = "http://cran.irsn.fr/")))
 Classical Docker stuffs:
 
 ``` r
+my_dock$COMMENT("Copy Plumber API and main script to container.")
 my_dock$RUN("mkdir /usr/scripts")
 my_dock$RUN("cd /usr/scripts")
 my_dock$COPY("plumberfile.R", "/usr/scripts/plumber.R")
 my_dock$COPY("torun.R", "/usr/scripts/torun.R")
+my_dock$COMMENT("Expose the API port and run the main script when the container starts.")
 my_dock$EXPOSE(8000)
 my_dock$CMD("Rscript /usr/scripts/torun.R ")
 ```

man/Dockerfile.Rd

@@ -45,6 +45,8 @@ test_that("R6 creation works", {
   expect_captured_length(my_dock, 17)
   my_dock$switch_cmd(5, 6)
   expect_captured_length(my_dock, 17)
+  my_dock$COMMENT("Just testing Dockerfile comments.")
+  expect_captured_length(my_dock, 18)
 
   my_dock <- Dockerfile$new(FROM = "plop")
   expect_match(my_dock$Dockerfile, "plop")