{teal} module returns a teal_report object that extends from teal_data

[averissimo]

Pull Request

Fixes:

• [Question]: How to return report to teal? teal#1526

Built on top of:

• Redesign of teal.reporter Cards teal.reporter#307
  • (#307 will be closed once this PR is stable)

Companion PRs:

• {teal} module returns a teal_report object that extends from teal_data teal#1541
• {teal} module returns a teal_report object that extends from teal_data #255
• {teal} module returns a teal_report object that extends from teal_data teal.data#370
• {teal} module returns a teal_report object that extends from teal_data teal.reporter#331
• {teal} module returns a teal_report object that extends from teal_data teal.modules.general#884

Changes description

• Add new parameter cache
  • Caches the result of the last evaluation in the respective @code slot
  • Decide on name
• Remove signature with multiple arguments to allow overriding eval_code in other packages without showing a note

pkgload::load_all("teal.code")
#> ℹ Loading teal.code

q <- qenv() |> 
  eval_code(1 + 1, cache = TRUE) |> 
  eval_code(mtcars <- head(mtcars))

attr(q@code[[1]], "cache")
#> [1] 2

^{Created on 2025-06-03 with reprex v2.1.1}

[github-actions]

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  ---------
R/qenv-c.R                          55       0  100.00%
R/qenv-class.R                      12       0  100.00%
R/qenv-concat.R                      7       0  100.00%
R/qenv-constructor.R                 1       0  100.00%
R/qenv-errors.R                      4       4  0.00%    6-9
R/qenv-eval_code.R                  62       1  98.39%   40
R/qenv-extract.R                    30       0  100.00%
R/qenv-get_code.R                   24       0  100.00%
R/qenv-get_env.R                     3       1  66.67%   27
R/qenv-get_messages.r                5       0  100.00%
R/qenv-get_var.R                    26       0  100.00%
R/qenv-get_warnings.R                5       0  100.00%
R/qenv-join.R                        7       7  0.00%    137-151
R/qenv-length.R                      2       1  50.00%   2
R/qenv-show.R                       29      29  0.00%    19-50
R/qenv-within.R                      8       0  100.00%
R/utils-get_code_dependency.R      245       2  99.18%   160, 258
R/utils.R                           30       0  100.00%
TOTAL                              555      45  91.89%

Diff against main

Filename              Stmts    Miss  Cover
------------------  -------  ------  -------
R/qenv-eval_code.R        0      -1  +1.61%
TOTAL                     0      -1  +0.18%

Results for commit: c4bf214

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   13 suites   4s ⏱️
157 tests 154 ✅ 3 💤 0 ❌
245 runs  242 ✅ 3 💤 0 ❌

Results for commit c4bf214.

♻️ This comment has been updated with latest results.

[github-actions]

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
qenv_eval_code	💀	$0.01$	$-0.01$	Code_executed_with_integer_shorthand_1L_is_the_same_as_original
qenv_eval_code	👶		$+0.02$	eval_code_fails_with_code_not_being_language_nor_character
qenv_eval_code	💀	$0.01$	$-0.01$	eval_code_fails_with_unquoted_expression
qenv_eval_code	👶		$+0.00$	eval_code_ignores_empty_code
qenv_within	👶		$+0.01$	Code_executed_with_integer_shorthand_1L_is_the_same_as_original

Results for commit 5c19905

♻️ This comment has been updated with latest results.

[gogonzo]

LGTM 👍
@pawelru we removed this controversial argument. We keep only ... for future methods