Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document and clean up helper modules #474

Merged
merged 27 commits into from
Aug 26, 2024
Merged

Document and clean up helper modules #474

merged 27 commits into from
Aug 26, 2024

Conversation

spohlenz
Copy link
Member

This PR encompasses an overhaul of the Trestle helpers, particularly in regards to documentation. Comments have been added to most helpers intended for public use.

In addition it:

  • Added some missing specs for helper methods
  • Improved usage of kwargs options where appropriate
  • Updated to tag.foo format over legacy content_tag
  • Some minor cleanup and reorganization of helper modules
    • Removed turbo_stream_update_flash helper (use turbo_stream.flash instead)
    • Removed separate format_value_from_options method
    • Extracted Gravatar helpers into separate module

@spohlenz
Minimize mocking in FormatHelper spec
632ca14
@spohlenz
Add spec for IconHelper
27a22ce
@spohlenz
Add spec for StatusHelper
ae37144
@spohlenz
Update use of content_tag within helpers to use Rails' tag builder
3f4617a
@spohlenz
Add spec for CardHelper and use keyword arguments where appropriate
3aa995a
@spohlenz
Add spec for TimestampHelper and use keyword arguments where appropriate
a7f5de0
@spohlenz
Remove ActionView::Context from specs where not required
89e693e
@spohlenz
Add specs for Gravatar helpers and extract as own module
0a9cd7b
@spohlenz
Remove turbo_stream_update_flash helper
c989f89
@spohlenz
Use semantic tags within card helper and add comments
27663c8
@spohlenz
Add spec and docs for ContainerHelper
007147a
@spohlenz
Clean up table helper with kwargs
a1c841c
@spohlenz
Update Bootstrap URLs in GridHelper docs
1994bfb
@spohlenz
Add documentation for avatar, gravatar, heading and icon helpers
002eeaf
@spohlenz
Mark internal helper modules
cac08ce
@spohlenz
Minor reorganization of helper method locations
ce7a726
@spohlenz
Improve use of kwargs for sort_link helper
8a0b849
@spohlenz
Add spec and docs for ModalHelper
c3967b1
@spohlenz
Add docs for sort_link helper and fix kwargs forwarding from Column
163cc50
@spohlenz
Remove unneeded Rails version check in params helper specs
1e0c6c3
@spohlenz
Explicitly limit sort_options when calling sort_link for column header
6457102
@spohlenz
Clean up FormatHelper (remove separate format_value_from_options method)
f4bbdef
@spohlenz
Add spec and docs for FormHelper
c5d038c
@spohlenz
Use kwargs options for tabs
8810af9
@spohlenz
Use kwargs in admin_url_for helper
38d1549
@spohlenz
Add documentation for remaining public helpers
4c2be3c
@coveralls
Copy link

coveralls commented Aug 26, 2024 •
edited
Loading

Coverage Status

coverage: 91.463% (+0.8%) from 90.682%
when pulling 9805806 on helper-updates
into c2e8fe4 on main.

@spohlenz spohlenz merged commit 38c6118 into main Aug 26, 2024
41 checks passed
@spohlenz spohlenz deleted the helper-updates branch August 28, 2024 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@spohlenz @coveralls