Merge pull request #574 from r-world-devs/567-prettify

Prettify
r-world-devs · Jan 10, 2025 · 4b177c3 · 4b177c3
2 parents a7ae9ed + 85d9fdd
commit 4b177c3
Show file tree

Hide file tree

Showing 28 changed files with 429 additions and 173 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: GitStats
 Title: Standardized Git Repository Data
-Version: 2.1.2.9008
+Version: 2.2.0
 Authors@R: c(
     person(given = "Maciej", family = "Banas", email = "banasmaciek@gmail.com", role = c("aut", "cre")),
     person(given = "Kamil", family = "Koziej", email = "koziej.k@gmail.com", role = "aut"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,6 @@
-# GitStats (development version)
+# GitStats 2.2.0
+
+This release brings some substantial improvements with making it possible to scan whole organizations and particular repositories for one host at the same time, boosting function to prepare commits statistics and simplifying workflow for getting files.
 
 ## Features:
 
@@ -9,7 +11,7 @@
   - adding `yearly` aggregation to `time_aggregation` parameter,
   - changing basic input from `GitStats` to `commits_data` object which allows to build workflow in one pipeline (`create_gitstats() |> set_*_host() |> get_commits() |> get_commits_stats()`).
 - Merged two functions `get_files_content()` and `get_files_structure()` into one `get_files()` ([#564](https://github.com/r-world-devs/GitStats/issues/564)).
-- Add `.show_error` parameter to the `set_*_host()` functions to control if error should pop up when wrong input is passed ([#547](https://github.com/r-world-devs/GitStats/issues/547)).
+- Add `.error` parameter to the `set_*_host()` functions to control if error should pop up when wrong input is passed ([#547](https://github.com/r-world-devs/GitStats/issues/547)).
 
 ## Fixes:
 

diff --git a/R/EngineGraphQLGitHub.R b/R/EngineGraphQLGitHub.R
@@ -9,9 +9,11 @@ EngineGraphQLGitHub <- R6::R6Class(
     initialize = function(gql_api_url,
                           token,
                           scan_all = FALSE) {
-      super$initialize(gql_api_url = gql_api_url,
-                       token = token,
-                       scan_all = scan_all)
+      super$initialize(
+        gql_api_url = gql_api_url,
+        token = token,
+        scan_all = scan_all
+      )
       self$gql_query <- GQLQueryGitHub$new()
     },
 
@@ -53,7 +55,7 @@ EngineGraphQLGitHub <- R6::R6Class(
             response$errors[[1]]$message
           )
         }
-        orgs_list <- purrr::map(response$data$search$edges, ~stringr::str_match(.$node$url, "[^\\/]*$"))
+        orgs_list <- purrr::map(response$data$search$edges, ~ stringr::str_match(.$node$url, "[^\\/]*$"))
         full_orgs_list <- append(full_orgs_list, orgs_list)
         has_next_page <- response$data$search$pageInfo$hasNextPage
         end_cursor <- response$data$search$pageInfo$endCursor
@@ -98,7 +100,7 @@ EngineGraphQLGitHub <- R6::R6Class(
     prepare_repos_table = function(repos_list, org) {
       if (length(repos_list) > 0) {
         repos_table <- purrr::map(repos_list, function(repo) {
-          repo$default_branch <- if (!is.null(repo$default_branch)) {
+          repo[["default_branch"]] <- if (!is.null(repo$default_branch)) {
             repo$default_branch$name
           } else {
             ""
@@ -107,13 +109,13 @@ EngineGraphQLGitHub <- R6::R6Class(
           if (length(last_activity_at) == 0) {
             last_activity_at <- gts_to_posixt(repo$created_at)
           }
-          repo$languages <- purrr::map_chr(repo$languages$nodes, ~ .$name) %>%
+          repo[["languages"]] <- purrr::map_chr(repo$languages$nodes, ~ .$name) |>
             paste0(collapse = ", ")
-          repo$created_at <- gts_to_posixt(repo$created_at)
-          repo$issues_open <- repo$issues_open$totalCount
-          repo$issues_closed <- repo$issues_closed$totalCount
-          repo$last_activity_at <- last_activity_at
-          repo$organization <- repo$organization$login
+          repo[["created_at"]] <- gts_to_posixt(repo$created_at)
+          repo[["issues_open"]] <- repo$issues_open$totalCount
+          repo[["issues_closed"]] <- repo$issues_closed$totalCount
+          repo[["last_activity_at"]] <- last_activity_at
+          repo[["organization"]] <- repo$organization$login
           repo <- data.frame(repo) %>%
             dplyr::relocate(
               default_branch,
@@ -200,7 +202,7 @@ EngineGraphQLGitHub <- R6::R6Class(
                                   repos,
                                   file_paths = NULL,
                                   host_files_structure = NULL,
-                                  verbose  = TRUE,
+                                  verbose = TRUE,
                                   progress = TRUE) {
       repo_data <- private$get_repos_data(
         org = org,
@@ -265,11 +267,11 @@ EngineGraphQLGitHub <- R6::R6Class(
       def_branches <- repo_data[["def_branches"]]
       files_structure <- purrr::map2(repositories, def_branches, function(repo, def_branch) {
         private$get_files_structure_from_repo(
-          org        = org,
-          repo       = repo,
+          org = org,
+          repo = repo,
           def_branch = def_branch,
-          pattern    = pattern,
-          depth      = depth
+          pattern = pattern,
+          depth = depth
         )
       }, .progress = progress)
       names(files_structure) <- repositories
@@ -293,7 +295,8 @@ EngineGraphQLGitHub <- R6::R6Class(
         user_data[["web_url"]] <- user_data$web_url %||% ""
         user_table <- tibble::as_tibble(user_data) %>%
           dplyr::relocate(c(commits, issues, pull_requests, reviews),
-                          .after = starred_repos)
+            .after = starred_repos
+          )
       } else {
         user_table <- NULL
       }
@@ -431,27 +434,30 @@ EngineGraphQLGitHub <- R6::R6Class(
       commits_by_org_query <- self$gql_query$commits_from_repo(
         commits_cursor = commits_cursor
       )
-      response <- tryCatch({
-        self$gql_response(
-          gql_query = commits_by_org_query,
-          vars = list(
-            "org" = org,
-            "repo" = repo,
-            "since" = date_to_gts(since),
-            "until" = date_to_gts(until)
+      response <- tryCatch(
+        {
+          self$gql_response(
+            gql_query = commits_by_org_query,
+            vars = list(
+              "org" = org,
+              "repo" = repo,
+              "since" = date_to_gts(since),
+              "until" = date_to_gts(until)
+            )
           )
-        )
-      }, error = function(e) {
-        self$gql_response(
-          gql_query = commits_by_org_query,
-          vars = list(
-            "org" = org,
-            "repo" = repo,
-            "since" = date_to_gts(since),
-            "until" = date_to_gts(until)
+        },
+        error = function(e) {
+          self$gql_response(
+            gql_query = commits_by_org_query,
+            vars = list(
+              "org" = org,
+              "repo" = repo,
+              "since" = date_to_gts(since),
+              "until" = date_to_gts(until)
+            )
           )
-        )
-      })
+        }
+      )
       return(response)
     },
 

diff --git a/R/EngineGraphQLGitLab.R b/R/EngineGraphQLGitLab.R
@@ -24,7 +24,7 @@ EngineGraphQLGitLab <- R6::R6Class(
         response <- self$gql_response(
           gql_query = user_or_org_query,
           vars = list(
-            "username"  = owner,
+            "username" = owner,
             "grouppath" = owner
           )
         )
@@ -352,10 +352,10 @@ EngineGraphQLGitLab <- R6::R6Class(
       repositories <- repo_data[["repositories"]]
       files_structure <- purrr::map(repositories, function(repo) {
         private$get_files_structure_from_repo(
-          org     = org,
-          repo    = repo,
+          org = org,
+          repo = repo,
           pattern = pattern,
-          depth   = depth
+          depth = depth
         )
       }, .progress = progress)
       names(files_structure) <- repositories
@@ -367,18 +367,20 @@ EngineGraphQLGitLab <- R6::R6Class(
     prepare_user_table = function(user_response) {
       if (!is.null(user_response$data$user)) {
         user_data <- user_response$data$user
-        user_data$name <- user_data$name %||% ""
-        user_data$starred_repos <- user_data$starred_repos$count
-        user_data$pull_requests <- user_data$pull_requests$count
-        user_data$reviews <- user_data$reviews$count
-        user_data$email <- user_data$email %||% ""
-        user_data$location <- user_data$location %||% ""
-        user_data$web_url <- user_data$web_url %||% ""
-        user_table <- tibble::as_tibble(user_data) %>%
+        user_data[["name"]] <- user_data$name %||% ""
+        user_data[["starred_repos"]] <- user_data$starred_repos$count
+        user_data[["pull_requests"]] <- user_data$pull_requests$count
+        user_data[["reviews"]] <- user_data$reviews$count
+        user_data[["email"]] <- user_data$email %||% ""
+        user_data[["location"]] <- user_data$location %||% ""
+        user_data[["web_url"]] <- user_data$web_url %||% ""
+        user_table <- tibble::as_tibble(user_data) |>
           dplyr::mutate(commits = NA,
-                        issues = NA) %>%
-          dplyr::relocate(c(commits, issues),
-                          .after = starred_repos)
+                        issues = NA) |>
+          dplyr::relocate(
+            c(commits, issues),
+            .after = starred_repos
+          )
       } else {
         user_table <- NULL
       }

diff --git a/R/EngineRestGitHub.R b/R/EngineRestGitHub.R
@@ -195,11 +195,7 @@ EngineRestGitHub <- R6::R6Class(
           error = function(e) {
             NA
           })
-        }, .progress = if (progress) {
-          "[GitHost:GitHub] Pulling contributors..."
-        } else {
-          FALSE
-        })
+        }, .progress = progress)
       }
       return(repos_table)
     }

diff --git a/R/EngineRestGitLab.R b/R/EngineRestGitLab.R
@@ -246,11 +246,7 @@ EngineRestGitLab <- R6::R6Class(
             NA
           })
           return(contributors_vec)
-        }, .progress = if (progress) {
-          "[GitHost:GitLab] Pulling contributors..."
-        } else {
-          FALSE
-        })
+        }, .progress = progress)
       }
       return(repos_table)
     },

diff --git a/R/GitHost.R b/R/GitHost.R
@@ -496,7 +496,7 @@ GitHost <- R6::R6Class(
             }
           }
           return(org)
-        }) |>
+        }, .progress = verbose) |>
         purrr::keep(~ length(.) > 0)
       if (length(orgs) == 0) {
         return(NULL)
@@ -693,7 +693,7 @@ GitHost <- R6::R6Class(
             show_message(
               host        = private$host_name,
               engine      = "graphql",
-              scope       = org,
+              scope       = set_repo_scope(org, private),
               information = "Pulling repositories"
             )
           }
@@ -813,7 +813,7 @@ GitHost <- R6::R6Class(
             show_message(
               host = private$host_name,
               engine = "rest",
-              scope = org,
+              scope = paste0(org, "/", private$orgs_repos[[org]], collapse = ", "),
               information = "Pulling repositories (URLs)"
             )
           }
@@ -1150,7 +1150,7 @@ GitHost <- R6::R6Class(
             show_message(
               host = private$host_name,
               engine = "graphql",
-              scope = org,
+              scope = paste0(org, "/", private$orgs_repos[[org]], collapse = ", "),
               information = glue::glue("Pulling files content: [{paste0(file_path, collapse = ', ')}]")
             )
           }
@@ -1280,7 +1280,7 @@ GitHost <- R6::R6Class(
             show_message(
               host = private$host_name,
               engine = "graphql",
-              scope = org,
+              scope = paste0(org, "/", private$orgs_repos[[org]], collapse = ", "),
               information = user_info
             )
           }
@@ -1383,7 +1383,7 @@ GitHost <- R6::R6Class(
             show_message(
               host = private$host_name,
               engine = "graphql",
-              scope = paste0(org, "/", private$orgs_repos[[org]]),
+              scope = paste0(org, "/", private$orgs_repos[[org]], collapse = ", "),
               information = "Pulling release logs"
             )
           }