Make $xml_find_function_calls() land on parent::expr instead (#2715)

* Initial progress migrating style for $xml_find_function_calls

* rest of first pass on linters, docs

* document updated to man/

* vestigial debugging comment

* ws change for consistency with other edits

---------

Co-authored-by: AshesITR <[email protected]>

Author: MichaelChirico

R/any_duplicated_linter.R

@@ -35,8 +35,7 @@
 #' @export
 any_duplicated_linter <- function() {
   any_duplicated_xpath <- "
-  parent::expr
-    /following-sibling::expr[1][expr[1][SYMBOL_FUNCTION_CALL[text() = 'duplicated']]]
+  following-sibling::expr[1][expr[1][SYMBOL_FUNCTION_CALL[text() = 'duplicated']]]
     /parent::expr[
       count(expr) = 2
       or (count(expr) = 3 and SYMBOL_SUB[text() = 'na.rm'])

R/any_is_na_linter.R

@@ -37,8 +37,7 @@
 #' @export
 any_is_na_linter <- function() {
   any_xpath <- "
-  parent::expr
-    /following-sibling::expr[1][expr[1][SYMBOL_FUNCTION_CALL[text() = 'is.na']]]
+  following-sibling::expr[1][expr[1][SYMBOL_FUNCTION_CALL[text() = 'is.na']]]
     /parent::expr[
       count(expr) = 2
       or (count(expr) = 3 and SYMBOL_SUB[text() = 'na.rm'])

R/backport_linter.R

@@ -56,8 +56,9 @@ backport_linter <- function(r_version = getRversion(), except = character()) {
     used_symbols <- xml_find_all(xml, "//SYMBOL")
     used_symbols <- used_symbols[xml_text(used_symbols) %in% names(backport_index)]
 
+    used_calls <- source_expression$xml_find_function_calls(names(backport_index))
     all_names_nodes <- combine_nodesets(
-      source_expression$xml_find_function_calls(names(backport_index)),
+      xml_find_first(used_calls, "SYMBOL_FUNCTION_CALL"),
       used_symbols
     )
     all_names <- xml_text(all_names_nodes)

R/boolean_arithmetic_linter.R

@@ -36,21 +36,19 @@ boolean_arithmetic_linter <- function() {
   one_expr <- "(LT or GE) and expr[NUM_CONST[text() = '1' or text() = '1L']]"
   length_xpath <- glue("
   parent::expr
-    /parent::expr
     /parent::expr[
       expr[SYMBOL_FUNCTION_CALL[text() = 'length']]
       and parent::expr[ ({zero_expr}) or ({one_expr})]
     ]
   ")
   sum_xpath <- glue("
-  parent::expr
-    /parent::expr[
-      expr[
-        expr[SYMBOL_FUNCTION_CALL[text() = 'grepl']]
-        or (EQ or NE or GT or LT or GE or LE)
-      ] and parent::expr[ ({zero_expr}) or ({one_expr})]
+  parent::expr[
+    expr[
+      expr[SYMBOL_FUNCTION_CALL[text() = 'grepl']]
+      or (EQ or NE or GT or LT or GE or LE)
     ]
-  ")
+    and parent::expr[ ({zero_expr}) or ({one_expr})]
+  ]")
 
   Linter(linter_level = "expression", function(source_expression) {
     length_calls <- source_expression$xml_find_function_calls(c("which", "grep"))

R/class_equals_linter.R

@@ -36,7 +36,6 @@
 class_equals_linter <- function() {
   xpath <- "
   parent::expr
-    /parent::expr
     /parent::expr[
       not(preceding-sibling::OP-LEFT-BRACKET)
       and (EQ or NE or SPECIAL[text() = '%in%'])

R/condition_call_linter.R

@@ -77,7 +77,7 @@ condition_call_linter <- function(display_call = FALSE) {
     msg_fmt <- "Use %s(., call. = FALSE) not to display the call in an error message."
   }
 
-  xpath <- glue::glue("parent::expr[{call_cond}]/parent::expr")
+  xpath <- glue::glue("./self::*[{call_cond}]/parent::expr")
 
   Linter(linter_level = "expression", function(source_expression) {
     xml_calls <- source_expression$xml_find_function_calls(c("stop", "warning"))

R/condition_message_linter.R

@@ -44,10 +44,9 @@
 condition_message_linter <- function() {
   translators <- c("packageStartupMessage", "message", "warning", "stop")
   xpath <- glue("
-  self::SYMBOL_FUNCTION_CALL[
+  self::*[SYMBOL_FUNCTION_CALL[
     not(preceding-sibling::OP-DOLLAR or preceding-sibling::OP-AT)
-  ]
-    /parent::expr
+  ]]
     /following-sibling::expr[
       expr[1][SYMBOL_FUNCTION_CALL[text() = 'paste' or text() = 'paste0']]
       and not(SYMBOL_SUB[text() = 'collapse'])

R/conjunct_test_linter.R

@@ -79,19 +79,16 @@ conjunct_test_linter <- function(allow_named_stopifnot = TRUE,
   allow_filter <- match.arg(allow_filter)
 
   expect_true_assert_that_xpath <- "
-  parent::expr
-    /following-sibling::expr[1][AND2]
+  following-sibling::expr[1][AND2]
     /parent::expr
   "
   named_stopifnot_condition <- if (allow_named_stopifnot) "and not(preceding-sibling::*[1][self::EQ_SUB])" else ""
   stopifnot_xpath <- glue("
-  parent::expr
-    /following-sibling::expr[1][AND2 {named_stopifnot_condition}]
+  following-sibling::expr[1][AND2 {named_stopifnot_condition}]
     /parent::expr
   ")
   expect_false_xpath <- "
-  parent::expr
-    /following-sibling::expr[1][OR2]
+  following-sibling::expr[1][OR2]
     /parent::expr
   "
 
@@ -101,7 +98,7 @@ conjunct_test_linter <- function(allow_named_stopifnot = TRUE,
     always = "true"
   )
   filter_xpath <- glue("
-  parent::expr[{ filter_ns_cond }]
+  self::*[{ filter_ns_cond }]
     /parent::expr
     /expr[AND]
   ")

R/consecutive_assertion_linter.R

@@ -35,19 +35,15 @@ consecutive_assertion_linter <- function() {
   next_expr <- "following-sibling::*[self::expr or self::expr_or_assign_or_help or self::equal_assign][1]"
 
   stopifnot_xpath <- glue("
-  parent::expr
-    /parent::expr[
-      expr[1]/SYMBOL_FUNCTION_CALL = {next_expr}/expr[1]/SYMBOL_FUNCTION_CALL
-    ]
-  ")
+  parent::expr[
+    expr[1]/SYMBOL_FUNCTION_CALL = {next_expr}/expr[1]/SYMBOL_FUNCTION_CALL
+  ]")
   assert_that_xpath <- glue("
-  parent::expr
-    /parent::expr[
-      not(SYMBOL_SUB[text() = 'msg'])
-      and not(following-sibling::expr[1]/SYMBOL_SUB[text() = 'msg'])
-      and expr[1]/SYMBOL_FUNCTION_CALL = {next_expr}/expr[1]/SYMBOL_FUNCTION_CALL
-    ]
-  ")
+  parent::expr[
+    not(SYMBOL_SUB[text() = 'msg'])
+    and not(following-sibling::expr[1]/SYMBOL_SUB[text() = 'msg'])
+    and expr[1]/SYMBOL_FUNCTION_CALL = {next_expr}/expr[1]/SYMBOL_FUNCTION_CALL
+  ]")
 
   Linter(linter_level = "file", function(source_expression) {
     # need the full file to also catch usages at the top level

R/consecutive_mutate_linter.R

@@ -38,8 +38,7 @@
 #' @export
 consecutive_mutate_linter <- function(invalid_backends = "dbplyr") {
   attach_pkg_xpath <- "
-  parent::expr
-    /following-sibling::expr
+  following-sibling::expr
     /*[self::SYMBOL or self::STR_CONST]
   "