Merge branch 'master' into f-abs

Author: krlmlr

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rprojroot
 Title: Finding Files in Project Subdirectories
-Version: 1.3.2.9000
+Version: 1.3.2.9001
 Authors@R: 
     person(given = "Kirill",
            family = "M\u00fcller",
@@ -20,6 +20,7 @@ Imports:
     backports
 Suggests:
     knitr,
+    lifecycle,
     mockr,
     rmarkdown,
     testthat,

NAMESPACE

@@ -1,14 +1,12 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method("|",root_criterion)
-S3method(as.root_criterion,default)
 S3method(as_root_criterion,character)
 S3method(as_root_criterion,default)
 S3method(as_root_criterion,root_criterion)
 S3method(format,root_criterion)
 S3method(print,root_criterion)
 S3method(str,root_criteria)
-export(as.root_criterion)
 export(as_root_criterion)
 export(criteria)
 export(find_package_root_file)
@@ -19,11 +17,10 @@ export(find_rstudio_root_file)
 export(find_testthat_root_file)
 export(from_wd)
 export(get_root_desc)
+export(has_basename)
 export(has_dir)
-export(has_dirname)
 export(has_file)
 export(has_file_pattern)
-export(is.root_criterion)
 export(is_drake_project)
 export(is_git_root)
 export(is_projectile_project)

NEWS.md

@@ -1,11 +1,18 @@
+# rprojroot 1.3.2.9001 (2020-11-09)
+
+- `has_basename()` replaces `has_dirname()` to avoid confusion (#63).
+- The `is_dirname()` criterion no longer considers sibling directories (#44).
+- Move to GitHub Actions (#52).
+- Re-license as MIT (#50).
+
+
 # rprojroot 1.3.2.9000 (2018-03-29)
 
 - Rename `as.` and `is.` functions to `as_` and `is_`, deprecate old versions.
 - New `is_drake_project` criterion (#34).
 - Add `subdir` argument to `make_fix_file()` (#33, @BarkleyBG).
 - Update documentation for version control criteria (#35, @uribo).
 - Availability of suggested packages knitr and rmarkdown, and pandoc, is now checked before running the corresponding tests.
-- rprojroot has been re-licensed as MIT (#50).
 
 
 # rprojroot 1.3-2 (2017-12-22)

R/criterion.R

@@ -124,27 +124,12 @@ is_root_criterion <- function(x) {
   inherits(x, "root_criterion")
 }
 
-#' @rdname deprecated
-#' @inheritParams is_root_criterion
-#' @export
-is.root_criterion <- function(x) {
-  .Deprecated("is_root_criterion")
-  is_root_criterion(x)
-}
-
 #' @rdname root_criterion
 #' @export
 as_root_criterion <- function(x) UseMethod("as_root_criterion", x)
 
-#' @rdname deprecated
-#' @export
-as.root_criterion <- function(x) {
-  .Deprecated("as_root_criterion")
-  UseMethod("as.root_criterion", x)
-}
-
 #' @details
-#' The `as.root_criterion()` function accepts objects of class
+#' The `as_root_criterion()` function accepts objects of class
 #' `root_criterion`, and character values; the latter will be
 #' converted to criteria using `has_file`.
 #'
@@ -163,11 +148,6 @@ as_root_criterion.default <- function(x) {
   stop("Cannot coerce ", x, " to type root_criterion.", call. = FALSE)
 }
 
-#' @export
-as.root_criterion.default <- function(x) {
-  as_root_criterion(x)
-}
-
 #' @export
 format.root_criterion <- function(x, ...) {
   if (length(x$desc) > 1) {

R/deprecated.R

@@ -22,7 +22,7 @@ has_file <- function(filepath, contents = NULL, n = -1L) {
     if (!file.exists(testfile)) {
       return(FALSE)
     }
-    if (is_dir(testfile)) {
+    if (dir.exists(testfile)) {
       return(FALSE)
     }
     match_contents(testfile, .(contents), .(n))
@@ -52,10 +52,7 @@ has_dir <- function(filepath) {
 
   testfun <- eval(bquote(function(path) {
     testfile <- file.path(path, .(filepath))
-    if (!file.exists(testfile)) {
-      return(FALSE)
-    }
-    is_dir(testfile)
+    dir.exists(testfile)
   }))
 
   desc <- paste0("contains a directory `", filepath, "`")
@@ -101,20 +98,22 @@ has_file_pattern <- function(pattern, contents = NULL, n = -1L) {
 }
 
 #' @details
-#' The `has_dirname()` function constructs a criterion that checks if the
-#' [base::dirname()] has a specific name.
+#' The `has_basename()` function constructs a criterion that checks if the
+#' [base::basename()] of the root directory has a specific name,
+#' with support for case-insensitive file systems.
 #'
 #' @rdname root_criterion
-#' @param dirname A directory name, without subdirectories
+#' @param basename A directory name, without subdirectories
 #' @export
-has_dirname <- function(dirname, subdir = NULL) {
-  force(dirname)
+has_basename <- function(basename, subdir = NULL) {
+  force(basename)
 
   testfun <- eval(bquote(function(path) {
-    dir.exists(file.path(dirname(path), .(dirname)))
+    # Support case insensitive file systems.
+    tolower(basename(path)) == tolower(.(basename)) && dir.exists(file.path(dirname(path), .(basename)))
   }))
 
-  desc <- paste0("directory name is `", dirname, "`")
+  desc <- paste0("directory name is `", basename, "`")
 
   root_criterion(testfun, desc, subdir = subdir)
 }
@@ -144,7 +143,7 @@ is_svn_root <- has_dir(".svn")
 is_vcs_root <- is_git_root | is_svn_root
 
 #' @export
-is_testthat <- has_dirname("testthat", c("tests/testthat", "testthat"))
+is_testthat <- has_basename("testthat", c("tests/testthat", "testthat"))
 
 #' @export
 from_wd <- root_criterion(function(path) TRUE, "from current working directory")
@@ -262,15 +261,11 @@ str.root_criteria <- function(object, ...) {
 
 list_files <- function(path, filename) {
   files <- dir(path = path, pattern = filename, all.files = TRUE, full.names = TRUE)
-  dirs <- is_dir(files)
+  dirs <- dir.exists(files)
   files <- files[!dirs]
   files
 }
 
-is_dir <- function(x) {
-  dir.exists(x)
-}
-
 match_contents <- function(f, contents, n) {
   if (is.null(contents)) {
     return(TRUE)

R/has-file.R

@@ -1,6 +1,6 @@
 #' @details
 #' See the "Value" section in [root_criterion()] for documentation
-#' of root criterion objects, and  [criteria()] for useful predefined
+#' of root criterion objects, and  [criteria] for useful predefined
 #' root criteria.
 #'
 #' @examples
@@ -11,5 +11,4 @@
 #' root_fun("NAMESPACE")
 #' }
 #' @import backports
-#' @api
 "_PACKAGE"

R/rprojroot-package.R

@@ -1,5 +1,9 @@
-#' @title Determines the path of the currently running script
-#' @description \R does not store nor export the path of the currently running
+#' Determines the path of the currently running script
+#'
+#' @description
+#' `r lifecycle::badge("soft-deprecated")`
+#'
+#' \R does not store nor export the path of the currently running
 #'   script.  This is an attempt to circumvent this limitation by applying
 #'   heuristics (such as call stack and argument inspection) that work in many
 #'   cases.
@@ -12,17 +16,29 @@
 #'   or run with `Rscript` or using the `--file` parameter to the
 #'   `R` executable.  For code run with `Rscript`, the exact value
 #'   of the parameter passed to `Rscript` is returned.
+#'
+#' @section Life cycle:
+#'
+#' These functions are now available in the \pkg{whereami} package.
+#'
 #' @return The path of the currently running script, NULL if it cannot be
 #'   determined.
 #' @seealso [base::source()], [utils::Rscript()], [base::getwd()]
 #' @references [https://stackoverflow.com/q/1815606/946850]()
 #' @author Kirill Müller, Hadley Wickham, Michael R. Head
+#' @keywords internal
 #' @examples
 #' \dontrun{
 #' thisfile()
 #' }
 #' @export
 thisfile <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile()",
+    "whereami::thisfile()"
+  )
+
   if (!is.null(res <- thisfile_source())) {
     res
   } else if (!is.null(res <- thisfile_r())) {
@@ -39,6 +55,12 @@ thisfile <- function() {
 #' @rdname thisfile
 #' @export
 thisfile_source <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_source()",
+    "whereami::thisfile_source()"
+  )
+
   for (i in -(1:sys.nframe())) {
     if (identical(args(sys.function(i)), args(base::source))) {
       return(normalizePath(sys.frame(i)$ofile))
@@ -52,6 +74,12 @@ thisfile_source <- function() {
 #' @importFrom utils tail
 #' @export
 thisfile_r <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_r()",
+    "whereami::thisfile_r()"
+  )
+
   cmd_args <- commandArgs(trailingOnly = FALSE)
   if (!grepl("^R(?:|term)(?:|[.]exe)$", basename(cmd_args[[1L]]), ignore.case = TRUE)) {
     return(NULL)
@@ -77,6 +105,12 @@ thisfile_r <- function() {
 #' @importFrom utils tail
 #' @export
 thisfile_rscript <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_rscript()",
+    "whereami::thisfile_rscript()"
+  )
+
   cmd_args <- commandArgs(trailingOnly = FALSE)
   if (!grepl("^R(?:term|script)(?:|[.]exe)$", basename(cmd_args[[1L]]), ignore.case = TRUE)) {
     return(NULL)
@@ -100,6 +134,12 @@ thisfile_rscript <- function() {
 #' @rdname thisfile
 #' @export
 thisfile_knit <- function() {
+  lifecycle::deprecate_soft(
+    "2.0.0",
+    "rprojroot::thisfile_knit()",
+    "whereami::thisfile_knit()"
+  )
+
   if (requireNamespace("knitr")) {
     return(knitr::current_input(dir = TRUE))
   }

R/thisfile.R

@@ -17,6 +17,7 @@ rlang::local_interactive(FALSE)
 # [rprojroot](https://r-lib.github.io/rprojroot)
 
 <!-- badges: start -->
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
 [![rcc](https://github.com/r-lib/rprojroot/workflows/rcc/badge.svg)](https://github.com/r-lib/rprojroot/actions)
 [![codecov.io](https://codecov.io/github/r-lib/rprojroot/coverage.svg?branch=master)](https://codecov.io/github/r-lib/rprojroot?branch=master)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/rprojroot)](https://cran.r-project.org/package=rprojroot)

README.Rmd

@@ -4,6 +4,7 @@
 
 <!-- badges: start -->
 
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
 [![rcc](https://github.com/r-lib/rprojroot/workflows/rcc/badge.svg)](https://github.com/r-lib/rprojroot/actions) [![codecov.io](https://codecov.io/github/r-lib/rprojroot/coverage.svg?branch=master)](https://codecov.io/github/r-lib/rprojroot?branch=master) [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/rprojroot)](https://cran.r-project.org/package=rprojroot)
 
 <!-- badges: end -->