spree_core 4.5.0 → 4.7.3

data/app/models/spree/data_feed.rb

@@ -0,0 +1,40 @@
+module Spree
+  class DataFeed < Base
+    belongs_to :store, class_name: 'Spree::Store', foreign_key: 'store_id'
+
+    scope :for_store, ->(store) { where(store: store) }
+
+    before_validation :generate_slug
+
+    with_options presence: true do
+      validates :store
+      validates :name, uniqueness: true
+      validates :slug, uniqueness: { scope: :store_id }
+    end
+
+    def formatted_url
+      "#{store.formatted_url}/api/v2/data_feeds/#{self.class.provider_name}/#{slug}.rss"
+    end
+
+    private
+
+    def generate_slug
+      new_slug = slug.blank? ? SecureRandom.uuid : slug.parameterize
+      write_attribute(:slug, new_slug)
+    end
+
+    class << self
+      def label
+        raise NotImplementedError
+      end
+
+      def provider_name
+        raise NotImplementedError
+      end
+
+      def available_types
+        Rails.application.config.spree.data_feed_types
+      end
+    end
+  end
+end

data/app/models/spree/digital_link.rb

@@ -1,6 +1,10 @@
 module Spree
   class DigitalLink < Spree::Base
-    has_secure_token
+    if Rails::VERSION::STRING >= '7.1.0'
+      has_secure_token on: :save
+    else
+      has_secure_token
+    end
 
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/image.rb

@@ -1,8 +1,8 @@
 module Spree
   class Image < Asset
-    include Configuration::ActiveStorage
+    include Spree::Image::Configuration::ActiveStorage
     include Rails.application.routes.url_helpers
-    include ::Spree::ImageMethods
+    include Spree::ImageMethods
 
     # In Rails 5.x class constants are being undefined/redefined during the code reloading process
     # in a rails development environment, after which the actual ruby objects stored in those class constants

data/app/models/spree/legacy_user.rb

@@ -1,9 +1,9 @@
 # Default implementation of User.  This class is intended to be modified by extensions (ex. spree_auth_devise)
 module Spree
   class LegacyUser < Spree::Base
-    include UserAddress
-    include UserPaymentSource
-    include UserMethods
+    include Spree::UserAddress
+    include Spree::UserPaymentSource
+    include Spree::UserMethods
     include Spree::Metadata
 
     self.table_name = 'spree_users'

data/app/models/spree/line_item.rb

@@ -1,6 +1,6 @@
 module Spree
   class LineItem < Spree::Base
-    include Metadata
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/log_entry.rb

@@ -15,7 +15,11 @@ module Spree
     end
 
     def parsed_details
-      @details ||= YAML.safe_load(details, [ActiveMerchant::Billing::Response])
+      @details ||= if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.1.0')
+                     YAML.safe_load(details, permitted_classes: [ActiveMerchant::Billing::Response])
+                   else
+                     YAML.safe_load(details, [ActiveMerchant::Billing::Response])
+                   end
     end
   end
 end

data/app/models/spree/menu.rb

@@ -1,6 +1,6 @@
 module Spree
   class Menu < Spree::Base
-    include SingleStoreResource
+    include Spree::SingleStoreResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/option_type.rb

@@ -1,11 +1,15 @@
 module Spree
   class OptionType < Spree::Base
-    include UniqueName
-    include Metadata
+    include Spree::UniqueName
+    include Spree::Metadata
+    include Spree::TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    TRANSLATABLE_FIELDS = %i[name presentation].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
     acts_as_list
     auto_strip_attributes :name, :presentation
 

data/app/models/spree/option_value.rb

@@ -1,10 +1,14 @@
 module Spree
   class OptionValue < Spree::Base
-    include Metadata
+    include Spree::Metadata
+    include Spree::TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    TRANSLATABLE_FIELDS = %i[name presentation].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
     belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_values
 
     acts_as_list scope: :option_type

data/app/models/spree/order/store_credit.rb

@@ -1,6 +1,14 @@
 module Spree
   class Order < Spree::Base
     module StoreCredit
+      def add_store_credit_payments(amount = nil)
+        Spree::Dependencies.checkout_add_store_credit_service.constantize.call(order: self, amount: amount)
+      end
+
+      def remove_store_credit_payments
+        Spree::Dependencies.checkout_remove_store_credit_service.constantize.call(order: self)
+      end
+
       def covered_by_store_credit?
         return false unless user
 

data/app/models/spree/order.rb

@@ -20,11 +20,11 @@ module Spree
     include Spree::Core::NumberGenerator.new(prefix: 'R')
     include Spree::Core::TokenGenerator
 
-    include NumberIdentifier
-    include NumberAsParam
-    include SingleStoreResource
-    include MemoizedData
-    include Metadata
+    include Spree::NumberIdentifier
+    include Spree::NumberAsParam
+    include Spree::SingleStoreResource
+    include Spree::MemoizedData
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -415,7 +415,7 @@ module Spree
 
     def available_payment_methods(store = nil)
       if store.present?
-        ActiveSupport::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
+        Spree::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
       end
 
       @available_payment_methods ||= collect_payment_methods(store)
@@ -449,7 +449,7 @@ module Spree
     end
 
     def empty!
-      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+      Spree::Deprecation.warn(<<-DEPRECATION, caller)
         `Order#empty!` is deprecated and will be removed in Spree 5.0.
         Please use `Spree::Cart::Empty.call(order: order)` instead.
       DEPRECATION
@@ -647,7 +647,7 @@ module Spree
     end
 
     def validate_payments_attributes(attributes)
-      ActiveSupport::Deprecation.warn('`Order#validate_payments_attributes` is deprecated and will be removed in Spree 5')
+      Spree::Deprecation.warn('`Order#validate_payments_attributes` is deprecated and will be removed in Spree 5')
 
       # Ensure the payment methods specified are allowed for this user
       payment_method_ids = available_payment_methods.map(&:id).map(&:to_s)
@@ -745,7 +745,7 @@ module Spree
 
     def collect_payment_methods(store = nil)
       if store.present?
-        ActiveSupport::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
+        Spree::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
       end
       store ||= self.store
 

data/app/models/spree/order_contents.rb

@@ -0,0 +1,31 @@
+module Spree
+  class OrderContents
+    attr_accessor :order, :currency
+
+    def initialize(order)
+      @order = order
+    end
+
+    def add(variant, quantity = 1, options = {})
+      Spree::Dependencies.cart_add_item_service.constantize.call(order: order,
+                                                                 variant: variant,
+                                                                 quantity: quantity,
+                                                                 options: options).value
+    end
+
+    def remove(variant, quantity = 1, options = {})
+      Spree::Dependencies.cart_remove_item_service.constantize.call(order: order,
+                                                                    variant: variant,
+                                                                    quantity: quantity,
+                                                                    options: options).value
+    end
+
+    def remove_line_item(line_item, options = {})
+      Spree::Cart::RemoveLineItem.call(order: @order, line_item: line_item, options: options).value
+    end
+
+    def update_cart(params)
+      Spree::Dependencies.cart_update_service.constantize.call(order: order, params: params).value
+    end
+  end
+end

data/app/models/spree/payment.rb

@@ -3,9 +3,9 @@ require_dependency 'spree/payment/processing'
 module Spree
   class Payment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'P', letters: true, length: 7)
-    include NumberIdentifier
-    include NumberAsParam
-    include Metadata
+    include Spree::NumberIdentifier
+    include Spree::NumberAsParam
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -222,18 +222,10 @@ module Spree
 
     def validate_source
       if source && !source.valid?
-        if Rails::VERSION::STRING >= '6.1'
-          source.errors.map { |error| { field: error.attribute, message: error&.message } }.each do |err|
-            next if err[:field].blank? || err[:message].blank?
-
-            add_source_error(err[:field], err[:message])
-          end
-        else
-          source.errors.messages.each do |field, error|
-            next if field.blank? || error.empty?
-
-            add_source_error(field, error.first)
-          end
+        source.errors.map { |error| { field: error.attribute, message: error&.message } }.each do |err|
+          next if err[:field].blank? || err[:message].blank?
+
+          add_source_error(err[:field], err[:message])
         end
       end
       !errors.present?

data/app/models/spree/payment_method.rb

@@ -3,7 +3,7 @@ module Spree
     acts_as_paranoid
     acts_as_list
 
-    include MultiStoreResource
+    include Spree::MultiStoreResource
     include Spree::Metadata
     if defined?(Spree::Security::PaymentMethods)
       include Spree::Security::PaymentMethods

data/app/models/spree/payment_source.rb

@@ -1,6 +1,6 @@
 module Spree
   class PaymentSource < Spree::Base
-    include Metadata
+    include Spree::Metadata
 
     belongs_to :payment_method, class_name: 'Spree::PaymentMethod'
     belongs_to :user, class_name: 'Spree::User', optional: true

data/app/models/spree/preference.rb

@@ -1,5 +1,9 @@
 class Spree::Preference < Spree::Base
-  serialize :value
+  if Rails::VERSION::STRING >= '7.1.0'
+    serialize :value, coder: YAML
+  else
+    serialize :value
+  end
 
   validates :key, presence: true,
                   uniqueness: { case_sensitive: false, allow_blank: true, scope: spree_base_uniqueness_scope }

data/app/models/spree/price.rb

@@ -1,6 +1,6 @@
 module Spree
   class Price < Spree::Base
-    include VatPriceCalculation
+    include Spree::VatPriceCalculation
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/product.rb

@@ -21,10 +21,12 @@
 module Spree
   class Product < Spree::Base
     extend FriendlyId
-    include ProductScopes
-    include MultiStoreResource
-    include MemoizedData
-    include Metadata
+    include Spree::ProductScopes
+    include Spree::MultiStoreResource
+    include Spree::TranslatableResource
+    include Spree::TranslatableResourceSlug
+    include Spree::MemoizedData
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -32,12 +34,36 @@ module Spree
       include Spree::VendorConcern
     end
 
-    MEMOIZED_METHODS = %w(total_on_hand taxonomy_ids taxon_and_ancestors category
+    MEMOIZED_METHODS = %w[total_on_hand taxonomy_ids taxon_and_ancestors category
                           default_variant_id tax_category default_variant
-                          purchasable? in_stock? backorderable?)
+                          purchasable? in_stock? backorderable?]
+
+    TRANSLATABLE_FIELDS = %i[name description slug meta_description meta_keywords meta_title].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      before_save :set_slug
+      acts_as_paranoid
+      # deleted translation values also need to be accessible for index views listing deleted resources
+      default_scope { unscope(where: :deleted_at) }
+      def set_slug
+        self.slug = generate_slug
+      end
+
+      private
 
-    friendly_id :slug_candidates, use: :history
+      def generate_slug
+        if name.blank? && slug.blank?
+          translated_model.name.to_url
+        elsif slug.blank?
+          name.to_url
+        else
+          slug.to_url
+        end
+      end
+    end
 
+    friendly_id :slug_candidates, use: [:history, :mobility]
     acts_as_paranoid
     auto_strip_attributes :name
 
@@ -306,14 +332,26 @@ module Spree
     end
 
     def property(property_name)
-      product_properties.joins(:property).find_by(spree_properties: { name: property_name }).try(:value)
+      product_properties.joins(:property).
+        join_translation_table(Property).
+        find_by(Property.translation_table_alias => { name: property_name }).try(:value)
     end
 
     def set_property(property_name, property_value, property_presentation = property_name)
       ApplicationRecord.transaction do
-        # Works around spree_i18n #301
-        property = Property.create_with(presentation: property_presentation).find_or_create_by(name: property_name)
-        product_property = ProductProperty.where(product: self, property: property).first_or_initialize
+        # Manual first_or_create to work around Mobility bug
+        property = if Property.where(name: property_name).exists?
+                     Property.where(name: property_name).first
+                   else
+                     Property.create(name: property_name, presentation: property_presentation)
+                   end
+
+        product_property = if ProductProperty.where(product: self, property: property).exists?
+                             ProductProperty.where(product: self, property: property).first
+                           else
+                             ProductProperty.create(product: self, property: property)
+                           end
+
         product_property.value = property_value
         product_property.save!
       end
@@ -337,11 +375,16 @@ module Spree
     end
 
     def brand
-      @brand ||= taxons.joins(:taxonomy).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_brands_name) })
+      @brand ||= taxons.joins(:taxonomy).
+                 join_translation_table(Taxonomy).
+                 find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_brands_name) })
     end
 
     def category
-      @category ||= taxons.joins(:taxonomy).order(depth: :desc).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_categories_name) })
+      @category ||= taxons.joins(:taxonomy).
+                    join_translation_table(Taxonomy).
+                    order(depth: :desc).
+                    find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_categories_name) })
     end
 
     def taxons_for_store(store)
@@ -415,7 +458,11 @@ module Spree
 
     def punch_slug
       # punch slug with date prefix to allow reuse of original
-      update_column :slug, "#{Time.current.to_i}_#{slug}"[0..254] unless frozen?
+      return if frozen?
+
+      translations.with_deleted.each do |t|
+        t.update_column :slug, "#{Time.current.to_i}_#{t.slug}"[0..254]
+      end
     end
 
     def update_slug_history
@@ -460,18 +507,10 @@ module Spree
       # We call master.default_price here to ensure price is initialized.
       # Required to avoid Variant#check_price validation failing on create.
       unless master.default_price && master.valid?
-        if Rails::VERSION::STRING >= '6.1'
-          master.errors.map { |error| { field: error.attribute, message: error&.message } }.each do |err|
-            next if err[:field].blank? || err[:message].blank?
-
-            errors.add(err[:field], err[:message])
-          end
-        else
-          master.errors.messages.each do |field, error|
-            next if field.blank? || error.empty?
+        master.errors.map { |error| { field: error.attribute, message: error&.message } }.each do |err|
+          next if err[:field].blank? || err[:message].blank?
 
-            errors.add(field, error.first)
-          end
+          errors.add(err[:field], err[:message])
         end
       end
     end

data/app/models/spree/product_property.rb

@@ -1,8 +1,14 @@
 module Spree
   class ProductProperty < Spree::Base
     include Spree::FilterParam
+    include Spree::TranslatableResource
 
-    auto_strip_attributes :value
+    TRANSLATABLE_FIELDS = %i[value filter_param].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      auto_strip_attributes :value
+    end
 
     acts_as_list scope: :product
 
@@ -27,12 +33,15 @@ module Spree
     delegate :name, :presentation, to: :property, prefix: true, allow_nil: true
 
     def property_name=(name)
-      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+      Spree::Deprecation.warn(<<-DEPRECATION, caller)
         `ProductProperty#property_name=` is deprecated and will be removed in Spree 5.0.
       DEPRECATION
       if name.present?
-        # don't use `find_by :name` to workaround globalize/globalize#423 bug
-        self.property = Property.where(name: name).first_or_create(presentation: name)
+        self.property = if Property.where(name: name).exists?
+                          Property.where(name: name).first
+                        else
+                          Property.create(name: name, presentation: name)
+                        end
       end
     end
 

data/app/models/spree/promotion.rb

@@ -1,7 +1,7 @@
 module Spree
   class Promotion < Spree::Base
-    include MultiStoreResource
-    include Metadata
+    include Spree::MultiStoreResource
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/property.rb

@@ -1,12 +1,18 @@
 module Spree
   class Property < Spree::Base
     include Spree::FilterParam
-    include Metadata
+    include Spree::Metadata
+    include Spree::TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
-    auto_strip_attributes :name, :presentation
+    TRANSLATABLE_FIELDS = %i[name presentation filter_param].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      auto_strip_attributes :name, :presentation
+    end
 
     has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'
     has_many :prototypes, through: :property_prototypes, class_name: 'Spree::Prototype'

data/app/models/spree/prototype.rb

@@ -1,6 +1,6 @@
 module Spree
   class Prototype < Spree::Base
-    include Metadata
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/refund.rb

@@ -1,6 +1,6 @@
 module Spree
   class Refund < Spree::Base
-    include Metadata
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/reimbursement.rb

@@ -1,7 +1,7 @@
 module Spree
   class Reimbursement < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RI', length: 9)
-    include NumberIdentifier
+    include Spree::NumberIdentifier
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/return_authorization.rb

@@ -1,7 +1,7 @@
 module Spree
   class ReturnAuthorization < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
-    include NumberIdentifier
+    include Spree::NumberIdentifier
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/return_item.rb

@@ -62,7 +62,11 @@ module Spree
     scope :exchange_required, -> { eager_load(:exchange_inventory_units).where(spree_inventory_units: { original_return_item_id: nil }).distinct }
     scope :resellable, -> { where resellable: true }
 
-    serialize :acceptance_status_errors
+    if Rails::VERSION::STRING >= '7.1.0'
+      serialize :acceptance_status_errors, coder: YAML
+    else
+      serialize :acceptance_status_errors
+    end
 
     delegate :eligible_for_return?, :requires_manual_intervention?, to: :validator
     delegate :variant, to: :inventory_unit

data/app/models/spree/role.rb

@@ -1,6 +1,6 @@
 module Spree
   class Role < Spree::Base
-    include UniqueName
+    include Spree::UniqueName
 
     has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
     has_many :users, through: :role_users, class_name: "::#{Spree.user_class}"

data/app/models/spree/shipment.rb

@@ -3,9 +3,9 @@ require 'ostruct'
 module Spree
   class Shipment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
-    include NumberIdentifier
-    include NumberAsParam
-    include Metadata
+    include Spree::NumberIdentifier
+    include Spree::NumberAsParam
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -249,8 +249,8 @@ module Spree
     end
 
     def selected_shipping_rate_id=(id)
-      shipping_rates.update_all(selected: false)
-      shipping_rates.touch_all # Bust cache dependent on "updated_at" timestamp
+      # Explicitly updates the timestamp in order to bust cache dependent on "updated_at"
+      shipping_rates.update_all(selected: false, updated_at: Time.current)
       shipping_rates.update(id, selected: true)
       save!
     end

data/app/models/spree/shipping_category.rb

@@ -1,6 +1,6 @@
 module Spree
   class ShippingCategory < Spree::Base
-    include UniqueName
+    include Spree::UniqueName
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/shipping_method.rb

@@ -2,7 +2,7 @@ module Spree
   class ShippingMethod < Spree::Base
     acts_as_paranoid
     include Spree::CalculatedAdjustments
-    include Metadata
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/stock/estimator.rb

@@ -1,7 +1,7 @@
 module Spree
   module Stock
     class Estimator
-      include VatPriceCalculation
+      include Spree::VatPriceCalculation
 
       attr_reader :order, :currency
 

data/app/models/spree/stock/splitter/weight.rb

@@ -15,7 +15,7 @@ module Spree
         private
 
         def reduce(package)
-          contents = split_package_contents_over_threshold(package).sort { |x, y| y.weight <=> x.weight }
+          contents = split_package_contents_over_threshold(package).sort_by(&:weight).reverse
           # Treat current package as one of the generated packages for convenience and add the heaviest item
           # This also prevents an additional package if no fit is possible
           package.contents.clear