43 decouple@main

[Polkas]

closes #43

Decouple metadata in the ReportCard. It is needed e.g. to support the new format method in the FilteredData class.

append_fs is expected to consume a FilteredData object now. Thus we could use the new format method.
I do not want to add teal.slice dependency so I created an artificial object for test/example purposes.

[github-actions]

Unit Tests Summary

    1 files    15 suites   6s ⏱️
131 tests 131 ✔️ 0 💤 0 ❌
181 runs  181 ✔️ 0 💤 0 ❌

Results for commit 87fe53a.

♻️ This comment has been updated with latest results.

[github-actions]

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  ---------------------------------------------
R/AddCardModule.R        82       3  96.34%   73-75
R/ContentBlock.R         16       0  100.00%
R/DownloadModule.R      137      24  82.48%   76-78, 99, 156-160, 163-167, 174-178, 181-185
R/NewpageBlock.R          2       0  100.00%
R/PictureBlock.R         31       0  100.00%
R/Previewer.R           215      11  94.88%   158, 160-163, 168-174
R/Renderer.R             54       4  92.59%   142, 144-145, 166
R/ReportCard.R           30       1  96.67%   138
R/Reporter.R             43       0  100.00%
R/ResetModule.R          45       0  100.00%
R/SimpleReporter.R       18       0  100.00%
R/TableBlock.R            9       0  100.00%
R/TealReportCard.R       12       0  100.00%
R/TextBlock.R             7       0  100.00%
R/yaml_utils.R           74       2  97.30%   65, 263
TOTAL                   775      45  94.19%

Results for commit: 2ca8d9a

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[Polkas]

@kpagacz and @mhallal1 I will be glad to get your feedback. I understand that we have consensus here now.

[Polkas]

Do we want to transfer TealReportCard to teal here too (here remove it), as we talked.

[mhallal1]

I am happy with the decoupling, I will approve it if @kpagacz has no additional comments.

[kpagacz]

Can this have duplicated keys?

[Polkas]

no, because of key %in% names(private$metadata)

   append_metadata = function(key, value) {
      checkmate::assert_character(key, min.len = 0, max.len = 1)
      checkmate::assert_false(key %in% names(private$metadata))

[kpagacz]

LGTM!