-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from wlandau/review
Align with upcoming review policy
- Loading branch information
Showing
30 changed files
with
845 additions
and
151 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,6 +30,8 @@ Authors@R: c( | |
| Depends: | ||
| R (>= 3.6) | ||
| Imports: | ||
| base64enc, | ||
| desc, | ||
| gh, | ||
| igraph, | ||
| jsonlite, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| #' @title Assert package `DESCRIPTION` | ||
| #' @keywords internal | ||
| #' @description Run basic assertions on the `DESCRIPTION` file of a package | ||
| #' on GitHub or GitLab. | ||
| #' @return A character string with an informative message if a problem | ||
| #' was found. Otherwise, `NULL` if there are no issues. | ||
| #' @param name Character string, name of the package listing contribution | ||
| #' to R-multiverse. | ||
| #' @param url Character string, URL of the package on GitHub or GitLab. | ||
| assert_package_description <- function(name, url) { | ||
| text <- try(get_repo_file(url, "DESCRIPTION"), silent = TRUE) | ||
| if (inherits(text, "try-error")) { | ||
| return( | ||
| paste( | ||
| "Could not read a DESCRIPTION file at the top-level of", | ||
| url, | ||
| sprintf("(error: %s)", conditionMessage(attr(text, "condition"))) | ||
| ) | ||
| ) | ||
| } | ||
| if (!is.null(out <- assert_description_local(name, text))) { | ||
| return(out) | ||
| } | ||
| license <- desc::description$new(text = text)$get("License") | ||
| if (any(grepl("LICENSE", license))) { | ||
| path <- "LICENSE" | ||
| } else if (any(grepl("LICENCE", license))) { | ||
| path <- "LICENCE" | ||
| } else { | ||
| return() | ||
| } | ||
| text <- try(get_repo_file(url, path), silent = TRUE) | ||
| if (inherits(text, "try-error")) { | ||
| return( | ||
| paste( | ||
| "Could not download license file", | ||
| path, | ||
| "of package", | ||
| name, | ||
| sprintf("(error: %s)", conditionMessage(attr(text, "condition"))) | ||
| ) | ||
| ) | ||
| } | ||
| if (!is.null(out <- assert_license_local(name, path, text))) { | ||
| return(out) | ||
| } | ||
| } | ||
|
|
||
| assert_description_local <- function(name, text) { | ||
| description <- try( | ||
| desc::description$new(text = text), | ||
| silent = TRUE | ||
| ) | ||
| if (inherits(description, "try-error")) { | ||
| return( | ||
| paste( | ||
| "DESCRPTION file could not be parsed. Original error:", | ||
| conditionMessage(attr(description, "condition")) | ||
| ) | ||
| ) | ||
| } | ||
| assert_parsed_description(name, description) | ||
| } | ||
|
|
||
| assert_parsed_description <- function(name, description) { | ||
| if (!identical(name, as.character(description$get("Package")))) { | ||
| return( | ||
| paste( | ||
| "R-multiverse listing name", | ||
| shQuote(name), | ||
| "is different from the package name in the DESCRIPTION FILE:", | ||
| shQuote(description$get("Package")) | ||
| ) | ||
| ) | ||
| } | ||
| authors <- c( | ||
| description$get("Authors@R"), | ||
| description$get("Author"), | ||
| description$get("Maintainer") | ||
| ) | ||
| if (!length(authors) || all(is.na(authors))) { | ||
| return( | ||
| paste( | ||
| "DESCRIPTION of package", | ||
| name, | ||
| "does not list an author or maintainer.", | ||
| "Each package contributed to R-multiverse must correctly attribute", | ||
| "authorship and ownership to protect the intellectual property", | ||
| "rights of the package owners." | ||
| ) | ||
| ) | ||
| } | ||
| license <- description$get("License") | ||
| if (!(license %in% trusted_licenses)) { | ||
| return( | ||
| paste( | ||
| "Detected license", | ||
| shQuote(license), | ||
| "which requires review by a moderator.", | ||
| "Each package contributed to R-multiverse must have a valid", | ||
| "open-source license to protect the intellectual property", | ||
| "rights of the package owners." | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| assert_license_local <- function(name, path, text) { | ||
| lines <- unlist(strsplit(text, split = "\n")) | ||
| keys <- trimws(gsub(":.*$", "", lines)) | ||
| acceptable <- c("COPYRIGHT HOLDER", "ORGANISATION", "ORGANIZATION", "YEAR") | ||
| if (!all(keys %in% acceptable)) { | ||
| return( | ||
| paste( | ||
| "Package", | ||
| name, | ||
| "license file", | ||
| path, | ||
| "contains text more complicated than the usual", | ||
| "'YEAR', 'COPYRIGHT HOLDER', and 'ORGANIZATION' key-value pairs." | ||
| ) | ||
| ) | ||
| } | ||
| values <- trimws(gsub("^.*:", "", lines)) | ||
| if (!all(nzchar(values))) { | ||
| return( | ||
| paste( | ||
| "Package", | ||
| name, | ||
| "license file", | ||
| path, | ||
| "contains colon-separated key-value pairs with empty values." | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| trusted_licenses <- c( | ||
| "Apache License (== 2.0)", | ||
| "Apache License (>= 2.0)", | ||
| "Artistic-2.0", | ||
| "Artistic License 2.0", | ||
| "BSD_2_clause + file LICENCE", | ||
| "BSD_3_clause + file LICENCE", | ||
| "BSD_2_clause + file LICENSE", | ||
| "BSD_3_clause + file LICENSE", | ||
| "GPL-2", | ||
| "GPL-3", | ||
| "GPL (== 2)", | ||
| "GPL (== 2)", | ||
| "GPL (== 2.0)", | ||
| "GPL (== 3)", | ||
| "GPL (== 3.0)", | ||
| "GPL (>= 2)", | ||
| "GPL (>= 2)", | ||
| "GPL (>= 2.0)", | ||
| "GPL (>= 3)", | ||
| "GPL (>= 3.0)", | ||
| "LGPL-2", | ||
| "LGPL-3", | ||
| "LGPL (== 2)", | ||
| "LGPL (== 2.1)", | ||
| "LGPL (== 3)", | ||
| "LGPL (>= 2)", | ||
| "LGPL (>= 2.1)", | ||
| "LGPL (>= 3)", | ||
| "MIT + file LICENCE", | ||
| "MIT + file LICENSE" | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| #' @title Get repo file | ||
| #' @keywords internal | ||
| #' @description Get the contents of a file from a GitHub or GitLab repo. | ||
| #' @return A character string with the contents of the file. | ||
| #' @param url Character string, URL of a GitHub or GitLab repository. | ||
| #' @param path Character string, path to the file in the repository. | ||
| get_repo_file <- function(url, path) { | ||
| host <- url_parse(url)[["host"]] | ||
| if (host == "github.com") { | ||
| get_repo_file_github(url, path) | ||
| } else if (host == "gitlab.com") { | ||
| get_repo_file_gitlab(url, path) | ||
| } | ||
| } | ||
|
|
||
| get_repo_file_github <- function(url, path) { | ||
| response <- gh::gh( | ||
| "/repos/{owner}/{repo}/contents/{path}", | ||
| owner = basename(dirname(url)), | ||
| repo = basename(url), | ||
| path = path | ||
| ) | ||
| rawToChar(base64enc::base64decode(response$content)) | ||
| } | ||
|
|
||
| get_repo_file_gitlab <- function(url, path) { | ||
| query <- sprintf( | ||
| "https://gitlab.com/api/v4/projects/%s%s%s/repository/files/%s/raw", | ||
| basename(dirname(url)), | ||
| "%2F", | ||
| basename(url), | ||
| path | ||
| ) | ||
| response <- nanonext::ncurl(url = query) | ||
| stopifnot(response$response == 200L) | ||
| response$data | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| #' @title Check GitHub organization membership | ||
| #' @export | ||
| #' @keywords internal | ||
| #' @description Check if a GitHub user is a member of at least one | ||
| #' of the organizations given. | ||
| #' @return `TRUE` if the user is a member of at least one of the given | ||
| #' GitHub organizations, `FALSE` otherwise. | ||
| #' @param user Character string, GitHub user name. | ||
| #' @param organizations Character vector of names of GitHub organizations. | ||
| is_member_organization <- function(user, organizations) { | ||
| response <- gh::gh("/users/{user}/orgs", user = user) | ||
| membership <- unlist(lapply(response, function(entry) entry$login)) | ||
| any(membership %in% organizations) | ||
| } |
Oops, something went wrong.