zakuro 0.6.1 → 0.8.0

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

@@ -19,48 +19,35 @@ module Zakuro
       # @return [Integer] 2行目
       SECOND_LINE = Alignment::Aligner::SECOND_LINE
 
-      #
-      # 該当行の元号を取得する
-      #
-      # @param [Integer] line 行番号
-      # @param [Western::Calendar] start_date 開始日
-      # @param [Western::Calendar] last_date 終了日
-      #
-      # @return [Array<LinearGengou>] 該当行の元号
-      #
-      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
-
-      #
-      # 1行目元号を取得する
-      #
-      # @param [Western::Calendar] start_date 開始日
-      # @param [Western::Calendar] last_date 終了日
-      #
-      # @return [Array<LinearGengou>] 1行目元号
-      #
-      def self.first_line(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
-        Alignment.get(
-          line: FIRST_LINE, start_date: start_date, last_date: last_date
-        )
-      end
+      class << self
+        #
+        # 該当行の元号を取得する
+        #
+        # @param [Integer] line 行番号
+        # @param [Western::Calendar] start_date 開始日
+        # @param [Western::Calendar] last_date 終了日
+        #
+        # @return [Array<LinearGengou>] 該当行の元号
+        #
+        def 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] start_date 開始日
-      # @param [Western::Calendar] last_date 終了日
-      #
-      # @return [Array<LinearGengou>] 2行目元号
-      #
-      def self.second_line(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
-        Alignment.get(
-          line: SECOND_LINE, start_date: start_date, last_date: last_date
-        )
+        #
+        # 該当行の元号を取得する（元号名）
+        #
+        # @param [Integer] line 行番号
+        # @param [Western::Calendar] start_date 開始日
+        # @param [Western::Calendar] last_date 終了日
+        #
+        # @return [Array<LinearGengou>] 該当行の元号
+        #
+        def line_by_name(line: FIRST_LINE, name:)
+          Alignment.get_by_name(line: line, name: name)
+        end
       end
     end
   end

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

@@ -125,26 +125,28 @@ module Zakuro
         )
       ].freeze
 
-      #
-      # 年を基準に暦を引き当てる
-      #
-      # @param [Integer] start_year 開始西暦年
-      # @param [Integer] last_year 終了西暦年
-      #
-      # @return [Array<Range>] 和暦
-      #
-      def self.ranges_with_year(start_year:, last_year:)
-        result = []
+      class << self
+        #
+        # 年を基準に暦を引き当てる
+        #
+        # @param [Integer] start_year 開始西暦年
+        # @param [Integer] last_year 終了西暦年
+        #
+        # @return [Array<Range>] 和暦
+        #
+        def ranges_with_year(start_year:, last_year:)
+          result = []
 
-        LIST.each do |range|
-          next if start_year > range.last_year
+          LIST.each do |range|
+            next if start_year > range.last_year
 
-          next if last_year < range.start_year
+            next if last_year < range.start_year
 
-          result.push(range)
-        end
+            result.push(range)
+          end
 
-        result
+          result
+        end
       end
     end
   end

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

@@ -58,26 +58,28 @@ module Zakuro
       Type::DEFAULT => Date::ITALY
     }.freeze
 
-    #
-    # 日付種別からRuby標準のグレゴリオ暦開始日を引き当てる
-    #
-    # @param [Symbol] type 日付種別
-    #
-    # @return [Integer] Ruby標準のグレゴリオ暦開始日
-    #
-    def self.to_native_start(type:)
-      DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-    end
+    class << self
+      #
+      # 日付種別からRuby標準のグレゴリオ暦開始日を引き当てる
+      #
+      # @param [Symbol] type 日付種別
+      #
+      # @return [Integer] Ruby標準のグレゴリオ暦開始日
+      #
+      def to_native_start(type:)
+        DATE_START.fetch(type, DATE_START[Type::DEFAULT])
+      end
 
-    #
-    # Ruby標準のグレゴリオ暦開始日から日付種別を引き当てる
-    #
-    # @param [Integer] start Ruby標準のグレゴリオ暦開始日
-    #
-    # @return [Symbol] 日付種別
-    #
-    def self.to_type(start:)
-      DATE_START.invert.fetch(start, Type::DEFAULT)
+      #
+      # Ruby標準のグレゴリオ暦開始日から日付種別を引き当てる
+      #
+      # @param [Integer] start Ruby標準のグレゴリオ暦開始日
+      #
+      # @return [Symbol] 日付種別
+      #
+      def to_type(start:)
+        DATE_START.invert.fetch(start, Type::DEFAULT)
+      end
     end
 
     #
@@ -131,8 +133,16 @@ module Zakuro
     # 定数 DATE_START のバリエーションで日付オブジェクトを初期化するだけで良い
     #
     class Calendar # rubocop:disable Metrics/ClassLength
-      attr_reader :param, :date
+      # @return [Parameter] 初期化引数
+      attr_reader :param
+      # @return [Date] 日付（Ruby日付型）
+      attr_reader :date
 
+      #
+      # 検証する
+      #
+      # @return [Array<String>] エラー文字列
+      #
       def validate
         failed = valid_type
 
@@ -150,9 +160,9 @@ module Zakuro
       #
       def valid_type
         failed = []
-        year = @param.year
-        month = @param.month
-        day = @param.day
+        year = param.year
+        month = param.month
+        day = param.day
         failed.push("wrong type. year: #{year}") unless year.is_a?(Integer)
         failed.push("wrong type. month: #{month}") unless month.is_a?(Integer)
         failed.push("wrong type. day: #{day}") unless day.is_a?(Integer)
@@ -169,10 +179,10 @@ module Zakuro
       def valid_date
         failed = []
 
-        year = @param.year
-        month = @param.month
-        day = @param.day
-        start = @param.start
+        year = param.year
+        month = param.month
+        day = param.day
+        start = param.start
         unless Date.valid_date?(year, month, day, start)
           failed.push("year: #{year}, month: #{month}, " \
                       "day: #{day}, start: #{start}")
@@ -188,6 +198,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)
@@ -213,7 +225,7 @@ module Zakuro
       #
       def redate(type: Type::DEFAULT)
         start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-        @date = @date.new_start(start)
+        @date = date.new_start(start)
         self
       end
 
@@ -225,7 +237,7 @@ module Zakuro
       # @return [Calendar] 年月日情報（西暦）
       #
       def +(other)
-        return @date.jd + other.date.jd if other.is_a?(Western::Calendar)
+        return date.jd + other.date.jd if other.is_a?(Western::Calendar)
 
         @date += other
         self
@@ -239,7 +251,7 @@ module Zakuro
       # @return [Calendar] 年月日情報（西暦）
       #
       def -(other)
-        return @date.jd - other.date.jd if other.is_a?(Western::Calendar)
+        return date.jd - other.date.jd if other.is_a?(Western::Calendar)
 
         @date -= other
         self
@@ -254,7 +266,7 @@ module Zakuro
       # @return [False] 以下（現在日/過去日である）
       #
       def >(other)
-        @date > other.date
+        date > other.date
       end
 
       #
@@ -266,7 +278,7 @@ module Zakuro
       # @return [False] より小さい（過去日である）
       #
       def >=(other)
-        @date >= other.date
+        date >= other.date
       end
 
       #
@@ -278,7 +290,7 @@ module Zakuro
       # @return [False] 以上（現在日/未来日である）
       #
       def <(other)
-        @date < other.date
+        date < other.date
       end
 
       #
@@ -290,7 +302,7 @@ module Zakuro
       # @return [False] より大きい（未来日である）
       #
       def <=(other)
-        @date <= other.date
+        date <= other.date
       end
 
       #
@@ -302,7 +314,7 @@ module Zakuro
       # @return [False] 等しくない（過去日/未来日である）
       #
       def ==(other)
-        @date == other.date
+        date == other.date
       end
 
       #
@@ -311,7 +323,7 @@ module Zakuro
       # @return [Integer] 年
       #
       def year
-        @date.year
+        date.year
       end
 
       #
@@ -320,7 +332,7 @@ module Zakuro
       # @return [Integer] 月
       #
       def month
-        @date.month
+        date.month
       end
 
       #
@@ -329,7 +341,7 @@ module Zakuro
       # @return [Integer] 日
       #
       def day
-        @date.day
+        date.day
       end
 
       #
@@ -340,7 +352,7 @@ module Zakuro
       # @return [Calendar] 年月日情報（西暦）
       #
       def next_year(num: 1)
-        @date = @date.next_year(num)
+        @date = date.next_year(num)
         self
       end
 
@@ -351,7 +363,7 @@ module Zakuro
       # @return [False] 無効値以外
       #
       def invalid?
-        (@date == Date.new)
+        (date == Date.new)
       end
 
       #
@@ -362,60 +374,64 @@ module Zakuro
       # @return [String] 年月日情報
       #
       def format(form: '%Y-%m-%d')
-        @date.strftime(form)
-      end
-
-      #
-      # 年月日情報（西暦）を生成する
-      #
-      # @param [Date] date Ruby標準日付
-      #
-      # @return [Calendar] 年月日情報（西暦）
-      #
-      def self.create(date: Date.new)
-        type = Western.to_type(start: date.start)
-        Calendar.new(year: date.year, month: date.month,
-                     day: date.day, type: type)
+        date.strftime(form)
       end
 
-      #
-      # 年月日情報（西暦）を生成する
-      #
-      # @param [String] str 日付文字列
-      # @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}"
+      class << self
+        #
+        # 年月日情報（西暦）を生成する
+        #
+        # @param [Date] date Ruby標準日付
+        #
+        # @return [Calendar] 年月日情報（西暦）
+        #
+        def create(date: Date.new)
+          type = Western.to_type(start: date.start)
+          Calendar.new(year: date.year, month: date.month,
+                       day: date.day, type: type)
         end
 
-        start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-        date = Date.parse(str, start)
-
-        Calendar.new(
-          year: date.year, month: date.month, day: date.day, type: type
-        )
-      end
+        #
+        # 年月日情報（西暦）を生成する
+        #
+        # @param [String] text 日付文字列
+        # @param [Symbol] type 日付種別
+        #
+        # @return [Calendar] 年月日情報（西暦）
+        #
+        # @raise [ArgumentError] 引数エラー
+        #
+        def parse(text: '', type: Type::DEFAULT)
+          unless 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(text, start)
+
+          Calendar.new(
+            year: date.year, month: date.month, day: date.day, type: type
+          )
+        end
 
-      #
-      # 日付文字列を検証する
-      #
-      # @param [String] str 日付文字列
-      # @param [Symbol] type 日付種別
-      #
-      # @return [True] 正しい
-      # @return [True] 正しくない
-      #
-      def self.valid_date_string(str: '', type: Type::DEFAULT)
-        start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-        begin
-          Date.parse(str, start)
-        rescue ArgumentError => _e
-          false
+        #
+        # 日付文字列を検証する
+        #
+        # @param [String] text 日付文字列
+        # @param [Symbol] type 日付種別
+        #
+        # @return [True] 正しい
+        # @return [True] 正しくない
+        #
+        def valid_date_string(text: '', type: Type::DEFAULT)
+          start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
+          begin
+            Date.parse(text, start)
+          rescue ArgumentError => _e
+            return false
+          end
+          true
         end
-        true
       end
     end
   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,39 @@
+# 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'
+
+    class << self
+      #
+      # 例外を取得する
+      #
+      # @param [Array<Case::Preset>] presets 原因プリセット
+      #
+      # @return [ZakuroError] ライブラリエラー
+      #
+      def 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
+end