Class: Spree::StockTransfer

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/stock_transfer.rb

Defined Under Namespace

Classes: InvalidTransferMovement

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Preferences::Preferable

#default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Instance Method Details

#close(closed_by) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'app/models/spree/stock_transfer.rb', line 92

def close(closed_by)
  if receivable?
    self.update_attributes({ closed_at: Time.now, closed_by: closed_by })
  else
    errors.add(:base, Spree.t(:stock_transfer_must_be_receivable))
    false
  end
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'app/models/spree/stock_transfer.rb', line 33

def closed?
  closed_at.present?
end

#destination_movements ⇒ Object 



66
67
68
69
 
# File 'app/models/spree/stock_transfer.rb', line 66

def destination_movements
  stock_movements.joins(:stock_item)
    .where('spree_stock_items.stock_location_id' => destination_location_id)
end

#expected_item_count ⇒ Object 



57
58
59
 
# File 'app/models/spree/stock_transfer.rb', line 57

def expected_item_count
  transfer_items.sum(:expected_quantity)
end

#finalizable? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'app/models/spree/stock_transfer.rb', line 41

def finalizable?
  !finalized? && !shipped? && !closed?
end

#finalize(finalized_by) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'app/models/spree/stock_transfer.rb', line 71

def finalize(finalized_by)
  if finalizable?
    self.update_attributes({ finalized_at: Time.now, finalized_by: finalized_by })
  else
    errors.add(:base, Spree.t(:stock_transfer_cannot_be_finalized))
    false
  end
end

#finalized? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'app/models/spree/stock_transfer.rb', line 29

def finalized?
  finalized_at.present?
end

#receivable? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'app/models/spree/stock_transfer.rb', line 45

def receivable?
  finalized? && shipped? && !closed?
end

#received_item_count ⇒ Object 



53
54
55
 
# File 'app/models/spree/stock_transfer.rb', line 53

def received_item_count
  transfer_items.sum(:received_quantity)
end

#ship(tracking_number: nil, shipped_at: nil) ⇒ Object 



49
50
51
 
# File 'app/models/spree/stock_transfer.rb', line 49

def ship(tracking_number: nil, shipped_at: nil)
  update_attributes!(tracking_number: tracking_number, shipped_at: shipped_at)
end

#shipped? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'app/models/spree/stock_transfer.rb', line 37

def shipped?
  shipped_at.present?
end

#source_movements ⇒ Object 



61
62
63
64
 
# File 'app/models/spree/stock_transfer.rb', line 61

def source_movements
  stock_movements.joins(:stock_item)
    .where('spree_stock_items.stock_location_id' => source_location_id)
end

#to_param ⇒ Object 



25
26
27
 
# File 'app/models/spree/stock_transfer.rb', line 25

def to_param
  number
end

#transfer ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
 
# File 'app/models/spree/stock_transfer.rb', line 80

def transfer
  transaction do
    transfer_items.each do |item|
      raise InvalidTransferMovement unless item.valid?
      source_location.unstock(item.variant, item.expected_quantity, self)
    end
  end
rescue InvalidTransferMovement
  errors.add(:base, Spree.t(:not_enough_stock))
  false
end