spree_core 5.2.6 → 5.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0552e5475aa54e072158a70ea648d02d5514550eca293f1c0e0c79554c4216
-  data.tar.gz: afe49cf6d48fa819396d1518e3531435ffc22d038ce1a75aef430082bbc429fb
+  metadata.gz: e9a0e0a87e86ccf2c9213c4511c96c63b672ee82dba7c47f029b60e94226b975
+  data.tar.gz: 191192ca65bb1d919da4dd77cc93b50cfcfb51618a36dc954788ff4b259d5185
 SHA512:
-  metadata.gz: 46b12717f12408f073b31a2a4f70d8850204bcfd59d32b20a6d891bc0326b7ea0c563c9b876e81156c6ba40f6ba88705553f87bc349598f52e8d761a7ea887a7
-  data.tar.gz: 37e34cbc4020055babe24354344aae7306dde8343267b2bac666fe691881936e5ebf6daeaa982ad4ce1ea4df88eecc77cb168c5321c57c2329b920dba37d05d7
+  metadata.gz: d6eeed104b0d5ffa31c70d98792da3944ae19b81fd63afd62368fdeb6a8a5efa93775660c07e7990e05c9b3e8934d2ae064bc389d91f1c3c4face95dc10f477d
+  data.tar.gz: 54698f48b85f66aca3c03c3efaaf836ee216996b98c3564739d0cad3e816e1b158f0e79b4b3df9034c2e0f6a54ad1621d55484cb0803a87e6edf045fb806f39b

data/app/helpers/spree/addresses_helper.rb

@@ -31,7 +31,7 @@ module Spree
       method_name = Spree.t(:zipcode)
       form.label(:zipcode, method_name, id: address_id + '_zipcode_label', class: 'block text-xs text-neutral-600 mb-1') +
       form.text_field(:zipcode,
-                      class: 'text-input h-full',
+                      class: 'text-input',
                       placeholder: method_name,
                       required: country&.zipcode_required?,
                       data: { 'address-form-target': 'zipcode', address_autocomplete_target: 'zipcode' },
@@ -74,28 +74,6 @@ module Spree
       end
     end
 
-    def current_store_countries_with_states_ids
-      Spree::Deprecation.warn('current_store_countries_with_states_ids is deprecated and will be removed in Spree 5.3')
-
-      @current_store_countries_with_states_ids ||= current_store.countries_available_for_checkout.find_all { |country| country.states_required? }.each_with_object([]) do |country, memo|
-        memo << current_store.states_available_for_checkout(country)
-      end.flatten.pluck(:country_id)
-    end
-
-    def current_store_countries_without_states_ids
-      Spree::Deprecation.warn('current_store_countries_without_states_ids is deprecated and will be removed in Spree 5.3')
-
-      @current_store_countries_without_states_ids ||= current_store.countries_available_for_checkout.find_all { |country| !country.states_required? }.pluck(:id)
-    end
-
-    def current_store_supported_countries_ids
-      Spree::Deprecation.warn('current_store_supported_countries_ids is deprecated and will be removed in Spree 5.3')
-
-      @current_store_supported_countries_ids ||= Rails.cache.fetch(['current_store_supported_countries_ids', current_store]) do
-        (current_store_countries_with_states_ids + current_store_countries_without_states_ids).uniq
-      end
-    end
-
     def user_available_addresses
       return [] unless try_spree_current_user
 

data/app/helpers/spree/base_helper.rb

@@ -23,16 +23,22 @@ module Spree
     end
 
     def spree_resource_path(resource)
+      Spree::Deprecation.warn('BaseHelper#spree_resource_path is deprecated and will be removed in Spree 5.5')
+
       last_word = resource.class.name.split('::', 10).last
 
       spree_class_name_as_path(last_word)
     end
 
     def spree_class_name_as_path(class_name)
+      Spree::Deprecation.warn('BaseHelper#spree_class_name_as_path is deprecated and will be removed in Spree 5.5')
+
       class_name.underscore.humanize.parameterize(separator: '_')
     end
 
     def display_price(product_or_variant)
+      Spree::Deprecation.warn('display_price is deprecated and will be removed in Spree 5.5. Use variant.price_for(context).display_amount instead.')
+
       product_or_variant.
         price_in(current_currency).
         display_price_including_vat_for(current_price_options).
@@ -40,6 +46,8 @@ module Spree
     end
 
     def display_compare_at_price(product_or_variant)
+      Spree::Deprecation.warn('display_compare_at_price is deprecated and will be removed in Spree 5.5. Use variant.price_for(context).display_compare_at_amount instead.')
+
       product_or_variant.
         price_in(current_currency).
         display_compare_at_price_including_vat_for(current_price_options).
@@ -47,6 +55,8 @@ module Spree
     end
 
     def link_to_tracking(shipment, options = {})
+      Spree::Deprecation.warn('BaseHelper#link_to_tracking is deprecated and will be removed in Spree 5.5. Please use shipment.tracking_url instead.')
+
       return unless shipment.tracking && shipment.shipping_method
 
       options[:target] ||= :blank
@@ -59,6 +69,8 @@ module Spree
     end
 
     def spree_favicon_path
+      Spree::Deprecation.warn('BaseHelper#spree_favicon_path is deprecated and will be removed in Spree 5.5. Please use Active Storage URL helpers instead.')
+
       if current_store.favicon.present?
         main_app.cdn_image_url(current_store.favicon)
       else
@@ -70,66 +82,9 @@ module Spree
       instance_variable_get('@' + controller_name.singularize)
     end
 
-    def og_meta_data
-      og_meta = {}
-
-      if object.is_a? Spree::Product
-        image                             = default_image_for_product_or_variant(object)
-        og_meta['og:image']               = main_app.cdn_image_url(image.attachment) if image&.attachment
-
-        og_meta['og:url']                 = spree.url_for(object) if frontend_available? # url_for product needed
-        og_meta['og:type']                = object.class.name.demodulize.downcase
-        og_meta['og:title']               = object.name
-        og_meta['og:description']         = object.description
-
-        price = object.price_in(current_currency)
-        if price
-          og_meta['product:price:amount']   = price.amount
-          og_meta['product:price:currency'] = current_currency
-        end
-      end
-
-      og_meta
-    end
-
-    def meta_data
-      meta = {}
-
-      if object.is_a? ApplicationRecord
-        meta[:keywords] = object.meta_keywords if object.try(:meta_keywords).present?
-        meta[:description] = object.meta_description if object.try(:meta_description).present?
-      end
-
-      if meta[:description].blank? && object.is_a?(Spree::Product)
-        meta[:description] = truncate(strip_tags(object.description), length: 160, separator: ' ')
-      end
-
-      if meta[:keywords].blank? || meta[:description].blank?
-        if object && object[:name].present?
-          meta.reverse_merge!(keywords: [object.name, current_store.meta_keywords].reject(&:blank?).join(', '),
-                              description: [object.name, current_store.meta_description].reject(&:blank?).join(', '))
-        else
-          meta.reverse_merge!(keywords: (current_store.meta_keywords || current_store.seo_title),
-                              description: current_store.seo_meta_description)
-        end
-      end
-      meta
-    end
-
-    def og_meta_data_tags
-      og_meta_data.map do |property, content|
-        tag('meta', property: property, content: content) unless property.nil? || content.nil?
-      end.join("\n")
-    end
-
-    def meta_data_tags
-      meta_data.map do |name, content|
-        tag('meta', name: name, content: content) unless name.nil? || content.nil?
-      end.join("\n")
-    end
-
     def method_missing(method_name, *args, &block)
       if image_style = image_style_from_method_name(method_name)
+        Spree::Deprecation.warn("#{BaseHelper.name}##{method_name} is deprecated and will be removed in Spree 5.5. Please use spree_image_tag instead - https://spreecommerce.org/docs/developer/core-concepts/images-assets#preprocessed-named-variants")
         define_image_method(image_style)
         send(method_name, *args)
       else
@@ -140,7 +95,7 @@ module Spree
     def pretty_time(time)
       return '' if time.blank?
 
-      Spree::Deprecation.warn('BaseHelper#pretty_time is deprecated and will be removed in Spree 6.0. Please add `local_time` gem to your Gemfile and use `local_time(time)` instead')
+      Spree::Deprecation.warn('BaseHelper#pretty_time is deprecated and will be removed in Spree 5.5. Please add `local_time` gem to your Gemfile and use `local_time(time)` instead')
 
       [I18n.l(time.to_date, format: :long), time.strftime('%l:%M %p %Z')].join(' ')
     end
@@ -148,16 +103,18 @@ module Spree
     def pretty_date(date)
       return '' if date.blank?
 
-      Spree::Deprecation.warn('BaseHelper#pretty_date is deprecated and will be removed in Spree 6.0. Please add `local_time` gem to your Gemfile and use `local_date(date)` instead')
+      Spree::Deprecation.warn('BaseHelper#pretty_date is deprecated and will be removed in Spree 5.5. Please add `local_time` gem to your Gemfile and use `local_date(date)` instead')
 
       [I18n.l(date.to_date, format: :long)].join(' ')
     end
 
     def seo_url(taxon, options = {})
+      Spree::Deprecation.warn('BaseHelper#seo_url is deprecated and will be removed in Spree 5.5. Please use spree_storefront_resource_url')
       spree.nested_taxons_path(taxon.permalink, options.merge(locale: locale_param))
     end
 
     def frontend_available?
+      Spree::Deprecation.warn('BaseHelper#frontend_available? is deprecated and will be removed in Spree 5.5')
       Spree::Core::Engine.frontend_available?
     end
 
@@ -198,14 +155,14 @@ module Spree
         params = "?#{params}" if params.present?
 
         "#{base_url + localize}/products/#{resource.slug}#{params}"
-      elsif resource.is_a?(Post)
+      elsif defined?(Spree::Post) && resource.is_a?(Spree::Post)
         preview_id = options[:preview_id].present? ? "?preview_id=#{options[:preview_id]}" : ''
         "#{base_url + localize}/posts/#{resource.slug}#{preview_id}"
       elsif resource.is_a?(Spree::Taxon)
         "#{base_url + localize}/t/#{resource.permalink}"
-      elsif resource.is_a?(Spree::Page) || resource.is_a?(Spree::Policy)
+      elsif defined?(Spree::Page) && (resource.is_a?(Spree::Page) || resource.is_a?(Spree::Policy))
         "#{base_url + localize}#{resource.page_builder_url}"
-      elsif resource.is_a?(Spree::PageLink)
+      elsif defined?(Spree::PageLink) && resource.is_a?(Spree::PageLink)
         resource.linkable_url
       elsif localize.blank?
         base_url
@@ -217,19 +174,19 @@ module Spree
     # we should always try to render image of the default variant
     # same as it's done on PDP
     def default_image_for_product(product)
-      Spree::Deprecation.warn('BaseHelper#default_image_for_product is deprecated and will be removed in Spree 6.0. Please use product.default_image instead')
+      Spree::Deprecation.warn('BaseHelper#default_image_for_product is deprecated and will be removed in Spree 5.5. Please use product.default_image instead')
 
       product.default_image
     end
 
     def default_image_for_product_or_variant(product_or_variant)
-      Spree::Deprecation.warn('BaseHelper#default_image_for_product_or_variant is deprecated and will be removed in Spree 6.0. Please use product_or_variant.default_image instead')
+      Spree::Deprecation.warn('BaseHelper#default_image_for_product_or_variant is deprecated and will be removed in Spree 5.5. Please use product_or_variant.default_image instead')
 
       product_or_variant.default_image
     end
 
     def base_cache_key
-      Spree::Deprecation.warn('`base_cache_key` is deprecated and will be removed in Spree 6. Please use `spree_base_cache_key` instead')
+      Spree::Deprecation.warn('`base_cache_key` is deprecated and will be removed in Spree 5.5. Please use `spree_base_cache_key` instead')
       spree_base_cache_key
     end
 
@@ -256,6 +213,8 @@ module Spree
       opts[:width] ||= opts[:height] * 1.5 if opts[:height]
       opts[:size] = "#{opts[:width]}x#{opts[:height]}" if opts[:width] && opts[:height]
 
+      opts[:fallback] = 'payment_icons/storecredit.svg'
+
       inline_svg "payment_icons/#{payment_method}.svg", opts
     end
 
@@ -291,17 +250,6 @@ module Spree
       end
     end
 
-    def meta_robots
-      return unless current_store.respond_to?(:seo_robots)
-      return if current_store.seo_robots.blank?
-
-      tag('meta', name: 'robots', content: current_store.seo_robots)
-    end
-
-    def legal_policy(policy)
-      current_store.send("customer_#{policy}")&.body&.html_safe
-    end
-
     I18N_PLURAL_MANY_COUNT = 2.1
     def plural_resource_name(resource_class)
       resource_class.model_name.human(count: I18N_PLURAL_MANY_COUNT)

data/app/helpers/spree/currency_helper.rb

@@ -45,12 +45,12 @@ module Spree
     # Returns the list of supported currencies for the current store.
     # @return [Array<Money::Currency>] the list of supported currencies
     def preferred_currencies
-      Spree::Deprecation.warn('preferred_currencies is deprecated and will be removed in Spree 6.0. Use current_store.supported_currencies_list instead.')
+      Spree::Deprecation.warn('preferred_currencies is deprecated and will be removed in Spree 5.5. Use current_store.supported_currencies_list instead.')
       @preferred_currencies ||= current_store.supported_currencies_list
     end
 
     def preferred_currencies_select_options
-      Spree::Deprecation.warn('preferred_currencies_select_options is deprecated and will be removed in Spree 6.0. Use supported_currency_options instead.')
+      Spree::Deprecation.warn('preferred_currencies_select_options is deprecated and will be removed in Spree 5.5. Use supported_currency_options instead.')
       preferred_currencies.map { |currency| currency_presentation(currency) }
     end
 

data/app/helpers/spree/images_helper.rb

@@ -9,6 +9,10 @@ module Spree
     # @option options [Integer] :height the height of the image
     # @option options [Symbol] :variant use a preprocessed named variant (e.g., :mini, :small, :medium, :large, :xlarge)
     def spree_image_tag(image, options = {})
+      return unless image
+      return unless image.variable?
+      return if image.respond_to?(:attached?) && !image.attached?
+
       url_options = if options[:variant].present?
                       { variant: options[:variant] }
                     else
@@ -25,6 +29,7 @@ module Spree
       return unless image
       return unless image.variable?
       return if image.respond_to?(:attached?) && !image.attached?
+
       url_helpers = respond_to?(:main_app) ? main_app : Rails.application.routes.url_helpers
 
       # Use preprocessed named variant if specified (e.g., :mini, :small, :medium, :large, :xlarge)

data/app/helpers/spree/mail_helper.rb

@@ -17,7 +17,7 @@ module Spree
     end
 
     def logo_path
-      Spree::Deprecation.warn('logo_path is deprecated and will be removed in Spree 6.0. Please use Active Storage URL helpers instead.')
+      Spree::Deprecation.warn('logo_path is deprecated and will be removed in Spree 5.5. Please use Active Storage URL helpers instead.')
 
       return main_app.cdn_image_url(store_logo.variant(resize_to_limit: [244, 104])) if store_logo&.variable?
 

data/app/helpers/spree/products_helper.rb

@@ -121,7 +121,7 @@ module Spree
     end
 
     def related_products
-      Spree::Deprecation.warn('ProductsHelper#related_products is deprecated and will be removed in Spree 6.0. Please use ProductsHelper#relations from now on.')
+      Spree::Deprecation.warn('ProductsHelper#related_products is deprecated and will be removed in Spree 5.5. Please use ProductsHelper#relations from now on.')
 
       return [] unless @product.respond_to?(:has_related_products?)
 

data/app/jobs/spree/events/subscriber_job.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Spree
+  module Events
+    # Job for executing subscribers asynchronously.
+    #
+    # When subscribers are configured to run async (the default),
+    # this job is enqueued to handle the event processing in the background.
+    #
+    # @example Direct usage (typically called by the adapter)
+    #   Spree::Events::SubscriberJob.perform_later(
+    #     'MySubscriber',
+    #     { name: 'order.complete', payload: {...}, ... }
+    #   )
+    #
+    class SubscriberJob < Spree::BaseJob
+      queue_as Spree.queues.events
+
+      # Retry configuration
+      retry_on StandardError, wait: :polynomially_longer, attempts: 3
+
+      discard_on ActiveJob::DeserializationError do |job, error|
+        Rails.error.report(error, context: {
+          subscriber: job.arguments.first,
+          event: job.arguments.second
+        })
+      end
+
+      # @param subscriber_class_name [String] The subscriber class name
+      # @param event_hash [Hash] The event data as a hash
+      def perform(subscriber_class_name, event_hash)
+        subscriber_class = subscriber_class_name.constantize
+        event = reconstruct_event(event_hash)
+
+        if subscriber_class < Spree::Subscriber
+          subscriber_class.new.call(event)
+        elsif subscriber_class.respond_to?(:call)
+          subscriber_class.call(event)
+        else
+          raise ArgumentError, "#{subscriber_class_name} is not a valid subscriber"
+        end
+      rescue NameError => e
+        Rails.error.report(e, context: {
+          subscriber: subscriber_class_name,
+          event_name: event_hash[:name] || event_hash['name']
+        })
+        raise
+      end
+
+      private
+
+      def reconstruct_event(event_hash)
+        event_hash = event_hash.deep_symbolize_keys
+        Spree::Event.new(**event_hash.slice(:id, :name, :store_id, :payload, :metadata, :created_at))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Products
+    class RefreshMetricsJob < Spree::BaseJob
+      queue_as Spree.queues.products
+
+      def perform(product_id, store_id)
+        store_product = Spree::StoreProduct.find_by(product_id: product_id, store_id: store_id)
+        return unless store_product
+
+        store_product.refresh_metrics!
+      end
+    end
+  end
+end

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

@@ -6,7 +6,6 @@ module Spree
       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)
-        Spree::Taxons::TouchFeaturedSections.call(taxon_ids: taxon_ids)
       end
     end
   end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Variants
+    class TouchJob < Spree::BaseJob
+      def perform(variant_ids)
+        Spree::Variant.where(id: variant_ids).find_each(&:touch)
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ module Spree
     included do
       has_many :adjustments, as: :source
       before_destroy :deals_with_adjustments_for_deleted_source
+      after_commit :clear_adjustment_source_cache
     end
 
     protected
@@ -54,5 +55,12 @@ module Spree
       # This would mean that the order's total is not altered at all.
       adjustments.for_complete_order.update_all(source_id: nil, updated_at: Time.current)
     end
+
+    def clear_adjustment_source_cache
+      # Use base_class.name to match the polymorphic_name stored in source_type
+      # For STI models like PromotionAction subclasses, this ensures cache key consistency
+      cache_class_name = self.class.polymorphic_name
+      Rails.cache.delete("spree/adjustment_source/#{cache_class_name}/#{id}")
+    end
   end
 end

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

@@ -3,7 +3,7 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      auto_strip_attributes :name, :presentation
+      normalizes :name, :presentation, with: ->(value) { value&.to_s&.squish&.presence }
 
       #
       # Callbacks

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

@@ -56,6 +56,34 @@ module Spree
         order(price_table_name => { amount: :desc })
       end
 
+      # Price sorting scopes that use subqueries to get prices across all variants
+      # These ensure products with only variant prices (no master price) are included in results
+      add_search_scope :ascend_by_price do
+        price_subquery = Price
+          .non_zero
+          .joins(:variant)
+          .where("#{Variant.table_name}.product_id = #{Product.table_name}.id")
+          .select('MIN(amount)')
+
+        price_sort_sql = "COALESCE((#{price_subquery.to_sql}), 999999999)"
+
+        select("#{Product.table_name}.*", "#{price_sort_sql} AS min_price").
+          order(Arel.sql("#{price_sort_sql} ASC"))
+      end
+
+      add_search_scope :descend_by_price do
+        price_subquery = Price
+          .non_zero
+          .joins(:variant)
+          .where("#{Variant.table_name}.product_id = #{Product.table_name}.id")
+          .select('MAX(amount)')
+
+        price_sort_sql = "COALESCE((#{price_subquery.to_sql}), 0)"
+
+        select("#{Product.table_name}.*", "#{price_sort_sql} AS max_price").
+          order(Arel.sql("#{price_sort_sql} DESC"))
+      end
+
       add_search_scope :price_between do |low, high|
         where(Price.table_name => { amount: low..high })
       end
@@ -113,16 +141,13 @@ module Spree
       end
 
       add_search_scope :ascend_by_taxons_min_position do |taxon_ids|
+        min_position_sql = "MIN(#{Classification.table_name}.position)"
+
         joins(:classifications).
           where(Classification.table_name => { taxon_id: taxon_ids }).
-          select(
-            [
-              "#{Product.table_name}.*",
-              "MIN(#{Classification.table_name}.position) AS min_position"
-            ].join(', ')
-          ).
-          group(:id).
-          order(min_position: :asc)
+          select("#{Product.table_name}.*", "#{min_position_sql} AS min_taxon_position").
+          group("#{Product.table_name}.id").
+          order(Arel.sql("#{min_position_sql} ASC"))
       end
 
       # a scope that finds all products having property specified by name, object or id
@@ -302,6 +327,27 @@ module Spree
         group('spree_products.id').joins(:taxons).where(Taxon.arel_table[:name].eq(name))
       end
 
+      # Orders products by best selling based on units_sold_count and revenue
+      # stored in spree_products_stores table.
+      #
+      # These metrics are updated asynchronously when orders are completed
+      # via the ProductMetricsSubscriber.
+      #
+      # @param order_direction [Symbol] :desc (default) or :asc
+      # @return [ActiveRecord::Relation]
+      add_search_scope :by_best_selling do |order_direction = :desc|
+        order_dir = order_direction == :desc ? 'DESC' : 'ASC'
+        store_id = Spree::Current.store&.id
+
+        joins(:store_products)
+          .where(StoreProduct.table_name => { store_id: store_id })
+          .select("#{Product.table_name}.*",
+                  "#{StoreProduct.table_name}.units_sold_count",
+                  "#{StoreProduct.table_name}.revenue")
+          .order(Arel.sql("#{StoreProduct.table_name}.units_sold_count #{order_dir}"))
+          .order(Arel.sql("#{StoreProduct.table_name}.revenue #{order_dir}"))
+      end
+
       # .search_by_name
       if defined?(PgSearch)
         include PgSearch::Model