spree_page_builder 5.3.0.rc1

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

@@ -0,0 +1,45 @@
+module Spree
+  module PageSections
+    class FeaturedPosts < Spree::PageSection
+      before_validation :make_heading_size_valid
+      before_validation :make_max_posts_to_show_valid
+      before_validation :make_alignment_valid
+      before_validation :make_posts_to_show_valid
+
+      preference :heading, :string, default: ''
+      preference :heading_size, :string, default: 'large'
+      preference :heading_alignment, :string, default: 'left'
+      preference :description_alignment, :string, default: 'left'
+      preference :posts_to_show, :string, default: 'newest'
+      preference :max_posts_to_show, :integer, default: 4
+
+      def icon_name
+        'news'
+      end
+
+      def posts
+        Spree::Post.published.by_newest.limit(preferred_max_posts_to_show)
+      end
+
+      private
+
+      def make_posts_to_show_valid
+        self.preferred_posts_to_show = 'newest' unless %w[newest most_popular].include?(preferred_posts_to_show)
+      end
+
+      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_max_posts_to_show_valid
+        self.preferred_max_posts_to_show = 2 if preferred_max_posts_to_show < 2
+        self.preferred_max_posts_to_show = 8 if preferred_max_posts_to_show > 8
+      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/featured_product.rb

@@ -0,0 +1,50 @@
+module Spree
+  module PageSections
+    class FeaturedProduct < Spree::PageSection
+      preference :product_id, :string, default: ''
+
+      def icon_name
+        'star'
+      end
+
+      def product
+        return @product if defined?(@product)
+
+        includes = [
+          { variants: { images: [], prices: [], stock_items: [], stock_locations: [], option_values: :option_type } },
+        ]
+
+        @product ||= store.products.includes(includes).find_by(id: preferred_product_id)
+      end
+
+      def vendor_name
+        return unless defined?(Spree::Vendor)
+
+        @vendor_name ||= product&.vendor&.display_name || 'Brand'
+      end
+
+      def product_name
+        product&.name
+      end
+
+      def default_blocks
+        [
+          Spree::PageBlocks::Products::Title.new,
+          Spree::PageBlocks::Products::Price.new(text: 'Price', preferred_text_alignment: 'left'),
+          Spree::PageBlocks::Products::VariantPicker.new,
+          Spree::PageBlocks::Products::QuantitySelector.new,
+          Spree::PageBlocks::Products::BuyButtons.new,
+          Spree::PageBlocks::Products::Share.new(text: 'Share')
+        ]
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+module Spree
+  module PageSections
+    class FeaturedTaxon < Spree::PageSection
+      scope :by_taxon_id, lambda { |taxon_ids|
+        queries = [*taxon_ids].map do |taxon_id|
+          where("#{Spree::PageSections::FeaturedTaxon.table_name}.preferences LIKE ?", "%taxon_id: '#{taxon_id}'%")
+        end
+
+        queries.reduce(:or)
+      }
+
+      before_validation :make_heading_size_valid
+      before_validation :make_alignment_valid
+      before_validation :make_taxon_id_valid
+
+      preference :heading, :string, default: Spree.t('page_sections.featured_taxon.heading_default')
+      preference :heading_size, :string, default: 'large'
+      preference :heading_alignment, :string, default: 'left'
+      preference :description_alignment, :string, default: 'left'
+      preference :use_description_from_admin, :boolean, default: true
+      preference :show_taxon_image, :boolean, default: true
+      preference :show_more_button, :boolean, default: true
+      preference :taxon_id, :string, default: ''
+      preference :max_products_to_show, :integer, default: 20
+      preference :button_style, :string, default: 'primary'
+      preference :button_text_color, :string, default: nil
+      preference :button_background_color, :string, default: nil
+      preference :button_text, :string, default: Spree.t('page_sections.featured_taxon.button_text_default')
+
+      def icon_name
+        'tags'
+      end
+
+      def lazy?
+        !Rails.env.test?
+      end
+
+      def taxon
+        @taxon ||= store.taxons.find_by(id: preferred_taxon_id) if preferred_taxon_id.present?
+      end
+
+      def description_to_use
+        @description_to_use ||= preferred_use_description_from_admin && description.blank? ? taxon&.description : description
+      end
+
+      def display_name
+        @display_name ||= preferred_heading.present? ? "#{preferred_heading} - #{name}" : name
+      end
+
+      def products(currency)
+        Spree::Deprecation.warn(
+          'FeaturedTaxon#products is deprecated and will be removed in Spree 5.5. ' \
+          'Please use taxon_products(featured_taxon.taxon) helper method in views instead'
+        )
+
+        @products ||= begin
+          finder_params = {
+            store: store,
+            filter: { taxons: preferred_taxon_id },
+            currency: currency,
+            sort_by: 'default'
+          }
+
+          Spree.products_finder.new(scope: store.products, params: finder_params).execute.limit(preferred_max_products_to_show)
+        end
+      end
+
+      private
+
+      def make_taxon_id_valid
+        self.preferred_taxon_id = preferred_taxon_id.presence || store.taxons.where(depth: 1).first&.id
+      end
+
+      def set_heading
+        return unless collection_id_changed?
+
+        self.heading = collection&.title
+      end
+
+      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/featured_taxons.rb

@@ -0,0 +1,45 @@
+module Spree
+  module PageSections
+    class FeaturedTaxons < Spree::PageSection
+      before_validation :make_heading_size_valid
+      before_validation :make_alignment_valid
+
+      preference :heading, :string, default: Spree.t('page_sections.featured_taxons.heading_default')
+      preference :heading_size, :string, default: 'large'
+      preference :heading_alignment, :string, default: 'left'
+
+      def icon_name
+        'layout-grid'
+      end
+
+      def links_available?
+        true
+      end
+
+      def allowed_linkable_types
+        [
+          [Spree.t(:taxon), 'Spree::Taxon']
+        ]
+      end
+
+      def default_linkable_type
+        default_linkable_resource.class.to_s
+      end
+
+      def default_linkable_resource
+        @default_linkable_resource ||= Spree::Taxon.where(parent: store.taxonomies.first.root).first ||
+                                        store.theme_pages.find_by(type: 'Spree::Pages::Homepage')
+      end
+
+      private
+
+      def make_heading_size_valid
+        self.preferred_heading_size = 'small' unless %w[small medium large].include?(preferred_heading_size)
+      end
+
+      def make_alignment_valid
+        self.preferred_heading_alignment = 'left' unless %w[left center right].include?(preferred_heading_alignment)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+module Spree
+  module PageSections
+    class Footer < Spree::PageSection
+      alias logo asset
+
+      BACKGROUND_COLOR_DEFAULT = '#F5F5F4'
+      TOP_PADDING_DEFAULT = 32
+      BOTTOM_PADDING_DEFAULT = 32
+      TOP_BORDER_WIDTH_DEFAULT = 0
+
+      preference :copyright_text_color, :string, default: '#FFFFFF'
+      preference :copyright_background_color, :string, default: '#000000'
+
+      def self.role
+        'footer'
+      end
+
+      def icon_name
+        'layout-bottombar'
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def available_blocks_to_add
+        [Spree::PageBlocks::Nav]
+      end
+
+      def default_blocks
+        shop_default_links = [
+          Spree::PageLink.new(
+            linkable: pages.find_by(type: 'Spree::Pages::ShopAll')
+          )
+        ]
+
+        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'))
+
+          shop_default_links << Spree::PageLink.new(linkable: on_sale_collection) if on_sale_collection.present?
+          shop_default_links << Spree::PageLink.new(linkable: new_arrivals_collection) if new_arrivals_collection.present?
+        end
+
+        default_info_links = []
+
+        if store.policies.find_by(name: Spree.t('terms_of_service')).present?
+          default_info_links << Spree::PageLink.new(
+            label: Spree.t('terms_of_service'),
+            linkable: store.policies.find_by(name: Spree.t('terms_of_service'))
+          )
+        end
+
+        if store.policies.find_by(name: Spree.t('privacy_policy')).present?
+          default_info_links << Spree::PageLink.new(
+            label: Spree.t('privacy_policy'),
+            linkable: store.policies.find_by(name: Spree.t('privacy_policy'))
+          )
+        end
+
+        [
+          Spree::PageBlocks::Nav.new(
+            preferred_label: 'Shop',
+            default_links: shop_default_links
+          ),
+          Spree::PageBlocks::Nav.new(
+            preferred_label: Spree.t('account'),
+            default_links: [
+              Spree::PageLink.new(
+                label: Spree.t('my_account'),
+                linkable: pages.find_by(type: 'Spree::Pages::Account')
+              ),
+              Spree::PageLink.new(
+                label: 'Favorites',
+                linkable: pages.find_by(type: 'Spree::Pages::Wishlist')
+              )
+            ]
+          ),
+          Spree::PageBlocks::Nav.new(
+            preferred_label: 'Company',
+            default_links: []
+          ),
+          Spree::PageBlocks::Nav.new(
+            preferred_label: 'Info',
+            default_links: default_info_links
+          )
+        ]
+      end
+
+      def pages
+        @pages ||= theme.pages
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Spree
+  module PageSections
+    class Header < Spree::PageSection
+      alias logo asset
+
+      TOP_PADDING_DEFAULT = 15
+      BOTTOM_PADDING_DEFAULT = 15
+      TOP_BORDER_WIDTH_DEFAULT = 0
+
+      preference :layout, :string, default: 'logo-centered'
+      preference :desktop_logo_height, :integer, default: 0
+
+      def self.role
+        'header'
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def available_blocks_to_add
+        [Spree::PageBlocks::MegaNavWithSubcategories, Spree::PageBlocks::MegaNav, Spree::PageBlocks::Link]
+      end
+
+      def icon_name
+        'layout-navbar'
+      end
+
+      def links_available?
+        true
+      end
+
+      def default_links
+        links = [
+          Spree::PageLink.new(linkable: pages.find_by(type: 'Spree::Pages::ShopAll'))
+        ]
+
+        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'))
+
+          links << Spree::PageLink.new(linkable: on_sale_collection) if on_sale_collection.present?
+          links << Spree::PageLink.new(linkable: new_arrivals_collection) if new_arrivals_collection.present?
+        end
+
+        links << Spree::PageLink.new(linkable: pages.find_by(type: 'Spree::Pages::PostList'))
+
+        links
+      end
+
+      def pages
+        @pages ||= theme.pages
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Spree
+  module PageSections
+    class ImageBanner < Spree::PageSection
+      include Spree::HasImageAltText
+      
+      TOP_PADDING_DEFAULT = 0
+      BOTTOM_PADDING_DEFAULT = 0
+
+      preference :overlay_transparency, :integer, default: 40
+      preference :height, :integer, default: 384
+      preference :vertical_alignment, :string, default: :middle
+      preference :image_alt, :string
+
+      def default_blocks
+        [
+          Spree::PageBlocks::Heading.new(
+            text: Spree.t('page_sections.image_banner.heading_default'),
+            preferred_text_alignment: 'center',
+            preferred_container_alignment: 'center',
+            preferred_width_desktop: 50
+          ),
+          Spree::PageBlocks::Text.new(
+            text: Spree.t('page_sections.image_banner.text_default'),
+            preferred_text_alignment: 'center',
+            preferred_container_alignment: 'center',
+            preferred_width_desktop: 50
+          ),
+          Spree::PageBlocks::Buttons.new
+        ]
+      end
+
+      def available_blocks_to_add
+        [
+          Spree::PageBlocks::Buttons,
+          Spree::PageBlocks::Heading,
+          Spree::PageBlocks::Text
+        ]
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def icon_name
+        'slideshow'
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Spree
+  module PageSections
+    class ImageWithText < Spree::PageSection
+      include Spree::HasImageAltText
+      
+      TOP_PADDING_DEFAULT = 16
+      BOTTOM_PADDING_DEFAULT = 16
+
+      preference :desktop_image_alignment, :string, default: 'right'
+      preference :vertical_alignment, :string, default: :middle
+      preference :image_alt, :string
+
+      has_one :link, ->(ps) { ps.links }, class_name: 'Spree::PageLink', as: :parent, dependent: :destroy, inverse_of: :parent
+      accepts_nested_attributes_for :link
+
+      def default_blocks
+        @default_blocks.presence || [
+          Spree::PageBlocks::Heading.new(
+            text: Spree.t('page_sections.image_with_text.heading_default'),
+            preferred_text_alignment: 'left',
+            preferred_bottom_padding: 8,
+            preferred_top_padding: 24
+          ),
+          Spree::PageBlocks::Text.new(
+            text: Spree.t('page_sections.image_with_text.text_default', store_name: store.name),
+            preferred_text_alignment: 'left',
+            preferred_bottom_padding: 16
+          ),
+          Spree::PageBlocks::Buttons.new(preferred_text_alignment: 'left')
+        ]
+      end
+
+      def available_blocks_to_add
+        [
+          Spree::PageBlocks::Buttons,
+          Spree::PageBlocks::Heading,
+          Spree::PageBlocks::Text
+        ]
+      end
+
+      def default_links
+        @default_links.presence || [
+          Spree::PageLink.new(
+            label: Spree.t(:shop_all),
+            linkable: theme.pages.find_by(type: 'Spree::Pages::ShopAll')
+          )
+        ]
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def icon_name
+        'photo'
+      end
+
+
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module PageSections
+    class MainPasswordFooter < Spree::PageSection
+      alias logo asset
+
+      TOP_PADDING_DEFAULT = 32
+      BOTTOM_PADDING_DEFAULT = 32
+
+      def self.role
+        'footer'
+      end
+
+      def icon_name
+        'layout-bottombar'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Spree
+  module PageSections
+    class MainPasswordHeader < Spree::PageSection
+      alias logo asset
+
+      TOP_PADDING_DEFAULT = 15
+      BOTTOM_PADDING_DEFAULT = 15
+
+      preference :desktop_logo_height, :integer, default: 0
+
+      def self.role
+        'header'
+      end
+
+      def icon_name
+        'layout-navbar'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Spree
+  module PageSections
+    class Newsletter < Spree::PageSection
+      include Spree::HasImageAltText
+      
+      preference :overlay_transparency, :integer, default: 40
+      preference :image_alt, :string
+
+      def default_blocks
+        @default_blocks.presence || [
+          Spree::PageBlocks::Heading.new(
+            text: Spree.t('page_sections.newsletter.heading_default'),
+            preferred_width_desktop: 50, # in %
+            preferred_text_alignment: 'center',
+            preferred_container_alignment: 'center',
+            preferred_bottom_padding: 8
+          ),
+          Spree::PageBlocks::Text.new(
+            text: Spree.t('page_sections.newsletter.text_default'),
+            preferred_text_alignment: 'center',
+            preferred_bottom_padding: 32,
+            preferred_width_desktop: 50,
+            preferred_container_alignment: 'center'
+          ),
+          Spree::PageBlocks::NewsletterForm.new
+        ]
+      end
+
+      def self.role
+        'footer'
+      end
+
+      def lazy?
+        !Rails.env.test?
+      end
+
+      def blocks_available?
+        true
+      end
+
+      def available_blocks_to_add
+        [Spree::PageBlocks::Image, Spree::PageBlocks::Heading, Spree::PageBlocks::Text, Spree::PageBlocks::NewsletterForm]
+      end
+
+      def can_sort_blocks?
+        true
+      end
+
+      def icon_name
+        'mail'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module PageSections
+    class PageTitle < Spree::PageSection
+      preference :title, :string
+
+      def icon_name
+        'heading'
+      end
+
+      def display_name
+        if pageable.is_a?(Spree::Page) && pageable.custom?
+          pageable.name
+        else
+          Spree.t('page_sections.page_title.display_name')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module PageSections
+    class PostDetails < Spree::PageSection
+      DISPLAY_NAME = Spree.t(:post).freeze
+
+      def icon_name
+        'article'
+      end
+
+      def self.role
+        'system'
+      end
+
+      def display_name
+        DISPLAY_NAME
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module PageSections
+    class PostGrid < Spree::PageSection
+      DISPLAY_NAME = Spree.t(:posts).freeze
+
+      def icon_name
+        'news'
+      end
+
+      def self.role
+        'system'
+      end
+
+      def display_name
+        DISPLAY_NAME
+      end
+    end
+  end
+end