Class: Groupdate::Magic

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(field, options) ⇒ Magic

Returns a new instance of Magic.

Raises:



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

def initialize(field, options)
  @field = field
  @options = options

  raise Groupdate::Error, "Unrecognized time zone" unless time_zone

  raise Groupdate::Error, "Unrecognized :week_start option" if field == :week && !week_start
end

Instance Attribute Details

#field ⇒ Object

Returns the value of attribute field.



5
6
7
 
# File 'lib/groupdate/magic.rb', line 5

def field
  @field
end

#options ⇒ Object

Returns the value of attribute options.



5
6
7
 
# File 'lib/groupdate/magic.rb', line 5

def options
  @options
end

Instance Method Details

#group_by(enum, &_block) ⇒ Object 



16
17
18
19
 
# File 'lib/groupdate/magic.rb', line 16

def group_by(enum, &_block)
  group = enum.group_by { |v| v = yield(v); v ? round_time(v) : nil }
  series(group, [], false, false, false)
end

#perform(relation, method, *args, &block) ⇒ Object 



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

def perform(relation, method, *args, &block)
  # undo reverse since we do not want this to appear in the query
  reverse = relation.send(:reverse_order_value)
  relation = relation.except(:reverse_order) if reverse
  order = relation.order_values.first
  if order.is_a?(String)
    parts = order.split(" ")
    reverse_order = (parts.size == 2 && (parts[0].to_sym == field || (activerecord42? && parts[0] == "#{relation.quoted_table_name}.#{relation.quoted_primary_key}")) && parts[1].to_s.downcase == "desc")
    if reverse_order
      reverse = !reverse
      relation = relation.reorder(relation.order_values[1..-1])
    end
  end

  multiple_groups = relation.group_values.size > 1

  cast_method =
    case field
    when :day_of_week, :hour_of_day, :day_of_month, :month_of_year
      lambda { |k| k.to_i }
    else
      utc = ActiveSupport::TimeZone["UTC"]
      lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
    end

  result = relation.send(method, *args, &block)
  missing_time_zone_support = multiple_groups ? (result.keys.first && result.keys.first[@group_index].nil?) : result.key?(nil)
  if missing_time_zone_support
    raise Groupdate::Error, "Be sure to install time zone support - https://github.com/ankane/groupdate#for-mysql"
  end
  result = Hash[result.map { |k, v| [multiple_groups ? k[0...@group_index] + [cast_method.call(k[@group_index])] + k[(@group_index + 1)..-1] : cast_method.call(k), v] }]

  series(result, (options.key?(:default_value) ? options[:default_value] : 0), multiple_groups, reverse)
end

#relation(column, relation) ⇒ Object 



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

def relation(column, relation)
  if relation.default_timezone == :local
    raise Groupdate::Error, "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
  end

  time_zone = self.time_zone.tzinfo.name

  adapter_name = relation.connection.adapter_name
  query =
    case adapter_name
    when "MySQL", "Mysql2", "Mysql2Spatial"
      case field
      when :day_of_week # Sunday = 0, Monday = 1, etc
        # use CONCAT for consistent return type (String)
        ["DAYOFWEEK(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)) - 1", time_zone]
      when :hour_of_day
        ["(EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?)) + 24 - #{day_start / 3600}) % 24", time_zone]
      when :day_of_month
        ["DAYOFMONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?))", time_zone]
      when :month_of_year
        ["MONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?))", time_zone]
      when :week
        ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL ((#{7 - week_start} + WEEKDAY(CONVERT_TZ(#{column}, '+00:00', ?) - INTERVAL #{day_start} second)) % 7) DAY) - INTERVAL #{day_start} second, '+00:00', ?), '%Y-%m-%d 00:00:00') + INTERVAL #{day_start} second, ?, '+00:00')", time_zone, time_zone, time_zone]
      when :quarter
        ["DATE_ADD(CONVERT_TZ(DATE_FORMAT(DATE(CONCAT(EXTRACT(YEAR FROM CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)), '-', LPAD(1 + 3 * (QUARTER(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)) - 1), 2, '00'), '-01')), '%Y-%m-%d %H:%i:%S'), ?, '+00:00'), INTERVAL #{day_start} second)", time_zone, time_zone, time_zone]
      else
        format =
          case field
          when :second
            "%Y-%m-%d %H:%i:%S"
          when :minute
            "%Y-%m-%d %H:%i:00"
          when :hour
            "%Y-%m-%d %H:00:00"
          when :day
            "%Y-%m-%d 00:00:00"
          when :month
            "%Y-%m-01 00:00:00"
          else # year
            "%Y-01-01 00:00:00"
          end

        ["DATE_ADD(CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?), '#{format}'), ?, '+00:00'), INTERVAL #{day_start} second)", time_zone, time_zone]
      end
    when "PostgreSQL", "PostGIS"
      case field
      when :day_of_week
        ["EXTRACT(DOW from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
      when :hour_of_day
        ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
      when :day_of_month
        ["EXTRACT(DAY from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
      when :month_of_year
        ["EXTRACT(MONTH from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
      when :week # start on Sunday, not PostgreSQL default Monday
        ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{week_start} day' - INTERVAL '#{day_start} second') AT TIME ZONE ?) + INTERVAL '#{week_start} day' + INTERVAL '#{day_start} second') AT TIME ZONE ?", time_zone, time_zone]
      else
        ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{day_start} second') AT TIME ZONE ?) + INTERVAL '#{day_start} second') AT TIME ZONE ?", time_zone, time_zone]
      end
    when "SQLite"
      raise Groupdate::Error, "Time zones not supported for SQLite" unless self.time_zone.utc_offset.zero?
      raise Groupdate::Error, "day_start not supported for SQLite" unless day_start.zero?
      raise Groupdate::Error, "week_start not supported for SQLite" unless week_start == 6

      if field == :week
        ["strftime('%%Y-%%m-%%d 00:00:00 UTC', #{column}, '-6 days', 'weekday 0')"]
      else
        format =
          case field
            when :hour_of_day
              "%H"
            when :day_of_week
              "%w"
            when :day_of_month
              "%d"
            when :month_of_year
              "%m"
            when :second
              "%Y-%m-%d %H:%M:%S UTC"
            when :minute
              "%Y-%m-%d %H:%M:00 UTC"
            when :hour
              "%Y-%m-%d %H:00:00 UTC"
            when :day
              "%Y-%m-%d 00:00:00 UTC"
            when :month
              "%Y-%m-01 00:00:00 UTC"
            when :quarter
              raise Groupdate::Error, "Quarter not supported for SQLite"
            else # year
              "%Y-01-01 00:00:00 UTC"
            end

        ["strftime('#{format.gsub(/%/, '%%')}', #{column})"]
      end
    when "Redshift"
      case field
      when :day_of_week # Sunday = 0, Monday = 1, etc.
        ["EXTRACT(DOW from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
      when :hour_of_day
        ["EXTRACT(HOUR from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
      when :day_of_month
        ["EXTRACT(DAY from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
      when :month_of_year
        ["EXTRACT(MONTH from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
      when :week # start on Sunday, not Redshift default Monday
        # Redshift does not return timezone information; it
        # always says it is in UTC time, so we must convert
        # back to UTC to play properly with the rest of Groupdate.
        #
        ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, CONVERT_TIMEZONE(?, #{column}) - INTERVAL '#{week_start} day' - INTERVAL '#{day_start} second'))::timestamp + INTERVAL '#{week_start} day' + INTERVAL '#{day_start} second'", time_zone, field, time_zone]
      else
        ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, CONVERT_TIMEZONE(?, #{column}) - INTERVAL '#{day_start} second'))::timestamp + INTERVAL '#{day_start} second'", time_zone, field, time_zone]
      end
    else
      raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}"
    end

  if adapter_name == "MySQL" && field == :week
    query[0] = "CAST(#{query[0]} AS DATETIME)"
  end

  group = relation.group(Groupdate::OrderHack.new(relation.send(:sanitize_sql_array, query), field, time_zone))
  relation =
    if time_range.is_a?(Range)
      # doesn't matter whether we include the end of a ... range - it will be excluded later
      group.where("#{column} >= ? AND #{column} <= ?", time_range.first, time_range.last)
    else
      group.where("#{column} IS NOT NULL")
    end

  # TODO do not change object state
  @group_index = group.group_values.size - 1

  Groupdate::Series.new(self, relation)
end