era_ja 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f5955178ca4a898c771451e6b33345acf59352ae6d89a1fc1334da5b0e2e3a
-  data.tar.gz: baef3d1dcc782d26d062095479f6f6121941d2a258e3870dbecbc1080fa3eaba
+  metadata.gz: 38838bfc2c49efc21bfb6ea0ad206af0cdda6d67c66e21eb786d02990e1c2edd
+  data.tar.gz: 2fe65c8cf87ea96e14840c0835f02a87469ac92e2b3cbaddc008284d39691bcf
 SHA512:
-  metadata.gz: a501415e87bc28d933553835d1baca333d5c67cd15becf01fca6cbe71ca662cf20e56e427e2bcbfb72dab2650026a1bdd96299ce37ca120614c4028420ac044b
-  data.tar.gz: f95522ba00aadfb7f3a97d3eaeb0b7a958f7817e20c3d0a76a618a9b34ef515022223792b794e04c568e8234c2d71607d3d237e7ba79ec203e9ffd91ce1760dd
+  metadata.gz: 6c7c3e10a11d56a7c33670629e4570f2e4b19a935d42a53d6f1a825846cc660fe70eb8d7035466541e9536919c34b3a3b5c992b95a5db4a3e3137e19fe98c523
+  data.tar.gz: 8940a5d449b38cce4be8e10f54f228ca78afdc24743d51956748490eb058f42804e999094ae0de7d9496cc74ecc1f6bb98c186364bf2369a44fb9bc2c676d3fb

data/README.ja.md

@@ -79,6 +79,18 @@ Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日", era_names: { heisei: ['h',
 # same as Date
 ```
 
+### 元号に変換できるかどうかの判定方法 ###
+
+日付が元号に変換できるかどうかを判定するために、`era_convertible?` を使うことができます。
+
+```ruby
+require 'era_ja'
+Time.mktime(1868,9,7).era_convertible? #=> false
+Time.mktime(1868,9,8).era_convertible? #=> true
+```
+
+元号に変換できない日付に関しては、[Noteセクション](#note) を参照してください。
+
 ## Support
 
 問題を報告したり、機能追加の要望する場合はgithubのIssuesに登録してください。 https://github.com/tomiacannondale/era_ja/issues

data/README.md

@@ -80,6 +80,18 @@ Time.mktime(2012,4,29).to_era("%O%JE年%Jm月%Jd日", era_names: { heisei: ['h',
 # same as Date
 ```
 
+### Checking a date is convertible ###
+
+You can use `era_convertible?` to check if a given date is convertible or not.
+
+```ruby
+require 'era_ja'
+Time.mktime(1868,9,7).era_convertible? #=> false
+Time.mktime(1868,9,8).era_convertible? #=> true
+```
+
+See [Note](#note) section for more details.
+
 ## Support
 
 Report issues and feature requests to github Issues. https://github.com/tomiacannondale/era_ja/issues

data/lib/era_ja.rb

@@ -2,3 +2,4 @@
 require "era_ja/version"
 require "era_ja/date"
 require "era_ja/time"
+require "era_ja/error"

data/lib/era_ja/conversion.rb

@@ -8,11 +8,9 @@ module EraJa
       taisho: ["T", "大正"],
       showa:  ["S", "昭和"],
       heisei: ["H", "平成"],
-      reiwa: ["R", "令和"]
+      reiwa:  ["R", "令和"]
     }.freeze
 
-    ERR_DATE_OUT_OF_RANGE = "#to_era only works on dates after 1868,9,8".freeze
-
     # Convert to Japanese era.
     # @param [String] format_string
     #   Time#strftime format string can be used
@@ -28,12 +26,12 @@ module EraJa
     #    this argument is same as one element of ERA_NAME_DEFAULTS.
     # @return [String]
     def to_era(format = "%o%E.%m.%d", era_names: ERA_NAME_DEFAULTS)
+      raise EraJa::DateOutOfRangeError unless era_convertible?
+
       @era_format = format.gsub(/%J/, "%J%")
       str_time = strftime(@era_format)
       if @era_format =~ /%([EOo]|1O)/
         case
-        when self.to_time < ::Time.mktime(1868,9,8)
-          raise ERR_DATE_OUT_OF_RANGE
         when self.to_time < ::Time.mktime(1912,7,30)
           str_time = era_year(year - 1867, :meiji, era_names)
         when self.to_time < ::Time.mktime(1926,12,25)
@@ -49,6 +47,10 @@ module EraJa
       str_time.gsub(/%J(\d+)/) { to_kanzi($1) }
     end
 
+    def era_convertible?
+      self.to_time >= ::Time.mktime(1868,9,8)
+    end
+
     private
     def era_year(year, era, era_names)
       strftime(@era_format).sub(/(%J)?%E/) { format_year(year, $1) }.sub(/%1?o/i) { format_era(era, era_names) }

data/lib/era_ja/error.rb

@@ -0,0 +1,9 @@
+module EraJa
+  class DateOutOfRangeError < StandardError
+    ERR_DATE_OUT_OF_RANGE = "#to_era only works on dates after 1868,9,8".freeze
+
+    def message
+      ERR_DATE_OUT_OF_RANGE
+    end
+  end
+end

data/lib/era_ja/version.rb

@@ -1,3 +1,3 @@
 module EraJa
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/date_spec.rb

@@ -5,6 +5,11 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 RSpec.describe Date do
   describe "#to_era" do
 
+    context "date is 2020,1,1" do
+      subject { Date.new(2020,1,1) }
+      include_examples "2020,1,1"
+    end
+
     context "date is 2019,7,2" do
       subject { Date.new(2019,7,2) }
       include_examples "2019,7,2"
@@ -68,4 +73,20 @@ RSpec.describe Date do
 
   end
 
+  describe "#era_convertible?" do
+
+    context "when date is not convertible" do
+      it "returns false" do
+        expect(Date.new(1868,9,7).era_convertible?).to be false
+      end
+    end
+
+    context "when date is convertible" do
+      it "returns true" do
+        expect(Date.new(1868,9,8).era_convertible?).to be true
+      end
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require 'rspec'
+require File.expand_path('../lib/era_ja/error', File.dirname(__FILE__))
 
 RSpec.shared_examples "should equal 'R01.07.02'" do
   it { expect(subject.to_era).to eq "R01.07.02" }
@@ -23,12 +24,114 @@ RSpec.shared_examples "should equal 'R01.05.01'" do
   end
 end
 
+RSpec.shared_examples "should equal 'r01.05.01'" do
+  context "with era_names option" do
+    context "when era_names is correct" do
+      let(:era_names) { { reiwa: ["r", "令和"] } }
+      it { expect(subject.to_era(era_names: era_names)).to eq "r01.05.01" }
+    end
+
+    context "when era_names have no reiwa values" do
+      let(:era_names) { { heisei: ["h", "平成"] } }
+      it { expect { subject.to_era(era_names: era_names) }.to raise_error(KeyError) }
+    end
+  end
+
+  context "with '%o%E.%m.%d' and era_names option" do
+    let(:era_names) { { reiwa: ["r", "令和"] } }
+    it { expect(subject.to_era("%o%E.%m.%d", era_names: era_names)).to eq "r01.05.01" }
+  end
+end
+
 RSpec.shared_examples "should equal '令和01年05月01日'" do
   context "with '%O%E年%m月%d日'" do
     it { expect(subject.to_era("%O%E年%m月%d日")).to eq "令和01年05月01日" }
   end
 end
 
+RSpec.shared_examples "should equal '令01年05月01日'" do
+  context "with '%1O%E年%m月%d日'" do
+    it { expect(subject.to_era("%1O%E年%m月%d日")).to eq "令01年05月01日" }
+  end
+end
+
+RSpec.shared_examples "should equal '01.05.01'" do
+  context "with '%E.%m.%d'" do
+    it { expect(subject.to_era("%E.%m.%d")).to eq "01.05.01" }
+  end
+end
+
+RSpec.shared_examples "should equal '0105'" do
+  context "with '%E%m'" do
+    it { expect(subject.to_era("%E%m")).to eq "0105" }
+  end
+end
+
+RSpec.shared_examples "should equal '令和010501'" do
+  context "with '%O%E%m%d'" do
+    it { expect(subject.to_era("%O%E%m%d")).to eq "令和010501" }
+  end
+end
+
+RSpec.shared_examples "should equal '令010501'" 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) { { reiwa: ["R", "令"] } }
+      it { expect(subject.to_era(format, era_names: era_names)).to eq '令010501' }
+    end
+
+    context "when era_names have no heisei values" do
+      let(:era_names) { { heisei: ["H", "平"] } }
+      it { expect { subject.to_era(format, era_names: era_names) }.to raise_error(KeyError) }
+    end
+  end
+end
+
+RSpec.shared_examples "should equal '2019年05月01日'" do
+  context "with '%y年%m月%d日'" do
+    it { expect(subject.to_era('%Y年%m月%d日')).to eq '2019年05月01日' }
+  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 '令和元年五月一日' }
+  end
+end
+
+RSpec.shared_examples "should equal '二千十九年五月一日'" do
+  context "with '%JY年%Jm月%Jd日'" do
+    it { expect(subject.to_era('%JY年%Jm月%Jd日')).to eq '二千十九年五月一日' }
+  end
+end
+
+
+RSpec.shared_examples "should equal '令和'" do
+  context "with '%O'" do
+    it { expect(subject.to_era('%O')).to eq '令和' }
+  end
+end
+
+RSpec.shared_examples "should equal '令'" do
+  context "with '%1O'" do
+    it { expect(subject.to_era('%1O')).to eq '令' }
+  end
+end
+
+RSpec.shared_examples "should equal 'R'" do
+  context "with '%o'" do
+    it { expect(subject.to_era('%o')).to eq 'R' }
+  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 '令和二年一月一日' }
+  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 "平成三十一年四月三十日" }
@@ -209,7 +312,11 @@ RSpec.shared_examples "should equal 'M01.09.08'" do
 end
 
 RSpec.shared_examples "should raise error" do
-  it { expect {subject.to_era}.to raise_error(RuntimeError, EraJa::Conversion::ERR_DATE_OUT_OF_RANGE) }
+  it { expect {subject.to_era}.to raise_error(EraJa::DateOutOfRangeError, EraJa::DateOutOfRangeError::ERR_DATE_OUT_OF_RANGE) }
+end
+
+RSpec.shared_examples "2020,1,1" do
+  include_examples "should equal '令和二年一月一日'"
 end
 
 RSpec.shared_examples "2019,7,2" do
@@ -219,7 +326,19 @@ end
 
 RSpec.shared_examples "2019,5,1" do
   include_examples "should equal 'R01.05.01'"
+  include_examples "should equal 'r01.05.01'"
   include_examples "should equal '令和01年05月01日'"
+  include_examples "should equal '令01年05月01日'"
+  include_examples "should equal '01.05.01'"
+  include_examples "should equal '0105'"
+  include_examples "should equal '令和010501'"
+  include_examples "should equal '令010501'"
+  include_examples "should equal '2019年05月01日'"
+  include_examples "should equal '令和元年五月一日'"
+  include_examples "should equal '二千十九年五月一日'"
+  include_examples "should equal '令和'"
+  include_examples "should equal '令'"
+  include_examples "should equal 'R'"
 end
 
 RSpec.shared_examples "2019,4,30" do

data/spec/time_spec.rb

@@ -5,6 +5,11 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 RSpec.describe Time do
   describe "#to_era" do
 
+    context 'time is 2020,1,1' do
+      subject { Time.mktime(2020,1,1) }
+      include_examples "2020,1,1"
+    end
+
     context 'time is 2019,7,2' do
       subject { Time.mktime(2019,7,2) }
       include_examples "2019,7,2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: era_ja
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - tomi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -115,6 +115,7 @@ files:
 - lib/era_ja.rb
 - lib/era_ja/conversion.rb
 - lib/era_ja/date.rb
+- lib/era_ja/error.rb
 - lib/era_ja/time.rb
 - lib/era_ja/version.rb
 - spec/date_spec.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Convert Date or Time instance to String of Japanese era.