spree_core 4.3.3 → 4.4.0.rc1

data/app/models/spree/payment.rb

@@ -3,11 +3,12 @@ require_dependency 'spree/payment/processing'
 module Spree
   class Payment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'P', letters: true, length: 7)
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
 
     include Spree::Payment::Processing
 
-    include NumberAsParam
-
     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
@@ -25,8 +26,8 @@ module Spree
     has_many :refunds, inverse_of: :payment
 
     validates :payment_method, presence: true
-    validates :number, uniqueness: { case_sensitive: true }
     validates :source, presence: true, if: -> { payment_method&.source_required? }
+    validate :payment_method_available_for_order, on: :create
 
     before_validation :validate_source
 
@@ -66,6 +67,9 @@ module Spree
     scope :store_credits, -> { where(source_type: Spree::StoreCredit.to_s) }
     scope :not_store_credits, -> { where(arel_table[:source_type].not_eq(Spree::StoreCredit.to_s).or(arel_table[:source_type].eq(nil))) }
 
+    self.whitelisted_ransackable_associations = %w[payment_method order source]
+    self.whitelisted_ransackable_attributes = %w[number amount state response_code avs_response cvv_response_code cvv_response_message]
+
     # transaction_id is much easier to understand
     def transaction_id
       response_code
@@ -95,10 +99,12 @@ module Spree
       event :complete do
         transition from: [:processing, :pending, :checkout], to: :completed
       end
+      after_transition to: :completed, do: :after_completed
       event :void do
         transition from: [:pending, :processing, :completed, :checkout], to: :void
       end
-      # when the card brand isnt supported
+      after_transition to: :void, do: :after_void
+      # when the card brand isn't supported
       event :invalidate do
         transition from: [:checkout], to: :invalid
       end
@@ -196,6 +202,14 @@ module Spree
 
     private
 
+    def after_void
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
+    def after_completed
+      # this method is prepended in api/ to queue Webhooks requests
+    end
+
     def has_invalid_state?
       INVALID_STATES.include?(state)
     end
@@ -219,6 +233,13 @@ module Spree
       !errors.present?
     end
 
+    def payment_method_available_for_order
+      return if payment_method.blank?
+      return if order.blank?
+
+      errors.add(:payment_method, :invalid) if !payment_method.available_for_order?(order) || !payment_method.available_for_store?(order.store)
+    end
+
     def add_source_error(field, message)
       field_name = I18n.t("activerecord.attributes.#{source.class.to_s.underscore}.#{field}")
       errors.add(Spree.t(source.class.to_s.demodulize.underscore), "#{field_name} #{message}")

data/app/models/spree/payment_method.rb

@@ -4,6 +4,7 @@ module Spree
     acts_as_list
 
     include MultiStoreResource
+    include Spree::Metadata
 
     DISPLAY = [:both, :front_end, :back_end].freeze
 
@@ -14,7 +15,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/preference.rb

@@ -1,5 +1,6 @@
 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 }
 end

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

@@ -1,5 +1,5 @@
-# This takes the preferrable methods and adds some
-# syntatic sugar to access the preferences
+# This takes the preferable methods and adds some
+# syntactic sugar to access the preferences
 #
 # class App < Configuration
 #   preference :color, :string

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

@@ -36,7 +36,7 @@ module Spree::Preferences
 
     def get(key)
       # return the retrieved value, if it's in the cache
-      # use unless nil? incase the value is actually boolean false
+      # use unless nil? in case the value is actually boolean false
       #
       unless (val = @cache.read(key)).nil?
         return val

data/app/models/spree/price.rb

@@ -66,7 +66,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,7 @@ module Spree
     include ProductScopes
     include MultiStoreResource
     include MemoizedData
+    include Metadata
 
     MEMOIZED_METHODS = %w(total_on_hand taxonomy_ids taxon_and_ancestors category
                           default_variant_id tax_category default_variant
@@ -87,6 +88,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,9 +117,11 @@ module Spree
       validates :price, if: :requires_price?
     end
 
-    validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
+    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 }
 
+    scope :for_store, ->(store) { joins(:store_products).where(StoreProduct.table_name => { store_id: store.id }) }
+
     attr_accessor :option_values_hash
 
     accepts_nested_attributes_for :product_properties, allow_destroy: true, reject_if: ->(pp) { pp[:property_name].blank? }
@@ -126,7 +130,7 @@ module Spree
 
     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_scopes = %w[not_discontinued search_by_name in_taxon price_between]
 
     [
       :sku, :price, :currency, :weight, :height, :width, :depth, :is_master,
@@ -140,17 +144,17 @@ module Spree
 
     alias master_images images
 
-    # 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 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 +197,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
@@ -263,14 +264,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
@@ -331,6 +324,14 @@ 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
+
     private
 
     def add_associations_from_prototype

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,7 @@
 module Spree
   class Promotion < Spree::Base
     include MultiStoreResource
+    include Metadata
 
     MATCH_POLICIES = %w(all any)
     UNACTIVATABLE_ORDER_STATES = ['complete', 'awaiting_return', 'returned']
@@ -18,7 +19,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/property.rb

@@ -1,6 +1,7 @@
 module Spree
   class Property < Spree::Base
     include Spree::FilterParam
+    include Metadata
 
     auto_strip_attributes :name, :presentation
 

data/app/models/spree/prototype.rb

@@ -1,5 +1,7 @@
 module Spree
   class Prototype < Spree::Base
+    include Metadata
+
     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,7 @@
 module Spree
   class Refund < Spree::Base
+    include Metadata
+
     with_options inverse_of: :refunds do
       belongs_to :payment
       belongs_to :reimbursement, optional: true

data/app/models/spree/reimbursement.rb

@@ -1,6 +1,7 @@
 module Spree
   class Reimbursement < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RI', length: 9)
+    include NumberIdentifier
 
     class IncompleteReimbursementError < StandardError; end
 
@@ -15,7 +16,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,7 @@
 module Spree
   class ReturnAuthorization < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
+    include NumberIdentifier
 
     belongs_to :order, class_name: 'Spree::Order', inverse_of: :return_authorizations
 
@@ -17,7 +18,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
 
@@ -44,7 +44,8 @@ module Spree
     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

@@ -165,7 +165,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
+    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
-
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
   end
 end

data/app/models/spree/shipment.rb

@@ -3,8 +3,9 @@ require 'ostruct'
 module Spree
   class Shipment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
-
+    include NumberIdentifier
     include NumberAsParam
+    include Metadata
 
     with_options inverse_of: :shipments do
       belongs_to :address, class_name: 'Spree::Address'
@@ -26,7 +27,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 +216,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).
@@ -303,34 +303,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,6 @@
 module Spree
   class ShippingCategory < Spree::Base
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
+    include UniqueName
 
     with_options inverse_of: :shipping_category do
       has_many :products

data/app/models/spree/shipping_method.rb

@@ -2,6 +2,8 @@ module Spree
   class ShippingMethod < Spree::Base
     acts_as_paranoid
     include Spree::CalculatedAdjustments
+    include Metadata
+
     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/stock/quantifier.rb

@@ -31,7 +31,7 @@ module Spree
       private
 
       def scope_to_location(collection)
-        return collection.with_active_stock_location unless stock_location.present?
+        return collection.with_active_stock_location if stock_location.blank?
 
         collection.where(stock_location: stock_location)
       end

data/app/models/spree/stock/splitter/digital.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Stock
+    module Splitter
+      class Digital < Spree::Stock::Splitter::Base
+        def split(packages)
+          split_packages = []
+          packages.each do |package|
+            split_packages += split_by_digital(package)
+          end
+
+          return_next(split_packages)
+        end
+
+        private
+
+        def split_by_digital(package)
+          digitals = Hash.new { |hash, key| hash[key] = [] }
+          package.contents.each do |item|
+            digitals[item.variant.digital?] << item
+          end
+
+          hash_to_packages(digitals)
+        end
+
+        def hash_to_packages(digitals)
+          packages = []
+          digitals.each do |_id, contents|
+            packages << build_package(contents)
+          end
+          packages
+        end
+      end
+    end
+  end
+end

data/app/models/spree/stock_item.rb

@@ -26,7 +26,7 @@ module Spree
     after_destroy { variant.touch }
 
     self.whitelisted_ransackable_attributes = %w[count_on_hand stock_location_id variant_id]
-    self.whitelisted_ransackable_associations = ['variant']
+    self.whitelisted_ransackable_associations = %w[variant stock_location]
 
     scope :with_active_stock_location, -> { joins(:stock_location).merge(Spree::StockLocation.active) }
 
@@ -79,7 +79,7 @@ module Spree
 
         if unit.quantity > number
           # if required quantity is greater than available
-          # split off and fullfill that
+          # split off and fulfill that
           split = unit.split_inventory!(number)
           split.fill_backorder
         else

data/app/models/spree/stock_location.rb

@@ -1,5 +1,7 @@
 module Spree
   class StockLocation < Spree::Base
+    include UniqueName
+
     has_many :shipments
     has_many :stock_items, dependent: :delete_all, inverse_of: :stock_location
     has_many :variants, through: :stock_items
@@ -8,8 +10,6 @@ module Spree
     belongs_to :state, class_name: 'Spree::State', optional: true
     belongs_to :country, class_name: 'Spree::Country'
 
-    validates :name, presence: true, uniqueness: { allow_blank: true, case_sensitive: false }
-
     scope :active, -> { where(active: true) }
     scope :order_default, -> { order(default: :desc, name: :asc) }
 
@@ -47,15 +47,13 @@ module Spree
     end
 
     # Attempts to look up StockItem for the variant, and creates one if not found.
-    # This method accepts an instance of the variant.
-    # Other methods in this model attempt to pass a variant,
-    # but controller actions can pass just the variant id as a parameter.
     #
-    # @param variant [Variant] Variant instance.
+    # @param variant Variant instance or Variant ID
     #
     # @return [StockItem] Corresponding StockItem for the StockLocation's variant.
     def stock_item_or_create(variant)
-      stock_item(variant) || stock_items.create(variant_id: variant.id)
+      variant_id = variant.is_a?(Spree::Variant) ? variant.id : variant
+      stock_item(variant_id) || stock_items.create(variant_id: variant_id)
     end
 
     def count_on_hand(variant)
@@ -108,27 +106,7 @@ module Spree
     private
 
     def create_stock_items
-      variants_scope = Spree::Variant
-
-      if self.class.method_defined?(:insert_all) && self.class.method_defined?(:touch_all)
-        prepared_stock_items = variants_scope.ids.map do |variant_id|
-          Hash[
-            'stock_location_id', id,
-            'variant_id', variant_id,
-            'backorderable', backorderable_default,
-            'created_at', Time.current,
-            'updated_at', Time.current
-          ]
-        end
-        if prepared_stock_items.any?
-          stock_items.insert_all(prepared_stock_items)
-          variants_scope.touch_all
-        end
-      else
-        variants_scope.find_each do |variant|
-          propagate_variant(variant)
-        end
-      end
+      Spree::StockLocations::StockItems::CreateJob.perform_later(self)
     end
 
     def ensure_one_default

data/app/models/spree/stock_movement.rb

@@ -21,6 +21,9 @@ module Spree
 
     scope :recent, -> { order(created_at: :desc) }
 
+    delegate :variant, to: :stock_item
+    delegate :product, to: :variant
+
     self.whitelisted_ransackable_attributes = ['quantity']
 
     def readonly?

data/app/models/spree/stock_transfer.rb

@@ -1,20 +1,17 @@
 module Spree
   class StockTransfer < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'T')
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
 
     has_many :stock_movements, as: :originator
 
     belongs_to :source_location, class_name: 'StockLocation', optional: true
     belongs_to :destination_location, class_name: 'StockLocation'
 
-    validates :number, uniqueness: true
-
     self.whitelisted_ransackable_attributes = %w[reference source_location_id destination_location_id number]
 
-    def to_param
-      number
-    end
-
     def source_movements
       find_stock_location_with_location_id(source_location_id)
     end