diff --git a/DESCRIPTION b/DESCRIPTION index 3833a2482..7d0f0325c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -67,6 +67,7 @@ Collate: 'expect_not_linter.R' 'expect_null_linter.R' 'expect_s3_class_linter.R' + 'expect_true_false_linter.R' 'expect_type_linter.R' 'extract.R' 'extraction_operator_linter.R' diff --git a/NAMESPACE b/NAMESPACE index 3f1fbd1db..2724e6146 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -35,6 +35,7 @@ export(expect_not_linter) export(expect_null_linter) export(expect_s3_class_linter) export(expect_s4_class_linter) +export(expect_true_false_linter) export(expect_type_linter) export(extraction_operator_linter) export(function_left_parentheses_linter) diff --git a/NEWS.md b/NEWS.md index ad2291b76..0a91a3bb4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -92,6 +92,7 @@ function calls. (#850, #851, @renkun-ken) + `expect_s3_class_linter()` Require usage of `expect_s3_class(x, k)` over `expect_equal(class(x), k)` and similar + `expect_s4_class_linter()` Require usage of `expect_s4_class(x, k)` over `expect_true(methods::is(x, k))` + `expect_not_linter()` Require usage of `expect_false(x)` over `expect_true(!x)`, and _vice versa_. + + `expect_true_false_linter()` Require usage of `expect_true(x)` over `expect_equal(x, TRUE)` and similar * `assignment_linter()` now lints right assignment (`->` and `->>`) and gains two arguments. `allow_cascading_assign` (`TRUE` by default) toggles whether to lint `<<-` and `->>`; `allow_right_assign` toggles whether to lint `->` and `->>` (#915, @michaelchirico) # lintr 2.0.1 diff --git a/R/expect_true_false_linter.R b/R/expect_true_false_linter.R new file mode 100644 index 000000000..2d5dd1d09 --- /dev/null +++ b/R/expect_true_false_linter.R @@ -0,0 +1,39 @@ +#' Require usage of expect_true(x) over expect_equal(x, TRUE) +#' +#' [testthat::expect_true()] and [testthat::expect_false()] exist specifically +#' for testing the `TRUE`/`FALSE` value of an object. +#' [testthat::expect_equal()] and [testthat::expect_identical()] can also be +#' used for such tests, but it is better to use the tailored function instead. +#' +#' @evalRd rd_tags("expect_true_false_linter") +#' @seealso [linters] for a complete list of linters available in lintr. +#' @export +expect_true_false_linter <- function() { + Linter(function(source_file) { + if (length(source_file$parsed_content) == 0L) { + return(list()) + } + + xml <- source_file$xml_parsed_content + + xpath <- "//expr[expr[ + SYMBOL_FUNCTION_CALL[text() = 'expect_equal' or text() = 'expect_identical'] + and following-sibling::expr[position() <= 2 and NUM_CONST[text() = 'TRUE' or text() = 'FALSE']] + ]]" + + bad_expr <- xml2::xml_find_all(xml, xpath) + return(lapply(bad_expr, gen_expect_true_false_lint, source_file)) + }) +} + +gen_expect_true_false_lint <- function(expr, source_file) { + # NB: use expr/$node, not expr[$node], to exclude other things (especially ns:: parts of the call) + call_name <- xml2::xml_text(xml2::xml_find_first(expr, "expr/SYMBOL_FUNCTION_CALL[starts-with(text(), 'expect_')]")) + truth_value <- xml2::xml_text(xml2::xml_find_first(expr, "expr/NUM_CONST[text() = 'TRUE' or text() = 'FALSE']")) + if (truth_value == "TRUE") { + lint_msg <- sprintf("expect_true(x) is better than %s(x, TRUE)", call_name) + } else { + lint_msg <- sprintf("expect_false(x) is better than %s(x, FALSE)", call_name) + } + xml_nodes_to_lint(expr, source_file, lint_msg, type = "warning") +} diff --git a/inst/lintr/linters.csv b/inst/lintr/linters.csv index 6a11db3de..7fcc331cd 100644 --- a/inst/lintr/linters.csv +++ b/inst/lintr/linters.csv @@ -13,6 +13,7 @@ expect_not_linter,package_development best_practices readability expect_null_linter,package_development best_practices expect_s3_class_linter,package_development best_practices expect_s4_class_linter,package_development best_practices +expect_true_false_linter,package_development best_practices readability expect_type_linter,package_development best_practices extraction_operator_linter,style best_practices function_left_parentheses_linter,style readability default diff --git a/man/best_practices_linters.Rd b/man/best_practices_linters.Rd index a94e0a28b..470c2cedc 100644 --- a/man/best_practices_linters.Rd +++ b/man/best_practices_linters.Rd @@ -19,6 +19,7 @@ The following linters are tagged with 'best_practices': \item{\code{\link{expect_null_linter}}} \item{\code{\link{expect_s3_class_linter}}} \item{\code{\link{expect_s4_class_linter}}} +\item{\code{\link{expect_true_false_linter}}} \item{\code{\link{expect_type_linter}}} \item{\code{\link{extraction_operator_linter}}} \item{\code{\link{implicit_integer_linter}}} diff --git a/man/expect_not_linter.Rd b/man/expect_not_linter.Rd index cb11b7baf..0331aee89 100644 --- a/man/expect_not_linter.Rd +++ b/man/expect_not_linter.Rd @@ -7,9 +7,11 @@ expect_not_linter() } \description{ -\code{\link[testthat:logical-expectations]{testthat::expect_false()}} exists specifically for testing an output is +\code{\link[testthat:logical-expectations]{testthat::expect_false()}} exists specifically for testing that an output is \code{FALSE}. \code{\link[testthat:logical-expectations]{testthat::expect_true()}} can also be used for such tests by negating the output, but it is better to use the tailored function instead. +The reverse is also true -- use \code{expect_false(A)} instead of +\code{expect_true(!A)}. } \seealso{ \link{linters} for a complete list of linters available in lintr. diff --git a/man/expect_true_false_linter.Rd b/man/expect_true_false_linter.Rd new file mode 100644 index 000000000..fe0542591 --- /dev/null +++ b/man/expect_true_false_linter.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/expect_true_false_linter.R +\name{expect_true_false_linter} +\alias{expect_true_false_linter} +\title{Require usage of expect_true(x) over expect_equal(x, TRUE)} +\usage{ +expect_true_false_linter() +} +\description{ +\code{\link[testthat:logical-expectations]{testthat::expect_true()}} and \code{\link[testthat:logical-expectations]{testthat::expect_false()}} exist specifically +for testing the \code{TRUE}/\code{FALSE} value of an object. +\code{\link[testthat:equality-expectations]{testthat::expect_equal()}} and \code{\link[testthat:equality-expectations]{testthat::expect_identical()}} can also be +used for such tests, but it is better to use the tailored function instead. +} +\seealso{ +\link{linters} for a complete list of linters available in lintr. +} +\section{Tags}{ +\link[=best_practices_linters]{best_practices}, \link[=package_development_linters]{package_development}, \link[=readability_linters]{readability} +} diff --git a/man/linters.Rd b/man/linters.Rd index c68cf9ec5..56cac5a9d 100644 --- a/man/linters.Rd +++ b/man/linters.Rd @@ -17,16 +17,15 @@ Documentation for linters is structured into tags to allow for easier discovery. \section{Tags}{ The following tags exist: \itemize{ -\item{\link[=best_practices_linters]{best_practices} (15 linters)} -\item{\link[=best_practices_linters]{best_practices} (13 linters)} +\item{\link[=best_practices_linters]{best_practices} (16 linters)} \item{\link[=common_mistakes_linters]{common_mistakes} (5 linters)} \item{\link[=configurable_linters]{configurable} (16 linters)} \item{\link[=consistency_linters]{consistency} (7 linters)} \item{\link[=correctness_linters]{correctness} (7 linters)} \item{\link[=default_linters]{default} (25 linters)} \item{\link[=efficiency_linters]{efficiency} (4 linters)} -\item{\link[=package_development_linters]{package_development} (7 linters)} -\item{\link[=readability_linters]{readability} (22 linters)} +\item{\link[=package_development_linters]{package_development} (8 linters)} +\item{\link[=readability_linters]{readability} (23 linters)} \item{\link[=robustness_linters]{robustness} (10 linters)} \item{\link[=style_linters]{style} (32 linters)} } @@ -48,6 +47,7 @@ The following linters exist: \item{\code{\link{expect_null_linter}} (tags: best_practices, package_development)} \item{\code{\link{expect_s3_class_linter}} (tags: best_practices, package_development)} \item{\code{\link{expect_s4_class_linter}} (tags: best_practices, package_development)} +\item{\code{\link{expect_true_false_linter}} (tags: best_practices, package_development, readability)} \item{\code{\link{expect_type_linter}} (tags: best_practices, package_development)} \item{\code{\link{extraction_operator_linter}} (tags: best_practices, style)} \item{\code{\link{function_left_parentheses_linter}} (tags: default, readability, style)} diff --git a/man/package_development_linters.Rd b/man/package_development_linters.Rd index b92f6a6a5..76cf00266 100644 --- a/man/package_development_linters.Rd +++ b/man/package_development_linters.Rd @@ -17,6 +17,7 @@ The following linters are tagged with 'package_development': \item{\code{\link{expect_null_linter}}} \item{\code{\link{expect_s3_class_linter}}} \item{\code{\link{expect_s4_class_linter}}} +\item{\code{\link{expect_true_false_linter}}} \item{\code{\link{expect_type_linter}}} \item{\code{\link{package_hooks_linter}}} } diff --git a/man/readability_linters.Rd b/man/readability_linters.Rd index 6795161e1..f5cab44f2 100644 --- a/man/readability_linters.Rd +++ b/man/readability_linters.Rd @@ -18,6 +18,7 @@ The following linters are tagged with 'readability': \item{\code{\link{commented_code_linter}}} \item{\code{\link{cyclocomp_linter}}} \item{\code{\link{expect_not_linter}}} +\item{\code{\link{expect_true_false_linter}}} \item{\code{\link{function_left_parentheses_linter}}} \item{\code{\link{infix_spaces_linter}}} \item{\code{\link{line_length_linter}}} diff --git a/tests/testthat/test-expect_true_false_linter.R b/tests/testthat/test-expect_true_false_linter.R new file mode 100644 index 000000000..e0bee7e12 --- /dev/null +++ b/tests/testthat/test-expect_true_false_linter.R @@ -0,0 +1,26 @@ +test_that("expect_true_false_linter skips allowed usages", { + # expect_true is a scalar test; testing logical vectors with expect_equal is OK + expect_lint("expect_equal(x, c(TRUE, FALSE))", NULL, expect_true_false_linter()) +}) + +test_that("expect_true_false_linter blocks simple disallowed usages", { + expect_lint( + "expect_equal(foo(x), TRUE)", + rex::rex("expect_true(x) is better than expect_equal(x, TRUE)"), + expect_true_false_linter() + ) + + # expect_identical is treated the same as expect_equal + expect_lint( + "testthat::expect_identical(x, FALSE)", + rex::rex("expect_false(x) is better than expect_identical(x, FALSE)"), + expect_true_false_linter() + ) + + # also caught when TRUE/FALSE is the first argument + expect_lint( + "expect_equal(TRUE, foo(x))", + rex::rex("expect_true(x) is better than expect_equal(x, TRUE)"), + expect_true_false_linter() + ) +}) diff --git a/tests/testthat/test-settings.R b/tests/testthat/test-settings.R index 5a40e87d7..3d7d0b31a 100644 --- a/tests/testthat/test-settings.R +++ b/tests/testthat/test-settings.R @@ -92,10 +92,10 @@ test_that("logical_env utility works as intended", { on.exit(if (is.na(old)) Sys.unsetenv(test_env) else sym_set_env(test_env, old)) sym_set_env(test_env, "true") - expect_equal(lintr:::logical_env(test_env), TRUE) + expect_true(lintr:::logical_env(test_env)) sym_set_env(test_env, "F") - expect_equal(lintr:::logical_env(test_env), FALSE) + expect_false(lintr:::logical_env(test_env)) sym_set_env(test_env, "") expect_null(lintr:::logical_env(test_env))