Change line_id to line

Author: olivroy

R/outline-criteria.R

@@ -158,7 +158,7 @@ define_outline_criteria <- function(.data, print_todo) {
   )
   x <- dplyr::mutate(
     x,
-    before_and_after_empty = line_id == 1 | !nzchar(dplyr::lead(content, default = "")) & !nzchar(dplyr::lag(content)),
+    before_and_after_empty = line == 1 | !nzchar(dplyr::lead(content, default = "")) & !nzchar(dplyr::lag(content)),
     .by = file
   )
   x

R/outline.R

@@ -122,14 +122,14 @@ file_outline <- function(pattern = NULL,
     file_content <- rlang::set_names(path)
     # Not warn
     file_content <- purrr::map(file_content, function(x) readLines(fs::path_real(x), encoding = "UTF-8", warn = FALSE))
-    # Combine everything into a tibble that contains file, line_id, content
-    file_content <- purrr::map(file_content, function(x) tibble::enframe(x, name = "line_id", value = "content"))
+    # Combine everything into a tibble that contains file, line, content
+    file_content <- purrr::map(file_content, function(x) tibble::enframe(x, name = "line", value = "content"))
     file_content <- dplyr::bind_rows(file_content, .id = "file")
   } else {
     file_content <-
       purrr::map(
         .x = list("unsaved-doc.R" = rstudioapi::getSourceEditorContext()$contents),
-        .f = function(x) tibble::enframe(x, name = "line_id", value = "content")
+        .f = function(x) tibble::enframe(x, name = "line", value = "content")
       )
     file_content <- dplyr::bind_rows(file_content, .id = "file")
   }
@@ -365,7 +365,7 @@ print.outline_report <- function(x, ...) {
       link = list(rlang::set_names(
         link_rs_api,
         purrr::map_chr(
-          paste0("{.file ", file, ":", line_id, "}"),
+          paste0("{.file ", file, ":", line, "}"),
           cli::format_inline
         )
       )),
@@ -507,19 +507,19 @@ display_outline_element <- function(.data) {
   y <- dplyr::mutate(
     x,
     has_title_el =
-      ((line_id == 1 & !is_todo_fixme & !is_test_name & !is_snap_file) |
+      ((line == 1 & !is_todo_fixme & !is_test_name & !is_snap_file) |
         (is_doc_title & !is_subtitle & !is_snap_file & !is_second_level_heading_or_more)) & !is_news,
     .by = "file"
   )
   y <- withCallingHandlers(
     dplyr::mutate(y,
-      title_el_line = ifelse(has_title_el, line_id[
-        (line_id == 1 & !is_todo_fixme & !is_test_name & !is_snap_file) |
+      title_el_line = ifelse(has_title_el, line[
+        (line == 1 & !is_todo_fixme & !is_test_name & !is_snap_file) |
           (is_doc_title & !is_subtitle & !is_snap_file & !is_second_level_heading_or_more)
       ][1], # take  the first element to avoid problems (may be the reason why problems occur)
       NA_integer_
       ),
-      title_el = outline_el[line_id == title_el_line],
+      title_el = outline_el[line == title_el_line],
       .by = "file"
     ),
     error = function(e) {
@@ -529,7 +529,7 @@ display_outline_element <- function(.data) {
   )
   y <- dplyr::relocate(
     y,
-    "outline_el", "line_id", "title_el", "title_el_line", "has_title_el",
+    "outline_el", "line", "title_el", "title_el_line", "has_title_el",
     .after = "content"
   )
 
@@ -595,7 +595,7 @@ construct_outline_link <- function(.data, is_saved_doc, dir_common, pattern) {
     as.character(trim_outline(.data$outline_el[cn], width - 8L)),
     "- {.run [Done{cli::symbol$tick}?](reuseme::complete_todo(",
     # Removed ending dot. (possibly will fail with older versions)
-    .data$line_id[cn], ", '", .data$file[cn], "', '",
+    .data$line[cn], ", '", .data$file[cn], "', '",
     # modify regex twice if needed (see below)
     stringr::str_sub(stringr::str_replace_all(.data$content[cn], "\\^|\\$|'|\\{|\\}|\\)|\\(|\\[\\]|\\+", "."), start = -15L), "'))}",
     .data$rs_version[cn]
@@ -617,7 +617,7 @@ construct_outline_link <- function(.data, is_saved_doc, dir_common, pattern) {
         # Removed ending dot. (possibly will fail with older versions)
 
         # modify regex twice if needed (see above)
-        line_id, ", '", file, "', '", stringr::str_sub(stringr::str_replace_all(content, "\\^|\\$|'|\\{|\\}|\\)|\\(|\\[\\]|\\+", "."), start = -15L), "'))}",
+        line, ", '", file, "', '", stringr::str_sub(stringr::str_replace_all(content, "\\^|\\$|'|\\{|\\}|\\)|\\(|\\[\\]|\\+", "."), start = -15L), "'))}",
         rs_version
       ),
       outline_el2
@@ -626,7 +626,7 @@ construct_outline_link <- function(.data, is_saved_doc, dir_common, pattern) {
   )
 
   .data <- dplyr::mutate(.data,
-    link = paste0(outline_el2, " {.path ", file, ":", line_id, "}"),
+    link = paste0(outline_el2, " {.path ", file, ":", line, "}"),
     # rstudioapi::documentOpen works in the visual mode!! but not fully.
     file_path = .data$file,
     is_saved_doc = .env$is_saved_doc,
@@ -646,15 +646,15 @@ construct_outline_link <- function(.data, is_saved_doc, dir_common, pattern) {
   }
 
   dplyr::mutate(.data,
-    # link_rs_api = paste0("{.run [", outline_el, "](reuseme::open_rs_doc('", file_path, "', line = ", line_id, "))}"),
+    # link_rs_api = paste0("{.run [", outline_el, "](reuseme::open_rs_doc('", file_path, "', line = ", line, "))}"),
     link_rs_api = dplyr::case_when(
       is.na(outline_el2) ~ NA_character_,
-      !is_saved_doc ~ paste0("line ", line_id, " -", outline_el2),
+      !is_saved_doc ~ paste0("line ", line, " -", outline_el2),
       rs_avail_file_link ~ paste0(
         "{cli::style_hyperlink(", style_fun, ', "',
-        paste0("file://", file_path), '", params = list(line = ', line_id, ", col = 1))} ", outline_el2
+        paste0("file://", file_path), '", params = list(line = ', line, ", col = 1))} ", outline_el2
       ),
-      .default = paste0(rs_version, "{.run [i](reuseme::open_rs_doc('", file_path, "', line = ", line_id, "))} ", outline_el2)
+      .default = paste0(rs_version, "{.run [i](reuseme::open_rs_doc('", file_path, "', line = ", line, "))} ", outline_el2)
     ),
     file_hl = dplyr::case_when(
       !is_saved_doc ~ file_path,

R/use-todo.R

@@ -66,7 +66,7 @@ use_todo <- function(todo, proj = proj_get2(), code = FALSE) {
 #' Function meant to be wrapped as `{.run}` hyperlinks with [file_outline()].
 #' It basically removes a line from a file.
 #'
-#' @param line_id The line number (a single integer)
+#' @param line The line number (a single integer)
 #' @param file Path to a file
 #' @param regexp A regexp to assess that the file content has not changed.
 #' @param rm_line A logical If `NULL` will remove the full line in the file
@@ -77,18 +77,18 @@ use_todo <- function(todo, proj = proj_get2(), code = FALSE) {
 #'   content invisibly.
 #' @export
 #' @keywords internal
-complete_todo <- function(line_id, file, regexp, rm_line = NULL) {
+complete_todo <- function(line, file, regexp, rm_line = NULL) {
   check_string(regexp)
-  check_number_whole(line_id)
-  line_id_original <- line_id
+  check_number_whole(line)
+  line_original <- line
   # to defer warning.
   if (interactive() && rstudioapi::isAvailable()) {
     rstudioapi::documentSaveAll()
   }
   warn_change_of_line <- FALSE
 
   file_content <- readLines(file, encoding = "UTF-8")
-  line_content <- file_content[line_id]
+  line_content <- file_content[line]
 
   # Special case for issues (probably need to opt out at some point)
   # patch that will likely not work for many cases.
@@ -105,8 +105,8 @@ complete_todo <- function(line_id, file, regexp, rm_line = NULL) {
     warn_change_of_line <- TRUE
 
     if (length(regexp_detection) == 1) {
-      line_id <- regexp_detection
-      line_content <- line_content <- file_content[line_id]
+      line <- regexp_detection
+      line_content <- line_content <- file_content[line]
       detect_regexp_in_line <- grepl(pattern = regexp, x = line_content)
     } else if (length(regexp_detection) > 1) {
       cli::cli_abort(c(
@@ -121,12 +121,12 @@ complete_todo <- function(line_id, file, regexp, rm_line = NULL) {
     }
   }
 
-  tag_type <- extract_tag_in_text(text = line_content, line_id)
+  tag_type <- extract_tag_in_text(text = line_content, line)
 
   if (warn_change_of_line) {
     cli::cli_warn(c(
       x = "Could not find {.arg regexp} as expected",
-      "Could not find {.val {regexp}} at line {line_id_original}.",
+      "Could not find {.val {regexp}} at line {line_original}.",
       i = "Has the file content changed since you ran this code?",
       # needs qty for cli pluralization, but no printing
       "`regexp` was detected in {cli::qty(length(regexp_detection))} line{?s} {regexp_detection}."
@@ -152,18 +152,18 @@ complete_todo <- function(line_id, file, regexp, rm_line = NULL) {
     regex_new <- cli::style_strikethrough(regex)
     line_content_show <- stringr::str_replace(line_content_show, regex, regex_new)
   }
-  file_line <- paste0(file, ":", line_id)
+  file_line <- paste0(file, ":", line)
   cli::cli_alert_success(
     "Removed {.code {line_content_show}} from {.file {file_line}}!"
   )
   # Rem
   line_content_new <- strip_todo_line(line_content, only_rm_tag = !rm_line)
 
   if (nzchar(line_content_new)) {
-    file_content[line_id] <- line_content_new
+    file_content[line] <- line_content_new
     file_content_new <- file_content
   } else {
-    file_content_new <- file_content[-line_id]
+    file_content_new <- file_content[-line]
     if (!rm_line) {
       # WIll remove this line eventually
       # remove line if it ends up empty. not supposed to happen

man/complete_todo.Rd

@@ -1,13 +1,13 @@
 # Marking a TODO item as done works
 
     Code
-      complete_todo(line_id = 1, file = tmp, regexp = "I Want this done")
+      complete_todo(line = 1, file = tmp, regexp = "I Want this done")
     Condition
       Error in `complete_todo()`:
       x Could not delete the TODO item.
       i Line 1 does not contain any "WORK", "FIXME", or "TODO" tags.
     Code
-      complete_todo(line_id = 2, file = tmp)
+      complete_todo(line = 2, file = tmp)
     Condition
       Error in `complete_todo()`:
       ! `regexp` must be a single string, not absent.

tests/testthat/_snaps/use-todo.md

@@ -46,20 +46,20 @@ test_that("Marking a TODO item as done works", {
   # tmp still has 7 lines
   expect_snapshot(error = TRUE, {
     # Can't delete the first line as it doesn't contain a TODO item
-    complete_todo(line_id = 1, file = tmp, regexp = "I Want this done")
+    complete_todo(line = 1, file = tmp, regexp = "I Want this done")
     # Try to delete TODO item at line 2 without providing the regexp for safeguard
-    complete_todo(line_id = 2, file = tmp)
+    complete_todo(line = 2, file = tmp)
   })
   # Deleting the TODO item line completely (tmp now has 4 lines)
   expect_complete_todo(
-    complete_todo(line_id = 2, file = tmp, regexp = "item to delete")
+    complete_todo(line = 2, file = tmp, regexp = "item to delete")
   )
   # Deleting the work tag (on new line 2), but keeping the comment.
   # Will throw a warning for now.
 
   expect_complete_todo(
     out <- complete_todo(
-      line_id = 4,
+      line = 4,
       file = tmp,
       regexp = "Explain what the next code does"
     ),
@@ -71,7 +71,7 @@ test_that("Marking a TODO item as done works", {
   )
   expect_complete_todo(
     out <- complete_todo(
-      line_id = 4,
+      line = 4,
       file = tmp,
       regexp = "ethisissues1890"
     ),
@@ -101,5 +101,5 @@ test_that("use_todo() global works", {
     suppressMessages(path <- use_todo("global::it is time"))
   )
   line_to_delete <- length(readLines(path, encoding = "UTF-8"))
-  suppressMessages(complete_todo(file = path, regexp = "it is time", line_id = line_to_delete, rm_line = TRUE))
+  suppressMessages(complete_todo(file = path, regexp = "it is time", line = line_to_delete, rm_line = TRUE))
 })