zakuro 0.6.0 → 0.7.2

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../western/calendar'
-require_relative './gengou/parser'
-require_relative './gengou/type'
+
+require_relative './gengou/alignment'
 
 # :nodoc:
 module Zakuro
@@ -11,95 +11,41 @@ module Zakuro
   #
   module Japan
     #
-    # GengouResource 元号情報
+    # Gengou 元号
     #
-    module GengouResource
-      # @return [Array<Set>] 元号セット情報リスト
-      LIST = [
-        Parser.run(filepath: File.expand_path(
-          './gengou/yaml/set-001-until-south.yaml',
-          __dir__
-        )),
-        Parser.run(filepath: File.expand_path(
-          './gengou/yaml/set-002-from-north.yaml',
-          __dir__
-        )),
-        Parser.run(filepath: File.expand_path(
-          './gengou/yaml/set-003-modern.yaml',
-          __dir__
-        ))
-      ].freeze
-
-      # :reek:TooManyStatements { max_statements: 9 }
-
-      #
-      # 元号（1行目,2行目）を引き当てる
-      #
-      # * LIST配列の元号情報を配列順で「x行目」（1始まり）とする
-      # * 1行目にデータがあれば、第一要素に1行目のデータが設定される
-      # * 1行目と2行目にデータがあれば、第二要素に2行目のデータが設定される
-      # * 1行目にデータがなく、2行目以降に1つだけデータがあれば、第一要素にそのデータを設定してそれ以外の要素は未設定
-      # * 1行目にデータがなく、2行目以降に2つ以上のデータがあれば、第一要素に末尾行に一番近いデータを設定してそれ以外の要素は未設定
-      #
-      # @param [Western::Calendar] date 日
-      #
-      # @return [Array<Gengou>] 元号情報（1行目, 2行目）
-      #
-      def self.lines(date:)
-        lines = native_lines(date: date)
-        return lines unless lines[0].invalid?
-
-        first = Japan::Gengou.new
-        lines[1..].each.with_index(1) do |item, index|
-          next if item.invalid?
-
-          first = item
-          lines[index] = Japan::Gengou.new
-        end
-        lines[0] = first
-        lines
-      end
-
-      #
-      # 元号を引き当てる
-      #
-      # * LISTから単純に元号を引き当てる
-      # * 1行目,2行目といった概念は無視する
-      #
-      # @param [Western::Calendar] date 日
-      #
-      # @return [Array<Gengou>] 元号情報
-      #
-      def self.native_lines(date:)
-        result = Array.new(LIST.size)
-        LIST.each_with_index do |set, index|
-          result[index] = set.include_item(date: date)
-        end
-        result
-      end
+    module Gengou
+      # @return [Integer] 1行目
+      FIRST_LINE = Alignment::Aligner::FIRST_LINE
+      # @return [Integer] 2行目
+      SECOND_LINE = Alignment::Aligner::SECOND_LINE
 
       #
-      # 「日本暦日原典」1行目の元号を返す
+      # 該当行の元号を取得する
       #
-      # @param [Western::Calendar] date 日
+      # @param [Integer] line 行番号
+      # @param [Western::Calendar] start_date 開始日
+      # @param [Western::Calendar] last_date 終了日
       #
-      # @return [Gengou] 元号情報（1行目）
+      # @return [Array<LinearGengou>] 該当行の元号
       #
-      def self.first_line(date:)
-        lines = lines(date: date)
-        lines[0].clone
+      def self.line(line: FIRST_LINE,
+                    start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+        Alignment.get(
+          line: line, start_date: start_date, last_date: last_date
+        )
       end
 
       #
-      # 「日本暦日原典」2行目の元号を返す
+      # 該当行の元号を取得する（元号名）
       #
-      # @param [Western::Calendar] date 日
+      # @param [Integer] line 行番号
+      # @param [Western::Calendar] start_date 開始日
+      # @param [Western::Calendar] last_date 終了日
       #
-      # @return [Gengou] 元号情報（2行目）
+      # @return [Array<LinearGengou>] 該当行の元号
       #
-      def self.second_line(date:)
-        lines = lines(date: date)
-        lines[1].clone
+      def self.line_by_name(line: FIRST_LINE, name:)
+        Alignment.get_by_name(line: line, name: name)
       end
     end
   end

data/lib/zakuro/era/japan/version.rb

@@ -23,7 +23,7 @@ module Zakuro
         # @return [Integer] 開始西暦年
         attr_reader :start_year
         # @return [Integer] 終了西暦年
-        attr_reader :end_year
+        attr_reader :last_year
         # @return [True] リリース済
         # @return [False] 未リリース
         attr_reader :released
@@ -34,20 +34,20 @@ module Zakuro
         # @param [String] name 暦名
         # @param [Western::Calendar] start_date 暦の開始日
         # @param [Integer] start_year 開始西暦年
-        # @param [Integer] end_year 終了西暦年
+        # @param [Integer] last_year 終了西暦年
         # @param [True, False] released リリース済 / 未リリース
         #
-        def initialize(name:, start_date:, start_year:, end_year:, released:)
+        def initialize(name:, start_date:, start_year:, last_year:, released:)
           @name = name
           @start_date = start_date
           @start_year = start_year
-          @end_year = end_year
+          @last_year = last_year
           @released = released
         end
       end
 
       # TODO: yamlにする
-      # TODO: end_year は不要
+      # TODO: last_year は不要
 
       # @return [Array<Range>] 全和暦
       LIST = [
@@ -56,7 +56,7 @@ module Zakuro
           name: 'Genka',
           start_date: Western::Calendar.new(year: 445, month: 1, day: 24),
           start_year: 445,
-          end_year: 697,
+          last_year: 697,
           released: true
         ),
         # 文武天皇02年01月01日
@@ -64,7 +64,7 @@ module Zakuro
           name: 'Gihou',
           start_date: Western::Calendar.new(year: 698, month: 2, day: 16),
           start_year: 698,
-          end_year: 763,
+          last_year: 763,
           released: true
         ),
         # 天平宝字08年01月01日
@@ -72,7 +72,7 @@ module Zakuro
           name: 'Daien',
           start_date: Western::Calendar.new(year: 764, month: 2, day: 7),
           start_year: 764,
-          end_year: 861,
+          last_year: 861,
           released: true
         ),
         # 貞観02年01月01日
@@ -80,7 +80,7 @@ module Zakuro
           name: 'Senmyou',
           start_date: Western::Calendar.new(year: 862, month: 2, day: 3),
           start_year: 862,
-          end_year: 1684,
+          last_year: 1684,
           released: true
         ),
         # 貞享02年01月01日
@@ -88,7 +88,7 @@ module Zakuro
           name: 'Joukyou',
           start_date: Western::Calendar.new(year: 1685, month: 2, day: 4),
           start_year: 1685,
-          end_year: 1754,
+          last_year: 1754,
           released: false
         ),
         # 宝暦05年01月01日
@@ -96,7 +96,7 @@ module Zakuro
           name: 'Houryaku',
           start_date: Western::Calendar.new(year: 1755, month: 2, day: 11),
           start_year: 1755,
-          end_year: 1797,
+          last_year: 1797,
           released: false
         ),
         # 寛政10年01月01日
@@ -104,7 +104,7 @@ module Zakuro
           name: 'Kansei',
           start_date: Western::Calendar.new(year: 1798, month: 2, day: 16),
           start_year: 1798,
-          end_year: 1843,
+          last_year: 1843,
           released: false
         ),
         # 天保13年01月01日
@@ -112,7 +112,7 @@ module Zakuro
           name: 'Tenpou',
           start_date: Western::Calendar.new(year: 1844, month: 2, day: 18),
           start_year: 1844,
-          end_year: 1867,
+          last_year: 1867,
           released: false
         ),
         # 明治01年09月08日
@@ -120,7 +120,7 @@ module Zakuro
           name: 'Gregorio',
           start_date: Western::Calendar.new(year: 1868, month: 10, day: 23),
           start_year: 1868,
-          end_year: 9999,
+          last_year: 9999,
           released: false
         )
       ].freeze
@@ -129,17 +129,17 @@ module Zakuro
       # 年を基準に暦を引き当てる
       #
       # @param [Integer] start_year 開始西暦年
-      # @param [Integer] end_year 終了西暦年
+      # @param [Integer] last_year 終了西暦年
       #
       # @return [Array<Range>] 和暦
       #
-      def self.ranges_with_year(start_year:, end_year:)
+      def self.ranges_with_year(start_year:, last_year:)
         result = []
 
         LIST.each do |range|
-          next if start_year > range.end_year
+          next if start_year > range.last_year
 
-          next if end_year < range.start_year
+          next if last_year < range.start_year
 
           result.push(range)
         end

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)
@@ -381,18 +383,20 @@ module Zakuro
       #
       # 年月日情報（西暦）を生成する
       #
-      # @param [String] str 日付文字列
+      # @param [String] text 日付文字列
       # @param [Symbol] type 日付種別
       #
       # @return [Calendar] 年月日情報（西暦）
       #
-      def self.parse(str: '', type: Type::DEFAULT)
-        unless Calendar.valid_date_string(str: str, type: type)
-          raise ArgumentError, "invalid date string: #{str}"
+      # @raise [ArgumentError] 引数エラー
+      #
+      def self.parse(text: '', type: Type::DEFAULT)
+        unless Calendar.valid_date_string(text: text, type: type)
+          raise ArgumentError, "invalid date string: #{text}"
         end
 
         start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-        date = Date.parse(str, start)
+        date = Date.parse(text, start)
 
         Calendar.new(
           year: date.year, month: date.month, day: date.day, type: type
@@ -402,18 +406,18 @@ module Zakuro
       #
       # 日付文字列を検証する
       #
-      # @param [String] str 日付文字列
+      # @param [String] text 日付文字列
       # @param [Symbol] type 日付種別
       #
       # @return [True] 正しい
       # @return [True] 正しくない
       #
-      def self.valid_date_string(str: '', type: Type::DEFAULT)
+      def self.valid_date_string(text: '', type: Type::DEFAULT)
         start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
         begin
-          Date.parse(str, start)
+          Date.parse(text, start)
         rescue ArgumentError => _e
-          false
+          return false
         end
         true
       end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative './template'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Pattern 原因パターン
+      #
+      module Pattern
+        INTERNAL_ERROR = Template.new(
+          code: 'ERROR_0001',
+          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_0201',
+          message: '一日検索の日付指定が誤っています。',
+          length: 0
+        )
+
+        INVALID_RANGE = Template.new(
+          code: 'ERROR_0202',
+          message: '範囲検索の日付指定が誤っています。',
+          length: 0
+        )
+
+        UNCOMMITTABLE_DATE = Template.new(
+          code: 'ERROR_0203',
+          message: '検索不可能な日付指定です。',
+          length: 0
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative './template'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Preset プリセット
+      #
+      class Preset
+        # @return [Template] テンプレート
+        attr_reader :template
+        # @return [Array<Object>] メッセージ引数
+        attr_reader :args
+
+        #
+        # 初期化
+        #
+        # @param [String] args メッセージ引数
+        # @param [String] template テンプレート
+        #
+        def initialize(*args, template:)
+          @template = template
+          @args = args
+        end
+
+        #
+        # エラーコードを取得する
+        #
+        # @return [String] エラーコード
+        #
+        def code
+          @template.code
+        end
+
+        #
+        # メッセージを作成する
+        #
+        # @return [String] メッセージ
+        #
+        def message
+          @template.format(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Template テンプレート
+      #
+      class Template
+        # @return [String] エラーコード
+        attr_reader :code
+        # @return [String] メッセージ
+        attr_reader :message
+        # @return [Integer] テンプレート引数長
+        attr_reader :length
+
+        #
+        # 初期化
+        #
+        # @param [String] code エラーコード
+        # @param [String] message メッセージ
+        # @param [Integer] length テンプレート引数長
+        #
+        def initialize(code:, message:, length: 0)
+          @code = code
+          @message = message
+          @length = length
+        end
+
+        #
+        # メッセージを作成する
+        #
+        # @param [Array<Object>] args テンプレート引数長
+        #
+        # @return [String] メッセージ
+        #
+        def format(*args)
+          return '' unless args.size == length
+
+          super(message, *args)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/exception/cause.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    #
+    # Cause 原因
+    #
+    class Cause
+      # @return [String] エラーコード
+      attr_reader :code
+      # @return [String] メッセージ
+      attr_reader :message
+
+      #
+      # 初期化
+      #
+      # @param [String] code エラーコード
+      # @param [String] message メッセージ
+      #
+      def initialize(code:, message:)
+        @code = code
+        @message = message
+      end
+    end
+  end
+end

data/lib/zakuro/exception/exception.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../output/logger'
+
+require_relative './case/preset'
+require_relative './case/pattern'
+
+require_relative './zakuro_error'
+require_relative './cause'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # @return [Output::Logger] ロガー
+    LOGGER = Output::Logger.new(location: 'exception')
+
+    # @return [String] 共通メッセージ
+    MESSAGE = 'an error has occurred'
+
+    #
+    # 例外を取得する
+    #
+    # @param [Array<Case::Preset>] presets 原因プリセット
+    #
+    # @return [ZakuroError] ライブラリエラー
+    #
+    def self.get(presets: [])
+      causes = []
+      presets.each do |preset|
+        causes.push(Cause.new(code: preset.code, message: preset.message))
+      end
+
+      ZakuroError.new(msg: MESSAGE, causes: causes)
+    end
+  end
+end

data/lib/zakuro/exception/zakuro_error.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative './cause'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    #
+    # ZakuroError ライブラリ内エラー
+    #
+    class ZakuroError < StandardError
+      # @return [Array<ErrorMessage>] エラーメッセージ
+      attr_reader :causes
+
+      #
+      # 初期化
+      #
+      # @param [String] msg メッセージ
+      # @param [Array<Cause>] causes 原因
+      #
+      def initialize(msg: '', causes: [])
+        @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
+end