Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add runtime configuration class

Rafal Cymerysb28c78cf3bd3
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index c95b077704..540ac5b44b 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -141,3 +141,4 @@ require 'spree/core/controller_helpers/currency'
require 'spree/core/preferences/store'
require 'spree/core/preferences/scoped_store'
+require 'spree/core/preferences/runtime_configuration'
diff --git a/core/lib/spree/core/preferences/runtime_configuration.rb b/core/lib/spree/core/preferences/runtime_configuration.rb
new file mode 100644
index 0000000000..499b5afe1d
--- /dev/null
+++ b/core/lib/spree/core/preferences/runtime_configuration.rb
@@ -0,0 +1,43 @@
+module Spree
+ module Preferences
+ class RuntimeConfiguration
+ def initialize
+ self.class.defaults.each do |key, value|
+ self[key] = value
+ end
+ end
+
+ def configure
+ yield(self) if block_given?
+ end
+
+ def get(preference)
+ send(preference)
+ end
+
+ alias [] get
+
+ def set(preference, value)
+ send("#{preference}=", value)
+ end
+
+ alias []= set
+
+ class << self
+ def preference(name, _type, default: nil, deprecated: false)
+ defaults[name] = default
+ deprecations[name] = deprecated
+ attr_accessor name
+ end
+
+ def defaults
+ @defaults ||= {}
+ end
+
+ def deprecations
+ @deprecations ||= {}
+ end
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/preferences/runtime_configuration_spec.rb b/core/spec/models/spree/preferences/runtime_configuration_spec.rb
new file mode 100644
index 0000000000..12280fb67a
--- /dev/null
+++ b/core/spec/models/spree/preferences/runtime_configuration_spec.rb
@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Spree::Preferences::RuntimeConfiguration, type: :model do
+ let(:test_class) do
+ Class.new(Spree::Preferences::RuntimeConfiguration) do
+ preference :admin_path, :string, default: '/admin'
+ preference :page_size, :integer
+ end
+ end
+
+ subject { test_class.new }
+
+ describe '#get' do
+ it 'returns default value if present' do
+ expect(subject.get(:admin_path)).to eq('/admin')
+ end
+
+ it 'returns nil if not present' do
+ expect(subject.get(:page_size)).to be_nil
+ end
+
+ it 'returns value via an attribute accessor' do
+ expect(subject.admin_path).to eq('/admin')
+ end
+
+ it 'returns value via a hash accessor' do
+ expect(subject[:admin_path]).to eq('/admin')
+ end
+ end
+
+ describe '#set' do
+ it 'overrides the default value' do
+ subject.set(:admin_path, '/secret_admin')
+ expect(subject.get(:admin_path)).to eq('/secret_admin')
+ end
+
+ it 'sets value if not set previously' do
+ subject.set(:page_size, 10)
+ expect(subject.get(:page_size)).to eq(10)
+ end
+
+ it 'sets the value via an attribute accessor' do
+ subject.page_size = 10
+ expect(subject.get(:page_size)).to eq(10)
+ end
+
+ it 'sets value via a hash accessor' do
+ subject[:page_size] = 10
+ expect(subject.get(:page_size)).to eq(10)
+ end
+ end
+end