Merge pull request #10 from ThinkR-open/cran-release

Cran release

Author: statnmap

.Rbuildignore

@@ -12,3 +12,5 @@
 ^data-raw$
 ^gitdown$
 ^\.github$
+^cran-comments\.md$
+^CRAN-RELEASE$

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

@@ -23,6 +23,7 @@ jobs:
       matrix:
         config:
           - {os: windows-latest, r: 'release'}
+          - {os: windows-latest, r: 'devel'}
           - {os: macOS-latest, r: 'release'}
           - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
           - {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}

.gitignore

@@ -5,3 +5,5 @@ inst/doc
 testbook
 docs/
 gitdown
+cran-comments.md
+CRAN-RELEASE

R/utils.R

@@ -21,7 +21,7 @@ write_in <- function(x, repo, dir =  "gitdown", rmd = "index.Rmd") {
   dir_out <- normalizePath(file.path(repo, dir))
   if (!dir.exists(dir_out)) {dir.create(dir_out)}
   there <- file.path(dir_out, rmd)
-  write(x, file = there, append = TRUE)
+  write(enc2utf8(x), file = there, append = TRUE)
 }
 
 #' Presentation of commit
@@ -39,11 +39,11 @@ presentation_commit <- function(commit) {
     paste("- Date:", commit$when),
     "\n",
     paste("- Message content:"),
-    "\n",
+    "\n\n",
     "```",
     "\n",
     paste(commit$message),
-    "\n",
+    "\n\n",
     "```",
     "\n",
     paste("- Related patterns:\n"),

dev_history.R

@@ -68,7 +68,14 @@ usethis::use_github_action("test-coverage")
 rcmdcheck::rcmdcheck(args = "--as-cran")
 spelling::spell_check_package()
 rhub::check_for_cran()
-rhub::check_on_windows()
+rhub::check_on_windows(check_args = "--force-multiarch")
 rhub::check_on_fedora()
 devtools::check_win_devel()
+devtools::check_win_release()
+
+usethis::use_cran_badge()
+usethis::use_cran_comments()
+usethis::use_git_ignore("cran-comments.md")
+usethis::use_git_ignore("CRAN-RELEASE")
+
 devtools::release()

inst/booktemplate/_output.yml

@@ -1,5 +1,6 @@
 bookdown::gitbook:
   css: style.css
+  split_by: chapter
   config:
     toc:
       before: |

tests/testthat/presentation_commit tests/testthat/presentation_commit.mdtests/testthat/presentation_commit renamed to tests/testthat/presentation_commit.md

@@ -4,6 +4,7 @@
 - Author: Alice ; E-mail: [email protected]
 - Date: 2020-08-05 10:25:29
 - Message content:
+
 ```
 Add NEWS
 
@@ -12,6 +13,7 @@ issue #1.
 ticket6789.
 ticket1234
  Creation of the NEWS file for version 0.1.
+
 ```
 - Related patterns:
   + Issues: [#32](#issues-32), [#1](#issues-1), [#12](#issues-12)  

tests/testthat/test-git_down.R

@@ -1,5 +1,8 @@
 library(withr)
 
+# debug if problems with CRAN to retrieve outputs
+debug <- FALSE
+
 repo_input <- tempfile(pattern = "git2r-")
 repo <- fake_repo(repo_input)
 
@@ -13,13 +16,26 @@ with_dir(repo, {
 lines <- readLines(file.path(dirname(res), "section-issue.html"))
 one_line_exists <- grep('<h2><span class="header-section-number">1.2</span> Issue: #1</h2>',
                         lines, fixed = TRUE)
+sub_commit_1 <- grep('<h3><span class="header-section-number">1.2.1</span> commit: example: modification</h3>',
+                     lines, fixed = TRUE)
+sub_commit_2 <- grep('<h3><span class="header-section-number">1.2.2</span> commit: Add NEWS</h3>',
+                     lines, fixed = TRUE)
 
 test_that("git_down function",{
   expect_match(res, regexp = ".html")
   expect_true(file.exists(file.path(dirname(res), "section-issue.html")))
-  expect_true(length(one_line_exists) == 1)
+  expect_length(one_line_exists, 1)
+  expect_length(sub_commit_1, 1)
+  expect_length(sub_commit_2, 1)
 })
 
+# clean dir
+if (debug) {
+  dir.create("res_one")
+  file.copy(dirname(res), "res_one", recursive = TRUE, overwrite = TRUE)
+}
+unlink(dirname(res), recursive = TRUE)
+
 # Pattern without name and special characters cleaned
 with_dir(repo, {
   res <- git_down(author = "StatnMap",
@@ -38,30 +54,99 @@ test_that("git_down no name function",{
   expect_true(length(one_line_exists) == 1)
 })
 
+# clean dir
+if (debug) {
+  dir.create("res_two")
+  file.copy(dirname(res), "res_two", recursive = TRUE, overwrite = TRUE)
+}
+unlink(dirname(res), recursive = TRUE)
+
 # With multiple patterns ----
 
 with_dir(repo, {
+
   res <- git_down(author = "Seb",
                   pattern = c("Tickets" = "ticket[[:digit:]]+", "Issues" = "#[[:digit:]]+"),
                   open = FALSE
   )
-  res <- normalizePath(res)
+
+
+  # For Debugging with CRAN ----
+  if (debug) {
+    res_files <- paste(list.files(dirname(res)), collapse = ", ")
+
+    # repo <- "."
+
+    res_commits <- nest_commits_by_pattern(
+      repo,
+      pattern = c("Issues" = "#[[:digit:]]+", "Tickets" = "ticket[[:digit:]]+"),
+      silent = TRUE
+    )
+
+    res_pattern <- purrr::map_dfr(
+      names(c("Tickets" = "ticket[[:digit:]]+", "Issues" = "#[[:digit:]]+")),
+      ~each_pattern(res_commits, pattern.type = .x))
+
+    res_content <- paste(c(paste0("# Gitbook for ", "toto", "{-} \n"),
+                           paste0("Done on: ", Sys.time(), "\n"), "\n", unlist(res_pattern$text)),
+                         collapse = "\n\n")
+
+    dir.create(normalizePath(file.path(repo, "gitdown-cran"), mustWork = FALSE), recursive = TRUE)
+    file.copy(from = list.files(system.file("booktemplate", package = "gitdown"), full.names = TRUE),
+              to = normalizePath(file.path(repo, "gitdown-cran")), overwrite = TRUE)
+
+    gitdown:::write_in(x = res_content, repo = repo, dir = "gitdown-cran", rmd = "index.Rmd")
+    res_render <- rmarkdown::render(file.path(repo, "gitdown-cran", "index.Rmd"))
+  }
 })
-lines <- readLines(file.path(dirname(res), "section-issues.html"))
-one_line_exists <- grep('<h2><span class="header-section-number">2.2</span> Issue: #1</h2>',
-                        lines, fixed = TRUE)
-lines <- readLines(file.path(dirname(res), "section-tickets.html"))
-one_line_ticket_exists <- grep('<h2><span class="header-section-number">1.2</span> Ticket: ticket1234</h2>',
-                        lines, fixed = TRUE)
+
+# For Debugging with CRAN ----
+if (debug) {
+  dput(res_commits, file = "res_commits.txt")
+  dput(res_files, file = "res_files.txt")
+  dput(res_pattern, file = "res_pattern.txt")
+  dput(res_content, file = "res_content.txt")
+  file.copy(file.path(repo, "gitdown", 'index.Rmd'), "res_index.txt", overwrite = TRUE)
+  file.copy(file.path(repo, "gitdown-cran", 'index.Rmd'), "res_index_cran.txt", overwrite = TRUE)
+  file.copy(file.path(repo, "gitdown", '_bookdown.yml'), "res_bookdown.txt", overwrite = TRUE)
+  file.copy(file.path(repo, "gitdown", '_output.yml'), "res_output.txt", overwrite = TRUE)
+
+
+  dir.create("res_three")
+  file.copy(dirname(res), "res_three", recursive = TRUE, overwrite = TRUE)
+}
 
 test_that("git_down multiple pattern works", {
   expect_match(res, regexp = ".html")
-  expect_true(file.exists(file.path(dirname(res), "section-issues.html")))
-  expect_true(file.exists(file.path(dirname(res), "section-tickets.html")))
-  expect_true(length(one_line_exists) == 1)
+
+  issues_file <- normalizePath(file.path(dirname(res), "section-issues.html"))
+  tickets_file <- normalizePath(file.path(dirname(res), "section-tickets.html"))
+
+  # For Debugging with CRAN ----
+  if (debug) {
+    dput(dirname(res), file = "res_dirname.txt")
+    dput(issues_file, file = "res_issues_file.txt")
+    dput(tickets_file, file = "res_tickets_file.txt")
+  }
+
+  expect_true(file.exists(issues_file))
+  expect_true(file.exists(tickets_file))
+
+  lines <- readLines(tickets_file)
+  one_line_ticket_exists <- grep('<h2><span class="header-section-number">1.2</span> Ticket: ticket1234</h2>',
+                                 lines, fixed = TRUE)
+
   expect_true(length(one_line_ticket_exists) == 1)
+
+  lines <- readLines(issues_file)
+  one_line_exists <- grep('<h2><span class="header-section-number">2.2</span> Issue: #1</h2>',
+                          lines, fixed = TRUE)
+  expect_true(length(one_line_exists) == 1)
 })
 
+# clean dir
+unlink(dirname(res), recursive = TRUE)
+
 # With table of correspondence
 pattern.table <- data.frame(
   number = c("#2", "#1", "#1000"),
@@ -79,3 +164,13 @@ test_that("git_down with pattern table",{
     expect_match(res, regexp = ".html")
   })
 })
+
+if (debug) {
+  all_res_files <- list.files(pattern = '^res_', full.names = TRUE)
+  dir.create("debug")
+  file.copy(all_res_files, "debug", recursive = TRUE)
+  unlink(all_res_files, recursive = TRUE)
+}
+
+# clean dir
+unlink(dirname(res), recursive = TRUE)

tests/testthat/test-utils.R

@@ -1,4 +1,3 @@
-context("utils functions")
 library(withr)
 
 repo_input <- tempfile(pattern = "git2r-")
@@ -47,8 +46,6 @@ nest_out_pattern_table <- nest_commits_by_pattern(
   pattern.table = pattern.table,
   pattern = c("Tickets" = "ticket[[:digit:]]+", "Issues" = "#[[:digit:]]+"))
 
-# writeLines(aa, "tests/testthat/presentation_commit")
-
 test_that("nest_commits_by_pattern", {
   # One pattern
   expect_equal(
@@ -146,10 +143,11 @@ one_commit <- structure(
 )
 
 prez_commit <- gitdown:::presentation_commit(one_commit)
-# writeLines(prez_commit, "tests/testthat/presentation_commit")
+# writeLines(prez_commit, "tests/testthat/presentation_commit.md")
+# paste(readLines("tests/testthat/presentation_commit.md"), collapse = "\n")
 
 test_that("presentation_commit", {
-  expect_equal(prez_commit, paste(readLines("presentation_commit"), collapse = "\n"))
+  expect_equal(prez_commit, paste(readLines("presentation_commit.md"), collapse = "\n"))
 })
 
 # clean_link ----