spree_core 4.4.1 → 4.5.0

data/app/models/spree/legacy_user.rb

@@ -8,7 +8,6 @@ module Spree
 
     self.table_name = 'spree_users'
 
-    attr_accessor :password
-    attr_accessor :password_confirmation
+    attr_accessor :password, :password_confirmation
   end
 end

data/app/models/spree/line_item.rb

@@ -1,6 +1,9 @@
 module Spree
   class LineItem < Spree::Base
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     before_validation :ensure_valid_quantity
 
@@ -8,7 +11,7 @@ module Spree
       belongs_to :order, class_name: 'Spree::Order', touch: true
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
     end
-    belongs_to :tax_category, class_name: 'Spree::TaxCategory'
+    belongs_to :tax_category, -> { with_deleted }, class_name: 'Spree::TaxCategory'
 
     has_one :product, through: :variant
 

data/app/models/spree/linkable/homepage.rb

@@ -0,0 +1,3 @@
+module Spree::Linkable::Homepage
+  # Placeholder for polymorphic lookup.
+end

data/app/models/spree/linkable/uri.rb

@@ -0,0 +1,3 @@
+module Spree::Linkable::Uri
+  # Placeholder for polymorphic lookup.
+end

data/app/models/spree/log_entry.rb

@@ -1,5 +1,9 @@
 module Spree
   class LogEntry < Spree::Base
+    if defined?(Spree::Security::LogEntries)
+      include Spree::Security::LogEntries
+    end
+
     belongs_to :source, polymorphic: true
 
     # Fix for #1767

data/app/models/spree/menu.rb

@@ -1,6 +1,9 @@
 module Spree
   class Menu < Spree::Base
     include SingleStoreResource
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     MENU_LOCATIONS = ['Header', 'Footer']
     MENU_LOCATIONS_PARAMETERIZED = []

data/app/models/spree/menu_item.rb

@@ -1,11 +1,16 @@
 module Spree
   class MenuItem < Spree::Base
     include Spree::DisplayLink
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     acts_as_nested_set dependent: :destroy
 
+    ITEM_TYPE = %w[Link Container]
+    LINKED_RESOURCE_TYPE = ['Spree::Linkable::Uri', 'Spree::Linkable::Homepage', 'Spree::Product', 'Spree::Taxon', 'Spree::CmsPage']
+
     belongs_to :menu, touch: true
-    belongs_to :linked_resource, polymorphic: true
 
     before_create :ensure_item_belongs_to_root
     before_update :reset_link_attributes
@@ -14,15 +19,6 @@ module Spree
     after_save :touch_ancestors_and_menu
     after_touch :touch_ancestors_and_menu
 
-    ITEM_TYPE = %w[Link Container]
-
-    LINKED_RESOURCE_TYPE = ['URL']
-    STATIC_RESOURCE_TYPE = ['Home Page']
-    DYNAMIC_RESOURCE_TYPE = ['Spree::Product', 'Spree::Taxon', 'Spree::CmsPage']
-
-    LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
-    LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
-
     validates :name, :menu, presence: true
     validates :item_type, inclusion: { in: ITEM_TYPE }
     validates :linked_resource_type, inclusion: { in: LINKED_RESOURCE_TYPE }
@@ -50,7 +46,7 @@ module Spree
         self.destination = nil
         self.new_window = false
 
-        self.linked_resource_type = 'URL' if item_type == 'Container'
+        self.linked_resource_type = 'Spree::Linkable::Uri' if item_type == 'Container'
       end
     end
 

data/app/models/spree/option_type.rb

@@ -2,8 +2,12 @@ module Spree
   class OptionType < Spree::Base
     include UniqueName
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     acts_as_list
+    auto_strip_attributes :name, :presentation
 
     with_options dependent: :destroy, inverse_of: :option_type do
       has_many :option_values, -> { order(:position) }

data/app/models/spree/option_value.rb

@@ -1,9 +1,14 @@
 module Spree
   class OptionValue < Spree::Base
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_values
+
     acts_as_list scope: :option_type
+    auto_strip_attributes :name, :presentation
 
     has_many :option_value_variants, class_name: 'Spree::OptionValueVariant'
     has_many :variants, through: :option_value_variants, class_name: 'Spree::Variant'

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

@@ -54,6 +54,7 @@ module Spree
         return if attributes.blank?
 
         attributes.transform_values! { |v| v == '' ? nil : v }
+        attributes = attributes.to_h.symbolize_keys
 
         default_address_scope = user ? user.addresses : ::Spree::Address
         default_address = default_address_scope.find_by(id: attributes[:id])

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

@@ -1,14 +1,6 @@
 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

@@ -25,6 +25,15 @@ module Spree
     include SingleStoreResource
     include MemoizedData
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Orders)
+      include Spree::Security::Orders
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
 
     MEMOIZED_METHODS = %w(tax_zone)
 
@@ -77,7 +86,7 @@ module Spree
     attribute :state_machine_resumed, :boolean
 
     if Spree.user_class
-      belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+      belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     else
       belongs_to :user, optional: true
     end
@@ -146,7 +155,7 @@ module Spree
 
     before_create :create_token
     before_create :link_by_email
-    before_update :homogenize_line_item_currencies, if: :currency_changed?
+    before_update :ensure_updated_shipments, :homogenize_line_item_currencies, if: :currency_changed?
 
     with_options presence: true do
       # we want to have this case_sentive: true as changing it to false causes all SQL to use LOWER(slug)

data/app/models/spree/order_merger.rb

@@ -54,7 +54,7 @@ module Spree
 
     # Change the error messages as you choose.
     def handle_error(line_item)
-      order.errors[:base] << line_item.errors.full_messages
+      order.errors.add(:base, line_item.errors.full_messages)
     end
 
     def persist_merge

data/app/models/spree/payment/processing.rb

@@ -72,7 +72,7 @@ module Spree
       end
 
       def cancel!
-        response = payment_method.cancel(response_code)
+        response = payment_method.cancel(response_code, self)
         handle_response(response, :void, :failure)
       end
 

data/app/models/spree/payment.rb

@@ -6,12 +6,18 @@ module Spree
     include NumberIdentifier
     include NumberAsParam
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Payments)
+      include Spree::Security::Payments
+    end
 
     include Spree::Payment::Processing
 
     NON_RISKY_AVS_CODES = ['B', 'D', 'H', 'J', 'M', 'Q', 'T', 'V', 'X', 'Y'].freeze
     RISKY_AVS_CODES     = ['A', 'C', 'E', 'F', 'G', 'I', 'K', 'L', 'N', 'O', 'P', 'R', 'S', 'U', 'W', 'Z'].freeze
-    INVALID_STATES      = %w(failed invalid).freeze
+    INVALID_STATES      = %w(failed invalid void).freeze
 
     with_options inverse_of: :payments do
       belongs_to :order, class_name: 'Spree::Order', touch: true

data/app/models/spree/payment_capture_event.rb

@@ -1,5 +1,9 @@
 module Spree
   class PaymentCaptureEvent < Spree::Base
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     belongs_to :payment, class_name: 'Spree::Payment'
 
     def display_amount

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

@@ -74,7 +74,7 @@ module Spree
       handle_action(action, :credit, auth_code)
     end
 
-    def cancel(auth_code)
+    def cancel(auth_code, _payment = nil)
       store_credit_event = StoreCreditEvent.find_by(authorization_code: auth_code,
                                                     action: Spree::StoreCredit::CAPTURE_ACTION)
       store_credit = store_credit_event.try(:store_credit)

data/app/models/spree/payment_method.rb

@@ -5,6 +5,9 @@ module Spree
 
     include MultiStoreResource
     include Spree::Metadata
+    if defined?(Spree::Security::PaymentMethods)
+      include Spree::Security::PaymentMethods
+    end
 
     DISPLAY = [:both, :front_end, :back_end].freeze
 

data/app/models/spree/payment_source.rb

@@ -0,0 +1,10 @@
+module Spree
+  class PaymentSource < Spree::Base
+    include Metadata
+
+    belongs_to :payment_method, class_name: 'Spree::PaymentMethod'
+    belongs_to :user, class_name: 'Spree::User', optional: true
+
+    validates_uniqueness_of :gateway_payment_profile_id, scope: :type
+  end
+end

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

@@ -25,6 +25,12 @@ module Spree
     include MultiStoreResource
     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
                           default_variant_id tax_category default_variant
@@ -33,10 +39,11 @@ module Spree
     friendly_id :slug_candidates, use: :history
 
     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 +125,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 +136,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 +151,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 +249,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?
@@ -296,7 +322,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
@@ -327,17 +353,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
@@ -473,8 +503,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 +515,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 +532,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

@@ -13,6 +13,7 @@ module Spree
 
     validates :property, presence: true
     validates :property_id, uniqueness: { scope: :product_id }
+    validates :value, presence: true
 
     default_scope { order(:position) }
 

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,6 +2,9 @@ module Spree
   class Property < Spree::Base
     include Spree::FilterParam
     include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     auto_strip_attributes :name, :presentation
 

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'
@@ -244,6 +250,7 @@ module Spree
 
     def selected_shipping_rate_id=(id)
       shipping_rates.update_all(selected: false)
+      shipping_rates.touch_all # Bust cache dependent on "updated_at" timestamp
       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]