Bump version to 202

.github/workflows/R-CMD-check.yaml

@@ -18,6 +18,8 @@ jobs:
       fail-fast: false
       matrix:
         config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
           - {os: ubuntu-latest,   r: 'release'}
 
     env:

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: GitStats
 Title: Get Statistics from GitHub and GitLab
-Version: 2.0.1.90032
+Version: 2.0.2
 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"),

NEWS.md

@@ -1,12 +1,13 @@
-# GitStats (development version)
+# GitStats 2.0.2
 
 - Added new `get_repos_urls()` function to fetch repository URLs (either web or API - choose with `type` parameter). It may return also only these repository URLs that consist of a given file or files (with passing argument to `with_files` parameter) or a text in code blobs (`with_code` parameter). This is a minimalist version of `get_repos()`, which takes out all the process of parsing (search response into repositories one) and adding statistics on repositories. This makes it poorer with content but faster. ([#425](https://github.com/r-world-devs/GitStats/issues/425)).
 - Added `with_files` parameter to `get_repos()` function, which makes it possible to search for repositories with a given file or files and return full output for repositories.
 - It is also possible now to pass multiple code phrases to `with_code` parameter (as a character vector) in `get_repos()` and `get_repos_urls()` ([282](https://github.com/r-world-devs/GitStats/issues/282)).
 - Added `in_files` parameter to `get_repos()` which works with `with_code` parameter. When both are defined, `GitStats` searches code blobs only in given files.
 - Removed `dplyr::glimpse()` from `get_*()` functions, so there is printing to console only if `get_*()` function is not assigned to the object ([#426](https://github.com/r-world-devs/GitStats/issues/426)).
 - Output table of `get_R_package_usage()` consists now also of repository full name ([#438](https://github.com/r-world-devs/GitStats/issues/438)).
-- Improved `get_R_package_usage()` with optimizing search of package names in `DESCRIPTION` and `NAMESPACE` files by removing filtering method and replacing it with `filename:` filter directly in search endpoint query ([#428](https://github.com/r-world-devs/GitStats/issues/438)).
+- Improved `get_R_package_usage()` with optimizing search of package names in `DESCRIPTION` and `NAMESPACE` files by removing filtering method and replacing it with `filename:` filter directly in search endpoint query ([#428](https://github.com/r-world-devs/GitStats/issues/428)).
+- Fixed `get_files()` when scanning scope is set to `repositories`. Earlier, it pulled given files from whole organizations, even if scanning scope was set to `repos` with `set_*_host()`. Now it shows only files for the given repositories ([#439](https://github.com/r-world-devs/GitStats/issues/439)).
 
 # GitStats 2.0.1
 

R/gitstats_functions.R

@@ -87,9 +87,11 @@ set_gitlab_host <- function(gitstats_object,
   return(invisible(gitstats_object))
 }
 
-#' @title Get information on repositories
+#' @title Get data on repositories
 #' @name get_repos
-#' @description  List all repositories for an organization or by a keyword.
+#' @description  Pulls data on all repositories for an organization or those
+#'   with a given text in code blobs (`with_code` parameter) or a file
+#'   (`with_file` parameter) and parse it into table format.
 #' @param gitstats_object A GitStats object.
 #' @param add_contributors A logical parameter to decide whether to add
 #'   information about repositories' contributors to the repositories output
@@ -147,9 +149,11 @@ get_repos <- function(gitstats_object,
   )
 }
 
-#' @title List repository URLS
+#' @title Get repository URLS
 #' @name get_repos_urls
-#' @description A wrapper over search API endpoints to list repositories URLS.
+#' @description Pulls a vector of repositories URLS (web or API): either all for
+#'   an organization or those with a given text in code blobs (`with_code`
+#'   parameter) or a file (`with_file` parameter).
 #' @param gitstats_object A GitStats object.
 #' @param type A character, choose if `api` or `web` (`html`) URLs should be
 #'   returned.
@@ -197,7 +201,7 @@ get_repos_urls <- function(gitstats_object,
   )
 }
 
-#' @title Get information on commits
+#' @title Get data on commits
 #' @name get_commits
 #' @description List all commits from all repositories for an organization or a
 #'   vector of repositories.
@@ -239,7 +243,7 @@ get_commits <- function(gitstats_object,
   )
 }
 
-#' @title Get statistics on commits
+#' @title Get commits statistics
 #' @name get_commits_stats
 #' @description Prepare statistics from the pulled commits data.
 #' @details To make function work, you need first to get commits data with
@@ -268,7 +272,6 @@ get_commits_stats = function(gitstats_object,
 
 #' @title Get users data
 #' @name get_users
-#' @description Pull users data from Git Host.
 #' @param gitstats_object A GitStats object.
 #' @param logins A character vector of logins.
 #' @param cache A logical, if set to `TRUE` GitStats will retrieve the last
@@ -301,16 +304,17 @@ get_users <- function(gitstats_object,
   )
 }
 
-#' @title Get files content
+#' @title Get data on files
 #' @name get_files
-#' @description Pull files content from Git Hosts.
+#' @description Pull text files content for a given scope (orgs, repos or whole
+#'   git hosts).
 #' @param gitstats_object A GitStats object.
 #' @param file_path A standardized path to file(s) in repositories. May be a
 #'   character vector if multiple files are to be pulled.
 #' @param cache A logical, if set to `TRUE` GitStats will retrieve the last
 #'   result from its storage.
-#' @param verbose A logical, `TRUE` by default. If `FALSE` messages and
-#'   printing output is switched off.
+#' @param verbose A logical, `TRUE` by default. If `FALSE` messages and printing
+#'   output is switched off.
 #' @examples
 #' \dontrun{
 #'  my_gitstats <- create_gitstats() %>%
@@ -337,7 +341,7 @@ get_files <- function(gitstats_object,
   )
 }
 
-#' @title Get information on package usage across repositories
+#' @title Get data on package usage across repositories
 #' @name get_R_package_usage
 #' @description Wrapper over searching repositories by code blobs related to
 #'   loading package (`library(package)` and `require(package)` in all files) or

renv.lock

@@ -1,6 +1,6 @@
 {
   "R": {
-    "Version": "4.2.2",
+    "Version": "4.3.3",
     "Repositories": [
       {
         "Name": "CRAN",