spree_core 4.0.0 → 4.5.1

data/app/models/spree/promotion_handler/cart.rb

@@ -13,12 +13,13 @@ module Spree
     # the promotions system accurate and performant. Here they can plug custom
     # handler to activate promos as they wish once an item is added to cart
     class Cart
-      attr_reader :line_item, :order
+      attr_reader :line_item, :order, :store
       attr_accessor :error, :success
 
       def initialize(order, line_item = nil)
         @order = order
         @line_item = line_item
+        @store = order.store
       end
 
       def activate
@@ -34,7 +35,11 @@ module Spree
       private
 
       def promotions
-        Promotion.find_by_sql("#{order.promotions.active.to_sql} UNION #{Promotion.active.where(code: nil, path: nil).to_sql}")
+        promotion_scope.find_by_sql("#{order.promotions.active.to_sql} UNION #{promotion_scope.active.where(code: nil, path: nil).to_sql}")
+      end
+
+      def promotion_scope
+        ::Spree::Promotion.for_store(store)
       end
     end
   end

data/app/models/spree/promotion_handler/coupon.rb

@@ -1,18 +1,19 @@
 module Spree
   module PromotionHandler
     class Coupon
-      attr_reader :order
+      attr_reader :order, :store
       attr_accessor :error, :success, :status_code
 
       def initialize(order)
         @order = order
+        @store = order.store
       end
 
       def apply
         if order.coupon_code.present?
           if promotion.present? && promotion.actions.exists?
             handle_present_promotion
-          elsif Promotion.with_coupon_code(order.coupon_code).try(:expired?)
+          elsif store.promotions.with_coupon_code(order.coupon_code).try(:expired?)
             set_error_code :coupon_code_expired
           else
             set_error_code :coupon_code_not_found
@@ -25,10 +26,9 @@ module Spree
 
       def remove(coupon_code)
         promotion = order.promotions.with_coupon_code(coupon_code)
-
         if promotion.present?
           # Order promotion has to be destroyed before line item removing
-          order.order_promotions.find_by!(promotion_id: promotion.id).destroy
+          order.order_promotions.where(promotion_id: promotion.id).destroy_all
 
           remove_promotion_adjustments(promotion)
           remove_promotion_line_items(promotion)
@@ -52,7 +52,7 @@ module Spree
       end
 
       def promotion
-        @promotion ||= Promotion.active.includes(
+        @promotion ||= store.promotions.active.includes(
           :promotion_rules, :promotion_actions
         ).with_coupon_code(order.coupon_code)
       end
@@ -76,7 +76,7 @@ module Spree
           line_item = order.find_line_item_by_variant(item.variant)
           next if line_item.blank?
 
-          Spree::Dependencies.cart_remove_item_service(order: order, item: item.variant, quantity: item.quantity)
+          Spree::Dependencies.cart_remove_item_service.constantize.call(order: order, variant: item.variant, quantity: item.quantity)
         end
       end
 

data/app/models/spree/promotion_handler/free_shipping.rb

@@ -2,12 +2,13 @@ module Spree
   module PromotionHandler
     # Used for activating promotions with shipping rules
     class FreeShipping
-      attr_reader :order, :order_promo_ids
+      attr_reader :order, :order_promo_ids, :store
       attr_accessor :error, :success
 
       def initialize(order)
         @order = order
-        @order_promo_ids = order.promotions.pluck(:id)
+        @store = order.store
+        @order_promo_ids = order.promotions.ids
       end
 
       def activate
@@ -21,10 +22,8 @@ module Spree
       private
 
       def promotions
-        Spree::Promotion.active.where(
-          id: Spree::Promotion::Actions::FreeShipping.pluck(:promotion_id),
-          path: nil
-        )
+        store.promotions.active.joins(:promotion_actions).
+          where(Spree::PromotionAction.table_name => { type: 'Spree::Promotion::Actions::FreeShipping' }, path: nil).distinct
       end
     end
   end

data/app/models/spree/promotion_handler/page.rb

@@ -1,10 +1,11 @@
 module Spree
   module PromotionHandler
     class Page
-      attr_reader :order, :path
+      attr_reader :order, :path, :store
 
       def initialize(order, path)
         @order = order
+        @store = order.store
         @path = path.gsub(/\A\//, '')
       end
 
@@ -17,7 +18,7 @@ module Spree
       private
 
       def promotion
-        @promotion ||= Promotion.active.find_by(path: path)
+        @promotion ||= store.promotions.active.find_by(path: path)
       end
     end
   end

data/app/models/spree/promotion_handler/promotion_duplicator.rb

@@ -1,15 +1,17 @@
 module Spree
   module PromotionHandler
     class PromotionDuplicator
-      def initialize(promotion)
+      def initialize(promotion, random_string: nil)
         @promotion = promotion
+        @random_string = random_string || generate_random_string(4)
       end
 
       def duplicate
         @new_promotion = @promotion.dup
-        @new_promotion.path = "#{@promotion.path}_new"
+        @new_promotion.path = "#{@promotion.path}_#{@random_string}"
         @new_promotion.name = "New #{@promotion.name}"
-        @new_promotion.code = "#{@promotion.code}_new"
+        @new_promotion.code = "#{@promotion.code}_#{@random_string}"
+        @new_promotion.stores = @promotion.stores
 
         ActiveRecord::Base.transaction do
           @new_promotion.save
@@ -33,6 +35,11 @@ module Spree
         end
       end
 
+      def generate_random_string(number)
+        charset = Array('A'..'Z') + Array('a'..'z')
+        Array.new(number) { charset.sample }.join
+      end
+
       def copy_actions
         @promotion.promotion_actions.each do |action|
           new_action = action.dup

data/app/models/spree/promotion_rule.rb

@@ -3,6 +3,8 @@ module Spree
   class PromotionRule < Spree::Base
     belongs_to :promotion, class_name: 'Spree::Promotion', inverse_of: :promotion_rules
 
+    delegate :stores, to: :promotion
+
     scope :of_type, ->(t) { where(type: t) }
 
     validate :unique_per_promotion, on: :create
@@ -33,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

@@ -1,5 +1,13 @@
 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
+
     has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'
     has_many :prototypes, through: :property_prototypes, class_name: 'Spree::Prototype'
 
@@ -9,15 +17,38 @@ module Spree
     validates :name, :presentation, presence: true
 
     scope :sorted, -> { order(:name) }
+    scope :filterable, -> { where(filterable: true) }
 
     after_touch :touch_all_products
+    after_save :ensure_product_properties_have_filter_params
 
-    self.whitelisted_ransackable_attributes = ['presentation']
+    self.whitelisted_ransackable_attributes = ['presentation', 'filterable']
+
+    def uniq_values(product_properties_scope: nil)
+      with_uniq_values_cache_key(product_properties_scope) do
+        properties = product_properties
+        properties = properties.where(id: product_properties_scope) if product_properties_scope.present?
+        properties.where.not(value: [nil, '']).pluck(:filter_param, :value).uniq
+      end
+    end
 
     private
 
     def touch_all_products
       products.update_all(updated_at: Time.current)
     end
+
+    def with_uniq_values_cache_key(product_properties_scope, &block)
+      return block.call if product_properties_scope.present?
+
+      uniq_values_cache_key = ['property-uniq-values', cache_key_with_version]
+      Rails.cache.fetch(uniq_values_cache_key) { block.call }
+    end
+
+    def ensure_product_properties_have_filter_params
+      return unless filterable?
+
+      product_properties.where(filter_param: [nil, '']).where.not(value: [nil, '']).find_each(&:save)
+    end
   end
 end

data/app/models/spree/prototype.rb

@@ -1,5 +1,10 @@
 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,5 +1,13 @@
 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
       belongs_to :reimbursement, optional: true
@@ -21,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
@@ -61,14 +71,14 @@ module Spree
                  end
 
       unless response.success?
-        logger.error(Spree.t(:gateway_error) + "  #{response.to_yaml}")
+        Rails.logger.error(Spree.t(:gateway_error) + "  #{response.to_yaml}")
         text = response.params['message'] || response.params['response_reason_text'] || response.message
         raise Core::GatewayError, text
       end
 
       response
     rescue ActiveMerchant::ConnectionError => e
-      logger.error(Spree.t(:gateway_error) + "  #{e.inspect}")
+      Rails.logger.error(Spree.t(:gateway_error) + "  #{e.inspect}")
       raise Core::GatewayError, Spree.t(:unable_to_connect_to_gateway)
     end
 

data/app/models/spree/reimbursement.rb

@@ -1,6 +1,10 @@
 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
 
@@ -15,7 +19,6 @@ module Spree
       has_many :return_items
     end
 
-    validates :number, uniqueness: true
     validates :order, presence: true
     validate :validate_return_items_belong_to_same_order
 
@@ -60,6 +63,8 @@ module Spree
     class_attribute :reimbursement_failure_hooks
     self.reimbursement_failure_hooks = []
 
+    delegate :store, :currency, to: :order
+
     state_machine :reimbursement_status, initial: :pending do
       event :errored do
         transition to: :errored, from: :pending
@@ -137,7 +142,9 @@ module Spree
     end
 
     def send_reimbursement_email
-      Spree::ReimbursementMailer.reimbursement_email(id).deliver_later
+      # you can overwrite this method in your application / extension to send out the confirmation email
+      # or use `spree_emails` gem
+      # YourEmailVendor.deliver_reimbursement_email(id) # `id` = ID of the Reimbursement being sent, you can also pass the entire object using `self`
     end
 
     # If there are multiple different reimbursement types for a single

data/app/models/spree/reimbursement_type/reimbursement_helpers.rb

@@ -51,7 +51,8 @@ module Spree
         category: category,
         created_by: Spree::StoreCredit.default_created_by,
         memo: "Refund for uncreditable payments on order #{reimbursement.order.number}",
-        currency: reimbursement.order.currency
+        currency: reimbursement.order.currency,
+        store: reimbursement.order.store
       }
     end
 

data/app/models/spree/return_authorization.rb

@@ -1,6 +1,10 @@
 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
 
@@ -17,7 +21,6 @@ module Spree
 
     accepts_nested_attributes_for :return_items, allow_destroy: true
 
-    validates :number, uniqueness: true
     validates :order, :reason, :stock_location, presence: true
     validate :must_have_shipped_units, on: :create
 
@@ -38,13 +41,15 @@ module Spree
     money_methods :pre_tax_total
 
     self.whitelisted_ransackable_attributes = ['memo', 'number', 'state']
+    self.whitelisted_ransackable_associations = ['order']
 
     def pre_tax_total
       return_items.sum(:pre_tax_amount)
     end
 
     def currency
-      order.nil? ? Spree::Config[:currency] : order.currency
+      # FIXME: we should associate ReturnAuthorization with Store
+      order.nil? ? Spree::Store.default.default_currency : order.currency
     end
 
     def refundable_amount

data/app/models/spree/return_item/eligibility_validator/base_validator.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Spree::ReturnItem::EligibilityValidator::BaseValidator
+  class ReturnItem::EligibilityValidator::BaseValidator
     attr_reader :errors
 
     def initialize(return_item)

data/app/models/spree/return_item/eligibility_validator/default.rb

@@ -1,5 +1,3 @@
-require_relative 'r_m_a_required'
-
 module Spree
   class ReturnItem::EligibilityValidator::Default < Spree::ReturnItem::EligibilityValidator::BaseValidator
     class_attribute :permitted_eligibility_validators

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
 
@@ -165,7 +169,7 @@ module Spree
     end
 
     def currency
-      return_authorization.try(:currency) || Spree::Config[:currency]
+      return_authorization.try(:currency) || Spree::Store.default.default_currency
     end
 
     private

data/app/models/spree/role.rb

@@ -1,8 +1,8 @@
 module Spree
   class Role < Spree::Base
-    has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
-    has_many :users, through: :role_users, class_name: Spree.user_class.to_s
+    include UniqueName
 
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
+    has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
+    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

@@ -3,8 +3,15 @@ require 'ostruct'
 module Spree
   class Shipment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
-
+    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'
@@ -26,7 +33,6 @@ module Spree
     before_validation :set_cost_zero_when_nil
 
     validates :stock_location, presence: true
-    validates :number, uniqueness: { case_sensitive: true }
 
     attr_accessor :special_instructions
 
@@ -40,6 +46,9 @@ module Spree
     scope :with_state, ->(*s) { where(state: s) }
     # sort by most recent shipped_at, falling back to created_at. add "id desc" to make specs that involve this scope more deterministic.
     scope :reverse_chronological, -> { order(Arel.sql('coalesce(spree_shipments.shipped_at, spree_shipments.created_at) desc'), id: :desc) }
+    scope :valid, -> { where.not(state: :canceled) }
+
+    delegate :store, :currency, to: :order
 
     # shipment state machine (see http://github.com/pluginaweek/state_machine/tree/master for details)
     state_machine initial: :pending, use_transactions: false do
@@ -103,11 +112,6 @@ module Spree
       inventory_units.any?(&:backordered?)
     end
 
-    # TODO: delegate currency to Order, order.currency is mandatory
-    def currency
-      order ? order.currency : Spree::Config[:currency]
-    end
-
     # Determines the appropriate +state+ according to the following logic:
     #
     # pending    unless order is complete and +order.payment_state+ is +paid+
@@ -218,7 +222,7 @@ module Spree
       return shipping_rates if shipped?
       return [] unless can_get_rates?
 
-      # StockEstimator.new assigment below will replace the current shipping_method
+      # StockEstimator.new assignment below will replace the current shipping_method
       original_shipping_method_id = shipping_method.try(:id)
 
       self.shipping_rates = Stock::Estimator.new(order).
@@ -246,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
@@ -305,34 +310,8 @@ module Spree
       end
     end
 
-    # Update Shipment and make sure Order states follow the shipment changes
     def update_attributes_and_order(params = {})
-      if update params
-        if params.key? :selected_shipping_rate_id
-          # Changing the selected Shipping Rate won't update the cost (for now)
-          # so we persist the Shipment#cost before calculating order shipment
-          # total and updating payment state (given a change in shipment cost
-          # might change the Order#payment_state)
-          update_amounts
-
-          order.updater.update_shipment_total
-          order.updater.update_payment_state
-
-          # Update shipment state only after order total is updated because it
-          # (via Order#paid?) affects the shipment state (YAY)
-          update_columns(
-            state: determine_state(order),
-            updated_at: Time.current
-          )
-
-          # And then it's time to update shipment states and finally persist
-          # order changes
-          order.updater.update_shipment_state
-          order.updater.persist_totals
-        end
-
-        true
-      end
+      Shipments::Update.call(shipment: self, shipment_attributes: params).success?
     end
 
     # Updates various aspects of the Shipment while bypassing any callbacks.  Note that this method takes an explicit reference to the
@@ -364,7 +343,7 @@ module Spree
         desired_shipment: shipment_to_transfer_to,
         variant: variant,
         quantity: quantity
-      ).run!
+      )
     end
 
     private

data/app/models/spree/shipment_handler.rb

@@ -25,10 +25,12 @@ module Spree
       send_shipped_email
     end
 
-    private
+    protected
 
     def send_shipped_email
-      ShipmentMailer.shipped_email(@shipment.id).deliver_later
+      # you can overwrite this method in your application / extension to send out the confirmation email
+      # or use `spree_emails` gem
+      # YourEmailVendor.deliver_shipment_notification_email(@shipment.id)
     end
 
     def update_order_shipment_state

data/app/models/spree/shipping_category.rb

@@ -1,6 +1,9 @@
 module Spree
   class ShippingCategory < Spree::Base
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
+    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

@@ -2,6 +2,14 @@ module Spree
   class ShippingMethod < Spree::Base
     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]
 
     # Used for #refresh_rates
@@ -19,7 +27,7 @@ module Spree
                                      foreign_key: 'shipping_method_id'
     has_many :zones, through: :shipping_method_zones, class_name: 'Spree::Zone'
 
-    belongs_to :tax_category, class_name: 'Spree::TaxCategory', optional: true
+    belongs_to :tax_category, -> { with_deleted }, class_name: 'Spree::TaxCategory', optional: true
 
     validates :name, :display_on, presence: true
 
@@ -44,10 +52,6 @@ module Spree
         select { |c| c.to_s.constantize < Spree::ShippingCalculator }
     end
 
-    def tax_category
-      Spree::TaxCategory.unscoped { super }
-    end
-
     def available_to_display?(display_filter)
       (frontend? && display_filter == DISPLAY_ON_FRONT_END) ||
         (backend? && display_filter == DISPLAY_ON_BACK_END)

data/app/models/spree/shipping_rate.rb

@@ -1,9 +1,8 @@
 module Spree
   class ShippingRate < Spree::Base
     belongs_to :shipment, class_name: 'Spree::Shipment'
-    belongs_to :tax_rate, class_name: 'Spree::TaxRate'
-    belongs_to :shipping_method, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
-
+    belongs_to :tax_rate, -> { with_deleted }, class_name: 'Spree::TaxRate'
+    belongs_to :shipping_method, -> { with_deleted }, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
     extend Spree::DisplayMoney
 
     money_methods :base_price, :final_price, :tax_amount
@@ -32,14 +31,6 @@ module Spree
       @tax_amount ||= tax_rate&.calculator&.compute_shipping_rate(self) || BigDecimal(0)
     end
 
-    def shipping_method
-      Spree::ShippingMethod.unscoped { super }
-    end
-
-    def tax_rate
-      Spree::TaxRate.unscoped { super }
-    end
-
     # returns base price - any available discounts for this Shipment
     # useful when you want to present a list of available shipping rates
     def final_price

data/app/models/spree/state.rb

@@ -14,7 +14,7 @@ module Spree
     validates :country, :name, presence: true
     validates :name, :abbr, uniqueness: { case_sensitive: false, scope: :country_id }, allow_blank: true
 
-    self.whitelisted_ransackable_attributes = %w(abbr)
+    self.whitelisted_ransackable_attributes = %w(abbr country_id name)
 
     def self.find_all_by_name_or_abbr(name_or_abbr)
       where('name = ? OR abbr = ?', name_or_abbr, name_or_abbr)

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)