Skip to content

Commit

Permalink
Allow storing static preferences using string class names
Browse files Browse the repository at this point in the history
This will make unnecessary to wrap these definitions under `.to_prepare`
blocks.

Additionally the error message for unexpected keys has improved and
now lists both all the unexpected keys along with the expected keys,
mentioning the name associated to the definition.

The only thing that changed is that it doesn't do so when the
configuration is added but rather when it's fetched.
  • Loading branch information
elia committed Jan 18, 2023
1 parent 17540ad commit 55b4df4
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 18 deletions.
1 change: 1 addition & 0 deletions core/lib/spree/core/engine.rb
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ class Engine < ::Rails::Engine

config.after_initialize do
Spree::Config.check_load_defaults_called('Spree::Config')
Spree::Config.static_model_preferences.validate!
end

config.after_initialize do
Expand Down
38 changes: 26 additions & 12 deletions core/lib/spree/preferences/static_model_preferences.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,8 @@ class Definition
attr_reader :preferences

def initialize(klass, hash)
hash = hash.symbolize_keys
hash.keys.each do |key|
if !klass.defined_preferences.include?(key)
raise "Preference #{key.inspect} is not defined on #{klass}"
end
end
@preferences = hash
@klass = klass
@preferences = hash.symbolize_keys
end

def fetch(key, &block)
Expand All @@ -27,20 +22,39 @@ def []=(key, value)
def to_hash
@preferences.deep_dup
end

delegate :keys, to: :@preferences
end

def initialize
@store = Hash.new do |data, klass|
data[klass] = {}
end
@store = {}
end

def add(klass, name, preferences)
@store[klass.to_s][name] = Definition.new(klass, preferences)
@store[klass.to_s] ||= {}
@store[klass.to_s][name] = Definition.new(klass.to_s, preferences)
end

def for_class(klass)
@store[klass.to_s]
@store[klass.to_s] || {}
end

def validate!
@store.keys.map(&:constantize).each do |klass|
validate_for_class!(klass)
end
end

private

def validate_for_class!(klass)
for_class(klass).each do |name, preferences|
klass_keys = klass.defined_preferences.map(&:to_s)
extra_keys = preferences.keys.map(&:to_s) - klass_keys
next if extra_keys.empty?

raise "Unexpected keys found for #{klass} under #{name}: #{extra_keys.to_sentence} (expected keys: #{klass_keys.to_sentence})"
end
end
end
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ module Spree
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' })
}.to raise_error(/\APreference :ice_cream is not defined/)
end

context "with stored definitions" do
before do
subject.add(preference_class, 'light', { color: 'white' })
Expand Down Expand Up @@ -83,5 +77,17 @@ module Spree
expect(subject.for_class(other_class)).to be_empty
end
end

describe '.validate!' do
it "errors assigning invalid preferences" do
subject.add(preference_class, 'my_definition', { ice_cream: 'chocolate' })

expect {
subject.validate!
}.to raise_error(
/\AUnexpected keys found for #{Regexp.escape preference_class.to_s} under my_definition: ice_cream \(expected keys: color\)/
)
end
end
end
end

0 comments on commit 55b4df4

Please sign in to comment.