spree_core 4.10.1 → 5.0.0.rc1

data/app/models/spree/theme.rb

@@ -0,0 +1,200 @@
+module Spree
+  class Theme < Spree.base_class
+    include Spree::SingleStoreResource
+    include Spree::Previewable
+
+    #
+    # Magic methods
+    #
+    acts_as_paranoid
+
+    #
+    # Validations
+    #
+    validates :name, :store, presence: true
+
+    #
+    # Associations
+    #
+    belongs_to :store, class_name: 'Spree::Store', touch: true
+    belongs_to :parent, class_name: 'Spree::Theme', optional: true, foreign_key: :parent_id
+    has_many :previews, class_name: 'Spree::Theme', foreign_key: :parent_id, dependent: :destroy_async
+    has_many :pages, -> { without_previews }, class_name: 'Spree::Page', dependent: :destroy, as: :pageable
+    has_many :page_previews, -> { only_previews }, class_name: 'Spree::Page', dependent: :destroy_async, as: :pageable
+    has_many :layout_sections, class_name: 'Spree::PageSection', dependent: :destroy, as: :pageable
+    alias sections layout_sections
+
+    #
+    # Attachments
+    #
+    has_one_attached :screenshot, service: Spree.public_storage_service_name
+
+    #
+    #
+    # Callbacks
+    #
+    before_validation :set_name, on: :create
+    before_save :ensure_default_exists_and_is_unique
+    after_create :create_default_pages, :create_layout_sections, unless: :duplicating?
+    before_destroy :change_name_to_archived
+
+    #
+    # Virtual attributes
+    #
+    attribute :duplicating, :boolean, default: false
+
+    #
+    # Class methods
+    #
+    def self.to_param
+      Spree::Theme.to_s
+    end
+
+    # Returns an array of available themes, sorted by display name
+    #
+    # We need to load the theme classes to get the display name, so we also load the page classes at the same time
+    #
+    # @return [Array<Spree::Theme>]
+    def self.available_themes
+      @available_themes ||= Rails.application.config.spree.themes.sort_by(&:display_name)
+    end
+
+    def self.metadata
+      {
+        authors: [], # eg. ['Spree Commerce']
+        website: '', # eg. 'https://spreecommerce.org'
+        license: '', # eg. 'MIT', https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type
+        description: '', # eg. 'A theme for Spree Commerce'
+        preview_image_url: '' # eg. 'https://example.com/screenshot.png'
+      }
+    end
+
+    def self.display_name
+      metadata[:name].presence || name.demodulize.titleize
+    end
+
+    def self.authors
+      metadata[:authors]
+    end
+
+    def self.license
+      metadata[:license]
+    end
+
+    def self.description
+      metadata[:description]
+    end
+
+    def self.preview_image_url
+      metadata[:preview_image_url]
+    end
+
+    def self.website
+      metadata[:website]
+    end
+
+    def duplicate
+      Themes::Duplicator.new(self).duplicate
+    end
+
+    def create_default_pages
+      Rails.application.config.spree.pages.each do |page_class|
+        next if page_class == Spree::Pages::Custom
+
+        page_class.where(pageable: self).first_or_create!
+      end
+    end
+
+    def create_layout_sections
+      ApplicationRecord.transaction do
+        available_layout_sections.each do |section_class|
+          section_class.where(pageable: self).first_or_create!
+        end
+      end
+    end
+
+    def create_preview
+      ActiveRecord::Base.connected_to(role: :writing) do
+        ApplicationRecord.transaction do
+          new_preview = dup
+          new_preview.parent = self
+          new_preview.duplicating = true
+          new_preview.default = false
+
+          # we need to deep clone layout sections and their assets
+          sections.includes(:links, { asset_attachment: :blob }, { blocks: [:rich_text_text, :links] }).each do |section|
+            section.deep_clone(new_preview)
+          end
+
+          new_preview.save!
+          new_preview
+        end
+      end
+    end
+
+    # Promotes the preview to the main theme
+    def promote
+      return unless preview?
+
+      ApplicationRecord.transaction do
+        old_theme = parent
+
+        # clear reference to the old theme and set default to the old theme's default
+        update!(parent: nil, default: old_theme.default)
+
+        # move pages to the new theme
+        old_theme.pages.update_all(pageable_id: id)
+
+        # destroy the old theme with their other previews, etc.
+        store.themes.find(old_theme.id).destroy
+
+        take_screenshot # update the screenshot
+      end
+    end
+
+    def available_layout_sections
+      Rails.application.config.spree.theme_layout_sections
+    end
+
+    def available_page_sections
+      return @available_page_sections if @available_page_sections
+
+      @available_page_sections ||= Rails.application.config.spree.page_sections.find_all do |section_class|
+        section_class.role == 'content'
+      end.sort_by(&:name)
+    end
+
+    def restore_defaults!
+      self.preferences = {}
+      save!
+    end
+
+    def take_screenshot
+      return if Spree.screenshot_api_token.blank?
+      return if preview? # we don't want to take screenshots of previews, they aren't surfaced in the UI
+      return if screenshot.attached?
+
+      Spree::Themes::ScreenshotJob.perform_later(id)
+    end
+
+    protected
+
+    def set_name
+      self.name = type.demodulize.titleize if name.blank?
+    end
+
+    private
+
+    def ensure_default_exists_and_is_unique
+      if default
+        store.themes.where.not(id: id).update_all(default: false, updated_at: Time.current)
+      elsif store.themes.where(default: true).count.zero?
+        self.default = true
+      end
+    end
+
+    def change_name_to_archived
+      update_columns(name: "#{name} (Archived)")
+    end
+  end
+end

data/app/models/spree/themes/default.rb

@@ -0,0 +1,94 @@
+module Spree
+  module Themes
+    class Default < Spree::Theme
+      def self.metadata
+        {
+          authors: ['Spree Commerce'],
+          license: 'MIT',
+          preview_image_url: 'https://s3.eu-central-2.wasabisys.com/w.storage.screenshotapi.net/demo_spreecommerce_org_299a49137b25.png'
+        }
+      end
+
+      # COLORS
+      # main colors
+      preference :primary_color, :string, default: '#000000'
+      preference :accent_color, :string, default: '#F0EFE9'
+      preference :danger_color, :string, default: '#C73528'
+      preference :neutral_color, :string, default: '#999999'
+      preference :background_color, :string, default: '#FFFFFF'
+      preference :text_color, :string, default: '#000000'
+      preference :success_color, :string, default: '#00C773'
+
+      # buttons
+      preference :button_background_color, :string
+      preference :button_text_color, :string, default: '#ffffff'
+      preference :button_hover_background_color, :string
+      preference :button_hover_text_color, :string
+      preference :button_border_color, :string
+
+      # borders
+      preference :border_color, :string, default: '#E9E7DC'
+      preference :sidebar_border_color, :string
+
+      preference :secondary_button_background_color, :string
+      preference :secondary_button_text_color, :string
+      preference :secondary_button_hover_background_color, :string
+      preference :secondary_button_hover_text_color, :string
+
+      # inputs
+      preference :input_text_color, :string, default: '#6b7280'
+      preference :input_background_color, :string, default: '#ffffff'
+      preference :input_border_color, :string
+      preference :input_focus_border_color, :string
+      preference :input_focus_background_color, :string
+      preference :input_focus_text_color, :string
+
+      # sidebar (checkout)
+      preference :checkout_sidebar_background_color, :string, default: '#f3f4f6'
+      preference :checkout_divider_background_color, :string
+      preference :checkout_sidebar_text_color, :string
+
+      # TYPOGRAPHY
+      preference :custom_font_code, :string, default: nil
+      # body
+      preference :font_family, :string, default: 'Inter'
+      preference :font_size_scale, :integer, default: 100
+      # headers
+      preference :header_font_family, :string, default: 'Inter'
+      preference :header_font_size_scale, :integer, default: 100
+      preference :headings_uppercase, :boolean, default: true
+
+      # BUTTONS
+      preference :button_border_thickness, :integer, default: 1
+      preference :button_border_opacity, :integer, default: 100
+      preference :button_border_radius, :integer, default: 100
+      preference :button_shadow_opacity, :integer, default: 0
+      preference :button_shadow_horizontal_offset, :integer, default: 0
+      preference :button_shadow_vertical_offset, :integer, default: 4
+      preference :button_shadow_blur, :integer, default: 5
+
+      # INPUTS
+      preference :input_border_thickness, :integer, default: 1
+      preference :input_border_opacity, :integer, default: 100
+      preference :input_border_radius, :integer, default: 8
+      preference :input_shadow_opacity, :integer, default: 0
+      preference :input_shadow_horizontal_offset, :integer, default: 0
+      preference :input_shadow_vertical_offset, :integer, default: 4
+      preference :input_shadow_blur, :integer, default: 5
+
+      # BORDERS
+      preference :border_width, :integer, default: 1
+      preference :border_radius, :integer, default: 6
+      preference :border_shadow_opacity, :integer, default: 0
+      preference :border_shadow_horizontal_offset, :integer, default: 0
+      preference :border_shadow_vertical_offset, :integer, default: 4
+      preference :border_shadow_blur, :integer, default: 5
+
+      # PRODUCT IMAGES
+      preference :product_listing_image_height, :integer, default: 300
+      preference :product_listing_image_width, :integer, default: 300
+      preference :product_listing_image_height_mobile, :integer, default: 190
+      preference :product_listing_image_width_mobile, :integer, default: 190
+    end
+  end
+end

data/app/models/spree/variant/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Variant < Spree::Base
+  class Variant < Spree.base_class
     module Webhooks
     end
   end