From 597ae9186ba553f929763db9b5ffcfffc4e71d8d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Paul=20Li=C3=A9tar?= <pl2113@ic.ac.uk>
Date: Mon, 13 Jan 2025 14:25:14 +0000
Subject: [PATCH] Code review

---
 R/api.R       | 19 ++++++++++---------
 R/porcelain.R |  4 ++--
 man/api.Rd    |  5 +++--
 3 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/R/api.R b/R/api.R
index 914c141..4b89b24 100644
--- a/R/api.R
+++ b/R/api.R
@@ -4,7 +4,8 @@
 ##'
 ##' @param root Orderly root
 ##'
-##' @param repositories Path in which Git repositories are cloned
+##' @param repositories_base_path Path in which Git repositories are
+##'   cloned.
 ##'
 ##' @param validate Logical, indicating if validation should be done
 ##'   on responses.  This should be `FALSE` in production
@@ -21,7 +22,7 @@
 ##'
 ##' @export
 api <- function(
-    root, repositories,
+    root, repositories_base_path,
     validate = NULL, log_level = "info",
     skip_queue_creation = FALSE) {
   logger <- porcelain::porcelain_logger(log_level)
@@ -36,7 +37,7 @@ api <- function(
   api <- porcelain::porcelain$new(validate = validate, logger = logger)
   api$include_package_endpoints(state = list(
     root = root,
-    repositories = repositories,
+    repositories_base_path = repositories_base_path,
     queue = queue))
   api
 }
@@ -53,21 +54,21 @@ root <- function() {
 
 
 ##' @porcelain POST /repository/fetch => json(repository_fetch_response)
-##'   state repositories :: repositories
+##'   state repositories_base_path :: repositories_base_path
 ##'   body data :: json(repository_fetch_request)
-repository_fetch <- function(repositories, data) {
+repository_fetch <- function(repositories_base_path, data) {
   data <- jsonlite::parse_json(data)
-  r <- git_sync(repositories, data$url)
+  r <- git_sync(repositories_base_path, data$url)
 
   empty_object()
 }
 
 
 ##' @porcelain GET /repository/branches => json(repository_branches)
-##'   state repositories :: repositories
+##'   state repositories_base_path :: repositories_base_path
 ##'   query url :: string
-repository_branches <- function(repositories, url) {
-  repo <- repository_path(repositories, url)
+repository_branches <- function(repositories_base_path, url) {
+  repo <- repository_path(repositories_base_path, url)
   branches <- git_remote_list_branches(repo)
   message <- vcapply(branches$commit, function(commit) {
     gert::git_commit_info(repo = repo, ref = commit)$message
diff --git a/R/porcelain.R b/R/porcelain.R
index d91503a..cbf63ae 100644
--- a/R/porcelain.R
+++ b/R/porcelain.R
@@ -15,7 +15,7 @@
         "/repository/fetch",
         repository_fetch,
         porcelain::porcelain_input_body_json("data", "repository_fetch_request"),
-        porcelain::porcelain_state(repositories = state$repositories),
+        porcelain::porcelain_state(repositories_base_path = state$repositories_base_path),
         returning = porcelain::porcelain_returning_json("repository_fetch_response"),
         validate = validate)
     },
@@ -25,7 +25,7 @@
         "/repository/branches",
         repository_branches,
         porcelain::porcelain_input_query(url = "string"),
-        porcelain::porcelain_state(repositories = state$repositories),
+        porcelain::porcelain_state(repositories_base_path = state$repositories_base_path),
         returning = porcelain::porcelain_returning_json("repository_branches"),
         validate = validate)
     },
diff --git a/man/api.Rd b/man/api.Rd
index 3c67504..518c80b 100644
--- a/man/api.Rd
+++ b/man/api.Rd
@@ -6,7 +6,7 @@
 \usage{
 api(
   root,
-  repositories,
+  repositories_base_path,
   validate = NULL,
   log_level = "info",
   skip_queue_creation = FALSE
@@ -15,7 +15,8 @@ api(
 \arguments{
 \item{root}{Orderly root}
 
-\item{repositories}{Path in which Git repositories are cloned}
+\item{repositories_base_path}{Path in which Git repositories are
+cloned.}
 
 \item{validate}{Logical, indicating if validation should be done
 on responses.  This should be \code{FALSE} in production