Class: Spree::ReturnItem

Inherits:
ActiveRecord::Base
  • Object
show all
Extended by:
DisplayMoney
Defined in:
app/models/spree/return_item.rb

Defined Under Namespace

Modules: ExchangeVariantEligibility

Constant Summary collapse

INTERMEDIATE_RECEPTION_STATUSES =
%i(given_to_customer lost_in_transit shipped_wrong_item short_shipped in_transit)
COMPLETED_RECEPTION_STATUSES =
INTERMEDIATE_RECEPTION_STATUSES + [:received]

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from DisplayMoney

money_methods

Class Attribute Details

.exchange_variant_engineClass

Configurable engine for determining which variants can be exchanged for a given variant.

Returns:

  • (Class)


20
# File 'app/models/spree/return_item.rb', line 20

class_attribute :exchange_variant_engine

.refund_amount_calculatorClass

Configurable calculator for determining the amount ro refund when refunding.

Returns:

  • (Class)


28
# File 'app/models/spree/return_item.rb', line 28

class_attribute :refund_amount_calculator

.return_eligibility_validatorClass

Configurable validator for determining whether given return item is eligible for return.

Returns:

  • (Class)


12
# File 'app/models/spree/return_item.rb', line 12

class_attribute :return_eligibility_validator

Class Method Details

.build_exchange_inventory_unitObject

Builds the exchange inventory unit for this return item, only if an exchange is required, correctly associating the variant, line item and order.



173
174
175
176
177
178
179
180
# File 'app/models/spree/return_item.rb', line 173

def build_exchange_inventory_unit
  # The inventory unit needs to have the new variant
  # but it also needs to know the original line item
  # for pricing information for if the inventory unit is
  # ever returned. This means that the inventory unit's line_item
  # will have a different variant than the inventory unit itself
  super(variant: exchange_variant, line_item: inventory_unit.line_item, order: inventory_unit.order) if exchange_required?
end

.eligible_exchange_variantsActiveRecord::Relation<Spree::Variant>

Note:

This uses the exchange_variant_engine configured on the class.

Returns the variants eligible for exchange for this return item.

Returns:

  • (ActiveRecord::Relation<Spree::Variant>)

    the variants eligible for exchange for this return item



166
167
168
# File 'app/models/spree/return_item.rb', line 166

def eligible_exchange_variants
  exchange_variant_engine.eligible_variants(variant)
end

.exchange_processed?Boolean

True when an exchange has been processed for this return item

Returns:

  • (Boolean)

    true when an exchange has been processed for this return item



147
148
149
# File 'app/models/spree/return_item.rb', line 147

def exchange_processed?
  exchange_inventory_unit.present?
end

.exchange_requested?Boolean

Returns true when an exchange has been requested on this return item.

Returns:

  • (Boolean)

    true when an exchange has been requested on this return item



141
142
143
# File 'app/models/spree/return_item.rb', line 141

def exchange_requested?
  exchange_variant.present?
end

.exchange_required?Boolean

Returns true when an exchange has been requested but has yet to be processed.

Returns:

  • (Boolean)

    true when an exchange has been requested but has yet to be processed



153
154
155
# File 'app/models/spree/return_item.rb', line 153

def exchange_required?
  exchange_requested? && !exchange_processed?
end

.exchange_shipmentSpree::Shipment?

Returns the exchange inventory unit’s shipment if it exists.

Returns:

  • (Spree::Shipment, nil)

    the exchange inventory unit’s shipment if it exists



183
184
185
# File 'app/models/spree/return_item.rb', line 183

def exchange_shipment
  exchange_inventory_unit.try(:shipment)
end

.from_inventory_unit(inventory_unit) ⇒ Spree::ReturnItem

Returns a valid return item for the given inventory unit if one exists, or a new one if one does not.

Parameters:

Returns:

  • (Spree::ReturnItem)

    a valid return item for the given inventory unit if one exists, or a new one if one does not



134
135
136
137
# File 'app/models/spree/return_item.rb', line 134

def self.from_inventory_unit(inventory_unit)
  valid.find_by(inventory_unit: inventory_unit) ||
    new(inventory_unit: inventory_unit).tap(&:set_default_pre_tax_amount)
end

.part_of_exchange?Boolean

Returns:

  • (Boolean)


208
209
210
211
212
# File 'app/models/spree/return_item.rb', line 208

def part_of_exchange?
  # test whether this ReturnItem was either a) one for which an exchange was sent or
  #   b) the exchanged item itself being returned in lieu of the original item
  exchange_requested? || sibling_intended_for_exchange('unexchanged')
end

.potential_reception_transitionsObject



195
196
197
198
199
200
201
202
203
204
205
206
# File 'app/models/spree/return_item.rb', line 195

def potential_reception_transitions
  status_paths = reception_status_paths.to_states
  event_paths = reception_status_paths.events
  status_paths.delete(:cancelled)
  status_paths.delete(:expired)
  status_paths.delete(:unexchanged)
  event_paths.delete(:cancel)
  event_paths.delete(:expired)
  event_paths.delete(:unexchange)

  status_paths.map{ |s| s.to_s.humanize }.zip(event_paths)
end

.reception_completed?Boolean

Returns true when this retur item is in a complete reception state.

Returns:

  • (Boolean)

    true when this retur item is in a complete reception state



100
101
102
# File 'app/models/spree/return_item.rb', line 100

def reception_completed?
  COMPLETED_RECEPTION_STATUSES.map(&:to_s).include?(reception_status.to_s)
end

.set_default_pre_tax_amountObject

Note:

This uses the configured refund_amount_calculator configured on the class.

Calculates and sets the default pre-tax amount to be refunded.



191
192
193
# File 'app/models/spree/return_item.rb', line 191

def set_default_pre_tax_amount
  self.pre_tax_amount = refund_amount_calculator.new.compute(self)
end

.totalBigDecimal

Returns the cost of the item before tax, plus the included and additional taxes.

Returns:

  • (BigDecimal)

    the cost of the item before tax, plus the included and additional taxes



159
160
161
# File 'app/models/spree/return_item.rb', line 159

def total
  pre_tax_amount + included_tax_total + additional_tax_total
end