Skip to content
/ wareki Public

ruby 向け和暦ライブラリ。和暦と標準Dateの双方向変換をサポート。全元号対応。

License

Notifications You must be signed in to change notification settings

sugi/wareki

Repository files navigation

ruby 和暦ライブラリ

<img src=“https://badge.fury.io/rb/wareki.svg” alt=“Gem Version” /> <img src=“https://travis-ci.org/sugi/wareki.svg?branch=master” alt=“Build Status” /> <img src=“https://coveralls.io/repos/sugi/wareki/badge.svg?branch=master&service=github” alt=“Coverage Status” /> <img src=“https://api.codeclimate.com/v1/badges/c9209422700b526d2b45/maintainability” />

概要

日本の和暦をサポートするライブラリです。旧暦は445年から、元号は大化から全て処理できます。元号はWikipedia、暦は日本暦日原典由来のデータを元にしています。

機能

  • 和暦文字列のパース

    • 旧字体を含む元号のサポート (慶應、萬延など)

    • 漢数字サポート

    • 閏月サポート

    • 月の別名(如月、弥生、師走など)のサポート

    • 元年、正月、朔日、晦日、廿一日、卅日 などの特殊な表記の日付サポート

  • Date クラスの拡張

    • strftime に和暦フォーマット文字列を追加

    • to_wareki_date を追加

    • Date::JAPAN (明治改暦日)の追加

インストール

Gemfile に以下のようにするか、

gem 'wareki'

もしくは、直接 gem install して下さい。

gem install wareki

使い方の例

require 'wareki'

Date.today.strftime("%JF")              # => "平成二十七年八月二十二日"
Date.civil(1311, 7, 20).strftime("%JF") # => "応長元年閏六月四日"

Date.parse("正嘉元年 うるう3月 12日") # => 標準 Date インスタンス 1257-04-27

# Wareki::Date を直接扱う場合
Date.today.to_wareki_date # => Wareki::Date インスタンス
Wareki::Date.parse("正嘉元年 うるう3月 12日") # => Wareki::Date インスタンス
Wareki::Date.new("明治", 8, 2, 1).to_date # => 標準 Date インスタンス 1875-02-01

フォーマット文字列

  • %Jf: “%Je%Jg年%Js%Jl月%Jd日” の略 (例: 平成23年3月12日)

  • %JF: “%Je%JGK年%JLk%JSk月%JDk日” の略 (例: 平成二十三年三月十二日)

  • %Jy: “%Je%Jg” の略 (元号+半角数字年)

  • %JY: “%Je%JG” の略 (元号+全角数字年)

  • %JYk: “%Je%Gk” の略 (元号+漢数字年)

  • %JYK: “%Je%GK” の略 (元号+特殊漢数字年)

  • %Je: 元号 (存在しない場合空文字列になります)

  • %Jg: 和暦年の半角数字(元号が存在しない場合空文字列)

  • %JG: 和暦年の全角数字(元号が存在しない場合空文字列)

  • %JGk: 和暦年の漢数字(元号が存在しない場合空文字列)

  • %JGK: 和暦年の漢数字の特殊記法 (元) (元号が存在しない場合空文字列)

  • %Jo: 旧暦年の半角数字

  • %JO: 旧暦年の全角数字

  • %JOk: 旧暦年の漢数字

  • %Ji: 神武天皇即位紀元(皇紀)年の半角数字

  • %JI: 神武天皇即位紀元(皇紀)年の全角数字

  • %JIk: 神武天皇即位紀元(皇紀)年の漢数字

  • %Jm: “%Js%Jl” の略 (和暦月の半角数字。閏月は後ろに “‘” を追加)

  • %JM: “%JLk%JS” の略 (和暦月の全角数字。閏月は前に “閏” を追加)

  • %JMk: “%JLk%JSk” の略 (和暦月の漢数字。閏月は前に “閏” を追加)

  • %Js: 和暦月の半角数字

  • %JS: 和暦月の全角数字

  • %JSk: 和暦月の漢数字

  • %JSK: 和暦月の別名 (睦月、如月、弥生…)

  • %Jl: 和暦月が閏月の場合 “‘”、そうでなければ空文字列になります。

  • %JL: 和暦月が閏月の場合 “’”、そうでなければ空文字列になります。

  • %JLk: 和暦月が閏月の場合 “閏”、そうでなければ空文字列になります。

  • %Jd: 和暦日の半角数字

  • %JD: 和暦日の全角数字

  • %JDk: 和暦日の漢数字

  • %JDK: 和暦日の漢数字の特殊記法 (朔、晦)

仕様、限界、制限など

  • 作者は暦の専門家ではまったくありません。ツッコミお待ちしています。

  • 皇紀と旧暦が出力できますが、旧暦445年1月1日(先発グレゴリオ暦で445年1月25日)より前の日付はサポートしていません。扱おうとすると UnsupportedDateRange 例外を上げます。

  • 日本暦日原典の対照表が、どの暦法を元にしているのか分かっていません。単にデータだけを利用しています。

  • 内部的には全てユリウス日を経由して変換しています。

  • パース時には元号の存在しない年(例: 霊亀百年)を受け入れます。しかし現状、Date に変換した場合この情報は捨てられ、パース時の元号を復元することはできません。(Wareki::Date を直接扱えば可能です)

  • 改暦による存在しない日(明治5年12月3日〜31日)は基本的に例外を上げます。が、現状このチェックは完全ではありません。

  • 北朝の元号も解釈できます。しかし現在の所、北朝の元号で文字列にフォーマットすることはできません。

  • 10月の別名は「神無月」しかサポートしていません

  • 将来の日付に関しては、現在の元号がずっと継続しているとみなします

  • 日本でユリウス暦は使われていないので、Date::JAPAN は単にグレゴリオ暦への改暦日の目安、と言うだけです。Date.new で使う意味はほぼありません。

参照元データ

作成には以下のデータを参照しました。

ライセンス

The BSD 2-Clause License

作者

Tatsuki Sugiura <sugi@nemui.org>

TODO

  • 北朝モード

  • Wareki::Date で各種計算のサポート

  • 元号として “西暦” サポート?

  • 元号の切り替え日を和暦ベースで計算するようにする?

About

ruby 向け和暦ライブラリ。和暦と標準Dateの双方向変換をサポート。全元号対応。

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages