Line break before function() provoke unexpected problem

[pwaeckerle]

Criteria of validation

All the below cases are tested with a specific flat test file: https://github.com/ThinkR-open/fusen/blob/main/inst/tests-templates/dev-template-function-name-linebreak.Rmd

The use of the following codes in a flat file do not affect the correct detection of the function real name :

• linebreak, roxygen before

#' fake_name
real_name <- 
   function()

• linebreak, comment before

#' fake_name
# a comment
real_name <- 
function()

• comment between name and linebreak

#' fake_name
real_name <- # a comment
function()

• commented line between name and linebreak

#' fake_name
real_name <- 
# a comment
function()

• linebreak, nothing before

real_name <- 
   function()

• no linebreak, comment before

#' fake_name
# a comment
real_name <- function()

• no linebreak, code before

sqrt(1)
real_name <- function()

• no linebreak, nothing before

real_name <- function()

• linebreak, roxygen before, symbol "="

#' fake_name
real_name  =
   function()

Technical

Proposition 1 : detect the 1st assignment arrow in the code that is not in a comment or a roxygen
Propostion 2 : combine the line above in paste(line_before, line). A line break turns into a space, and there is no risk of catching a different name

• Create a new test Rmd file there to create the problem (the different code snippets to be validated) : https://github.com/ThinkR-open/fusen/tree/main/inst/tests-templates
• Add a new unit test in https://github.com/ThinkR-open/fusen/blob/main/tests/testthat/test-inflate-part2.R
• Debug the source of the function
  • the problem is in parse_fun(), which uses this regex for each single line:

    fusen/R/inflate-utils.R

    Line 18 in bc84590

    regex_extract_fun_name <- paste(

---

Problem description

When adding a line break between the affectation sign and the function keyword, fusen does not handle correctly the flat file content.

This line break can be added by the user, but more surely by the RStudio reformat shortcut.

fusen shows warning messages that alerts the user :

Updating mypkg documentation
ℹ Loading mypkg
Warning: [/home/rstudio/mypkg/R/my-function.R:8] @examples requires a value
Writing NAMESPACE
Writing NAMESPACE
Writing debug_fusen.Rd

In the output, the vignette is created as expected but the .R file has the name of the makdown title above the function description in the flat file.

Reprex

Working example

I use a minimal flat file with the following function description and example (no test) :

# My function

```{r function-debug_fusen}
#' debug_fusen
#'
#' @return 1
#' @export
#'
#' @examples
debug_fusen <- function() {
  1
}

debug_fusen()

When inflating, we have : a debug_fusen.R file in R\ and a vignette corresponding to the vignette_name attribute in the fusen::inflate() call.

Not working example

The same cas as below, with the simple addition of a line break before function :

# My function

```{r function-debug_fusen}
#' debug_fusen
#'
#' @return 1
#' @export
#'
#' @examples
debug_fusen <- 
  function() {
  1
}

debug_fusen()

When doing the inflate, we have :

• Warning message (see above) regarding the absence of a function example,
• The vignette updated (still well located thanks to the filename argument),
• a my_function.R file created with no example in it.

[FlorenceMounier]

Problem:
in R/inflate-utils.R, parsermd::rmd_node_code() splits code by reading line breaks (1 value = 1 line).

Proposal:
add a new regex that would detect the pattern "<-" in "my_fun <- " and bind this value with the value returned by the regex regex_isfunction that detects the value " function() {"

[statnmap]

That should be good now.
Merged in: #186
Please tell us if your face again the problem