spree_page_builder 5.3.0.rc1

data/app/jobs/spree/themes/duplicate_components_job.rb

@@ -0,0 +1,59 @@
+module Spree
+  module Themes
+    class DuplicateComponentsJob < Spree::BaseJob
+      queue_as Spree.queues.themes
+
+      # We need to duplicate:
+      # 1. Theme files + sections with pageable_type Spree::Theme.
+      # 2. Duplicate pages + sections.
+      # 3. Adjust linkable on page links for Spree::PageSection and Spree::PageBlock parents and Spree::Page linkable.
+
+      def perform(theme_id, duplicated_theme_id)
+        theme = Spree::Theme.find(theme_id)
+        duplicated_theme = Spree::Theme.find(duplicated_theme_id)
+
+        ApplicationRecord.transaction do
+          duplicated_pages = duplicate_pages(theme, duplicated_theme)
+
+          # Duplicated links on pages and blocks have references to pages from the previous theme
+          # We need to look for a duplicated page and update the link with it
+          duplicate_layout_sections(theme, duplicated_theme)
+          adjust_page_links(theme, duplicated_theme, duplicated_pages)
+
+          duplicated_theme.update!(ready: true)
+        end
+      end
+
+      private
+
+      def duplicate_layout_sections(theme, duplicated_theme)
+        theme.layout_sections.each { |section| section.deep_clone(duplicated_theme) }
+      end
+
+      def duplicate_pages(theme, duplicated_theme)
+        theme.pages.map { |page| page.duplicate(duplicated_theme) }
+      end
+
+      def adjust_page_links(theme, duplicated_theme, duplicated_pages)
+        page_sections = Spree::PageSection.where(pageable: duplicated_pages)
+        layout_sections = duplicated_theme.layout_sections
+        all_section_ids = page_sections.ids + layout_sections.ids
+
+        all_page_blocks = Spree::PageBlock.where(section_id: all_section_ids)
+
+        all_parent_ids = all_section_ids + all_page_blocks.ids
+        all_page_links = Spree::PageLink.
+                          includes(:linkable, parent: :pageable).
+                          where(linkable_type: 'Spree::Page').
+                          where(parent_id: all_parent_ids, linkable_id: theme.pages)
+
+        all_page_links.each do |page_link|
+          linkable_type = page_link.linkable.type
+          duplicated_page = duplicated_theme.pages.find_by(type: linkable_type)
+
+          page_link.update!(linkable: duplicated_page)
+        end
+      end
+    end
+  end
+end

data/app/jobs/spree/themes/screenshot_job.rb

@@ -0,0 +1,81 @@
+require 'uri'
+require 'net/http'
+
+module Spree
+  module Themes
+    class ScreenshotJob < Spree::BaseJob
+      queue_as Spree.queues.themes
+
+      BASE_SCREENSHOT_API_URL = 'https://shot.screenshotapi.net/v3/screenshot'.freeze
+      SCREENSHOT_OUTPUT = 'image'.freeze
+      SCREENSHOT_FILE_TYPE = 'png'.freeze
+
+      def perform(theme_id)
+        theme = Spree::Theme.find(theme_id)
+
+        Rails.logger.warn('Screenshot API token is missing') and return if screenshot_api_token.blank?
+
+        return if theme.screenshot.attached?
+
+        url = URI.encode_www_form_component("#{theme.store.url_or_custom_domain}?theme_id=#{theme_id}")
+        query_params = {
+          token: screenshot_api_token,
+          url: url,
+          output: SCREENSHOT_OUTPUT,
+          file_type: SCREENSHOT_FILE_TYPE,
+          retina: true,
+          enable_caching: true
+        }
+        query = "#{BASE_SCREENSHOT_API_URL}?#{query_params.to_query}"
+
+        # Send a GET request to the API
+        uri = URI.parse(query)
+        response = Net::HTTP.get_response(uri)
+
+        case response.code
+        when '301', '302'
+          redirect_uri = response['location']
+          redirect_uri = URI.parse(redirect_uri)
+          response = Net::HTTP.get_response(redirect_uri)
+          save_screenshot(theme, response)
+        when '200'
+          save_screenshot(theme, response)
+        else
+          Rails.error.report('Screenshot API returned non-200 status code')
+        end
+      end
+
+      private
+
+      def screenshot_api_token
+        @screenshot_api_token ||= Spree.screenshot_api_token
+      end
+
+      def save_screenshot(theme, response)
+        temp_file_path = "theme-screenshot-#{theme.id}.png"
+
+        # Create a temporary file
+        File.open(temp_file_path, "wb") do |file|
+          file.write(response.body)
+        end
+
+        # Open the file for reading to attach it
+        file = File.open(temp_file_path, "rb")
+
+        # Attach the file
+        theme.screenshot.attach(
+          io: file,
+          filename: "theme-screenshot-#{theme.id}.#{SCREENSHOT_FILE_TYPE}",
+          content_type: "image/#{SCREENSHOT_FILE_TYPE}"
+        )
+        theme.save!
+
+        # Close the file before attempting to delete it
+        file.close
+
+        # Remove the temporary file
+        File.delete(temp_file_path) if File.exist?(temp_file_path)
+      end
+    end
+  end
+end

data/app/models/concerns/spree/has_page_links.rb

@@ -0,0 +1,53 @@
+module Spree
+  module HasPageLinks
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :links, -> { order(:position).includes(:linkable) }, class_name: 'Spree::PageLink', as: :parent, dependent: :destroy, inverse_of: :parent
+      alias page_links links
+
+      after_create :create_default_links, unless: :do_not_create_links
+
+      attribute :do_not_create_links, :boolean, default: false
+      attr_accessor :default_links
+
+      def allowed_linkable_types
+        [
+          [Spree.t(:page), 'Spree::Page'],
+          [Spree.t(:product), 'Spree::Product'],
+          [Spree.t(:post), 'Spree::Post'],
+          [Spree.t(:taxon), 'Spree::Taxon'],
+          [Spree.t(:policy), 'Spree::Policy'],
+          [Spree.t(:url), nil]
+        ]
+      end
+
+      def default_linkable_type
+        'Spree::Page'
+      end
+
+      def theme_or_parent
+        theme.preview? ? theme.parent : theme
+      end
+
+      def default_linkable_resource
+        @default_linkable_resource ||= theme_or_parent.pages.find_by(type: 'Spree::Pages::Homepage')
+      end
+
+      def default_links
+        @default_links.presence || []
+      end
+
+      def links_available?
+        true
+      end
+
+      def create_default_links
+        default_links.each do |link|
+          link.parent = self
+          link.save!
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page.rb

@@ -0,0 +1,188 @@
+module Spree
+  class Page < Spree.base_class
+    include Spree::Previewable
+    include Spree::Linkable
+
+    #
+    # Magic methods
+    #
+    extend FriendlyId
+    friendly_id :slug_candidates, use: [:slugged, :scoped, :history], scope: :pageable
+    acts_as_paranoid
+
+    #
+    # Associations
+    #
+    belongs_to :pageable, polymorphic: true # this can be either Store or Theme
+    has_many :sections, -> { order(position: :asc) }, class_name: 'Spree::PageSection', dependent: :destroy_async, as: :pageable
+    alias page_sections sections
+
+    #
+    # Validations
+    #
+    validates :name, presence: true
+    validates :pageable, presence: true
+    validates :slug, uniqueness: { scope: :pageable, conditions: -> { where(deleted_at: nil).where.not(slug: nil) } }
+
+    #
+    # Callbacks
+    #
+    before_validation :set_name
+    after_create :create_default_sections, unless: :duplicating
+
+    #
+    # Scopes
+    #
+    scope :linkable, lambda {
+                        where(type: [
+                                'Spree::Pages::Homepage',
+                                'Spree::Pages::ShopAll',
+                                'Spree::Pages::PostList',
+                                'Spree::Pages::Custom',
+                                'Spree::Pages::Account',
+                                'Spree::Pages::Login'
+                              ])
+                     }
+    scope :product_details, -> { where(type: 'Spree::Pages::ProductDetails') }
+    scope :standard, -> { where.not(type: 'Spree::Pages::Custom') }
+    scope :custom, -> { where(type: 'Spree::Pages::Custom') }
+
+    #
+    # Virtual attributes
+    #
+    attribute :duplicating, :boolean, default: false
+
+    def icon_name
+      'file-earmark-richtext'
+    end
+
+    def store
+      if pageable.is_a?(Spree::Store)
+        pageable
+      else
+        pageable.store
+      end
+    end
+
+    def create_preview
+      return self if preview? # no need to create a preview for the preview
+
+      ActiveRecord::Base.connected_to(role: :writing) do
+        ApplicationRecord.transaction do
+          new_preview = dup
+          new_preview.parent = self
+          new_preview.duplicating = true
+          new_preview.save!
+
+          sections.includes(:links, { asset_attachment: :blob }, { blocks: [:rich_text_text, :links] }).each do |section|
+            section.deep_clone(new_preview)
+          end
+
+          new_preview
+        end
+      end
+    end
+
+    # Promotes the page preview to the main page
+    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.
+      end
+    end
+
+    def default_sections
+      []
+    end
+
+    def customizable?
+      false
+    end
+
+    def linkable?
+      false
+    end
+
+    def layout_sections?
+      true
+    end
+
+    def preview_url(theme_preview = nil, page_preview = nil)
+      return if page_builder_url.blank?
+
+      "#{page_builder_url}?#{url_query_params(theme_preview, page_preview).to_query}"
+    end
+
+    def display_name
+      if custom?
+        name
+      else
+        name.titleize
+      end
+    end
+
+    def custom?
+      type == 'Spree::Pages::Custom'
+    end
+
+    def duplicate(target_pageable)
+      duplicated_page = dup
+      duplicated_page.duplicating = true
+      duplicated_page.pageable = target_pageable
+      duplicated_page.save!
+
+      sections_scope = sections.includes(:links, :blocks, { asset_attachment: :blob },
+                                         { blocks: [:rich_text_text, :links, { asset_attachment: :blob }] })
+      sections_scope.each { |section| section.deep_clone(duplicated_page) }
+
+      duplicated_page
+    end
+
+    def theme
+      @theme ||= if pageable.is_a?(Spree::Theme)
+                   pageable
+                 else
+                   pageable.default_theme
+                 end
+    end
+
+    private
+
+    def create_default_sections
+      default_sections.each do |section|
+        section.pageable = self
+        section.save!
+      end
+    end
+
+    def url_query_params(theme_preview, page_preview)
+      theme_preview_cache = theme_preview.updated_at.to_i.to_s + rand(999_999).to_s if theme_preview
+
+      {
+        theme_id: theme.id,
+        page_preview_id: page_preview&.id,
+        theme_preview_id: theme_preview&.id,
+        theme_preview_cache: theme_preview_cache
+      }
+    end
+
+    def set_name
+      return if custom?
+      return if name.present?
+
+      self.name = self.class.name.demodulize
+    end
+
+    def should_generate_new_friendly_id?
+      name_changed? && custom?
+    end
+
+    def page_builder_url_exists?(path)
+      Spree::Core::Engine.routes.url_helpers.respond_to?(path)
+    end
+  end
+end

data/app/models/spree/page_block.rb

@@ -0,0 +1,73 @@
+module Spree
+  class PageBlock < Spree.base_class
+    include Spree::HasPageLinks
+
+    #
+    # Magic methods
+    #
+    acts_as_paranoid
+    acts_as_list scope: :section
+
+    #
+    # Associations
+    #
+    belongs_to :section, class_name: 'Spree::PageSection', inverse_of: :blocks, touch: true
+    delegate :store, :theme, to: :section
+
+    #
+    # Rich Text
+    #
+    has_rich_text :text
+
+    #
+    # Attachments
+    #
+    has_one_attached :asset, service: Spree.public_storage_service_name
+
+    #
+    # Validations
+    #
+    validates :section, :type, :name, presence: true
+    validates :asset, content_type: Rails.application.config.active_storage.web_image_content_types
+
+    #
+    # Callbacks
+    #
+    before_validation :set_name_from_type, on: :create
+
+    #
+    # Preferences
+    #
+    TEXT_ALIGNMENT_DEFAULT = 'left'
+    CONTAINER_ALIGNMENT_DEFAULT = 'left'
+    SIZE_DEFAULT = 'medium'
+    WIDTH_DESKTOP_DEFAULT = 100
+    TOP_PADDING_DEFAULT = 0
+    BOTTOM_PADDING_DEFAULT = 0
+
+    preference :text_alignment, :string, default: -> { self.class::TEXT_ALIGNMENT_DEFAULT if defined?(self.class::TEXT_ALIGNMENT_DEFAULT) }
+    preference :container_alignment, :string, default: -> { self.class::CONTAINER_ALIGNMENT_DEFAULT if defined?(self.class::CONTAINER_ALIGNMENT_DEFAULT) }
+    preference :size, :string, default: -> { self.class::SIZE_DEFAULT if defined?(self.class::SIZE_DEFAULT) }
+    preference :width_desktop, :integer, default: -> { self.class::WIDTH_DESKTOP_DEFAULT if defined?(self.class::WIDTH_DESKTOP_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) }
+
+    def display_name
+      name
+    end
+
+    def form_partial_name
+      type.demodulize.underscore
+    end
+
+    def icon_name
+      'fullscreen'
+    end
+
+    private
+
+    def set_name_from_type
+      self.name ||= type.demodulize.titleize
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Spree
+  module PageBlocks
+    class Buttons < Spree::PageBlock
+      include Spree::HasOneLink
+
+      TEXT_ALIGNMENT_DEFAULT = 'center'
+
+      preference :button_style_1, :string, default: 'primary'
+      preference :background_color, :string
+      preference :button_background_color, :string
+      preference :button_text_color, :string
+
+      # Without link there is no purpose of the button.
+      def link_destroyed(_link)
+        return unless page_links_count.zero?
+
+        destroy
+      end
+
+      def display_name
+        Spree.t('page_blocks.buttons.display_name')
+      end
+
+      def icon_name
+        'click'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    class Heading < Spree::PageBlock
+      SIZE_DEFAULT = 'large'
+
+      preference :text_color, :string
+      preference :background_color, :string
+
+      def icon_name
+        'heading'
+      end
+
+      def display_name
+        text.to_plain_text.truncate(30)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Spree
+  module PageBlocks
+    class Image < Spree::PageBlock
+      include Spree::HasImageAltText
+      
+      alias image asset
+
+      TOP_PADDING_DEFAULT = 20
+      BOTTOM_PADDING_DEFAULT = 20
+
+      preference :height, :integer, default: 64
+      preference :mobile_height, :integer, default: 32
+      preference :image_alt, :string
+
+      def icon_name
+        'photo'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module PageBlocks
+    class Link < Spree::PageBlock
+      include Spree::HasOneLink
+
+      def icon_name
+        'menu-2'
+      end
+
+      def display_name
+        link&.label || Spree.t('page_blocks.link.display_name')
+      end
+
+      def link_destroyed(_link)
+        return unless page_links_count.zero?
+
+        destroy
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Spree
+  module PageBlocks
+    class MegaNav < Spree::PageBlock
+      include Spree::HasPageLinks
+
+      has_one :link, ->(ps) { ps.links.where(position: 1) }, class_name: 'Spree::PageLink', as: :parent, dependent: :destroy, inverse_of: :parent
+      accepts_nested_attributes_for :link
+
+      preference :featured_taxon_id, :string, default: ''
+
+      def featured_taxon
+        store.taxons.find_by(id: preferred_featured_taxon_id) if preferred_featured_taxon_id.present?
+      end
+
+      def icon_name
+        'layout-navbar-expand'
+      end
+
+      def display_name
+        link&.label || Spree.t(:mega_nav)
+      end
+
+      def default_links
+        @default_links.presence || [
+          Spree::PageLink.new(
+            label: Spree.t(:shop_all),
+            linkable: theme_or_parent.pages.find_by(type: 'Spree::Pages::ShopAll')
+          ),
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Spree
+  module PageBlocks
+    class MegaNavWithSubcategories < Spree::PageBlock
+      preference :taxon_id, :string, default: ''
+      preference :featured_taxon_id, :string, default: ''
+
+      before_validation :make_taxon_id_valid
+
+      def taxon
+        store.taxons.find_by(id: preferred_taxon_id) if preferred_taxon_id.present?
+      end
+
+      def featured_taxon
+        store.taxons.find_by(id: preferred_featured_taxon_id) if preferred_featured_taxon_id.present?
+      end
+
+      def icon_name
+        'category'
+      end
+
+      def display_name
+        taxon&.name || Spree.t(:mega_nav_with_subcategories)
+      end
+
+      private
+
+      def make_taxon_id_valid
+        self.preferred_taxon_id = preferred_taxon_id.presence || store.taxons.where(depth: 1).first&.id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    class Metafields < Spree::PageBlock
+      RESOURCE_TYPE_DEFAULT = 'Spree::Product'
+
+      preference :resource_type, :string, default: -> { self.class::RESOURCE_TYPE_DEFAULT if defined?(self.class::RESOURCE_TYPE_DEFAULT) }
+      preference :metafield_definition_ids, :array, default: -> { available_metafield_definitions.pluck(:id) }
+
+      def icon_name
+        'list'
+      end
+
+      def available_metafield_definitions
+        @available_metafield_definitions ||= Spree::MetafieldDefinition.where(resource_type: preferred_resource_type).available_on_front_end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module PageBlocks
+    class Nav < Spree::PageBlock
+      preference :label, :string, default: Spree.t('page_blocks.nav.label_default')
+
+      def icon_name
+        'menu-2'
+      end
+
+      def display_name
+        preferred_label
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    class NewsletterForm < Spree::PageBlock
+      preference :button_text, :string, default: Spree.t('page_blocks.newsletter_form.button_text_default')
+      preference :button_text_color, :string
+      preference :button_background_color, :string
+      preference :button_style, :string, default: 'primary'
+      preference :placeholder, :string, default: Spree.t('page_blocks.newsletter_form.placeholder_default')
+      preference :justify, :string, default: 'center'
+
+      validates :preferred_button_style, inclusion: { in: ['primary', 'secondary'] }
+
+      def icon_name
+        'forms'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Brand < Spree::PageBlocks::Heading
+        preference :text_color, :string
+
+        SIZE_DEFAULT = 'medium'
+
+        def display_name
+          Spree.t(:brand)
+        end
+      end
+    end
+  end
+end