zakuro 0.6.0 → 0.7.2

data/lib/zakuro/result/operation/month/annotation.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # 運用情報
+    #
+    module Operation
+      #
+      # Month 運用情報（月）
+      #
+      module Month
+        #
+        # Annotation 注釈
+        #
+        class Annotation
+          # @return [String] 注釈内容
+          attr_reader :description
+          # @return [String] 注釈補記
+          attr_reader :note
+
+          #
+          # 初期化
+          #
+          # @param [String] description 注釈内容
+          # @param [<Type>] note 注釈補記
+          #
+          def initialize(description:, note:)
+            @description = description
+            @note = note
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/operation/month/bundle.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative './history'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # 運用情報
+    #
+    module Operation
+      #
+      # Month 運用情報（月）
+      #
+      module Month
+        #
+        # Bundle 月履歴集約情報
+        #
+        class Bundle
+          # @return [History] 月別履歴情報（当月）
+          attr_reader :current
+          # @return [History] 月別履歴情報（影響を与えた月）
+          attr_reader :parent
+
+          def initialize(current: History.new, parent: History.new)
+            @current = current
+            @parent = parent
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/operation/month/history.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative './annotation'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # 運用情報
+    #
+    module Operation
+      #
+      # Month 運用情報（月）
+      #
+      module Month
+        #
+        # History 月別履歴情報
+        #
+        class History
+          # @return [String] ID
+          attr_reader :id
+          # @return [String] 月初日の西暦日
+          attr_reader :western_date
+          # @return [Integer] 原文頁数
+          attr_reader :page
+          # @return [Integer] 原文注釈番号
+          attr_reader :number
+          # @return [Array<Annotation>] 注釈
+          attr_reader :annotations
+
+          #
+          # 初期化
+          #
+          # @param [String] id ID
+          # @param [String] western_date 月初日の西暦日
+          # @param [Integer] page 原文頁数
+          # @param [Integer] number 原文注釈番号
+          # @param [Array<Annotation>] annotations 注釈
+          #
+          def initialize(id: '', western_date: '', page: -1, number: -1, annotations: [])
+            @id = id
+            @western_date = western_date
+            @page = page
+            @number = number
+            @annotations = annotations
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/result.rb

@@ -2,9 +2,11 @@
 
 require 'json'
 
+require_relative './data/single_day'
+
+require_relative './operation/bundle'
+
 require_relative './core'
-require_relative './data'
-require_relative './operation'
 
 # :nodoc:
 module Zakuro
@@ -33,5 +35,22 @@ module Zakuro
         @operation = operation
       end
     end
+
+    #
+    # Range 期間検索結果
+    #
+    class Range < Core
+      attr_reader :list
+
+      #
+      # 初期化
+      #
+      # @param [Array<Data::Single>] list 期間内データ
+      #
+      def initialize(list: [])
+        super
+        @list = list
+      end
+    end
   end
 end

data/lib/zakuro/tools/stringifier.rb

@@ -17,6 +17,7 @@ module Zakuro
       #
       # @param [Object] obj 対象インスタンス
       # @param [String] class_prefix インスタンス内でハッシュ変換するクラスのプレフィックス
+      # @param [True, False] formatted 整形有無
       #
       # @return [Hash<String, Objcet>] ハッシュ
       #
@@ -31,13 +32,12 @@ module Zakuro
         hash
       end
 
-      # :reek:TooManyStatements { max_statements: 7 }
-
       #
       # 対象インスタンスをハッシュ化する（再帰処理）
       #
       # @param [Object] obj 対象インスタンス
       # @param [String] class_prefix インスタンス内でハッシュ変換するクラスのプレフィックス
+      # @param [True, False] formatted 整形有無
       #
       # @return [Hash<String, Objcet>] ハッシュ
       #
@@ -52,6 +52,20 @@ module Zakuro
           return to_h(obj: obj, class_prefix: class_prefix, formatted: formatted)
         end
 
+        general_value_to_hash(obj: obj, class_prefix: class_prefix, formatted: formatted)
+      end
+      private_class_method :value_to_hash
+
+      #
+      # ライブラリを問わない標準的な値をハッシュ化する（再帰処理）
+      #
+      # @param [Object] obj 対象インスタンス
+      # @param [String] class_prefix インスタンス内でハッシュ変換するクラスのプレフィックス
+      # @param [True, False] formatted 整形有無
+      #
+      # @return [Objcet] ハッシュ変換可能な値
+      #
+      def self.general_value_to_hash(obj:, class_prefix:, formatted:)
         # 配列は要素一つずつで再帰する
         if obj.is_a?(Array)
           arr = []
@@ -61,9 +75,18 @@ module Zakuro
           return arr
         end
 
+        # ハッシュはキーごとに再帰する
+        if obj.is_a?(Hash)
+          hash = {}
+          obj.each do |key, value|
+            hash[key] = to_h(obj: value, class_prefix: class_prefix, formatted: formatted)
+          end
+          return hash
+        end
+
         obj
       end
-      private_class_method :value_to_hash
+      private_class_method :general_value_to_hash
     end
   end
 end

data/lib/zakuro/version/daien/cycle/remainder.rb

@@ -29,7 +29,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 
@@ -63,7 +63,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 

data/lib/zakuro/version/daien/option/dropped_date/parameter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/option/dropped_date/abstract_parameter'
+
+require_relative '../../const/number'
+require_relative '../../const/remainder'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Daien
+      # :nodoc:
+      module DroppedDate
+        #
+        # Parameter 引数
+        #
+        class Parameter < Calculation::Option::DroppedDate::AbstractParameter
+          #
+          # 初期化
+          #
+          def initialize
+            super(valid: false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/daien/range/annual_range.rb

@@ -20,7 +20,7 @@ module Zakuro
         #   * 対象年に対して、前年11月-当年11月までを出力する
         #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [Integer] western_year 西暦年
         #
         # @return [Array<Month>] 1年データ

data/lib/zakuro/version/daien/stella/lunar/adjustment.rb

@@ -206,6 +206,8 @@ module Zakuro
         #
         # @return [Row] 補正値
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.specify(day:, minute:)
           LIST.each do |row|
             # NOTE: 範囲が重複している場合、最初に引き当てたほうを優先する

data/lib/zakuro/version/daien/stella/lunar/value.rb

@@ -63,6 +63,8 @@ module Zakuro
         # @return [True] 正しい（月の位相計算に使う大余小余）
         # @return [True] 正しくない
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.valid?(remainder:)
           return if remainder.is_a?(Cycle::LunarRemainder)
 

data/lib/zakuro/version/genka/cycle/remainder.rb

@@ -30,7 +30,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 
@@ -67,7 +67,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::TERM_DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::TERM_DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 

data/lib/zakuro/version/genka/option/dropped_date/parameter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/option/dropped_date/abstract_parameter'
+
+require_relative '../../const/number'
+require_relative '../../const/remainder'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Genka
+    # :nodoc:
+    module Option
+      # :nodoc:
+      module DroppedDate
+        #
+        # Parameter 引数
+        #
+        class Parameter < Calculation::Option::DroppedDate::AbstractParameter
+          #
+          # 初期化
+          #
+          def initialize
+            super(valid: false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/genka/range/annual_range.rb

@@ -24,7 +24,7 @@ module Zakuro
         #   * 対象年に対して、当年1月-翌年1月までを出力する
         #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [Integer] western_year 西暦年
         #
         # @return [Array<Month>] 1年データ

data/lib/zakuro/version/gihou/cycle/remainder.rb

@@ -26,7 +26,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 
@@ -60,7 +60,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 

data/lib/zakuro/version/gihou/option/dropped_date/parameter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/option/dropped_date/abstract_parameter'
+
+require_relative '../../const/number'
+require_relative '../../const/remainder'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gihou
+    # :nodoc:
+    module Option
+      # :nodoc:
+      module DroppedDate
+        #
+        # Parameter 引数
+        #
+        class Parameter < Calculation::Option::DroppedDate::AbstractParameter
+          #
+          # 初期化
+          #
+          def initialize
+            super(valid: false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/gihou/range/annual_range.rb

@@ -20,7 +20,7 @@ module Zakuro
         #   * 対象年に対して、前年11月-当年11月までを出力する
         #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [Integer] western_year 西暦年
         #
         # @return [Array<Month>] 1年データ

data/lib/zakuro/version/gihou/stella/lunar/adjustment.rb

@@ -216,6 +216,8 @@ module Zakuro
         #
         # @return [Row] 補正値
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.specify(day:, minute:)
           LIST.each do |row|
             # NOTE: 範囲が重複している場合、最初に引き当てたほうを優先する

data/lib/zakuro/version/gihou/stella/lunar/value.rb

@@ -63,6 +63,8 @@ module Zakuro
         # @return [True] 正しい（月の位相計算に使う大余小余）
         # @return [True] 正しくない
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.valid?(remainder:)
           return if remainder.is_a?(Cycle::LunarRemainder)
 

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

@@ -94,21 +94,25 @@
 
 計算の多くはそれぞれの暦に依存するが、まずは共通の計算部分を列挙する
 
-### ある元号の2年目以降について
+### 元号の求め方
 
-各元号の1年（元年）の始まりは固定値のため、西暦にて開始日を持つ（例: 正慶1年1月1日 = 1332/01/28）
+元慶（877-6-1 ～ 885-3-10）をもとに考える
 
-日本の旧暦（太陰太陽暦）において、元号は1月1日を境に改元または継続する
+元号開始年が存在する元号年（877）から、次の元号の開始年（885） + 1 までを和暦計算する。これをAとする
 
-NOTE: これは『日本暦日原典』をベースにした場合であり、多くの場合、実際の改元は1月1日ではない [返却される元号が実際の存在期間と一致しない](https://github.com/pldb/zakuro/issues/3)
+元号のはじまりは固定値のため、西暦開始日と、それに対応する和暦開始日を持つ（例: 元慶01年04月16日 = 877-6-1）
 
-ここで問題となるのは、元号2年目以降はその前年までの計算結果が必要になることである
+この和暦開始日は必ずAの1年目に存在するため、1年目の和暦日を特定し、その日と西暦開始日を関連付ける
 
-西暦（太陽暦）のように1年あたりの日数は一定しない
+もし元慶2年以降を計算したい場合は、Aの西暦開始日から該当年月日までを加算で求める
+
+具体的には、和暦上の月の大小（29日 or 30日）を用いた加算となる
+
+念のため補足するが、西暦（太陽暦）のように1年あたりの日数は一定しない
 
 平年（353/354/355/356）または閏年(383/384/385）のパターンがあり、月の大小（29/30）や閏月（中気のない月）の有無で変動する
 
-この日数を求めることで、初めて2年目の開始日が求められる（1332/01/28 + 355日 = 1333/1/17 = 正慶2年1月1日）
+したがって、2年目以降を加算なしに特定することはできない
 
 ### 南北朝について
 

data/lib/zakuro/version/senmyou/const/remainder.rb

@@ -25,6 +25,11 @@ module Zakuro
           #
           # @return [Cycle::Remainder] 弦（1分=8秒）
           QUARTER = Cycle::Remainder.new(day: 7, minute: 3214, second: 2)
+
+          # @return [Cycle::Remainder] 有没判定
+          # * 中盈（小余3671秒2）/ 2 = 小余1835秒5
+          # * 日（小余8400） - 小余1835秒5 = 小余6564秒3
+          DROPPED_DATE_LIMIT = Cycle::Remainder.new(day: 0, minute: 6564, second: 3)
         end
 
         #

data/lib/zakuro/version/senmyou/cycle/remainder.rb

@@ -26,7 +26,7 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 
@@ -60,7 +60,42 @@ module Zakuro
         # @param [Integer] total 繰り上げなしの小余
         #
         def initialize(day: -1, minute: -1, second: -1, total: -1)
-          super(base_day: Const::Number::Cycle::DAY, base_mitune: MINUTE,
+          super(base_day: Const::Number::Cycle::DAY, base_minute: MINUTE,
+                day: day, minute: minute, second: second, total: total)
+        end
+
+        #
+        # 特定の文字フォーマットにして出力する
+        #
+        # @param [String] form フォーマット（大余、小余、秒それぞれを%dで指定する）
+        #
+        # @return [String] フォーマットした結果
+        #
+        def format(form: '%d-%d')
+          return '' if invalid?
+
+          super(form, @day, @minute, @second)
+        end
+      end
+
+      #
+      # DroppedRemainder 没日の計算向け時刻情報（没余）
+      #
+      class DroppedRemainder < Calculation::Cycle::AbstractRemainder
+        # @return [Integer] 分（1分=8秒）
+        MINUTE = 8
+
+        #
+        # 初期化
+        #
+        # @param [Integer] day 大余（"日"に相当）
+        # @param [Integer] minute 小余（"分"に相当）
+        # @param [Integer] second 秒
+        # @param [Integer] total 繰り上げなしの小余
+        #
+        def initialize(day: -1, minute: -1, second: -1, total: -1)
+          # 小余 = 通余
+          super(base_day: Const::Number::Derivation::REMAINDER_ALL_YEAR, base_minute: MINUTE,
                 day: day, minute: minute, second: second, total: total)
         end
 

data/lib/zakuro/version/senmyou/option/dropped_date/parameter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../../../../calculation/option/dropped_date/abstract_parameter'
+
+require_relative '../../const/number'
+require_relative '../../const/remainder'
+require_relative '../../cycle/remainder'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Senmyou
+    # :nodoc:
+    module Option
+      # :nodoc:
+      module DroppedDate
+        #
+        # Parameter 引数
+        #
+        class Parameter < Calculation::Option::DroppedDate::AbstractParameter
+          #
+          # 初期化
+          #
+          def initialize
+            super(valid: true, year: Const::Number::Cycle::YEAR,
+                  limit: Const::Remainder::Solar::DROPPED_DATE_LIMIT,
+                  remainder_class: Cycle::DroppedRemainder)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/version/senmyou/range/annual_range.rb

@@ -20,7 +20,7 @@ module Zakuro
         #   * 対象年に対して、前年11月-当年11月までを出力する
         #   * 対象年（西暦）と計算年（元号x年）の紐付けは行わない
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [Integer] western_year 西暦年
         #
         # @return [Array<Month>] 1年データ

data/lib/zakuro/version/senmyou/stella/lunar/adjustment.rb

@@ -205,6 +205,8 @@ module Zakuro
         #
         # @return [Row] 補正値
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.specify(forward:, day:, minute:)
           LIST.each do |row|
             # NOTE: 範囲が重複している場合、最初に引き当てたほうを優先する

data/lib/zakuro/version/senmyou/stella/lunar/value.rb

@@ -55,6 +55,8 @@ module Zakuro
         # @return [True] 正しい（月の位相計算に使う大余小余）
         # @return [True] 正しくない
         #
+        # @raise [ArgumentError] 引数エラー
+        #
         def self.valid?(remainder:)
           return if remainder.is_a?(Cycle::LunarRemainder)