add fileRename function

NAMESPACE

@@ -8,6 +8,7 @@ export(diffFiles)
 export(diffPreviousRevisions)
 export(diffQced)
 export(dirSummary)
+export(fileRename)
 export(getQcedRevision)
 export(logAccept)
 export(logAssign)

NEWS.md

@@ -2,6 +2,8 @@
 
 ## New features and changes
 
+- `fileRename` added to the package to assist with renaming files in SVN and QClog. (#104)
+
 - `diffFiles` can now display the entire file that is being diffed. (#115)
 
 - Added `repoHistory` function to return history of all commits in the repository. (#116)

R/fileRename.R

@@ -0,0 +1,36 @@
+#' Rename file in SVN and QClog
+#' 
+#' @description 
+#' This function facilitates renaming a file in SVN. When run
+#' the file will be renamed and a targeted commit to SVN will
+#' be made to check in the new name. Additionally, if the file
+#' exists in the QC log, all entries will be renamed and the updated
+#' QC log will also be checked in to SVN.
+#' 
+#' @param .filepath current file path of file to be renamed
+#' @param .new_filepath new file path for file
+#' 
+#' @export
+fileRename <- function(.filepath, .new_filepath) {
+
+  # Check current file path exists
+  if(!file.exists(.filepath)) {
+    stop(paste0(.filepath, " does not exist"))
+  }
+
+  # Check if new file path already exists
+  if(file.exists(.new_filepath)) {
+    stop(paste0(.new_filepath, " already exists, can't overwrite"))
+  }
+
+  system(
+    glue::glue("svn mv {.filepath} {.new_filepath}")
+  )
+
+  qclog <- logRead()
+  qclog[qclog$file == .filepath,][["file"]] <- .new_filepath
+  qclog[qclog$origin == .filepath,][["origin"]] <- .new_filepath
+
+  logWrite(qclog, file = "QClog.csv")
+
+}

_pkgdown.yml

@@ -36,4 +36,5 @@ reference:
     - svnLog
     - svnExport
     - demoRepo
+    - fileRename
     - repoHistory

tests/testthat/test-fileRename.R

@@ -0,0 +1,30 @@
+with_demoRepo({
+
+  fileRename("script/data-assembly.R", .new_filepath = "script/data-assembly2.R")
+  fileRename("script/combine-da.R", .new_filepath = "script/pk/combine-da.R")
+
+  testthat::test_that("fileRename renames file locally and in SVN history", {
+    expect_true(file.exists("script/data-assembly2.R"))
+    expect_true(!file.exists("script/data-assembly.R"))
+
+    expect_true(nrow(svnLog("script/data-assembly2.R")) > 1)
+  }) 
+
+  testthat::test_that("fileRename updates the file name in the QClog", {
+    qclog <- logRead()
+
+    expect_true(nrow(qclog[qclog$file == "script/data-assembly2.R",]) > 0)
+    expect_true(nrow(qclog[qclog$file == "script/data-assembly.R",]) == 0)
+  }) 
+
+  testthat::test_that("fileRename can move files to different directories", {
+
+    expect_true(!all(list.files("script") == "combine-da.R"))
+
+    expect_true(file.exists("script/pk/combine-da.R"))
+    expect_true(!file.exists("script/combine-da.R"))
+  }) 
+
+})
+
+