spree_core 3.0.9 → 3.2.0

data/app/models/spree/stock/prioritizer.rb

@@ -1,12 +1,12 @@
 module Spree
   module Stock
     class Prioritizer
-      attr_reader :packages, :inventory_units
+      attr_reader :packages
 
-      def initialize(inventory_units, packages, adjuster_class=Adjuster)
-        @inventory_units = inventory_units
+      def initialize(packages, adjuster_class=Adjuster)
         @packages = packages
         @adjuster_class = adjuster_class
+        @adjusters = Hash.new
       end
 
       def prioritized_packages
@@ -17,22 +17,32 @@ module Spree
       end
 
       private
-      def adjust_packages
-        inventory_units.each do |inventory_unit|
-          adjuster = @adjuster_class.new(inventory_unit, :on_hand)
-
-          visit_packages(adjuster)
 
-          adjuster.status = :backordered
-          visit_packages(adjuster)
+      def adjust_packages
+        packages.each do |package|
+          package.contents.each do |item|
+            adjuster = find_adjuster(item)
+
+            if adjuster.nil?
+              adjuster = build_adjuster(item, package)
+            elsif item.state == :on_hand && adjuster.status == :backordered
+              # Remove item from backordered package
+              adjuster.package.remove(item.inventory_unit)
+              # Reassign adjuster's status package
+              adjuster.reassign(:on_hand, package)
+            end
+
+            adjuster.adjust(package)
+          end
         end
       end
 
-      def visit_packages(adjuster)
-        packages.each do |package|
-          item = package.find_item adjuster.inventory_unit, adjuster.status
-          adjuster.adjust(package) if item
-        end
+      def build_adjuster(item, package)
+        @adjusters[item.inventory_unit] = @adjuster_class.new(item.inventory_unit, item.state, package)
+      end
+
+      def find_adjuster(item)
+        @adjusters[item.inventory_unit]
       end
 
       def sort_packages

data/app/models/spree/stock/quantifier.rb

@@ -1,15 +1,15 @@
 module Spree
   module Stock
     class Quantifier
-      attr_reader :stock_items
+      attr_reader :stock_items, :variant
 
       def initialize(variant)
         @variant = variant
-        @stock_items = Spree::StockItem.joins(:stock_location).where(variant_id: @variant, Spree::StockLocation.table_name => { active: true })
+        @stock_items = @variant.stock_items.with_active_stock_location
       end
 
       def total_on_hand
-        if @variant.should_track_inventory?
+        if variant.should_track_inventory?
           stock_items.sum(:count_on_hand)
         else
           Float::INFINITY
@@ -20,8 +20,8 @@ module Spree
         stock_items.any?(&:backorderable)
       end
 
-      def can_supply?(required)
-        total_on_hand >= required || backorderable?
+      def can_supply?(required = 1)
+        variant.available? && (total_on_hand >= required || backorderable?)
       end
 
     end

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

@@ -6,11 +6,11 @@ module Spree
         def split(packages)
           split_packages = []
           packages.each do |package|
-            if package.on_hand.count > 0
+            if package.on_hand.size > 0
               split_packages << build_package(package.on_hand)
             end
 
-            if package.backordered.count > 0
+            if package.backordered.size > 0
               split_packages << build_package(package.backordered)
             end
           end

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

@@ -14,7 +14,7 @@ module Spree
         def split_by_category(package)
           categories = Hash.new { |hash, key| hash[key] = [] }
           package.contents.each do |item|
-            categories[item.variant.shipping_category_id] << item
+            categories[shipping_category_for(item)] << item
           end
           hash_to_packages(categories)
         end
@@ -26,6 +26,11 @@ module Spree
           end
           packages
         end
+
+        def shipping_category_for(item)
+          @item_shipping_category ||= {}
+          @item_shipping_category[item.inventory_unit.variant_id] ||= item.variant.shipping_category_id
+        end
       end
     end
   end

data/app/models/spree/stock_item.rb

@@ -2,39 +2,40 @@ module Spree
   class StockItem < Spree::Base
     acts_as_paranoid
 
-    belongs_to :stock_location, class_name: 'Spree::StockLocation', inverse_of: :stock_items
-    belongs_to :variant, class_name: 'Spree::Variant', inverse_of: :stock_items, counter_cache: true
+    with_options inverse_of: :stock_items do
+      belongs_to :stock_location, class_name: 'Spree::StockLocation'
+      belongs_to :variant, class_name: 'Spree::Variant'
+    end
     has_many :stock_movements, inverse_of: :stock_item
 
-    validates_presence_of :stock_location, :variant
-    validates_uniqueness_of :variant_id, scope: [:stock_location_id, :deleted_at]
+    validates :stock_location, :variant, presence: true
+    validates :variant_id, uniqueness: { scope: [:stock_location_id, :deleted_at] }, allow_blank: true
 
-    validates_numericality_of :count_on_hand,
+    validates :count_on_hand, numericality: {
                               greater_than_or_equal_to: 0,
                               less_than_or_equal_to: 2**31 - 1,
-                              only_integer: true, if: :verify_count_on_hand?
+                              only_integer: true }, if: :verify_count_on_hand?
 
     delegate :weight, :should_track_inventory?, to: :variant
+    delegate :name, to: :variant, prefix: true
+    delegate :product, to: :variant
 
     after_save :conditional_variant_touch, if: :changed?
     after_touch { variant.touch }
+    after_destroy { variant.touch }
 
     self.whitelisted_ransackable_attributes = ['count_on_hand', 'stock_location_id']
+    self.whitelisted_ransackable_associations = ['variant']
+
+    scope :with_active_stock_location, -> { joins(:stock_location).merge(Spree::StockLocation.active) }
 
     def backordered_inventory_units
       Spree::InventoryUnit.backordered_for_stock_item(self)
     end
 
-    def variant_name
-      variant.name
-    end
-
     def adjust_count_on_hand(value)
       self.with_lock do
-        self.count_on_hand = self.count_on_hand + value
-        process_backorders(count_on_hand - count_on_hand_was)
-
-        self.save!
+        set_count_on_hand(count_on_hand + value)
       end
     end
 
@@ -67,10 +68,6 @@ module Spree
         count_on_hand_changed? && !backorderable? && (count_on_hand < count_on_hand_was) && (count_on_hand < 0)
       end
 
-      def count_on_hand=(value)
-        write_attribute(:count_on_hand, value)
-      end
-
       # Process backorders based on amount of stock received
       # If stock was -20 and is now -15 (increase of 5 units), then we should process 5 inventory orders.
       # If stock was -20 but then was -25 (decrease of 5 units), do nothing.

data/app/models/spree/stock_location.rb

@@ -7,12 +7,12 @@ module Spree
     belongs_to :state, class_name: 'Spree::State'
     belongs_to :country, class_name: 'Spree::Country'
 
-    validates_presence_of :name
+    validates :name, presence: true
 
     scope :active, -> { where(active: true) }
     scope :order_default, -> { order(default: :desc, name: :asc) }
 
-    after_create :create_stock_items, :if => "self.propagate_all_variants?"
+    after_create :create_stock_items, if: :propagate_all_variants?
     after_save :ensure_one_default
 
     def state_text
@@ -68,7 +68,7 @@ module Spree
       item = stock_item_or_create(variant)
       item.update_columns(
         count_on_hand: item.count_on_hand + quantity,
-        updated_at: Time.now
+        updated_at: Time.current
       )
     end
 
@@ -108,10 +108,7 @@ module Spree
 
       def ensure_one_default
         if self.default
-          StockLocation.where(default: true).where.not(id: self.id).each do |stock_location|
-            stock_location.default = false
-            stock_location.save!
-          end
+          StockLocation.where(default: true).where.not(id: self.id).update_all(default: false)
         end
       end
   end

data/app/models/spree/stock_movement.rb

@@ -1,24 +1,31 @@
 module Spree
   class StockMovement < Spree::Base
+    QUANTITY_LIMITS = {
+      max: 2**31 - 1,
+      min: -2**31
+    }.freeze
+
     belongs_to :stock_item, class_name: 'Spree::StockItem', inverse_of: :stock_movements
     belongs_to :originator, polymorphic: true
 
     after_create :update_stock_item_quantity
 
-    validates :stock_item, presence: true
-    validates :quantity, presence: true, numericality: {
-                 greater_than_or_equal_to: -2**31,
-                 less_than_or_equal_to: 2**31-1,
-                 only_integer: true,
-                 allow_nil: true
-              }
+    with_options presence: true do
+      validates :stock_item
+      validates :quantity, numericality: {
+        greater_than_or_equal_to: QUANTITY_LIMITS[:min],
+        less_than_or_equal_to: QUANTITY_LIMITS[:max],
+        only_integer: true,
+        allow_nil: true
+      }
+    end
 
-    scope :recent, -> { order('created_at DESC') }
+    scope :recent, -> { order(created_at: :desc) }
 
     self.whitelisted_ransackable_attributes = ['quantity']
 
     def readonly?
-      !new_record?
+      persisted?
     end
 
     private

data/app/models/spree/stock_transfer.rb

@@ -1,34 +1,27 @@
 module Spree
   class StockTransfer < Spree::Base
+    include Spree::Core::NumberGenerator.new(prefix: 'T')
+
     extend FriendlyId
     friendly_id :number, slug_column: :number, use: :slugged
 
-    include Spree::NumberGenerator
-
-    def generate_number(options = {})
-      options[:prefix] ||= 'T'
-      super(options)
-    end
-
     has_many :stock_movements, as: :originator
 
     belongs_to :source_location, class_name: 'StockLocation'
     belongs_to :destination_location, class_name: 'StockLocation'
 
-    self.whitelisted_ransackable_attributes = %w[reference source_location_id destination_location_id closed_at created_at number]
+    self.whitelisted_ransackable_attributes = %w[reference source_location_id destination_location_id number]
 
     def to_param
       number
     end
 
     def source_movements
-      stock_movements.joins(:stock_item)
-        .where('spree_stock_items.stock_location_id' => source_location_id)
+      find_stock_location_with_location_id(source_location_id)
     end
 
     def destination_movements
-      stock_movements.joins(:stock_item)
-        .where('spree_stock_items.stock_location_id' => destination_location_id)
+      find_stock_location_with_location_id(destination_location_id)
     end
 
     def transfer(source_location, destination_location, variants)
@@ -47,5 +40,11 @@ module Spree
     def receive(destination_location, variants)
       transfer(nil, destination_location, variants)
     end
+
+    private
+
+    def find_stock_location_with_location_id(location_id)
+      stock_movements.joins(:stock_item).where('spree_stock_items.stock_location_id' => location_id)
+    end
   end
 end

data/app/models/spree/store.rb

@@ -2,23 +2,27 @@ module Spree
   class Store < Spree::Base
     has_many :orders, class_name: "Spree::Order"
 
-    validates :code, presence: true, uniqueness: { allow_blank: true }
-    validates :name, presence: true
-    validates :url, presence: true
-    validates :mail_from_address, presence: true
+    with_options presence: true do
+      validates :code, uniqueness: { allow_blank: true }
+      validates :name, :url, :mail_from_address
+    end
 
     before_save :ensure_default_exists_and_is_unique
     before_destroy :validate_not_default
 
     scope :by_url, lambda { |url| where("url like ?", "%#{url}%") }
 
+    after_commit :clear_cache
+
     def self.current(domain = nil)
       current_store = domain ? Store.by_url(domain).first : nil
       current_store || Store.default
     end
 
     def self.default
-      where(default: true).first || new
+      Rails.cache.fetch("default_store") do
+        where(default: true).first_or_initialize
+      end
     end
 
     private
@@ -26,7 +30,7 @@ module Spree
     def ensure_default_exists_and_is_unique
       if default
         Store.where.not(id: id).update_all(default: false)
-      elsif Store.where(default: true).count == 0
+      elsif Store.where(default: true).count.zero?
         self.default = true
       end
     end
@@ -34,7 +38,12 @@ module Spree
     def validate_not_default
       if default
         errors.add(:base, :cannot_destroy_default_store)
+        throw(:abort)
       end
     end
+
+    def clear_cache
+      Rails.cache.delete("default_store")
+    end
   end
 end

data/app/models/spree/store_credit.rb

@@ -0,0 +1,252 @@
+module Spree
+  class StoreCredit < Spree::Base
+    acts_as_paranoid
+
+    VOID_ACTION       = 'void'.freeze
+    CANCEL_ACTION     = 'cancel'.freeze
+    CREDIT_ACTION     = 'credit'.freeze
+    CAPTURE_ACTION    = 'capture'.freeze
+    ELIGIBLE_ACTION   = 'eligible'.freeze
+    AUTHORIZE_ACTION  = 'authorize'.freeze
+    ALLOCATION_ACTION = 'allocation'.freeze
+
+    DEFAULT_CREATED_BY_EMAIL = 'spree@example.com'.freeze
+
+    belongs_to :user, class_name: Spree.user_class.to_s, foreign_key: 'user_id'
+    belongs_to :category, class_name: "Spree::StoreCreditCategory"
+    belongs_to :created_by, class_name: Spree.user_class.to_s, foreign_key: 'created_by_id'
+    belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id'
+    has_many :store_credit_events
+
+    validates_presence_of :user, :category, :credit_type, :created_by, :currency
+    validates_numericality_of :amount, greater_than: 0
+    validates_numericality_of :amount_used, greater_than_or_equal_to: 0
+    validate :amount_used_less_than_or_equal_to_amount
+    validate :amount_authorized_less_than_or_equal_to_amount
+
+    delegate :name, to: :category, prefix: true
+    delegate :email, to: :created_by, prefix: true
+
+    scope :order_by_priority, -> { includes(:credit_type).order('spree_store_credit_types.priority ASC') }
+
+    before_validation :associate_credit_type
+    after_save :store_event
+    before_destroy :validate_no_amount_used
+
+    attr_accessor :action, :action_amount, :action_originator, :action_authorization_code
+
+    def display_amount
+      Spree::Money.new(amount)
+    end
+
+    def display_amount_used
+      Spree::Money.new(amount_used)
+    end
+
+    def amount_remaining
+      amount - amount_used - amount_authorized
+    end
+
+    def authorize(amount, order_currency, options = {})
+      authorization_code = options[:action_authorization_code]
+      if authorization_code
+        if store_credit_events.find_by(action: AUTHORIZE_ACTION, authorization_code: authorization_code)
+          # Don't authorize again on capture
+          return true
+        end
+      else
+        authorization_code = generate_authorization_code
+      end
+
+      if validate_authorization(amount, order_currency)
+        update_attributes!(
+          action: AUTHORIZE_ACTION,
+          action_amount: amount,
+          action_originator: options[:action_originator],
+          action_authorization_code: authorization_code,
+          amount_authorized: amount_authorized + amount
+        )
+        authorization_code
+      else
+        errors.add(:base, Spree.t('store_credit_payment_method.insufficient_authorized_amount'))
+        false
+      end
+    end
+
+    def validate_authorization(amount, order_currency)
+      if amount_remaining.to_d < amount.to_d
+        errors.add(:base, Spree.t('store_credit_payment_method.insufficient_funds'))
+      elsif currency != order_currency
+        errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
+      end
+      errors.blank?
+    end
+
+    def capture(amount, authorization_code, order_currency, options = {})
+      return false unless authorize(amount, order_currency, action_authorization_code: authorization_code)
+
+      if amount <= amount_authorized
+        if currency != order_currency
+          errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
+          false
+        else
+          update_attributes!(
+            action: CAPTURE_ACTION,
+            action_amount: amount,
+            action_originator: options[:action_originator],
+            action_authorization_code: authorization_code,
+            amount_used: amount_used + amount,
+            amount_authorized: amount_authorized - amount
+          )
+          authorization_code
+        end
+      else
+        errors.add(:base, Spree.t('store_credit_payment_method.insufficient_authorized_amount'))
+        false
+      end
+    end
+
+    def void(authorization_code, options = {})
+      if auth_event = store_credit_events.find_by(action: AUTHORIZE_ACTION, authorization_code: authorization_code)
+        update_attributes!(
+          action: VOID_ACTION,
+          action_amount: auth_event.amount,
+          action_authorization_code: authorization_code,
+          action_originator: options[:action_originator],
+          amount_authorized: amount_authorized - auth_event.amount
+        )
+        true
+      else
+        errors.add(:base, Spree.t('store_credit_payment_method.unable_to_void', auth_code: authorization_code))
+        false
+      end
+    end
+
+    def credit(amount, authorization_code, order_currency, options = {})
+      # Find the amount related to this authorization_code in order to add the store credit back
+      capture_event = store_credit_events.find_by(action: CAPTURE_ACTION, authorization_code: authorization_code)
+
+      if currency != order_currency # sanity check to make sure the order currency hasn't changed since the auth
+        errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
+        false
+      elsif capture_event && amount <= capture_event.amount
+        action_attributes = {
+          action: CREDIT_ACTION,
+          action_amount: amount,
+          action_originator: options[:action_originator],
+          action_authorization_code: authorization_code
+        }
+        create_credit_record(amount, action_attributes)
+        true
+      else
+        errors.add(:base, Spree.t('store_credit_payment_method.unable_to_credit', auth_code: authorization_code))
+        false
+      end
+    end
+
+    def actions
+      [CAPTURE_ACTION, VOID_ACTION, CREDIT_ACTION]
+    end
+
+    def can_capture?(payment)
+      payment.pending? || payment.checkout?
+    end
+
+    def can_void?(payment)
+      payment.pending?
+    end
+
+    def can_credit?(payment)
+      payment.completed? && payment.credit_allowed > 0
+    end
+
+    def generate_authorization_code
+      "#{id}-SC-#{Time.now.utc.strftime('%Y%m%d%H%M%S%6N')}"
+    end
+
+    class << self
+      def default_created_by
+        Spree.user_class.find_by(email: DEFAULT_CREATED_BY_EMAIL)
+      end
+    end
+
+    private
+
+    def create_credit_record(amount, action_attributes = {})
+      # Setting credit_to_new_allocation to true will create a new allocation anytime #credit is called
+      # If it is not set, it will update the store credit's amount in place
+      credit = if Spree::Config.credit_to_new_allocation
+                 Spree::StoreCredit.new(create_credit_record_params(amount))
+               else
+                 self.amount_used = amount_used - amount
+                 self
+               end
+
+      credit.assign_attributes(action_attributes)
+      credit.save!
+    end
+
+    def create_credit_record_params(amount)
+      {
+        amount: amount,
+        user_id: user_id,
+        category_id: category_id,
+        created_by_id: created_by_id,
+        currency: currency,
+        type_id: type_id,
+        memo: credit_allocation_memo
+      }
+    end
+
+    def credit_allocation_memo
+      "This is a credit from store credit ID #{id}"
+    end
+
+    def store_event
+      return unless amount_changed? || amount_used_changed? || amount_authorized_changed? || action == ELIGIBLE_ACTION
+
+      event = if action
+                store_credit_events.build(action: action)
+              else
+                store_credit_events.where(action: ALLOCATION_ACTION).first_or_initialize
+              end
+
+      event.update_attributes!(
+        amount: action_amount || amount,
+        authorization_code: action_authorization_code || event.authorization_code || generate_authorization_code,
+        user_total_amount: user.total_available_store_credit,
+        originator: action_originator
+      )
+    end
+
+    def amount_used_less_than_or_equal_to_amount
+      return true if amount_used.nil?
+
+      if amount_used > amount
+        errors.add(:amount_used, :cannot_be_greater_than_amount)
+        false
+      end
+    end
+
+    def amount_authorized_less_than_or_equal_to_amount
+      if (amount_used + amount_authorized) > amount
+        errors.add(:amount_authorized, :exceeds_total_credits)
+        false
+      end
+    end
+
+    def validate_no_amount_used
+      if amount_used > 0
+        errors.add(:amount_used, :greater_than_zero_restrict_delete)
+        throw(:abort)
+      end
+    end
+
+    def associate_credit_type
+      unless type_id
+        credit_type_name = category.try(:non_expiring?) ? 'Non-expiring' : 'Expiring'
+        self.credit_type = Spree::StoreCreditType.find_by_name(credit_type_name)
+      end
+    end
+  end
+end

data/app/models/spree/store_credit_category.rb

@@ -0,0 +1,22 @@
+module Spree
+  class StoreCreditCategory < Spree::Base
+    validates_presence_of :name
+
+    GIFT_CARD_CATEGORY_NAME = 'Gift Card'.freeze
+    DEFAULT_NON_EXPIRING_TYPES = [GIFT_CARD_CATEGORY_NAME]
+
+    def non_expiring?
+      non_expiring_category_types.include? name
+    end
+
+    def non_expiring_category_types
+      DEFAULT_NON_EXPIRING_TYPES | Spree::Config[:non_expiring_credit_types]
+    end
+
+    class << self
+      def default_reimbursement_category(_options = {})
+        Spree::StoreCreditCategory.first
+      end
+    end
+  end
+end