wareki 0.4.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d43ff6ae07900db1d6030a75cbad4b9dc5afe898282438e731e9a90f8cff219
-  data.tar.gz: 45c95809480c0955ddec74da16cb59b4313710586279f176e17539ece375c51c
+  metadata.gz: 8be029e4138ca6a683ff52bd0e4070db0bb2e025a9e1024b3a0ad0cd60ca34fa
+  data.tar.gz: e8b300fd9f65529284acdb43e7dfbcd91c3a2e92f07824bcc3500fa78199c2dd
 SHA512:
-  metadata.gz: 2445ba5c0d2d8228cb18ffcfa0edafffdb1952ef97ff8c20e68f73aa0e8f884767917341fb6742ac503e8bfcbe6a4fd5b1b23cee8cf47c56855eb25ace3965f1
-  data.tar.gz: dca7197e51b33123f544367011db41360214d385531e70c9fbd5064356e983af8a44c8ff12f8e582bb25755d0cc628404a1bd8f1fb89f7eabe0b58f0abb5da53
+  metadata.gz: ef1021d0c68056c285c2095c83b66adeb8ce25ed4d7530065f9e06e41ed3129251faf094bb599a4cc5c68506586a996b87ecb67c8d72f59da8c9328c2914c876
+  data.tar.gz: d98a3ed03d156f6a3a04931ec62ad4cce55dc008ffbd3c4529a6a41c0cd2b6e5279fce42246359177072568b22527da75dba637cf9050ff10883075934f33899

data/ChangeLog

@@ -1,3 +1,10 @@
+2019-04-15  Tatsuki Sugiura  <sugi@nemui.org>
+
+	* Verion: 1.0.0 🎉, compat with 0.x mostly.
+	* Split kansuji handling to 'ya_kansuji' gem
+	* Deprecate Wareki::Kansuji module
+	* Revert Utils.kan_to_i and Utils.i_to_kan as deprecated
+
 2019-04-11  Tatsuki Sugiura  <sugi@nemui.org>
 
 	* Version: 0.4.2

data/{README.rdoc → README.md}

@@ -1,17 +1,17 @@
-= wareki - ruby 和暦ライブラリ
+# wareki - ruby 和暦ライブラリ
 
-{<img src="https://badge.fury.io/rb/wareki.svg" alt="Gem Version" />}[https://badge.fury.io/rb/wareki]
-{<img src="https://travis-ci.org/sugi/wareki.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/sugi/wareki]
-{<img src="https://coveralls.io/repos/sugi/wareki/badge.svg?branch=master&service=github" alt="Coverage Status" />}[https://coveralls.io/github/sugi/wareki?branch=master]
-{<img src="https://api.codeclimate.com/v1/badges/c9209422700b526d2b45/maintainability" />}[https://codeclimate.com/github/sugi/wareki/maintainability]
+[<img src="https://badge.fury.io/rb/wareki.svg" alt="Gem Version" />](https://badge.fury.io/rb/wareki)
+[<img src="https://travis-ci.org/sugi/wareki.svg?branch=master" alt="Build Status" />](https://travis-ci.org/sugi/wareki)
+[<img src="https://coveralls.io/repos/sugi/wareki/badge.svg?branch=master&service=github" alt="Coverage Status" />](https://coveralls.io/github/sugi/wareki?branch=master)
+[<img src="https://api.codeclimate.com/v1/badges/c9209422700b526d2b45/maintainability" />](https://codeclimate.com/github/sugi/wareki/maintainability)
 
-== 概要
+## 概要
 
 日本の和暦をサポートするライブラリです。
 旧暦は445年から、元号は大化から全て処理できます。
 元号はWikipedia、暦は日本暦日原典由来のデータを元にしています。
 
-== 機能
+## 機能
 
 * 和暦文字列のパース
   * 旧字体、１文字元号のサポート (慶應、萬延、㍻ など)
@@ -24,61 +24,100 @@
   * to_wareki_date を追加
   * Date::JAPAN (明治改暦日)の追加
 
-== インストール
+## インストール
 
 Gemfile に以下のようにするか、
 
- gem 'wareki'
+```ruby
+gem 'wareki'
+```
 
 もしくは、直接 gem install して下さい。
 
- gem install wareki
+```
+gem install wareki
+```
 
-== 使い方の例
+## 使い方の例
 
-=== ありそうな例
+### ありそうな例
 
- require 'wareki'
+```ruby
+require 'wareki'
 
- d = Date.parse("平成二七年 08月 ２２日")
- d.strftime("%F")   # => "2015-08-22"
- d.strftime("%JF")  # => "平成二十七年八月二十二日"
- d.strftime("%Jf")  # => "平成27年8月22日"
+d = Date.parse("平成二七年 08月 ２２日")
+d.strftime("%F")   # => "2015-08-22"
+d.strftime("%JF")  # => "平成二十七年八月二十二日"
+d.strftime("%Jf")  # => "平成27年8月22日"
+```
 
-=== パース
+### パース
 
 旧暦を含むの日本語の日付文字列パースして、組み込み Date オブジェクトに変換できます。この時、慣例的に使われていたい色々な表記も解釈できます。(標準では Date::ITALY な Date オブジェクトに変換しますが、必要であれば第3引数の start に改暦日を渡せます。)
 
- # 和暦のパース (標準 Date インスタンス)
- Date.parse("㍻一〇年 肆月 晦日")       # => #<Date: 1998-04-30 ...
- Date.parse("安政七年 弥生")           # => #<Date: 1860-03-22 ...
- Date.parse("元仁元年閏七月朔日")       # => #<Date: 1224-08-17 ...
- Date.parse("萬延三年 ５月 廿一日")     # => #<Date: 1862-06-18 ...
- Date.parse("皇紀二千皕卌年")          # => #<Date: 1580-01-17 ...
- Date.parse("正嘉元年 うるう3月 １２日") # => #<Date: 1257-04-27 ...
+```ruby
+# 和暦のパース (標準 Date インスタンス)
+Date.parse("㍻一〇年 肆月 晦日")       # => #<Date: 1998-04-30 ...
+Date.parse("安政七年 弥生")           # => #<Date: 1860-03-22 ...
+Date.parse("元仁元年閏七月朔日")       # => #<Date: 1224-08-17 ...
+Date.parse("萬延三年 ５月 廿一日")     # => #<Date: 1862-06-18 ...
+Date.parse("皇紀二千皕卌年")          # => #<Date: 1580-01-17 ...
+Date.parse("正嘉元年 うるう3月 １２日") # => #<Date: 1257-04-27 ...
 
- # Wareki::Date を直接扱う場合
- Date.today.to_wareki_date # => Wareki::Date インスタンス
- Wareki::Date.parse("正嘉元年 うるう3月 １２日") # => Wareki::Date インスタンス
- Wareki::Date.new("明治", 8, 2, 1).to_date   # => 標準 Date インスタンス 1875-02-01
+# Wareki::Date を直接扱う場合
+Date.today.to_wareki_date # => Wareki::Date インスタンス
+Wareki::Date.parse("正嘉元年 うるう3月 １２日") # => Wareki::Date インスタンス
+Wareki::Date.new("明治", 8, 2, 1).to_date   # => 標準 Date インスタンス 1875-02-01
+```
 
-=== 和暦・旧暦へのフォーマット
+### 和暦・旧暦へのフォーマット
 
 日本では明治5年まで、グレゴリオ暦でもユリウス歴でもない旧暦が使われていました。これもフォーマット文字列経由で透過的に扱えます。
 
- Date.today.strftime("%JF")              # => "平成二十七年八月二十二日"
- Date.civil(1311, 7, 20).strftime("%JF") # => "応長元年閏六月四日"
+```ruby
+Date.today.strftime("%JF")              # => "平成二十七年八月二十二日"
+Date.civil(1311, 7, 20).strftime("%JF") # => "応長元年閏六月四日"
+```
 
 旧暦の場合の月日 (%Jm, %Jd) と、グレゴリオ暦やユリウス暦での月日 (%m, %d)は違うものを出力します。
 
- d = Date.civil(1860, 4, 7)
- dj = d.new_start(Date::JULIAN)
- d.strftime                     # => "1860-04-07" (グレゴリオ暦)
- dj.strftime                    # => "1860-03-26" (ユリウス暦)
- d.strftime("%Jf")              # => "安政7年3月17日" (日本の旧暦)
- d.strftime("皇紀%Ji年%Jm月%Jd日") # => "皇紀2520年3月17日" (日本の旧暦で神武天皇即位紀元年)
+```ruby
+d = Date.civil(1860, 4, 7)
+dj = d.new_start(Date::JULIAN)
+d.strftime                     # => "1860-04-07" (グレゴリオ暦)
+dj.strftime                    # => "1860-03-26" (ユリウス暦)
+d.strftime("%Jf")              # => "安政7年3月17日" (日本の旧暦)
+d.strftime("皇紀%Ji年%Jm月%Jd日") # => "皇紀2520年3月17日" (日本の旧暦で神武天皇即位紀元年)
+```
 
-== 追加フォーマット文字列一覧
+### Rails I18n から使う場合
+
+strftime が拡張されるので、 `config/locale/ja.yml` にそのままフォーマット文字列が指定できます。例えば
+
+```yaml
+  ja:
+    date:
+      formats:
+        default: "%JF"
+```
+
+の様にすると、 I18n.l (I18n.localize) の出力が標準で和暦日本語になります。
+標準は変更せず、特定の箇所で使い分けたい場合は、例えば、
+
+```yaml
+  ja:
+    date:
+      formats:
+        ja_kan: "%JF"
+```
+
+の様に別のフォーマットキーを設定して、以下のように呼び出し時に `format` に指定します。
+
+```erb
+  <%= I18n.l Date.today, format: :ja_kan %>
+```
+
+## 追加フォーマット文字列一覧
 
 * %Jf: "%Je%Jg年%Js%Jl月%Jd日" の略 (例: 平成23年3月12日)
 * %JF: "%Je%JGK年%JLk%JSk月%JDk日" の略 (例: 平成二十三年三月十二日)
@@ -112,7 +151,7 @@ Gemfile に以下のようにするか、
 * %JDk: 和暦日の漢数字
 * %JDK: 和暦日の漢数字の特殊記法 (朔、晦)
 
-== 仕様、限界、制限など
+## 仕様、限界、制限など
 
 * 作者は暦の専門家ではまったくありません。ツッコミお待ちしています。
 * 皇紀と旧暦が出力できますが、旧暦445年1月1日(先発グレゴリオ暦で445年1月25日)より前の日付はサポートしていません。扱おうとすると Wareki::UnsupportedDateRange 例外を上げます。
@@ -126,17 +165,17 @@ Gemfile に以下のようにするか、
 * 将来の日付に関しては、現在の元号がずっと継続しているとみなします
 * 日本でユリウス暦は使われていないので、Date::JAPAN は単にグレゴリオ暦への改暦日の目安、と言うだけです。Date.new で使う意味はほぼありません。
 
-== 参照元データ
+## 参照元データ
 
 作成には以下のデータを参照しました。
 
-* 旧暦: {suikawiki - 旧暦}[http://wiki.suikawiki.org/n/%E6%97%A7%E6%9A%A6#section-%E5%AF%BE%E7%85%A7%E8%A1%A8%E3%81%A8%E5%A4%89%E6%8F%9B%E3%83%84%E3%83%BC%E3%83%AB] にある「日本暦日原典」第4版準拠の先発グレゴリオ暦対照表
-* 元号: {Wikipedia - 元号一覧_(日本)}[https://ja.wikipedia.org/wiki/%E5%85%83%E5%8F%B7%E4%B8%80%E8%A6%A7_%28%E6%97%A5%E6%9C%AC%29] のユリウス歴とグレゴリオ暦表記の物を利用しています
+* 旧暦: [suikawiki - 旧暦](http://wiki.suikawiki.org/n/%E6%97%A7%E6%9A%A6#section-%E5%AF%BE%E7%85%A7%E8%A1%A8%E3%81%A8%E5%A4%89%E6%8F%9B%E3%83%84%E3%83%BC%E3%83%AB) にある「日本暦日原典」第4版準拠の先発グレゴリオ暦対照表
+* 元号: [Wikipedia - 元号一覧_(日本)](https://ja.wikipedia.org/wiki/%E5%85%83%E5%8F%B7%E4%B8%80%E8%A6%A7_%28%E6%97%A5%E6%9C%AC%29) のユリウス歴とグレゴリオ暦表記の物に基づいています
 
-== ライセンス
+## ライセンス
 
-{The BSD 2-Clause License}[https://opensource.org/licenses/BSD-2-Clause]
+[The BSD 2-Clause License](https://opensource.org/licenses/BSD-2-Clause)
 
-== 作者
+## 作者
 
 Tatsuki Sugiura <sugi@nemui.org>

data/lib/wareki/date.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'date'
+require 'ya_kansuji'
 require 'wareki/common'
 require 'wareki/utils'
 require 'wareki/kansuji'
@@ -31,7 +32,7 @@ module Wareki
       if (era.nil? || era == '') && match[:year].nil?
         year = Date.today.year
       else
-        (year = Kansuji.k2i(match[:year])) > 0 or
+        (year = Utils.k2i(match[:year])) > 0 or
           raise ArgumentError, "Invalid year: #{str}"
       end
       month = day = 1
@@ -40,7 +41,7 @@ module Wareki
         raise ArgumentError, "Date parse failed: Invalid era name '#{match[:era_name]}'"
 
       if match[:month]
-        month = Kansuji.k2i(match[:month])
+        month = Utils.k2i(match[:month])
       elsif match[:alt_month]
         month = Utils.alt_month_name_to_i(match[:alt_month])
       end
@@ -52,7 +53,7 @@ module Wareki
         if match[:day] == '晦'
           day = Utils.last_day_of_month(ERA_BY_NAME[era].year + year - 1, month, match[:is_leap])
         else
-          day = Kansuji.k2i(match[:day])
+          day = Utils.k2i(match[:day])
         end
       end
 
@@ -168,32 +169,32 @@ module Wareki
       case key.to_sym
       when :e  then era_name
       when :g  then era_name.to_s == '' ? '' : era_year
-      when :G  then era_name.to_s == '' ? '' : Kansuji.i2z(era_year)
-      when :Gk then era_name.to_s == '' ? '' : Kansuji.i2k(era_year)
+      when :G  then era_name.to_s == '' ? '' : Utils.i2z(era_year)
+      when :Gk then era_name.to_s == '' ? '' : YaKansuji.to_kan(era_year, :simple)
       when :GK
         if era_name.to_s == ''
           ''
         elsif era_year == 1
           '元'
         else
-          Kansuji.i2k(era_year)
+          YaKansuji.to_kan(era_year, :simple)
         end
       when :o  then year
-      when :O  then Kansuji.i2z(year)
-      when :Ok then Kansuji.i2k(year)
+      when :O  then Utils.i2z(year)
+      when :Ok then YaKansuji.to_kan(year, :simple)
       when :i  then imperial_year
-      when :I  then Kansuji.i2z(imperial_year)
-      when :Ik then Kansuji.i2k(imperial_year)
+      when :I  then Utils.i2z(imperial_year)
+      when :Ik then YaKansuji.to_kan(imperial_year, :simple)
       when :s  then month
-      when :S  then Kansuji.i2z(month)
-      when :Sk then Kansuji.i2k(month)
+      when :S  then Utils.i2z(month)
+      when :Sk then YaKansuji.to_kan(month, :simple)
       when :SK then Utils.alt_month_name(month)
       when :l  then leap_month? ? "'" : ''
       when :L  then leap_month? ? '’' : ''
       when :Lk then leap_month? ? '閏' : ''
       when :d  then day
-      when :D  then Kansuji.i2z(day)
-      when :Dk then Kansuji.i2k(day)
+      when :D  then Utils.i2z(day)
+      when :Dk then YaKansuji.to_kan(day, :simple)
       when :DK
         if month == 1 && !leap_month? && day == 1
           '元'
@@ -202,7 +203,7 @@ module Wareki
         elsif day == Utils.last_day_of_month(year, month, leap_month?)
           '晦'
         else
-          Kansuji.i2k(day)
+          YaKansuji.to_kan(day, :simple)
         end
       when :m  then "#{format(:s)}#{format(:l)}"
       when :M  then "#{format(:Lk)}#{format(:S)}"

data/lib/wareki/kansuji.rb

@@ -1,104 +1,28 @@
 # frozen_string_literal: true
 
+require 'ya_kansuji'
+require 'wareki/utils'
+
 module Wareki
-  # Utilities of kansuji/integer converter.
+  # [DEPRECATED] Utilities of kansuji/integer converter.
   module Kansuji
-    UNIT_SUFFIX1 = {
-      '千' => 1000,
-      '百' => 100,
-      '十' => 10,
-      '' => 1,
-    }.freeze
-    UNIT_SUFFIX2 = {
-      '京' => 10_000_000_000_000_000,
-      '兆' => 1_000_000_000_000,
-      '億' => 100_000_000,
-      '万' => 10_000,
-      '' => 1,
-    }.freeze
-
     module_function
 
+    # DEPRECATED
     def kan_to_i(str)
-      str = str.to_s.tr(
-        '〇一二三四五六七八九０１２３４５６７８９零正元朔壱壹弌弐貳貮参參弎肆伍陸漆質柒捌玖拾什陌佰阡仟萬',
-        '01234567890123456789011111122233345677789十十百百千千万'
-      )
-      ret3 = 0
-      ret4 = 0
-      curnum = nil
-      str.each_char do |c|
-        case c
-        when '1', '2', '3', '4', '5', '6', '7', '8', '9'
-          if curnum
-            curnum *= 10
-          else
-            curnum = 0
-          end
-          curnum += c.to_i
-        when '0'
-          curnum and curnum *= 10
-        when '卄', '廿'
-          ret3 += 20
-          curnum = nil
-        when '卅', '丗'
-          ret3 += 30
-          curnum = nil
-        when '卌'
-          ret3 += 40
-          curnum = nil
-        when '皕'
-          ret3 += 200
-          curnum = nil
-        when '万', '億', '兆', '京', '垓'
-          if curnum
-            ret3 += curnum
-            curnum = nil
-          end
-          ret3 = 1 if ret3.zero?
-          ret4 += ret3 * 10**((%w[万 億 兆 京 垓].index(c) + 1) * 4)
-          ret3 = 0
-        when '十', '百', '千'
-          curnum ||= 1
-          ret3 += curnum * 10**(%w[十 百 千].index(c) + 1)
-          curnum = nil
-        end
-      end
-      if curnum
-        ret3 += curnum
-        curnum = nil
-      end
-      ret4 + ret3
+      warn '[DEPRECATED] Wareki::Kansuji.kan_to_i: Please use ya_kansuji gem to handle kansuji'
+      Utils.k2i str
     end
 
+    # DEPRECATED
     def i_to_kan(num)
-      ret = ''
-      UNIT_SUFFIX2.each do |unit4, rank4|
-        i4 = (num / rank4).to_i % 10_000
-        next if i4.zero?
-
-        if i4 == 1
-          ret += "一#{unit4}"
-          next
-        end
-
-        UNIT_SUFFIX1.each do |unit1, rank1|
-          i1 = (i4 / rank1).to_i % 10
-          next if i1.zero?
-
-          if i1 == 1 && unit1 != ''
-            ret += unit1
-          else
-            ret += i1.to_s.tr('123456789', '一二三四五六七八九') + unit1
-          end
-        end
-        ret += unit4
-      end
-      ret
+      warn '[DEPRECATED] Wareki::Kansuji.i_to_kan: Please use ya_kansuji gem to handle kasuji'
+      YaKansuji.to_kan num
     end
 
     def i_to_zen(num)
-      num.to_s.tr('0123456789', '０１２３４５６７８９')
+      warn '[DEPRECATED] Wareki::Kansuji.i_to_zen: Use Wareki::Utils.i2z'
+      Utils.i2z num
     end
 
     class << self

data/lib/wareki/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ya_kansuji'
+
 module Wareki
   # Static utility methods.
   module Utils
@@ -95,5 +97,30 @@ module Wareki
       end
       nil
     end
+
+    def i2z(num)
+      num.to_s.tr('0123456789', '０１２３４５６７８９')
+    end
+
+    def k2i(str)
+      str = str.to_s.strip
+      if %w(正 元 朔).member? str
+        1
+      else
+        YaKansuji.to_i str
+      end
+    end
+
+    # DEPRECATED
+    def kan_to_i(*args)
+      warn '[DEPRECATED] Wareki::Utils.kan_to_i: Please use ya_kansuji gem to handle kansuji'
+      k2i(*args)
+    end
+
+    # DEPRECATED
+    def i_to_kan(*args)
+      warn '[DEPRECATED] Wareki::Utils.i_to_kan: Please use ya_kansuji gem to handle kansuji'
+      i2k(*args)
+    end
   end
 end

data/lib/wareki/version.rb

@@ -1,3 +1,3 @@
 module Wareki
-  VERSION = '0.4.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: wareki
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Tatsuki Sugiura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ya_kansuji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +83,7 @@ extra_rdoc_files: []
 files:
 - ChangeLog
 - LICENSE
-- README.rdoc
+- README.md
 - lib/wareki.rb
 - lib/wareki/calendar_def.rb
 - lib/wareki/common.rb