spree_core 4.4.0 → 4.6.0

data/app/models/spree/preference.rb

@@ -3,4 +3,8 @@ class Spree::Preference < Spree::Base
 
   validates :key, presence: true,
                   uniqueness: { case_sensitive: false, allow_blank: true, scope: spree_base_uniqueness_scope }
+
+  if defined?(Spree::Security::Preferences)
+    include Spree::Security::Preferences
+  end
 end

data/app/models/spree/price.rb

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

data/app/models/spree/product.rb

@@ -23,20 +23,37 @@ module Spree
     extend FriendlyId
     include ProductScopes
     include MultiStoreResource
+    include TranslatableResource
+    include TranslatableResourceSlug
     include MemoizedData
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::VendorConcern)
+      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)
 
-    friendly_id :slug_candidates, use: :history
+    self::Translation.class_eval do
+      acts_as_paranoid
+      # deleted translation values also need to be accessible for index views listing deleted resources
+      default_scope { unscope(where: :deleted_at) }
+    end
 
+    friendly_id :slug_candidates, use: [:history, :mobility]
     acts_as_paranoid
+    auto_strip_attributes :name
 
     # we need to have this callback before any dependent: :destroy associations
     # https://github.com/rails/rails/issues/3458
-    before_destroy :ensure_no_line_items
+    before_destroy :ensure_not_in_complete_orders
 
     has_many :product_option_types, dependent: :destroy, inverse_of: :product
     has_many :option_types, through: :product_option_types
@@ -118,7 +135,7 @@ module Spree
     end
 
     validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true, scope: spree_base_uniqueness_scope }
-    validate :discontinue_on_must_be_later_than_available_on, if: -> { available_on && discontinue_on }
+    validate :discontinue_on_must_be_later_than_make_active_at, if: -> { make_active_at && discontinue_on }
 
     scope :for_store, ->(store) { joins(:store_products).where(StoreProduct.table_name => { store_id: store.id }) }
 
@@ -129,11 +146,11 @@ module Spree
     alias options product_option_types
 
     self.whitelisted_ransackable_associations = %w[taxons stores variants_including_master master variants]
-    self.whitelisted_ransackable_attributes = %w[description name slug discontinue_on]
+    self.whitelisted_ransackable_attributes = %w[description name slug discontinue_on status]
     self.whitelisted_ransackable_scopes = %w[not_discontinued search_by_name in_taxon price_between]
 
     [
-      :sku, :price, :currency, :weight, :height, :width, :depth, :is_master,
+      :sku, :barcode, :price, :currency, :weight, :height, :width, :depth, :is_master,
       :cost_currency, :price_in, :amount_in, :cost_price, :compare_at_price, :compare_at_amount_in
     ].each do |method_name|
       delegate method_name, :"#{method_name}=", to: :find_or_build_master
@@ -144,6 +161,23 @@ module Spree
 
     alias master_images images
 
+    state_machine :status, initial: :draft do
+      event :activate do
+        transition to: :active
+      end
+      after_transition to: :active, do: :after_activate
+
+      event :archive do
+        transition to: :archived
+      end
+      after_transition to: :archived, do: :after_archive
+
+      event :draft do
+        transition to: :draft
+      end
+      after_transition to: :draft, do: :after_draft
+    end
+
     # Can't use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
     def purchasable?
       default_variant.purchasable? || variants.any?(&:purchasable?)
@@ -225,14 +259,16 @@ module Spree
     end
 
     # determine if product is available.
-    # deleted products and products with nil or future available_on date
+    # deleted products and products with status different than active
     # are not available
     def available?
-      !(available_on.nil? || available_on.future?) && !deleted? && !discontinued?
+      active? && !deleted?
     end
 
     def discontinue!
-      update_attribute(:discontinue_on, Time.current)
+      self.discontinue_on = Time.current
+      self.status = 'archived'
+      save(validate: false)
     end
 
     def discontinued?
@@ -280,14 +316,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
@@ -296,7 +344,7 @@ module Spree
     def total_on_hand
       @total_on_hand ||= Rails.cache.fetch(['product-total-on-hand', cache_key_with_version]) do
         if any_variants_not_track_inventory?
-          Float::INFINITY
+          BigDecimal::INFINITY
         else
           stock_items.sum(:count_on_hand)
         end
@@ -311,11 +359,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)
@@ -327,17 +380,21 @@ module Spree
     def any_variant_in_stock_or_backorderable?
       if variants.any?
         variants_including_master.in_stock_or_backorderable.exists?
-      else 
+      else
         master.in_stock_or_backorderable?
       end
     end
 
+    def digital?
+      shipping_category&.name == I18n.t('spree.seed.shipping.categories.digital')
+    end
+
     private
 
     def add_associations_from_prototype
       if prototype_id && prototype = Spree::Prototype.find_by(id: prototype_id)
         prototype.properties.each do |property|
-          product_properties.create(property: property)
+          product_properties.create(property: property, value: 'Placeholder')
         end
         self.option_types = prototype.option_types
         self.taxons = prototype.taxons
@@ -385,7 +442,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
@@ -473,8 +534,8 @@ module Spree
       Spree::Taxonomy.where(id: taxonomy_ids).update_all(updated_at: Time.current)
     end
 
-    def ensure_no_line_items
-      if line_items.any?
+    def ensure_not_in_complete_orders
+      if orders.complete.any?
         errors.add(:base, :cannot_destroy_if_attached_to_line_items)
         throw(:abort)
       end
@@ -485,8 +546,8 @@ module Spree
       removed_classifications.each &:remove_from_list
     end
 
-    def discontinue_on_must_be_later_than_available_on
-      if discontinue_on < available_on
+    def discontinue_on_must_be_later_than_make_active_at
+      if discontinue_on < make_active_at
         errors.add(:discontinue_on, :invalid_date_range)
       end
     end
@@ -502,5 +563,17 @@ module Spree
     def downcase_slug
       slug&.downcase!
     end
+
+    def after_activate
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
+    def after_archive
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
+    def after_draft
+      # this method is prepended in api/ to queue Webhooks requests
+    end
   end
 end

data/app/models/spree/product_property.rb

@@ -1,8 +1,14 @@
 module Spree
   class ProductProperty < Spree::Base
     include Spree::FilterParam
+    include 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
 
@@ -13,6 +19,7 @@ module Spree
 
     validates :property, presence: true
     validates :property_id, uniqueness: { scope: :product_id }
+    validates :value, presence: true
 
     default_scope { order(:position) }
 
@@ -30,8 +37,11 @@ module Spree
         `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/rules/option_value.rb

@@ -4,9 +4,9 @@ module Spree
       module OptionValueWithNumerificationSupport
         def preferred_eligible_values
           values = super || {}
-          Hash[values.keys.map(&:to_i).zip(
+          Hash[values.keys.zip(
             values.values.map do |v|
-              (v.is_a?(Array) ? v : v.split(',')).map(&:to_i)
+              (v.is_a?(Array) ? v : v.split(','))
             end
           )]
         end

data/app/models/spree/promotion.rb

@@ -2,6 +2,12 @@ module Spree
   class Promotion < Spree::Base
     include MultiStoreResource
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Promotions)
+      include Spree::Security::Promotions
+    end
 
     MATCH_POLICIES = %w(all any)
     UNACTIVATABLE_ORDER_STATES = ['complete', 'awaiting_return', 'returned']

data/app/models/spree/promotion_rule.rb

@@ -35,7 +35,7 @@ module Spree
 
     def unique_per_promotion
       if Spree::PromotionRule.exists?(promotion_id: promotion_id, type: self.class.name)
-        errors[:base] << 'Promotion already contains this rule type'
+        errors.add(:base, 'Promotion already contains this rule type')
       end
     end
 

data/app/models/spree/promotion_rule_user.rb

@@ -1,7 +1,7 @@
 module Spree
   class PromotionRuleUser < Spree::Base
     belongs_to :promotion_rule, class_name: 'Spree::PromotionRule'
-    belongs_to :user, class_name: Spree.user_class.to_s
+    belongs_to :user, class_name: "::#{Spree.user_class}"
 
     validates :user, :promotion_rule, presence: true
     validates :user_id, uniqueness: { scope: :promotion_rule_id }, allow_nil: true

data/app/models/spree/property.rb

@@ -2,8 +2,17 @@ module Spree
   class Property < Spree::Base
     include Spree::FilterParam
     include Metadata
+    include TranslatableResource
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
+    TRANSLATABLE_FIELDS = %i[name presentation filter_param].freeze
+    translates(*TRANSLATABLE_FIELDS)
 
-    auto_strip_attributes :name, :presentation
+    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,9 @@
 module Spree
   class Prototype < Spree::Base
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'
     has_many :properties, through: :property_prototypes, class_name: 'Spree::Property'

data/app/models/spree/refund.rb

@@ -1,6 +1,12 @@
 module Spree
   class Refund < Spree::Base
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Refunds)
+      include Spree::Security::Refunds
+    end
 
     with_options inverse_of: :refunds do
       belongs_to :payment
@@ -23,6 +29,8 @@ module Spree
 
     scope :non_reimbursement, -> { where(reimbursement_id: nil) }
 
+    attr_reader :response
+
     def money
       Spree::Money.new(amount, currency: payment.currency)
     end

data/app/models/spree/reimbursement.rb

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

data/app/models/spree/return_authorization.rb

@@ -2,6 +2,9 @@ module Spree
   class ReturnAuthorization < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
     include NumberIdentifier
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     belongs_to :order, class_name: 'Spree::Order', inverse_of: :return_authorizations
 

data/app/models/spree/return_item.rb

@@ -2,6 +2,10 @@ module Spree
   class ReturnItem < Spree::Base
     COMPLETED_RECEPTION_STATUSES = %w(received given_to_customer)
 
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     class_attribute :return_eligibility_validator
     self.return_eligibility_validator = ReturnItem::EligibilityValidator::Default
 

data/app/models/spree/role.rb

@@ -3,6 +3,6 @@ module Spree
     include UniqueName
 
     has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
-    has_many :users, through: :role_users, class_name: Spree.user_class.to_s
+    has_many :users, through: :role_users, class_name: "::#{Spree.user_class}"
   end
 end

data/app/models/spree/role_user.rb

@@ -1,6 +1,6 @@
 module Spree
   class RoleUser < Spree::Base
     belongs_to :role, class_name: 'Spree::Role'
-    belongs_to :user, class_name: Spree.user_class.to_s
+    belongs_to :user, class_name: "::#{Spree.user_class}"
   end
 end

data/app/models/spree/shipment.rb

@@ -6,6 +6,12 @@ module Spree
     include NumberIdentifier
     include NumberAsParam
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Shipments)
+      include Spree::Security::Shipments
+    end
 
     with_options inverse_of: :shipments do
       belongs_to :address, class_name: 'Spree::Address'
@@ -243,7 +249,8 @@ module Spree
     end
 
     def selected_shipping_rate_id=(id)
-      shipping_rates.update_all(selected: false)
+      # 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,9 @@
 module Spree
   class ShippingCategory < Spree::Base
     include UniqueName
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     with_options inverse_of: :shipping_category do
       has_many :products

data/app/models/spree/shipping_method.rb

@@ -3,6 +3,12 @@ module Spree
     acts_as_paranoid
     include Spree::CalculatedAdjustments
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
 
     DISPLAY = [:both, :front_end, :back_end]
 

data/app/models/spree/state_change.rb

@@ -1,6 +1,6 @@
 module Spree
   class StateChange < Spree::Base
-    belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+    belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     belongs_to :stateful, polymorphic: true
 
     def <=>(other)

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

@@ -14,9 +14,15 @@ module Spree
         display_name = variant.name.to_s
         display_name += " (#{variant.options_text})" unless variant.options_text.blank?
 
-        line_item.errors.add(:quantity,
-                             :selected_quantity_not_available,
-                             message: Spree.t(:selected_quantity_not_available, item: display_name.inspect))
+        if variant.available?
+          line_item.errors.add(:quantity,
+                               :selected_quantity_not_available,
+                               message: Spree.t(:selected_quantity_not_available, item: display_name.inspect))
+        else
+          line_item.errors.add(:base,
+                               :only_active_products_can_be_added_to_cart,
+                               message: Spree.t(:only_active_products_can_be_added_to_cart))
+        end
       end
 
       private

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

@@ -12,7 +12,7 @@ module Spree
         delegate :line_item,
                  :quantity,
                  :variant, to: :inventory_unit
-        delegate :price, to: :variant
+        delegate :price, to: :line_item
         delegate :dimension,
                  :volume,
                  :weight, to: :variant, prefix: true

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

@@ -12,7 +12,7 @@ module Spree
         @total_on_hand ||= if variant.should_track_inventory?
                              stock_items.sum(:count_on_hand)
                            else
-                             Float::INFINITY
+                             BigDecimal::INFINITY
                            end
       end
 

data/app/models/spree/stock_item.rb

@@ -2,6 +2,11 @@ module Spree
   class StockItem < Spree::Base
     acts_as_paranoid
 
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     with_options inverse_of: :stock_items do
       belongs_to :stock_location, class_name: 'Spree::StockLocation'
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'

data/app/models/spree/stock_location.rb

@@ -1,6 +1,15 @@
 module Spree
   class StockLocation < Spree::Base
     include UniqueName
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::StockLocations)
+      include Spree::Security::StockLocations
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
 
     has_many :shipments
     has_many :stock_items, dependent: :delete_all, inverse_of: :stock_location
@@ -51,9 +60,15 @@ module Spree
     # @param variant Variant instance or Variant ID
     #
     # @return [StockItem] Corresponding StockItem for the StockLocation's variant.
-    def stock_item_or_create(variant)
-      variant_id = variant.is_a?(Spree::Variant) ? variant.id : variant
-      stock_item(variant_id) || stock_items.create(variant_id: variant_id)
+    def stock_item_or_create(variant_or_variant_id)
+      if variant_or_variant_id.is_a?(Spree::Variant)
+        variant_id = variant_or_variant_id.id
+        variant = variant_or_variant_id
+      else
+        variant_id = variant_or_variant_id
+        variant = Spree::Variant.find(variant_or_variant_id)
+      end
+      stock_item(variant_id) || propagate_variant(variant)
     end
 
     def count_on_hand(variant)
@@ -86,8 +101,7 @@ module Spree
     end
 
     def fill_status(variant, quantity)
-      if item = stock_item(variant)
-
+      if item = stock_item_or_create(variant)
         if item.count_on_hand >= quantity
           on_hand = quantity
           backordered = 0

data/app/models/spree/stock_movement.rb

@@ -5,6 +5,10 @@ module Spree
       min: -2**31
     }.freeze
 
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     belongs_to :stock_item, class_name: 'Spree::StockItem', inverse_of: :stock_movements
     belongs_to :originator, polymorphic: true
 

data/app/models/spree/stock_transfer.rb

@@ -4,6 +4,9 @@ module Spree
     include NumberIdentifier
     include NumberAsParam
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     has_many :stock_movements, as: :originator