Merge pull request #3 from Appsilon/code-refinement

Code refinement

.gitignore

@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 .DS_Store
+.Renviron

app/logic/api_utils.R

@@ -1,16 +1,16 @@
 box::use(
+  dplyr[filter],
+  glue[glue],
   httr2[
-    request,
     req_auth_bearer_token,
     req_dry_run,
     req_perform,
-    resp_body_string,
-    req_user_agent
+    req_user_agent,
+    request,
+    resp_body_string
   ],
-  magrittr[`%>%`],
   jsonlite[fromJSON],
-  dplyr[filter],
-  glue[glue]
+  magrittr[`%>%`],
 )
 
 #' Simple function to get the access token from environment
@@ -30,7 +30,7 @@ get_access_token <- function() {
 #' Simple function to make an API url
 #' @param host Character. Default CONNECT_SERVER set as an envvar
 #' @param endpoint Character. Default is "content"
-#' @param versioned Logical. Whether to use versioned API. Default is FALSE
+#' @param version Logical. Whether to use versioned API. Default is "v1"
 #' @return url for the API
 get_api_url <- function(
   host = Sys.getenv("CONNECT_SERVER"),
@@ -44,7 +44,7 @@ get_api_url <- function(
 #'
 #' @param app_mode_filter Character. The filter for app_mode in the API
 #' response. Default is "shiny".
-#' @param url Character. The URL for API endpoint
+#' @param endpoint Character. Default is "content"
 #' @param dry_run Logical. Whether to dry run the API for debugging.
 #' Default is FALSE
 #' @export
@@ -77,7 +77,7 @@ get_app_list <- function(
 #' Function to get a list of all jobs for a specific app
 #'
 #' @param guid Character. The guid for the app in question
-#' @param url Character. The URL for API endpoint
+#' @param endpoint Character. Default is "content"
 #' @param dry_run Logical. Whether to dry run the API for debugging.
 #' Default is FALSE
 #' @export
@@ -112,7 +112,7 @@ get_job_list <- function(
 #'
 #' @param guid Character. The guid for the app in question
 #' @param job_key Character. The key for the job in question
-#' @param url Character. The URL for API endpoint
+#' @param endpoint Character. Default is "content"
 #' @param tail Logical. Whether to show the tail only for the logs
 #' @param dry_run Logical. Whether to dry run the API for debugging.
 #' Default is FALSE
@@ -152,7 +152,7 @@ get_job_logs <- function(
 #'
 #' @param guid Character. The guid for the app in question
 #' @param job_key Character. The key for the job in quesrtion
-#' @param url Character. The URL for API endpoint
+#' @param endpoint Character. Default is "content"
 #' @param dry_run Logical. Whether to dry run the API for debugging.
 #' Default is FALSE
 #' @export

app/logic/app_table_utils.R

@@ -1,16 +1,15 @@
 box::use(
   shiny[
+    a,
     div,
-    span,
     icon,
-    a,
+    span,
     strong
   ],
-  glue[glue]
 )
 
 box::use(
-  app/logic/general_utils[format_timestamp]
+  app/logic/general_utils[format_timestamp],
 )
 
 #' Function to process each row for the app table

app/logic/job_list_utils.R

@@ -1,16 +1,12 @@
 box::use(
   shiny[
     div,
-    span,
-    icon,
-    a,
     strong
   ],
-  glue[glue]
 )
 
 box::use(
-  app/logic/general_utils[format_timestamp]
+  app/logic/general_utils[format_timestamp],
 )
 
 

app/logic/logs_utils.R

@@ -1,13 +1,13 @@
 box::use(
   glue[glue],
   shiny[
-    icon,
-    div
-  ]
+    div,
+    icon
+  ],
 )
 
 box::use(
-  app/logic/general_utils[check_text_error, format_timestamp]
+  app/logic/general_utils[check_text_error, format_timestamp],
 )
 
 #' Function to process each row for the log table

app/main.R

@@ -1,32 +1,34 @@
+# nolint start: box_func_import_count_linter
 box::use(
+  dplyr[select],
+  magrittr[`%>%`],
   shiny[
-    NS,
-    moduleServer,
     div,
+    fluidPage,
+    img,
+    isTruthy,
+    moduleServer,
+    NS,
+    observeEvent,
+    p,
     reactive,
     reactiveValues,
-    observeEvent,
-    isTruthy,
-    tags,
-    tagList,
-    renderUI,
-    uiOutput,
-    img,
     removeUI,
-    p,
-    fluidPage
+    renderUI,
+    tagList,
+    tags,
+    uiOutput
   ],
-  magrittr[`%>%`],
-  dplyr[select],
-  shinycssloaders[withSpinner]
+  shinycssloaders[withSpinner],
 )
+# nolint end
 
 box::use(
+  app/logic/api_utils[get_app_list],
   app/view/mod_app_table,
+  app/view/mod_header,
   app/view/mod_job_list,
   app/view/mod_logs,
-  app/view/mod_header,
-  app/logic/api_utils[get_app_list]
 )
 
 #' @export

app/view/mod_app_table.R

@@ -1,28 +1,26 @@
 box::use(
-  shiny[
-    NS,
-    div,
-    moduleServer,
-    reactive
+  dplyr[
+    mutate,
+    select
   ],
+  magrittr[`%>%`],
   reactable[
+    colDef,
+    getReactableState,
     reactable,
-    renderReactable,
     reactableOutput,
-    getReactableState,
-    colDef
+    renderReactable
   ],
-  dplyr[
-    select,
-    mutate
+  shiny[
+    moduleServer,
+    NS,
+    reactive
   ],
-  magrittr[`%>%`],
-  glue[glue],
-  shinycssloaders[withSpinner]
+  shinycssloaders[withSpinner],
 )
 
 box::use(
-  app/logic/app_table_utils[process_app_data]
+  app/logic/app_table_utils[process_app_data],
 )
 
 #' @export

app/view/mod_header.R

@@ -1,14 +1,12 @@
 box::use(
   shiny[
-    NS,
-    moduleServer,
+    actionLink,
     div,
-    img,
     h2,
-    icon,
-    actionButton,
-    actionLink
-  ]
+    img,
+    moduleServer,
+    NS
+  ],
 )
 
 #' @export

app/view/mod_job_list.R

@@ -1,29 +1,28 @@
 box::use(
-  shiny[
-    moduleServer,
-    NS,
-    div,
-    reactive,
-    req
+  dplyr[
+    mutate,
+    select
   ],
+  magrittr[`%>%`],
   reactable[
+    colDef,
+    getReactableState,
     reactable,
-    renderReactable,
     reactableOutput,
-    getReactableState,
-    colDef
+    renderReactable
   ],
-  dplyr[
-    select,
-    mutate
+  shiny[
+    moduleServer,
+    NS,
+    reactive,
+    req
   ],
-  magrittr[`%>%`],
-  shinycssloaders[withSpinner]
+  shinycssloaders[withSpinner],
 )
 
 box::use(
   app/logic/api_utils[get_job_list],
-  app/logic/job_list_utils[process_job_data]
+  app/logic/job_list_utils[process_job_data],
 )
 
 #' @export

app/view/mod_logs.R

@@ -1,32 +1,34 @@
+# nolint start: box_func_import_count_linter
 box::use(
+  dplyr[mutate],
+  glue[glue],
+  magrittr[`%>%`],
+  reactable[
+    colDef,
+    reactable,
+    reactableOutput,
+    renderReactable
+  ],
+  shinycssloaders[withSpinner],
   shiny[
-    moduleServer,
-    NS,
     div,
-    reactive,
-    req,
     downloadButton,
     downloadHandler,
     icon,
+    moduleServer,
+    NS,
+    observeEvent,
+    reactive,
     renderUI,
-    uiOutput,
-    observeEvent
-  ],
-  reactable[
-    reactable,
-    renderReactable,
-    reactableOutput,
-    colDef
+    req,
+    uiOutput
   ],
-  dplyr[mutate],
-  magrittr[`%>%`],
-  glue[glue],
-  shinycssloaders[withSpinner]
 )
+# nolint end
 
 box::use(
-  app/logic/api_utils[get_job_logs, download_job_logs],
-  app/logic/logs_utils[process_log_data]
+  app/logic/api_utils[download_job_logs, get_job_logs],
+  app/logic/logs_utils[process_log_data],
 )
 
 #' @export

dependencies.R

@@ -6,4 +6,3 @@ library(reactable)
 library(rhino)
 library(rsconnect)
 library(shinycssloaders)
-library(usethis)