Merge pull request #4449 from nebulab/waiting-for-dev/accept_static_class_name_as_string

Support code reloading when configuring static preferences sources

Author: waiting-for-dev

CHANGELOG.md

@@ -5,7 +5,9 @@
 
 - Fix CSRF forgery protection bypass for Spree::OrdersController#populate [GHSA-h3fg-h5v3-vf8m](https://github.com/solidusio/solidus/security/advisories/GHSA-h3fg-h5v3-vf8m)
 
-**Other important changes**
+### Other important changes
+
+#### No more autoload of decorators in fresh applications
 
 New Solidus applications won't autoload files matching `app/**/*_decorator*.rb`
 pattern anymore. For previous Solidus applications, it's something that will
@@ -43,7 +45,7 @@ of Solidus recommendations (that files are monkey patches; they don't use the
 you can place those files in `app/overrides/` and remove the `decorator`
 suffix.
 
-### Changes to the promotion system
+#### Changes to the promotion system
 
 Promotions with a `match_policy` of `any` are deprecated. If you have promotions
 with such a match policy, try running the following rake task:
@@ -64,6 +66,43 @@ set a temporary flag in your `config/initializers/spree.rb` file:
 config.allow_promotions_any_match_policy = true
 ```
 
+#### Static preference sources configured within `.to_prepare` blocks
+
+[Rails 7 no longer supports referring autoloadable classes within an
+initializer](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-on-boot-and-on-each-reload).
+
+Because of that, we need to change the way we configure static preference sources.
+
+Before:
+
+```ruby
+# config/initializers/spree.rb
+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
+```
+
+Now:
+
+```ruby
+# config/initializers/spree.rb
+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
+```
+
 ### Core
 
 - Add configuration option for `migration_path` [#4190](https://github.com/solidusio/solidus/pull/4190) ([SuperGoodSoft](https://github.com/supergoodsoft/))

core/lib/spree/preferences/static_model_preferences.rb

@@ -36,8 +36,6 @@ def initialize
       end
 
       def add(klass, name, preferences)
-        # We use class name instead of class to allow reloading in dev
-        raise "Static model preference '#{name}' on #{klass} is already defined" if @store[klass.to_s][name]
         @store[klass.to_s][name] = Definition.new(klass, preferences)
       end
 

core/spec/models/spree/preferences/static_model_preferences_spec.rb

@@ -23,6 +23,14 @@ module Spree
       expect(definitions).to have_key('my_definition')
     end
 
+    it "can replace preferences" do
+      subject.add(preference_class, 'my_definition', { color: "red" })
+
+      subject.add(preference_class, 'my_definition', { color: "blue" })
+
+      expect(definitions['my_definition'].fetch(:color)).to eq("blue")
+    end
+
     it "errors assigning invalid preferences" do
       expect {
         subject.add(preference_class, 'my_definition', { ice_cream: 'chocolate' })