Add deprecation path for arity-zero preference defaults #4170
Conversation
This file contains 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
houndci-bot
reviewed
Sep 15, 2021
Solidus 3.1 shipped with a new preferences system, where a default can take different values depending on the Solidus version defaults that have been loaded. See solidusio#4064 for details. To achieve those above, when a proc is given as the default value constructor, it now should take the loaded Solidus version as an argument. That's a breaking change, as some extensions or user-defined preferences may be using zero-arity lambdas. This commit deprecates zero-arity lambdas but wraps them into another lambda, taking and disregarding a single argument. That's only needed for procs with lambda semantics, as raw procs will ignore the provided extra argument. When it comes to the implementation, as it's something to be ditched in the next major release, we've opted for the more straightforward solution. I.e., wrapping the lambda into the `Preferable` module even if it only affects `AppConfiguration` classes. The default-handling logic is very entangled into the former, and it'd take more work to extract it. Fixes solidusio#4165
waiting-for-dev
force-pushed
the
waiting-for-dev/fix_preferences_arity
branch
from
ae0d908
to
5c7053d
Compare
kennyadsl
approved these changes
Sep 15, 2021
There was a problem hiding this comment.
Thanks @waiting-for-dev, we have to release a new patch after this is merged.
jarednorman
approved these changes
Sep 15, 2021
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Mar 28, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Mar 28, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Mar 28, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Mar 28, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 12, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 14, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 18, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 18, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 19, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
kennyadsl
added a commit
to nebulab/solidus
that referenced
this pull request
Apr 24, 2023
Instead of
preference :foo, :string, default: -> { true }
Do this:
preference :foo, :string, default: proc { true }
Ref solidusio#4170
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.
Description
Solidus 3.1 shipped with a new preferences system, where a default can
take different values depending on the Solidus version defaults that
have been loaded. See #4064 for details.
To achieve those above, when a proc is given as the default value
constructor, it now should take the loaded Solidus version as an
argument. That's a breaking change, as some extensions or user-defined
preferences may be using zero-arity lambdas.
This commit deprecates zero-arity lambdas but wraps them into another
lambda, taking and disregarding a single argument. That's only needed
for procs with lambda semantics, as raw procs will ignore the provided
extra argument.
When it comes to the implementation, as it's something to be ditched in
the next major release, we've opted for the more straightforward
solution. I.e., wrapping the lambda into the
Preferablemodule even ifit only affects
AppConfigurationclasses. The default-handling logicis very entangled into the former, and it'd take more work to extract
it.
Fixes #4165
Checklist: