spree_core 4.3.0 → 4.5.1

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

@@ -4,6 +4,10 @@ module Spree
     acts_as_list
 
     include MultiStoreResource
+    include Spree::Metadata
+    if defined?(Spree::Security::PaymentMethods)
+      include Spree::Security::PaymentMethods
+    end
 
     DISPLAY = [:both, :front_end, :back_end].freeze
 
@@ -14,7 +18,8 @@ module Spree
 
     validates :name, presence: true
 
-    has_and_belongs_to_many :stores
+    has_many :store_payment_methods, class_name: 'Spree::StorePaymentMethod'
+    has_many :stores, class_name: 'Spree::Store', through: :store_payment_methods
 
     with_options dependent: :restrict_with_error do
       has_many :payments, class_name: 'Spree::Payment', inverse_of: :payment_method

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

@@ -1,5 +1,10 @@
 class Spree::Preference < Spree::Base
   serialize :value
 
-  validates :key, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
+  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
 
@@ -66,7 +69,7 @@ module Spree
     private
 
     def ensure_currency
-      self.currency ||= Spree::Config[:currency]
+      self.currency ||= Spree::Store.default.default_currency
     end
   end
 end

data/app/models/spree/product.rb

@@ -24,6 +24,13 @@ module Spree
     include ProductScopes
     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
@@ -32,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
@@ -87,6 +95,7 @@ module Spree
 
     has_many :store_products, class_name: 'Spree::StoreProduct'
     has_many :stores, through: :store_products, class_name: 'Spree::Store'
+    has_many :digitals, through: :variants_including_master
 
     after_create :add_associations_from_prototype
     after_create :build_variants_from_option_values_hash, if: :option_values_hash
@@ -115,8 +124,10 @@ module Spree
       validates :price, if: :requires_price?
     end
 
-    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 }
+    validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true, scope: spree_base_uniqueness_scope }
+    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 }) }
 
     attr_accessor :option_values_hash
 
@@ -125,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_scopes = %w[not_discontinued search_by_name]
+    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
@@ -140,17 +151,34 @@ module Spree
 
     alias master_images images
 
-    # Cant use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
+    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?)
     end
 
-    # Cant use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
+    # Can't use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
     def in_stock?
       default_variant.in_stock? || variants.any?(&:in_stock?)
     end
 
-    # Cant use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
+    # Can't use short form block syntax due to https://github.com/Netflix/fast_jsonapi/issues/259
     def backorderable?
       default_variant.backorderable? || variants.any?(&:backorderable?)
     end
@@ -193,10 +221,7 @@ module Spree
     end
 
     # Adding properties and option types on creation based on a chosen prototype
-    attr_reader :prototype_id
-    def prototype_id=(value)
-      @prototype_id = value.to_i
-    end
+    attr_accessor :prototype_id
 
     # Ensures option_types and product_option_types exist for keys in option_values_hash
     def ensure_option_types_exist_for_values_hash
@@ -224,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?
@@ -263,14 +290,6 @@ module Spree
       where conditions.inject(:or)
     end
 
-    def self.search_by_name(query)
-      if defined?(SpreeGlobalize)
-        joins(:translations).order(:name).where("LOWER(#{Product::Translation.table_name}.name) LIKE LOWER(:query)", query: "%#{query}%").distinct
-      else
-        where("LOWER(#{Product.table_name}.name) LIKE LOWER(:query)", query: "%#{query}%")
-      end
-    end
-
     # Suitable for displaying only variants that has at least one option value.
     # There may be scenarios where an option type is removed and along with it
     # all option values. At that point all variants associated with only those
@@ -303,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
@@ -331,12 +350,24 @@ module Spree
       end
     end
 
+    def any_variant_in_stock_or_backorderable?
+      if variants.any?
+        variants_including_master.in_stock_or_backorderable.exists?
+      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
@@ -472,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
@@ -484,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
@@ -501,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/rules/product.rb

@@ -1,6 +1,6 @@
 # A rule to limit a promotion based on products in the order.
 # Can require all or any of the products to be present.
-# Valid products either come from assigned product group or are assingned directly to the rule.
+# Valid products either come from assigned product group or are assigned directly to the rule.
 module Spree
   class Promotion
     module Rules

data/app/models/spree/promotion.rb

@@ -1,6 +1,13 @@
 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']
@@ -18,7 +25,8 @@ module Spree
     has_many :order_promotions, class_name: 'Spree::OrderPromotion'
     has_many :orders, through: :order_promotions, class_name: 'Spree::Order'
 
-    has_and_belongs_to_many :stores, class_name: 'Spree::Store', join_table: 'spree_promotions_stores'
+    has_many :store_promotions, class_name: 'Spree::StorePromotion'
+    has_many :stores, class_name: 'Spree::Store', through: :store_promotions
 
     accepts_nested_attributes_for :promotion_actions, :promotion_rules
 

data/app/models/spree/promotion_action.rb

@@ -8,7 +8,7 @@ module Spree
 
     scope :of_type, ->(t) { where(type: t) }
 
-    # This method should be overriden in subclass
+    # This method should be overridden in subclass
     # Updates the state of the order or performs some other action depending on the subclass
     # options will contain the payload from the event that activated the promotion. This will include
     # the key :user which allows user based actions to be performed in addition to actions on the order

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

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

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
 

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.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
 
@@ -216,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).
@@ -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
@@ -303,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

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

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)