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 `Preferences` to `Store` model (#12305)

Damian Legawiecbfe3e8595f17
diff --git a/admin/app/controllers/spree/admin/base_controller.rb b/admin/app/controllers/spree/admin/base_controller.rb
index 0d7f4d5414..08dc0149aa 100644
--- a/admin/app/controllers/spree/admin/base_controller.rb
+++ b/admin/app/controllers/spree/admin/base_controller.rb
@@ -81,7 +81,7 @@ module Spree
end
def current_timezone
- @current_timezone ||= current_store.timezone
+ @current_timezone ||= current_store.preferred_timezone
end
def current_currency
diff --git a/core/app/models/spree/digital_link.rb b/core/app/models/spree/digital_link.rb
index 47bf76badd..b517f83111 100644
--- a/core/app/models/spree/digital_link.rb
+++ b/core/app/models/spree/digital_link.rb
@@ -25,16 +25,16 @@ module Spree
end
def expired?
- if line_item.order.store.limit_digital_download_days
- created_at <= line_item.order.store.digital_asset_authorized_days.day.ago
+ if line_item.order.store.preferred_limit_digital_download_days
+ created_at <= line_item.order.store.preferred_digital_asset_authorized_days.day.ago
else
false
end
end
def access_limit_exceeded?
- if line_item.order.store.limit_digital_download_count
- access_counter >= line_item.order.store.digital_asset_authorized_clicks
+ if line_item.order.store.preferred_limit_digital_download_count
+ access_counter >= line_item.order.store.preferred_digital_asset_authorized_clicks
else
false
end
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index 3209bdad3c..7d9b55716e 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -19,19 +19,18 @@ module Spree
default_scope { unscope(where: :deleted_at) }
end
- typed_store :settings, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
- # Spree Digital Asset Configurations
- s.boolean :limit_digital_download_count, default: true, null: false
- s.boolean :limit_digital_download_days, default: true, null: false
- s.integer :digital_asset_authorized_clicks, default: 5, null: false # number of times a customer can download a digital file.
- s.integer :digital_asset_authorized_days, default: 7, null: false # number of days after initial purchase the customer can download a file.
- s.integer :digital_asset_link_expire_time, default: 300, null: false # 5 minutes in seconds
+ #
+ # Preferences
+ #
+ preference :limit_digital_download_count, :boolean, default: true
+ preference :limit_digital_download_days, :boolean, default: true
+ preference :digital_asset_authorized_clicks, :integer, default: 5
+ preference :digital_asset_authorized_days, :integer, default: 7
+ preference :digital_asset_link_expire_time, :integer, default: 300
- # store configuration
- s.string :timezone, default: Time.zone.name, null: false
- s.string :weight_unit, default: 'kg', null: false
- s.string :unit_system, default: 'metric', null: false
- end
+ preference :timezone, :string, default: Time.zone.name
+ preference :weight_unit, :string, default: 'lb'
+ preference :unit_system, :string, default: 'imperial'
attr_accessor :skip_validate_not_last
@@ -91,9 +90,8 @@ module Spree
with_options presence: true do
validates :name, :url, :mail_from_address, :default_currency, :default_country, :code
end
-
- validates :digital_asset_authorized_clicks, numericality: { only_integer: true, greater_than: 0 }
- validates :digital_asset_authorized_days, numericality: { only_integer: true, greater_than: 0 }
+ validates :preferred_digital_asset_authorized_clicks, numericality: { only_integer: true, greater_than: 0 }
+ validates :preferred_digital_asset_authorized_days, numericality: { only_integer: true, greater_than: 0 }
validates :code, uniqueness: { case_sensitive: false, conditions: -> { with_deleted } }
validates :mail_from_address, email: { allow_blank: false }
@@ -247,7 +245,7 @@ module Spree
end
def metric_unit_system?
- unit_system == 'metric'
+ preferred_unit_system == 'metric'
end
private
diff --git a/core/app/models/spree/taxon_rules/available_on.rb b/core/app/models/spree/taxon_rules/available_on.rb
index 3a458cfc5b..dbb17bfd87 100644
--- a/core/app/models/spree/taxon_rules/available_on.rb
+++ b/core/app/models/spree/taxon_rules/available_on.rb
@@ -4,7 +4,7 @@ module Spree
def apply(scope)
# value here is no of weeks
# eg. return products that become available in the last 2 weeks
- timezone = taxon.store.timezone
+ timezone = taxon.store.preferred_timezone
date = value.to_i.days.ago.beginning_of_day.in_time_zone(timezone)
if match_policy == 'is_equal_to'
diff --git a/core/app/models/spree/variant.rb b/core/app/models/spree/variant.rb
index edf3456c42..0ed0b70928 100644
--- a/core/app/models/spree/variant.rb
+++ b/core/app/models/spree/variant.rb
@@ -449,7 +449,7 @@ module Spree
# Returns the weight unit for the variant
# @return [String]
def weight_unit
- attributes['weight_unit'] || Spree::Store.default.weight_unit
+ attributes['weight_unit'] || Spree::Store.default.preferred_weight_unit
end
def discontinue!
diff --git a/core/app/presenters/spree/csv/order_line_item_presenter.rb b/core/app/presenters/spree/csv/order_line_item_presenter.rb
index 4850d247ef..c8eab8e2c0 100644
--- a/core/app/presenters/spree/csv/order_line_item_presenter.rb
+++ b/core/app/presenters/spree/csv/order_line_item_presenter.rb
@@ -138,7 +138,7 @@ module Spree
def format_date(date)
return nil if date.blank?
- date.in_time_zone(order.store.timezone).strftime('%Y-%m-%d %H:%M:%S')
+ date.in_time_zone(order.store.preferred_timezone).strftime('%Y-%m-%d %H:%M:%S')
end
end
end
diff --git a/core/db/migrate/20250113180019_add_preferences_to_spree_stores.rb b/core/db/migrate/20250113180019_add_preferences_to_spree_stores.rb
new file mode 100644
index 0000000000..cdf3638e32
--- /dev/null
+++ b/core/db/migrate/20250113180019_add_preferences_to_spree_stores.rb
@@ -0,0 +1,5 @@
+class AddPreferencesToSpreeStores < ActiveRecord::Migration[6.1]
+ def change
+ add_column :spree_stores, :preferences, :text, if_not_exists: true
+ end
+end
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index 67f21b7ecf..51f8a75a46 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -136,8 +136,10 @@ module Spree
:description, :address, :contact_phone, :supported_locales,
:default_locale, :default_country_id, :supported_currencies,
:new_order_notifications_email, :checkout_zone_id, :seo_robots,
- :digital_asset_authorized_clicks, :digital_asset_authorized_days,
- :limit_digital_download_count, :limit_digital_download_days, :digital_asset_link_expire_time,
+ :preferred_timezone, :preferred_weight_unit, :preferred_unit_system,
+ :preferred_digital_asset_authorized_clicks, :preferred_digital_asset_authorized_days,
+ :preferred_limit_digital_download_count, :preferred_limit_digital_download_days,
+ :preferred_digital_asset_link_expire_time,
{ mailer_logo_attributes: {}, favicon_image_attributes: {}, logo_attributes: {} }]
@@store_credit_attributes = %i[amount currency category_id memo]
diff --git a/core/lib/spree/testing_support/factories/store_factory.rb b/core/lib/spree/testing_support/factories/store_factory.rb
index 06542ebd2e..e19dfb097e 100644
--- a/core/lib/spree/testing_support/factories/store_factory.rb
+++ b/core/lib/spree/testing_support/factories/store_factory.rb
@@ -13,8 +13,6 @@ FactoryBot.define do
twitter { 'spreecommerce' }
instagram { 'spreecommerce' }
meta_description { 'Sample store description.' }
- digital_asset_authorized_clicks { 5 }
- digital_asset_authorized_days { 7 }
trait :with_favicon do
transient do
diff --git a/core/spec/models/spree/digital_link_spec.rb b/core/spec/models/spree/digital_link_spec.rb
index ca7451164e..4b38f2a0c4 100644
--- a/core/spec/models/spree/digital_link_spec.rb
+++ b/core/spec/models/spree/digital_link_spec.rb
@@ -72,7 +72,7 @@ describe Spree::DigitalLink, type: :model do
let(:digital_link) { create(:digital_link) }
before do
- digital_link.line_item.order.store.update(limit_digital_download_days: false)
+ digital_link.line_item.order.store.preferred_limit_digital_download_days = false
digital_link.line_item.order.store.save!
digital_link.line_item.order.store.reload
end
@@ -104,7 +104,7 @@ describe Spree::DigitalLink, type: :model do
let(:digital_link) { create(:digital_link) }
before do
- digital_link.line_item.order.store.update(limit_digital_download_count: false)
+ digital_link.line_item.order.store.preferred_limit_digital_download_count = false
digital_link.line_item.order.store.save!
digital_link.line_item.order.store.reload
end
@@ -136,7 +136,7 @@ describe Spree::DigitalLink, type: :model do
let(:digital_link) { create(:digital_link) }
before do
- digital_link.line_item.order.store.update(limit_digital_download_count: false)
+ digital_link.line_item.order.store.preferred_limit_digital_download_count = false
digital_link.line_item.order.store.save!
digital_link.line_item.order.store.reload
end
@@ -166,7 +166,7 @@ describe Spree::DigitalLink, type: :model do
let(:digital_link) { create(:digital_link) }
before do
- digital_link.line_item.order.store.update(limit_digital_download_days: false)
+ digital_link.line_item.order.store.preferred_limit_digital_download_days = false
digital_link.line_item.order.store.save!
digital_link.line_item.order.store.reload
end
diff --git a/core/spec/presenters/spree/csv/order_line_items_presenter_spec.rb b/core/spec/presenters/spree/csv/order_line_items_presenter_spec.rb
index d280fea9e1..fb8a7781bf 100644
--- a/core/spec/presenters/spree/csv/order_line_items_presenter_spec.rb
+++ b/core/spec/presenters/spree/csv/order_line_items_presenter_spec.rb
@@ -69,7 +69,7 @@ RSpec.describe Spree::CSV::OrderLineItemPresenter do
it 'formats date according to store timezone' do
expect(presenter.send(:format_date, date)).to eq(
- date.in_time_zone(order.store.timezone).strftime('%Y-%m-%d %H:%M:%S')
+ date.in_time_zone(order.store.preferred_timezone).strftime('%Y-%m-%d %H:%M:%S')
)
end