era_ja 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccca4808e214d0277f4dc83b3a3a7f131b619807
-  data.tar.gz: ac2d02db9b31485f244ce04ff8938fdee6530693
+  metadata.gz: e63d396e7ea8b3fe5708d1612595222f744a3077
+  data.tar.gz: 5f157527bcb37159862adbed9adde21956243d9c
 SHA512:
-  metadata.gz: 2f1a77b0833a94bcc00fbdbe47a051cd45e876ada349637c9a6d0eb243dd3e86b4d5b83e076b158726c24a26f4c45e52e0a571d7a8e8e042a9befd333b7e12c8
-  data.tar.gz: f3a48f2bb1b1632e6b2bfd6e0cd8302d170a44c2e19cb8fa42d3286aa691e6988b0fcfd008c7d671deb6138cd1587d0a44b7a43ec510f7e6b412c1eabfc3a452
+  metadata.gz: 8c7f9a91eafad1b8a20d245fcbe3e35879b0d429b32c218a496275953d1e56f433f84be7eaf80d64c1ecccf34307069469c9a0b896744b6a9f163fcf866dc8d2
+  data.tar.gz: e2d0b8aecc5e2f7c46d23ebc37f306e387fb9833ccfbccc6ece0984bb8dc34a2c7f0e57266e4d5c13f8fa6466d8af2425564e401fd45e6b16c3353fd91dd78ee

data/README.ja.md

@@ -18,7 +18,9 @@
 
 ### ruby version ###
 
-era_jaはruby1.9.3とruby2.0.0でテストをしています。
+era_jaはruby2.0.0とruby2.1.x, 2.2.xでテストをしています。(xは現時点での最後のバージョンです)
+
+**NOTE** :: era_ja0.4.0からruby1.9.3をサポートしていません。
 
 ## Usage
 
@@ -35,27 +37,39 @@ EraJa#to_eraメソッドでの追加のフォーマット文字列は以下の
 ### Timeインスタンスを和暦に変換します。
 
 ```ruby
-	require 'era_ja/time'
-	Time.mktime(2012,4,29).to_era   # => "H24.4.29"
-	Time.mktime(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
-	Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
+require 'era_ja'
+Time.mktime(2012,4,29).to_era   # => "H24.4.29"
+Time.mktime(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
+Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
 ```
 
 ### Dateインタンスを和暦に変換します。
 
 ```ruby
-	require 'era_ja/date'
-	Date.new(2012,4,29).to_era     # => "H24.4.29"
-	Date.new(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
-	Date.new(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
+require 'era_ja
+Date.new(2012,4,29).to_era     # => "H24.4.29"
+Date.new(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
+Date.new(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
 ```
 
 ### 数字を漢数字に変換します。 ###
 
 
 ```ruby
-	Time.mktime(2012,4,29).to_era("%Jy年%Jm月%Jd日") # => "二千十二年四月二十九日"
-	Date.new(2012,4,29).to_era("%Jy年%Jm月%Jd日")    # => "二千十二年四月二十九日"
+Time.mktime(2012,4,29).to_era("%Jy年%Jm月%Jd日") # => "二千十二年四月二十九日"
+Date.new(2012,4,29).to_era("%Jy年%Jm月%Jd日")    # => "二千十二年四月二十九日"
+```
+
+### Era names ###
+
+もしデフォルトの元号文字列以外の文字列でコンバートしたい場合、 `era_names` を使用することができます。
+
+```ruby
+require 'era_ja'
+Time.mktime(2012,4,29).to_era(era_names: { heisei: ['h', '平'] })                       # => "h24.4.29"
+Time.mktime(2012,4,29).to_era("%O%E年%m月%d日", era_names: { heisei: ['h', '平'] })     # => "平24年4月29日"
+Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日", era_names: { heisei: ['h', '平'] })  # => "平二十四年四月二十九日"
+# same as Date
 ```
 
 ## Support

data/README.md

@@ -18,7 +18,9 @@ Or install it yourself as:
 
 ### ruby version ###
 
-era_ja was run test on ruby 1.9.3 and ruby 2.0.0
+era_ja was run test on ruby 2.0.0 and ruby 2.1.x and ruby 2.2.x .(x is latest version)
+
+**NOTE** :: era_ja does not support ruby 1.9.3 since 0.4.0
 
 ## Usage
 
@@ -36,26 +38,38 @@ EraJa#to_era of extra format string is follow.
 ### Time instance to japanese era
 
 ```ruby
-	require 'era_ja'
-	Time.mktime(2012,4,29).to_era   # => "H24.4.29"
-	Time.mktime(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
-	Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
+require 'era_ja'
+Time.mktime(2012,4,29).to_era   # => "H24.4.29"
+Time.mktime(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
+Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
 ```
 
 ### Date instance to japanese era
 
 ```ruby
-	require 'era_ja'
-	Date.new(2012,4,29).to_era     # => "H24.4.29"
-	Date.new(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
-	Date.new(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
+require 'era_ja'
+Date.new(2012,4,29).to_era     # => "H24.4.29"
+Date.new(2012,4,29).to_era("%O%E年%m月%d日") # => "平成24年4月29日"
+Date.new(2012,4,29).to_era("%O%JE年%Jm月%Jd日") # => "平成二十四年四月二十九日"
 ```
 
 ### Change number to kansuuzi ###
 
 ```ruby
-	Time.mktime(2012,4,29).to_era("%Jy年%Jm月%Jd日") # => "二千十二年四月二十九日"
-	Date.new(2012,4,29).to_era("%Jy年%Jm月%Jd日")    # => "二千十二年四月二十九日"
+Time.mktime(2012,4,29).to_era("%Jy年%Jm月%Jd日") # => "二千十二年四月二十九日"
+Date.new(2012,4,29).to_era("%Jy年%Jm月%Jd日")    # => "二千十二年四月二十九日"
+```
+
+### Era names ###
+
+If you want to convert custom ara string, you can set `era_names` .
+
+```ruby
+require 'era_ja'
+Time.mktime(2012,4,29).to_era(era_names: { heisei: ['h', '平'] })                       # => "h24.4.29"
+Time.mktime(2012,4,29).to_era("%O%E年%m月%d日", era_names: { heisei: ['h', '平'] })     # => "平24年4月29日"
+Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日", era_names: { heisei: ['h', '平'] })  # => "平二十四年四月二十九日"
+# same as Date
 ```
 
 ## Support

data/lib/era_ja/conversion.rb

@@ -3,7 +3,12 @@ require 'date'
 
 module EraJa
   module Conversion
-    ERA = [["M", "明治"], ["T", "大正"], ["S", "昭和"], ["H", "平成"]]
+    ERA_NAME_DEFAULTS = {
+      meiji:  ["M", "明治"],
+      taisho: ["T", "大正"],
+      showa:  ["S", "昭和"],
+      heisei: ["H", "平成"]
+    }
 
     # Convert to Japanese era.
     # @param [String] format_string
@@ -13,8 +18,13 @@ module EraJa
     #   * %O - era(kanzi)
     #   * %E - era year
     #   * %J - kanzi number
+    # @param [Hash] era_names
+    #    If you want to convert custom era string(ex `平`, `h`), you can set this argument.
+    #    key is `:meiji' or `:taisho' or `:showa` or `:heisei`.
+    #    value is ["alphabet era name"(ex `h`, `s`)(related to `%o`), "multibyte ara name"(ex `平`, `昭`)(related to `%O`)].
+    #    this argument is same as one element of ERA_NAME_DEFAULTS.
     # @return [String]
-    def to_era(format = "%o%E.%m.%d")
+    def to_era(format = "%o%E.%m.%d", era_names: ERA_NAME_DEFAULTS)
       @era_format = format.dup
       @era_format.gsub!(/%J/, "%J%")
       @era_format.sub!(/%o/i) { |m| m + ' ' }
@@ -24,28 +34,28 @@ module EraJa
         if self.to_time < ::Time.mktime(1868,9,8)
           raise "#to_era is expeted later in 1868,9,8"
         elsif self.to_time < ::Time.mktime(1912,7,30)
-          str_time = era_year(year - 1867, 'M')
+          str_time = era_year(year - 1867, :meiji, era_names)
         elsif self.to_time < ::Time.mktime(1926,12,25)
-          str_time = era_year(year - 1911, 'T')
+          str_time = era_year(year - 1911, :taisho, era_names)
         elsif self.to_time < ::Time.mktime(1989,1,8)
-          str_time = era_year(year - 1925, 'S')
+          str_time = era_year(year - 1925, :showa, era_names)
         else
-          str_time = era_year(year - 1988, 'H')
+          str_time = era_year(year - 1988, :heisei, era_names)
         end
       end
       str_time.gsub(/%J(\d+)/) { to_kanzi($1) }
     end
 
     private
-    def era_year(year, era)
-      strftime(@era_format).sub(/(%J)?%E /) { format_year(year, $1) }.sub(/%o /i) { format_era(era) }
+    def era_year(year, era, era_names)
+      strftime(@era_format).sub(/(%J)?%E /) { format_year(year, $1) }.sub(/%o /i) { format_era(era, era_names) }
     end
 
-    def format_era(string)
+    def format_era(era, era_names)
       if @era_format =~ /%o/
-        return "#{ERA.detect{ |i| i[0] == string}[0]}"
+        return era_names.fetch(era)[0]
       elsif @era_format =~ /%O/
-        return "#{ERA.detect{ |i| i[0] == string}[1]}"
+        return era_names.fetch(era)[1]
       end
     end
 

data/lib/era_ja/version.rb

@@ -1,3 +1,3 @@
 module EraJa
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/spec_helper.rb

@@ -9,6 +9,25 @@ RSpec.shared_examples "should equal 'H24.04.29'" do
   end
 end
 
+RSpec.shared_examples "should equal 'h24.04.29'" do
+  context "with era_names option" do
+    context "when era_names is correct" do
+      let(:era_names) { { heisei: ["h", "平成"] } }
+      it { expect(subject.to_era(era_names: era_names)).to eq "h24.04.29" }
+    end
+
+    context "when era_names have no heisei values" do
+      let(:era_names) { { showa: ["s", "昭和"] } }
+      it { expect { subject.to_era(era_names: era_names) }.to raise_error }
+    end
+  end
+
+  context "with '%o%E.%m.%d' and era_names option" do
+    let(:era_names) { { heisei: ["h", "平成"] } }
+    it { expect(subject.to_era("%o%E.%m.%d", era_names: era_names)).to eq "h24.04.29" }
+  end
+end
+
 RSpec.shared_examples "should equal '平成24年04月29日'" do
   context "with '%O%E年%m月%d日'" do
     it { expect(subject.to_era("%O%E年%m月%d日")).to eq "平成24年04月29日" }
@@ -33,6 +52,22 @@ RSpec.shared_examples "should equal '平成240429'" do
   end
 end
 
+RSpec.shared_examples "should equal '平240429'" do
+  context "with '%O%E%m%d' and era_names option" do
+    let(:format) { "%O%E%m%d" }
+
+    context "when era_names is correct" do
+      let(:era_names) { { heisei: ["H", "平"] } }
+      it { expect(subject.to_era(format, era_names: era_names)).to eq '平240429' }
+    end
+
+    context "when era_names have no heisei values" do
+      let(:era_names) { { showa: ["S", "昭"] } }
+      it { expect { subject.to_era(format, era_names: era_names) }.to raise_error }
+    end
+  end
+end
+
 RSpec.shared_examples "should equal '平成二十四年四月二十九日'" do
   context "with '%O%JE年%Jm月%Jd日'" do
     it { expect(subject.to_era('%O%JE年%Jm月%Jd日')).to eq '平成二十四年四月二十九日' }
@@ -103,10 +138,12 @@ end
 
 RSpec.shared_examples "2012,4,29" do
   include_examples "should equal 'H24.04.29'"
+  include_examples "should equal 'h24.04.29'"
   include_examples "should equal '平成24年04月29日'"
   include_examples "should equal '24.04.29'"
   include_examples "should equal '2404'"
   include_examples "should equal '平成240429'"
+  include_examples "should equal '平240429'"
   include_examples "should equal '2012年04月29日'"
   include_examples "should equal '平成二十四年四月二十九日'"
   include_examples "should equal '二千十二年四月二十九日'"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: era_ja
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - tomi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake