spree_core 4.10.1 → 5.0.0.rc1

data/app/jobs/spree/products/touch_taxons_job.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Products
+    class TouchTaxonsJob < ::Spree::BaseJob
+      queue_as Spree.queues.taxons
+
+      def perform(taxon_ids, taxonomy_ids)
+        Spree::Taxon.where(id: taxon_ids).update_all(updated_at: Time.current)
+        Spree::Taxonomy.where(id: taxonomy_ids).update_all(updated_at: Time.current)
+      end
+    end
+  end
+end

data/app/jobs/spree/reports/generate_job.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Reports
+    class GenerateJob < Spree::BaseJob
+      queue_as Spree.queues.reports
+
+      def perform(report_id)
+        report = Spree::Report.find(report_id)
+        report.generate
+      end
+    end
+  end
+end

data/app/jobs/spree/stock_locations/stock_items/create_job.rb

@@ -2,7 +2,7 @@ module Spree
   module StockLocations
     module StockItems
       class CreateJob < Spree::BaseJob
-        queue_as :spree_stock_location_stock_items
+        queue_as Spree.queues.stock_location_stock_items
 
         def perform(stock_location)
           Spree::StockLocations::StockItems::Create.call(stock_location: stock_location)

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/jobs/spree/variants/remove_from_incomplete_orders_job.rb

@@ -1,6 +1,8 @@
 module Spree
   module Variants
     class RemoveFromIncompleteOrdersJob < Spree::BaseJob
+      queue_as Spree.queues.variants
+
       def perform(variant)
         Spree::Variants::RemoveLineItems.call(variant: variant)
       end

data/app/jobs/spree/variants/remove_line_item_job.rb

@@ -1,6 +1,8 @@
 module Spree
   module Variants
     class RemoveLineItemJob < Spree::BaseJob
+      queue_as Spree.queues.variants
+
       def perform(line_item:)
         Spree::Dependencies.cart_remove_line_item_service.constantize.call(order: line_item.order, line_item: line_item)
       end

data/app/mailers/spree/base_mailer.rb

@@ -0,0 +1,51 @@
+module Spree
+  class BaseMailer < ActionMailer::Base
+    helper Spree::MailHelper
+
+    def current_store
+      @current_store ||= @order&.store.presence || Spree::Store.current || Spree::Store.default
+    end
+
+    helper_method :current_store
+
+    def from_address
+      current_store.mail_from_address
+    end
+
+    def reply_to_address
+      current_store.mail_from_address
+    end
+
+    def money(amount, currency = nil)
+      currency ||= current_store.default_currency
+      Spree::Money.new(amount, currency: currency).to_s
+    end
+    helper_method :money
+
+    def frontend_available?
+      Spree::Core::Engine.frontend_available?
+    end
+    helper_method :frontend_available?
+
+    def mail(headers = {}, &block)
+      ensure_default_action_mailer_url_host(headers[:store_url])
+      set_email_locale
+      super if Spree::Config[:send_core_emails]
+    end
+
+    private
+
+    # this ensures that ActionMailer::Base.default_url_options[:host] is always set
+    # this is only a fail-safe solution if developer didn't set this in environment files
+    # http://guides.rubyonrails.org/action_mailer_basics.html#generating-urls-in-action-mailer-views
+    def ensure_default_action_mailer_url_host(store_url = nil)
+      ActionMailer::Base.default_url_options ||= {}
+      ActionMailer::Base.default_url_options[:host] ||= store_url.presence || current_store.url
+    end
+
+    def set_email_locale
+      locale = @order&.store&.default_locale || current_store&.default_locale
+      I18n.locale = locale if locale.present?
+    end
+  end
+end

data/app/mailers/spree/export_mailer.rb

@@ -0,0 +1,19 @@
+module Spree
+  class ExportMailer < Spree::BaseMailer
+    def export_done(export)
+      @export = export
+
+      mail(
+        to: @export.user.email,
+        subject: Spree.t('export_mailer.export_done.subject', export_number: @export.number).to_s,
+        from: from_address,
+        reply_to: reply_to_address,
+        store_url: current_store.url
+      )
+    end
+
+    def current_store
+      @current_store ||= @export.store
+    end
+  end
+end

data/app/mailers/spree/report_mailer.rb

@@ -0,0 +1,20 @@
+module Spree
+  class ReportMailer < BaseMailer
+    def report_done(report)
+      @report = report
+
+      mail(
+        to: @report.user.email,
+        subject: Spree.t('report_mailer.report_done.subject', report_name: @report.human_name).to_s,
+        from: from_address,
+        reply_to: reply_to_address
+      )
+    end
+
+    private
+
+    def current_store
+      @current_store ||= @report.store
+    end
+  end
+end

data/app/mailers/spree/test_mailer.rb

@@ -0,0 +1,8 @@
+module Spree
+  class TestMailer < BaseMailer
+    def test_email(email)
+      subject = "#{Spree::Store.default.name} #{Spree.t('test_mailer.test_email.subject')}"
+      mail(to: email, from: from_address, reply_to: reply_to_address, subject: subject)
+    end
+  end
+end

data/app/models/action_text/rich_text_decorator.rb

@@ -0,0 +1,11 @@
+module ActionText
+  module RichTextDecorator
+    def page_builder_url
+      return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:policy_path)
+
+      Spree::Core::Engine.routes.url_helpers.policy_path(name.gsub(/customer_/, ''))
+    end
+  end
+
+  ActionText::RichText.include(RichTextDecorator)
+end

data/app/models/action_text/video_embed.rb

@@ -0,0 +1,13 @@
+module ActionText
+  class VideoEmbed < ApplicationRecord
+    include ActionText::Attachable
+
+    validates :url, :raw_html, :thumbnail_url, presence: true
+
+    # `to_partial_path` for the storefront render is by default "action_text/video_embeds/video_embed"
+
+    def to_trix_content_attachment_partial_path
+      'action_text/video_embeds/thumbnail'
+    end
+  end
+end

data/app/models/acts_as_taggable_on/tag_decorator.rb

@@ -0,0 +1,10 @@
+module ActsAsTaggableOn
+  module TagDecorator
+    def self.prepended(base)
+      base.include ::Spree::RansackableAttributes
+      base.whitelisted_ransackable_attributes = %w[id name]
+    end
+  end
+
+  Tag.prepend(TagDecorator)
+end

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

@@ -8,6 +8,8 @@ module Spree
       validates :calculator, presence: true
       delegate :compute, to: :calculator
 
+      scope :with_calculator, ->(calculator) { joins(:calculator).where(calculator: { type: calculator.to_s }) }
+
       def self.calculators
         spree_calculators.send model_name_without_spree_namespace
       end

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

@@ -0,0 +1,13 @@
+module Spree
+  module DisplayOn
+    extend ActiveSupport::Concern
+
+    DISPLAY = [:both, :front_end, :back_end].freeze
+
+    included do
+      scope :available,              -> { where(display_on: [:both]) }
+      scope :available_on_front_end, -> { where(display_on: [:front_end, :both]) }
+      scope :available_on_back_end,  -> { where(display_on: [:back_end, :both]) }
+    end
+  end
+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), 'ActionText::RichText'],
+          [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/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), 'ActionText::RichText'],
+          [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/concerns/spree/metadata.rb

@@ -5,13 +5,9 @@ module Spree
     included do
       attribute :public_metadata, default: {}
       attribute :private_metadata, default: {}
-      if Rails::VERSION::STRING >= '7.1.0'
-        serialize :public_metadata, coder: HashSerializer
-        serialize :private_metadata, coder: HashSerializer
-      else
-        serialize :public_metadata, HashSerializer
-        serialize :private_metadata, HashSerializer
-      end
+
+      serialize :public_metadata, coder: HashSerializer
+      serialize :private_metadata, coder: HashSerializer
     end
 
     # https://nandovieira.com/using-postgresql-and-jsonb-with-ruby-on-rails

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

@@ -0,0 +1,21 @@
+module Spree
+  module MultiSearchable
+    extend ActiveSupport::Concern
+
+    included do
+      def self.sanitize_query_for_multi_search(query)
+        ActiveRecord::Base.sanitize_sql_like(query.to_s.downcase.strip)
+      end
+
+      def self.multi_search_condition(model_class, attribute, query)
+        encrypted_attributes = model_class.encrypted_attributes.presence || []
+
+        if encrypted_attributes.include?(attribute.to_sym)
+          model_class.arel_table[attribute.to_sym].eq(query)
+        else
+          model_class.arel_table[attribute.to_sym].lower.matches("%#{query}%")
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,8 @@ module Spree
     included do
       scope :for_store, ->(store) { joins(:stores).where(Store.table_name => { id: store.id }) }
 
+      before_validation :set_default_store, if: :new_record?
+
       validate :must_have_one_store, unless: :disable_store_presence_validation?
     end
 
@@ -16,6 +18,13 @@ module Spree
       errors.add(:stores, Spree.t(:must_have_one_store))
     end
 
+    def set_default_store
+      return if disable_store_presence_validation?
+      return if stores.any?
+
+      stores << Spree::Store.default
+    end
+
     # this can be overridden on model basis
     def disable_store_presence_validation?
       Spree::Config[:disable_store_presence_validation]

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

@@ -2,8 +2,10 @@ module Spree
   module NumberAsParam
     extend ActiveSupport::Concern
 
-    def to_param
-      number.presence.to_s
+    included do
+      extend FriendlyId
+
+      friendly_id :number
     end
   end
 end

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

@@ -0,0 +1,21 @@
+module Spree
+  module ParameterizableName
+    extend ActiveSupport::Concern
+
+    included do
+      #
+      # Callbacks
+      #
+      before_validation :set_name_from_presentation, if: -> { name.blank? }
+      before_validation :normalize_name
+
+      def set_name_from_presentation
+        self.name = presentation
+      end
+
+      def normalize_name
+        self.name = name.to_s.parameterize.strip
+      end
+    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/product_scopes.rb

@@ -246,7 +246,7 @@ module Spree
 
       def self.not_discontinued(only_not_discontinued = true)
         if only_not_discontinued != '0' && only_not_discontinued
-          where.not(status: 'archived')
+          where(discontinue_on: [nil, Time.current..])
         else
           all
         end
@@ -263,11 +263,11 @@ module Spree
 
       # Can't use add_search_scope for this as it needs a default argument
       def self.available(available_on = nil, currency = nil)
-        if available_on
-          scope = not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
-        else
-          scope = where(status: 'active')
-        end
+        scope = if available_on
+                  not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+                else
+                  not_discontinued.where(status: 'active')
+                end
 
         unless Spree::Config.show_products_without_price
           currency ||= Spree::Store.default.default_currency
@@ -305,7 +305,7 @@ module Spree
       # .search_by_name
       if defined?(PgSearch)
         include PgSearch::Model
-        pg_search_scope :search_by_name, against: :name, using: { tsearch: { any_word: true, prefix: true } }
+        pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { tsearch: { any_word: true, prefix: true } }
       else
         def self.search_by_name(query)
           i18n { name.lower.matches("%#{query.downcase}%") }

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

@@ -0,0 +1,52 @@
+module Spree
+  module Stores
+    module Setup
+      extend ActiveSupport::Concern
+
+      def setup_task_done?(task)
+        case task
+        when :setup_payment_method
+          payment_method_setup?
+        when :setup_taxes_collection
+          Spree::TaxRate.any?
+        when :add_products
+          products.any?
+        when :set_customer_support_email
+          customer_support_email.present?
+        end
+      end
+
+      def setup_tasks_total
+        @setup_tasks_total = setup_tasks_list.count
+      end
+
+      def setup_tasks_list
+        return [] if deleted?
+
+        @setup_tasks_list = []
+        @setup_tasks_list << :setup_payment_method
+        @setup_tasks_list << :add_products
+        @setup_tasks_list << :set_customer_support_email
+        @setup_tasks_list << :setup_taxes_collection
+
+        @setup_tasks_list
+      end
+
+      def setup_tasks_done
+        @setup_tasks_done = setup_tasks_list.select { |task| setup_task_done?(task) }.count
+      end
+
+      def setup_completed?
+        @setup_completed ||= setup_tasks_done == setup_tasks_total
+      end
+
+      def setup_percentage
+        @setup_percentage ||= (setup_tasks_done / setup_tasks_total.to_f * 100).to_i
+      end
+
+      def payment_method_setup?
+        payment_methods.active.where.not(type: Spree::PaymentMethod::StoreCredit.to_s).any?
+      end
+    end
+  end
+end