mirror of
https://github.com/openfoodfoundation/openfoodnetwork
synced 2026-02-04 22:16:08 +00:00
cc9e3fe69b
We rely now on the exhaustive list of states an order can be in after checkout. What made this all a bit more messy is that I made up the "checkout" order state, likely mixing it from the payment model states. This simplifies things quite a bit and gives meaningful names to things.
45 lines
1.5 KiB
Ruby
45 lines
1.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# Encapsulates the SQL statement that computes the balance of an order as a new column in the result
|
|
# set. This can then be reused chaining it with the ActiveRecord::Relation objects you pass in the
|
|
# constructor.
|
|
#
|
|
# Alternatively, you can get the SQL by calling #statement, which is suitable for more complex
|
|
# cases.
|
|
#
|
|
# See CompleteOrdersWithBalance or CustomersWithBalance as examples.
|
|
class OutstandingBalance
|
|
# All the states of a finished order but that shouldn't count towards the balance (the customer
|
|
# didn't get the order for whatever reason). Note it does not include complete
|
|
FINALIZED_NON_SUCCESSFUL_STATES = %w(canceled returned).freeze
|
|
|
|
# The relation must be an ActiveRecord::Relation object with `spree_orders` in the SQL statement
|
|
# FROM for #statement to work.
|
|
def initialize(relation = nil)
|
|
@relation = relation
|
|
end
|
|
|
|
def query
|
|
relation.select("#{statement} AS balance_value")
|
|
end
|
|
|
|
# Arel doesn't support CASE statements until v7.1.0 so we'll have to wait with SQL literals
|
|
# a little longer. See https://github.com/rails/arel/pull/400 for details.
|
|
def statement
|
|
<<-SQL.strip_heredoc
|
|
CASE WHEN state IN #{non_fulfilled_states_group.to_sql} THEN payment_total
|
|
WHEN state IS NOT NULL THEN payment_total - total
|
|
ELSE 0 END
|
|
SQL
|
|
end
|
|
|
|
private
|
|
|
|
attr_reader :relation
|
|
|
|
def non_fulfilled_states_group
|
|
states = FINALIZED_NON_SUCCESSFUL_STATES.map { |state| Arel::Nodes.build_quoted(state) }
|
|
Arel::Nodes::Grouping.new(states)
|
|
end
|
|
end
|