Class: Date

Inherits:
Object show all
Includes:
DateAndTime::Calculations
Defined in:
motion/_stdlib/date.rb,
motion/core_ext/date/acts_like.rb,
motion/core_ext/date/conversions.rb,
motion/core_ext/date/calculations.rb

Constant Summary collapse

DATE_FORMATS =
{
  :short        => '%e %b',
  :long         => '%B %e, %Y',
  :db           => '%Y-%m-%d',
  :number       => '%Y%m%d',
  :long_ordinal => lambda { |date|
    day_format = MotionSupport::Inflector.ordinalize(date.day)
    date.strftime("%B #{day_format}, %Y") # => "April 25th, 2007"
  },
  :rfc822       => '%e %b %Y'
}

Constants included from DateAndTime::Calculations

DateAndTime::Calculations::DAYS_INTO_WEEK

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DateAndTime::Calculations

#beginning_of_month, #beginning_of_quarter, #beginning_of_week, #beginning_of_year, #days_ago, #days_since, #days_to_week_start, #end_of_month, #end_of_quarter, #end_of_week, #end_of_year, #future?, #monday, #months_ago, #months_since, #next_month, #next_quarter, #next_week, #next_year, #past?, #prev_month, #prev_quarter, #prev_week, #prev_year, #sunday, #today?, #tomorrow, #weeks_ago, #weeks_since, #years_ago, #years_since, #yesterday

Constructor Details

#initialize(year = nil, month = nil, day = nil) ⇒ Date

Returns a new instance of Date


14
15
16
17
18
19
20
# File 'motion/_stdlib/date.rb', line 14

def initialize(year = nil, month = nil, day = nil)
  if year && month && day
    @value = Time.utc(year, month, day)
  else
    @value = Time.now
  end
end

Class Attribute Details

.beginning_of_week_defaultObject

Returns the value of attribute beginning_of_week_default


7
8
9
# File 'motion/core_ext/date/calculations.rb', line 7

def beginning_of_week_default
  @beginning_of_week_default
end

Class Method Details

.beginning_of_weekObject

Returns the week start (e.g. :monday) for the current request, if this has been set (via Date.beginning_of_week=). If Date.beginning_of_week has not been set for the current request, returns the week start specified in config.beginning_of_week. If no config.beginning_of_week was specified, returns :monday.


12
13
14
# File 'motion/core_ext/date/calculations.rb', line 12

def beginning_of_week
  Thread.current[:beginning_of_week] || beginning_of_week_default || :monday
end

.beginning_of_week=(week_start) ⇒ Object

Sets Date.beginning_of_week to a week start (e.g. :monday) for current request/thread.

This method accepts any of the following day symbols: :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday


20
21
22
# File 'motion/core_ext/date/calculations.rb', line 20

def beginning_of_week=(week_start)
  Thread.current[:beginning_of_week] = find_beginning_of_week!(week_start)
end

.currentObject

Alias for Date.today.


41
42
43
# File 'motion/core_ext/date/calculations.rb', line 41

def current
  ::Date.today
end

.find_beginning_of_week!(week_start) ⇒ Object

Returns week start day symbol (e.g. :monday), or raises an ArgumentError for invalid day symbol.

Raises:

  • (ArgumentError)

25
26
27
28
# File 'motion/core_ext/date/calculations.rb', line 25

def find_beginning_of_week!(week_start)
  raise ArgumentError, "Invalid beginning of week: #{week_start}" unless ::Date::DAYS_INTO_WEEK.key?(week_start)
  week_start
end

.gregorian_leap?(year) ⇒ Boolean

Returns:

  • (Boolean)

2
3
4
5
6
7
8
9
10
11
12
# File 'motion/_stdlib/date.rb', line 2

def self.gregorian_leap?(year)
  if year % 400 == 0
    true
  elsif year % 100 == 0 then
    false
  elsif year % 4 == 0 then
    true
  else
    false
  end
end

.todayObject


22
23
24
# File 'motion/_stdlib/date.rb', line 22

def self.today
  new
end

.tomorrowObject

Returns a new Date representing the date 1 day after today (i.e. tomorrow's date).


36
37
38
# File 'motion/core_ext/date/calculations.rb', line 36

def tomorrow
  ::Date.current.tomorrow
end

.yesterdayObject

Returns a new Date representing the date 1 day ago (i.e. yesterday's date).


31
32
33
# File 'motion/core_ext/date/calculations.rb', line 31

def yesterday
  ::Date.current.yesterday
end

Instance Method Details

#<<(months) ⇒ Object


60
61
62
# File 'motion/_stdlib/date.rb', line 60

def <<(months)
  return self >> -months
end

#==(other) ⇒ Object


30
31
32
33
34
# File 'motion/_stdlib/date.rb', line 30

def ==(other)
  year == other.year &&
  month == other.month &&
  day == other.day
end

#>>(months) ⇒ Object


51
52
53
54
55
56
57
58
# File 'motion/_stdlib/date.rb', line 51

def >>(months)
  new_year = year + (self.month + months - 1) / 12
  new_month = (self.month + months) % 12
  new_month = new_month == 0 ? 12 : new_month
  new_day = [day, Time.days_in_month(new_month, new_year)].min
  
  Date.new(new_year, new_month, new_day)
end

#acts_like_date?Boolean

Duck-types as a Date-like class. See Object#acts_like?.

Returns:

  • (Boolean)

5
6
7
# File 'motion/core_ext/date/acts_like.rb', line 5

def acts_like_date?
  true
end

#advance(options) ⇒ Object

Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.


95
96
97
98
99
100
101
102
103
# File 'motion/core_ext/date/calculations.rb', line 95

def advance(options)
  options = options.dup
  d = self
  d = d >> options.delete(:years) * 12 if options[:years]
  d = d >> options.delete(:months)     if options[:months]
  d = d +  options.delete(:weeks) * 7  if options[:weeks]
  d = d +  options.delete(:days)       if options[:days]
  d
end

#ago(seconds) ⇒ Object

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then subtracts the specified number of seconds.


48
49
50
# File 'motion/core_ext/date/calculations.rb', line 48

def ago(seconds)
  to_time.since(-seconds)
end

#beginning_of_dayObject Also known as: midnight, at_midnight, at_beginning_of_day

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)


60
61
62
# File 'motion/core_ext/date/calculations.rb', line 60

def beginning_of_day
  to_time
end

#change(options) ⇒ Object

Returns a new Date where one or more of the elements have been changed according to the options parameter. The options parameter is a hash with a combination of these keys: :year, :month, :day.

Date.new(2007, 5, 12).change(day: 1)               # => Date.new(2007, 5, 1)
Date.new(2007, 5, 12).change(year: 2005, month: 1) # => Date.new(2005, 1, 12)

110
111
112
113
114
115
116
# File 'motion/core_ext/date/calculations.rb', line 110

def change(options)
  ::Date.new(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day)
  )
end

#end_of_dayObject Also known as: at_end_of_day

Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)


68
69
70
# File 'motion/core_ext/date/calculations.rb', line 68

def end_of_day
  to_time.end_of_day
end

#minus_with_duration(other) ⇒ Object Also known as: -

:nodoc:


83
84
85
86
87
88
89
# File 'motion/core_ext/date/calculations.rb', line 83

def minus_with_duration(other) #:nodoc:
  if MotionSupport::Duration === other
    plus_with_duration(-other)
  else
    minus_without_duration(other)
  end
end

#plus_with_duration(other) ⇒ Object Also known as: +

:nodoc:


73
74
75
76
77
78
79
# File 'motion/core_ext/date/calculations.rb', line 73

def plus_with_duration(other) #:nodoc:
  if MotionSupport::Duration === other
    other.since(self)
  else
    plus_without_duration(other)
  end
end

#readable_inspectObject Also known as: inspect

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005”


51
52
53
# File 'motion/core_ext/date/conversions.rb', line 51

def readable_inspect
  strftime('%a, %d %b %Y')
end

#since(seconds) ⇒ Object Also known as: in

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds


54
55
56
# File 'motion/core_ext/date/calculations.rb', line 54

def since(seconds)
  to_time.since(seconds)
end

#succObject


78
79
80
# File 'motion/_stdlib/date.rb', line 78

def succ
  self + 1
end

#to_dateObject


70
71
72
# File 'motion/_stdlib/date.rb', line 70

def to_date
  self
end

#to_formatted_s(format = :default) ⇒ Object Also known as: to_s

Convert to a formatted string. See DATE_FORMATS for predefined formats.

This method is aliased to to_s.

date = Date.new(2007, 11, 10)       # => Sat, 10 Nov 2007

date.to_formatted_s(:db)            # => "2007-11-10"
date.to_s(:db)                      # => "2007-11-10"

date.to_formatted_s(:short)         # => "10 Nov"
date.to_formatted_s(:long)          # => "November 10, 2007"
date.to_formatted_s(:long_ordinal)  # => "November 10th, 2007"
date.to_formatted_s(:rfc822)        # => "10 Nov 2007"

Adding your own time formats to to_formatted_s

You can add your own formats to the Date::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a date argument as the value.

# config/initializers/time_formats.rb
Date::DATE_FORMATS[:month_and_year] = '%B %Y'
Date::DATE_FORMATS[:short_ordinal] = ->(date) { date.strftime("%B #{date.day.ordinalize}") }

36
37
38
39
40
41
42
43
44
45
46
# File 'motion/core_ext/date/conversions.rb', line 36

def to_formatted_s(format = :default)
  if formatter = DATE_FORMATS[format]
    if formatter.respond_to?(:call)
      formatter.call(self).to_s
    else
      strftime(formatter)
    end
  else
    to_default_s
  end
end

#to_timeObject


74
75
76
# File 'motion/_stdlib/date.rb', line 74

def to_time
  @value
end