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.

Rename `base_cache_key` to `spree_base_cache_key` and add helper method for the cache scope (#12188)

Damian Kaczmarczykdc37e7ce7bd1
diff --git a/admin/app/controllers/spree/admin/base_controller.rb b/admin/app/controllers/spree/admin/base_controller.rb
index 441a452985..e152a49b70 100644
--- a/admin/app/controllers/spree/admin/base_controller.rb
+++ b/admin/app/controllers/spree/admin/base_controller.rb
@@ -66,7 +66,7 @@ module Spree
end
def config_locale
- I18n.locale
+ I18n.default_locale
end
def current_timezone
diff --git a/core/app/helpers/spree/base_helper.rb b/core/app/helpers/spree/base_helper.rb
index 25d98ee0d4..8b8df91020 100644
--- a/core/app/helpers/spree/base_helper.rb
+++ b/core/app/helpers/spree/base_helper.rb
@@ -219,10 +219,19 @@ module Spree
end
def base_cache_key
+ Spree::Deprecation.warn('`base_cache_key` is deprecated and will be removed in Spree 6. Please use `spree_base_cache_key` instead')
+ spree_base_cache_key
+ end
+
+ def spree_base_cache_key
[I18n.locale, current_currency, defined?(try_spree_current_user) && try_spree_current_user.present?,
defined?(try_spree_current_user) && try_spree_current_user.try(:has_spree_role?, 'admin')]
end
+ def spree_base_cache_scope
+ ->(record = nil) { [*spree_base_cache_key, record].compact_blank }
+ end
+
def maximum_quantity
Spree::DatabaseTypeUtilities.maximum_value_for(:integer)
end
diff --git a/core/app/helpers/spree/products_helper.rb b/core/app/helpers/spree/products_helper.rb
index a6a2b76ffc..287cf98067 100644
--- a/core/app/helpers/spree/products_helper.rb
+++ b/core/app/helpers/spree/products_helper.rb
@@ -155,7 +155,7 @@ module Spree
end
def common_product_cache_keys
- base_cache_key + price_options_cache_key
+ spree_base_cache_key + price_options_cache_key
end
private
diff --git a/core/spec/helpers/base_helper_spec.rb b/core/spec/helpers/base_helper_spec.rb
index 31aef6bba9..0d1a4a0472 100644
--- a/core/spec/helpers/base_helper_spec.rb
+++ b/core/spec/helpers/base_helper_spec.rb
@@ -146,7 +146,7 @@ describe Spree::BaseHelper, type: :helper do
end
end
- context 'base_cache_key' do
+ context 'spree_base_cache_key' do
let(:current_currency) { 'USD' }
context 'when try_spree_current_user defined' do
@@ -159,7 +159,7 @@ describe Spree::BaseHelper, type: :helper do
let!(:user) { create(:admin_user) }
it 'returns base cache key' do
- expect(base_cache_key).to eq [:en, 'USD', true, true]
+ expect(spree_base_cache_key).to eq [:en, 'USD', true, true]
end
end
@@ -167,7 +167,7 @@ describe Spree::BaseHelper, type: :helper do
let!(:user) { create(:user) }
it 'returns base cache key' do
- expect(base_cache_key).to eq [:en, 'USD', true, false]
+ expect(spree_base_cache_key).to eq [:en, 'USD', true, false]
end
end
@@ -175,7 +175,7 @@ describe Spree::BaseHelper, type: :helper do
let!(:user) { nil }
it 'returns base cache key' do
- expect(base_cache_key).to eq [:en, 'USD', false, nil]
+ expect(spree_base_cache_key).to eq [:en, 'USD', false, nil]
end
end
end
@@ -188,7 +188,7 @@ describe Spree::BaseHelper, type: :helper do
end
it 'returns base cache key' do
- expect(base_cache_key).to eq [:en, 'USD', nil, nil]
+ expect(spree_base_cache_key).to eq [:en, 'USD', nil, nil]
end
end
end