spree_page_builder 5.3.0.rc1

data/app/models/spree/page_sections/product_details.rb

@@ -0,0 +1,53 @@
+module Spree
+  module PageSections
+    class ProductDetails < Spree::PageSection
+      TOP_BORDER_WIDTH_DEFAULT = 0
+      TOP_PADDING_DEFAULT = 0
+      BOTTOM_PADDING_DEFAULT = 40
+
+      def icon_name
+        'list-details'
+      end
+
+      def self.role
+        'system'
+      end
+
+      def default_blocks
+        product_metafield_definition_ids = Spree::MetafieldDefinition.where(resource_type: 'Spree::Product').ids
+
+        [
+          Spree::PageBlocks::Products::Brand.new,
+          Spree::PageBlocks::Products::Title.new,
+          Spree::PageBlocks::Products::Price.new(text: Spree.t(:price), preferred_text_alignment: 'left'),
+          Spree::PageBlocks::Products::VariantPicker.new,
+          Spree::PageBlocks::Products::QuantitySelector.new,
+          Spree::PageBlocks::Products::BuyButtons.new,
+          Spree::PageBlocks::Products::Description.new,
+          Spree::PageBlocks::Metafields.new(preferred_metafield_definition_ids: product_metafield_definition_ids),
+        ]
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def available_blocks_to_add
+        [
+          Spree::PageBlocks::Products::Brand,
+          Spree::PageBlocks::Products::Title,
+          Spree::PageBlocks::Products::Price,
+          Spree::PageBlocks::Products::VariantPicker,
+          Spree::PageBlocks::Products::QuantitySelector,
+          Spree::PageBlocks::Products::BuyButtons,
+          Spree::PageBlocks::Products::Description,
+          Spree::PageBlocks::Metafields,
+        ]
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/product_grid.rb

@@ -0,0 +1,13 @@
+module Spree
+  module PageSections
+    class ProductGrid < Spree::PageSection
+      def icon_name
+        'layout-grid'
+      end
+
+      def self.role
+        'system'
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/related_products.rb

@@ -0,0 +1,58 @@
+module Spree
+  module PageSections
+    class RelatedProducts < Spree::PageSection
+      before_validation :make_heading_size_valid
+      before_validation :make_alignment_valid
+
+      preference :heading, :string, default: Spree.t('page_sections.related_products.heading_default')
+      preference :heading_size, :string, default: 'medium'
+      preference :heading_alignment, :string, default: 'left'
+      preference :description_alignment, :string, default: 'left'
+      preference :max_products_to_show, :integer, default: 10
+
+      def icon_name
+        'tags'
+      end
+
+      def lazy?
+        true
+      end
+
+      def layout
+        'swiper'
+      end
+
+      def lazy_path(variables)
+        section_id = variables[:section].id
+        url_options = variables[:url_options] || {}
+
+        if variables[:product].present?
+          product_id = variables[:product].id
+          Spree::Core::Engine.routes.url_helpers.related_product_path(
+            product_id,
+            section_id: section_id,
+            **url_options
+          )
+        elsif variables[:post].present?
+          post_id = variables[:post].id
+          Spree::Core::Engine.routes.url_helpers.related_products_post_path(
+            post_id,
+            section_id: section_id,
+            **url_options
+          )
+        end
+      end
+
+      private
+
+      def make_alignment_valid
+        self.preferred_heading_alignment = 'left' unless %w[left center right].include?(preferred_heading_alignment)
+        self.preferred_description_alignment = 'left' unless %w[left center right].include?(preferred_description_alignment)
+      end
+
+      def make_heading_size_valid
+        self.preferred_heading_size = 'small' unless %w[small medium large].include?(preferred_heading_size)
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/rich_text.rb

@@ -0,0 +1,31 @@
+module Spree
+  module PageSections
+    class RichText < Spree::PageSection
+      def default_blocks
+        [
+          Spree::PageBlocks::Heading.new(text: Spree.t('page_sections.rich_text.heading_default')),
+          Spree::PageBlocks::Text.new(text: Spree.t('page_sections.rich_text.text_default'))
+        ]
+      end
+
+      def available_blocks_to_add
+        [
+          Spree::PageBlocks::Heading,
+          Spree::PageBlocks::Text
+        ]
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def icon_name
+        'text-caption'
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/taxon_banner.rb

@@ -0,0 +1,18 @@
+module Spree
+  module PageSections
+    class TaxonBanner < Spree::PageSection
+      TOP_PADDING_DEFAULT = 20
+      BOTTOM_PADDING_DEFAULT = 20
+      TOP_BORDER_WIDTH_DEFAULT = 0
+      BOTTOM_BORDER_WIDTH_DEFAULT = 1
+
+      def icon_name
+        'heading'
+      end
+
+      def self.role
+        'system'
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/taxon_grid.rb

@@ -0,0 +1,17 @@
+module Spree
+  module PageSections
+    class TaxonGrid < Spree::PageSection
+      TOP_BORDER_WIDTH_DEFAULT = 0
+
+      preference :heading, :string, default: Spree.t('page_sections.taxon_grid.heading_default')
+
+      def icon_name
+        'layout-grid'
+      end
+
+      def self.role
+        'system'
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/video.rb

@@ -0,0 +1,107 @@
+module Spree
+  module PageSections
+    class Video < Spree::PageSection
+      alias video asset
+
+      include Spree::MemoizedData
+      MEMOIZED_METHODS = %w(video_embed)
+
+      after_create :create_video_embed, if: -> { preferred_youtube_video_url.present? }
+      after_update :update_video_embed, if: -> { video_url_changed? || video_embed.nil? }
+      after_destroy :destroy_video_embed
+
+      preference :youtube_video_url, :string
+      preference :youtube_video_embed_id, :string
+      preference :width_desktop, :integer, default: 70
+      preference :separated, :string, default: 'horizontally'
+
+      def default_blocks
+        @default_blocks.presence || [
+          Spree::PageBlocks::Heading.new(
+            text: Spree.t('page_sections.video.heading_1_default'),
+            preferred_text_alignment: nil,
+            preferred_container_alignment: nil,
+            preferred_bottom_padding: 8,
+            preferred_top_padding: 24,
+            preferred_size: 'small'
+          ),
+          Spree::PageBlocks::Heading.new(
+            text: Spree.t('page_sections.video.heading_2_default'),
+            preferred_text_alignment: nil,
+            preferred_container_alignment: nil,
+            preferred_bottom_padding: 8,
+            preferred_top_padding: 24,
+            preferred_size: 'large'
+          ),
+          Spree::PageBlocks::Heading.new(
+            text: store.name,
+            preferred_text_alignment: nil,
+            preferred_container_alignment: nil,
+            preferred_bottom_padding: 8,
+            preferred_top_padding: 24,
+            preferred_size: 'small'
+          )
+        ]
+      end
+
+      def available_blocks_to_add
+        [Spree::PageBlocks::Heading]
+      end
+
+      def icon_name
+        'movie'
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def video_embed
+        @video_embed ||= ::ActionText::VideoEmbed.find_by(id: preferred_youtube_video_embed_id) if preferred_youtube_video_embed_id.present?
+      end
+
+      private
+
+      def video_url_changed?
+        saved_change_to_preferences? &&
+          saved_change_to_preferences[0][:youtube_video_url] != saved_change_to_preferences[1][:youtube_video_url]
+      end
+
+      def create_video_embed
+        oembed_response = oembed_cached_response(preferred_youtube_video_url)
+
+        if oembed_response.present?
+          embed = ::ActionText::VideoEmbed.new
+          embed.url = preferred_youtube_video_url
+          embed.raw_html = oembed_response.html
+          embed.thumbnail_url = oembed_response.thumbnail_url
+
+          embed.save
+          update(preferred_youtube_video_embed_id: embed.id) if embed.persisted?
+        end
+      end
+
+      def update_video_embed
+        destroy_video_embed
+        create_video_embed
+      end
+
+      def destroy_video_embed
+        video_embed.destroy if video_embed.present?
+      end
+
+      def oembed_cached_response(url)
+        return nil if url.blank?
+
+        raw_response = Rails.cache.fetch(['oembed', url]) { ::OEmbed::Providers.get(url).fields.to_json }
+        OEmbed::Response.create_for(raw_response, OEmbed::Providers::Youtube, url, 'json')
+      rescue OEmbed::Error
+        nil
+      end
+    end
+  end
+end

data/app/models/spree/pages/account.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Pages
+    class Account < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:account_path)
+
+        Spree::Core::Engine.routes.url_helpers.account_path
+      end
+
+      def icon_name
+        'user'
+      end
+
+      def linkable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/cart.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Pages
+    class Cart < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:cart_path)
+
+        Spree::Core::Engine.routes.url_helpers.cart_path
+      end
+
+      def icon_name
+        'shopping-cart'
+      end
+
+      def linkable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/checkout.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Pages
+    class Checkout < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:checkout_path)
+
+        Spree::Core::Engine.routes.url_helpers.checkout_path
+      end
+
+      def icon_name
+        'credit-card'
+      end
+    end
+  end
+end

data/app/models/spree/pages/custom.rb

@@ -0,0 +1,38 @@
+module Spree
+  module Pages
+    class Custom < Spree::Page
+      def customizable?
+        true
+      end
+
+      def linkable?
+        true
+      end
+
+      def page_builder_url
+        return unless page_builder_url_exists?(:page_path)
+
+        Spree::Core::Engine.routes.url_helpers.page_path(self)
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::PageTitle.new,
+          Spree::PageSections::RichText.new
+        ]
+      end
+
+      def promote
+        return unless preview?
+
+        ApplicationRecord.transaction do
+          old_page = parent
+          old_page.page_links.update_all(linkable_id: id)
+          update(parent: nil) # clear reference to the old page
+          Spree::Page.find(old_page.id).destroy # destroy the old page with their other previews, etc.
+          update_columns(slug: old_page.slug)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/pages/homepage.rb

@@ -0,0 +1,72 @@
+module Spree
+  module Pages
+    class Homepage < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:root_path)
+
+        Spree::Core::Engine.routes.url_helpers.root_path
+      end
+
+      def icon_name
+        'home'
+      end
+
+      def linkable?
+        true
+      end
+
+      def default_sections
+        sections = [
+          Spree::PageSections::ImageWithText.new(
+            preferred_top_padding: 0,
+            preferred_bottom_padding: 26
+          )
+        ]
+
+        collections_taxonomy = store.taxonomies.find_by(name: Spree.t(:taxonomy_collections_name))
+
+        if collections_taxonomy.present?
+          on_sale_collection = collections_taxonomy.taxons.automatic.find_by(name: Spree.t('automatic_taxon_names.on_sale'))
+          new_arrivals_collection = collections_taxonomy.taxons.automatic.find_by(name: Spree.t('automatic_taxon_names.new_arrivals'))
+
+          if on_sale_collection.present?
+            sections << Spree::PageSections::FeaturedTaxon.new(
+              preferred_heading: Spree.t('pages_defaults.homepage.featured_taxon_heading_on_sale'),
+              preferred_use_description_from_admin: true,
+              preferred_taxon_id: on_sale_collection.id
+            )
+          end
+
+          if new_arrivals_collection.present?
+            sections << Spree::PageSections::FeaturedTaxon.new(
+              preferred_heading: Spree.t('pages_defaults.homepage.featured_taxon_heading_new_arrivals'),
+              preferred_use_description_from_admin: true,
+              preferred_taxon_id: new_arrivals_collection.id
+            )
+          end
+        end
+
+        sections << Spree::PageSections::ImageWithText.new(
+          preferred_background_color: '#F0EFE9', # accent color,
+          default_blocks: [
+            Spree::PageBlocks::Heading.new(
+              text: Spree.t('pages_defaults.homepage.image_with_text_heading'),
+              preferred_text_alignment: 'left',
+              preferred_bottom_padding: 8,
+              preferred_top_padding: 24
+            ),
+            Spree::PageBlocks::Text.new(
+              text: Spree.t('pages_defaults.homepage.image_with_text_text'),
+              preferred_text_alignment: 'left',
+              preferred_bottom_padding: 16
+            )
+          ]
+        )
+      end
+
+      def customizable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/login.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Pages
+    class Login < Spree::Page
+      def icon_name
+        'key'
+      end
+
+      def page_builder_url
+        return unless page_builder_url_exists?(:login_path)
+
+        Spree::Core::Engine.routes.url_helpers.login_path
+      end
+
+      def linkable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/password.rb

@@ -0,0 +1,59 @@
+module Spree
+  module Pages
+    class Password < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:password_path)
+
+        Spree::Core::Engine.routes.url_helpers.password_path
+      end
+
+      def preview_url(theme_preview = nil, page_preview = nil)
+        return unless page_builder_url_exists?(:password_path)
+
+        Spree::Core::Engine.routes.url_helpers.password_path(
+          theme_id: theme.id,
+          page_preview_id: page_preview&.id,
+          theme_preview_id: theme_preview&.id
+        )
+      end
+
+      def icon_name
+        'key'
+      end
+
+      def customizable?
+        true
+      end
+
+      def layout_sections?
+        false
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::MainPasswordHeader.new,
+          Spree::PageSections::Newsletter.new(
+            default_blocks: [
+              Spree::PageBlocks::Heading.new(
+                text: Spree.t('pages_defaults.password.newsletter_heading'),
+                preferred_width_desktop: 50, # in %
+                preferred_text_alignment: 'center',
+                preferred_container_alignment: 'center',
+                preferred_bottom_padding: 8
+              ),
+              Spree::PageBlocks::Text.new(
+                text: Spree.t('pages_defaults.password.newsletter_text'),
+                preferred_text_alignment: 'center',
+                preferred_bottom_padding: 32,
+                preferred_width_desktop: 50,
+                preferred_container_alignment: 'center'
+              ),
+              Spree::PageBlocks::NewsletterForm.new
+            ]
+          ),
+          Spree::PageSections::MainPasswordFooter.new,
+        ]
+      end
+    end
+  end
+end

data/app/models/spree/pages/post.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Pages
+    class Post < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:post_path)
+
+        post = store.posts.published.last || store.posts.last
+        return if post.nil?
+        Spree::Core::Engine.routes.url_helpers.post_path(post)
+      end
+
+      def icon_name
+        'article'
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::PostDetails.new,
+        ]
+      end
+
+      def customizable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/post_list.rb

@@ -0,0 +1,36 @@
+module Spree
+  module Pages
+    class PostList < Spree::Page
+      DISPLAY_NAME = Spree.t(:blog).freeze
+
+      def page_builder_url
+        return unless page_builder_url_exists?(:posts_path)
+
+        Spree::Core::Engine.routes.url_helpers.posts_path
+      end
+
+      def icon_name
+        'news'
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::PageTitle.new(preferred_title: DISPLAY_NAME),
+          Spree::PageSections::PostGrid.new
+        ]
+      end
+
+      def display_name
+        DISPLAY_NAME
+      end
+
+      def customizable?
+        true
+      end
+
+      def linkable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/product_details.rb

@@ -0,0 +1,30 @@
+module Spree
+  module Pages
+    class ProductDetails < Spree::Page
+      def page_builder_url
+        return unless page_builder_url_exists?(:product_path)
+
+        product = store.products.active.first || store.products.first
+        return if product.nil?
+
+        Spree::Core::Engine.routes.url_helpers.product_path(product)
+      end
+
+      def icon_name
+        'tag'
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::Breadcrumbs.new,
+          Spree::PageSections::ProductDetails.new,
+          Spree::PageSections::RelatedProducts.new
+        ]
+      end
+
+      def customizable?
+        true
+      end
+    end
+  end
+end

data/app/models/spree/pages/search_results.rb

@@ -0,0 +1,43 @@
+module Spree
+  module Pages
+    class SearchResults < Spree::Page
+      def icon_name
+        'search'
+      end
+
+      def page_builder_url
+        return unless page_builder_url_exists?(:search_path)
+
+        Spree::Core::Engine.routes.url_helpers.search_path(
+          q: 'test',
+          theme_id: theme.id,
+          page_preview_id: page_preview&.id,
+          theme_preview_id: theme_preview&.id,
+          locale: I18n.locale
+        )
+      end
+
+      def preview_url(theme_preview = nil, page_preview = nil)
+        return unless page_builder_url_exists?(:search_path)
+
+        Spree::Core::Engine.routes.url_helpers.search_path(
+          q: 'test',
+          theme_id: theme.id,
+          page_preview_id: page_preview&.id,
+          theme_preview_id: theme_preview&.id
+        )
+      end
+
+      def default_sections
+        [
+          Spree::PageSections::PageTitle.new(preferred_title: 'Search Results'),
+          Spree::PageSections::ProductGrid.new
+        ]
+      end
+
+      def customizable?
+        true
+      end
+    end
+  end
+end