spree_page_builder 5.3.0.rc1

data/app/models/spree/page_blocks/products/buy_buttons.rb

@@ -0,0 +1,24 @@
+module Spree
+  module PageBlocks
+    module Products
+      class BuyButtons < Spree::PageBlock
+        TOP_PADDING_DEFAULT = 0
+        BOTTOM_PADDING_DEFAULT = 20
+
+        preference :text_color, :string
+
+        def icon_name
+          'shopping-cart-plus'
+        end
+
+        def display_name
+          Spree.t('page_blocks.products.buy_buttons.display_name')
+        end
+
+        def form_partial_name
+          'products/buy_buttons'
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/description.rb

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Description < Spree::PageBlocks::Text
+        TOP_PADDING_DEFAULT = 0
+        BOTTOM_PADDING_DEFAULT = 20
+
+        def form_partial_name
+          'products/description'
+        end
+
+        def display_name
+          I18n.t('activerecord.attributes.spree/product.description')
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/price.rb

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Price < Spree::PageBlocks::Text
+        TOP_PADDING_DEFAULT = 16
+        BOTTOM_PADDING_DEFAULT = 16
+
+        def icon_name
+          'cash'
+        end
+
+        def display_name
+          Spree.t(:price)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/quantity_selector.rb

@@ -0,0 +1,20 @@
+module Spree
+  module PageBlocks
+    module Products
+      class QuantitySelector < Spree::PageBlock
+        TOP_PADDING_DEFAULT = 0
+        BOTTOM_PADDING_DEFAULT = 20
+
+        preference :text_color, :string
+
+        def icon_name
+          'plus-minus'
+        end
+
+        def form_partial_name
+          'products/quantity_selector'
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/share.rb

@@ -0,0 +1,8 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Share < Spree::PageBlocks::Text
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/title.rb

@@ -0,0 +1,19 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Title < Spree::PageBlocks::Heading
+        TOP_PADDING_DEFAULT = 16
+
+        preference :text_color, :string
+
+        def display_name
+          I18n.t('activerecord.attributes.spree/product.name')
+        end
+
+        def icon_name
+          'h-1'
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/variant_picker.rb

@@ -0,0 +1,13 @@
+module Spree
+  module PageBlocks
+    module Products
+      class VariantPicker < Spree::PageBlock
+        preference :text_color, :string
+
+        def icon_name
+          'list-details'
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/subheading.rb

@@ -0,0 +1,17 @@
+module Spree
+  module PageBlocks
+    class Subheading < Spree::PageBlock
+      SIZE_DEFAULT = 'small'
+
+      preference :text_color, :string
+
+      def icon_name
+        'h-2'
+      end
+
+      def display_name
+        text.to_plain_text.truncate(30)
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/text.rb

@@ -0,0 +1,16 @@
+module Spree
+  module PageBlocks
+    class Text < Spree::PageBlock
+      preference :text_color, :string
+      preference :background_color, :string
+
+      def icon_name
+        'align-justified'
+      end
+
+      def display_name
+        text.to_plain_text.truncate(30)
+      end
+    end
+  end
+end

data/app/models/spree/page_builder/policy_decorator.rb

@@ -0,0 +1,17 @@
+module Spree
+  module PageBuilder
+    module PolicyDecorator
+      def self.prepended(base)
+        base.include Spree::Linkable
+      end
+
+      def page_builder_url
+        return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:policy_path)
+
+        Spree::Core::Engine.routes.url_helpers.policy_path(self)
+      end
+    end
+  end
+end
+
+Spree::Policy.prepend(Spree::PageBuilder::PolicyDecorator)

data/app/models/spree/page_builder/post_decorator.rb

@@ -0,0 +1,17 @@
+module Spree
+  module PageBuilder
+    module PostDecorator
+      def self.prepended(base)
+        base.include Spree::Linkable
+      end
+
+      def page_builder_url
+        return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:post_path)
+
+        Spree::Core::Engine.routes.url_helpers.post_path(self)
+      end
+    end
+  end
+end
+
+Spree::Post.prepend(Spree::PageBuilder::PostDecorator)

data/app/models/spree/page_builder/product_decorator.rb

@@ -0,0 +1,17 @@
+module Spree
+  module PageBuilder
+    module ProductDecorator
+      def self.prepended(base)
+        base.include Spree::Linkable
+      end
+
+      def page_builder_url
+        return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:product_path)
+
+        Spree::Core::Engine.routes.url_helpers.product_path(self)
+      end
+    end
+  end
+end
+
+Spree::Product.prepend(Spree::PageBuilder::ProductDecorator)

data/app/models/spree/page_builder/store_decorator.rb

@@ -0,0 +1,46 @@
+module Spree
+  module PageBuilder
+    module StoreDecorator
+      def self.prepended(base)
+        base.include Spree::HasPageLinks
+
+        # Page Builder associations
+        base.has_many :themes, -> { without_previews }, class_name: 'Spree::Theme', dependent: :destroy, inverse_of: :store
+        base.has_many :theme_previews,
+                      -> { only_previews },
+                      class_name: 'Spree::Theme',
+                      through: :themes,
+                      source: :previews,
+                      inverse_of: :store,
+                      dependent: :destroy
+        base.has_one :default_theme, -> { without_previews.where(default: true) }, class_name: 'Spree::Theme', inverse_of: :store
+        base.alias_method :theme, :default_theme
+        base.has_many :theme_pages, class_name: 'Spree::Page', through: :themes, source: :pages
+        base.has_many :theme_page_previews, class_name: 'Spree::Page', through: :theme_pages, source: :previews
+        base.has_many :pages, -> { without_previews.custom }, class_name: 'Spree::Pages::Custom', dependent: :destroy, as: :pageable
+        base.has_many :page_previews, class_name: 'Spree::Pages::Custom', through: :pages, as: :pageable, source: :previews
+
+        base.after_create :create_default_theme
+      end
+
+      private
+
+      def create_default_theme
+        themes.find_or_initialize_by(default: true) do |theme|
+          theme.name = Spree.t(:default_theme_name)
+          theme.save!
+        end
+      end
+
+      def create_default_policies
+        super
+
+        policies.each do |policy|
+          links.find_or_create_by(linkable: policy)
+        end
+      end
+    end
+  end
+end
+
+Spree::Store.prepend(Spree::PageBuilder::StoreDecorator)

data/app/models/spree/page_builder/taxon_decorator.rb

@@ -0,0 +1,45 @@
+module Spree
+  module PageBuilder
+    module TaxonDecorator
+      def self.prepended(base)
+        base.include Spree::Linkable
+
+        base.class_eval do
+          after_commit :touch_featured_sections, on: [:update]
+          after_touch :touch_featured_sections
+          after_destroy :remove_featured_sections, if: -> { featured? }
+        end
+      end
+
+      def page_builder_url
+        return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:nested_taxons_path)
+
+        Spree::Core::Engine.routes.url_helpers.nested_taxons_path(self)
+      end
+
+      def page_builder_image
+        square_image.presence || image
+      end
+
+      def featured?
+        featured_sections.any?
+      end
+
+      def featured_sections
+        @featured_sections ||= Spree::PageSections::FeaturedTaxon.published.by_taxon_id(id)
+      end
+
+      private
+
+      def touch_featured_sections
+        Spree::Taxons::TouchFeaturedSections.call(taxon_ids: [id])
+      end
+
+      def remove_featured_sections
+        featured_sections.destroy_all
+      end
+    end
+  end
+end
+
+Spree::Taxon.prepend(Spree::PageBuilder::TaxonDecorator)

data/app/models/spree/page_link.rb

@@ -0,0 +1,60 @@
+module Spree
+  class PageLink < Spree.base_class
+    #
+    # Magic methods
+    #
+    acts_as_list scope: :parent
+
+    #
+    # Associations
+    #
+    belongs_to :parent, polymorphic: true, touch: true, counter_cache: true # Block or Section
+    belongs_to :linkable, polymorphic: true, optional: true # Page, Product, etc.
+    has_one :theme, through: :parent
+
+    #
+    # Validations
+    #
+    validates :label, :parent, presence: true
+    validates :url, presence: true, unless: :linkable
+
+    #
+    # Callbacks
+    #
+    after_destroy :notify_parent
+    before_validation :set_label, on: [:create, :update]
+
+    def linkable_url
+      @linkable_url ||= linkable&.page_builder_url || formatted_url
+    end
+
+    def formatted_url
+      return if url.blank?
+      return url if %w[mailto: tel:].any? { |protocol| url.start_with?(protocol) }
+
+      @formatted_url ||= url.match(/http:\/\/|https:\/\//) ? url : "http://#{url}"
+    end
+
+    private
+
+    def notify_parent
+      return unless parent.present?
+      return unless parent.respond_to?(:link_destroyed)
+
+      parent.link_destroyed(self)
+    end
+
+    def set_label
+      return if label.present? && new_record?
+      return unless linkable_id_changed?
+
+      if linkable.respond_to?(:title)
+        self.label = linkable.title
+      elsif linkable.respond_to?(:display_name)
+        self.label = linkable.display_name
+      elsif linkable.respond_to?(:name)
+        self.label = linkable.name
+      end
+    end
+  end
+end

data/app/models/spree/page_section.rb

@@ -0,0 +1,222 @@
+module Spree
+  class PageSection < Spree.base_class
+    include Spree::HasPageLinks
+    #
+    # Magic methods
+    #
+    acts_as_paranoid
+    acts_as_list scope: [:pageable_type, :pageable_id, { deleted_at: nil }]
+
+    #
+    # Associations
+    #
+    belongs_to :pageable, polymorphic: true, touch: true # this can be either Page or Theme
+    has_many :blocks, lambda {
+                        order(position: :asc)
+                      }, class_name: 'Spree::PageBlock', dependent: :destroy, inverse_of: :section, foreign_key: :section_id
+    alias page_blocks blocks
+    delegate :store, to: :pageable
+
+    #
+    # Attachments
+    #
+    has_one_attached :asset, service: Spree.public_storage_service_name
+    alias image asset
+
+    #
+    # Rich Text
+    #
+    has_rich_text :text
+    has_rich_text :description
+
+    #
+    # Validations
+    #
+    validates :name, :pageable, presence: true
+    validates :asset, content_type: Rails.application.config.active_storage.web_image_content_types
+
+    #
+    # Callbacks
+    #
+    before_validation :set_name, on: :create
+    after_create :create_blocks, unless: :do_not_create_blocks
+
+    #
+    # Scopes
+    #
+    scope :published, -> { where(pageable_type: 'Spree::Page') }
+    scope :related_products, -> { where(type: 'Spree::PageSections::RelatedProducts') }
+
+    #
+    # Preferences
+    #
+    TEXT_COLOR_DEFAULT = nil
+    BACKGROUND_COLOR_DEFAULT = nil
+    BORDER_COLOR_DEFAULT = nil
+    TOP_PADDING_DEFAULT = 40
+    BOTTOM_PADDING_DEFAULT = 40
+    TOP_BORDER_WIDTH_DEFAULT = 1
+    BOTTOM_BORDER_WIDTH_DEFAULT = 0
+
+    preference :text_color, :string, default: -> { self.class::TEXT_COLOR_DEFAULT if defined?(self.class::TEXT_COLOR_DEFAULT) }
+    preference :background_color, :string, default: -> { self.class::BACKGROUND_COLOR_DEFAULT if defined?(self.class::BACKGROUND_COLOR_DEFAULT) }
+    preference :border_color, :string, default: -> { self.class::BORDER_COLOR_DEFAULT if defined?(self.class::BORDER_COLOR_DEFAULT) }
+    preference :top_padding, :integer, default: -> { self.class::TOP_PADDING_DEFAULT if defined?(self.class::TOP_PADDING_DEFAULT) }
+    preference :bottom_padding, :integer, default: -> { self.class::BOTTOM_PADDING_DEFAULT if defined?(self.class::BOTTOM_PADDING_DEFAULT) }
+    preference :top_border_width, :integer, default: -> { self.class::TOP_BORDER_WIDTH_DEFAULT if defined?(self.class::TOP_BORDER_WIDTH_DEFAULT) }
+    preference :bottom_border_width, :integer, default: -> { self.class::BOTTOM_BORDER_WIDTH_DEFAULT if defined?(self.class::BOTTOM_BORDER_WIDTH_DEFAULT) }
+
+    #
+    # Virtual attributes
+    #
+    attribute :do_not_create_blocks, :boolean, default: false
+    attr_accessor :default_blocks
+
+    def to_partial_path
+      "spree/page_sections/#{type.to_s.demodulize.underscore}"
+    end
+
+    # this should be overridden in subclasses
+    def default_blocks
+      @default_blocks.presence || []
+    end
+
+    def blocks_available?
+      false
+    end
+
+    def available_blocks_to_add
+      []
+    end
+
+    def can_sort_blocks?
+      false
+    end
+
+    # this should be overridden in subclasses
+    # content - can be managed by the user
+    # system - main parts of the page eg. product details, login form
+    # header - header section
+    # footer - footer section
+    def self.role
+      'content'
+    end
+
+    def role
+      self.class.role
+    end
+
+    def theme
+      @theme ||= if pageable.is_a?(Spree::Theme)
+                   pageable
+                 else
+                   pageable.theme
+                 end
+    end
+
+    def icon_name
+      'text-caption'
+    end
+
+    def can_be_deleted?
+      role == 'content'
+    end
+
+    def can_be_sorted?
+      true
+    end
+
+    def lazy?
+      false
+    end
+
+    def lazy_path(variables)
+      url_options = variables[:url_options] || {}
+
+      Spree::Core::Engine.routes.url_helpers.page_section_path(self, **url_options)
+    end
+
+    def rich_text_fields
+      self.class.rich_text_association_names.map { |rt| rt.to_s.sub('rich_text_', '') }
+    end
+
+    def copy_rich_text_fields_from(other)
+      rich_text_fields.each do |field|
+        send(field).body = other.send(field).body
+      end
+    end
+
+    def deep_clone(target)
+      new_section = type.constantize.new(
+        preferences: preferences,
+        position: position,
+        pageable: target
+      )
+      new_section.copy_rich_text_fields_from(self)
+      new_section.do_not_create_blocks = true
+      new_section.do_not_create_links = true
+      new_section.save!
+
+      new_section.asset.attach(asset.blob) if asset.attached?
+
+      blocks.includes(:links, asset_attachment: :blob).each do |block|
+        new_block = block.type.constantize.new(
+          preferences: block.preferences,
+          position: block.position,
+          section: new_section
+        )
+        new_block.do_not_create_links = true
+        new_block.text = block.text if block.respond_to?(:text) # we need to copy ActionText content
+        new_block.save!
+
+        new_block.asset.attach(block.asset.blob) if block.asset.attached?
+
+        deep_clone_links(block, new_block)
+      end
+
+      deep_clone_links(self, new_section)
+    end
+
+    def deep_clone_links(section_or_block, new_section_or_block)
+      section_or_block.links.each do |link|
+        new_link = link.dup
+        new_link.parent = new_section_or_block
+        new_link.save!
+      end
+    end
+
+    # Turns out #dup doesn't not copy rich text content to the new record.
+    # https://github.com/rails/rails/issues/36683
+    def dup
+      super.tap do |object|
+        object.copy_rich_text_fields_from(self)
+      end
+    end
+
+    def restore_design_settings_to_defaults
+      restore_preferences_for(design_settings_to_restore)
+      save
+    end
+
+    def display_name
+      name
+    end
+
+    private
+
+    def design_settings_to_restore
+      [:text_color, :background_color, :border_color, :top_padding, :bottom_padding, :top_border_width, :bottom_border_width]
+    end
+
+    def create_blocks
+      default_blocks.each do |block|
+        block.section = self
+        block.save!
+      end
+    end
+
+    def set_name
+      self.name ||= type.to_s.demodulize.titleize
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Spree
+  module PageSections
+    class AnnouncementBar < Spree::PageSection
+      before_validation :set_default_text, on: :create
+
+      BACKGROUND_COLOR_DEFAULT = '#F5F5F4'
+      TOP_PADDING_DEFAULT = 8
+      BOTTOM_PADDING_DEFAULT = 8
+      TOP_BORDER_WIDTH_DEFAULT = 0
+
+      def self.role
+        'header'
+      end
+
+      def icon_name
+        'speakerphone'
+      end
+
+      private
+
+      def set_default_text
+        return unless text.blank?
+
+        self.text = Spree.t('page_sections.announcement_bar.default_text')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module PageSections
+    class Breadcrumbs < Spree::PageSection
+      TOP_PADDING_DEFAULT = 20
+      BOTTOM_PADDING_DEFAULT = 20
+
+      def icon_name
+        'chevron-right'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module PageSections
+    class CollectionBanner < 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/custom_code.rb

@@ -0,0 +1,11 @@
+module Spree
+  module PageSections
+    class CustomCode < Spree::PageSection
+      preference :custom_code, :string, default: ''
+
+      def icon_name
+        'code'
+      end
+    end
+  end
+end