Class: Order

Inherits:
ApplicationRecord show all
Includes:
DateTimeAttributeValidate
Defined in:
app/models/order.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#article_ids ⇒ Object 



92
93
94
 
# File 'app/models/order.rb', line 92

def article_ids
  @article_ids ||= order_articles.map { |a| a.article_id.to_s }
end

#ignore_warnings ⇒ Object

Returns the value of attribute ignore_warnings.



2
3
4
 
# File 'app/models/order.rb', line 2

def ignore_warnings
  @ignore_warnings
end

#transport_distribution ⇒ Object

Returns the value of attribute transport_distribution.



2
3
4
 
# File 'app/models/order.rb', line 2

def transport_distribution
  @transport_distribution
end

Class Method Details

.finish_ended! ⇒ Object 



332
333
334
335
336
337
338
339
340
 
# File 'app/models/order.rb', line 332

def self.finish_ended!
  orders = Order.where.not(end_action: Order.end_actions[:no_end_action]).where(state: 'open').where('ends <= ?',
                                                                                                     DateTime.now)
  orders.each do |order|
    order.do_end_action!
  rescue StandardError => e
    ExceptionNotifier.notify_exception(e, data: { foodcoop: FoodsoftConfig.scope, order_id: order.id })
  end
end

.ordergroup_group_orders_map(ordergroup) ⇒ Object

fetch current Order scope’s records and map the current user’s GroupOrders in (if any) (performance enhancement as opposed to fetching each GroupOrder separately from the view)



154
155
156
157
158
159
160
161
162
163
164
 
# File 'app/models/order.rb', line 154

def self.ordergroup_group_orders_map(ordergroup)
  orders = includes(:supplier)
  group_orders = GroupOrder.where(ordergroup_id: ordergroup.id, order_id: orders.map(&:id))
  group_orders_hash = group_orders.index_by { |go| go.order_id }
  orders.map do |order|
    {
      order: order,
      group_order: group_orders_hash[order.id]
    }
  end
end

.ransackable_associations(_auth_object = nil) ⇒ Object 



56
57
58
 
# File 'app/models/order.rb', line 56

def self.ransackable_associations(_auth_object = nil)
  %w[supplier articles order_articles]
end

.ransackable_attributes(_auth_object = nil) ⇒ Object 



52
53
54
 
# File 'app/models/order.rb', line 52

def self.ransackable_attributes(_auth_object = nil)
  %w[id state supplier_id starts boxfill ends pickup]
end

Instance Method Details

#articles_for_ordering ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'app/models/order.rb', line 68

def articles_for_ordering
  if stockit?
    # make sure to include those articles which are no longer available
    # but which have already been ordered in this stock order
    StockArticle.available.includes(:article_category)
                .order('article_categories.name', 'articles.name').reject do |a|
      a.quantity_available <= 0 && !a.ordered_in_order?(self)
    end.group_by { |a| a.article_category.name }
  else
    supplier.articles.available.group_by { |a| a.article_category.name }
  end
end

#articles_grouped_by_category ⇒ Object

Returns OrderArticles in a nested Array, grouped by category and ordered by article name. The array has the following form: e.g: [[“drugs”,[teethpaste, toiletpaper]], [“fruits” => [apple, banana, lemon]]]



178
179
180
181
182
183
184
 
# File 'app/models/order.rb', line 178

def articles_grouped_by_category
  @articles_grouped_by_category ||= order_articles
                                    .includes([:article_price, :group_order_articles, { article: :article_category }])
                                    .order('articles.name')
                                    .group_by { |a| a.article.article_category.name }
                                    .sort { |a, b| a[0] <=> b[0] }
end

#articles_sort_by_category ⇒ Object 



186
187
188
189
190
 
# File 'app/models/order.rb', line 186

def articles_sort_by_category
  order_articles.includes(:article).order('articles.name').sort do |a, b|
    a.article.article_category.name <=> b.article.article_category.name
  end
end

#boxfill? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'app/models/order.rb', line 117

def boxfill?
  !!FoodsoftConfig[:use_boxfill] && open? && boxfill.present? && boxfill < Time.now
end

#close!(user, transaction_type = nil, financial_link = nil, create_foodcoop_transaction: false) ⇒ Object

Sets order.status to ‘close’ and updates all Ordergroup.account_balances



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'app/models/order.rb', line 274

def close!(user, transaction_type = nil, financial_link = nil, create_foodcoop_transaction: false)
  raise I18n.t('orders.model.error_closed') if closed?

  update_price_of_group_orders!

  transaction do                                        # Start updating account balances
    charge_group_orders!(user, transaction_type, financial_link)

    if stockit?                                         # Decreases the quantity of stock_articles
      for oa in order_articles.includes(:article)
        oa.update_results!                              # Update units_to_order of order_article
        stock_changes.create! stock_article: oa.article, quantity: oa.units_to_order * -1
      end
    end

    if create_foodcoop_transaction
      ft = FinancialTransaction.new({ financial_transaction_type: transaction_type,
                                      user: user,
                                      amount: sum(:groups),
                                      note: transaction_note,
                                      financial_link: financial_link })
      ft.save!
    end

    update!(state: 'closed', updated_by: user, foodcoop_result: profit)
  end
end

#close_direct!(user) ⇒ Object

Close the order directly, without automaticly updating ordergroups account balances



303
304
305
306
307
308
309
310
311
 
# File 'app/models/order.rb', line 303

def close_direct!(user)
  raise I18n.t('orders.model.error_closed') if closed?

  unless FoodsoftConfig[:charge_members_manually]
    comments.create(user: user,
                    text: I18n.t('orders.model.close_direct_message'))
  end
  update!(state: 'closed', updated_by: user)
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
 
# File 'app/models/order.rb', line 113

def closed?
  state == 'closed'
end

#do_end_action! ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
 
# File 'app/models/order.rb', line 320

def do_end_action!
  if auto_close?
    finish!(created_by)
  elsif auto_close_and_send?
    finish!(created_by)
    send_to_supplier!(created_by)
  elsif auto_close_and_send_min_quantity?
    finish!(created_by)
    send_to_supplier!(created_by) if sum >= supplier.min_order_quantity.to_r
  end
end

#erroneous_article_ids ⇒ Object

Returns an array of article ids that lead to a validation error.



97
98
99
 
# File 'app/models/order.rb', line 97

def erroneous_article_ids
  @erroneous_article_ids ||= []
end

#expired? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'app/models/order.rb', line 125

def expired?
  ends.present? && ends < Time.now
end

#finish!(user) ⇒ Object

Finishes this order. This will set the order state to “finish” and the end property to the current time. Ignored if the order is already finished.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'app/models/order.rb', line 239

def finish!(user)
  return if finished?

  Order.transaction do
    # set new order state (needed by notify_order_finished)
    update!(state: 'finished', ends: Time.now, updated_by: user)

    # Update order_articles. Save the current article_price to keep price consistency
    # Also save results for each group_order_result
    # Clean up
    order_articles.includes(:article).find_each do |oa|
      oa.update_attribute(:article_price, oa.article.article_prices.first)
      oa.group_order_articles.each do |goa|
        goa.save_results!
        # Delete no longer required order-history (group_order_article_quantities) and
        # TODO: Do we need articles, which aren't ordered? (units_to_order == 0 ?)
        #    A: Yes, we do - for redistributing articles when the number of articles
        #       delivered changes, and for statistics on popular articles. Records
        #       with both tolerance and quantity zero can be deleted.
        # goa.group_order_article_quantities.clear
      end
    end

    # Update GroupOrder prices
    group_orders.each(&:update_price!)

    # Stats
    ordergroups.each(&:update_stats!)

    # Notifications
    NotifyFinishedOrderJob.perform_later(self)
  end
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'app/models/order.rb', line 105

def finished?
  state == 'finished' || state == 'received'
end

#group_order(ordergroup) ⇒ Object

search GroupOrder of given Ordergroup



167
168
169
 
# File 'app/models/order.rb', line 167

def group_order(ordergroup)
  group_orders.where(ordergroup_id: ordergroup.id).first
end

#include_articles ⇒ Object (protected) 



354
355
356
 
# File 'app/models/order.rb', line 354

def include_articles
  errors.add(:articles, I18n.t('orders.model.error_nosel')) if article_ids.empty?
end

#init_dates ⇒ Object

sets up first guess of dates when initializing a new object I guess ‘def initialize` would work, but it’s tricky stackoverflow.com/questions/1186400



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'app/models/order.rb', line 131

def init_dates
  self.starts ||= Time.now
  if FoodsoftConfig[:order_schedule]
    # try to be smart when picking a reference day
    last = begin
      DateTime.parse(FoodsoftConfig[:order_schedule][:initial])
    rescue StandardError
      nil
    end
    last ||= Order.finished.reorder(:starts).first.try(:starts)
    last ||= self.starts
    # adjust boxfill and end date
    if is_boxfill_useful?
      self.boxfill ||= FoodsoftDateUtil.next_occurrence last, self.starts,
                                                        FoodsoftConfig[:order_schedule][:boxfill]
    end
    self.ends ||= FoodsoftDateUtil.next_occurrence last, self.starts, FoodsoftConfig[:order_schedule][:ends]
  end
  self
end

#is_boxfill_useful? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'app/models/order.rb', line 121

def is_boxfill_useful?
  !!FoodsoftConfig[:use_boxfill] && !!supplier.try(:has_tolerance?)
end

#keep_ordered_articles ⇒ Object (protected) 



358
359
360
361
362
363
364
365
366
 
# File 'app/models/order.rb', line 358

def keep_ordered_articles
  chosen_order_articles = order_articles.where(article_id: article_ids)
  to_be_removed = order_articles - chosen_order_articles
  to_be_removed_but_ordered = to_be_removed.select { |a| a.quantity > 0 || a.tolerance > 0 }
  return if to_be_removed_but_ordered.empty? || ignore_warnings

  errors.add(:articles, I18n.t(stockit? ? 'orders.model.warning_ordered_stock' : 'orders.model.warning_ordered'))
  @erroneous_article_ids = to_be_removed_but_ordered.map { |a| a.article_id }
end

#name ⇒ Object 



64
65
66
 
# File 'app/models/order.rb', line 64

def name
  stockit? ? I18n.t('orders.model.stock') : supplier.name
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'app/models/order.rb', line 101

def open?
  state == 'open'
end

#profit(options = {}) ⇒ Object

Returns the defecit/benefit for the foodcoop Requires a valid invoice, belonging to this order FIXME: Consider order.foodcoop_result



195
196
197
198
199
200
201
 
# File 'app/models/order.rb', line 195

def profit(options = {})
  markup = options[:without_markup] || false
  return unless invoice

  groups_sum = markup ? sum(:groups_without_markup) : sum(:groups)
  groups_sum - invoice.net_amount
end

#received? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'app/models/order.rb', line 109

def received?
  state == 'received'
end

#save_order_articles ⇒ Object (protected) 



368
369
370
371
372
373
374
375
376
377
 
# File 'app/models/order.rb', line 368

def save_order_articles
  # fetch selected articles
  articles_list = Article.find(article_ids)
  # create new order_articles
  (articles_list - articles).each { |article| order_articles.create(article: article) }
  # delete old order_articles
  articles.reject { |article| articles_list.include?(article) }.each do |article|
    order_articles.detect { |order_article| order_article.article_id == article.id }.destroy
  end
end

#send_to_supplier!(user) ⇒ Object 



313
314
315
316
317
318
 
# File 'app/models/order.rb', line 313

def send_to_supplier!(user)
  Mailer.deliver_now_with_default_locale do
    Mailer.order_result_supplier(user, self)
  end
  update!(last_sent_mail: Time.now)
end

#starts_before_ends ⇒ Object (protected) 



344
345
346
347
348
349
350
351
352
 
# File 'app/models/order.rb', line 344

def starts_before_ends
  delta = Rails.env.test? ? 1 : 0 # since Rails 4.2 tests appear to have time differences, with this validation failing
  errors.add(:ends, I18n.t('orders.model.error_starts_before_ends')) if ends && starts && ends <= (starts - delta)
  errors.add(:ends, I18n.t('orders.model.error_boxfill_before_ends')) if ends && boxfill && ends <= (boxfill - delta)
  return unless boxfill && starts && boxfill <= (starts - delta)

  errors.add(:boxfill,
             I18n.t('orders.model.error_starts_before_boxfill'))
end

#stock_group_order ⇒ Object 



171
172
173
 
# File 'app/models/order.rb', line 171

def stock_group_order
  group_orders.where(ordergroup_id: nil).first
end

#stockit? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'app/models/order.rb', line 60

def stockit?
  supplier_id.nil?
end

#sum(type = :gross) ⇒ Object

Returns the all round price of a finished order :groups returns the sum of all GroupOrders :clear returns the price without tax, deposit and markup :gross includes tax and deposit. this amount should be equal to suppliers bill :fc, guess what…



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'app/models/order.rb', line 208

def sum(type = :gross)
  total = 0
  if %i[net gross fc].include?(type)
    for oa in order_articles.ordered.includes(:article, :article_price)
      quantity = oa.units * oa.price.unit_quantity
      case type
      when :net
        total += quantity * oa.price.price
      when :gross
        total += quantity * oa.price.gross_price
      when :fc
        total += quantity * oa.price.fc_price
      end
    end
  elsif %i[groups groups_without_markup].include?(type)
    for go in group_orders.includes(group_order_articles: { order_article: %i[article article_price] })
      for goa in go.group_order_articles
        case type
        when :groups
          total += goa.result * goa.order_article.price.fc_price
        when :groups_without_markup
          total += goa.result * goa.order_article.price.gross_price
        end
      end
    end
  end
  total
end

#supplier_articles ⇒ Object 



81
82
83
84
85
86
87
 
# File 'app/models/order.rb', line 81

def supplier_articles
  if stockit?
    StockArticle.undeleted.reorder('articles.name')
  else
    supplier.articles.undeleted.reorder('articles.name')
  end
end