spree_core 4.10.1 → 5.0.0.rc1

data/app/models/spree/page_block.rb

@@ -0,0 +1,69 @@
+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 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,17 @@
+module Spree
+  module PageBlocks
+    class Image < Spree::PageBlock
+      alias image asset
+
+      TOP_PADDING_DEFAULT = 20
+      BOTTOM_PADDING_DEFAULT = 20
+
+      preference :height, :integer, default: 64
+      preference :mobile_height, :integer, default: 32
+
+      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/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/buy_buttons.rb

@@ -0,0 +1,12 @@
+module Spree
+  module PageBlocks
+    module Products
+      class BuyButtons < Spree::PageBlock
+        TOP_PADDING_DEFAULT = 20
+        BOTTOM_PADDING_DEFAULT = 20
+
+        preference :text_color, :string
+      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
+          'Price'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module PageBlocks
+    module Products
+      class QuantitySelector < Spree::PageBlock
+        TOP_PADDING_DEFAULT = 20
+        BOTTOM_PADDING_DEFAULT = 20
+
+        preference :text_color, :string
+      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,15 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Title < Spree::PageBlocks::Heading
+        TOP_PADDING_DEFAULT = 16
+
+        preference :text_color, :string
+
+        def display_name
+          section.product_name.presence || 'Title'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module PageBlocks
+    module Products
+      class VariantPicker < Spree::PageBlock
+        preference :text_color, :string
+      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
+        'h2'
+      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_link.rb

@@ -0,0 +1,59 @@
+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?
+
+      @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,215 @@
+module Spree
+  class PageSection < Spree.base_class
+    include Spree::HasPageLinks
+    #
+    # Magic methods
+    #
+    acts_as_paranoid
+    acts_as_list scope: [: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
+
+    #
+    # 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?
+      role == 'content'
+    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,30 @@
+module Spree
+  module PageSections
+    class AnnouncementBar < Spree::PageSection
+      has_rich_text :text
+
+      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