Merge pull request #76 from metrumresearchgroup/fix/split_long_rows

Fix: `split_long_rows` when no mappings occur

Author: barrettk

.github/workflows/main.yaml

@@ -35,6 +35,9 @@ jobs:
           r-version: ${{ matrix.config.r }}
           use-public-rspm: true
           extra-repositories: 'https://mpn.metworx.com/snapshots/stable/${{ env.MPN_LATEST }}'
+      - name: Install additional system dependencies
+        shell: bash
+        run: sudo apt-get install libpoppler-cpp-dev
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: |
@@ -61,6 +64,9 @@ jobs:
           r-version: release
           use-public-rspm: true
           extra-repositories: 'https://mpn.metworx.com/snapshots/stable/${{ env.MPN_LATEST }}'
+      - name: Install additional system dependencies
+        shell: bash
+        run: sudo apt-get install libpoppler-cpp-dev
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: any::pkgpub

R/format-report.R

@@ -818,12 +818,17 @@ split_long_rows <- function(exported_func_df, n = 40) {
     # Expand each row if any of the splits are greater than 1
     dplyr::group_split() %>%
     purrr::map_dfr(function(row_data) {
-      n_chunks <- max(length(row_data$code_file_split[[1]]),
-                      length(row_data$documentation_split[[1]]),
-                      length(row_data$test_files_split[[1]]))
+      n_chunks <- max(
+        length(row_data$code_file_split[[1]]),
+        length(row_data$documentation_split[[1]]),
+        length(row_data$test_files_split[[1]]),
+        # Ensure the minimum value is at least 1
+        # i.e. when columns code_file, documentation, and test_files are all empty
+        1
+      )
 
       # Create a list of new rows
-      purrr::map_dfr(1:n_chunks, function(i) {
+      purrr::map_dfr(seq_len(n_chunks), function(i) {
         new_row <- row_data
 
         # Extract split contents or default to an empty string

tests/testthat/test-format-report.R

@@ -215,6 +215,37 @@ describe("formatting functions", {
     expect_true(all(grepl(paste(81:100, collapse = "|"), strsplit(exported_func_df[3,]$`Test Files`, "\n")[[1]])))
   })
 
+  it("split_long_rows", {
+    # Other formatting is done in format_traceability_matrix before
+    # split_long_rows is called. Integration test will suffice
+    mock_exports_df <- tibble::tibble(
+      exported_function = "example_func",
+      code_file = list("R/example_func.R"),
+      documentation = list("man/example_func.Rd"),
+      test_files = list(rep("test-example_func.R", 60)),
+      test_dirs = list(NULL)
+    )
+
+    mock_exports_flex <- format_traceability_matrix(mock_exports_df)
+    mock_exports_split <- tibble::as_tibble(mock_exports_flex$body$dataset)
+    expect_equal(
+      mock_exports_split$`Exported Function`,
+      c("example_func", "example_func (cont.)")
+    )
+    # Default cutoff for making a new export is 40, so there should be 39 rows
+    expect_equal(stringr::str_count(mock_exports_split$`Test Files`[1], "\n"), 39)
+
+    # Regression test: works when other columns are empty
+    # - This occurred when columns `code_file`, `documentation`, and `test_files`
+    #   were _all_ empty
+    mock_exports_df$code_file <- list(NA_character_)
+    mock_exports_df$documentation <- list(NA_character_)
+    mock_exports_df$test_files <- list(NA_character_)
+    mock_exports_flex <- format_traceability_matrix(mock_exports_df)
+    mock_exports_split <- tibble::as_tibble(mock_exports_flex$body$dataset)
+    expect_equal(mock_exports_split$`Exported Function`, "example_func")
+  })
+
   it("format_appendix", {
     pkg_setup_select <- pkg_dirs$pkg_setups_df %>% dplyr::filter(pkg_type == "pass_success")
     result_dir_x <- pkg_setup_select$pkg_result_dir