Module: Spree::Order::Checkout::ClassMethods

Defined in:
app/models/spree/order/checkout.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#checkout_stepsObject

Returns the value of attribute checkout_steps



11
12
13
# File 'app/models/spree/order/checkout.rb', line 11

def checkout_steps
  @checkout_steps
end

#next_event_transitionsObject

Returns the value of attribute next_event_transitions



9
10
11
# File 'app/models/spree/order/checkout.rb', line 9

def next_event_transitions
  @next_event_transitions
end

#previous_statesObject

Returns the value of attribute previous_states



10
11
12
# File 'app/models/spree/order/checkout.rb', line 10

def previous_states
  @previous_states
end

#removed_transitionsObject

Returns the value of attribute removed_transitions



12
13
14
# File 'app/models/spree/order/checkout.rb', line 12

def removed_transitions
  @removed_transitions
end

Instance Method Details

#add_transition(options) ⇒ Object



207
208
209
# File 'app/models/spree/order/checkout.rb', line 207

def add_transition(options)
  next_event_transitions << { options.delete(:from) => options.delete(:to) }.merge(options)
end

#checkout_flow(&block) ⇒ Object



14
15
16
17
18
19
20
21
# File 'app/models/spree/order/checkout.rb', line 14

def checkout_flow(&block)
  if block_given?
    @checkout_flow = block
    define_state_machine!
  else
    @checkout_flow
  end
end

#checkout_step_namesObject



203
204
205
# File 'app/models/spree/order/checkout.rb', line 203

def checkout_step_names
  checkout_steps.keys
end

#define_state_machine!Object



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'app/models/spree/order/checkout.rb', line 23

def define_state_machine!
  self.checkout_steps = {}
  self.next_event_transitions = []
  self.previous_states = [:cart]
  self.removed_transitions = []

  # Build the checkout flow using the checkout_flow defined either
  # within the Order class, or a decorator for that class.
  #
  # This method may be called multiple times depending on if the
  # checkout_flow is re-defined in a decorator or not.
  instance_eval(&checkout_flow)

  klass = self

  # To avoid multiple occurrences of the same transition being defined
  # On first definition, state_machines will not be defined
  state_machines.clear if respond_to?(:state_machines)
  state_machine :state, initial: :cart, use_transactions: false do
    klass.next_event_transitions.each { |t| transition(t.merge(on: :next)) }

    # Persist the state on the order
    after_transition do |order, transition|
      order.state = order.state
      order.state_changes.create(
        previous_state: transition.from,
        next_state:     transition.to,
        name:           'order',
        user_id:        order.user_id
      )
      order.save
    end

    event :cancel do
      transition to: :canceled, if: :allow_cancel?
    end

    event :return do
      transition to: :returned, from: [:returned, :complete, :awaiting_return, :canceled], if: :all_inventory_units_returned?
    end

    event :resume do
      transition to: :resumed, from: :canceled, if: :canceled?
    end

    event :authorize_return do
      transition to: :awaiting_return
    end

    event :complete do
      transition to: :complete, from: :confirm
    end

    if states[:payment]
      event :payment_failed do
        transition to: :payment, from: :confirm
      end

      after_transition to: :complete, do: :add_payment_sources_to_wallet
      before_transition to: :payment, do: :add_default_payment_from_wallet

      before_transition to: :confirm, do: :add_store_credit_payments

      # see also process_payments_before_complete below which needs to
      # be added in the correct sequence.
    end

    before_transition from: :cart, do: :ensure_line_items_present

    if states[:address]
      before_transition to: :address, do: :assign_default_addresses!
      before_transition from: :address, do: :persist_user_address!
    end

    if states[:delivery]
      before_transition to: :delivery, do: :ensure_shipping_address
      before_transition to: :delivery, do: :create_proposed_shipments
      before_transition to: :delivery, do: :ensure_available_shipping_rates
      before_transition from: :delivery, do: :apply_free_shipping_promotions
    end

    before_transition to: :resumed, do: :ensure_line_item_variants_are_not_deleted
    before_transition to: :resumed, do: :validate_line_item_availability

    # Sequence of before_transition to: :complete
    # calls matter so that we do not process payments
    # until validations have passed
    before_transition to: :complete, do: :validate_line_item_availability
    if states[:delivery]
      before_transition to: :complete, do: :ensure_available_shipping_rates
    end
    before_transition to: :complete, do: :ensure_promotions_eligible
    before_transition to: :complete, do: :ensure_line_item_variants_are_not_deleted
    before_transition to: :complete, do: :ensure_inventory_units
    if states[:payment]
      before_transition to: :complete, do: :process_payments_before_complete
    end

    after_transition to: :complete, do: :finalize!
    after_transition to: :resumed,  do: :after_resume
    after_transition to: :canceled, do: :after_cancel

    after_transition from: any - :cart, to: any - [:confirm, :complete] do |order|
      order.update!
    end

    after_transition do |order, transition|
      order.logger.debug "Order #{order.number} transitioned from #{transition.from} to #{transition.to} via #{transition.event}"
    end

    after_failure do |order, transition|
      order.logger.debug "Order #{order.number} halted transition on event #{transition.event} state #{transition.from}: #{order.errors.full_messages.join}"
    end
  end
end

#find_transition(options = {}) ⇒ Object



188
189
190
191
192
193
# File 'app/models/spree/order/checkout.rb', line 188

def find_transition(options = {})
  return nil if options.nil? || !options.include?(:from) || !options.include?(:to)
  next_event_transitions.detect do |transition|
    transition[options[:from].to_sym] == options[:to].to_sym
  end
end

#go_to_state(name, options = {}) ⇒ Object



139
140
141
142
143
144
145
146
147
148
149
# File 'app/models/spree/order/checkout.rb', line 139

def go_to_state(name, options = {})
  checkout_steps[name] = options
  previous_states.each do |state|
    add_transition({ from: state, to: name }.merge(options))
  end
  if options[:if]
    previous_states << name
  else
    self.previous_states = [name]
  end
end

#insert_checkout_step(name, options = {}) ⇒ Object



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'app/models/spree/order/checkout.rb', line 151

def insert_checkout_step(name, options = {})
  before = options.delete(:before)
  after = options.delete(:after) unless before
  after = checkout_steps.keys.last unless before || after

  cloned_steps = checkout_steps.clone
  cloned_removed_transitions = removed_transitions.clone
  checkout_flow do
    cloned_steps.each_pair do |key, value|
      go_to_state(name, options) if key == before
      go_to_state(key, value)
      go_to_state(name, options) if key == after
    end
    cloned_removed_transitions.each do |transition|
      remove_transition(transition)
    end
  end
end

#remove_checkout_step(name) ⇒ Object



170
171
172
173
174
175
176
177
178
179
180
181
# File 'app/models/spree/order/checkout.rb', line 170

def remove_checkout_step(name)
  cloned_steps = checkout_steps.clone
  cloned_removed_transitions = removed_transitions.clone
  checkout_flow do
    cloned_steps.each_pair do |key, value|
      go_to_state(key, value) unless key == name
    end
    cloned_removed_transitions.each do |transition|
      remove_transition(transition)
    end
  end
end

#remove_transition(options = {}) ⇒ Object



183
184
185
186
# File 'app/models/spree/order/checkout.rb', line 183

def remove_transition(options = {})
  removed_transitions << options
  next_event_transitions.delete(find_transition(options))
end