class DateTime
DateTime¶↑
A subclass ofDate that easily handles date, hour, minute, second, and offset.
DateTime class is considered deprecated. UseTime class.
DateTime does not consider any leap seconds, does not track any summer time rules.
ADateTime object is created withDateTime::new,DateTime::jd,DateTime::ordinal,DateTime::commercial,DateTime::parse,DateTime::strptime,DateTime::now,Time#to_datetime, etc.
require'date'DateTime.new(2001,2,3,4,5,6)#=> #<DateTime: 2001-02-03T04:05:06+00:00 ...>
The last element of day, hour, minute, or second can be a fractional number. The fractional number’s precision is assumed at most nanosecond.
DateTime.new(2001,2,3.5)#=> #<DateTime: 2001-02-03T12:00:00+00:00 ...>
An optional argument, the offset, indicates the difference between the local time and UTC. For example,Rational(3,24) represents ahead of 3 hours of UTC,Rational(-5,24) represents behind of 5 hours of UTC. The offset should be -1 to +1, and its precision is assumed at most second. The default value is zero (equals to UTC).
DateTime.new(2001,2,3,4,5,6,Rational(3,24))#=> #<DateTime: 2001-02-03T04:05:06+03:00 ...>
The offset also accepts string form:
DateTime.new(2001,2,3,4,5,6,'+03:00')#=> #<DateTime: 2001-02-03T04:05:06+03:00 ...>
An optional argument, the day of calendar reform (start), denotes a Julian day number, which should be 2298874 to 2426355 or negative/positive infinity. The default value isDate::ITALY (2299161=1582-10-15).
ADateTime object has various methods. See each reference.
d =DateTime.parse('3rd Feb 2001 04:05:06+03:30')#=> #<DateTime: 2001-02-03T04:05:06+03:30 ...>d.hour#=> 4d.min#=> 5d.sec#=> 6d.offset#=> (7/48)d.zone#=> "+03:30"d+=Rational('1.5')#=> #<DateTime: 2001-02-04%16:05:06+03:30 ...>d =d.new_offset('+09:00')#=> #<DateTime: 2001-02-04%21:35:06+09:00 ...>d.strftime('%I:%M:%S %p')#=> "09:35:06 PM"d>DateTime.new(1999)#=> true
When should you useDateTime and when should you useTime?¶↑
It’s a common misconception thatWilliam Shakespeare andMiguel de Cervantes died on the same day in history - so much so that UNESCO named April 23 asWorld Book Day because of this fact. However, because England hadn’t yet adopted theGregorian Calendar Reform (and wouldn’t until1752) their deaths are actually 10 days apart. Since Ruby’sTime class implements aproleptic Gregorian calendar and has no concept of calendar reform there’s no way to express this withTime objects. This is whereDateTime steps in:
shakespeare =DateTime.iso8601('1616-04-23',Date::ENGLAND)#=> Tue, 23 Apr 1616 00:00:00 +0000cervantes =DateTime.iso8601('1616-04-23',Date::ITALY)#=> Sat, 23 Apr 1616 00:00:00 +0000
Already you can see something is weird - the days of the week are different. Taking this further:
cervantes==shakespeare#=> false(shakespeare-cervantes).to_i#=> 10
This shows that in fact they died 10 days apart (in reality 11 days since Cervantes died a day earlier but was buried on the 23rd). We can see the actual date of Shakespeare’s death by using thegregorian method to convert it:
shakespeare.gregorian#=> Tue, 03 May 1616 00:00:00 +0000
So there’s an argument that all the celebrations that take place on the 23rd April in Stratford-upon-Avon are actually the wrong date since England is now using the Gregorian calendar. You can see why when we transition across the reform date boundary:
# start off with the anniversary of Shakespeare's birth in 1751shakespeare =DateTime.iso8601('1751-04-23',Date::ENGLAND)#=> Tue, 23 Apr 1751 00:00:00 +0000# add 366 days since 1752 is a leap year and April 23 is after February 29shakespeare+366#=> Thu, 23 Apr 1752 00:00:00 +0000# add another 365 days to take us to the anniversary in 1753shakespeare+366+365#=> Fri, 04 May 1753 00:00:00 +0000
As you can see, if we’re accurately tracking the number ofsolar years since Shakespeare’s birthday then the correct anniversary date would be the 4th May and not the 23rd April.
So when should you useDateTime in Ruby and when should you useTime? Almost certainly you’ll want to useTime since your app is probably dealing with current dates and times. However, if you need to deal with dates and times in a historical context you’ll want to useDateTime to avoid making the same mistakes as UNESCO. If you also have to deal with timezones then best of luck - just bear in mind that you’ll probably be dealing withlocal solar times, since it wasn’t until the 19th century that the introduction of the railways necessitated the need forStandard Time and eventually timezones.
Public Class Methods
Source
static VALUEdatetime_s__strptime(int argc, VALUE *argv, VALUE klass){ return date_s__strptime_internal(argc, argv, klass, "%FT%T%z");}Parses the given representation of date and time with the given template, and returns a hash of parsed elements. _strptime does not support specification of flags and width unlike strftime.
See also strptime(3) andstrftime.
Source
static VALUEdatetime_s_civil(int argc, VALUE *argv, VALUE klass){ return datetime_initialize(argc, argv, d_lite_s_alloc_complex(klass));}Same asDateTime.new.
Source
static VALUEdatetime_s_commercial(int argc, VALUE *argv, VALUE klass){ VALUE vy, vw, vd, vh, vmin, vs, vof, vsg, y, fr, fr2, ret; int w, d, h, min, s, rof; double sg; rb_scan_args(argc, argv, "08", &vy, &vw, &vd, &vh, &vmin, &vs, &vof, &vsg); y = INT2FIX(-4712); w = 1; d = 1; h = min = s = 0; fr2 = INT2FIX(0); rof = 0; sg = DEFAULT_SG; switch (argc) { case 8: val2sg(vsg, sg); case 7: val2off(vof, rof); case 6: check_numeric(vs, "second"); num2int_with_frac(s, positive_inf); case 5: check_numeric(vmin, "minute"); num2int_with_frac(min, 5); case 4: check_numeric(vh, "hour"); num2int_with_frac(h, 4); case 3: check_numeric(vd, "cwday"); num2int_with_frac(d, 3); case 2: check_numeric(vw, "cweek"); w = NUM2INT(vw); case 1: check_numeric(vy, "year"); y = vy; } { VALUE nth; int ry, rw, rd, rh, rmin, rs, rjd, rjd2, ns; if (!valid_commercial_p(y, w, d, sg, &nth, &ry, &rw, &rd, &rjd, &ns)) rb_raise(eDateError, "invalid date"); if (!c_valid_time_p(h, min, s, &rh, &rmin, &rs)) rb_raise(eDateError, "invalid date"); canon24oc(); rjd2 = jd_local_to_utc(rjd, time_to_df(rh, rmin, rs), rof); ret = d_complex_new_internal(klass, nth, rjd2, 0, INT2FIX(0), rof, sg, 0, 0, 0, rh, rmin, rs, HAVE_JD | HAVE_TIME); } add_frac(); return ret;}Creates aDateTime object denoting the given week date.
DateTime.commercial(2001)#=> #<DateTime: 2001-01-01T00:00:00+00:00 ...>DateTime.commercial(2002)#=> #<DateTime: 2001-12-31T00:00:00+00:00 ...>DateTime.commercial(2001,5,6,4,5,6,'+7')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Source
static VALUEdatetime_s_httpdate(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME_HTTPDATE); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__httpdate(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some RFC 2616 format.
DateTime.httpdate('Sat, 03 Feb 2001 04:05:06 GMT')#=> #<DateTime: 2001-02-03T04:05:06+00:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_iso8601(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__iso8601(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical ISO 8601 formats.
DateTime.iso8601('2001-02-03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.iso8601('20010203T040506+0700')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.iso8601('2001-W05-6T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_jd(int argc, VALUE *argv, VALUE klass){ VALUE vjd, vh, vmin, vs, vof, vsg, jd, fr, fr2, ret; int h, min, s, rof; double sg; rb_scan_args(argc, argv, "06", &vjd, &vh, &vmin, &vs, &vof, &vsg); jd = INT2FIX(0); h = min = s = 0; fr2 = INT2FIX(0); rof = 0; sg = DEFAULT_SG; switch (argc) { case 6: val2sg(vsg, sg); case 5: val2off(vof, rof); case 4: check_numeric(vs, "second"); num2int_with_frac(s, positive_inf); case 3: check_numeric(vmin, "minute"); num2int_with_frac(min, 3); case 2: check_numeric(vh, "hour"); num2int_with_frac(h, 2); case 1: check_numeric(vjd, "jd"); num2num_with_frac(jd, 1); } { VALUE nth; int rh, rmin, rs, rjd, rjd2; if (!c_valid_time_p(h, min, s, &rh, &rmin, &rs)) rb_raise(eDateError, "invalid date"); canon24oc(); decode_jd(jd, &nth, &rjd); rjd2 = jd_local_to_utc(rjd, time_to_df(rh, rmin, rs), rof); ret = d_complex_new_internal(klass, nth, rjd2, 0, INT2FIX(0), rof, sg, 0, 0, 0, rh, rmin, rs, HAVE_JD | HAVE_TIME); } add_frac(); return ret;}Creates aDateTime object denoting the given chronological Julian day number.
DateTime.jd(2451944)#=> #<DateTime: 2001-02-03T00:00:00+00:00 ...>DateTime.jd(2451945)#=> #<DateTime: 2001-02-04T00:00:00+00:00 ...>DateTime.jd(Rational('0.5'))#=> #<DateTime: -4712-01-01T12:00:00+00:00 ...>
Source
static VALUEdatetime_s_jisx0301(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__jisx0301(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical JIS X 0301 formats.
DateTime.jisx0301('H13.02.03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
For no-era year, legacy format, Heisei is assumed.
DateTime.jisx0301('13.02.03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
# File ext/json/lib/json/add/date_time.rb, line 10defself.json_create(object)args =object.values_at('y','m','d','H','M','S')of_a,of_b =object['of'].split('/')ifof_bandof_b!='0'args<<Rational(of_a.to_i,of_b.to_i)elseargs<<of_aendargs<<object['sg']civil(*args)end
Seeas_json.
Source
static VALUEdatetime_s_civil(int argc, VALUE *argv, VALUE klass){ return datetime_initialize(argc, argv, d_lite_s_alloc_complex(klass));}Same asDateTime.new.
Source
static VALUEdatetime_s_now(int argc, VALUE *argv, VALUE klass){ VALUE vsg, nth, ret; double sg;#ifdef HAVE_CLOCK_GETTIME struct timespec ts;#else struct timeval tv;#endif time_t sec; struct tm tm; long sf, of; int y, ry, m, d, h, min, s; rb_scan_args(argc, argv, "01", &vsg); if (argc < 1) sg = DEFAULT_SG; else sg = NUM2DBL(vsg);#ifdef HAVE_CLOCK_GETTIME if (clock_gettime(CLOCK_REALTIME, &ts) == -1) rb_sys_fail("clock_gettime"); sec = ts.tv_sec;#else if (gettimeofday(&tv, NULL) == -1) rb_sys_fail("gettimeofday"); sec = tv.tv_sec;#endif tzset(); if (!localtime_r(&sec, &tm)) rb_sys_fail("localtime"); y = tm.tm_year + 1900; m = tm.tm_mon + 1; d = tm.tm_mday; h = tm.tm_hour; min = tm.tm_min; s = tm.tm_sec; if (s == 60) s = 59;#ifdef HAVE_STRUCT_TM_TM_GMTOFF of = tm.tm_gmtoff;#elif defined(HAVE_TIMEZONE)#if defined(HAVE_ALTZONE) && !defined(_AIX) of = (long)-((tm.tm_isdst > 0) ? altzone : timezone);#else of = (long)-timezone; if (tm.tm_isdst) { time_t sec2; tm.tm_isdst = 0; sec2 = mktime(&tm); of += (long)difftime(sec2, sec); }#endif#elif defined(HAVE_TIMEGM) { time_t sec2; sec2 = timegm(&tm); of = (long)difftime(sec2, sec); }#else { struct tm tm2; time_t sec2; if (!gmtime_r(&sec, &tm2)) rb_sys_fail("gmtime"); tm2.tm_isdst = tm.tm_isdst; sec2 = mktime(&tm2); of = (long)difftime(sec, sec2); }#endif#ifdef HAVE_CLOCK_GETTIME sf = ts.tv_nsec;#else sf = tv.tv_usec * 1000;#endif if (of < -DAY_IN_SECONDS || of > DAY_IN_SECONDS) { of = 0; rb_warning("invalid offset is ignored"); } decode_year(INT2FIX(y), -1, &nth, &ry); ret = d_complex_new_internal(klass, nth, 0, 0, LONG2NUM(sf), (int)of, GREGORIAN, ry, m, d, h, min, s, HAVE_CIVIL | HAVE_TIME); { get_d1(ret); set_sg(dat, sg); } return ret;}Creates aDateTime object denoting the present time.
DateTime.now#=> #<DateTime: 2011-06-11T21:20:44+09:00 ...>
Source
static VALUEdatetime_s_ordinal(int argc, VALUE *argv, VALUE klass){ VALUE vy, vd, vh, vmin, vs, vof, vsg, y, fr, fr2, ret; int d, h, min, s, rof; double sg; rb_scan_args(argc, argv, "07", &vy, &vd, &vh, &vmin, &vs, &vof, &vsg); y = INT2FIX(-4712); d = 1; h = min = s = 0; fr2 = INT2FIX(0); rof = 0; sg = DEFAULT_SG; switch (argc) { case 7: val2sg(vsg, sg); case 6: val2off(vof, rof); case 5: check_numeric(vs, "second"); num2int_with_frac(s, positive_inf); case 4: check_numeric(vmin, "minute"); num2int_with_frac(min, 4); case 3: check_numeric(vh, "hour"); num2int_with_frac(h, 3); case 2: check_numeric(vd, "yday"); num2int_with_frac(d, 2); case 1: check_numeric(vy, "year"); y = vy; } { VALUE nth; int ry, rd, rh, rmin, rs, rjd, rjd2, ns; if (!valid_ordinal_p(y, d, sg, &nth, &ry, &rd, &rjd, &ns)) rb_raise(eDateError, "invalid date"); if (!c_valid_time_p(h, min, s, &rh, &rmin, &rs)) rb_raise(eDateError, "invalid date"); canon24oc(); rjd2 = jd_local_to_utc(rjd, time_to_df(rh, rmin, rs), rof); ret = d_complex_new_internal(klass, nth, rjd2, 0, INT2FIX(0), rof, sg, 0, 0, 0, rh, rmin, rs, HAVE_JD | HAVE_TIME); } add_frac(); return ret;}Creates aDateTime object denoting the given ordinal date.
DateTime.ordinal(2001,34)#=> #<DateTime: 2001-02-03T00:00:00+00:00 ...>DateTime.ordinal(2001,34,4,5,6,'+7')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.ordinal(2001,-332,-20,-55,-54,'+7')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Source
static VALUEdatetime_s_parse(int argc, VALUE *argv, VALUE klass){ VALUE str, comp, sg, opt; argc = rb_scan_args(argc, argv, "03:", &str, &comp, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: comp = Qtrue; case 2: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 2; VALUE argv2[3], hash; argv2[0] = str; argv2[1] = comp; argv2[2] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__parse(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Parses the given representation of date and time, and creates aDateTime object.
This methoddoesnot function as a validator. If the input string does not match valid formats strictly, you may get a cryptic result. Should consider to useDateTime.strptime instead of this method as possible.
If the optional second argument is true and the detected year is in the range “00” to “99”, makes it full.
DateTime.parse('2001-02-03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.parse('20010203T040506+0700')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.parse('3rd Feb 2001 04:05:06 PM')#=> #<DateTime: 2001-02-03T16:05:06+00:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_rfc2822(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME_RFC3339); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__rfc2822(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical RFC 2822 formats.
DateTime.rfc2822('Sat, 3 Feb 2001 04:05:06 +0700')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_rfc3339(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__rfc3339(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical RFC 3339 formats.
DateTime.rfc3339('2001-02-03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_rfc2822(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME_RFC3339); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__rfc2822(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical RFC 2822 formats.
DateTime.rfc2822('Sat, 3 Feb 2001 04:05:06 +0700')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Source
static VALUEdatetime_s_strptime(int argc, VALUE *argv, VALUE klass){ VALUE str, fmt, sg; rb_scan_args(argc, argv, "03", &str, &fmt, &sg); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: fmt = rb_str_new2("%FT%T%z"); case 2: sg = INT2FIX(DEFAULT_SG); } { VALUE argv2[2], hash; argv2[0] = str; argv2[1] = fmt; hash = date_s__strptime(2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Parses the given representation of date and time with the given template, and creates aDateTime object. strptime does not support specification of flags and width unlike strftime.
DateTime.strptime('2001-02-03T04:05:06+07:00','%Y-%m-%dT%H:%M:%S%z')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.strptime('03-02-2001 04:05:06 PM','%d-%m-%Y %I:%M:%S %p')#=> #<DateTime: 2001-02-03T16:05:06+00:00 ...>DateTime.strptime('2001-W05-6T04:05:06+07:00','%G-W%V-%uT%H:%M:%S%z')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.strptime('2001 04 6 04 05 06 +7','%Y %U %w %H %M %S %z')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.strptime('2001 05 6 04 05 06 +7','%Y %W %u %H %M %S %z')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>DateTime.strptime('-1','%s')#=> #<DateTime: 1969-12-31T23:59:59+00:00 ...>DateTime.strptime('-1000','%Q')#=> #<DateTime: 1969-12-31T23:59:59+00:00 ...>DateTime.strptime('sat3feb014pm+7','%a%d%b%y%H%p%z')#=> #<DateTime: 2001-02-03T16:00:00+07:00 ...>
See also strptime(3) andstrftime.
Source
static VALUEdatetime_s_xmlschema(int argc, VALUE *argv, VALUE klass){ VALUE str, sg, opt; argc = rb_scan_args(argc, argv, "02:", &str, &sg, &opt); switch (argc) { case 0: str = rb_str_new2(JULIAN_EPOCH_DATETIME); case 1: sg = INT2FIX(DEFAULT_SG); } { int argc2 = 1; VALUE argv2[2], hash; argv2[0] = str; argv2[1] = opt; if (!NIL_P(opt)) argc2++; hash = date_s__xmlschema(argc2, argv2, klass); return dt_new_by_frags(klass, hash, sg); }}Creates a newDateTime object by parsing from a string according to some typical XML Schema formats.
DateTime.xmlschema('2001-02-03T04:05:06+07:00')#=> #<DateTime: 2001-02-03T04:05:06+07:00 ...>
Raise anArgumentError when the string length is longer thanlimit. You can stop this check by passinglimit: nil, but note that it may take a long time to parse.
Public Instance Methods
Source
# File ext/json/lib/json/add/date_time.rb, line 39defas_json(*) {JSON.create_id=>self.class.name,'y'=>year,'m'=>month,'d'=>day,'H'=>hour,'M'=>min,'S'=>sec,'of'=>offset.to_s,'sg'=>start, }end
MethodsDateTime#as_json andDateTime.json_create may be used to serialize and deserialize a DateTime object; seeMarshal.
MethodDateTime#as_json serializesself, returning a 2-element hash representingself:
require'json/add/datetime'x =DateTime.now.as_json# => {"json_class"=>"DateTime", "y"=>2023, "m"=>11, "d"=>21, "sg"=>2299161.0}
MethodJSON.create deserializes such a hash, returning a DateTime object:
DateTime.json_create(x)# BUG? Raises Date::Error "invalid date"
Source
static VALUEdt_lite_deconstruct_keys(VALUE self, VALUE keys){ return deconstruct_keys(self, keys, /* is_datetime=true */ 1);}Returns a hash of the name/value pairs, to use in pattern matching. Possible keys are::year,:month,:day,:wday,:yday,:hour,:min,:sec,:sec_fraction,:zone.
Possible usages:
dt =DateTime.new(2022,10,5,13,30)ifdinwday:1..5,hour:10..18# uses deconstruct_keys underneathputs"Working time"end#=> prints "Working time"casedtinyear:...2022puts"too old"inmonth:..9puts"quarter 1-3"inwday:1..5,month:puts"working day in month #{month}"end#=> prints "working day in month 10"
Note that deconstruction by pattern can also be combined with class check:
ifdinDateTime(wday:1..5,hour:10..18,day:..7)puts"Working time, first week of the month"end
Source
static VALUEd_lite_hour(VALUE self){ get_d1(self); return INT2FIX(m_hour(dat));}Returns the hour in range (0..23):
DateTime.new(2001,2,3,4,5,6).hour# => 4
Source
static VALUEdt_lite_iso8601(int argc, VALUE *argv, VALUE self){ long n = 0; rb_check_arity(argc, 0, 1); if (argc >= 1) n = NUM2LONG(argv[0]); return rb_str_append(strftimev("%Y-%m-%d", self, set_tmx), iso8601_timediv(self, n));}This method is equivalent to strftime(‘%FT%T%:z’). The optional argumentn is the number of digits for fractional seconds.
DateTime.parse('2001-02-03T04:05:06.123456789+07:00').iso8601(9)#=> "2001-02-03T04:05:06.123456789+07:00"
Source
static VALUEdt_lite_jisx0301(int argc, VALUE *argv, VALUE self){ long n = 0; rb_check_arity(argc, 0, 1); if (argc >= 1) n = NUM2LONG(argv[0]); return rb_str_append(d_lite_jisx0301(self), iso8601_timediv(self, n));}Returns a string in a JIS X 0301 format. The optional argumentn is the number of digits for fractional seconds.
DateTime.parse('2001-02-03T04:05:06.123456789+07:00').jisx0301(9)#=> "H13.02.03T04:05:06.123456789+07:00"
Source
static VALUEd_lite_min(VALUE self){ get_d1(self); return INT2FIX(m_min(dat));}Returns the minute in range (0..59):
DateTime.new(2001,2,3,4,5,6).min# => 5
Source
static VALUEd_lite_new_offset(int argc, VALUE *argv, VALUE self){ VALUE vof; int rof; rb_scan_args(argc, argv, "01", &vof); rof = 0; if (argc >= 1) val2off(vof, rof); return dup_obj_with_new_offset(self, rof);}Duplicates self and resets its offset.
d =DateTime.new(2001,2,3,4,5,6,'-02:00')#=> #<DateTime: 2001-02-03T04:05:06-02:00 ...>d.new_offset('+09:00')#=> #<DateTime: 2001-02-03T15:05:06+09:00 ...>
Source
static VALUEd_lite_offset(VALUE self){ get_d1(self); return m_of_in_day(dat);}Returns the offset.
DateTime.parse('04pm+0730').offset#=> (5/16)
Source
static VALUEdt_lite_rfc3339(int argc, VALUE *argv, VALUE self){ return dt_lite_iso8601(argc, argv, self);}This method is equivalent to strftime(‘%FT%T%:z’). The optional argumentn is the number of digits for fractional seconds.
DateTime.parse('2001-02-03T04:05:06.123456789+07:00').rfc3339(9)#=> "2001-02-03T04:05:06.123456789+07:00"
Source
static VALUEd_lite_sec(VALUE self){ get_d1(self); return INT2FIX(m_sec(dat));}Returns the second in range (0..59):
DateTime.new(2001,2,3,4,5,6).sec# => 6
Source
static VALUEd_lite_sec_fraction(VALUE self){ get_d1(self); return m_sf_in_sec(dat);}Returns the fractional part of the second in range (Rational(0, 1)…Rational(1, 1)):
DateTime.new(2001,2,3,4,5,6.5).sec_fraction# => (1/2)
Source
static VALUEdt_lite_strftime(int argc, VALUE *argv, VALUE self){ return date_strftime_internal(argc, argv, self, "%Y-%m-%dT%H:%M:%S%:z", set_tmx);}Returns a string representation ofself, formatted according the given +format:
DateTime.now.strftime# => "2022-07-01T11:03:19-05:00"
For other formats, seeFormats for Dates and Times:
Source
static VALUEdatetime_to_date(VALUE self){ get_d1a(self); if (simple_dat_p(adat)) { VALUE new = d_lite_s_alloc_simple(cDate); { get_d1b(new); bdat->s = adat->s; bdat->s.jd = m_local_jd(adat); return new; } } else { VALUE new = d_lite_s_alloc_simple(cDate); { get_d1b(new); copy_complex_to_simple(new, &bdat->s, &adat->c); bdat->s.jd = m_local_jd(adat); bdat->s.flags &= ~(HAVE_DF | HAVE_TIME | COMPLEX_DAT); return new; } }}Returns aDate object which denotes self.
Source
# File ext/json/lib/json/add/date_time.rb, line 62defto_json(*args)as_json.to_json(*args)end
Returns aJSON string representingself:
require'json/add/datetime'putsDateTime.now.to_json
Output:
{"json_class":"DateTime","y":2023,"m":11,"d":21,"sg":2299161.0}Source
static VALUEdt_lite_to_s(VALUE self){ return strftimev("%Y-%m-%dT%H:%M:%S%:z", self, set_tmx);}Returns a string in an ISO 8601 format. (This method doesn’t use the expanded representations.)
DateTime.new(2001,2,3,4,5,6,'-7').to_s#=> "2001-02-03T04:05:06-07:00"
Source
static VALUEdatetime_to_time(VALUE self){ get_d1(self); if (m_julian_p(dat)) { VALUE g = d_lite_gregorian(self); get_d1a(g); dat = adat; self = g; } { VALUE t; t = rb_funcall(rb_cTime, rb_intern("new"), 7, m_real_year(dat), INT2FIX(m_mon(dat)), INT2FIX(m_mday(dat)), INT2FIX(m_hour(dat)), INT2FIX(m_min(dat)), f_add(INT2FIX(m_sec(dat)), m_sf_in_sec(dat)), INT2FIX(m_of(dat))); RB_GC_GUARD(self); /* may be the converted gregorian */ return t; }}Returns aTime object which denotes self.
This method is equivalent to strftime(‘%FT%T%:z’). The optional argumentn is the number of digits for fractional seconds.
DateTime.parse('2001-02-03T04:05:06.123456789+07:00').iso8601(9)#=> "2001-02-03T04:05:06.123456789+07:00"
Source
static VALUEd_lite_zone(VALUE self){ get_d1(self); return m_zone(dat);}Returns the timezone.
DateTime.parse('04pm+0730').zone#=> "+07:30"