zakuro 0.0.1 → 0.0.2

data/lib/zakuro/era/gengou/set-003-modern.yaml

@@ -3,10 +3,26 @@ name: "近代（一世一元）"
 end_date: "9999-12-31"
 list:
   - name: "明治"
-    start_date: "1868-1-25"
+    # 1年9月8日
+    start_year: 1
+    start_date: "1868-10-23"
+    new_year_date: "1868-1-25"
+    note: ""
   - name: "大正"
+    # 1年7月30日
+    start_year: 1
     start_date: "1912-7-30"
+    new_year_date: "1912-1-1"
+    note: ""
   - name: "昭和"
+    # 1年12月25日
+    start_year: 1
     start_date: "1926-12-25"
+    new_year_date: "1926-1-1"
+    note: ""
   - name: "令和"
-    start_date: "2019-5-1"
+    # -
+    start_year: 1
+    start_date: "2019-5-1"
+    new_year_date: "2019-1-1"
+    note: ""

data/lib/zakuro/era/japan.rb

@@ -97,6 +97,8 @@ module Zakuro
       attr_reader :name
       # @return [Western::Calendar] 開始日
       attr_reader :start_date
+      # @return [Western::Calendar] 元旦
+      attr_reader :new_year_date
       # @return [Western::Calendar] 終了日
       attr_reader :end_date
       # @return [Integer] 元号年
@@ -105,15 +107,18 @@ module Zakuro
       #
       # 初期化
       #
-      # @param [<Type>] name 元号名
-      # @param [<Type>] start_date 開始日
-      # @param [<Type>] end_date 終了日
-      # @param [<Type>] year 元号年
+      # @param [String] name 元号名
+      # @param [Western::Calendar] start_date 開始日
+      # @param [Western::Calendar] new_year_date 元旦
+      # @param [Western::Calendar] end_date 終了日
+      # @param [Integer] year 元号年
       #
       def initialize(name: '', start_date: Western::Calendar.new,
+                     new_year_date: Western::Calendar.new,
                      end_date: Western::Calendar.new, year: -1)
         @name = name
         @start_date = start_date
+        @new_year_date = new_year_date
         @end_date = end_date
         @year = year
       end
@@ -185,9 +190,14 @@ module Zakuro
       # 1元号年を追加する
       #
       def next_year
-        @year += 1
+        @year += 1 unless invalid?
         nil
       end
+
+      def to_s
+        "name: #{@name}, start_date: #{@start_date.format}, " \
+        "end_date: #{@end_date.format}, year: #{@year}"
+      end
     end
 
     #
@@ -269,6 +279,8 @@ module Zakuro
         attr_reader :name
         # @return [String] 開始日
         attr_reader :start_date
+        # @return [String] 元旦
+        attr_reader :new_year_date
         # @return [String] 開始年
         attr_reader :start_year
 
@@ -282,6 +294,7 @@ module Zakuro
           @index = index
           @name = hash['name']
           @start_date = hash['start_date']
+          @new_year_date = hash['new_year_date']
           @start_year = hash['start_year']
         end
 
@@ -298,9 +311,14 @@ module Zakuro
 
           failed.push(prefix + "invalid name. #{@name}") unless valid_name_type?
 
-          failed.push(prefix + "invalid start_date. #{@start_date}") unless valid_date_type?
+          failed.push(prefix + "invalid start_date. #{@start_date}") unless valid_start_date_type?
 
           failed.push(prefix + "invalid start_year. #{@start_year}") unless valid_year_type?
+
+          unless valid_new_year_date_type?
+            failed.push(prefix + "invalid new_year_date. #{@new_year_date}")
+          end
+
           failed
         end
 
@@ -317,15 +335,25 @@ module Zakuro
         end
 
         #
-        # 日付文字列を検証する
+        # 開始日文字列を検証する
         #
         # @return [True] 正しい
         # @return [False] 正しくない
         #
-        def valid_date_type?
+        def valid_start_date_type?
           Western::Calendar.valid_date_string(str: @start_date)
         end
 
+        #
+        # 元旦文字列を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def valid_new_year_date_type?
+          Western::Calendar.valid_date_string(str: @new_year_date)
+        end
+
         # :reek:NilCheck
 
         #
@@ -349,9 +377,11 @@ module Zakuro
         #
         def create
           start_date = Western::Calendar.parse(str: @start_date)
+          new_year_date = Western::Calendar.parse(str: @new_year_date)
           start_year = @start_year.nil? ? 1 : @start_year
 
-          Gengou.new(name: @name, start_date: start_date, year: start_year)
+          Gengou.new(name: @name, start_date: start_date, new_year_date: new_year_date,
+                     year: start_year)
         end
       end
 

data/lib/zakuro/era/western.rb

@@ -344,6 +344,16 @@ module Zakuro
         self
       end
 
+      #
+      # 無効値（引数なし）かどうかを検証する
+      #
+      # @return [True] 無効値
+      # @return [False] 無効値以外
+      #
+      def invalid?
+        (@date == Date.new)
+      end
+
       #
       # 年月日をフォーマット化する
       #

data/lib/zakuro/output/response.rb

@@ -68,15 +68,15 @@ module Zakuro
       # @return [Result::Year] 年データ
       #
       def self.save_year(year:)
-        gengou = year.gengou
-        first = gengou.first_line
-        second = gengou.second_line
+        multi_gengou = year.multi_gengou
+        first = multi_gengou.first_line
+        second = multi_gengou.second_line
         Result::Year.new(
           first_gengou:
             Result::Gengou.new(name: first.name, number: first.year),
           second_gengou:
             Result::Gengou.new(name: second.name, number: second.year),
-          zodiac_name: gengou.zodiac_name, total_days: gengou.total_days
+          zodiac_name: year.zodiac_name, total_days: year.total_days
         )
       end
       private_class_method :save_year

data/lib/zakuro/version.rb

@@ -3,5 +3,5 @@
 # :nodoc:
 module Zakuro
   # @return [String] library version
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/zakuro/version/senmyou/README.md

@@ -1,6 +1,6 @@
 # 宣明暦
 
-貞観4年1月1日（859/02/07）-貞享2年12月29日（1686/01/23）
+貞観4年1月1日（862/02/03）-貞享1年12月30日（1685/02/03）
 
 # 著者
 
@@ -100,6 +100,8 @@
 
 日本の旧暦（太陰太陽暦）において、元号は1月1日を境に改元または継続する
 
+NOTE: これは『日本暦日原典』をベースにした場合であり、多くの場合、実際の改元は1月1日ではない [返却される元号が実際の存在期間と一致しない](https://github.com/pldb/zakuro/issues/3)
+
 ここで問題となるのは、元号2年目以降はその前年までの計算結果が必要になることである
 
 西暦（太陽暦）のように1年あたりの日数は一定しない

data/lib/zakuro/version/senmyou/base/era.rb

@@ -12,6 +12,8 @@ module Zakuro
     # Era 宣明暦時代
     #
     module Era
+      # FIXME: JOUGAN_START_DATE は不要。'貞観' かどうかだけで良い
+
       # @return [Western::Calendar] 貞観1年1月1日
       JOUGAN_START_DATE = Western::Calendar.new(year: 859, month: 2, day: 7)
       # @return [Western::Calendar] 貞観4年1月1日

data/lib/zakuro/version/senmyou/base/multi_gengou.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative '../../../era/japan'
+require_relative '../../../era/western'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    #
+    # MultiGengou 複数元号
+    #
+    class MultiGengou
+      # @return [Japan::Gengou] 元号（1行目）
+      attr_reader :first_line
+      # @return [Japan::Gengou] 元号（2行目）
+      attr_reader :second_line
+      # @return [Western::Calendar] 元旦
+      attr_reader :new_year_date
+
+      def initialize(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new,
+                     new_year_date: Western::Calendar.new)
+        @first_line = first_line
+        @second_line = second_line
+        @new_year_date = new_year_date
+      end
+
+      # :reek:TooManyStatements { max_statements: 7 }
+
+      #
+      # 改元する
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [MultiGengou] 自身
+      #
+      def transfer(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new)
+        cloned_first_line = first_line.clone
+        cloned_second_line = second_line.clone
+
+        if integrated?(first_line: cloned_first_line, second_line: cloned_second_line)
+          @first_line = @second_line.clone
+          @second_line = cloned_second_line
+        end
+
+        @first_line = cloned_first_line if @first_line.name != first_line.name
+        @second_line = cloned_second_line if @second_line.name != second_line.name
+
+        self
+      end
+
+      #
+      # 次年にする
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [MultiGengou] 自身
+      #
+      def next_year
+        @first_line.next_year
+        @second_line.next_year
+
+        self
+      end
+
+      #
+      # ディープコピー
+      #
+      # @param [MultiGengou] obj 自身
+      #
+      def initialize_copy(obj)
+        @first_line = obj.first_line.clone
+        @second_line = obj.second_line.clone
+      end
+
+      private
+
+      #
+      # 複数元号を統一するかどうか
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [True] 統一する
+      # @return [False] 統一しない
+      #
+      def integrated?(first_line: Japan::Gengou.new, second_line: Japan::Gengou.new)
+        return false if @second_line.name != first_line.name
+
+        return false unless second_line.invalid?
+
+        true
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/base/multi_gengou_roller.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require_relative './era'
+require_relative './multi_gengou'
+
+require_relative '../../../era/japan'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # FIXME: 宣明暦に依存しない共通処理にする
+
+    #
+    # MultiGengouRoller 改元処理
+    #
+    class MultiGengouRoller
+      # @return [MultiGengou] 複数元号
+      attr_reader :multi_gengou
+      # @return [Western::Calendar] 元旦（元号が2つある場合は再過去の日付になる）
+      attr_reader :oldest_date
+      # @return [Western::Calendar] 元号内での最未来日（元号が2つある場合は再未来の日付になる）
+      attr_reader :newest_date
+      # @return [Western::Calendar] 現在日
+      attr_reader :current_date
+
+      def initialize(start_date: Era::START_DATE, end_date: Western::Calendar.new)
+        end_date = start_date if end_date.invalid?
+
+        @oldest_date = MultiGengouRoller.choise_oldest_gengou_date(
+          first_line: Era.first(start_date: start_date),
+          second_line: Era.second(start_date: start_date)
+        )
+        @current_date = @oldest_date.clone
+        @newest_date = MultiGengouRoller.choise_newest_gengou_date(
+          first_line: Era.first(start_date: end_date),
+          second_line: Era.second(start_date: end_date)
+        )
+
+        @multi_gengou = MultiGengou.new(
+          first_line: current_first_line,
+          second_line: current_second_line,
+          new_year_date: @oldest_date
+        )
+      end
+
+      #
+      # 現在日付を未来に進める
+      #
+      # @param [<Type>] days <description>
+      #
+      # @return [<Type>] <description>
+      #
+      def next(days: 0)
+        @current_date += days
+      end
+
+      #
+      # 現在日から元号（1行目）を取得する
+      #
+      # @return [Japan::Gengou] 元号（1行目）
+      #
+      def current_first_line
+        MultiGengouRoller.first_line(date: @current_date)
+      end
+
+      #
+      # 現在日から元号（2行目）を取得する
+      #
+      # @return [Japan::Gengou] 元号（2行目）
+      #
+      def current_second_line
+        MultiGengouRoller.second_line(date: @current_date)
+      end
+
+      #
+      # 改元する
+      #
+      # @return [MultiGengou] 複数元号
+      #
+      def transfer
+        MultiGengouRoller.transfer(multi_gengou: @multi_gengou, date: @current_date)
+      end
+
+      #
+      # 次年にする
+      #
+      # @return [MultiGengou] 複数元号
+      #
+      def next_year
+        @multi_gengou.next_year
+      end
+
+      #
+      # 元号（1行目）を取得する
+      #
+      # @return [Japan::Gengou] 元号（1行目）
+      #
+      def self.first_line(date: Western::Calender.new)
+        Era.first(start_date: date)
+      end
+
+      #
+      # 元号（2行目）を取得する
+      #
+      # @return [Japan::Gengou] 元号（2行目）
+      #
+      def self.second_line(date: Western::Calender.new)
+        Era.second(start_date: date)
+      end
+
+      #
+      # 改元する
+      #
+      # @param [MultiGengou] multi_gengou 複数元号
+      # @param [Western::Calendar] date 対象日
+      #
+      # @return [MultiGengou] 改元済み複数元号
+      #
+      def self.transfer(multi_gengou:, date:)
+        multi_gengou.transfer(
+          first_line: first_line(date: date),
+          second_line: second_line(date: date)
+        )
+
+        multi_gengou
+      end
+
+      #
+      # 現在日からみて直近の未来に対する元号の切替前日を求める
+      # @note 2つの元号が重複した場合はより過去の日となる
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [Western::Calendar] 元号の切替前日
+      #
+      def choise_nearest_end_date
+        condition = lambda do |first_date, second_date|
+          first_date < second_date ? first_date : second_date
+        end
+
+        second_line = current_second_line
+
+        MultiGengouRoller.choise_date(condition: condition, second_line: second_line,
+                                      first_date: current_first_line.end_date.clone,
+                                      second_date: second_line.end_date.clone)
+      end
+
+      #
+      # 最過去の元旦を求める
+      # @note 2つの元号が重複した場合はより過去の日となる
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [Western::Calendar] 最過去の元旦
+      #
+      def self.choise_oldest_gengou_date(first_line:, second_line:)
+        condition = lambda do |first_date, second_date|
+          first_date < second_date ? first_date : second_date
+        end
+        choise_date(condition: condition, second_line: second_line,
+                    first_date: first_line.new_year_date.clone,
+                    second_date: second_line.new_year_date.clone)
+      end
+
+      #
+      # 元号内での最未来日を求める
+      # @note 2つの元号が重複した場合はより未来の日となる
+      #
+      # @param [Japan::Gengou] first_line 元号（1行目）
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      #
+      # @return [Western::Calendar] 最未来日
+      #
+      def self.choise_newest_gengou_date(first_line:, second_line:)
+        condition = lambda do |first_date, second_date|
+          first_date > second_date ? first_date : second_date
+        end
+        choise_date(condition: condition, second_line: second_line,
+                    first_date: first_line.end_date.clone, second_date: second_line.end_date.clone)
+      end
+
+      # :reek:LongParameterList {max_params: 4}
+
+      #
+      # 条件を元に日付を求める
+      #
+      # @param [Proc] condition 比較条件
+      # @param [Japan::Gengou] second_line 元号（2行目）
+      # @param [Western::Calendar] first_date 比較対象（1行目）
+      # @param [Western::Calendar] second_date 比較対象（2行目）
+      #
+      # @return [Western::Calendar] 比較結果
+      #
+      def self.choise_date(condition:, second_line:, first_date:, second_date:)
+        # first_lineは常に存在する
+        return first_date if second_line.invalid?
+
+        condition.call(first_date, second_date)
+      end
+    end
+  end
+end