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.

Set pages as STI

Matthew Kennedy3bc0bb9bb8f3
diff --git a/backend/app/assets/javascripts/spree/backend/cms/page.es6 b/backend/app/assets/javascripts/spree/backend/cms/page.es6
index f5cee19c29..344efb844e 100644
--- a/backend/app/assets/javascripts/spree/backend/cms/page.es6
+++ b/backend/app/assets/javascripts/spree/backend/cms/page.es6
@@ -1,5 +1,6 @@
document.addEventListener('DOMContentLoaded', function() {
-const el = document.getElementById('cmsPagesectionsArea')
+ updateCmsPageType()
+ const el = document.getElementById('cmsPagesectionsArea')
if (el) {
Sortable.create(el, {
@@ -14,6 +15,24 @@ const el = document.getElementById('cmsPagesectionsArea')
}
})
}
+
+ $('#cms_page_type').on('change', function() {
+ updateCmsPageType()
+ });
+
+ function updateCmsPageType () {
+ const linkSettingsPanel = document.getElementById('cms_page_slug_field')
+
+ if (!linkSettingsPanel) return
+
+ const selectedLinkType = $('#cms_page_type').val()
+
+ if (selectedLinkType === 'Spree::Cms::Pages::Homepage') {
+ linkSettingsPanel.classList.add('d-none')
+ } else {
+ linkSettingsPanel.classList.remove('d-none')
+ }
+ }
})
function handleSectionReposition(evt) {
diff --git a/backend/app/controllers/spree/admin/cms_pages_controller.rb b/backend/app/controllers/spree/admin/cms_pages_controller.rb
index 14179fe930..ea4c4ceb63 100644
--- a/backend/app/controllers/spree/admin/cms_pages_controller.rb
+++ b/backend/app/controllers/spree/admin/cms_pages_controller.rb
@@ -6,7 +6,7 @@ module Spree
private
def load_data
- @page_kinds = Spree::CmsPage::PAGE_KINDS
+ @page_types = Spree::CmsPage::PAGE_TYPES
end
def location_after_save
diff --git a/backend/app/helpers/spree/admin/cms_page_helper.rb b/backend/app/helpers/spree/admin/cms_page_helper.rb
index 991b321a95..d36d48d9c8 100644
--- a/backend/app/helpers/spree/admin/cms_page_helper.rb
+++ b/backend/app/helpers/spree/admin/cms_page_helper.rb
@@ -19,6 +19,18 @@ module Spree
def linkable_as_path(item)
item.parameterize(separator: '_')
end
+
+ def page_types_dropdown_values
+ formatted_types = []
+
+ Spree::CmsPage::PAGE_TYPES.each do |type|
+ last_word = type.split('::', 4).last
+ readable_type = last_word.gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
+ formatted_types << [readable_type, type]
+ end
+
+ formatted_types
+ end
end
end
end
diff --git a/backend/app/views/spree/admin/cms_pages/_form.html.erb b/backend/app/views/spree/admin/cms_pages/_form.html.erb
index 89a47adb32..e20f70ad51 100644
--- a/backend/app/views/spree/admin/cms_pages/_form.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/_form.html.erb
@@ -7,6 +7,19 @@
</div>
<div class="card-body">
+ <div class="row">
+ <%= f.field_container :type, class: ['form-group col-12 col-md-6'] do %>
+ <%= f.label :type, Spree.t('admin.cms.page_type') %>
+ <%= f.select(:type, page_types_dropdown_values, {include_blank: false}, class: 'select2') %>
+ <%= f.error_message_on :type %>
+ <% end %>
+
+ <div class="col-12 col-md-6 mt-3">
+ <div class="alert alert-info">Select your page type... (Add more info)</div>
+ </div>
+ <div class="col-12"><hr></div>
+ </div>
+
<div class="row pb-0">
<%= f.field_container :title, class: ['form-group col-6'] do %>
<%= f.label :title, raw(Spree.t('admin.cms.page_title') + required_span_tag) %>
@@ -14,12 +27,6 @@
<%= f.error_message_on :title %>
<% end %>
- <%= f.field_container :kind, class: ['form-group col-6'] do %>
- <%= f.label :kind, Spree.t('admin.cms.page_type') %>
- <%= f.select(:kind, @page_kinds, {include_blank: false}, class: 'select2') %>
- <%= f.error_message_on :kind %>
- <% end %>
-
<%= f.field_container :cms_page_stores, class: ['form-group col-6'] do %>
<%= label_tag :cms_page_stores, Spree.t(:stores) %>
<%= collection_select(:cms_page, :store_id, @stores, :id, :unique_name, {}, { class: 'select2' }) %>
@@ -32,6 +39,12 @@
<%= f.error_message_on :default_locale %>
<% end %>
+ <%= f.field_container :slug, class: ['form-group col-6'] do %>
+ <%= f.label :slug, Spree.t('admin.pages.slug') %>
+ <%= f.text_field :slug, class: 'form-control' %>
+ <%= f.error_message_on :slug %>
+ <% end %>
+
<%= f.field_container :visible, class: ['form-group col-6'] do %>
<div class="custom-control custom-checkbox">
<%= f.check_box :visible, class: 'custom-control-input' %>
@@ -50,18 +63,12 @@
<hr class="mt-5">
<h5 class="mt-4"><%= Spree.t('admin.cms.seo_settings') %></h5>
<div class="row pb-0">
- <%= f.field_container :meta_title, class: ['form-group col-6'] do %>
+ <%= f.field_container :meta_title, class: ['form-group col-12'] do %>
<%= f.label :meta_title, Spree.t('admin.pages.meta_title') %>
<%= f.text_field :meta_title, class: 'form-control' %>
<%= f.error_message_on :meta_title %>
<% end %>
- <%= f.field_container :slug, class: ['form-group col-6'] do %>
- <%= f.label :slug, Spree.t('admin.pages.slug') %>
- <%= f.text_field :slug, class: 'form-control' %>
- <%= f.error_message_on :slug %>
- <% end %>
-
<%= f.field_container :meta_description, class: ['form-group col-12'] do %>
<%= f.label :meta_description, Spree.t('admin.pages.meta_description') %>
<%= f.text_area :meta_description, { rows: 3, class: 'form-control' } %>
@@ -77,7 +84,7 @@
</div>
</div>
- <% if @cms_page.kind == 'Standard Page' %>
+ <% if @cms_page.type == 'Spree::Cms::Pages::StandardPage' %>
<div class="row">
<div class="col-12">
<%= f.field_container :content, class: ['form-group'] do %>
diff --git a/backend/app/views/spree/admin/cms_pages/_section_template.html.erb b/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
index b3f6668fea..ad8d7999f1 100644
--- a/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/_section_template.html.erb
@@ -5,7 +5,7 @@
<div class="d-flex align-items-center overflow-hidden w-100">
<div>
<h5 class="mb-0"><%= section.name %></h5>
- <small class="form-text text-muted mt-0">Type: <%= section.kind %></small>
+ <small class="form-text text-muted mt-0">Type: <%= section.type %></small>
</div>
<div class="ml-4 pl-4 v-seperator">
diff --git a/backend/app/views/spree/admin/cms_pages/edit.html.erb b/backend/app/views/spree/admin/cms_pages/edit.html.erb
index ffad03934f..80ce8370a3 100644
--- a/backend/app/views/spree/admin/cms_pages/edit.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/edit.html.erb
@@ -7,14 +7,14 @@
<% end %>
<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @cms_page } %>
-<%= form_for [:admin, @cms_page] do |f| %>
+<%= form_for [:admin, @cms_page], as: :cms_page, url: spree.admin_cms_page_path do |f| %>
<%= render partial: 'form', locals: { f: f } %>
<div class="col-12">
<%= render partial: 'spree/admin/shared/edit_resource_links' %>
</div>
<% end %>
-<% unless @cms_page.kind == "Standard Page" %>
+<% if @cms_page.sections? %>
<div id="pageSectionsArea" class="col-12">
<div class="row mt-5">
<div class="col-12">
diff --git a/backend/app/views/spree/admin/cms_pages/index.html.erb b/backend/app/views/spree/admin/cms_pages/index.html.erb
index 46900cfb10..49faba1837 100644
--- a/backend/app/views/spree/admin/cms_pages/index.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/index.html.erb
@@ -23,7 +23,7 @@
<%= page.title %>
</td>
<td>
- <%= page.kind %>
+ <%= page.type %>
</td>
<td>
<%= page.store.unique_name %>
diff --git a/backend/app/views/spree/admin/cms_pages/sections/_featured_atricle.html.erb b/backend/app/views/spree/admin/cms_pages/sections/_featured_atricle.html.erb
index 6d01b42d9d..6742da5baa 100644
--- a/backend/app/views/spree/admin/cms_pages/sections/_featured_atricle.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/sections/_featured_atricle.html.erb
@@ -5,7 +5,7 @@
</div>
<div class="col text-center">
<div>Name: <%= section.name %></div>
- <div>Type: <%= section.kind %></div>
+ <div>Type: <%= section.type %></div>
<div class="m-auto" style="width:50px;">
<% if section.icon.present? %>
<div class="cms_section_preview_image_holder">
diff --git a/backend/app/views/spree/admin/cms_pages/sections/_hero.html.erb b/backend/app/views/spree/admin/cms_pages/sections/_hero.html.erb
index 6d01b42d9d..6742da5baa 100644
--- a/backend/app/views/spree/admin/cms_pages/sections/_hero.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/sections/_hero.html.erb
@@ -5,7 +5,7 @@
</div>
<div class="col text-center">
<div>Name: <%= section.name %></div>
- <div>Type: <%= section.kind %></div>
+ <div>Type: <%= section.type %></div>
<div class="m-auto" style="width:50px;">
<% if section.icon.present? %>
<div class="cms_section_preview_image_holder">
diff --git a/backend/app/views/spree/admin/cms_pages/sections/_promo.html.erb b/backend/app/views/spree/admin/cms_pages/sections/_promo.html.erb
index b47f1509be..6829f78149 100644
--- a/backend/app/views/spree/admin/cms_pages/sections/_promo.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/sections/_promo.html.erb
@@ -5,7 +5,7 @@
</div>
<div class="col text-center p-0">
<div>Name: <%= section.name %></div>
- <div>Type: <%= section.kind %></div>
+ <div>Type: <%= section.type %></div>
<div class="m-auto" style="width:50px;">
<% if section.icon.present? %>
<div class="cms_section_preview_image_holder">
diff --git a/backend/app/views/spree/admin/cms_pages/sections/_text_block.html.erb b/backend/app/views/spree/admin/cms_pages/sections/_text_block.html.erb
index 1d0ac76302..73e319cc46 100644
--- a/backend/app/views/spree/admin/cms_pages/sections/_text_block.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/sections/_text_block.html.erb
@@ -5,7 +5,7 @@
</div>
<div class="col text-center p-0">
<div>Name: <%= section.name %></div>
- <div>Type: <%= section.kind %></div>
+ <div>Type: <%= section.type %></div>
<div class="m-auto">
<% if section.icon.present? %>
<div class="cms_section_preview_image_holder">
diff --git a/core/app/models/spree/cms/pages/feature_page.rb b/core/app/models/spree/cms/pages/feature_page.rb
new file mode 100644
index 0000000000..d170dbd65c
--- /dev/null
+++ b/core/app/models/spree/cms/pages/feature_page.rb
@@ -0,0 +1,9 @@
+module Spree::Cms::Pages
+ class FeaturePage < Spree::CmsPage
+ validates :slug, uniqueness: true
+
+ def sections?
+ true
+ end
+ end
+end
diff --git a/core/app/models/spree/cms/pages/homepage.rb b/core/app/models/spree/cms/pages/homepage.rb
new file mode 100644
index 0000000000..a577454b90
--- /dev/null
+++ b/core/app/models/spree/cms/pages/homepage.rb
@@ -0,0 +1,15 @@
+module Spree::Cms::Pages
+ class Homepage < Spree::CmsPage
+ validates :type, uniqueness: { scope: [:store, :locale] }
+
+ def sections?
+ false
+ end
+
+ private
+
+ def create_slug
+ self.slug = nil
+ end
+ end
+end
diff --git a/core/app/models/spree/cms/pages/standard_page.rb b/core/app/models/spree/cms/pages/standard_page.rb
new file mode 100644
index 0000000000..c26ec444cf
--- /dev/null
+++ b/core/app/models/spree/cms/pages/standard_page.rb
@@ -0,0 +1,9 @@
+module Spree::Cms::Pages
+ class StandardPage < Spree::CmsPage
+ validates :slug, uniqueness: true
+
+ def sections?
+ false
+ end
+ end
+end
diff --git a/core/app/models/spree/cms_page.rb b/core/app/models/spree/cms_page.rb
index 8f4393b8e4..bafc429589 100644
--- a/core/app/models/spree/cms_page.rb
+++ b/core/app/models/spree/cms_page.rb
@@ -1,6 +1,6 @@
module Spree
class CmsPage < Spree::Base
- PAGE_KINDS = ['Standard Page', 'Feature Page', 'Home Page']
+ PAGE_TYPES = ['Spree::Cms::Pages::StandardPage', 'Spree::Cms::Pages::FeaturePage', 'Spree::Cms::Pages::Homepage']
extend FriendlyId
friendly_id :slug, use: [:slugged, :finders, :history]
@@ -12,8 +12,6 @@ module Spree
before_validation :create_slug
validates :title, presence: true
- validates :slug, uniqueness: true
- validates :kind, uniqueness: { scope: [:store, :locale] }, if: :home_page?
scope :visible, -> { where visible: true }
scope :by_store, ->(store) { where(store: store) }
@@ -27,14 +25,18 @@ module Spree
end
def home_page(store, locale)
- find_by(store: store, locale: locale.to_s, kind: 'Home Page') ||
- find_by(store: store, locale: locale.to_s)
+ find_by(store: store, locale: locale.to_s, type: 'Spree::Cms::Pages::Homepage') ||
+ find_by(store: store, type: 'Spree::Cms::Pages::Homepage')
+ end
+
+ def sections?
+ false
end
private
def home_page?
- kind == 'Home Page'
+ type == 'Spree::Cms::Pages::Homepage'
end
def create_slug
diff --git a/core/db/migrate/20210512191732_create_spree_cms_pages.rb b/core/db/migrate/20210512191732_create_spree_cms_pages.rb
index b68d4b96cc..117b13b385 100644
--- a/core/db/migrate/20210512191732_create_spree_cms_pages.rb
+++ b/core/db/migrate/20210512191732_create_spree_cms_pages.rb
@@ -7,7 +7,7 @@ class CreateSpreeCmsPages < ActiveRecord::Migration[6.0]
t.column :meta_description, :text
t.column :visible, :boolean, default: false
t.column :slug, :string
- t.column :kind, :string, default: 'Standard Page'
+ t.column :type, :string
t.column :locale, :string
t.belongs_to :store
diff --git a/frontend/app/views/spree/cms_pages/show.html.erb b/frontend/app/views/spree/cms_pages/show.html.erb
index 5a999b9939..c0ca46a9e1 100644
--- a/frontend/app/views/spree/cms_pages/show.html.erb
+++ b/frontend/app/views/spree/cms_pages/show.html.erb
@@ -1,4 +1,4 @@
-<% if @cms_page.content.present? && @cms_page.kind == 'Standard Page' %>
+<% if @cms_page.content.present? && !@cms_page.sections? %>
<div class="container">
<div class="row my-5">
<div class="col-12">