Merge pull request #40 from ropensci-review-tools/stars

stargazer data

Author: mpadge

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: repometrics
 Title: Metrics for Your Code Repository
-Version: 0.1.1.115
+Version: 0.1.1.117
 Authors@R: 
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

R/cm-data-gh-forks.R

@@ -29,7 +29,7 @@ gh_forks_qry <- function (org = "ropensci-review-tools",
     return (q)
 }
 
-cm_data_repo_forks <- function (path, n_per_page = 100L) {
+cm_data_repo_forks_internal <- function (path, n_per_page = 100L) {
 
     is_test_env <- Sys.getenv ("REPOMETRICS_TESTS") == "true"
     n_per_page <- n_per_page_in_tests (n_per_page)
@@ -65,3 +65,4 @@ cm_data_repo_forks <- function (path, n_per_page = 100L) {
         created = as.Date (created)
     )
 }
+cm_data_repo_forks <- memoise::memoise (cm_data_repo_forks_internal)

R/cm-data-gh-stargazers.R

@@ -0,0 +1,69 @@
+gh_stargazers_qry <- function (org = "ropensci-review-tools",
+                               repo = "repometrics",
+                               n_per_page = 100L,
+                               end_cursor = NULL) {
+
+    checkmate::assert_integerish (n_per_page)
+
+    after_txt <- ""
+    if (!is.null (end_cursor)) {
+        after_txt <- paste0 (", after:\"", end_cursor, "\"")
+    }
+
+    q <- paste0 ("{
+        repository(owner:\"", org, "\", name:\"", repo, "\") {
+            stargazers (first: ", n_per_page, after_txt, ") {
+                pageInfo {
+                    hasNextPage
+                    endCursor
+                }
+                edges {
+                    starredAt
+                    node {
+                        login
+                    }
+                }
+            }
+        }
+    }")
+
+    return (q)
+}
+
+cm_data_repo_stargazers_internal <- function (path, n_per_page = 100L) {
+
+    is_test_env <- Sys.getenv ("REPOMETRICS_TESTS") == "true"
+    n_per_page <- n_per_page_in_tests (n_per_page)
+
+    or <- org_repo_from_path (path)
+    end_cursor <- stargazers <- NULL
+    has_next_page <- TRUE
+
+    while (has_next_page) {
+
+        q <- gh_stargazers_qry (
+            org = or [1],
+            repo = or [2],
+            end_cursor = end_cursor,
+            n_per_page = n_per_page
+        )
+        dat <- gh::gh_gql (query = q)
+
+        stargazers <- c (stargazers, dat$data$repository$stargazers$edges)
+
+        has_next_page <- dat$data$repository$stargazers$pageInfo$hasNextPage
+        end_cursor <- dat$data$repository$stargazers$pageInfo$endCursor
+        if (is_test_env) {
+            has_next_page <- FALSE
+        }
+    }
+
+    login <- vapply (stargazers, function (i) i$node$login, character (1L))
+    starred_at <- vapply (stargazers, function (i) i$starredAt, character (1L))
+
+    data.frame (
+        login = login,
+        starred_at = as.Date (starred_at)
+    )
+}
+cm_data_repo_stargazers <- memoise::memoise (cm_data_repo_stargazers_internal)

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/repometrics",
   "issueTracker": "https://github.com/ropensci-review-tools/repometrics/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.1.1.115",
+  "version": "0.1.1.117",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

tests/testthat/gh_api_stars/api.github.com/graphql-3465bf-POST.json

@@ -0,0 +1,26 @@
+{
+    "data": {
+        "repository": {
+            "stargazers": {
+                "pageInfo": {
+                    "hasNextPage": true,
+                    "endCursor": "Y3Vyc29yOnYyOpK5MjAxNi0wMi0wMlQwOToxODoxOSswMTowMM4DFLwY"
+                },
+                "edges": [
+                    {
+                        "starredAt": "2016-02-01T10:52:19Z",
+                        "node": {
+                            "login": "Pakillo"
+                        }
+                    },
+                    {
+                        "starredAt": "2016-02-02T08:18:19Z",
+                        "node": {
+                            "login": "uribo"
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}

tests/testthat/helper-cm-data.R

@@ -17,6 +17,9 @@ mock_cm_data <- function () {
     forks <- httptest2::with_mock_dir ("gh_api_forks", {
         cm_data_repo_forks (path)
     })
+    stargazers <- httptest2::with_mock_dir ("gh_api_stars", {
+        cm_data_repo_stargazers (path)
+    })
     issues <- httptest2::with_mock_dir ("gh_api_issues", {
         cm_data_issues_from_gh_api (path)
     })

tests/testthat/test-cm-data-github.R

@@ -248,3 +248,39 @@ test_that ("cm data gh repo", {
         expect_type (repo [[n]], type)
     }
 })
+
+test_that ("cm data gh forks", {
+
+    Sys.setenv ("REPOMETRICS_TESTS" = "true")
+    mock_cm_data ()
+    path <- generate_test_pkg ()
+    forks <- cm_data_repo_forks (path)
+    fs::dir_delete (path)
+
+    expect_s3_class (forks, "data.frame")
+    expect_equal (nrow (forks), 2L)
+    expect_equal (ncol (forks), 2L)
+    nms <- c ("org_repo", "created")
+    expect_equal (names (forks), nms)
+
+    expect_type (forks$org_repo, "character")
+    expect_type (forks$created, "double")
+})
+
+test_that ("cm data gh stars", {
+
+    Sys.setenv ("REPOMETRICS_TESTS" = "true")
+    mock_cm_data ()
+    path <- generate_test_pkg ()
+    stars <- cm_data_repo_stargazers (path)
+    fs::dir_delete (path)
+
+    expect_s3_class (stars, "data.frame")
+    expect_equal (nrow (stars), 2L)
+    expect_equal (ncol (stars), 2L)
+    nms <- c ("login", "starred_at")
+    expect_equal (names (stars), nms)
+
+    expect_type (stars$login, "character")
+    expect_type (stars$starred_at, "double")
+})

tests/testthat/test-cm-data.R

@@ -9,12 +9,13 @@ test_that ("cm data full", {
     fs::dir_delete (path)
 
     expect_type (dat, "list")
-    expect_length (dat, 12L)
+    expect_length (dat, 13L)
     nms <- c (
         "contribs_from_gh_api", "contribs_from_log", "dependencies",
         "gh_repo_workflow", "gitlog", "issue_comments_from_gh_api",
         "issues_from_gh_api", "libyears", "prs_from_gh_api",
-        "releases_from_gh_api", "repo_forks", "repo_from_gh_api"
+        "releases_from_gh_api", "repo_forks", "repo_from_gh_api",
+        "repo_stargazers"
     )
     expect_equal (names (dat), nms)