Class: Groupdate::SeriesBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdate/series_builder.rb

Constant Summary collapse

CHECK_PERIODS = 
[:day, :week, :month, :quarter, :year]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(period:, time_zone:, day_start:, week_start:, **options) ⇒ SeriesBuilder

Returns a new instance of SeriesBuilder.



7
8
9
10
11
12
13
14
15
 
# File 'lib/groupdate/series_builder.rb', line 7

def initialize(period:, time_zone:, day_start:, week_start:, **options)
  @period = period
  @time_zone = time_zone
  @week_start = week_start
  @day_start = day_start
  @options = options
  @round_time = {}
  @week_start_key = Groupdate::Magic::DAYS[@week_start] if @week_start
end

Instance Attribute Details

#day_start ⇒ Object (readonly)

Returns the value of attribute day_start.



3
4
5
 
# File 'lib/groupdate/series_builder.rb', line 3

def day_start
  @day_start
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



3
4
5
 
# File 'lib/groupdate/series_builder.rb', line 3

def options
  @options
end

#period ⇒ Object (readonly)

Returns the value of attribute period.



3
4
5
 
# File 'lib/groupdate/series_builder.rb', line 3

def period
  @period
end

#time_zone ⇒ Object (readonly)

Returns the value of attribute time_zone.



3
4
5
 
# File 'lib/groupdate/series_builder.rb', line 3

def time_zone
  @time_zone
end

#week_start ⇒ Object (readonly)

Returns the value of attribute week_start.



3
4
5
 
# File 'lib/groupdate/series_builder.rb', line 3

def week_start
  @week_start
end

Instance Method Details

#change_zone ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/groupdate/series_builder.rb', line 132

def change_zone
  @change_zone ||= begin
    if ActiveSupport::VERSION::STRING >= "5.2"
      ->(time, zone) { time.change(zone: zone) }
    else
      # TODO make more efficient
      ->(time, zone) { zone.parse(time.strftime("%Y-%m-%d %H:%M:%S")) }
    end
  end
end

#format_series_label(series_label) ⇒ Object 



76
77
78
79
 
# File 'lib/groupdate/series_builder.rb', line 76

def format_series_label(series_label)
  series_label = round_time(series_label) if series_label.respond_to?(:to_time)
  key_format.call(series_label)
end

#generate(data, default_value:, series_default: true, multiple_groups: false, group_index: nil) ⇒ Object 



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
 
# File 'lib/groupdate/series_builder.rb', line 17

def generate(data, default_value:, series_default: true, multiple_groups: false, group_index: nil)
  series = generate_series(data, multiple_groups, group_index)
  series = handle_multiple(data, series, multiple_groups, group_index)

  verified_data = {}
  series.each do |k|
    verified_data[k] = data.delete(k)
  end

  # this is a fun one
  # PostgreSQL and Ruby both return the 2nd hour when converting/parsing a backward DST change
  # Other databases and Active Support return the 1st hour (as expected)
  # Active Support good: ActiveSupport::TimeZone["America/Los_Angeles"].parse("2013-11-03 01:00:00")
  # MySQL good: SELECT CONVERT_TZ('2013-11-03 01:00:00', 'America/Los_Angeles', 'Etc/UTC');
  # SQLServer good: SELECT CAST('2013-11-03 01:00:00' AS DATETIME2(3)) AT TIME ZONE 'Pacific Standard Time' AT TIME ZONE 'UTC'
  # Ruby not good: Time.parse("2013-11-03 01:00:00")
  # PostgreSQL not good: SELECT '2013-11-03 01:00:00'::timestamp AT TIME ZONE 'America/Los_Angeles';
  # we need to account for this here
  if series_default && CHECK_PERIODS.include?(period)
    data.each do |k, v|
      key = multiple_groups ? k[group_index] : k
      # TODO only do this for PostgreSQL
      # this may mask some inconsistent time zone errors
      # but not sure there's a better approach
      if key.hour == (key - 1.hour).hour && series.include?(key - 1.hour)
        key -= 1.hour
        if multiple_groups
          k[group_index]  = key
        else
          k = key
        end
        verified_data[k] = v
      elsif key != round_time(key)
        # only need to show what database returned since it will cast in Ruby time zone
        # raise Groupdate::Error, "Database and Ruby have inconsistent time zone info. Database returned #{key}: #{round_time(key)}"
      end
    end
  end

  unless entire_series?(series_default)
    series = series.select { |k| verified_data[k] }
  end

  value = 0
  result = Hash[series.map do |k|
    value = verified_data[k] || (@options[:carry_forward] && value) || default_value
    key =
      if multiple_groups
        k[0...group_index] + [key_format.call(k[group_index])] + k[(group_index + 1)..-1]
      else
        key_format.call(k)
      end

    [key, value]
  end]

  result
end

#round_time(time) ⇒ Object 



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
 
# File 'lib/groupdate/series_builder.rb', line 81

def round_time(time)
  time = time.to_time.in_time_zone(time_zone)

  if day_start != 0
    # apply day_start to a time object that's not affected by DST
    time = change_zone.call(time, utc)
    time -= day_start.seconds
  end

  time =
    case period
    when :second
      time.change(usec: 0)
    when :minute
      time.change(sec: 0)
    when :hour
      time.change(min: 0)
    when :day
      time.beginning_of_day
    when :week
      time.beginning_of_week(@week_start_key)
    when :month
      time.beginning_of_month
    when :quarter
      time.beginning_of_quarter
    when :year
      time.beginning_of_year
    when :hour_of_day
      time.hour
    when :minute_of_hour
      time.min
    when :day_of_week
      time.days_to_week_start(@week_start_key)
    when :day_of_month
      time.day
    when :month_of_year
      time.month
    when :day_of_year
      time.yday
    else
      raise Groupdate::Error, "Invalid period"
    end

  if day_start != 0 && time.is_a?(Time)
    time += day_start.seconds
    time = change_zone.call(time, time_zone)
  end

  time
end

#time_range ⇒ Object 



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
 
# File 'lib/groupdate/series_builder.rb', line 143

def time_range
  @time_range ||= begin
    time_range = options[:range]
    if time_range.is_a?(Range) && time_range.first.is_a?(Date)
      # convert range of dates to range of times
      last = time_range.last.in_time_zone(time_zone)
      last += 1.day unless time_range.exclude_end?
      time_range = Range.new(time_range.first.in_time_zone(time_zone), last, true)
    elsif !time_range && options[:last]
      if period == :quarter
        step = 3.months
      elsif 1.respond_to?(period)
        step = 1.send(period)
      else
        raise ArgumentError, "Cannot use last option with #{period}"
      end
      if step
        # loop instead of multiply to change start_at - see #151
        start_at = now
        (options[:last].to_i - 1).times do
          start_at -= step
        end

        time_range =
          if options[:current] == false
            round_time(start_at - step)...round_time(now)
          else
            # extend to end of current period
            round_time(start_at)...(round_time(now) + step)
          end
      end
    end
    time_range
  end
end