spree_page_builder 5.3.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aff9ef8a6cddfe9ea8ca9031493f8d182dd557367594a11b68e92327c5938d6c
+  data.tar.gz: ac52379c8fefd86e2297d929638a22701bc5c558711f6ff8ef10006078696280
+SHA512:
+  metadata.gz: 9797793b83bb8236ad9796e6b865b33458e60963fee4a53c813e4d900e9a4cd0d87d975ae0a4272a04bc77cc4575dfa9a14288abd3cdba5cda7c0bb8cbdafa4e
+  data.tar.gz: 19a67653afbc2405963daee8b27aa7220eda4bd079831d65783b3464bb23472d1273ce73e39e784512e605759360e5dfd0f560fca6ad3c3e32b00bdc87f3fa1e

data/README.md

@@ -0,0 +1,43 @@
+# Spree Page Builder
+
+Visual page builder and theme management for Spree Commerce storefronts.
+
+## Overview
+
+Spree Page Builder provides a visual drag-and-drop interface for building and customizing storefront pages. It includes:
+
+- **Theme Management**: Create and manage multiple themes for your store
+- **Page Builder**: Visual editor for creating custom pages
+- **Page Sections**: Pre-built section components (headers, footers, product grids, etc.)
+- **Page Blocks**: Content blocks within sections (text, images, buttons, etc.)
+
+## Installation
+
+Add this line to your Spree application's Gemfile:
+
+```ruby
+gem 'spree_page_builder'
+```
+
+Or install it through the storefront gem (recommended):
+
+```ruby
+gem 'spree_storefront'
+```
+
+Then execute:
+
+```bash
+bundle install
+rails spree_page_builder:install:migrations
+rails db:migrate
+```
+
+## Dependencies
+
+- `spree_core` - Core Spree functionality
+- `spree_admin` - Admin dashboard for managing pages and themes
+
+## License
+
+Spree Page Builder is released under the [AGPL-3.0-or-later License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree/page_builder'
+
+  Rake::Task['common:test_app'].execute(
+    install_admin: true,
+  )
+end

data/app/controllers/concerns/spree/admin/page_builder_concern.rb

@@ -0,0 +1,45 @@
+module Spree
+  module Admin
+    module PageBuilderConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper 'spree/admin/page_builder'
+        before_action :set_variables
+      end
+
+      def set_variables
+        @theme_preview = current_store.theme_previews.find_by(id: session[:theme_preview_id]) if session[:theme_preview_id].present?
+        @theme = @theme_preview.present? ? @theme_preview.parent : current_store.default_theme
+        if @theme.present? && session[:page_preview_id].present?
+          @page_preview = @theme.page_previews.find_by(id: session[:page_preview_id]) ||
+                            current_store.page_previews.find_by(id: session[:page_preview_id])
+        end
+        @page = @page_preview.parent if @page_preview
+      end
+
+      def create_turbo_stream_enabled?
+        true
+      end
+
+      def update_turbo_stream_enabled?
+        true
+      end
+
+      def default_url_options
+        {
+          theme_preview_id: session[:theme_preview_id],
+          page_preview_id: session[:page_preview_id],
+        }
+      end
+
+      def location_after_save
+        collection_url
+      end
+
+      def collection_url
+        spree.edit_admin_theme_path(@theme, page_id: @page.id)
+      end
+    end
+  end
+end

data/app/controllers/concerns/spree/admin/storefront_breadcrumb_concern.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Admin
+    module StorefrontBreadcrumbConcern
+      extend ActiveSupport::Concern
+
+      included do
+        add_breadcrumb_icon 'building-store'
+        add_breadcrumb Spree.t('admin.storefront'), :admin_themes_path
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/page_blocks_controller.rb

@@ -0,0 +1,58 @@
+module Spree
+  module Admin
+    class PageBlocksController < Spree::Admin::ResourceController
+      include Spree::Admin::PageBuilderConcern
+
+      belongs_to 'spree/page_section', find_by: :id
+
+      def destroy
+        @page_block.destroy
+      end
+
+      def move_higher
+        if @page_block.first?
+          head :ok
+        else
+          @page_block.move_higher
+        end
+      end
+
+      def move_lower
+        if @page_block.last?
+          head :ok
+        else
+          @page_block.move_lower
+        end
+      end
+
+      def create
+        page_block_type = params.dig(:page_block, :type)
+        allowed_type = allowed_types.find { |type| type.to_s == page_block_type }
+
+        if allowed_type
+          @page_block = allowed_type.new
+          @page_block.section = @page_section
+          @page_block.save!
+        end
+      end
+
+      private
+
+      def allowed_types
+        [
+          *Spree.page_builder.page_blocks,
+          *parent&.available_blocks_to_add
+        ].uniq.sort_by(&:name)
+      end
+
+      def permitted_resource_params
+        params.require(:page_block).permit(
+          permitted_page_block_attributes +
+          [link_attributes: permitted_page_link_attributes + [:id]] +
+          @object.preferences.keys.map { |key| "preferred_#{key}" } +
+          [preferred_metafield_definition_ids: []]
+        )
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/page_links_controller.rb

@@ -0,0 +1,60 @@
+module Spree
+  module Admin
+    class PageLinksController < ResourceController
+      include Spree::Admin::PageBuilderConcern
+
+      before_action :load_parent
+
+      create.before :set_defaults
+
+      def destroy
+        @page_link.destroy
+      end
+
+      private
+
+      def find_resource
+        model_class.accessible_by(current_ability, :manage).find(params[:id])
+      end
+
+      def collection_url
+        @collection_url ||= if @parent.is_a?(Spree::PageSection)
+                              spree.edit_admin_page_section_path(@parent)
+                            elsif @parent.is_a?(Spree::PageBlock)
+                              spree.edit_admin_page_section_block_path(@parent.section, @parent)
+                            elsif @parent.is_a?(Spree::Store)
+                              spree.edit_admin_store_path(section: :checkout)
+                            end
+      end
+
+      def load_parent
+        @parent ||= if @page_link&.persisted?
+                      @page_link.parent
+                    elsif params[:block_id].present?
+                      Spree::PageBlock.find(params[:block_id])
+                    elsif params[:page_section_id].present?
+                      Spree::PageSection.find(params[:page_section_id])
+                    elsif params[:store_id].present?
+                      current_store
+                    end
+      end
+
+      def set_defaults
+        raise ActiveRecord::RecordNotFound unless @parent
+
+        @page_link.parent = @parent
+        @page_link.linkable_type ||= @parent.default_linkable_type
+        @page_link.linkable ||= @parent.default_linkable_resource
+      end
+
+      # for create action we don't pass    page_link at all
+      def permitted_resource_params
+        if params[:page_link].present?
+          params.require(:page_link).permit(permitted_page_link_attributes)
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/page_sections_controller.rb

@@ -0,0 +1,82 @@
+module Spree
+  module Admin
+    class PageSectionsController < ResourceController
+      include Spree::Admin::PageBuilderConcern
+
+      before_action :load_pageable, only: %i[new create index]
+
+      def create
+        page_section_type = params.dig(:page_section, :type)
+        allowed_types = available_page_section_types.map(&:to_s)
+
+        if allowed_types.include?(page_section_type)
+          # Find the actual class from our allowed types rather than using constantize
+          section_class = available_page_section_types.find { |type| type.to_s == page_section_type }
+
+          if section_class
+            @page_section = section_class.new(permitted_resource_params)
+            @page_section.pageable = @pageable
+            @page_section.save!
+          end
+        end
+      end
+
+      def destroy
+        @page_section.destroy if @page_section.can_be_deleted?
+      end
+
+      def move_higher
+        if @page_section.first?
+          head :ok
+        else
+          @page_section.move_higher
+        end
+      end
+
+      def move_lower
+        if @page_section.last?
+          head :ok
+        else
+          @page_section.move_lower
+        end
+      end
+
+      def restore_design_settings_to_defaults
+        @page_section.restore_design_settings_to_defaults
+      end
+
+      private
+
+      def load_pageable
+        @pageable = if @page_section.present? && @page_section.pageable.present?
+                      @page_section.pageable
+                    elsif params[:page_id].present?
+                      current_store.theme_page_previews.friendly.find_by(id: params[:page_id]) ||
+                        current_store.page_previews.friendly.find(params[:page_id])
+                    elsif params[:theme_id].present?
+                      current_store.theme_previews.find(params[:theme_id])
+                    end
+      end
+
+      def available_page_section_types
+        return [] unless @pageable.present?
+
+        if @pageable.is_a?(Spree::Theme)
+          @pageable.available_page_sections
+        elsif @pageable.respond_to?(:theme)
+          @pageable.theme.available_page_sections
+        else
+          []
+        end
+      end
+
+      def permitted_resource_params
+        params.require(:page_section).permit(
+          permitted_page_section_attributes +
+          [link_attributes: permitted_page_link_attributes + [:id]] +
+          @object.preferences.keys.map { |key| "preferred_#{key}" }
+        )
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/pages_controller.rb

@@ -0,0 +1,39 @@
+module Spree
+  module Admin
+    class PagesController < Spree::Admin::ResourceController
+      create.before :set_page
+      update.after :remove_preview_from_session
+      destroy.after :remove_preview_from_session
+      create.after :remove_preview_from_session
+
+      include StorefrontBreadcrumbConcern
+      add_breadcrumb Spree.t(:pages), :admin_pages_path
+
+      private
+
+      def remove_preview_from_session
+        session.delete(:page_preview_id)
+      end
+
+      def flash_message_for(object, event_sym)
+        Spree.t(event_sym, resource: "#{Spree.t(:page)} \"#{object.name}\"")
+      end
+
+      def set_page
+        @object = current_store.pages.custom.new
+      end
+
+      def edit_object_url(object, options = {})
+        spree.edit_admin_theme_path(current_store.default_theme, page_id: object.id, **options)
+      end
+
+      def scope
+        super.custom.without_previews
+      end
+
+      def permitted_resource_params
+        params.require(:page).permit(permitted_page_attributes)
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/storefront_controller.rb

@@ -0,0 +1,41 @@
+module Spree
+  module Admin
+    class StorefrontController < BaseController
+      include StorefrontBreadcrumbConcern
+      add_breadcrumb Spree.t(:settings), :edit_admin_storefront_path
+
+      def edit
+        @store = current_store
+      end
+
+      def update
+        @store = current_store
+        if @store.update(store_params)
+          remove_assets(%w[favicon_image social_image], object: @store)
+          flash[:success] = flash_message_for(@store, :successfully_updated)
+        else
+          flash[:error] = @store.errors.full_messages.to_sentence
+        end
+
+        redirect_to spree.edit_admin_storefront_path
+      end
+
+      private
+
+      def store_params
+        params.require(:store).permit(
+          :preferred_index_in_search_engines,
+          :preferred_password_protected, :social_image, :favicon_image, :name,
+          :meta_description, :meta_keywords, :seo_robots, :seo_title,
+          :facebook, :twitter, :instagram, :linkedin, :youtube, :tiktok, :pinterest,
+          :storefront_custom_code_head, :storefront_custom_code_body_start,
+          :storefront_custom_code_body_end, :storefront_password, :spotify, :discord
+        )
+      end
+
+      def model_class
+        Spree::Store
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/themes_controller.rb

@@ -0,0 +1,87 @@
+module Spree
+  module Admin
+    class ThemesController < ResourceController
+      layout :choose_layout
+
+      include StorefrontBreadcrumbConcern
+      helper 'spree/admin/page_builder'
+      add_breadcrumb Spree.t(:themes), :admin_themes_path
+
+      def edit
+        @theme_preview = params[:theme_preview_id].present? ? @theme.previews.find(params[:theme_preview_id]) : @theme.create_preview
+        @page = if params[:page_id].present?
+                  @theme.pages.find_by(id: params[:page_id]) || current_store.pages.find(params[:page_id])
+                else
+                  @theme.pages.find_by(type: 'Spree::Pages::Homepage')
+                end
+        @page_preview = params[:page_preview_id].present? ? @page.previews.find(params[:page_preview_id]) : @page.create_preview
+
+        session[:theme_preview_id] = @theme_preview.id
+        session[:page_preview_id] = @page_preview.id
+      end
+
+      def update_with_page
+        @theme_preview = @theme.previews.find(params[:theme_preview_id])
+        @page_preview = @theme.page_previews.find_by(id: params[:page_preview_id]) || current_store.page_previews.find(params[:page_preview_id])
+
+        ApplicationRecord.transaction do
+          @page_preview.promote && @theme_preview.promote
+        end
+        flash[:success] = Spree.t('changes_published')
+
+        redirect_to spree.edit_admin_theme_path(@theme_preview, page_id: @page_preview.id), status: :see_other
+      rescue ActiveRecord::RecordInvalid
+        redirect_to spree.edit_admin_theme_path(@theme_preview, page_id: @page_preview.id), alert: Spree.t('something_went_wrong')
+      end
+
+      def publish
+        @theme = current_store.themes.find(params[:id])
+
+        if @theme.update(default: true)
+          flash[:success] = Spree.t('theme_is_now_live')
+        else
+          flash[:error] = "#{Spree.t('something_went_wrong')}: #{@theme.errors.full_messages.to_sentence}"
+        end
+        redirect_to spree.admin_themes_path
+      end
+
+      def clone
+        @new = @theme.duplicate
+
+        if @new.persisted?
+          flash[:success] = Spree.t('theme_copied')
+        else
+          flash[:error] = Spree.t('theme_not_copied', error: @new.errors.full_messages.to_sentence)
+        end
+
+        redirect_to spree.admin_themes_path
+      end
+
+      private
+
+      def choose_layout
+        if action_name == 'index'
+          'spree/admin'
+        else
+          'spree/page_builder'
+        end
+      end
+
+      def update_turbo_stream_enabled?
+        true
+      end
+
+      def scope
+        super.without_previews.order(default: :desc)
+      end
+
+      def collection_includes
+        { screenshot_attachment: :blob }
+      end
+
+      def permitted_resource_params
+        params.require(:theme).permit(permitted_theme_attributes + @object.preferences.keys.map { |key| "preferred_#{key}" })
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/page_builder_helper.rb

@@ -0,0 +1,125 @@
+module Spree
+  module Admin
+    module PageBuilderHelper
+      def system_fonts_list
+        ['Sans-serif', 'Serif', 'Mono']
+      end
+
+      def google_fonts_list
+        ['Abel', 'Abril Fatface', 'Alegreya', 'Alegreya Sans', 'Alice', 'Amiri', 'Anonymous Pro', 'Arapey', 'Archivo', 'Archivo Narrow',
+         'Arimo', 'Armata', 'Arvo', 'Asap', 'Assistant', 'Asul', 'Bitter', 'Cabin', 'Cardo', 'Catamaran', 'Chivo', 'Cormorant',
+         'Crimson Text', 'DM Sans', 'Domine', 'Dosis', 'Eczar', 'Figtree', 'Fira Sans', 'Fjalla One', 'Glegoo', 'IBM Plex Sans', 'Inconsolata',
+         'Inknut Antiqua', 'Inter', 'Josefin Sans', 'Josefin Slab', 'Kalam', 'Karla', 'Kreon', 'Lato', 'Libre Baskerville',
+         'Libre Franklin', 'Lobster', 'Lobster Two', 'Lora', 'Maven Pro', 'Megrim', 'Merriweather Sans', 'Montserrat',
+         'Mouse Memoirs', 'Muli', 'Neuton', 'News Cycle', 'Nobile', 'Noticia Text', 'Noto Serif', 'Nunito', 'Nunito Sans',
+         'Old Standard TT', 'Open Sans', 'Oswald', 'Ovo', 'Oxygen', 'PT Mono', 'PT Sans', 'PT Sans Narrow', 'PT Serif',
+         'Pacifico', 'Playball', 'Playfair Display', 'Poppins', 'Prata', 'Prompt', 'Quattrocento', 'Quattrocento Sans',
+         'Questrial', 'Quicksand', 'Rajdhani', 'Raleway', 'Righteous', 'Roboto', 'Roboto Condensed', 'Roboto Mono', 'Roboto Slab',
+         'Rubik', 'Shadows Into Light', 'Slabo 13px', 'Slabo 27px', 'Smooch', 'Source Code Pro', 'Source Sans Pro', 'Space Mono',
+         'Syne', 'Tenor Sans', 'Tinos', 'Titillium Web', 'Ubuntu', 'Unica One', 'Unna', 'Varela', 'Varela Round', 'Vidaloka',
+         'Volkhov', 'Vollkorn', 'Work Sans']
+      end
+
+      def color_palettes
+        [
+          {
+            primary_color: '#1e4bd1',
+            text_color: '#000000',
+            border_color: '#d1d5db',
+            button_text_color: '#ffffff',
+            background_color: '#F9FAFB'
+          },
+          {
+            primary_color: '#e63946',
+            text_color: '#1d3557',
+            border_color: '#a8dadc',
+            button_text_color: '#ffffff',
+            background_color: '#f1faee'
+          },
+          {
+            primary_color: '#264653',
+            text_color: '#060C0E',
+            border_color: '#2a9d8f',
+            button_text_color: '#ffffff',
+            background_color: '#e9c46a'
+          },
+          {
+            primary_color: '#606c38',
+            text_color: '#283618',
+            border_color: '#dda15e',
+            button_text_color: '#ffffff',
+            background_color: '#fefae0'
+          },
+          {
+            primary_color: '#FF961F',
+            text_color: '#023047',
+            border_color: '#219EBC',
+            button_text_color: '#FFEEDA',
+            background_color: '#DEF0F7'
+          },
+          {
+            primary_color: '#181CF1',
+            text_color: '#011627',
+            border_color: '#7678ED',
+            button_text_color: '#FFFFFF',
+            background_color: '#FFF5D6'
+          }
+        ]
+      end
+
+      def color_palette_active?(color_palette)
+        @theme_preview&.primary_color&.downcase == color_palette[:primary_color].downcase &&
+          @theme_preview&.text_color&.downcase == color_palette[:text_color].downcase &&
+          @theme_preview&.border_color&.downcase == color_palette[:border_color].downcase &&
+          @theme_preview&.button_text_color&.downcase == color_palette[:button_text_color].downcase &&
+          @theme_preview&.background_color&.downcase == color_palette[:background_color].downcase
+      end
+
+      def all_fonts_options
+        @all_fonts_options ||= system_fonts_list + google_fonts_list
+      end
+
+      def all_linkable_pages
+        @all_linkable_pages ||= Spree::Page.
+                                without_previews.
+                                where(pageable: [@theme, current_store]).
+                                select(&:linkable?).
+                                map { |page| [page.display_name, page.id] }.sort_by(&:first)
+      end
+
+      def all_linkable_policies
+        @all_linkable_policies ||= current_store.policies.pluck(:name, :id)
+      end
+
+      def refresh_theme_preview(section = nil, block = nil)
+        reload_params = section.present? ? "{ frame: 'section-#{section.id}' }" : "{ action: 'replace' }"
+
+        editor_id = if block.present?
+                      "block-#{block.id}"
+                    elsif section.present?
+                      "section-#{section.id}"
+                    end
+
+        turbo_stream.replace :iframe_preview_scripts do
+          turbo_frame_tag :iframe_preview_scripts do
+            javascript_tag do
+              raw <<~JS
+                document.getElementById('page-builder-preview').contentWindow.window.Turbo.visit(
+                  document.getElementById('page-builder').dataset.pageBuilderPreviewUrlValue + '&editor_id=#{editor_id}',
+                  #{reload_params}
+                )
+              JS
+            end
+          end
+        end
+      end
+
+      def page_preview_url
+        preview_url = @page.preview_url(@theme_preview, @page_preview)
+        return if preview_url.blank?
+
+        "#{preview_url}&page_builder=true"
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/themes_helper.rb

@@ -0,0 +1,9 @@
+module Spree
+  module Admin
+    module ThemesHelper
+      def available_themes
+        @available_themes ||= Spree::Theme.available_themes.sort_by(&:name).reject { |theme_class| current_store.themes.any? { |theme| theme.class.to_s == theme_class.to_s } }
+      end
+    end
+  end
+end

data/app/jobs/spree/page_builder/products/touch_taxons_job_decorator.rb

@@ -0,0 +1,15 @@
+module Spree
+  module PageBuilder
+    module Products
+      module TouchTaxonsJobDecorator
+        def perform(taxon_ids, taxonomy_ids)
+          super(taxon_ids, taxonomy_ids)
+
+          Spree::Taxons::TouchFeaturedSections.call(taxon_ids: taxon_ids)
+        end
+      end
+    end
+  end
+end
+
+Spree::Products::TouchTaxonsJob.prepend(Spree::PageBuilder::Products::TouchTaxonsJobDecorator)