Skip to content

Refactor/client helpers - #730

Merged
timcadman merged 3 commits into
v7.0-devfrom
refactor/client-helpers
Nov 13, 2026
Merged

timcadman merged 3 commits into
v7.0-devfrom
refactor/client-helpers

Conversation

@timcadman

@timcadman timcadman commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Aim of this PR is to refactor error message handling such that, where possible, helper functions handle errors (e.g. argument checks). This means we can then specify the wording in a small number of places and reuse across the package, rather than repeating in every function. This will increase consistency and also maintainability, as if we ever want to change the wording we only need to do it in one place.

This PR does the refactor, the next PR will update the error message handling to use CLI, which gives a more professional look

What's change

  • All helper functions now written in camelCase
  • Where the same check was repeated and rewritten >= 2 times, this was refactored into a separate helper function
  • For some functions errors were returned as messages with 'error' prefixed at the start of the message -this has been changed to throw and error with cli_abort

@timcadman
timcadman changed the base branch from v6.3.6-dev to v7.0-dev November 2, 2026 11:32
@github-actions

github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
⏳ 4 of 5 checks reported so far
CheckResult
Devtools checks✅ passed
Code quality✅ 0 new findings (package total: 1901)
Armadillo unit tests✅ [ FAIL 0 | WARN 0 | SKIP 21 | PASS 11825 ]
Opal unit tests✅ [ FAIL 0 | WARN 0 | SKIP 21 | PASS 11199 ]
Test coverageℹ️ no coverable lines changed (project: 68.6%)

Tested against dsBase versions:
Armadillo: 7.0.0.9000
Opal: 7.0.0.9000

Logs: Devtools checks · Code quality · Armadillo unit tests · Opal unit tests · Codecov

Comment thread R/ds.table.R Fixed
Comment thread R/utils.R Fixed
@timcadman
timcadman marked this pull request as ready for review November 5, 2026 08:57
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.64%. Comparing base (b88f471) to head (a815ce3).
⚠️ Report is 14 commits behind head on v7.0-dev.

Additional details and impacted files
@@              Coverage Diff              @@
##           v7.0-dev     #730       +/-   ##
=============================================
+ Coverage     47.55%   68.64%   +21.08%     
=============================================
  Files           131      131               
  Lines          5076     4685      -391     
=============================================
+ Hits           2414     3216      +802     
+ Misses         2662     1469     -1193     
Flag Coverage Δ
armadillo-arg 18.84% <ø> (-1.74%) ⬇️
armadillo-misc 19.57% <ø> (+1.72%) ⬆️
armadillo-perf-1 11.46% <ø> (+0.86%) ⬆️
armadillo-perf-2 20.74% <ø> (+1.44%) ⬆️
armadillo-perf-3 19.38% <ø> (?)
armadillo-smk-1 43.79% <ø> (?)
armadillo-smk-2 37.82% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@StuartWheater StuartWheater left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Updates appear to be consistent, now .checkArgsProvider

@timcadman
timcadman merged commit 3bb4a0a into v7.0-dev Nov 13, 2026
100 of 119 checks passed
@timcadman
timcadman deleted the refactor/client-helpers branch November 13, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants