1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/lib/parsedate.rb
matz bb9f40a725 * lib/parsedate.rb: documentation patch from Konrad Meyer
<konrad.meyer@gmail.com>.  [ruby-doc:1238]

* lib/open3.rb, lib/ping.rb: ditto.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11113 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2006-10-09 14:49:49 +00:00

53 lines
1.3 KiB
Ruby

#
# = parsedate.rb: Parses dates
#
# Author:: Tadayoshi Funaba
# Documentation:: Konrad Meyer
#
# ParseDate munches on a date and turns it into an array of values.
#
#
# ParseDate converts a date into an array of values.
# For example:
#
# require 'parsedate'
#
# ParseDate.parsedate "Tuesday, July 6th, 2007, 18:35:20 UTC"
# # => [2007, 7, 6, 18, 35, 20, "UTC", 2]
#
# The order is of the form [year, month, day of month, hour, minute, second,
# timezone, day of the week].
require 'date/format'
module ParseDate
#
# Parse a string representation of a date into values.
# For example:
#
# require 'parsedate'
#
# ParseDate.parsedate "Tuesday, July 5th, 2007, 18:35:20 UTC"
# # => [2007, 7, 5, 18, 35, 20, "UTC", 2]
#
# The order is of the form [year, month, day of month, hour, minute,
# second, timezone, day of week].
#
# ParseDate.parsedate can also take a second argument, +comp+, which
# is a boolean telling the method to compensate for dates with years
# expressed as two digits. Example:
#
# require 'parsedate'
#
# ParseDate.parsedate "Mon Dec 25 00 06:53:24 UTC", true
# # => [2000, 12, 25, 6, 53, 24, "UTC", 1]
#
def parsedate(str, comp=false)
Date._parse(str, comp).
values_at(:year, :mon, :mday, :hour, :min, :sec, :zone, :wday)
end
module_function :parsedate
end