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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Move backend configuration to spree_backend gem (#11359)
Damian Legawiec97c7440b3cf4
diff --git a/backend/app/controllers/spree/admin/orders_controller.rb b/backend/app/controllers/spree/admin/orders_controller.rbindex 535e18f272..915e728c26 100644--- a/backend/app/controllers/spree/admin/orders_controller.rb+++ b/backend/app/controllers/spree/admin/orders_controller.rb@@ -13,7 +13,7 @@ module Spreedef indexparams[:q] ||= {}- params[:q][:completed_at_not_null] ||= '1' if Spree::Config[:show_only_complete_orders_by_default]+ params[:q][:completed_at_not_null] ||= '1' if Spree::Backend::Config[:show_only_complete_orders_by_default]@show_only_completed = params[:q][:completed_at_not_null] == '1'params[:q][:s] ||= @show_only_completed ? 'completed_at desc' : 'created_at desc'params[:q][:completed_at_not_null] = '' unless @show_only_completed@@ -54,7 +54,7 @@ module Spree# see https://github.com/spree/spree/pull/3919@orders = @search.result(distinct: true).page(params[:page]).- per(params[:per_page] || Spree::Config[:admin_orders_per_page])+ per(params[:per_page] || Spree::Backend::Config[:admin_orders_per_page])# Restore datesparams[:q][:created_at_gt] = created_at_gtdiff --git a/backend/app/controllers/spree/admin/products_controller.rb b/backend/app/controllers/spree/admin/products_controller.rbindex 09b961ff7e..1790a95bff 100644--- a/backend/app/controllers/spree/admin/products_controller.rb+++ b/backend/app/controllers/spree/admin/products_controller.rb@@ -132,7 +132,7 @@ module Spree@collection = @search.result.includes(product_includes).page(params[:page]).- per(params[:per_page] || Spree::Config[:admin_products_per_page])+ per(params[:per_page] || Spree::Backend::Config[:admin_products_per_page])@collectionenddiff --git a/backend/app/controllers/spree/admin/promotions_controller.rb b/backend/app/controllers/spree/admin/promotions_controller.rbindex 1f313f14d5..0211528c8f 100644--- a/backend/app/controllers/spree/admin/promotions_controller.rb+++ b/backend/app/controllers/spree/admin/promotions_controller.rb@@ -42,7 +42,7 @@ module Spree@collection = @search.result(distinct: true).includes(promotion_includes).page(params[:page]).- per(params[:per_page] || Spree::Config[:admin_promotions_per_page])+ per(params[:per_page] || Spree::Backend::Config[:admin_promotions_per_page])enddef promotion_includesdiff --git a/backend/app/controllers/spree/admin/properties_controller.rb b/backend/app/controllers/spree/admin/properties_controller.rbindex a1280ac35f..85b6d336da 100644--- a/backend/app/controllers/spree/admin/properties_controller.rb+++ b/backend/app/controllers/spree/admin/properties_controller.rb@@ -17,7 +17,7 @@ module Spree@search = @collection.ransack(params[:q])@collection = @search.result.page(params[:page]).- per(Spree::Config[:admin_properties_per_page])+ per(Spree::Backend::Config[:admin_properties_per_page])endendenddiff --git a/backend/app/controllers/spree/admin/return_index_controller.rb b/backend/app/controllers/spree/admin/return_index_controller.rbindex f634d90738..12f5f83281 100644--- a/backend/app/controllers/spree/admin/return_index_controller.rb+++ b/backend/app/controllers/spree/admin/return_index_controller.rb@@ -21,7 +21,7 @@ module Spree@collection = resource.all# @search needs to be defined as this is passed to search_form_for@search = @collection.ransack(params[:q])- per_page = params[:per_page] || Spree::Config[:admin_customer_returns_per_page]+ per_page = params[:per_page] || Spree::Backend::Config[:admin_customer_returns_per_page]@collection = @search.result.order(created_at: :desc).page(params[:page]).per(per_page)endenddiff --git a/backend/app/controllers/spree/admin/users_controller.rb b/backend/app/controllers/spree/admin/users_controller.rbindex df007601e4..b01882f5d1 100644--- a/backend/app/controllers/spree/admin/users_controller.rb+++ b/backend/app/controllers/spree/admin/users_controller.rb@@ -86,7 +86,7 @@ module Spree@collection = super@search = @collection.ransack(params[:q])- @collection = @search.result.page(params[:page]).per(Spree::Config[:admin_users_per_page])+ @collection = @search.result.page(params[:page]).per(Spree::Backend::Config[:admin_users_per_page])endprivatediff --git a/backend/app/helpers/spree/admin/navigation_helper.rb b/backend/app/helpers/spree/admin/navigation_helper.rbindex b256fd765d..d3f4ff2dc5 100644--- a/backend/app/helpers/spree/admin/navigation_helper.rb+++ b/backend/app/helpers/spree/admin/navigation_helper.rb@@ -88,13 +88,13 @@ module Spree# this method generates the select_tagdef per_page_dropdown# there is a config setting for admin_products_per_page, only for the orders page- if @products && per_page_default = Spree::Config.admin_products_per_page+ if @products && per_page_default = Spree::Backend::Config.admin_products_per_pageper_page_options = []5.times do |amount|- per_page_options << (amount + 1) * Spree::Config.admin_products_per_page+ per_page_options << (amount + 1) * Spree::Backend::Config.admin_products_per_pageendelse- per_page_default = Spree::Config.admin_orders_per_page+ per_page_default = Spree::Backend::Config.admin_orders_per_pageper_page_options = %w{25 50 75}enddiff --git a/backend/app/models/spree/backend_configuration.rb b/backend/app/models/spree/backend_configuration.rbindex da4273815f..0d684fdbc7 100644--- a/backend/app/models/spree/backend_configuration.rb+++ b/backend/app/models/spree/backend_configuration.rb@@ -1,10 +1,19 @@module Spreeclass BackendConfiguration < Preferences::Configuration+ preference :admin_path, :string, default: '/admin'+ preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_properties_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_promotions_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_customer_returns_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_users_per_page, :integer, default: Kaminari.config.default_per_page+ preference :admin_show_version, :boolean, default: truepreference :locale, :string, default: Rails.application.config.i18n.default_localepreference :variants_per_page, :integer, default: Kaminari.config.default_per_pagepreference :menus_per_page, :integer, default: Kaminari.config.default_per_pagepreference :product_wysiwyg_editor_enabled, :boolean, default: truepreference :taxon_wysiwyg_editor_enabled, :boolean, default: true+ preference :show_only_complete_orders_by_default, :boolean, default: trueORDER_TABS ||= [:orders, :payments, :creditcard_payments,:shipments, :credit_cards, :return_authorizations,diff --git a/backend/app/views/spree/admin/shared/_version.html.erb b/backend/app/views/spree/admin/shared/_version.html.erbindex bcf2ca91c1..9d379a6ee4 100644--- a/backend/app/views/spree/admin/shared/_version.html.erb+++ b/backend/app/views/spree/admin/shared/_version.html.erb@@ -1,4 +1,4 @@-<% if can?(:admin, current_store) && Spree::Config[:admin_show_version] %>+<% if can?(:admin, current_store) && Spree::Backend::Config[:admin_show_version] %><smallclass="spree-version font-weight-bold ml-3 my-3 text-muted"aria-label="Spree Commerce version">diff --git a/backend/lib/spree_backend.rb b/backend/lib/spree_backend.rbindex d095c2c556..258273bfb1 100644--- a/backend/lib/spree_backend.rb+++ b/backend/lib/spree_backend.rb@@ -1 +1,18 @@require 'spree/backend'++module Spree+ def self.admin_path+ Spree::Backend::Config[:admin_path]+ end++ # Used to configure admin_path for Spree+ #+ # Example:+ #+ # write the following line in `config/initializers/spree.rb`+ # Spree.admin_path = '/custom-path'++ def self.admin_path=(path)+ Spree::Backend::Config[:admin_path] = path+ end+enddiff --git a/backend/spec/features/admin/homepage_spec.rb b/backend/spec/features/admin/homepage_spec.rbindex 4feeabdb00..9fe4323705 100644--- a/backend/spec/features/admin/homepage_spec.rb+++ b/backend/spec/features/admin/homepage_spec.rb@@ -47,7 +47,7 @@ describe 'Homepage', type: :feature doendcontext 'if turned off' do- before { Spree::Config[:admin_show_version] = false }+ before { Spree::Backend::Config[:admin_show_version] = false }it 'is not displayed' dovisit spree.admin_pathdiff --git a/backend/spec/features/admin/orders/listing_spec.rb b/backend/spec/features/admin/orders/listing_spec.rbindex 9b8fc8c217..44299b97fc 100644--- a/backend/spec/features/admin/orders/listing_spec.rb+++ b/backend/spec/features/admin/orders/listing_spec.rb@@ -159,12 +159,12 @@ describe 'Orders Listing', type: :feature docontext 'when pagination is really short' dobefore do- @old_per_page = Spree::Config[:admin_orders_per_page]- Spree::Config[:admin_orders_per_page] = 1+ @old_per_page = Spree::Backend::Config[:admin_orders_per_page]+ Spree::Backend::Config[:admin_orders_per_page] = 1endafter do- Spree::Config[:admin_orders_per_page] = @old_per_page+ Spree::Backend::Config[:admin_orders_per_page] = @old_per_pageend# Regression test for #4004diff --git a/backend/spec/lib/spree/core_spec.rb b/backend/spec/lib/spree/core_spec.rbnew file mode 100644index 0000000000..c629eda897--- /dev/null+++ b/backend/spec/lib/spree/core_spec.rb@@ -0,0 +1,23 @@+require 'spec_helper'++describe Spree do+ describe '.admin_path' do+ it { expect(described_class.admin_path).to eq(Spree::Backend::Config[:admin_path]) }+ end++ describe '.admin_path=' do+ let!(:original_admin_path) { described_class.admin_path }+ let(:new_admin_path) { '/admin-secret-path' }++ before do+ described_class.admin_path = new_admin_path+ end++ after do+ described_class.admin_path = original_admin_path+ end++ it { expect(described_class.admin_path).to eq(new_admin_path) }+ it { expect(Spree::Backend::Config[:admin_path]).to eq(new_admin_path) }+ end+enddiff --git a/core/app/models/spree/app_configuration.rb b/core/app/models/spree/app_configuration.rbindex 2c7a3fd447..f707fb2218 100644--- a/core/app/models/spree/app_configuration.rb+++ b/core/app/models/spree/app_configuration.rb@@ -22,15 +22,14 @@ module Spree# Alphabetized to more easily lookup particular preferencespreference :address_requires_state, :boolean, default: true # should state/state_name be requiredpreference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address- preference :admin_interface_logo, :string, default: 'admin/logo.png'- preference :admin_path, :string, default: '/admin'- preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_properties_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_promotions_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_customer_returns_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_users_per_page, :integer, default: Kaminari.config.default_per_page- preference :admin_show_version, :boolean, default: true+ preference :admin_path, :string, deprecated: true+ preference :admin_products_per_page, :integer, deprecated: true+ preference :admin_orders_per_page, :integer, deprecated: true+ preference :admin_properties_per_page, :integer, deprecated: true+ preference :admin_promotions_per_page, :integer, deprecated: true+ preference :admin_customer_returns_per_page, :integer, deprecated: true+ preference :admin_users_per_page, :integer, deprecated: true+ preference :admin_show_version, :boolean, deprecated: truepreference :allow_checkout_on_gateway_error, :boolean, default: falsepreference :allow_guest_checkout, :boolean, default: truepreference :alternative_shipping_phone, :boolean, default: false # Request extra phone for ship addr@@ -58,7 +57,7 @@ module Spreepreference :return_eligibility_number_of_days, :integer, default: 365preference :send_core_emails, :boolean, default: true # Default mail headers settingspreference :shipping_instructions, :boolean, deprecated: true- preference :show_only_complete_orders_by_default, :boolean, default: true+ preference :show_only_complete_orders_by_default, :boolean, deprecated: truepreference :show_variant_full_price, :boolean, default: false # Displays variant full price or difference with product price. Default false to be compatible with older behaviorpreference :show_products_without_price, :boolean, default: falsepreference :show_raw_product_description, :boolean, deprecated: truediff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rbindex f4794828c5..6e8bec9022 100644--- a/core/lib/spree/core.rb+++ b/core/lib/spree/core.rb@@ -34,21 +34,6 @@ module Spreeendend- def self.admin_path- Spree::Config[:admin_path]- end-- # Used to configure admin_path for Spree- #- # Example:- #- # write the following line in `config/initializers/spree.rb`- # Spree.admin_path = '/custom-path'-- def self.admin_path=(path)- Spree::Config[:admin_path] = path- end-# Used to configure Spree.## Example:diff --git a/core/lib/spree/core/controller_helpers/auth.rb b/core/lib/spree/core/controller_helpers/auth.rbindex fad3cc9af8..4d22f689b3 100644--- a/core/lib/spree/core/controller_helpers/auth.rb+++ b/core/lib/spree/core/controller_helpers/auth.rb@@ -82,7 +82,7 @@ module Spreeredirect_to spree.forbidden_pathelsestore_location- if request.fullpath.match(Spree.admin_path) && defined?(spree.admin_login_path)+ if Spree.respond_to?(:admin_path) && request.fullpath.match(Spree.admin_path) && defined?(spree.admin_login_path)redirect_to spree.admin_login_pathelsif respond_to?(:spree_login_path)redirect_to spree_login_pathdiff --git a/core/spec/lib/spree/core/controller_helpers/auth_spec.rb b/core/spec/lib/spree/core/controller_helpers/auth_spec.rbindex cdd64ca639..b370a9e028 100644--- a/core/spec/lib/spree/core/controller_helpers/auth_spec.rb+++ b/core/spec/lib/spree/core/controller_helpers/auth_spec.rb@@ -108,13 +108,6 @@ describe Spree::Core::ControllerHelpers::Auth, type: :controller doexpect(response).to redirect_to('/login')end- it 'redirects admin login path when admin controller' do- allow(controller).to receive_message_chain(:spree, :admin_login_path).and_return('/admin/login')- allow_any_instance_of(ActionController::TestRequest).to receive(:fullpath).and_return('http://test.host/admin/fakes')- get :index- expect(response).to redirect_to('/admin/login')- end-it 'redirects root path' doallow(controller).to receive_message_chain(:spree, :root_path).and_return('/root_path')get :indexdiff --git a/core/spec/lib/spree/core_spec.rb b/core/spec/lib/spree/core_spec.rbindex 643a0f65da..527548680d 100644--- a/core/spec/lib/spree/core_spec.rb+++ b/core/spec/lib/spree/core_spec.rb@@ -1,26 +1,6 @@require 'spec_helper'describe Spree do- describe '.admin_path' do- it { expect(described_class.admin_path).to eq(Spree::Config[:admin_path]) }- end-- describe '.admin_path=' do- let!(:original_admin_path) { described_class.admin_path }- let(:new_admin_path) { '/admin-secret-path' }-- before do- described_class.admin_path = new_admin_path- end-- after do- described_class.admin_path = original_admin_path- end-- it { expect(described_class.admin_path).to eq(new_admin_path) }- it { expect(Spree::Config[:admin_path]).to eq(new_admin_path) }- end-describe '.user_class' doafter dodescribed_class.user_class = 'Spree::LegacyUser'diff --git a/core/spec/models/spree/app_configuration_spec.rb b/core/spec/models/spree/app_configuration_spec.rbindex 2064b91415..e2a21f456a 100644--- a/core/spec/models/spree/app_configuration_spec.rb+++ b/core/spec/models/spree/app_configuration_spec.rb@@ -7,10 +7,4 @@ describe Spree::AppConfiguration, type: :model doprefs.searcher_class = nilexpect(prefs.searcher_class).to eq Spree::Core::Search::Baseend-- describe 'admin_path' do- it { expect(Spree::Config).to have_preference(:admin_path) }- it { expect(Spree::Config.preferred_admin_path_type).to eq(:string) }- it { expect(Spree::Config.preferred_admin_path_default).to eq('/admin') }- endend