class Date (Ruby 1.8.7 リファレンスマニュアル)

このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。最新版のマニュアルへ

要約

日付だけでなく時刻も扱える Date のサブクラス DateTime も利用できます。

簡単なつかいかた

require 'date'

a = Date.new(1993, 2, 24)
b = Date.parse('1993-02-24')
b += 10

b - a            #=> 10
b.year           #=> 1993
b.strftime('%a') #=> "Sat"

yesterday = Date.today - 1

用語の定義

いくつか用語の定義は、ISO 8601、および JIS X 0301 に基づきます。

暦日付

暦日付は、暦年、暦月、および暦月の中の序数によって指定される特定の日の日付です。

つまり、ごく当たり前の年月日による日付です。

年間通算日 (年日付)

年間通算日 (年日付) は、暦年、および暦年の中の序数によって指定される特定の日の日付です。

暦週日付

暦週日付は、暦週と暦年中の序数による日付です。

暦週は、暦年中の序数によって指定される特定の7日の期間であり、月曜から始まります。その年の第1暦週は、最初の木曜日を含む週とします。これは、 1月4日を含む週と同じです。

ユリウス日

ユリウス日は紀元前4713年1月1日 (ユリウス暦) 正午 (グリニッジ平均時) を暦元とした通日 (経過日数) です。

この文書で、天文学的なユリウス日とは、本来のユリウス日と同じものです。また、年代学的なユリウス日とは、地方時における零時を一日の始まりとする流儀です。

この文書で、単に「ユリウス日」といった場合、それは本来のユリウス日でなく、「年代学的なユリウス日」を意味しています。

修正ユリウス日

修正ユリウス日は西暦1858年11月17日 (グレゴリオ暦) 正子/零時 (協定世界時) を暦元とした通日 (経過日数) です。

この文書で、天文学的な修正ユリウス日とは、本来の修正ユリウス日と同じものです。また、年代学的な修正ユリウス日とは、地方時における零時を一日の始まりとする流儀です。

この文書で、単に「修正ユリウス日」といった場合、それは本来の修正ユリウス日でなく、「年代学的な修正ユリウス日」を意味しています。

継承しているメソッド

Comparableから継承しているメソッド

特異メソッド

_parse(str, complete = false) -> Hash[permalink][rdoc]

このメソッドは Date.parse と似ていますが、日付オブジェクトを生成せずに、見いだした要素をハッシュで返します。

Date.parse も参照してください。

[PARAM] str:: 日付をあらわす文字列
[PARAM] complete:: 年を補完するか

_strptime(str, format = '%F') -> Hash[permalink][rdoc]

このメソッドは Date.strptime と似ていますが、日付オブジェクトを生成せずに、見いだした要素をハッシュで返します。

[PARAM] str:: 日付をあらわす文字列
[PARAM] format:: 書式

civil(year = -4712, mon = 1, mday = 1, start = Date::ITALY) -> Date[permalink][rdoc]

new(year = -4712, mon = 1, mday = 1, start = Date::ITALY) -> Date

暦日付に相当する日付オブジェクトを生成します。

このクラスでは、紀元前の年を天文学の流儀で勘定します。 1年の前は零年、零年の前は-1年、のようにします。月、および月の日は負、または正の数でなければなりません (負のときは最後からの序数)。零であってはなりません。

最後の引数は、グレゴリオ暦をつかい始めた日をあらわすユリウス日です。省略した場合は、Date::ITALY (1582年10月15日) になります。

Date.jd も参照してください。

[PARAM] year:: 年
[PARAM] mon:: 月
[PARAM] mday:: 日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[EXCEPTION] ArgumentError:: 正しくない日付になる組み合わせである場合に発生します。

commercial(cwyear = 1582, cweek = 41, cwday = 5, start = Date::ITALY) -> Date[permalink][rdoc]

暦週日付に相当する日付オブジェクトを生成します。

週、および週の日 (曜日) は負、または正の数でなければなりません(負のときは最後からの序数)。零であってはなりません。

このメソッドに改暦前の日付を与えることはできません。

Date.jd、および Date.new も参照してください。

[PARAM] cwyear:: 年
[PARAM] cweek:: 週
[PARAM] cwday:: 週の日 (曜日)
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[EXCEPTION] ArgumentError:: 正しくない日付になる組み合わせである場合に発生します。

gregorian_leap?(year) -> bool[permalink][rdoc]

leap?(year) -> bool

グレゴリオ暦の閏年なら真を返します。

[PARAM] year:: 年

jd(jd = 0, start = Date::ITALY) -> Date[permalink][rdoc]

ユリウス日に相当する日付オブジェクトを生成します。

このクラスのいくつかの重要なメソッドで、負のユリウス日は保証されません。

Date.new も参照してください。

[PARAM] jd:: ユリウス日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

julian_leap?(year) -> bool[permalink][rdoc]

ユリウス暦の閏年なら真を返します。

西暦4年は真になりますが、これは歴史的には正しくありません。

[PARAM] year:: 年

ordinal(year = -4712, yday = 1, start = Date::ITALY) -> Date[permalink][rdoc]

年間通算日 (年日付) に相当する日付オブジェクトを生成します。

年の日は負、または正の数でなければなりません (負のときは最後からの序数)。零であってはなりません。

Date.jd、および Date.new も参照してください。

[PARAM] year:: 年
[PARAM] yday:: 年の日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[EXCEPTION] ArgumentError:: 正しくない日付になる組み合わせである場合に発生します。

parse(str = '-4712-01-01', complete = false, start = Date::ITALY) -> Date[permalink][rdoc]

与えられた日付表現を解析し、その情報に基づいて日付オブジェクトを生成します。

complete が真で、年が "00" から "99" の範囲であれば、年の下2桁表現であるとみなしこれを補います。なお、省略した場合は、偽とみなします。

Date._parse も参照してください。

[PARAM] str:: 日付をあらわす文字列
[PARAM] complete:: 年を補完するか
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[EXCEPTION] ArgumentError:: 正しくない日付になる組み合わせである場合に発生します。

strptime(str = '-4712-01-01', format = '%F', start = Date::ITALY) -> Date[permalink][rdoc]

与えられた雛型で日付表現を解析し、その情報に基づいて日付オブジェクトを生成します。

Date._strptime も参照してください。また strptime(3)、および Date#strftime も参照してください。

[PARAM] str:: 日付をあらわす文字列
[PARAM] format:: 書式
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[EXCEPTION] ArgumentError:: 正しくない日付になる組み合わせである場合に発生します。

today(start = Date::ITALY) -> Date[permalink][rdoc]

現在の日付に相当する日付オブジェクトを生成します。

[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

valid_civil?(year, mon, mday, start = Date::GREGORIAN) -> Numeric | nil[permalink][rdoc]

valid_date?(year, mon, mday, start = Date::GREGORIAN) -> Numeric | nil

正しい暦日付であれば、相当するユリウス日を返します。そうでないなら、偽を返します。

Date.jd、および Date.civil も参照してください。

[PARAM] year:: 年
[PARAM] mon:: 月
[PARAM] mday:: 日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

valid_commercial?(cwyear, cweek, cwday, start = Date::GREGORIAN) -> Numeric | nil[permalink][rdoc]

正しい暦週日付であれば、相当するユリウス日を返します。そうでないなら、偽を返します。

Date.jd、および Date.commercial も参照してください。

[PARAM] cwyear:: 年
[PARAM] cweek:: 週
[PARAM] cwday:: 週の日 (曜日)
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

valid_jd?(jd, start = Date::GREGORIAN) -> Numeric | nil[permalink][rdoc]

ひとつ目の引数をそのまま返します。

対称性のため用意されていますが、実際的に意味はありません。

Date.jd も参照してください。

[PARAM] jd:: ユリウス日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

valid_ordinal?(year, yday, start = Date::GREGORIAN) -> Numeric | nil[permalink][rdoc]

正しい年間通算日 (年日付) であれば、相当するユリウス日を返します。そうでないなら、偽を返します。

Date.jd、および Date.ordinal も参照してください。

[PARAM] year:: 年
[PARAM] yday:: 年の日
[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日

インスタンスメソッド

self + n -> Date[permalink][rdoc]

self から n 日後の日付オブジェクトを返します。 n は数値でなければなりません。

[PARAM] n:: 日数
[EXCEPTION] TypeError:: n が数値でない場合に発生します。

self - x -> Rational | Date[permalink][rdoc]

x が日付オブジェクトなら、ふたつの差を返します。あるいは x が数値ならば、self より x 日前の日付を返します。

[PARAM] x:: 日数、あるいは日付オブジェクト
[EXCEPTION] TypeError:: x が数値でも日付オブジェクトでもない場合に発生します。

self << n -> Date[permalink][rdoc]

self より n ヶ月前の日付オブジェクトを返します。 n は数値でなければなりません。

[PARAM] n:: 月数

self <=> other -> Integer[permalink][rdoc]

ふたつを比較し、-1、零、あるいは 1 を返します。 other は日付オブジェクトか、天文学的なユリウス日をあらわす数値でなければなりません。

[PARAM] other:: 日付オブジェクト

self === other -> bool[permalink][rdoc]

同じ日なら真を返します。

[PARAM] other:: 日付オブジェクト

self >> n -> Date[permalink][rdoc]

self から n ヶ月後の日付オブジェクトを返します。 n は数値でなければなりません。

[PARAM] n:: 月数

ajd -> Rational[permalink][rdoc]

このメソッドは Date#jd と似ていますが、天文学的なユリウス日を返します。時刻を含みます。

amjd -> Rational[permalink][rdoc]

このメソッドは Date#mjd と似ていますが、天文学的な修正ユリウス日を返します。時刻を含みます。

asctime -> String[permalink][rdoc]

ctime -> String

asctime(3) 書式の文字列を返します (ただし、末尾の "\n\0" は除く)。

cwday -> Integer[permalink][rdoc]

暦週の日 (曜日) を返します (1-7、月曜は1)。

cweek -> Integer[permalink][rdoc]

暦週を返します (1-53)。

cwyear -> Integer[permalink][rdoc]

暦週における年を返します。

mday -> Integer[permalink][rdoc]

day -> Integer

月の日を返します (1-31)。

downto(min) {|date| ...} -> self[permalink][rdoc]

このメソッドは、step(min, -1){|date| ...} と等価です。

[PARAM] min:: 日付オブジェクト

[SEE_ALSO] Date#step, Date#upto

england -> Date[permalink][rdoc]

このメソッドは、new_start(Date::ENGLAND) と等価です。

Date#new_start、および Date::ENGLAND を参照してください。

gregorian -> Date[permalink][rdoc]

このメソッドは、new_start(Date::GREGORIAN) と等価です。

Date#new_start、および Date::GREGORIAN を参照してください。

gregorian? -> bool[permalink][rdoc]

グレゴリオ暦なら真を返します。

italy -> Date[permalink][rdoc]

このメソッドは、new_start(Date::ITALY) と等価です。

Date#new_start、および Date::ITALY を参照してください。

jd -> Integer[permalink][rdoc]

ユリウス日を返します。時刻を含みません。

Date#ajd も参照してください。

julian -> Date[permalink][rdoc]

このメソッドは、new_start(Date::JULIAN) と等価です。

Date#new_start、および Date::JULIAN を参照してください。

julian? -> bool[permalink][rdoc]

ユリウス暦なら真を返します。

ld -> Integer[permalink][rdoc]

リリウス日を返します。

leap? -> bool[permalink][rdoc]

閏年なら真を返します。

mjd -> Integer[permalink][rdoc]

修正ユリウス日を返します。時刻の情報を含みません。

Date#amjd も参照してください。

mon -> Integer[permalink][rdoc]

month -> Integer

月を返します (1-12)。

new_start(start = Date::ITALY) -> Date[permalink][rdoc]

self を複製して、その改暦日を設定しなおします。引数を省略した場合は、Date::ITALY (1582年10月15日) になります。

Date.new も参照してください。

[PARAM] start:: グレゴリオ暦をつかい始めた日をあらわすユリウス日
[PARAM] n:: 年数

succ -> Date[permalink][rdoc]

next -> Date

翌日の日付オブジェクトを返します。

start -> Integer[permalink][rdoc]

改暦日をあらわすユリウス日を返します。

Date.new も参照してください。

step(limit, step = 1) {|date| ...} -> self[permalink][rdoc]

ブロックの評価を繰り返します。ブロックは日付オブジェクトをとります。 limit は日付オブジェクトでなければなりません、また step は非零でなければなりません。

[PARAM] limit:: 日付オブジェクト
[PARAM] step:: 歩幅

[SEE_ALSO] Date#downto, Date#upto

strftime(format = '%F') -> String[permalink][rdoc]

与えられた雛型で日付を書式づけます。

つぎの変換仕様をあつかいます:

%A, %a, %B, %b, %C, %c, %D, %d, %e, %F, %G, %g, %H, %h, %I, %j, %k, %l, %M, %m, %n, %P, %p, %R, %r, %S, %s, %T, %t, %U, %u, %V, %v, %W, %w, %X, %x, %Y, %y, %Z, %z, %%, %+

1.8.6 以降では、%L, %N, %Q もつかえます。また、GNU 版にあるような幅指定などもできます。

strftime(3)、および Date.strptime も参照してください。

[PARAM] format:: 書式

to_s -> String[permalink][rdoc]

ISO 8601 書式の文字列を返します (拡大表記はつかいません)。

upto(max) {|date| ...} -> self[permalink][rdoc]

このメソッドは、step(max, 1){|date| ...} と等価です。

[PARAM] max:: 日付オブジェクト

[SEE_ALSO] Date#step, Date#downto

wday -> Integer[permalink][rdoc]

曜日を返します (0-6、日曜日は零)。

yday -> Integer[permalink][rdoc]

年の日を返します (1-366)。

year -> Integer[permalink][rdoc]

年を返します。

追加されるメソッド

taguri -> String[permalink][rdoc] [added by yaml/rubytypes]

自身のタグ URI を返します。

taguri=(val)[permalink][rdoc] [added by yaml/rubytypes]

自身のタグ URI を val に設定します。

[PARAM] val:: タグ URI を文字列で指定します。

to_yaml(opts = {}) -> String[permalink][rdoc] [added by yaml/rubytypes]

自身を YAML ドキュメントに変換します。

[PARAM] opts:: YAML ドキュメント出力の際のオプションを指定します。オプションの詳細は YAML::Syck::Emitter#reset を参照してください。

print Date.today.to_yaml # => --- 2011-12-31

yaml_tag_subclasses? -> true[permalink][rdoc] [added by yaml/rubytypes]

常に true を返します。

ライブラリ内部で使用します。

定数

ENGLAND -> Integer[permalink][rdoc]

英国がグレゴリオ暦をつかい始めた日 (1752年9月14日) をあらわすユリウス日です。この "ENGLAND" の名前は、旧い UNIX の cal(1) の記述に由来します。

[SEE_ALSO] http://www.cs.bell-labs.com/who/dmr/man61.pdf

ちなみに、本実装で英国の改暦日を尊重する姿勢がみられるのは前実装からの影響です。前実装が英国の改暦日を尊重していたのは、おそらく cal(1) の影響です。もっとも本実装で一番に尊重されているのは、伊国の改暦日であり、多くの場合、改暦日の既定値は Date::ITALY です。

GREGORIAN -> Date::Infinity[permalink][rdoc]

常にグレゴリオ暦であることを示します。改暦日は無限の過去にあると考えられます。

ITALY -> Integer[permalink][rdoc]

伊国がグレゴリオ暦をつかい始めた日 (1582年10月15日) をあらわすユリウス日です。

JULIAN -> Date::Infinity[permalink][rdoc]

常にユリウス暦であることを示します。改暦日は無限の未来にあると考えられます。

要約

簡単なつかいかた

用語の定義

暦日付

年間通算日 (年日付)

暦週日付

ユリウス日

修正ユリウス日

目次

継承しているメソッド

特異メソッド

インスタンスメソッド

追加されるメソッド

定数