Module: SifttterRedux::DateRangeMaker

Defined in:
lib/sifttter-redux/date-range-maker.rb

Overview

DateRangeMaker Module Returns a Range of dates based on supplied parameters

Class Method Summary collapse

Class Method Details

.last_n_days(num_days, include_today = false) ⇒ Range

Returns a date range for the last N days (including today’s date if specified).

Parameters:

  • num_days (Integer) —

    The number of days to look back

  • include_today (Boolean) (defaults to: false) —

    Should today be included?

Returns:

  • (Range) 


12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/sifttter-redux/date-range-maker.rb', line 12

def self.last_n_days(num_days, include_today = false)
  if num_days < 0
    error = 'Cannot specify a negative number of days'
    fail ArgumentError, error
  end

  if include_today
    (Date.today - num_days..Date.today)
  else
    (Date.today - num_days...Date.today)
  end
end

.last_n_weeks(num_weeks = 0, include_today = false) ⇒ Range

Returns a date range for the last N weeks (including today’s date if specified).

Parameters:

  • num_days (Integer) —

    The number of weeks to look back

  • include_today (Boolean) (defaults to: false) —

    Should today be included?

Returns:

  • (Range) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/sifttter-redux/date-range-maker.rb', line 30

def self.last_n_weeks(num_weeks = 0, include_today = false)
  if num_weeks < 0
    error = 'Cannot specify a negative number of weeks'
    fail ArgumentError, error
  end

  beginning_date = Date.today - Date.today.wday + 1
  end_date = Date.today - Date.today.wday + 7

  # We coerce the end date to be today if a date
  # greater than today has been specified.
  end_date = Date.today if end_date > Date.today

  if include_today
    (beginning_date - num_weeks * 7..end_date)
  else
    (beginning_date - num_weeks * 7...end_date)
  end
end

.range(start_date, end_date, include_today = false) ⇒ Range

Returns a date range for specified start dates and end dates. Note that specifying an end date greater than today’s date will force today to be the end date.

Parameters:

  • start_date (Start) —

    The start date

  • end_date (Date) —

    The end date

  • options (Hash) —

    Miscellaneous options

Returns:

  • (Range) 


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
 
# File 'lib/sifttter-redux/date-range-maker.rb', line 57

def self.range(start_date, end_date, include_today = false)
  if start_date.nil? && !end_date.nil?
    error = "You can't specify -t without specifying -f"
    fail ArgumentError, error
  end

  begin
    chronic_start_date = Chronic.parse(start_date).to_date
  rescue
    unless start_date.nil?
      error = "Invalid date provided to Chronic: #{ start_date }"
      fail ArgumentError, error
    end
    nil
  end

  begin
    chronic_end_date = Chronic.parse(end_date).to_date
  rescue
    unless end_date.nil?
      error = "Invalid date provided to Chronic: #{ end_date }"
      fail ArgumentError, error
    end
    nil
  end

  if chronic_end_date && chronic_start_date > chronic_end_date
    error = 'The start date must be before or equal to the end date'
    fail ArgumentError, error
  end

  unless chronic_start_date.nil?
    if chronic_end_date.nil?
      if include_today
        (chronic_start_date..Date.today)
      else
        (chronic_start_date...Date.today)
      end
    else
      (chronic_start_date..chronic_end_date)
    end
  end
end

.today ⇒ Range

Returns a date range for today

Returns:

  • (Range) 


103
104
105
 
# File 'lib/sifttter-redux/date-range-maker.rb', line 103

def self.today
  (Date.today..Date.today)
end

.yesterday ⇒ Range

Returns a date range for yesterday

Returns:

  • (Range) 


109
110
111
 
# File 'lib/sifttter-redux/date-range-maker.rb', line 109

def self.yesterday
  (Date.today - 1..Date.today - 1)
end