Add prefix and new Addins (#40)

* Allow to choose prefix for chunk names

issue #2

* Add new addins

- Name current Rmd file
- Name file chosen in a directory
- Name chunks from a folder
- issue #13

- Allow to use 'prefix' in the Addin for current file in relation to
issue #2

* Update Rproj

* Rebasing

---------

Co-authored-by: statnmap <[email protected]>

DESCRIPTION

@@ -59,4 +59,4 @@ VignetteBuilder:
 Encoding: UTF-8
 Language: en-GB
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2

R/name_chunks.R

@@ -10,6 +10,7 @@
 #'
 #' @template path
 #' @template unname
+#' @template prefix
 #'
 #' @export
 #'
@@ -23,7 +24,7 @@
 #' file.edit(temp_file_path)
 #' }
 #' file.remove(temp_file_path)
-name_chunks <- function(path, unname = FALSE){
+name_chunks <- function(path, unname = FALSE, prefix){
   # read the whole file
   lines <- readLines(path)
 
@@ -50,13 +51,15 @@ name_chunks <- function(path, unname = FALSE){
 
   # act only if needed!
   if(no_unnamed > 0){
-    # create new chunk names
-    filename <- fs::path_ext_remove(path)
-    filename <- fs::path_file(filename)
+    if (missing(prefix)) {
+      # create new chunk names
+      filename <- fs::path_ext_remove(path)
+      prefix <- fs::path_file(filename)
+    }
     # support for bookdown text references by removing underscores
     # https://bookdown.org/yihui/bookdown/markdown-extensions-by-bookdown.html#fnref5
-    filename <- clean_latex_special_characters(filename)
-    new_chunk_names <-  glue::glue("{filename}-{1:no_unnamed}")
+    prefix <- clean_latex_special_characters(prefix)
+    new_chunk_names <-  glue::glue("{prefix}-{1:no_unnamed}")
     new_chunk_names <- as.character(new_chunk_names)
     # and write to which line they correspond
     names(new_chunk_names) <- unique(unnamed$index)

R/name_chunks_addin.R

@@ -1,3 +1,17 @@
-name_chunks_addin <- function(){
+name_chunks_file_addin <- function(){
   name_chunks(path = rstudioapi::selectFile(filter = "R Markdown Files (*.Rmd)"))
 }
+
+name_chunks_addin <- function(){
+  prefix <- rstudioapi::showPrompt(title = "Chunk names prefix",
+                                   message = "Leave empty to use filename (Default)", default = "")
+  if (prefix == "") {
+    name_chunks(path = rstudioapi::getActiveDocumentContext()$path)
+  } else {
+    name_chunks(path = rstudioapi::getActiveDocumentContext()$path, prefix = prefix)
+  }
+}
+
+name_chunks_directory_addin <- function(){
+  namer::name_dir_chunks(rstudioapi::selectDirectory())
+}

inst/rstudio/addins.dcf

@@ -1,4 +1,14 @@
-Name: Label Rmd Chunks
+Name: Label Current Rmd Chunks
 Description: labels unnamed chunk of the active R Markdown document, based on the filename.
 Binding: name_chunks_addin
+Interactive: false
+
+Name: Label Rmd Chunks from File
+Description: labels unnamed chunk of a chosen R Markdown document, based on the filename.
+Binding: name_chunks_file_addin
+Interactive: true
+
+Name: Label Rmd Chunks from Directory
+Description: labels unnamed chunks of all R Markdown document in a Directory.
+Binding: name_chunks_directory_addin
 Interactive: true

man-roxygen/prefix.R

@@ -0,0 +1 @@
+#' @param prefix prefix to use to name chunks. Default to cleaned name of the Rmd.

namer.Rproj

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: 0a211baf-95cc-4ba1-a993-ce5368b7e03f
 
 RestoreWorkspace: No
 SaveWorkspace: No

tests/testthat/test-name_chunks.R

@@ -25,6 +25,18 @@ test_that("renaming works", {
   file.remove(temp_file_path)
 })
 
+test_that("renaming with prefix works", {
+  temp_file_path <- file.path(tmp, "test.Rmd")
+
+  file.copy(system.file("examples", "example1.Rmd", package = "namer"),
+            temp_file_path)
+  name_chunks(temp_file_path, prefix = "my-prefix")
+  lines <- readLines(temp_file_path)
+  chunk_info <- get_chunk_info(lines)
+  expect_true(all(grepl("my-prefix", chunk_info$name[-1])))
+  file.remove(temp_file_path)
+})
+
 test_that("unnaming is advised when needed", {
   temp_file_path <- file.path(tmp, "example4.Rmd")