zakuro 0.7.0 → 0.7.2

data/lib/zakuro/era/japan/gengou/alignment/aligner.rb

@@ -68,6 +68,8 @@ module Zakuro
           #
           # @return [Array<LinearGengou>] 元号
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def get(line:, start_date:, last_date:)
             raise ArgumentError.new, 'invalid line number' unless LINE_INDEXES.include?(line)
 
@@ -82,6 +84,8 @@ module Zakuro
           #
           # @return [Array<LinearGengou>] 元号
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def get_by_name(line:, name:)
             raise ArgumentError.new, 'invalid line number' unless LINE_INDEXES.include?(line)
 

data/lib/zakuro/era/japan/gengou/resource/parser.rb

@@ -226,6 +226,8 @@ module Zakuro
           #
           # @return [Set] 元号セット情報
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def self.run(filepath: '')
             yaml = YAML.load_file(filepath)
 

data/lib/zakuro/era/japan/gengou/resource/type.rb

@@ -54,6 +54,8 @@ module Zakuro
           #
           # @param [Integer] last_year 終了年
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def write_last_year(last_year:)
             unless Gengou.valid_year(year: last_year)
               raise ArgumentError, "invalid year format. [#{last_year}]"
@@ -67,6 +69,8 @@ module Zakuro
           #
           # @param [Western::Calendar] last_date 終了日
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def write_last_date(last_date:)
             unless Gengou.valid_date(date: last_date)
               raise ArgumentError, "invalid date format. [#{last_date}]"
@@ -125,6 +129,8 @@ module Zakuro
           #
           # @param [String] next_start_date 次回開始日
           #
+          # @raise [ArgumentError] 引数エラー
+          #
           def convert_next_start_date_to_last_date(next_start_date: '')
             raise ArgumentError, 'empty string cannot convert' if next_start_date.empty?
 

data/lib/zakuro/era/western/calendar.rb

@@ -188,6 +188,8 @@ module Zakuro
       # @param [Integer] day 日
       # @param [Symbol] type 日付種別
       #
+      # @raise [ArgumentError] 引数エラー
+      #
       def initialize(year: -4712, month: 1, day: 1, type: Type::DEFAULT)
         start = Western.to_native_start(type: type)
         @param = Parameter.new(year: year, month: month, day: day, start: start)
@@ -386,6 +388,8 @@ module Zakuro
       #
       # @return [Calendar] 年月日情報（西暦）
       #
+      # @raise [ArgumentError] 引数エラー
+      #
       def self.parse(text: '', type: Type::DEFAULT)
         unless Calendar.valid_date_string(text: text, type: type)
           raise ArgumentError, "invalid date string: #{text}"

data/lib/zakuro/exception/case/pattern.rb

@@ -14,21 +14,57 @@ module Zakuro
       module Pattern
         INTERNAL_ERROR = Template.new(
           code: 'ERROR_0001',
-          message: '致命的なエラーです。',
+          message: '内部エラーです。',
           length: 0
         )
 
+        INVALID_DATE_TYPE = Template.new(
+          code: 'ERROR_0101',
+          message: '日付の型は文字列/日付です。指定型:%s',
+          length: 1
+        )
+
+        INVALID_RANGE_TYPE = Template.new(
+          code: 'ERROR_0102',
+          message: '範囲の型はhashです。指定型:%s',
+          length: 1
+        )
+
+        INVALID_OPTION_TYPE = Template.new(
+          code: 'ERROR_0103',
+          message: 'オプションの型はhashです。指定型:%s',
+          length: 1
+        )
+
+        INVALID_COLUMN_TYPE = Template.new(
+          code: 'ERROR_0104',
+          message: '列の型は配列です。指定型:%s',
+          length: 1
+        )
+
+        INVALID_CONDITION_TYPE = Template.new(
+          code: 'ERROR_0105',
+          message: '条件の型は配列です。指定型:%s',
+          length: 1
+        )
+
         INVALID_DATE = Template.new(
-          code: 'ERROR_0002',
+          code: 'ERROR_0201',
           message: '一日検索の日付指定が誤っています。',
           length: 0
         )
 
         INVALID_RANGE = Template.new(
-          code: 'ERROR_0003',
+          code: 'ERROR_0202',
           message: '範囲検索の日付指定が誤っています。',
           length: 0
         )
+
+        UNCOMMITTABLE_DATE = Template.new(
+          code: 'ERROR_0203',
+          message: '検索不可能な日付指定です。',
+          length: 0
+        )
       end
     end
   end

data/lib/zakuro/exception/exception.rb

@@ -2,11 +2,11 @@
 
 require_relative '../output/logger'
 
-require_relative './cause'
-
+require_relative './case/preset'
 require_relative './case/pattern'
 
 require_relative './zakuro_error'
+require_relative './cause'
 
 # :nodoc:
 module Zakuro
@@ -21,7 +21,7 @@ module Zakuro
     #
     # 例外を取得する
     #
-    # @param [Array<Template>] presets 原因プリセット
+    # @param [Array<Case::Preset>] presets 原因プリセット
     #
     # @return [ZakuroError] ライブラリエラー
     #

data/lib/zakuro/exception/zakuro_error.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require_relative './cause'
 
 # :nodoc:
@@ -20,8 +21,25 @@ module Zakuro
       # @param [Array<Cause>] causes 原因
       #
       def initialize(msg: '', causes: [])
-        super(msg)
         @causes = causes
+        out = "#{msg}:#{text}"
+        super(out)
+      end
+
+      private
+
+      #
+      # 原因をJSON文字列にする
+      #
+      # @return [String] JSON文字列
+      #
+      def text
+        list = []
+        @causes.each do |cause|
+          list.push(Tools::Stringifier.to_h(obj: cause, class_prefix: 'Zakuro'))
+        end
+
+        JSON.generate(list)
       end
     end
   end

data/lib/zakuro/gateway/range.rb

@@ -15,7 +15,7 @@ module Zakuro
     # Range 範囲
     #
     class Range
-      # @return [Context] 暦コンテキスト
+      # @return [Context::Context] 暦コンテキスト
       attr_reader :context
       # @return [Locale::Range] 範囲
       attr_reader :range
@@ -23,7 +23,7 @@ module Zakuro
       #
       # 初期化
       #
-      # @param [Context] context 暦コンテキスト
+      # @param [Context::Context] context 暦コンテキスト
       # @param [Hash<Symbol, Object>] range 範囲
       #
       def initialize(context:, range:)

data/lib/zakuro/gateway/single.rb

@@ -21,7 +21,7 @@ module Zakuro
       #
       # 初期化
       #
-      # @param [Context] context 暦コンテキスト
+      # @param [Context::Context] context 暦コンテキスト
       # @param [Date, String] date 日付
       #
       def initialize(context:, date:)

data/lib/zakuro/merchant.rb

@@ -6,7 +6,9 @@ require_relative './gateway/range'
 
 require_relative './condition'
 
-require_relative './output/error'
+require_relative './exception/exception'
+
+require_relative './calculation/type/optional'
 
 # :nodoc:
 module Zakuro
@@ -15,6 +17,8 @@ module Zakuro
   #   東西の暦を取引する、素敵な笑顔の持ち主
   #
   class Merchant
+    # @return [Output::Logger] ロガー
+    LOGGER = Output::Logger.new(location: Merchant)
     # @return [Hash<Symbol, Object>] 条件
     attr_reader :condition
 
@@ -23,11 +27,17 @@ module Zakuro
     #
     # @param [Hash<Symbol, Object>] condition 条件
     #
+    # @raise [Exception::ZakuroError] ライブラリ内エラー
+    #
     def initialize(condition: {})
       failed = Condition.validate(hash: condition)
-      raise Output::ZakuroError, failed.join('\n') unless failed.empty?
+      raise Exception.get(presets: failed) unless failed.empty?
 
       @condition = Condition.new(hash: condition)
+    rescue Exception::ZakuroError => e
+      raise e
+    rescue StandardError => e
+      make_internal_error(error: e)
     end
 
     #
@@ -37,13 +47,19 @@ module Zakuro
     #
     # @return [Merchant] 自インスタンス
     #
+    # @raise [Exception::ZakuroError] ライブラリ内エラー
+    #
     def offer(condition: {})
       failed = Condition.validate(hash: condition)
-      raise Output::ZakuroError, failed.join('\n') unless failed.empty?
+      raise Exception.get(presets: failed) unless failed.empty?
 
       @condition.rewrite(hash: condition)
 
       self
+    rescue Exception::ZakuroError => e
+      raise e
+    rescue StandardError => e
+      make_internal_error(error: e)
     end
 
     #
@@ -52,19 +68,73 @@ module Zakuro
     # @return [Result::SingleDay] 和暦日
     # @return [Result::Range] 和暦日範囲
     #
+    # @raise [Exception::ZakuroError] ライブラリ内エラー
+    #
     def commit
-      # TODO: condition で設定する
-      context = Context.new(version_name: '')
+      context = Context::Context.new(options: condition.options)
+
+      result = get(context: context)
+
+      return result.get unless result.invalid?
 
+      make_uncommitable_error
+    rescue Exception::ZakuroError => e
+      raise e
+    rescue StandardError => e
+      make_internal_error(error: e)
+    end
+
+    private
+
+    #
+    # 結果取得する
+    #
+    # @param [Context::Context] context 暦コンテキスト
+    #
+    # @return [Calculation::Type::Optional] 参照
+    #
+    def get(context:)
       single = Gateway::Single.new(context: context, date: condition.date)
 
-      return single.get unless single.invalid?
+      return Calculation::Type::Optional.new(obj: single.get) unless single.invalid?
 
       range = Gateway::Range.new(context: context, range: condition.range)
 
-      return range.get unless range.invalid?
+      return Calculation::Type::Optional.new(obj: range.get) unless range.invalid?
+
+      Calculation::Type::Optional.new
+    end
+
+    #
+    # 内部エラーを生成する
+    #
+    # @param [StandardError] error 内部エラー
+    #
+    # @raise [Exception::ZakuroError] ライブラリ内エラー
+    #
+    def make_internal_error(error:)
+      LOGGER.error(error)
+      presets = [
+        Exception::Case::Preset.new(
+          template: Exception::Case::Pattern::INTERNAL_ERROR
+        )
+      ]
+      raise Exception.get(presets: presets)
+    end
 
-      {}
+    #
+    # 内部エラーを生成する
+    #
+    # @raise [Exception::ZakuroError] ライブラリ内エラー
+    #
+    def make_uncommitable_error
+      raise Exception.get(
+        presets: [
+          Exception::Case::Preset.new(
+            template: Exception::Case::Pattern::UNCOMMITTABLE_DATE
+          )
+        ]
+      )
     end
   end
 end

data/lib/zakuro/operation/month/parser.rb

@@ -112,6 +112,8 @@ module Zakuro
       #
       # @return [Array<MonthHistory>] 変更履歴
       #
+      # @raise [ArgumentError] 引数エラー
+      #
       def self.run(filepath:)
         hash = YAML.load_file(filepath)
 

data/lib/zakuro/output/response.rb

@@ -14,63 +14,37 @@ module Zakuro
       # SingleDay 1日データ
       #
       module SingleDay
-        #
-        # Param 引数
-        #
-        class Param
-          # @return [Year] 年情報（各暦のデータ型）
-          attr_reader :year
-          # @return [Month] 月情報（各暦のデータ型）
-          attr_reader :month
-          # @return [Western::Calendar] 年月日情報（西暦）
-          attr_reader :date
-          # @return [Integer] 日数（月初日から指定日までの日数）
-          attr_reader :days
-
-          #
-          # 初期化
-          #
-          # @param [Year] year 年情報（各暦のデータ型）
-          # @param [Month] month 月情報（各暦のデータ型）
-          # @param [Western::Calendar] date 年月日情報（西暦）
-          # @param [Integer] days 日数（月初日から指定日までの日数）
-          #
-          def initialize(year:, month:, date:, days:)
-            @year = year
-            @month = month
-            @date = date
-            @days = days
-          end
-        end
-
         #
         # 1日データを生成する
         #
-        # @param [Parameter] param 引数
+        # @param [Calculation::Base::Year] year 年情報（各暦のデータ型）
+        # @param [Calculation::Monthly::Month] month 月情報（各暦のデータ型）
+        # @param [Calculation::Base::Day] day 日情報
+        # @param [Hash<String, Result::Data::Option::AbstractOption>] options オプション
         #
-        # @return [SingleDay] 1日データ
+        # @return [Result::Data::SingleDay] 1日データ
         #
-        def self.save_single_day(param:)
-          year = param.year
-          month = param.month
-          date = param.date
-          days = param.days
+        def self.create(year:, month:, day:, options: {})
           Result::Data::SingleDay.new(
-            year: save_year(year: year, month: month, date: date),
-            month: save_month(month: month, date: date, days: days),
-            day: save_day(month: month, date: date, days: days)
+            year: save_year(year: year, month: month, day: day),
+            month: save_month(month: month, day: day),
+            day: save_day(day: day),
+            options: options
           )
         end
 
         #
         # 年データを保存する
         #
-        # @param [Year] year 年情報（各暦のデータ型）
+        # @param [Calculation::Base::Year] year 年情報（各暦のデータ型）
+        # @param [Calculation::Monthly::Month] month 月情報（各暦のデータ型）
+        # @param [Calculation::Base::Day] day 日情報
         #
         # @return [Result::Year] 年データ
         #
-        def self.save_year(year:, month:, date:)
+        def self.save_year(year:, month:, day:)
           gengou = month.gengou
+          date = day.western_date
           first = gengou.match_first_line(date: date)
           second = gengou.match_second_line(date: date)
           Result::Data::Year.new(
@@ -86,17 +60,16 @@ module Zakuro
         #
         # 月データを保存する
         #
-        # @param [Month] month 月情報（各暦のデータ型）
-        # @param [Western::Calendar] date 年月日情報（西暦）
-        # @param [Integer] days 日数（月初日から指定日までの日数）
+        # @param [Calculation::Monthly::Month] month 月情報（各暦のデータ型）
+        # @param [Calculation::Base::Day] day 日情報
         #
         # @return [Result::Month] 月データ
         #
-        def self.save_month(month:, date:, days:)
+        def self.save_month(month:, day:)
           Result::Data::Month.new(
             number: month.number, leaped: month.leaped?, days_name: month.days_name,
             first_day: save_first_day(remainder: month.remainder,
-                                      date: date, days: days),
+                                      date: day.western_date, days: day.number - 1),
             odd_solar_terms: save_solar_term(term: month.odd_term),
             even_solar_terms: save_solar_term(term: month.even_term)
           )
@@ -147,23 +120,17 @@ module Zakuro
         #
         # 日データを保存する
         #
-        # @param [Month] month 月情報（各暦のデータ型）
-        # @param [Western::Calendar] date 年月日情報（西暦）
-        # @param [Integer] days 日数（月初日から指定日までの日数）
+        # @param [Calculation::Base::Day] day 日情報
         #
         # @return [Result::Day] 日データ
         #
-        def self.save_day(month:, date:, days:)
-          remainder = month.remainder
-          remainder = remainder.add(
-            # 常に参照元のRemainderクラスで生成する
-            remainder.class.new(day: days, minute: 0, second: 0)
-          )
+        def self.save_day(day:)
+          remainder = day.remainder
           Result::Data::Day.new(
-            number: (days + 1),
+            number: day.number,
             zodiac_name: remainder.zodiac_name,
             remainder: remainder,
-            western_date: date
+            western_date: day.western_date
           )
         end
         private_class_method :save_day

data/lib/zakuro/result/data/option/abstract_option.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # データ部
+    #
+    module Data
+      #
+      # Option オプション
+      #
+      module Option
+        #
+        # AbstractOption 抽象オプション結果
+        #
+        class AbstractOption
+          # @return [True] オプション値有
+          # @return [False] オプション値無
+          attr_reader :matched
+
+          #
+          # 初期化
+          #
+          # @param [True, False] matched オプション値有無
+          #
+          def initialize(matched: false)
+            @matched = matched
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/data/option/dropped_date/calculation.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative './solar_term'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # データ部
+    #
+    module Data
+      #
+      # Option オプション
+      #
+      module Option
+        #
+        # DroppedDate 没日
+        #
+        module DroppedDate
+          #
+          # Calculation 演算値
+          #
+          class Calculation
+            # @return [String] 大余小余（没余）
+            attr_reader :remainder
+            # @return [SolarTerm] 二十四節気
+            attr_reader :solar_term
+
+            #
+            # 初期化
+            #
+            # @param [String] remainder 大余小余（没余）
+            # @param [SolarTerm] solar_term 二十四節気
+            #
+            def initialize(remainder: '', solar_term: SolarTerm.new)
+              @remainder = remainder
+              @solar_term = solar_term
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/data/option/dropped_date/option.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../abstract_option'
+
+require_relative './calculation'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # データ部
+    #
+    module Data
+      #
+      # Option オプション
+      #
+      module Option
+        #
+        # DroppedDate 没日
+        #
+        module DroppedDate
+          #
+          # Option 没日集約
+          #
+          class Option < AbstractOption
+            # @return [Calculation] 演算値
+            attr_reader :calculation
+
+            #
+            # 初期化
+            #
+            # @param [True, False] matched オプション値有無
+            # @param [Calculation] calculation 演算値
+            #
+            def initialize(matched: false, calculation: Calculation.new)
+              super(matched: matched)
+              @calculation = calculation
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/data/option/dropped_date/solar_term.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # データ部
+    #
+    module Data
+      #
+      # Option オプション
+      #
+      module Option
+        #
+        # DroppedDate 没日
+        #
+        module DroppedDate
+          #
+          # SolarTerm 二十四節気
+          #
+          class SolarTerm
+            # @return [Interger] 不正連番
+            INVALID = -1
+
+            # @return [Integer] 連番
+            attr_reader :index
+            # @return [String] 大余小余
+            attr_reader :remainder
+
+            #
+            # 初期化
+            #
+            # @param [Integer] index 連番
+            # @param [String] remainder 大余小余
+            #
+            def initialize(index: INVALID, remainder: '')
+              @index = index
+              @remainder = remainder
+            end
+          end
+        end
+      end
+    end
+  end
+end