Class: OpeningHoursConverter::OpeningHoursBuilder

Inherits:
Object
  • Object
show all
Includes:
Constants
Defined in:
lib/opening_hours_converter/opening_hours_builder.rb

Constant Summary

Constants included from Constants

Constants::DAYS, Constants::DAYS_MAX, Constants::EASTER_WEEKDAY, Constants::IRL_DAYS, Constants::IRL_MONTHS, Constants::MINUTES_MAX, Constants::MONTH_END_DAY, Constants::OSM_DAYS, Constants::OSM_DAYS_ABBREVIATIONS, Constants::OSM_MONTHS, Constants::PH_WEEKDAY, Constants::YEAR_DAYS_MAX

Instance Method Summary collapse

Instance Method Details

#build(date_ranges) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 6

def build(date_ranges)
  rules = []

  oh_rules = nil
  oh_rule_added = nil
  range_general = nil
  range_general_for = nil

  date_ranges.each_with_index do |date_range, date_range_index|
    next unless !date_range.nil?

    day_ph = false
    off_day_ph = false
    phs = []

    date_range.typical.intervals.each_with_index do |interval, interval_id|
      next unless interval&.day_start == PH_WEEKDAY && interval&.day_start == interval&.day_end

      if interval.is_off
        off_day_ph = true
      else
        day_ph = true
      end

      phs << interval
      date_range.typical.remove_interval(interval_id)
    end

    day_easter = false
    off_day_easter = false
    easters = []

    date_range.typical.intervals.each_with_index do |interval, interval_id|
      next unless interval&.day_start == EASTER_WEEKDAY && interval&.day_start == interval&.day_end

      if interval.is_off
        off_day_easter = true
      else
        day_easter = true
      end

      easters << interval
      date_range.typical.remove_interval(interval_id)
    end

    range_general = nil
    range_general_for = nil
    range_general_id = date_range_index - 1

    while range_general_id >= 0 && range_general.nil?
      if !date_range.nil?
        general_for = date_ranges[range_general_id].is_general_for?(date_range)
        if date_ranges[range_general_id].has_same_typical?(date_range) && (date_ranges[range_general_id].wide_interval.equals(date_range.wide_interval) || general_for)
          range_general = range_general_id
        elsif general_for && date_ranges[range_general_id].defines_typical_week? && date_range.defines_typical_week?
          range_general_for = range_general_id
        end
      end
      range_general_id -= 1
    end

    next unless date_range_index == 0 || range_general.nil?
    if date_range.defines_typical_week?
      oh_rules = if !range_general_for.nil?
                   build_week_diff(date_range, date_ranges[range_general_for])
                 else
                   build_week(date_range)
                 end
    else
      oh_rules = build_day(date_range)
    end

    oh_rules.each_with_index do |_rule, i|
      oh_rules[i].add_comment(date_range.comment)
    end

    oh_rules.map do |oh_rule|
      oh_rule_added = false
      rule_index = 0

      while !oh_rule_added && rule_index < rules.length
        if rules[rule_index].mergeable?(oh_rule) && rules[rule_index].same_time?(oh_rule) && !rules[rule_index].equals(oh_rule) && rules[rule_index].comment == oh_rule.comment && rules[rule_index].comment != "off" && oh_rule.comment != "off"
          begin
            for date_id in 0...oh_rule.date.length
              rules[rule_index].add_date(oh_rule.date[date_id])
            end
            oh_rule_added = true
          rescue Exception => e
            if oh_rule.date[0].wide_interval.type == 'holiday' && oh_rule.date[0].wide_interval.get_time_selector == 'PH'
              rules[rule_index].add_ph_weekday
              oh_rule_added = true
            elsif rules[rule_index].date[0].wide_interval.type == 'holiday' && rules[rule_index].date[0].wide_interval.get_time_selector == 'PH'
              oh_rule.add_ph_weekday
              rules[rule_index] = oh_rule
              oh_rule_added = true
            else
              rule_index += 1
            end
          end
        else
          rule_index += 1
        end
      end

      if off_day_ph || day_ph
        if date_range.typical.intervals.uniq == [nil]
          oh_rule.date.first.weekdays = [-2]
          if off_day_ph
            oh_rule.is_defined_off = off_day_ph
            phs = []
          else
            phs.reverse.each do |interval|
              oh_rule.add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end))
            end
          end
        else
          if times_are_compatible?(oh_rule, phs)
            holiday_intervals = get_compatible_intervals(oh_rule, phs)
            oh_rule.add_ph_weekday if holiday_intervals[:compatible].length > 0
            rules << oh_rule if !oh_rule_added
            oh_rule_added = true
            holiday_intervals[:incompatible].each do |interval|
              rules += build_off_holiday(date_range) if off_day_ph
              rules += build_holiday(date_range) if day_ph
            end
          else
            rules << oh_rule if !oh_rule_added
            oh_rule_added = true
            rules += build_off_holiday(date_range) if off_day_ph
            rules += build_holiday(date_range) if day_ph
          end
        end
      end

      if off_day_easter || day_easter
        if date_range.typical.intervals.uniq == [nil]
          oh_rule.date.first.weekdays = [EASTER_WEEKDAY]
          if off_day_easter
            oh_rule.is_defined_off = off_day_easter
            easters = []
          else
            easters.reverse.each do |interval|
              oh_rule.add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end))
            end
          end
        else
          if times_are_compatible?(oh_rule, easters)
            easter_intervals = get_compatible_intervals(oh_rule, easters)
            oh_rule.add_easter_weekday if easter_intervals[:compatible].length > 0
            rules << oh_rule if !oh_rule_added
            oh_rule_added = true
            easter_intervals[:incompatible].each do |interval|
              rules += build_off_easter(date_range) if off_day_easter
              rules += build_easter(date_range) if day_easter
            end
          else
            rules << oh_rule if !oh_rule_added
            oh_rule_added = true
            rules += build_off_easter(date_range) if off_day_easter
            rules += build_easter(date_range) if day_easter
          end
        end
      end

      rules << oh_rule if !oh_rule_added

      next unless oh_rule == oh_rules.last && oh_rule.has_overwritten_weekday?
      oh_rule_over = OpeningHoursConverter::OpeningHoursRule.new

      oh_rule.date.each do |date|
        oh_rule_over.add_date(OpeningHoursConverter::OpeningHoursDate.new(date.wide_interval, date.weekdays_over))
      end
      oh_rule_over.add_time(OpeningHoursConverter::OpeningHoursTime.new)
      oh_rules << oh_rule_over
    end
  end

  result = ''
  if rules.empty?
    date_ranges.each do |dr|
      result += "#{dr.wide_interval.get_time_selector} off"
    end
  else
    result += rules.map(&:get).join('; ')
  end

  result = result.strip
  result += " || #{date_ranges.first.fallback_suffix}" if date_ranges.first&.fallback_suffix
  result
end

#build_day(date_range) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 319

def build_day(date_range)
  intervals = date_range.typical.get_intervals(true)

  rule = OpeningHoursConverter::OpeningHoursRule.new
  date = OpeningHoursConverter::OpeningHoursDate.new(date_range.wide_interval, [-1])
  rule.add_date(date)

  intervals.each do |interval|
    if !interval.nil?
      rule.add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end))
      rule.is_defined_off = rule.is_defined_off ? true : interval.is_off
    end
  end

  [rule]
end

#build_easter(date_range) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 286

def build_easter(date_range)
  start_year = date_range.wide_interval.start&.key?(:year) ? date_range.wide_interval.start[:year] : date_range.wide_interval.start
  end_year = date_range.wide_interval.end&.key?(:year) ? date_range.wide_interval.end[:year] : date_range.wide_interval.end
  intervals = date_range.typical.get_intervals(true)

  if date_range.wide_interval.type == 'week'
    intervals.each do |interval|
      date_range.typical.add_interval(OpeningHoursConverter::Interval.new(EASTER_WEEKDAY, interval.start, EASTER_WEEKDAY, interval.end, interval.is_off))
    end
  else
    date_range = OpeningHoursConverter::DateRange.new(OpeningHoursConverter::WideInterval.new.holiday('easter', start_year, end_year))
  end

  for i in 0..6
    intervals.each do |interval|
      if !interval.nil?
        date_range.typical.add_interval(OpeningHoursConverter::Interval.new(i, interval.start, i, interval.end, interval.is_off))
      end
    end
  end
  rule = OpeningHoursConverter::OpeningHoursRule.new
  date = OpeningHoursConverter::OpeningHoursDate.new(date_range.wide_interval, [-1])
  rule.add_date(date)

  date_range.typical.intervals.each do |interval|
    if !interval.nil?
      rule.add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end))
      rule.is_defined_off = rule.is_defined_off || interval.is_off
    end
  end
  [rule]
end

#build_holiday(date_range) ⇒ Object 



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
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 239

def build_holiday(date_range)
  start_year = date_range.wide_interval.start&.key?(:year) ? date_range.wide_interval.start[:year] : date_range.wide_interval.start
  end_year = date_range.wide_interval.end&.key?(:year) ? date_range.wide_interval.end[:year] : date_range.wide_interval.end
  intervals = date_range.typical.get_intervals(true)

  if date_range.wide_interval.type == 'week'
    intervals.each do |interval|
      date_range.typical.add_interval(OpeningHoursConverter::Interval.new(-2, interval.start, -2, interval.end, interval.is_off))
    end
  else
    date_range = OpeningHoursConverter::DateRange.new(OpeningHoursConverter::WideInterval.new.holiday('PH', start_year, end_year))
  end

  for i in 0..6
    intervals.each do |interval|
      if !interval.nil?
        date_range.typical.add_interval(OpeningHoursConverter::Interval.new(i, interval.start, i, interval.end, interval.is_off))
      end
    end
  end
  rule = OpeningHoursConverter::OpeningHoursRule.new
  date = OpeningHoursConverter::OpeningHoursDate.new(date_range.wide_interval, [-1])
  rule.add_date(date)

  date_range.typical.intervals.each do |interval|
    if !interval.nil?
      rule.add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end))
      rule.is_defined_off = rule.is_defined_off || interval.is_off
    end
  end
  [rule]
end

#build_off_easter(date_range) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 272

def build_off_easter(date_range)
  start_year = date_range.wide_interval.start&.key?(:year) ? date_range.wide_interval.start[:year] : date_range.wide_interval.start
  end_year = date_range.wide_interval.end&.key?(:year) ? date_range.wide_interval.end[:year] : date_range.wide_interval.end

  date_range = OpeningHoursConverter::DateRange.new(OpeningHoursConverter::WideInterval.new.holiday('easter', start_year, end_year))

  rule = OpeningHoursConverter::OpeningHoursRule.new
  date = OpeningHoursConverter::OpeningHoursDate.new(date_range.wide_interval, [-1])
  rule.add_date(date)
  rule.is_defined_off = true

  [rule]
end

#build_off_holiday(date_range) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 225

def build_off_holiday(date_range)
  start_year = date_range.wide_interval.start&.key?(:year) ? date_range.wide_interval.start[:year] : date_range.wide_interval.start
  end_year = date_range.wide_interval.end&.key?(:year) ? date_range.wide_interval.end[:year] : date_range.wide_interval.end

  date_range = OpeningHoursConverter::DateRange.new(OpeningHoursConverter::WideInterval.new.holiday('PH', start_year, end_year))

  rule = OpeningHoursConverter::OpeningHoursRule.new
  date = OpeningHoursConverter::OpeningHoursDate.new(date_range.wide_interval, [-1])
  rule.add_date(date)
  rule.is_defined_off = true

  [rule]
end

#build_week(date_range) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 336

def build_week(date_range)
  result = []

  intervals = clean_intervals_keeping_index(date_range.typical)
  days = create_time_intervals(date_range.wide_interval, intervals)

  days_status = Array.new(OSM_DAYS.length, 0)

  days.each_with_index do |day, index|
    if day.is_off? && days_status[index] == 0
      days_status[index] = 8
    elsif day.is_off? && days_status[index] < 0 && days_status[index] > -8
      days_status[index] = -8
      merged = false
      md_off = 0
      while !merged && md_off < index
        if days[md_off].is_off?
          days[md_off].add_weekday(index)
          merged = true
        else
          md_off += 1
        end
        result << days[index] if !merged
      end
    elsif days_status[index] <= 0 && days_status[index] > -8
      days_status[index] = index + 1
      last_same_day = index
      same_day_count = 1

      for j in (index + 1)...days.length do
        next unless day.same_time?(days[j])
        days_status[j] = index + 1
        day.add_weekday(j)
        last_same_day = j
        same_day_count += 1
      end
      if same_day_count == 1
        result << day
      elsif same_day_count == 2
        day.add_weekday(last_same_day)
        result << day
      elsif same_day_count > 2
        day.add_weekday(last_same_day)
        result << day
      end
    end
  end
  result = days if result == [] && days_status == [8, 8, 8, 8, 8, 8, 8]

  result = merge_days(result)

  result
end

#build_week_diff(date_range, general_date_range) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 390

def build_week_diff(date_range, general_date_range)
  intervals = date_range.typical.get_intervals_diff(general_date_range.typical)
  days = create_time_intervals(
    date_range.wide_interval,
    intervals[:open]
  )

  intervals[:closed].each do |interval|
    for i in interval.day_start..interval.day_end do
      days[i].add_time(OpeningHoursConverter::OpeningHoursTime.new)
    end
  end

  days_status = Array.new(OSM_DAYS.length, 0)
  result = []

  days.each_with_index do |day, index|
    if day.is_off? && day.time.length == 1
      days_status[index] = -8
      merged = false
      md_off = 0

      while !merged && md_off < index
        if days[md_off].is_off? && days[md_off].time.length == 1
          days[md_off].add_weekday(index)
          merged = true
        else
          md_off += 1
        end
      end

      result << day if !merged
    elsif day.is_off? && day.time.empty?
      days_status[index] = 8
    elsif days_status[index] <= 0 && days_status[index] > -8
      days_status[index] = index + 1
      same_day_count = 1
      last_same_day = 1
      result << day

      for j in (index + 1)...days.length do
        next unless day.same_time?(days[j])
        days_status[j] = index + 1
        day.add_weekday(j)
        last_same_day = j
        same_day_count += 1
      end

      if same_day_count == 1
        result << day
      elsif same_day_count == 2
        day.add_weekday(last_same_day)
        result << day
      elsif same_day_count > 2
        for j in (index + 1)...last_same_day do
          next unless days_status[j] == 0
          days_status[j] = -index - 1
          day.add_overwritten_weekday(j) if !days[j].time.empty?
        end
        day.add_weekday(last_same_day)
        result << day
      end

    end
  end
  result = merge_days(result)
  result
end

#carries_metadata?(interval) ⇒ Boolean

Returns:

  • (Boolean) 


500
501
502
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 500

def carries_metadata?(interval)
  !interval.index.nil? || interval.is_unknown || interval.open_ended
end

#clean_intervals_keeping_index(typical) ⇒ Object

An index ("We"), the "unknown" state, and an open-ended time ("18:00+") don't survive Week#get_intervals(true), which rebuilds intervals from a per-minute true/false/"off" grid that has no room for any of them. All three are pulled out first and passed through untouched instead; none of them can collide with anything the grid pass produces (an index never applies to more than a single day, and "unknown"/open-ended are only ever full-interval markers here).



491
492
493
494
495
496
497
498
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 491

def clean_intervals_keeping_index(typical)
  special = typical.intervals.compact.select { |interval| carries_metadata?(interval) }
  return typical.get_intervals(true) if special.empty?

  plain = OpeningHoursConverter::Week.new
  typical.intervals.compact.each { |interval| plain.add_interval(interval) unless carries_metadata?(interval) }
  plain.get_intervals(true) + special
end

#create_time_intervals(wide_interval, intervals) ⇒ Object 



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 504

def create_time_intervals(wide_interval, intervals)
  days = []

  for i in 0...7
    days << OpeningHoursConverter::OpeningHoursRule.new
    days[i].add_date(OpeningHoursConverter::OpeningHoursDate.new(wide_interval, [i]))
  end

  intervals.each do |interval|
    next if interval.nil?

    begin
      if interval.day_start == interval.day_end
        days[interval.day_start].add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, interval.end, interval.open_ended))
        days[interval.day_start].is_defined_off = days[interval.day_start].is_defined_off ? true : interval.is_off
        days[interval.day_start].is_defined_unknown = days[interval.day_start].is_defined_unknown ? true : interval.is_unknown
        if interval.index
          # One weekday can carry several intervals, one per entry of its
          # index list ("Sa[2],Sa[4]"), and the list is their union.
          date = days[interval.day_start].date.first
          date.weekday_index = Array(date.weekday_index) | interval.index
        end
      elsif interval.day_end - interval.day_start == 1
        days[interval.day_start].add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, MINUTES_MAX))
        days[interval.day_start].is_defined_off = days[interval.day_start].is_defined_off ? true : interval.is_off
        days[interval.day_start].is_defined_unknown = days[interval.day_start].is_defined_unknown ? true : interval.is_unknown
        days[interval.day_end].add_time(OpeningHoursConverter::OpeningHoursTime.new(0, interval.end))
        days[interval.day_end].is_defined_off = days[interval.day_end].is_defined_off ? true : interval.is_off
        days[interval.day_end].is_defined_unknown = days[interval.day_end].is_defined_unknown ? true : interval.is_unknown
      else
        for j in interval.day_start..interval.day_end
          days[j].is_defined_off = days[j].is_defined_off ? true : interval.is_off
          days[j].is_defined_unknown = days[j].is_defined_unknown ? true : interval.is_unknown
          if j == interval.day_start
            days[j].add_time(OpeningHoursConverter::OpeningHoursTime.new(interval.start, MINUTES_MAX))
          elsif j == interval.day_end
            days[j].add_time(OpeningHoursConverter::OpeningHoursTime.new(0, interval.end))
          else
            days[j].add_time(OpeningHoursConverter::OpeningHoursTime.new(0, MINUTES_MAX))
          end
        end
      end
    rescue Exception => e
      puts e
    end
  end

  days
end

#get_compatible_intervals(oh_rule, phs) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 209

def get_compatible_intervals(oh_rule, phs)
  compatibility = {
    compatible: [],
    incompatible: []
  }

  compatibility[:compatible] = phs.select do |ph_interval|
    return false if ph_interval.is_off != oh_rule.is_defined_off

    oh_rule.time.any? { |rule_time| rule_time.start == ph_interval.start && rule_time.end == ph_interval.end }
  end
  compatibility[:incompatible] = phs - compatibility[:compatible]

  compatibility
end

#merge_days(rules) ⇒ Object 



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 459

def merge_days(rules)
  return rules if rules.empty?
  result = []
  result << rules[0]
  dm = 0

  for d in 1...rules.length do
    date_merged = false
    dm = 0
    while !date_merged && dm < d
      if rules[dm].same_time?(rules[d])
        wds = rules[d].date[0].weekdays
        wds.each do |wd|
          rules[dm].add_weekday(wd)
        end
        date_merged = true
      end
      dm += 1
    end
    result << rules[d] if !date_merged
  end

  result
end

#times_are_compatible?(oh_rule, phs) ⇒ Boolean

Returns:

  • (Boolean) 


197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/opening_hours_converter/opening_hours_builder.rb', line 197

def times_are_compatible?(oh_rule, phs)
  if oh_rule.is_defined_off
    phs.any?(&:is_off)
  else
    phs.any? do |ph_interval|
      oh_rule.time.any? do |rule_time|
        rule_time.start == ph_interval.start && rule_time.end == ph_interval.end
      end
    end
  end
end