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.

Fix page builder's restore design settings functionality (#12427)

Damian Kaczmarczyk452f5aa89a5a
diff --git a/admin/spec/controllers/spree/admin/page_blocks_controller_spec.rb b/admin/spec/controllers/spree/admin/page_blocks_controller_spec.rb
index 2e02e91b28..e2ae987431 100644
--- a/admin/spec/controllers/spree/admin/page_blocks_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/page_blocks_controller_spec.rb
@@ -15,7 +15,7 @@ RSpec.describe Spree::Admin::PageBlocksController, type: :controller do
end
describe '#destroy' do
- let(:page_section) { create(:featured_taxon, pageable: page) }
+ let(:page_section) { create(:featured_taxon_page_section, pageable: page) }
let!(:page_block) { create(:page_block, :buttons, section: page_section) }
it 'destroys the page block' do
@@ -26,7 +26,7 @@ RSpec.describe Spree::Admin::PageBlocksController, type: :controller do
end
describe '#move_higher' do
- let(:page_section) { create(:featured_taxon) }
+ let(:page_section) { create(:featured_taxon_page_section) }
let!(:another_page_block) { create(:page_block, :buttons, section: page_section, position: 1) }
let!(:page_block) { create(:page_block, :buttons, section: page_section, position: 2) }
@@ -38,7 +38,7 @@ RSpec.describe Spree::Admin::PageBlocksController, type: :controller do
end
describe '#move_lower' do
- let(:page_section) { create(:featured_taxon) }
+ let(:page_section) { create(:featured_taxon_page_section) }
let!(:page_block) { create(:page_block, :buttons, section: page_section, position: 1) }
let!(:another_page_block) { create(:page_block, :buttons, section: page_section, position: 2) }
@@ -53,7 +53,7 @@ RSpec.describe Spree::Admin::PageBlocksController, type: :controller do
subject { post :create, params: { page_block: { type: page_block_type }, page_section_id: page_section.id }, format: :turbo_stream }
let(:page_block_type) { 'Spree::PageBlocks::Buttons' }
- let(:page_section) { create(:featured_taxon) }
+ let(:page_section) { create(:featured_taxon_page_section) }
it 'creates page block of the given type' do
expect { subject }.to change(Spree::PageBlock, :count).by(1)
diff --git a/admin/spec/controllers/spree/admin/page_links_controller_spec.rb b/admin/spec/controllers/spree/admin/page_links_controller_spec.rb
index e2f0ac76ff..aba863e35c 100644
--- a/admin/spec/controllers/spree/admin/page_links_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/page_links_controller_spec.rb
@@ -38,7 +38,7 @@ RSpec.describe Spree::Admin::PageLinksController, type: :controller do
context 'for featured taxons' do
let(:taxonomy) { store.taxonomies.first }
let!(:taxon) { create(:taxon, taxonomy: taxonomy, parent: taxonomy.root) }
- let!(:page_section) { create(:page_section, :featured_taxons) }
+ let!(:page_section) { create(:featured_taxons_page_section) }
it 'creates a new page link' do
expect { post_create }.to change { page_section.links.count }.by 1
@@ -49,7 +49,7 @@ RSpec.describe Spree::Admin::PageLinksController, type: :controller do
context 'for featured taxons' do
let(:taxonomy) { store.taxonomies.find_by(name: 'Categories') || create(:taxonomy, name: 'Categories') }
let!(:category) { create(:taxon, taxonomy: taxonomy, parent: taxonomy.root) }
- let!(:page_section) { create(:page_section, :featured_taxons) }
+ let!(:page_section) { create(:featured_taxons_page_section) }
it 'creates a new page link' do
expect { post_create }.to change { page_section.links.count }.by 1
@@ -67,13 +67,13 @@ RSpec.describe Spree::Admin::PageLinksController, type: :controller do
end
context 'for nav page block' do
- let(:page_section) { create(:page_section, :header) }
- let(:page_block) { create(:page_block, :nav, section: page_section) }
-
subject :post_create do
post :create, params: { page_section_id: page_section.id, block_id: page_block.id }, as: :turbo_stream
end
+ let(:page_section) { create(:header_page_section) }
+ let(:page_block) { create(:page_block, :nav, section: page_section) }
+
it 'creates a new page link' do
expect { post_create }.to change { page_block.links.count }.by 1
expect(page_block.links.last.linkable).to be_a Spree::Pages::Homepage
diff --git a/admin/spec/controllers/spree/admin/page_sections_controller_spec.rb b/admin/spec/controllers/spree/admin/page_sections_controller_spec.rb
index 57e92ca526..37de99c0c0 100644
--- a/admin/spec/controllers/spree/admin/page_sections_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/page_sections_controller_spec.rb
@@ -56,7 +56,7 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
describe '#destroy' do
context 'when page section can be deleted' do
- let!(:page_section) { create(:featured_taxon, pageable: page) }
+ let!(:page_section) { create(:featured_taxon_page_section, pageable: page) }
it 'deletes the page section' do
expect { delete :destroy, params: { id: page_section.id }, format: :turbo_stream }.to change(Spree::PageSection, :count).by(-1)
@@ -64,7 +64,7 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
end
context 'when page section cannot be deleted' do
- let!(:page_section) { create(:page_section, :header) }
+ let!(:page_section) { create(:header_page_section) }
it 'does not delete the page section' do
expect { delete :destroy, params: { id: page_section.id }, format: :turbo_stream }.to change(Spree::PageSection, :count).by(0)
@@ -74,8 +74,8 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
describe '#move_higher' do
context 'within page' do
- let!(:another_page_section) { create(:featured_taxon, pageable: page, position: 1) }
- let!(:page_section) { create(:featured_taxon, pageable: page, position: 2) }
+ let!(:another_page_section) { create(:featured_taxon_page_section, pageable: page, position: 1) }
+ let!(:page_section) { create(:featured_taxon_page_section, pageable: page, position: 2) }
it 'moves the page section higher' do
put :move_higher, params: { id: page_section.id, page_id: page.id }, format: :turbo_stream
@@ -85,8 +85,8 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
end
context 'within theme' do
- let!(:another_page_section) { create(:featured_taxon, pageable: theme, pageable_type: "Spree::Theme", position: 1) }
- let!(:page_section) { create(:featured_taxon, pageable: theme, pageable_type: "Spree::Theme", position: 2) }
+ let!(:another_page_section) { create(:featured_taxon_page_section, pageable: theme, pageable_type: 'Spree::Theme', position: 1) }
+ let!(:page_section) { create(:featured_taxon_page_section, pageable: theme, pageable_type: 'Spree::Theme', position: 2) }
it 'moves the page section higher' do
old_position = page_section.position
@@ -99,8 +99,8 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
describe '#move_lower' do
context 'within page' do
- let!(:page_section) { create(:featured_taxon, pageable: page, position: 1) }
- let!(:another_page_section) { create(:featured_taxon, pageable: page, position: 2) }
+ let!(:page_section) { create(:featured_taxon_page_section, pageable: page, position: 1) }
+ let!(:another_page_section) { create(:featured_taxon_page_section, pageable: page, position: 2) }
it 'moves the page section lower' do
put :move_lower, params: { id: page_section.id, page_id: page.id }, format: :turbo_stream
@@ -110,8 +110,8 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
end
context 'within theme' do
- let!(:page_section) { create(:featured_taxon, pageable: theme, pageable_type: "Spree::Theme", position: 1) }
- let!(:another_page_section) { create(:featured_taxon, pageable: theme, pageable_type: "Spree::Theme", position: 2) }
+ let!(:page_section) { create(:featured_taxon_page_section, pageable: theme, pageable_type: 'Spree::Theme', position: 1) }
+ let!(:another_page_section) { create(:featured_taxon_page_section, pageable: theme, pageable_type: 'Spree::Theme', position: 2) }
it 'moves the page section lower' do
old_position = page_section.position
@@ -123,7 +123,7 @@ RSpec.describe Spree::Admin::PageSectionsController, type: :controller do
end
describe '#restore_design_settings_to_defaults' do
- let(:page_section) { create(:featured_taxon, preferred_top_padding: 50) }
+ let(:page_section) { create(:featured_taxon_page_section, preferred_top_padding: 50) }
it 'restores the design settings to defaults' do
expect(page_section.preferred_top_padding).to eq 50
diff --git a/core/app/models/spree/page_section.rb b/core/app/models/spree/page_section.rb
index a48f5e53df..10ae06f737 100644
--- a/core/app/models/spree/page_section.rb
+++ b/core/app/models/spree/page_section.rb
@@ -187,7 +187,7 @@ module Spree
end
def restore_design_settings_to_defaults
- clear_preferences_for(design_settings_to_restore)
+ restore_preferences_for(design_settings_to_restore)
save
end
diff --git a/core/lib/spree/core/preferences/preferable.rb b/core/lib/spree/core/preferences/preferable.rb
index 7e1f4d56b2..f6a016b2ed 100644
--- a/core/lib/spree/core/preferences/preferable.rb
+++ b/core/lib/spree/core/preferences/preferable.rb
@@ -103,8 +103,8 @@ module Spree::Preferences::Preferable
preferences.keys.each { |pref| preferences.delete pref }
end
- def clear_preferences_for(preference_keys)
- preference_keys.each { |pref| preferences.delete pref }
+ def restore_preferences_for(preference_keys)
+ preference_keys.each { |pref| preferences[pref] = preference_default(pref) }
end
private
diff --git a/core/lib/spree/testing_support/factories/page_block_factory.rb b/core/lib/spree/testing_support/factories/page_block_factory.rb
index 1b06f849ac..eaa46079e5 100644
--- a/core/lib/spree/testing_support/factories/page_block_factory.rb
+++ b/core/lib/spree/testing_support/factories/page_block_factory.rb
@@ -7,7 +7,7 @@ FactoryBot.define do
end
trait :nav do
- section { create(:page_section, :header) }
+ section { create(:header_page_section) }
type { 'Spree::PageBlocks::Nav' }
end
diff --git a/core/lib/spree/testing_support/factories/page_section_factory.rb b/core/lib/spree/testing_support/factories/page_section_factory.rb
index 96ce9120c1..11ed5ef0a7 100644
--- a/core/lib/spree/testing_support/factories/page_section_factory.rb
+++ b/core/lib/spree/testing_support/factories/page_section_factory.rb
@@ -3,22 +3,18 @@ FactoryBot.define do
pageable { Spree::Page.find_by!(name: 'Homepage') }
pageable_type { 'Spree::Page' }
- trait :featured_taxons do
- type { 'Spree::PageSections::FeaturedTaxons' }
+ trait :without_links do
+ do_not_create_links { true }
end
- factory :featured_taxon, class: Spree::PageSections::FeaturedTaxon
+ factory :featured_taxons_page_section, class: Spree::PageSections::FeaturedTaxons
- trait :header do
- type { 'Spree::PageSections::Header' }
- end
+ factory :featured_taxon_page_section, class: Spree::PageSections::FeaturedTaxon
- trait :announcement_bar do
- type { 'Spree::PageSections::AnnouncementBar' }
- end
+ factory :header_page_section, class: Spree::PageSections::Header
- trait :rich_text do
- type { 'Spree::PageSections::RichText' }
- end
+ factory :announcement_bar_page_section, class: Spree::PageSections::AnnouncementBar
+
+ factory :rich_text_page_section, class: Spree::PageSections::RichText
end
end
diff --git a/core/spec/jobs/spree/themes/duplicate_components_job_spec.rb b/core/spec/jobs/spree/themes/duplicate_components_job_spec.rb
index 87e1acb48c..72d60092b7 100644
--- a/core/spec/jobs/spree/themes/duplicate_components_job_spec.rb
+++ b/core/spec/jobs/spree/themes/duplicate_components_job_spec.rb
@@ -10,8 +10,7 @@ RSpec.describe Spree::Themes::DuplicateComponentsJob do
let!(:theme_section_1) do
create(
- :page_section,
- :announcement_bar,
+ :announcement_bar_page_section,
pageable: theme,
pageable_type: 'Spree::Theme',
preferences: {
@@ -28,8 +27,8 @@ RSpec.describe Spree::Themes::DuplicateComponentsJob do
let!(:theme_section_2) do
create(
- :page_section,
- :header,
+ :header_page_section,
+ :without_links,
pageable: theme,
pageable_type: 'Spree::Theme',
preferences: {
@@ -54,12 +53,12 @@ RSpec.describe Spree::Themes::DuplicateComponentsJob do
end
let!(:page_1) { create(:page, :homepage, pageable: theme) }
- let!(:page_1_section) { create(:page_section, :rich_text, pageable: page_1) }
+ let!(:page_1_section) { create(:rich_text_page_section, pageable: page_1) }
let!(:page_1_section_block) { create(:page_block, :heading, section: page_1_section) }
let!(:page_1_section_block_link) { create(:page_link, parent: page_1_section_block, linkable: page_2) }
let!(:page_2) { create(:page, :account, pageable: theme) }
- let!(:page_2_section) { create(:page_section, :header, pageable: page_2) }
+ let!(:page_2_section) { create(:header_page_section, :without_links, pageable: page_2) }
let!(:page_2_section_links) do
[
create(:page_link, parent: page_2_section, linkable: page_1, label: 'Homepage'),
@@ -72,7 +71,7 @@ RSpec.describe Spree::Themes::DuplicateComponentsJob do
let(:duplicated_page_1) { duplicated_theme.pages.find_by(type: page_1.type) }
let(:duplicated_page_1_section) { duplicated_page_1.sections[0] }
- let(:duplicated_page_1_section_block) { duplicated_page_1.sections[0].blocks[0] }
+ let(:duplicated_page_1_section_block) { duplicated_page_1_section.blocks.last }
let(:duplicated_page_2) { duplicated_theme.pages.find_by(type: page_2.type) }
let(:duplicated_page_2_section) { duplicated_page_2.sections.find_by!(name: 'Header') }
diff --git a/core/spec/models/spree/page_section_spec.rb b/core/spec/models/spree/page_section_spec.rb
index 6c9f9f94a1..ea2b74d2a6 100644
--- a/core/spec/models/spree/page_section_spec.rb
+++ b/core/spec/models/spree/page_section_spec.rb
@@ -10,7 +10,7 @@ RSpec.describe Spree::PageSection, type: :model do
expect(homepage.sections).to be_blank
expect(homepage.sections.with_deleted).to be_present
- create_list(:featured_taxon, 4, pageable: homepage)
+ create_list(:featured_taxon_page_section, 4, pageable: homepage)
expect(homepage.reload.sections.pluck(:position)).to match_array([1, 2, 3, 4])
end
end
@@ -104,7 +104,7 @@ RSpec.describe Spree::PageSection, type: :model do
describe 'validations' do
describe 'asset' do
- let(:page_section) { create(:page_section, :header) }
+ let(:page_section) { create(:header_page_section) }
it 'validates content type' do
page_section.asset.attach(
@@ -125,18 +125,21 @@ RSpec.describe Spree::PageSection, type: :model do
describe '#restore_design_settings_to_defaults' do
let(:page_section) do
create(
- :page_section,
- :header,
- preferences: { text_color: '#000000', background_color: '#FFFFFF', border_color: '#000000' }
+ :header_page_section,
+ preferences: { text_color: '#000000', background_color: '#FFFFFF', border_color: '#000000', top_padding: 100, bottom_padding: 100, top_border_width: 10, bottom_border_width: 10 }
)
end
it 'restores design settings to defaults' do
page_section.restore_design_settings_to_defaults
- expect(page_section.preferred_text_color).to be_nil
- expect(page_section.preferred_background_color).to be_nil
- expect(page_section.preferred_border_color).to be_nil
+ expect(page_section.preferred_text_color).to eq Spree::PageSections::Header::TEXT_COLOR_DEFAULT
+ expect(page_section.preferred_background_color).to eq Spree::PageSections::Header::BACKGROUND_COLOR_DEFAULT
+ expect(page_section.preferred_border_color).to eq Spree::PageSections::Header::BORDER_COLOR_DEFAULT
+ expect(page_section.preferred_top_padding).to eq Spree::PageSections::Header::TOP_PADDING_DEFAULT
+ expect(page_section.preferred_bottom_padding).to eq Spree::PageSections::Header::BOTTOM_PADDING_DEFAULT
+ expect(page_section.preferred_top_border_width).to eq Spree::PageSections::Header::TOP_BORDER_WIDTH_DEFAULT
+ expect(page_section.preferred_bottom_border_width).to eq Spree::PageSections::Header::BOTTOM_BORDER_WIDTH_DEFAULT
end
end
end
diff --git a/core/spec/models/spree/page_sections/featured_taxon_spec.rb b/core/spec/models/spree/page_sections/featured_taxon_spec.rb
index 33c5e16a31..ebde8a59d2 100644
--- a/core/spec/models/spree/page_sections/featured_taxon_spec.rb
+++ b/core/spec/models/spree/page_sections/featured_taxon_spec.rb
@@ -4,8 +4,8 @@ RSpec.describe Spree::PageSections::FeaturedTaxon do
describe '.by_taxon_id' do
let!(:taxons) { create_list(:taxon, 3) }
- let!(:featured_taxon_1) { create(:featured_taxon, preferred_taxon_id: taxons[0].id) }
- let!(:featured_taxon_2) { create(:featured_taxon, preferred_taxon_id: taxons[1].id) }
+ let!(:featured_taxon_1) { create(:featured_taxon_page_section, preferred_taxon_id: taxons[0].id) }
+ let!(:featured_taxon_2) { create(:featured_taxon_page_section, preferred_taxon_id: taxons[1].id) }
it 'returns featured taxons by the taxon id' do
expect(described_class.by_taxon_id(taxons[0].id)).to contain_exactly(featured_taxon_1)
diff --git a/core/spec/models/spree/taxon_spec.rb b/core/spec/models/spree/taxon_spec.rb
index 52674fd6ef..8bae95a49f 100644
--- a/core/spec/models/spree/taxon_spec.rb
+++ b/core/spec/models/spree/taxon_spec.rb
@@ -127,7 +127,7 @@ describe Spree::Taxon, type: :model do
describe 'after_destroy :remove_all_featured_sections' do
let(:taxon) { create(:taxon) }
- let!(:featured_section) { create(:featured_taxon, preferred_taxon_id: taxon.id) }
+ let!(:featured_section) { create(:featured_taxon_page_section, preferred_taxon_id: taxon.id) }
it 'removes the associated featured section' do
expect { taxon.destroy! }.to change(Spree::PageSections::FeaturedTaxon, :count).from(3).to(2)
@@ -768,7 +768,7 @@ describe Spree::Taxon, type: :model do
subject { taxon.featured? }
let(:taxon) { create(:taxon) }
- let!(:featured_section) { create(:featured_taxon, preferred_taxon_id: featured_taxon.id) }
+ let!(:featured_section) { create(:featured_taxon_page_section, preferred_taxon_id: featured_taxon.id) }
context 'with a featured section' do
let(:featured_taxon) { taxon }
@@ -788,8 +788,8 @@ describe Spree::Taxon, type: :model do
let(:taxon) { create(:taxon) }
- let!(:featured_sections) { create_list(:featured_taxon, 2, preferred_taxon_id: featured_taxon.id) }
- let!(:other_featured_sections) { create_list(:featured_taxon, 2, preferred_taxon_id: create(:taxon).id) }
+ let!(:featured_sections) { create_list(:featured_taxon_page_section, 2, preferred_taxon_id: featured_taxon.id) }
+ let!(:other_featured_sections) { create_list(:featured_taxon_page_section, 2, preferred_taxon_id: create(:taxon).id) }
context 'with featured sections' do
let(:featured_taxon) { taxon }