Skip to contents

artutils 0.15.0

Documentation & Code Cleanup Release

This release focuses on documentation improvements, removal of demo mode guards, test cleanup, file reorganization, and codebase hygiene.

BREAKING CHANGES

IMPROVEMENTS

  • Database File Reorganization
  • Test Reorganization
    • Created test-db-interface.R with live database tests for read operations
    • Updated test-db-modify.R to only contain data modification tests (mocked)
    • Added artHasNFT test to test-db-artwork.R
    • Read-only tests use live database queries; write operations use mocks
  • Roxygen Documentation Quality
    • Updated function titles to explain WHY (not just WHAT) for all exported functions
    • Reference index now shows actionable descriptions like “Resolve URL slug to artist profile for page routing”
    • Topic pages (@name blocks) use @keywords internal to prevent duplicate entries in reference
  • pkgdown Reference Organization
    • Topic pages no longer appear as separate entries in the reference index
    • Functions grouped cleanly by family without organizational noise

BUG FIXES

  • Fixed is_collection_visible() calling undefined get_artist_preferences() - replaced with inline database query
  • Fixed R CMD check notes for unused imports (rlang, shiny removed from Imports)
  • Added @importFrom lifecycle badge to properly import lifecycle package

REMOVED

  • Stub Files Deleted
    • R/calcArtworkBenchmarks.R - was just a redirect comment
    • R/settings-artist-prefs.R - was just a redirect comment
    • R/settings-visibility.R - empty topic page with no functions
  • Internal Function Tests Removed
    • Removed tests for .calc_benchmarks() and .parseBenchmarkRow() from test-benchmarks.R
    • Internal functions (prefixed with .) are not tested directly
    • Benchmark functionality tested via public updateArtistBenchmarks()

INTERNAL

  • Code coverage: 59.61%
    • db-artwork.R: 100%
    • db-frame-analytics.R: 100%
    • db-interface.R: 100%
    • getImageRaster.R: 100%
    • db-artist.R: 89%
    • app-data.R: 87%

DEPENDENCIES

  • Removed rlang and shiny from Imports (only used in .dev/ files)
  • Removed unused rdstools references from demo mode guards