package availability addressed (#52)

* package availability addressed * updated to not double check availability * implemented as utils function
lockedata · Oct 18, 2018 · cc8bb2e · cc8bb2e
1 parent c2e591a
commit cc8bb2e
Show file tree

Hide file tree

Showing 9 changed files with 143 additions and 94 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -20,18 +20,20 @@ Depends: R (>= 3.3.0)
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
-Suggests: covr,
+Suggests: 
+    covr,
     testthat,
     knitr,
-    rmarkdown
+    available
 VignetteBuilder: knitr
 Imports: 
     devtools,
     packrat,
     shiny,
     miniUI,
     methods,
-    usethis
+    usethis,
+    rmarkdown
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 6.1.0
 URL: https://github.com/lockedata/pRojects, https://itsalocke.com/pRojects/

diff --git a/R/createAnalysisProject.R b/R/createAnalysisProject.R
@@ -19,4 +19,6 @@ createAnalysisProject <- function(name,
   createBasicProject(name, ...)
   createdirs(name, dirs)
   invisible(TRUE)
+
+
 }
diff --git a/R/createBasicProject.R b/R/createBasicProject.R
@@ -20,24 +20,25 @@ createBasicProject <- function(name,
                                packrat = TRUE,
                                git = TRUE,
                                readme = TRUE) {
-  dir.create(name)
-  devtools::setup(name,check = FALSE)
-  file.remove(file.path(name,"NAMESPACE"))
+  if(is_available(name)){
+    dir.create(name)
+    devtools::setup(name,check = FALSE)
+    file.remove(file.path(name,"NAMESPACE"))
 
-  if (travis)
-    devtools::use_travis(name)
+    if (travis)
+      devtools::use_travis(name)
 
-  if (packrat) {
-    devtools::use_package("packrat", pkg = name)
-    packrat:::augmentRprofile(name)
-    packrat::init(name, enter = FALSE)
-  }
-
-  if (readme)
-    use_readme_rmd(name)
+    if (packrat) {
+      devtools::use_package("packrat", pkg = name)
+      packrat:::augmentRprofile(name)
+      packrat::init(name, enter = FALSE)
+    }
 
-  if (git)
-    devtools::use_git(pkg = name)
+    if (readme)
+      use_readme_rmd(name)
 
+    if (git)
+      devtools::use_git(pkg = name)
+  }
   invisible(TRUE)
 }
diff --git a/R/createPackageProject.R b/R/createPackageProject.R
@@ -17,18 +17,20 @@
 createPackageProject <- function(name,
                                  bestPractices = TRUE,
                                  coverage = c("codecov", "coveralls")) {
-  devtools::create(name)
-  if (bestPractices) {
-    devtools::use_travis(name)
-    devtools::use_code_of_conduct(name)
-    devtools::use_coverage(name, coverage)
-    devtools::use_mit_license(name)
-    use_news_md(name)
-    use_package_doc(name)
-    use_readme_rmd(name)
-    devtools::use_testthat(name)
-    devtools::use_vignette(name, name)
-    devtools::use_git(pkg = name)
+  if(is_available(name)){
+    devtools::create(name)
+    if (bestPractices) {
+      devtools::use_travis(name)
+      devtools::use_code_of_conduct(name)
+      devtools::use_coverage(name, coverage)
+      devtools::use_mit_license(name)
+      use_news_md(name)
+      use_package_doc(name)
+      use_readme_rmd(name)
+      devtools::use_testthat(name)
+      devtools::use_vignette(name, name)
+      devtools::use_git(pkg = name)
+    }
   }
   invisible(TRUE)
 }
diff --git a/R/utils.R b/R/utils.R
@@ -64,3 +64,22 @@ createdesc <- function(name) {
   )
   devtools:::write_dcf(file.path(name,"DESCRIPTION"),desc)
 }
+
+
+#' Check availability
+#'
+#' @param name Package / project
+
+is_available <- function(name) {
+  cran <- available::available_on_cran(name)
+  gh <- available::available_on_github(name)
+  if(cran == FALSE){
+    stop('package name is taken on CRAN')
+  }
+  if(gh$available == FALSE){
+    stop('package name is taken on Github')
+  }
+  invisible(TRUE)
+}
+
+
diff --git a/man/createPackageProject.Rd b/man/createPackageProject.Rd
diff --git a/man/is_available.Rd b/man/is_available.Rd
diff --git a/tests/testthat/test-createPackageProject.R b/tests/testthat/test-createPackageProject.R
@@ -1,26 +1,26 @@
 context("createPackageProject")
 
-project_name <- "packageProject"
+project_name <- "packageProject2"
 
 test_that("createPackageProject() creates as expected when using defaults",{
 
-  createPackageProject(project_name)
-
-  expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
-  expect_true(file.exists(file.path(project_name, "codecov.yml")))
-  expect_true(file.exists(file.path(project_name, "CONDUCT.md")))
-  expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
-  expect_true(file.exists(file.path(project_name, "LICENSE")))
-  expect_true(file.exists(file.path(project_name, "NAMESPACE")))
-  expect_true(file.exists(file.path(project_name, "NEWS.md")))
-  expect_true(file.exists(file.path(project_name, "R")))
-  expect_true(file.exists(file.path(project_name, "README.Rmd")))
-  expect_true(file.exists(file.path(project_name, "tests")))
-  expect_true(file.exists(file.path(project_name, "vignettes")))
-  expect_true(file.exists(file.path(project_name, ".git")))
-  expect_true(file.exists(file.path(project_name, ".gitignore")))
-  expect_true(file.exists(file.path(project_name, ".travis.yml")))
-
+  proj <- try(createPackageProject(project_name))
+  if(!inherits(proj, 'try-error')){
+    expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
+    expect_true(file.exists(file.path(project_name, "codecov.yml")))
+    expect_true(file.exists(file.path(project_name, "CONDUCT.md")))
+    expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
+    expect_true(file.exists(file.path(project_name, "LICENSE")))
+    expect_true(file.exists(file.path(project_name, "NAMESPACE")))
+    expect_true(file.exists(file.path(project_name, "NEWS.md")))
+    expect_true(file.exists(file.path(project_name, "R")))
+    expect_true(file.exists(file.path(project_name, "README.Rmd")))
+    expect_true(file.exists(file.path(project_name, "tests")))
+    expect_true(file.exists(file.path(project_name, "vignettes")))
+    expect_true(file.exists(file.path(project_name, ".git")))
+    expect_true(file.exists(file.path(project_name, ".gitignore")))
+    expect_true(file.exists(file.path(project_name, ".travis.yml")))
+  }
 })
 
 unlink(project_name, recursive = TRUE, force = TRUE)
diff --git a/tests/testthat/test-createTrainingProject.R b/tests/testthat/test-createTrainingProject.R
@@ -1,65 +1,74 @@
 context("createTrainingProject")
 
-project_name <- "trainingProject"
+project_name <- "trainingProject2"
 
 test_that("createTrainingProject() creates as expected when using defaults",{
 
-  createTrainingProject(project_name)
-
-  expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
-  expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
-  expect_true(file.exists(file.path(project_name, "R")))
-  expect_true(file.exists(file.path(project_name, "README.Rmd")))
-  expect_true(file.exists(file.path(project_name, "packrat")))
-  expect_true(file.exists(file.path(project_name, ".git")))
-  expect_true(file.exists(file.path(project_name, ".gitignore")))
-  expect_true(file.exists(file.path(project_name, ".travis.yml")))
-  expect_true(file.exists(file.path(project_name, "data")))
-  expect_true(file.exists(file.path(project_name, "handouts")))
-  expect_true(file.exists(file.path(project_name, "slides")))
 
+  proj <- try(createTrainingProject(project_name))
+
+  if(!inherits(proj, 'try-error')){
+    expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
+    expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
+    expect_true(file.exists(file.path(project_name, "R")))
+    expect_true(file.exists(file.path(project_name, "README.Rmd")))
+    expect_true(file.exists(file.path(project_name, "packrat")))
+    expect_true(file.exists(file.path(project_name, ".git")))
+    expect_true(file.exists(file.path(project_name, ".gitignore")))
+    expect_true(file.exists(file.path(project_name, ".travis.yml")))
+    expect_true(file.exists(file.path(project_name, "data")))
+    expect_true(file.exists(file.path(project_name, "handouts")))
+    expect_true(file.exists(file.path(project_name, "slides")))
+  }
 })
 
 unlink(project_name, recursive = TRUE, force = TRUE)
 
 test_that("createTrainingProject() creates as expected when using bookdown and revealjs",{
 
-  createTrainingProject(project_name, handoutEngine = "bookdown", slideEngine = "revealjs")
-
-  expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
-  expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
-  expect_true(file.exists(file.path(project_name, "R")))
-  expect_true(file.exists(file.path(project_name, "README.Rmd")))
-  expect_true(file.exists(file.path(project_name, "packrat")))
-  expect_true(file.exists(file.path(project_name, ".git")))
-  expect_true(file.exists(file.path(project_name, ".gitignore")))
-  expect_true(file.exists(file.path(project_name, ".travis.yml")))
-  expect_true(file.exists(file.path(project_name, "data")))
-  expect_true(file.exists(file.path(project_name, "handouts")))
-  expect_true(file.exists(file.path(project_name, "handouts", "index.Rmd")))
-  expect_true(file.exists(file.path(project_name, "slides", "revealjs_slides.Rmd")))
-
+  proj <- try(
+    createTrainingProject(project_name, 
+      handoutEngine = "bookdown", slideEngine = "revealjs")
+    )
+  if(!inherits(proj, 'try-error')){
+    expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
+    expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
+    expect_true(file.exists(file.path(project_name, "R")))
+    expect_true(file.exists(file.path(project_name, "README.Rmd")))
+    expect_true(file.exists(file.path(project_name, "packrat")))
+    expect_true(file.exists(file.path(project_name, ".git")))
+    expect_true(file.exists(file.path(project_name, ".gitignore")))
+    expect_true(file.exists(file.path(project_name, ".travis.yml")))
+    expect_true(file.exists(file.path(project_name, "data")))
+    expect_true(file.exists(file.path(project_name, "handouts")))
+    expect_true(file.exists(file.path(project_name, "handouts", "index.Rmd")))
+    expect_true(file.exists(file.path(project_name, "slides", "revealjs_slides.Rmd")))
+  }
 })
 
 unlink(project_name, recursive = TRUE, force = TRUE)
 
 test_that("createTrainingProject() creates as expected when using tufte and xaringan",{
 
-  createTrainingProject(project_name, handoutEngine = "tufte", slideEngine = "xaringan")
-
-  expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
-  expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
-  expect_true(file.exists(file.path(project_name, "R")))
-  expect_true(file.exists(file.path(project_name, "README.Rmd")))
-  expect_true(file.exists(file.path(project_name, "packrat")))
-  expect_true(file.exists(file.path(project_name, ".git")))
-  expect_true(file.exists(file.path(project_name, ".gitignore")))
-  expect_true(file.exists(file.path(project_name, ".travis.yml")))
-  expect_true(file.exists(file.path(project_name, "data")))
-  expect_true(file.exists(file.path(project_name, "handouts")))
-  expect_true(file.exists(file.path(project_name, "handouts", "tufte_handout.Rmd")))
-  expect_true(file.exists(file.path(project_name, "slides", "xaringan_slides.Rmd")))
-
+  proj <- try(
+    createTrainingProject(project_name, 
+      handoutEngine = "tufte", slideEngine = "xaringan")
+    )
+
+  if(!inherits(proj, 'try-error')){
+    expect_true(file.exists(file.path(project_name, paste0(project_name, ".Rproj"))))
+    expect_true(file.exists(file.path(project_name, "DESCRIPTION")))
+    expect_true(file.exists(file.path(project_name, "R")))
+    expect_true(file.exists(file.path(project_name, "README.Rmd")))
+    expect_true(file.exists(file.path(project_name, "packrat")))
+    expect_true(file.exists(file.path(project_name, ".git")))
+    expect_true(file.exists(file.path(project_name, ".gitignore")))
+    expect_true(file.exists(file.path(project_name, ".travis.yml")))
+    expect_true(file.exists(file.path(project_name, "data")))
+    expect_true(file.exists(file.path(project_name, "handouts")))
+    expect_true(file.exists(file.path(project_name, "handouts", "tufte_handout.Rmd")))
+    expect_true(file.exists(file.path(project_name, "slides", "xaringan_slides.Rmd")))
+  }
 })
 
 unlink(project_name, recursive = TRUE, force = TRUE)