Repository navigation
Improve Spree::Preferences constants and source code documentation - #6696
Merged
jarednorman merged 3 commits intoOct 23, 2026
Merged
jarednorman merged 3 commits into
jarednorman merged 3 commits into
Conversation
github-actions
Bot
added
the
changelog:solidus_core
benjaminwil
force-pushed
the
preference-documentation-improvements
branch
from
October 16, 2026 02:24
3bda527 to
5f00236
Compare
benjaminwil
changed the title
Spree::Prefrences constants and source code documentationSpree::Preferences constants and source code documentation
benjaminwil
force-pushed
the
preference-documentation-improvements
branch
from
October 16, 2026 03:59
5f00236 to
6b57fb1
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6696 +/- ##
=======================================
Coverage 92.46% 92.46%
=======================================
Files 1058 1058
Lines 21495 21495
=======================================
Hits 19875 19875
Misses 1620 1620 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
benjaminwil
marked this pull request as ready for review
October 16, 2026 04:36
tvdeyen
approved these changes
Oct 18, 2026
adammathys
approved these changes
Oct 19, 2026
benjaminwil
commented
Oct 19, 2026
| # @return [Array] | ||
| def allowed_admin_form_preference_types = Spree::Preferences::FORM_FIELD_TYPES | ||
| def allowed_admin_form_preference_types | ||
| Spree::Preferences::FORM_FIELD_TYPES.dup |
Contributor
Author
There was a problem hiding this comment.
After coming to this fresh today, I realized that this breaks current functionality in payment method extensions.
So I intend to drop this change.
I'll instead create a separate pull request to deprecate this method and make allowed form preference types a proper configuration point on Spree::AppConfiguration.
Contributor
Author
There was a problem hiding this comment.
To clarify: by "this change" I just mean the commit where I add the #dup call.
benjaminwil
force-pushed
the
preference-documentation-improvements
branch
from
October 19, 2026 22:17
6b57fb1 to
b2229c3
Compare
Member
|
Real failures on CI? |
Contributor
Author
|
@jarednorman Yeah, real. Merge conflict after #6695 was merged. Will fix this today. |
I found the old `DEFAULT_ADMIN_FORM_PREFERENCE_TYPES` constant to be a bit buried given how critical the information it contains is. (It's used across Solidus libraries for calculators, promotions, and payment methods.) It serves as better documentation as a part of the main `Spree::Preferences` class where the rest of the documentation for preferences live. This also clarify exactly what preferences are explicitly supported by Solidus. Before this, you had to dig through a case statement to see the full list.
While I was referring to the preferences documentation I found a lot of detail that muddied the purpose and usage instructions. This commit rewrites the docs and removes some superfluous and repeated docs. Hopefully this makes the documentation more maintainable over time. I also wanted to add explicit reference to preferences within the payment method class documentation. Hopefully this helps orient developers working on payment method integrations so that they understand better: - which preference types are built-in. - where the seams are for making admin-editable payment method records In subsequent commits, I will add additional documentation for where admin view components will be expected for applications using `solidus_admin`. There is only one preference to the legacy `preference_fields/` partials directory now, so there is now only one place to add references to the new admin's fields directory.
benjaminwil
force-pushed
the
preference-documentation-improvements
branch
from
October 20, 2026 19:33
b2229c3 to
e9a73d6
Compare
Contributor
Author
|
I amended a test assertion introduced when #6695 was merged. It was using one of the old constants that I removed in this pull request. No other changes. |
jarednorman
approved these changes
Oct 20, 2026
5 tasks done
Noah-Silvera
pushed a commit
to SuperGoodSoft/solidus
that referenced
this pull request
Nov 2, 2026
…tation-improvements Improve `Spree::Preferences` constants and source code documentation
5 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
While I have been building out payment method interfaces for the new
solidus_admingem, I had reason to dig into how preferences work. I needed to test that forms were working correctly against every supported preference type.I noticed that some of the documentation was unclear or could be improved.
I also noticed some constants related to
Spree::Preferencesfunctionality could be renamed to act as better documentation for these features, too.Checklist
Check out our PR guidelines for more details.
The following are mandatory for all PRs:
The following are not always needed: