spree_page_builder 5.3.4 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c3e5e508436611c0ec048cf7c9be00c65167ec554f302a676dfd4d772e3b87
-  data.tar.gz: 2471cbb07e99b62fc293d4dbb30c011a84a67ffa370d681b2657506af48310a5
+  metadata.gz: 1c0a0d6b849ba77a6f5aa00ed5572f1a809fd6fe5ded28c74346b2b09cbc71b1
+  data.tar.gz: 91fb84c175c3be58f23bcb9e7b3fecf8280058c7386aa8fd9d0c0b614a3291dc
 SHA512:
-  metadata.gz: cca3d70365a870a32b1334ee7f80e70f8accf3064c347d51beb8d0110127bc1f21f70257a8ca8ba25f50d8faf3af6b90d7ca5fd8039750de57c04095f7b9b062
-  data.tar.gz: 61e468920186e87e69f8102e3ef68d333041cb0d24ca420b2013308dd9dfb95bc1876cb9877fd0f47fae677a6e6d7aea796210bb5748ea2c9ca82abf13b2b02d
+  metadata.gz: 4b9c2e47346c889a289013e88a3205041c83982afbf9953a48d2de3ed60898ecd468a00d9ef25659fa51f404276f9bf5d2586cf546cccf4d5b1445673fb76780
+  data.tar.gz: cc30a24e1116a56ed833ab0455d4d2f96a4fab6e85d7bfed7985fc0452d8d7c5349b55bc2e3d3a9e5c7ed24ee233e92d2761687fdec58e285b1089b45087cefe

data/LICENSE.md

@@ -0,0 +1,13 @@
+# License
+
+Copyright (c) 2024-present, Vendo Connect Inc., Vendo Sp z o.o.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

data/README.md

@@ -2,6 +2,8 @@
 
 Visual page builder and theme management for Spree Commerce storefronts.
 
+![Spree Page Builder](page_builder.png)
+
 ## Overview
 
 Spree Page Builder provides a visual drag-and-drop interface for building and customizing storefront pages. It includes:

data/Rakefile

@@ -1,18 +1,24 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 require 'rspec/core/rake_task'
-require 'spree/testing_support/common_rake'
+require 'spree/testing_support/extension_rake'
 
 RSpec::Core::RakeTask.new
 
-task default: :spec
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
 
-desc "Generates a dummy app for testing"
+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,
+  Rake::Task['extension:test_app'].execute(
+    install_admin: true
   )
+  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'bundle exec rails g spree_posts:install')
 end

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

@@ -0,0 +1,42 @@
+module Spree
+  module HasOneLink
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :link, ->(ps) { ps.links }, class_name: 'Spree::PageLink', as: :parent, dependent: :destroy, inverse_of: :parent
+      accepts_nested_attributes_for :link
+
+      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 default_linkable_resource
+        @default_linkable_resource ||= theme_or_parent.pages.find_by(type: 'Spree::Pages::Homepage')
+      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
+
+      def theme_or_parent
+        theme.preview? ? theme.parent : theme
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Linkable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :page_links, as: :linkable, class_name: 'Spree::PageLink', dependent: :destroy
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Previewable
+    extend ActiveSupport::Concern
+
+    included do |base|
+      belongs_to :parent, class_name: base.name, optional: true, foreign_key: :parent_id
+      has_many :previews, class_name: base.name, dependent: :destroy_async, foreign_key: :parent_id
+
+      scope :without_previews, -> { where(parent_id: nil) }
+      scope :only_previews, -> { where.not(parent_id: nil) }
+    end
+
+    def preview?
+      parent.present?
+    end
+  end
+end

data/app/models/concerns/spree/stores/socials.rb

@@ -0,0 +1,72 @@
+module Spree
+  module Stores
+    module Socials
+      extend ActiveSupport::Concern
+
+      SUPPORTED_SOCIAL_NETWORKS = %w[instagram facebook twitter pinterest tiktok youtube spotify discord].freeze
+
+      SOCIAL_NETWORKS_CONFIG = {
+        twitter: {
+          input_placeholder: 'https://twitter.com/your_handle',
+          profile_link: 'https://twitter.com/your_handle'
+        },
+        instagram: {
+          input_placeholder: 'https://www.instagram.com/your_handle',
+          profile_link: 'https://www.instagram.com/your_handle'
+        },
+        facebook: {
+          input_placeholder: 'https://www.facebook.com/your_page',
+          profile_link: 'https://www.facebook.com/your_page'
+        },
+        youtube: {
+          input_placeholder: 'https://www.youtube.com/@your_channel',
+          profile_link: 'https://www.youtube.com/@your_channel'
+        },
+        pinterest: {
+          input_placeholder: 'https://pinterest.com/your_handle',
+          profile_link: 'https://pinterest.com/your_handle'
+        },
+        tiktok: {
+          input_placeholder: 'your_handle',
+          profile_link: 'https://www.tiktok.com/@your_handle'
+        },
+        spotify: {
+          input_placeholder: 'https://open.spotify.com/user/your_handle',
+          profile_link: 'https://open.spotify.com/user/your_handle'
+        },
+        discord: {
+          input_placeholder: 'https://discord.com/invite/your_handle',
+          profile_link: 'https://discord.com/invite/your_handle'
+        }
+      }.freeze
+
+      included do
+        # generate methods for social links
+        SUPPORTED_SOCIAL_NETWORKS.each do |social|
+          # store the social handle in the public metadata
+          store_accessor :public_metadata, social
+
+          define_method "#{social}_link" do
+            return if send(social).blank?
+
+            send(social).match(/http/) ? send(social) : SOCIAL_NETWORKS_CONFIG[social.to_sym][:profile_link].gsub(/your_handle|your_page|your_channel/, send(social).sub(/^\//, '').sub(/^@/, ''))
+          end
+
+          define_method "#{social}_handle" do
+            return if send(social).blank?
+
+            (send(social).match(/http/) ? send(social).split('/').last : send(social)).sub(/^\//, '').gsub('@', '').split('?').first
+          end
+        end
+      end
+
+      def social_handle
+        @social_handle ||= instagram_handle || youtube_handle || tiktok_handle
+      end
+
+      def social_links
+        @social_links ||= [instagram_link, facebook_link, twitter_link, pinterest_link, youtube_link, tiktok_link, spotify_link, discord_link].compact_blank
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@ module Spree
     module StoreDecorator
       def self.prepended(base)
         base.include Spree::HasPageLinks
+        base.include Spree::Stores::Socials
 
         # Page Builder associations
         base.has_many :themes, -> { without_previews }, class_name: 'Spree::Theme', dependent: :destroy, inverse_of: :store
@@ -21,17 +22,71 @@ module Spree
         base.has_many :page_previews, class_name: 'Spree::Pages::Custom', through: :pages, as: :pageable, source: :previews
 
         base.after_create :create_default_theme
+
+        base.has_rich_text :checkout_message
+
+        # Storefront-specific attachments
+        base.has_one_attached :favicon_image, service: Spree.public_storage_service_name
+        base.has_one_attached :social_image, service: Spree.public_storage_service_name
+
+        base.validates :favicon_image, :social_image, content_type: Rails.application.config.active_storage.web_image_content_types
+
+        base.preference :index_in_search_engines, :boolean, default: false
+        base.preference :password_protected, :boolean, default: false
+        base.store_accessor :private_metadata, :storefront_password
+
+        base.translates(:facebook, :twitter, :instagram, column_fallback: !Spree.always_use_translations?)
+      end
+
+      def favicon
+        return unless favicon_image.attached? && favicon_image.variable?
+
+        favicon_image.variant(resize_to_limit: [32, 32])
       end
 
       private
 
       def create_default_theme
+        ensure_default_taxonomies
+        ensure_default_automatic_taxons
+
         themes.find_or_initialize_by(default: true) do |theme|
           theme.name = Spree.t(:default_theme_name)
           theme.save!
         end
       end
 
+      def ensure_default_taxonomies
+        [
+          Spree.t(:taxonomy_categories_name),
+          Spree.t(:taxonomy_brands_name),
+          Spree.t(:taxonomy_collections_name)
+        ].each do |taxonomy_name|
+          next if taxonomies.with_matching_name(taxonomy_name).exists?
+
+          taxonomies.create(name: taxonomy_name)
+        end
+      end
+
+      def ensure_default_automatic_taxons
+        collections_taxonomy = taxonomies.with_matching_name(Spree.t(:taxonomy_collections_name)).first
+        return unless collections_taxonomy.present?
+
+        [
+          { name: Spree.t('automatic_taxon_names.on_sale'), rule_type: 'Spree::TaxonRules::Sale', rule_value: 'true' },
+          { name: Spree.t('automatic_taxon_names.new_arrivals'), rule_type: 'Spree::TaxonRules::AvailableOn', rule_value: 30 }
+        ].each do |config|
+          next if collections_taxonomy.taxons.automatic.with_matching_name(config[:name]).exists?
+
+          collections_taxonomy.taxons.create!(
+            name: config[:name],
+            automatic: true,
+            parent: collections_taxonomy.root,
+            taxon_rules: [Spree::TaxonRule.new(type: config[:rule_type], value: config[:rule_value])]
+          )
+        end
+      end
+
       def create_default_policies
         super
 

data/app/models/spree/page_section.rb

@@ -122,6 +122,10 @@ module Spree
       role == 'content'
     end
 
+    def can_be_hidden?
+      false
+    end
+
     def can_be_sorted?
       true
     end

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

@@ -8,10 +8,16 @@ module Spree
       BOTTOM_PADDING_DEFAULT = 8
       TOP_BORDER_WIDTH_DEFAULT = 0
 
+      preference :visible, :boolean, default: true
+
       def self.role
         'header'
       end
 
+      def can_be_hidden?
+        true
+      end
+
       def icon_name
         'speakerphone'
       end

data/app/views/spree/admin/page_builder/_sidebar_section.html.erb

@@ -1,19 +1,21 @@
 <% if section.persisted? %>
+  <% section_hidden = section.can_be_hidden? && !section.preferred_visible %>
   <%= turbo_frame_tag dom_id(section), class: 'list-group-item py-0 border-0 sidebar-page-section draggable rounded-sm',
                                        data: { sortable_update_url: spree.admin_page_section_path(section, format: :turbo_stream) } do %>
-    <div class="flex items-center justify-between sidebar-section-title py-1 rounded-xl"
+    <div class="flex items-center justify-between sidebar-section-title py-1 rounded-xl <%= 'opacity-50' if section_hidden %>"
          data-action="mouseover->page-builder#toggleHighlightElement mouseout->page-builder#toggleHighlightElement"
       data-page-builder-editor-id-param="section-<%= section.id %>">
       <div class="flex items-center flex-1 py-1 px-2">
         <%= icon("#{section.icon_name}", height: 18, class: 'mr-2') if section.icon_name.present? %>
         <%= link_to section.display_name, spree.edit_admin_page_section_path(section),
-            class: 'section-edit-link flex-1 font-bold text-gray-900',
+            class: "section-edit-link flex-1 font-bold #{section_hidden ? 'text-gray-400' : 'text-gray-900'}",
             data: {
               turbo_frame: :page_sidebar,
               action: 'click->page-builder#makeOverlayActive',
               page_builder_editor_id_param: "section-#{section.id}"
             }
         %>
+        <%= icon('eye-off', height: 14, class: 'ml-1 text-gray-400') if section_hidden %>
       </div>
       <div class="flex items-center hidden">
         <button class="btn btn-sm pr-0 handle hover:bg-gray-100 h-full mr-1 px-1 handle-section shadow-none">

data/app/views/spree/admin/page_sections/edit.html.erb

@@ -18,6 +18,12 @@
           </li>
         </ul>
         <div data-tabs-target="panel" id="pills-home" role="tabpanel" aria-labelledby="pills-home-tab" class="animate-fade-in" <%= 'hidden' unless tab_selected == :content %>>
+          <% if @page_section.can_be_hidden? %>
+            <div class="form-group">
+              <%= f.check_box :preferred_visible, class: "checkbox-input", data: { action: 'auto-submit#submit' } %>
+              <%= f.label :preferred_visible, Spree.t('admin.page_builder.visible') %>
+            </div>
+          <% end %>
           <%= render "spree/admin/page_sections/forms/#{@page_section.type.demodulize.underscore}", f: f  %>
           <%= render 'spree/admin/page_sections/form_tab_buttons', tab: :content %>
         </div>

data/app/views/spree/admin/page_sections/update.turbo_stream.erb

@@ -8,3 +8,9 @@
     <%= render 'spree/admin/page_links/linkable_type_dropdown', page_link: @page_section.link, form_name: 'page_section[link_attributes]' %>
   <% end %>
 <% end %>
+<% if @page_section.can_be_hidden? && @page_section.saved_change_to_preferences? &&
+      @page_section.saved_change_to_preferences[0][:visible] != @page_section.saved_change_to_preferences[1][:visible] %>
+  <%= turbo_stream.replace dom_id(@page_section) do %>
+    <%= render 'spree/admin/page_builder/sidebar_section', section: @page_section %>
+  <% end %>
+<% end %>

data/app/views/spree/admin/shared/_page_section_logo.html.erb

@@ -0,0 +1 @@
+<%= f.spree_file_field :asset, width: 400, height: 128, auto_submit: true, label: Spree.t(:logo) %>

data/app/views/spree/admin/stores/form/_checkout_links.html.erb

@@ -0,0 +1,28 @@
+<div id="checkout_links">
+  <% if current_store.links.any? %>
+    <ul class="list-group rounded-lg mb-6 border-gray-200"
+        data-controller="sortable"
+        data-sortable-handle-value=".handle"
+        data-sortable-resource-name-value="page_link"
+        data-sortable-response-kind-value="turbo-stream">
+      <% current_store.links.each do |link| %>
+        <li class="list-group-item p-0 hover:bg-gray-25"
+            data-sortable-update-url="<%= spree.admin_page_link_path(link, sorting_only: true, format: :turbo_stream) %>"
+        >
+          <%= turbo_frame_tag spree_dom_id(link), class: 'flex items-center w-full py-2 pl-6 pr-2' do %>
+            <%= link_to link.label, spree.edit_admin_page_link_path(link), class: 'block text-gray-900 flex-1 no-underline' %>
+            <span class="btn btn-sm handle shadow-none hover:bg-gray-100 px-1 cursor-move ml-4">
+              <%= icon 'grip-vertical', class: 'mr-0' %>
+            </span>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% else %>
+    <p class="text-gray-600 text-center p-12">
+      <%= Spree.t(:no_resource_found, resource: Spree::PageLink.model_name.human) %>
+    </p>
+  <% end %>
+
+  <%= link_to_with_icon 'plus', Spree.t(:add_link), spree.admin_store_links_path(current_store), class: 'btn btn-primary w-full', data: { turbo_method: :post } %>
+</div>

data/config/locales/en.yml

@@ -37,6 +37,7 @@ en:
         title: Title
         top_padding: Top padding
         use_description_from_admin: Use description from admin
+        visible: Visible
         vertical_alignment: Vertical alignment
         youtube_video_url: Youtube video URL
     default_theme_name: Default Theme

data/lib/generators/spree/page_builder/install/install_generator.rb

@@ -8,6 +8,7 @@ module Spree
 
         def add_migrations
           run 'bundle exec rake railties:install:migrations FROM=spree_page_builder'
+          run 'bundle exec rake railties:install:migrations FROM=spree_posts'
         end
 
         def run_migrations

data/lib/spree/page_builder/engine.rb

@@ -136,6 +136,12 @@ module Spree
     Rails.application.config.spree.page_blocks = value
   end
 
+  mattr_accessor :screenshot_api_token
+
+  def self.screenshot_api_token
+    @@screenshot_api_token
+  end
+
   # Page Builder configuration accessor (groups all page builder config)
   def self.page_builder
     @page_builder ||= PageBuilderConfig.new

data/lib/spree/page_builder.rb

@@ -1,4 +1,5 @@
 require 'spree'
 require 'spree_admin'
+require 'spree_posts'
 
 require 'spree/page_builder/engine'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_page_builder
 version: !ruby/object:Gem::Version
-  version: 5.3.4
+  version: 5.4.0
 platform: ruby
 authors:
 - Vendo Connect Inc.
@@ -15,34 +15,63 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: spree_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.3.4
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: spree_posts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Visual page builder and theme management for Spree Commerce storefronts
 email: hello@spreecommerce.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - Rakefile
 - app/controllers/concerns/spree/admin/page_builder_concern.rb
@@ -58,7 +87,11 @@ files:
 - app/jobs/spree/page_builder/products/touch_taxons_job_decorator.rb
 - app/jobs/spree/themes/duplicate_components_job.rb
 - app/jobs/spree/themes/screenshot_job.rb
+- app/models/concerns/spree/has_one_link.rb
 - app/models/concerns/spree/has_page_links.rb
+- app/models/concerns/spree/linkable.rb
+- app/models/concerns/spree/previewable.rb
+- app/models/concerns/spree/stores/socials.rb
 - app/models/spree/page.rb
 - app/models/spree/page_block.rb
 - app/models/spree/page_blocks/buttons.rb
@@ -236,7 +269,9 @@ files:
 - app/views/spree/admin/pages/filters.html.erb
 - app/views/spree/admin/pages/index.html.erb
 - app/views/spree/admin/pages/new.html.erb
+- app/views/spree/admin/shared/_page_section_logo.html.erb
 - app/views/spree/admin/storefront/edit.html.erb
+- app/views/spree/admin/stores/form/_checkout_links.html.erb
 - app/views/spree/admin/themes/_theme.html.erb
 - app/views/spree/admin/themes/_theme_preview_image.html.erb
 - app/views/spree/admin/themes/edit.html.erb
@@ -264,10 +299,10 @@ homepage: https://getvendo.com
 licenses:
 - AGPL-3.0-or-later
 metadata:
-  bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.4
+  bug_tracker_uri: https://github.com/spree/spree-rails-storefront/issues
+  changelog_uri: https://github.com/spree/spree-rails-storefront/releases/tag/v5.4.0
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.3.4
+  source_code_uri: https://github.com/spree/spree-rails-storefront/tree/v5.4.0
 rdoc_options: []
 require_paths:
 - lib
@@ -282,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Visual Page Builder for Spree Commerce
 test_files: []