Module: Calculon::ClassMethods

Defined in:
lib/calculon.rb

Instance Method Summary collapse

Instance Method Details

#between(starttime, endtime, opts = nil) ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/calculon.rb', line 39

def between(starttime, endtime, opts = nil)
  opts = default_calculon_opts.merge(opts || {})
  relation = where ["#{opts[:time_column]} >= ? and #{opts[:time_column]} <= ?", starttime, endtime]
  relation.calculon_opts ||= {}
  relation.calculon_opts.merge!(:starttime => starttime, :endtime => endtime)
  relation
end

#by_bucket(bucket_name, bucket, cols, opts = nil) ⇒ Object 



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

def by_bucket(bucket_name, bucket, cols, opts = nil)
  opts = default_calculon_opts.merge(opts || {})
  # allow group by to be either single symbol or array of symbols
  opts[:group_by] = [opts[:group_by]].flatten

  unless ActiveRecord::Base.connection.adapter_name == "Mysql2"
    raise "Mysql2 is the only supported connection adapter for calculon"
  end

  # Set column in bucket string.  This should be based on localtime, in case there are some points
  # that fall on both sides of a date - so group by this conversion.  The 'where' doesn't
  # need this conversion because Rails does this automatically before calling the query
  # (see http://api.rubyonrails.org/classes/ActiveRecord/Base.html#method-c-default_timezone)
  time_column = "CONVERT_TZ(#{opts[:time_column]}, '+00:00', '#{Time.zone.now.formatted_offset}')"
  bucket = bucket % { :time_column => time_column }

  # if we're grouping by other columns, we need to select them
  groupby = opts[:group_by] + ["time_bucket"]
  opts[:group_by].each { |c| cols[c] = nil }
  cols = cols.map { |name, method|
    asname = name.to_s.gsub(' ', '').tr('^A-Za-z0-9', '_')
    method.nil? ? name : "#{method}(#{name}) as #{asname}"
  } + ["#{bucket} as time_bucket"]

  relation = select(cols.join(",")).group(*groupby).order("time_bucket ASC")
  relation.calculon_opts ||= {}
  relation.calculon_opts.merge!(opts)
  relation.calculon_opts[:bybucket] = bucket_name
  relation
end

#by_day(cols, opts = nil) ⇒ Object 



56
57
58
 
# File 'lib/calculon.rb', line 56

def by_day(cols, opts = nil)
  by_bucket :day, "concat(date(%{time_column}),' 00:00:00')", cols, opts
end

#by_hour(cols, opts = nil) ⇒ Object 



52
53
54
 
# File 'lib/calculon.rb', line 52

def by_hour(cols, opts = nil)
  by_bucket :hour, "concat(date(%{time_column}),' ',lpad(hour(%{time_column}),2,'0'),':00:00')", cols, opts
end

#by_minute(cols, opts = nil) ⇒ Object 



47
48
49
50
 
# File 'lib/calculon.rb', line 47

def by_minute(cols, opts = nil)
  tcol = "concat(date(%{time_column}),' ',lpad(hour(%{time_column}),2,'0'),':',lpad(minute(%{time_column}),2,'0'),':00')"
  by_bucket :minute, tcol, cols, opts
end

#by_month(cols, opts = nil) ⇒ Object 



60
61
62
 
# File 'lib/calculon.rb', line 60

def by_month(cols, opts = nil)
  by_bucket :month, "concat(year(%{time_column}),'-',lpad(month(%{time_column}),2,'0'),'-01 00:00:00')", cols, opts
end

#by_year(cols, opts = nil) ⇒ Object 



64
65
66
 
# File 'lib/calculon.rb', line 64

def by_year(cols, opts = nil)
  by_bucket :year, "concat(year(%{time_column}),'-01-01 00:00:00')", cols, opts
end

#calculon_view(name, cols, opts = nil) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/calculon.rb', line 12

def calculon_view(name, cols, opts = nil)
  metaclass = class << self; self; end
  metaclass.instance_eval do
    ["minute", "hour", "day", "month", "year"].each do |window|
      define_method("#{name}_by_#{window}") { |nopts = nil|
        nopts = (opts || {}).merge(nopts || {})
        # clone cols so modifications downstream don't affect our original copy here
        send("by_#{window}".intern, cols.clone, nopts)
      }
    end
  end
end

#default_calculon_opts ⇒ Object 



29
30
31
32
 
# File 'lib/calculon.rb', line 29

def default_calculon_opts
  @@calculon_time_column ||= "created_at"
  { :time_column => @@calculon_time_column, :group_by => [] }
end

#default_time_column(column) ⇒ Object 



25
26
27
 
# File 'lib/calculon.rb', line 25

def default_time_column(column)
  @@calculon_time_column = column
end

#on(date) ⇒ Object 



34
35
36
37
 
# File 'lib/calculon.rb', line 34

def on(date)
  raise "'on' method takes a Date object as the first param" unless date.is_a?(Date)
  between date.to_time, date.to_time + 86399.seconds
end