Merge branch 'master' into hindi_s

Author: jyoti-bhogal

.Rbuildignore

@@ -19,6 +19,7 @@
 ^\.github$
 ^\.vscode$
 ^\.zed$
+^\.lintr$
 
 ^\.gitlab-ci\.yml$
 

.ci/.lintr.R

@@ -21,6 +21,7 @@ linters = c(dt_linters, all_linters(
     message = "Use messagef to avoid fragmented translations.",
     warning = "Use warningf to avoid fragmented translations.",
     stop = "Use stopf to avoid fragmented translations.",
+    rev = "Use frev internally, or setfrev if by-reference is safe.",
     NULL
   )),
   # undesirable_function_linter(modify_defaults(

.ci/atime/tests.R

@@ -277,5 +277,14 @@ test.list <- atime::atime_test_list(
     Slow = "73d79edf8ff8c55163e90631072192301056e336",   # Parent of the first commit in the PR (https://github.com/Rdatatable/data.table/commit/8397dc3c993b61a07a81c786ca68c22bc589befc)
     Fast = "8397dc3c993b61a07a81c786ca68c22bc589befc"),  # Commit in the PR (https://github.com/Rdatatable/data.table/pull/7019/commits) that removes inefficiency
 
+  "isoweek improved in #7144" = atime::atime_test(
+    setup = {
+      set.seed(349)
+      x = sample(Sys.Date() - 0:5000, N, replace=TRUE)
+    },
+    expr = data.table::isoweek(x),
+    Slow = "548410d23dd74b625e8ea9aeb1a5d2e9dddd2927",   # Parent of the first commit in the PR (https://github.com/Rdatatable/data.table/commit/548410d23dd74b625e8ea9aeb1a5d2e9dddd2927)
+    Fast = "c0b32a60466bed0e63420ec105bc75c34590865e"),  # Commit in the PR (https://github.com/Rdatatable/data.table/pull/7144/commits) that uses a much faster implementation
+
     tests=extra.test.list)
 # nolint end: undesirable_operator_linter.

.ci/linters/md/news_linter.R …rs/md/news_github_link_mismatch_linter.R.ci/linters/md/news_linter.R renamed to .ci/linters/md/news_github_link_mismatch_linter.R .ci/linters/md/news_linter.R renamed to .ci/linters/md/news_github_link_mismatch_linter.R

@@ -1,32 +1,6 @@
-# ensure that numbered list in each section is in sequence
-check_section_numbering = function(news) {
-  if (!grepl("NEWS", news)) return(invisible())
-  news = readLines(news)
-  # plain '#' catches some examples; 'd' for 'data.table'
-  sections = grep("^#+ [A-Zd]", news)
-  entries = grep("^[0-9]+[.]", news)
-  entry_value = as.integer(gsub("^([0-9]+)[.].*", "\\1", news[entries]))
-  section_id = findInterval(entries, sections)
-
-  any_mismatch = FALSE
-  for (id in unique(section_id)) {
-    section_entries = entry_value[section_id == id]
-    intended_value = seq_along(section_entries)
-    matched = section_entries == intended_value
-    if (all(matched)) next
-    any_mismatch = TRUE
-    section_header = news[sections[id]]
-    cat(sprintf(
-      "In section '%s' (line %d), bad numbering:\n%s\n",
-      section_header, sections[id],
-      paste0("  [", section_entries[!matched], " --> ", intended_value[!matched], "]", collapse="\n")
-    ))
-  }
-  stopifnot("Please fix the NEWS issues above" = !any_mismatch)
-}
-
 # ensure that GitHub link text & URL actually agree
-check_gh_links = function(news) {
+news_github_link_mismatch_linter = function(news) {
+  if (!grepl("NEWS", news)) return(invisible())
   news = readLines(news)
   gh_links_info = gregexpr(
     "\\[#(?<md_number>[0-9]+)\\]\\(https://github.com/Rdatatable/data.table/(?<link_type>[^/]+)/(?<link_number>[0-9]+)\\)",

.ci/linters/md/news_section_numbering_linter.R

@@ -0,0 +1,26 @@
+# ensure that numbered list in each section is in sequence
+news_section_numbering_linter = function(news) {
+  if (!grepl("NEWS", news)) return(invisible())
+  news = readLines(news)
+  # plain '#' catches some examples; 'd' for 'data.table'
+  sections = grep("^#+ [A-Zd]", news)
+  entries = grep("^[0-9]+[.]", news)
+  entry_value = as.integer(gsub("^([0-9]+)[.].*", "\\1", news[entries]))
+  section_id = findInterval(entries, sections)
+
+  any_mismatch = FALSE
+  for (id in unique(section_id)) {
+    section_entries = entry_value[section_id == id]
+    intended_value = seq_along(section_entries)
+    matched = section_entries == intended_value
+    if (all(matched)) next
+    any_mismatch = TRUE
+    section_header = news[sections[id]]
+    cat(sprintf(
+      "In section '%s' (line %d), bad numbering:\n%s\n",
+      section_header, sections[id],
+      paste0("  [", section_entries[!matched], " --> ", intended_value[!matched], "]", collapse="\n")
+    ))
+  }
+  stopifnot("Please fix the NEWS issues above" = !any_mismatch)
+}

.ci/linters/md/heading_id_linter.R …/linters/md/vignette_heading_id_linter.R.ci/linters/md/heading_id_linter.R renamed to .ci/linters/md/vignette_heading_id_linter.R .ci/linters/md/heading_id_linter.R renamed to .ci/linters/md/vignette_heading_id_linter.R

@@ -1,6 +1,6 @@
 # ensure that ids are limited to alphanumerics and dashes
 # (in particular, dots and underscores break the links)
-check_header_ids = function(md) {
+vignette_heading_id_linter = function(md) {
   if (!grepl('[.]Rmd$', md)) return(invisible())
   md = readLines(md)
   # A bit surprisingly, some headings don't start with a letter.

.ci/linters/r/eval_parse_linter.R

@@ -0,0 +1,8 @@
+eval_parse_linter = make_linter_from_xpath(
+  "//SYMBOL_FUNCTION_CALL[text() = 'parse']
+     /ancestor::expr
+     /preceding-sibling::expr[SYMBOL_FUNCTION_CALL[text() = 'eval']]
+     /parent::expr
+  ",
+  "Avoid eval(parse()); build the language directly, possibly using substitute2()."
+)

.ci/linters/rd/backtick_linter.R

@@ -0,0 +1,22 @@
+# ensure no markdown-style backticks wind up in Rd where \code is intended
+options_documentation_linter = function(rd_file) {
+  rd = tools::parse_Rd(rd_file)
+
+  error_if_backtick = function(rd_obj) {
+    if (!is.recursive(rd_obj)) {
+      if (any(grepl("`", rd_obj, fixed=TRUE))) {
+        stop(sprintf(
+          "Rd is not markdown -- backticks (`) don't render as code! Use \\code{...}.\nObserved in string '%s' in file %s",
+          trimws(rd_obj), rd_file
+        ))
+      }
+      return(invisible())
+    }
+    tags = vapply(rd_obj, \(x) attr(x, "Rd_tag") %||% "", FUN.VALUE="")
+     # backtick is valid inside R code (e.g. \examples, \code, \preformatted)
+    rd_obj = rd_obj[!tags %in% c("RCODE", "VERB")]
+    lapply(rd_obj, error_if_backtick)
+  }
+
+  invisible(error_if_backtick(rd))
+}

.ci/linters/rd/condition_class_docs_check.R

@@ -0,0 +1,51 @@
+# Ensure that data.table condition classes in code match documentation
+condition_classes_documentation_linter = function(rd_file) {
+  if (!grepl("\\name{data.table-condition-classes}", readChar(rd_file, 100L), fixed = TRUE)) return(invisible())
+
+  # Find condition classes in R code 
+  walk_r_ast_for_classes = function(expr) {
+    if (is.call(expr) && is.name(e <- expr[[1L]]) && as.character(e) %in% c("stopf", "warningf", "messagef", "packageStartupMessagef") && is.character(class_arg <- expr[["class"]]) && startsWith(class_arg, "dt_")) {
+      class_arg
+    } else if (is.recursive(expr)) {
+      unlist(lapply(expr, walk_r_ast_for_classes))
+    }
+  }
+
+  # Find condition classes in documentation  
+  walk_rd_ast_for_classes = function(rd_element) {
+    if (!is.list(rd_element)) return(character())
+
+    result = character()
+    if (isTRUE(attr(rd_element, "Rd_tag") == "\\code") && length(rd_element) >= 1L) {
+      content = rd_element[[1L]]
+      if (is.character(content) && startsWith(content, "dt_")) {
+        result = content
+      }
+    }
+    c(result, unlist(lapply(rd_element, walk_rd_ast_for_classes)))
+  }
+
+  code_classes = list.files("R", pattern = "\\.R$", full.names = TRUE) |>
+    lapply(\(f) lapply(parse(f), walk_r_ast_for_classes)) |>
+    unlist() |>
+    unique()
+
+  doc_classes = rd_file |>
+    tools::parse_Rd() |>
+    walk_rd_ast_for_classes() |>
+    unique()
+
+  miss_in_doc = setdiff(code_classes, doc_classes)
+  miss_in_code = setdiff(doc_classes, code_classes)
+
+  if (length(miss_in_doc) > 0L || length(miss_in_code) > 0L) {
+    if (length(miss_in_doc) > 0L) {
+      cat(sprintf("Condition classes in code but missing from docs: %s\n", toString(miss_in_doc)))
+    }
+    if (length(miss_in_code) > 0L) {
+      cat(sprintf("Condition classes in docs but not in code: %s\n", toString(miss_in_code)))
+    }
+    stop("Please sync man/datatable-condition-classes.Rd with code condition classes")
+  }
+}
+