spree_core 4.2.5 → 4.3.0.rc1

data/app/models/spree/option_value_variant.rb

@@ -1,7 +1,7 @@
 module Spree
   class OptionValueVariant < Spree::Base
     belongs_to :option_value, class_name: 'Spree::OptionValue'
-    belongs_to :variant, class_name: 'Spree::Variant'
+    belongs_to :variant, touch: true, class_name: 'Spree::Variant'
 
     validates :option_value, :variant, presence: true
     validates :option_value_id, uniqueness: { scope: :variant_id }

data/app/models/spree/order.rb

@@ -2,6 +2,7 @@ require_dependency 'spree/order/checkout'
 require_dependency 'spree/order/currency_updater'
 require_dependency 'spree/order/payments'
 require_dependency 'spree/order/store_credit'
+require_dependency 'spree/order/emails'
 
 module Spree
   class Order < Spree::Base
@@ -13,10 +14,15 @@ module Spree
     include Spree::Order::Payments
     include Spree::Order::StoreCredit
     include Spree::Order::AddressBook
+    include Spree::Order::Emails
     include Spree::Core::NumberGenerator.new(prefix: 'R')
     include Spree::Core::TokenGenerator
 
     include NumberAsParam
+    include SingleStoreResource
+    include MemoizedData
+
+    MEMOIZED_METHODS = %w(tax_zone)
 
     extend Spree::DisplayMoney
     money_methods :outstanding_balance, :item_total,           :adjustment_total,
@@ -93,6 +99,7 @@ module Spree
     has_many :reimbursements, inverse_of: :order, class_name: 'Spree::Reimbursement'
     has_many :line_item_adjustments, through: :line_items, source: :adjustments
     has_many :inventory_units, inverse_of: :order, class_name: 'Spree::InventoryUnit'
+    has_many :return_items, through: :inventory_units, class_name: 'Spree::ReturnItem'
     has_many :variants, through: :line_items
     has_many :products, through: :variants
     has_many :refunds, through: :payments
@@ -121,6 +128,8 @@ module Spree
     # Needs to happen before save_permalink is called
     before_validation :ensure_store_presence
     before_validation :ensure_currency_presence
+    before_validation :uppercase_number
+
     before_validation :clone_billing_address, if: :use_billing?
     attr_accessor :use_billing
 
@@ -129,7 +138,9 @@ module Spree
     before_update :homogenize_line_item_currencies, if: :currency_changed?
 
     with_options presence: true do
-      validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true, case_sensitive: false }
+      # we want to have this case_sentive: true as changing it to false causes all SQL to use LOWER(slug)
+      # which is very costly and slow on large set of records
+      validates :number, length: { maximum: 32, allow_blank: true }, uniqueness: { allow_blank: true, case_sensitive: true }
       validates :email, length: { maximum: 254, allow_blank: true }, email: { allow_blank: true }, if: :require_email
       validates :item_count, numericality: { greater_than_or_equal_to: 0, less_than: 2**31, only_integer: true, allow_blank: true }
       validates :store
@@ -158,6 +169,8 @@ module Spree
     scope :complete, -> { where.not(completed_at: nil) }
     scope :incomplete, -> { where(completed_at: nil) }
     scope :not_canceled, -> { where.not(state: 'canceled') }
+    scope :with_deleted_bill_address, -> { joins(:bill_address).where.not(Address.table_name => { deleted_at: nil }) }
+    scope :with_deleted_ship_address, -> { joins(:ship_address).where.not(Address.table_name => { deleted_at: nil }) }
 
     # shows completed orders first, by their completed_at date, then uncompleted orders by their created_at
     scope :reverse_chronological, -> { order(Arel.sql('spree_orders.completed_at IS NULL'), completed_at: :desc, created_at: :desc) }
@@ -326,6 +339,10 @@ module Spree
       complete? || resumed? || awaiting_return? || returned?
     end
 
+    def uneditable?
+      complete? || canceled? || returned?
+    end
+
     def credit_cards
       credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
       CreditCard.where(id: credit_card_ids)
@@ -356,7 +373,6 @@ module Spree
       touch :completed_at
 
       deliver_order_confirmation_email unless confirmation_delivered?
-
       deliver_store_owner_order_notification_email if deliver_store_owner_order_notification_email?
 
       consider_risk
@@ -368,17 +384,16 @@ module Spree
       save!
     end
 
-    def deliver_order_confirmation_email
-      OrderMailer.confirm_email(id).deliver_later
-      update_column(:confirmation_delivered, true)
-    end
-
     # Helper methods for checkout steps
     def paid?
       payment_state == 'paid' || payment_state == 'credit_owed'
     end
 
     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')
+      end
+
       @available_payment_methods ||= collect_payment_methods(store)
     end
 
@@ -410,21 +425,15 @@ module Spree
     end
 
     def empty!
-      if completed?
-        raise Spree.t(:cannot_empty_completed_order)
-      else
-        line_items.destroy_all
-        updater.update_item_count
-        adjustments.destroy_all
-        shipments.destroy_all
-        state_changes.destroy_all
-        order_promotions.destroy_all
+      ActiveSupport::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
 
-        update_totals
-        persist_totals
-        restart_checkout_flow
-        self
-      end
+      raise Spree.t(:cannot_empty_completed_order) if completed?
+
+      result = Spree::Dependencies.cart_empty_service.constantize.call(order: self)
+      result.value
     end
 
     def has_step?(step)
@@ -562,6 +571,10 @@ module Spree
       !approved?
     end
 
+    def can_be_destroyed?
+      !completed? && payments.completed.empty?
+    end
+
     def consider_risk
       considered_risky! if is_risky? && !approved?
     end
@@ -574,11 +587,6 @@ module Spree
       update_column(:considered_risky, false)
     end
 
-    def reload(options = nil)
-      remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
-      super
-    end
-
     def tax_total
       included_tax_total + additional_tax_total
     end
@@ -617,12 +625,12 @@ module Spree
 
     def validate_payments_attributes(attributes)
       # Ensure the payment methods specified are allowed for this user
-      payment_methods = Spree::PaymentMethod.where(id: available_payment_methods.map(&:id))
+      payment_method_ids = available_payment_methods.map(&:id)
+
       attributes.each do |payment_attributes|
-        payment_method_id = payment_attributes[:payment_method_id]
+        payment_method_id = payment_attributes[:payment_method_id].to_i
 
-        # raise RecordNotFound unless it is an allowed payment method
-        payment_methods.find(payment_method_id) if payment_method_id
+        raise ActiveRecord::RecordNotFound unless payment_method_ids.include?(payment_method_id)
       end
     end
 
@@ -693,10 +701,6 @@ module Spree
       update_with_updater!
     end
 
-    def send_cancel_email
-      OrderMailer.cancel_email(id).deliver_later
-    end
-
     def after_resume
       shipments.each(&:resume!)
       consider_risk
@@ -715,23 +719,20 @@ module Spree
     end
 
     def collect_payment_methods(store = nil)
-      PaymentMethod.available_on_front_end.select { |pm| pm.available_for_order?(self) && pm.available_for_store?(store) }
+      if store.present?
+        ActiveSupport::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
+      end
+      store ||= self.store
+
+      store.payment_methods.available_on_front_end.select { |pm| pm.available_for_order?(self) }
     end
 
     def credit_card_nil_payment?(attributes)
       payments.store_credits.present? && attributes[:amount].to_f.zero?
     end
 
-    # Returns true if:
-    #   1. an email address is set for new order notifications AND
-    #   2. no notification for this order has been sent yet.
-    def deliver_store_owner_order_notification_email?
-      store.new_order_notifications_email.present? && !store_owner_notification_delivered?
-    end
-
-    def deliver_store_owner_order_notification_email
-      OrderMailer.store_owner_notification_email(id).deliver_later
-      update_column(:store_owner_notification_delivered, true)
+    def uppercase_number
+      number&.upcase!
     end
   end
 end

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

@@ -2,7 +2,7 @@
 module Spree
   class Order < Spree::Base
     module AddressBook
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 
       def clone_shipping_address
         if ship_address
@@ -22,7 +22,6 @@ module Spree
         address = Spree::Address.find_by(id: id)
         if address && address.user_id == user_id
           self['bill_address_id'] = address.id
-          user.update_attribute(:bill_address_id, address.id)
           bill_address.reload
         else
           self['bill_address_id'] = nil
@@ -31,14 +30,13 @@ module Spree
 
       def bill_address_attributes=(attributes)
         self.bill_address = update_or_create_address(attributes)
-        user.bill_address = bill_address if user
+        user.bill_address = bill_address if user && user.bill_address.nil?
       end
 
       def ship_address_id=(id)
         address = Spree::Address.find_by(id: id)
         if address && address.user_id == user_id
           self['ship_address_id'] = address.id
-          user.update_attribute(:ship_address_id, address.id)
           ship_address.reload
         else
           self['ship_address_id'] = nil
@@ -47,7 +45,7 @@ module Spree
 
       def ship_address_attributes=(attributes)
         self.ship_address = update_or_create_address(attributes)
-        user.ship_address = ship_address if user
+        user.ship_address = ship_address if user && user.ship_address.nil?
       end
 
       private

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

@@ -1,7 +1,7 @@
 module Spree
   class Order < Spree::Base
     module CurrencyUpdater
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 
       included do
         def homogenize_line_item_currencies

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

@@ -0,0 +1,32 @@
+module Spree
+  class Order < Spree::Base
+    module Emails
+      extend ActiveSupport::Concern
+
+      def deliver_order_confirmation_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_order_confirmation_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:confirmation_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      # If you would like to also send confirmation email to store owner(s)
+      def deliver_store_owner_order_notification_email?
+        false
+      end
+
+      def deliver_store_owner_order_notification_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_store_owner_notification_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:store_owner_notification_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      def send_cancel_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_cancel_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Spree
   class Order < Spree::Base
     module Payments
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
       included do
         # processes any pending payments and must return a boolean as it's
         # return value is used by the checkout state_machine to determine

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

@@ -11,7 +11,7 @@ module Spree
       def total_available_store_credit
         return 0.0 unless user
 
-        user.total_available_store_credit
+        user.total_available_store_credit(currency, store)
       end
 
       def could_use_store_credit?

data/app/models/spree/payment.rb

@@ -112,6 +112,13 @@ module Spree
       end
     end
 
+    def source
+      return super if payment_method.nil?
+      return super unless payment_method.source_required?
+
+      payment_method.payment_source_class.unscoped { super }
+    end
+
     def money
       Spree::Money.new(amount, currency: currency)
     end

data/app/models/spree/payment_method.rb

@@ -3,6 +3,8 @@ module Spree
     acts_as_paranoid
     acts_as_list
 
+    include MultiStoreResource
+
     DISPLAY = [:both, :front_end, :back_end].freeze
 
     scope :active,                 -> { where(active: true).order(position: :asc) }
@@ -31,6 +33,8 @@ module Spree
     # e.g. CreditCard in the case of a the Gateway payment type
     # nil means the payment method doesn't require a source e.g. check
     def payment_source_class
+      return unless source_required?
+
       raise ::NotImplementedError, 'You must implement payment_source_class method for this gateway.'
     end
 

data/app/models/spree/preferences/preferable.rb

@@ -58,6 +58,11 @@ module Spree::Preferences::Preferable
     send self.class.preference_default_getter_method(name)
   end
 
+  def preference_deprecated(name)
+    has_preference! name
+    send(self.class.preference_deprecated_getter_method(name))
+  end
+
   def has_preference!(name)
     raise NoMethodError, "#{name} preference not defined" unless has_preference? name
   end
@@ -72,6 +77,13 @@ module Spree::Preferences::Preferable
     end
   end
 
+  def deprecated_preferences
+    defined_preferences.each_with_object([]) do |pref_name, array|
+      deprecated_message = preference_deprecated(pref_name)
+      array << { name: pref_name, message: deprecated_message } unless deprecated_message.nil?
+    end
+  end
+
   def default_preferences
     Hash[
       defined_preferences.map do |preference|

data/app/models/spree/preferences/preferable_class_methods.rb

@@ -2,9 +2,10 @@ module Spree::Preferences
   module PreferableClassMethods
     def preference(name, type, *args)
       options = args.extract_options!
-      options.assert_valid_keys(:default)
+      options.assert_valid_keys(:default, :deprecated)
       default = options[:default]
       default = -> { options[:default] } unless default.is_a?(Proc)
+      deprecated = options[:deprecated]
 
       # cache_key will be nil for new objects, then if we check if there
       # is a pending preference before going to default
@@ -29,6 +30,10 @@ module Spree::Preferences
       define_method preference_type_getter_method(name) do
         type
       end
+
+      define_method preference_deprecated_getter_method(name) do
+        deprecated
+      end
     end
 
     def preference_getter_method(name)
@@ -43,6 +48,10 @@ module Spree::Preferences
       "preferred_#{name}_default".to_sym
     end
 
+    def preference_deprecated_getter_method(name)
+      "preferred_#{name}_deprecated".to_sym
+    end
+
     def preference_type_getter_method(name)
       "preferred_#{name}_type".to_sym
     end

data/app/models/spree/product.rb

@@ -21,7 +21,13 @@
 module Spree
   class Product < Spree::Base
     extend FriendlyId
-    include Spree::ProductScopes
+    include ProductScopes
+    include MultiStoreResource
+    include MemoizedData
+
+    MEMOIZED_METHODS = %w(total_on_hand taxonomy_ids taxon_and_ancestors category
+                          default_variant_id tax_category default_variant
+                          purchasable? in_stock? backorderable?)
 
     friendly_id :slug_candidates, use: :history
 
@@ -36,6 +42,8 @@ module Spree
     has_many :product_properties, dependent: :destroy, inverse_of: :product
     has_many :properties, through: :product_properties
 
+    has_many :menu_items, as: :linked_resource
+
     has_many :classifications, dependent: :delete_all, inverse_of: :product
     has_many :taxons, through: :classifications, before_remove: :remove_taxon
 
@@ -77,6 +85,9 @@ module Spree
     has_many :variant_images, -> { order(:position) }, source: :images, through: :variants_including_master
     has_many :variant_images_without_master, -> { order(:position) }, source: :images, through: :variants
 
+    has_many :store_products, class_name: 'Spree::StoreProduct'
+    has_many :stores, through: :store_products, class_name: 'Spree::Store'
+
     after_create :add_associations_from_prototype
     after_create :build_variants_from_option_values_hash, if: :option_values_hash
 
@@ -90,10 +101,7 @@ module Spree
     after_save :reset_nested_changes
     after_touch :touch_taxons
 
-    # reset cache on save inside trasaction and transaction commit
-    after_save :reset_memoized_data
-    after_commit :reset_memoized_data
-
+    before_validation :downcase_slug
     before_validation :normalize_slug, on: :update
     before_validation :validate_master
 
@@ -107,7 +115,7 @@ module Spree
       validates :price, if: :requires_price?
     end
 
-    validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: false }
+    validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
     validate :discontinue_on_must_be_later_than_available_on, if: -> { available_on && discontinue_on }
 
     attr_accessor :option_values_hash
@@ -122,7 +130,7 @@ module Spree
 
     [
       :sku, :price, :currency, :weight, :height, :width, :depth, :is_master,
-      :cost_currency, :price_in, :amount_in, :cost_price, :compare_at_price
+      :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
     end
@@ -132,13 +140,6 @@ module Spree
 
     alias master_images images
 
-    def reload
-      %w(total_on_hand taxonomy_ids taxon_and_ancestors category category default_variant_id tax_category default_variant).each do |v|
-        instance_variable_set(:"@#{v}", nil)
-      end
-      super
-    end
-
     # Cant use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
     def purchasable?
       variants_including_master.any?(&:purchasable?)
@@ -173,8 +174,8 @@ module Spree
     # @return [Spree::Variant]
     def default_variant
       @default_variant ||= Rails.cache.fetch(default_variant_cache_key) do
-        if Spree::Config[:track_inventory_levels] && variants.in_stock_or_backorderable.any?
-          variants.in_stock_or_backorderable.first
+        if Spree::Config[:track_inventory_levels] && available_variant = variants.detect(&:purchasable?)
+          available_variant
         else
           has_variants? ? variants.first : master
         end
@@ -322,6 +323,12 @@ module Spree
       @category ||= taxons.joins(:taxonomy).order(depth: :desc).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_categories_name) })
     end
 
+    def taxons_for_store(store)
+      Rails.cache.fetch("#{cache_key_with_version}/taxons-per-store/#{store.id}") do
+        taxons.for_store(store)
+      end
+    end
+
     private
 
     def add_associations_from_prototype
@@ -481,12 +488,6 @@ module Spree
       end
     end
 
-    def reset_memoized_data
-      %w(total_on_hand taxonomy_ids taxon_and_ancestors category default_variant_id tax_category default_variant).each do |v|
-        instance_variable_set(:"@#{v}", nil)
-      end
-    end
-
     def requires_price?
       Spree::Config[:require_master_price]
     end
@@ -494,5 +495,9 @@ module Spree
     def requires_shipping_category?
       true
     end
+
+    def downcase_slug
+      slug&.downcase!
+    end
   end
 end