Accept static_model_preferences class name as string #4070
Closed
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
|
Thanks @willianveiga, this looks good but I'd like to better understand why we need this (as asked in the original issue). I mean, in which circumstances we need to use a string there? |
elia
requested changes
Jun 7, 2021
There was a problem hiding this comment.
Hey @willianveiga! thanks for tackling this 💯
I left a couple of comments for possible issues with the proposed implementation 👍
| @@ -36,9 +36,14 @@ def initialize | |||
| end | |||
|
|
|||
| def add(klass, name, preferences) | |||
| constantized_klass = klass.try(:constantize) || klass | |||
There was a problem hiding this comment.
This will trigger an autoload during initialization, which is one of the things that this change should avoid. Thoughts on just converting to a string if it's not already and allowing Definition to accept it as well?
There was a problem hiding this comment.
Hey @elia, I'm wondering how to fix it. In the end, add creates another Definition instance, and it calls .defined_preferences on the class 🤷
| @@ -5,7 +5,7 @@ | |||
| module Spree | |||
| RSpec.describe Preferences::StaticModelPreferences do | |||
| let(:preference_class) do | |||
| Class.new do | |||
| MyFakeStaticModelPreferencesClass ||= Class.new do | |||
There was a problem hiding this comment.
I think defining a constant here will actually define it under Spree::, an alternative could be using stubbed constants https://rspec.info/blog/2012/06/constant-stubbing-in-rspec-2-11/, but I'm not sure it's a good one, you need to check how they'll interact with this setup.
|
Hey @willianveiga, would you like to retake it? It's very close to a final solution 🍾 |
waiting-for-dev
added a commit
to nebulab/solidus
that referenced
this pull request
Jul 13, 2022
This is how we usually recommend configuring sources for static
preferences [1]:
```ruby
Spree.config do |config|
config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, it's no longer possible to directly reference an autoloadable
class from an initializer [2].
In this case, we can't change the `#add` method to take the class name
instead. The reason is that it ends up invoking a sanitization check on
the given preferences against the defined preferences, and that, of
course, needs access to the actual class [3].
Therefore, it's better to start recommending nesting the configuration
within a `.to_prepare` block, as they run every time the code is
reloaded [4]:
```ruby
Rails.application.config.to_prepare do
Spree::Config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, that means running the `#add` method multiple times, so we need
to change it to replace the definition instead of raising an error.
[1] - https://github.com/solidusio/solidus_stripe/blob/3fab36511a9d02ebd64d03571704ac5a9031b63b/README.md#usage
[2] - https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload
[3] - https://github.com/solidusio/solidus/blob/df51df62fa9b829216958b21b20514b7a3d87b30/core/lib/spree/preferences/static_model_preferences.rb#L13
[4] - https://guides.rubyonrails.org/configuring.html#initialization-events
Closes solidusio#4070 & solidusio#4040
waiting-for-dev
added a commit
to nebulab/solidus
that referenced
this pull request
Jul 15, 2022
This is how we usually recommend configuring sources for static
preferences [1]:
```ruby
Spree.config do |config|
config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, it's no longer possible to directly reference an autoloadable
class from an initializer [2].
In this case, we can't change the `#add` method to take the class name
instead. The reason is that it ends up invoking a sanitization check on
the given preferences against the defined preferences, and that, of
course, needs access to the actual class [3].
Therefore, it's better to start recommending nesting the configuration
within a `.to_prepare` block, as they run every time the code is
reloaded [4]:
```ruby
Rails.application.config.to_prepare do
Spree::Config.static_model_preferences.add(
AmazingStore::AmazingPaymentMethod,
'amazing_payment_method_credentials',
credentials: ENV['AMAZING_PAYMENT_METHOD_CREDENTIALS'],
server: Rails.env.production? ? 'production' : 'test',
test_mode: !Rails.env.production?
)
end
```
However, that means running the `#add` method multiple times, so we need
to change it to replace the definition instead of raising an error.
[1] - https://github.com/solidusio/solidus_stripe/blob/3fab36511a9d02ebd64d03571704ac5a9031b63b/README.md#usage
[2] - https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload
[3] - https://github.com/solidusio/solidus/blob/df51df62fa9b829216958b21b20514b7a3d87b30/core/lib/spree/preferences/static_model_preferences.rb#L13
[4] - https://guides.rubyonrails.org/configuring.html#initialization-events
Closes solidusio#4070 & solidusio#4040
7 tasks
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
Make it possible to accept
static_model_preferencesclass name asstring.Fixes #4040
Checklist: