Module: TimeChunk

Defined in:
lib/time_chunk.rb

Class Method Summary collapse

Class Method Details

.each_day(range) ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'lib/time_chunk.rb', line 15

def self.each_day(range)
  # if we're given a date range, yield individual dates instead of a range.
  if range.begin.is_a?(Date)
    iterate(range, 86400) {|chunk| yield chunk.begin }
  # otherwise yield a range like all other methods do.
  else
    iterate(range, 86400, &Proc.new)
  end
end

.each_hour(range) ⇒ Object 



11
12
13
 
# File 'lib/time_chunk.rb', line 11

def self.each_hour(range)
  iterate(range, 3600, &Proc.new)
end

.each_minute(range) ⇒ Object 



5
6
7
8
9
 
# File 'lib/time_chunk.rb', line 5

def self.each_minute(range)
  # &Proc.new : return a proc containing the block passed to the method
  # http://www.ruby-doc.org/core-1.9.3/Proc.html#method-c-new
  iterate(range, 60, &Proc.new)
end

.iterate(range, step_size) ⇒ Object

Iterate over any date or time range, yielding a range of no more than step_size duration (in seconds.) The final yielded range may be smaller than step_size if the total range is not a perfect multiple of the step_size.

String arguments will be parsed into Times, and yield Time ranges. Date ranges will yield Date ranges. Note that step_size is always in seconds

even for date ranges. If this feels weird, see iterate_days instead.

Raises:

  • (ArgumentError) 


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

def self.iterate(range, step_size)
  if range.first.is_a?(Time)
    begin_at = range.first
    end_at = range.last.is_a?(Time) ? range.last : Time.parse(range.last.to_s)
  elsif range.first.is_a?(Date)
    begin_at = range.first
    end_at = range.last.is_a?(Date) ? range.last : Date.parse(range.last.to_s)
    # step size is always seconds, regardless of whether range is Time or Date instances
    step_size = step_size/86400
  else
    begin_at = Time.parse(range.first.to_s)
    end_at = Time.parse(range.last.to_s)
  end

  raise ArgumentError, "Given range's begin (#{begin_at.to_time.utc.iso8601}) is after its end (#{end_at.to_time.utc.iso8601})." if begin_at > end_at

  current_end = begin_at - 1

  begin
    current_begin = current_end + 1
    current_end = current_begin + step_size - 1
    current_end = [current_end, end_at].min

    yield current_begin..current_end
  end while current_end < end_at
end

.iterate_days(range, step_size) ⇒ Object

Same as iterate, but with step_size specified in days instead of seconds.



60
61
62
63
64
65
66
 
# File 'lib/time_chunk.rb', line 60

def self.iterate_days(range, step_size)
  if ! range.begin.is_a?(Date) || ! range.end.is_a?(Date)
    raise ArgumentError, "iterate_days requires a range of dates."
  end

  iterate(range, step_size*86400, &Proc.new)
end