-
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 #40 from wlandau/interpret
Add intepret_issue()
- Loading branch information
Showing
16 changed files
with
487 additions
and
28 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
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,151 @@ | ||
| #' @title Interpret a set of package issues | ||
| #' @export | ||
| #' @family issues | ||
| #' @description Summarize the issues of a package in human-readable text. | ||
| #' @return A character string summarizing the issues of a package in prose. | ||
| #' @param path Character string, file path to a JSON issue file | ||
| #' of a package. | ||
| interpret_issue <- function(path) { | ||
| package <- basename(path) | ||
| if (!file.exists(path)) { | ||
| return(paste("Package", package, "has no recorded issues.")) | ||
| } | ||
| issue <- jsonlite::read_json(path, simplifyVector = TRUE) | ||
| paste0( | ||
| interpret_title(issue, package), | ||
| interpret_advisories(issue), | ||
| interpret_checks(issue), | ||
| interpret_dependencies(issue, package), | ||
| interpret_licenses(issue, package), | ||
| interpret_remotes(issue), | ||
| interpret_versions(issue) | ||
| ) | ||
| } | ||
|
|
||
| interpret_title <- function(issue, package) { | ||
| title <- paste0( | ||
| "R-multiverse found issues with package ", | ||
| package | ||
| ) | ||
| if (is.character(issue$version)) { | ||
| title <- paste(title, "version", issue$version) | ||
| } | ||
| if (is.character(issue$remote_hash)) { | ||
| title <- paste(title, "remote hash", issue$remote_hash) | ||
| } | ||
| paste0(title, " on ", issue$date, ".") | ||
| } | ||
|
|
||
| interpret_advisories <- function(issue) { | ||
| advisories <- issue$descriptions$advisories | ||
| if (is.null(advisories)) { | ||
| return(character(0L)) | ||
| } | ||
| paste0( | ||
| "\n\nFound the following advisories in the ", | ||
| "R Consortium Advisory Database:\n\n", | ||
| as.character(yaml::as.yaml(advisories)) | ||
| ) | ||
| } | ||
|
|
||
| interpret_checks <- function(issue) { | ||
| checks <- issue$checks | ||
| if (is.null(checks)) { | ||
| return(character(0L)) | ||
| } | ||
| paste0( | ||
| "\n\nNot all checks succeeded on R-universe. ", | ||
| "The following output shows the check status on each platform, ", | ||
| "the overall build status, and the ", | ||
| "build URL. Visit the build URL for specific details ", | ||
| "on the check failures.\n\n", | ||
| as.character(yaml::as.yaml(checks)) | ||
| ) | ||
| } | ||
|
|
||
| interpret_dependencies <- function(issue, package) { | ||
| dependencies <- issue$dependencies | ||
| if (is.null(dependencies)) { | ||
| return(character(0L)) | ||
| } | ||
| direct <- names(dependencies)[lengths(dependencies) < 1L] | ||
| indirect <- setdiff(names(dependencies), direct) | ||
| text <- paste0( | ||
| "\n\nOne or more dependencies have issues. Packages ", | ||
| paste(names(dependencies), collapse = ", "), | ||
| " are causing problems upstream. " | ||
| ) | ||
| if (length(direct)) { | ||
| text <- paste0( | ||
| text, | ||
| ifelse(length(direct) == 1L, "Dependency ", "Dependencies "), | ||
| paste(direct, collapse = ", "), | ||
| ifelse(length(direct) == 1L, " is ", " are "), | ||
| "explicitly mentioned in 'Depends:', 'Imports:', or 'LinkingTo:' ", | ||
| "in the DESCRIPTION of ", | ||
| package, | ||
| ". " | ||
| ) | ||
| } | ||
| if (length(indirect)) { | ||
| text <- paste0( | ||
| text, | ||
| ifelse(length(indirect) == 1L, "Package ", "Packages "), | ||
| paste(indirect, collapse = ", "), | ||
| ifelse(length(indirect) == 1L, " is ", " are "), | ||
| "not part of 'Depends:', 'Imports:', or 'LinkingTo:' ", | ||
| "in the DESCRIPTION of ", | ||
| package, | ||
| ", but ", | ||
| ifelse(length(indirect) == 1L, "it is", "they are"), | ||
| " upstream of one or more direct dependencies:\n\n", | ||
| as.character(yaml::as.yaml(dependencies[indirect])) | ||
| ) | ||
| } | ||
| text | ||
| } | ||
|
|
||
| interpret_licenses <- function(issue, package) { | ||
| license <- issue$descriptions$license | ||
| if (is.null(license)) { | ||
| return(character(0L)) | ||
| } | ||
| paste( | ||
| "\n\nPackage", | ||
| package, | ||
| "declares license", | ||
| shQuote(license), | ||
| "in its DESCRIPTION file. R-multiverse cannot verify that", | ||
| "this license is a valid free and open-source license", | ||
| "(c.f. https://en.wikipedia.org/wiki/Free_and_open-source_software).", | ||
| "Each package contributed to R-multiverse must have a valid", | ||
| "open-source license to protect the intellectual property", | ||
| "rights of the package owners." | ||
| ) | ||
| } | ||
|
|
||
| interpret_remotes <- function(issue) { | ||
| remotes <- issue$descriptions$remotes | ||
| if (is.null(remotes)) { | ||
| return(character(0L)) | ||
| } | ||
| paste0( | ||
| "\n\nPackage releases should not use the 'Remotes:' field. Found:", | ||
| as.character(yaml::as.yaml(remotes)) | ||
| ) | ||
| } | ||
|
|
||
| interpret_versions <- function(issue) { | ||
| versions <- issue$versions | ||
| if (is.null(versions)) { | ||
| return(character(0L)) | ||
| } | ||
| paste0( | ||
| "\n\nThe version number of the current release ", | ||
| "should be highest version of all the releases so far. ", | ||
| "Here is the current version of the package, ", | ||
| "the highest version number ever recorded by R-multiverse, ", | ||
| "and the latest remote hash of each:\n\n", | ||
| as.character(yaml::as.yaml(versions)) | ||
| ) | ||
| } |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Oops, something went wrong.