zakuro 0.0.2 → 0.1.3

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative '../../western'
+require_relative './type'
+require_relative './validator'
+require 'yaml'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+    #
+    # Parser yaml解析
+    #
+    module Parser
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+      #
+      # GengouParser 元号情報の検証/展開を行う
+      #
+      class GengouParser
+        # @return [Integer] 要素位置
+        attr_reader :index
+        # @return [String] 元号名
+        attr_reader :name
+        # @return [String] 開始日
+        attr_reader :start_date
+        # @return [String] 元旦
+        attr_reader :new_year_date
+        # @return [String] 開始年
+        attr_reader :start_year
+
+        #
+        # 初期化
+        #
+        # @param [Hash<String, Strin>] hash 元号情報
+        # @param [Integer] index （元号セット内での）元号の要素位置
+        #
+        def initialize(hash:, index:)
+          @index = index
+          @name = hash['name']
+          @start_date = hash['start_date']
+          @new_year_date = hash['new_year_date']
+          @start_year = hash['start_year']
+        end
+
+        #
+        # 元号情報を生成する
+        #
+        # @return [Gengou] 元号情報
+        #
+        def create
+          start_date = Western::Calendar.parse(str: @start_date)
+          new_year_date = Western::Calendar.parse(str: @new_year_date)
+          start_year = @start_year || 1
+
+          Gengou.new(name: @name, start_date: start_date, new_year_date: new_year_date,
+                     year: start_year)
+        end
+      end
+
+      #
+      # SetParser 元号セット情報の検証/展開
+      #
+      class SetParser
+        # @return [String] 元号セットID
+        attr_reader :id
+        # @return [String] 元号セット名
+        attr_reader :name
+        # @return [String] 終了日
+        attr_reader :end_date
+        # @return [Array<Hash<String, String>>] 元号情報
+        attr_reader :list
+
+        #
+        # 初期化
+        #
+        # @param [Hash<String, Object>] hash 元号セット情報
+        #
+        def initialize(hash:)
+          @id = hash['id']
+          @name = hash['name']
+          @end_date = hash['end_date']
+          @list = hash['list']
+        end
+
+        #
+        # 元号セット情報を生成する
+        #
+        # @return [Set] 元号セット情報
+        #
+        def create
+          end_date = Western::Calendar.parse(str: @end_date)
+          list = create_list
+          Set.new(
+            id: @id, name: @name, end_date: end_date, list: list
+          )
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 元号情報を生成する
+        #
+        # @return [Array<Gengou>] 元号情報
+        #
+        def create_list
+          result = []
+          @list.each_with_index do |li, index|
+            gengou = GengouParser.new(hash: li, index: index).create
+            next_index = index + 1
+            gengou = calc_end_date_on_gengou_data(next_index: next_index,
+                                                  gengou: gengou)
+            result.push(gengou)
+          end
+
+          result
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 次の元号の開始日から、元号の終了日に変換する
+        #
+        # @param [Integer] next_index 次の元号の要素位置
+        # @param [String] gengou 次回開始日
+        #
+        # @return [Gengou] 元号情報
+        #
+        def calc_end_date_on_gengou_data(next_index:, gengou:)
+          if next_index >= @list.size
+            end_date = Western::Calendar.parse(str: @end_date)
+            gengou.write_end_date(end_date: end_date)
+            return gengou
+          end
+          next_start_date = @list[next_index]['start_date']
+          gengou.convert_next_start_date_to_end_date(
+            next_start_date_string: next_start_date
+          )
+          gengou
+        end
+      end
+
+      #
+      # 解析/展開する
+      #
+      # @param [String] filepath 元号セットファイルパス
+      #
+      # @return [Set] 元号セット情報
+      #
+      def self.run(filepath: '')
+        yaml = YAML.load_file(filepath)
+
+        failed = Validator.run(yaml_hash: yaml)
+
+        raise ArgumentError, failed.join("\n") unless failed.empty?
+
+        parser = SetParser.new(hash: yaml)
+        parser.create
+      end
+    end
+  end
+end

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

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative '../../western'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+    #
+    # Gengou 元号情報
+    #
+    class Gengou
+      # @return [String] 元号名
+      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] 元号年
+      attr_reader :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
+
+      #
+      # 終了日を更新する
+      #
+      # @param [Western::Calendar] end_date 終了日
+      #
+      def write_end_date(end_date:)
+        unless Gengou.valid_date(date: end_date)
+          raise ArgumentError, "invalid date format. [#{end_date}]"
+        end
+
+        @end_date = end_date
+        nil
+      end
+
+      #
+      # 日付が有効かどうかを確認する
+      #
+      # @param [Western::Calendar] date 日付
+      #
+      # @return [True] 有効
+      # @return [False] 無効
+      #
+      def self.valid_date(date:)
+        return false unless date
+
+        date.is_a?(Western::Calendar)
+      end
+
+      #
+      # 次の元号の開始日から、元号の終了日に変換する
+      #
+      # @param [String] next_start_date_string 次回開始日
+      #
+      def convert_next_start_date_to_end_date(next_start_date_string: '')
+        raise ArgumentError, 'empty string cannot convert' if next_start_date_string.empty?
+
+        start_date = Western::Calendar.parse(str: next_start_date_string)
+        @end_date = start_date - 1
+        nil
+      end
+
+      #
+      # 指定した日が元号に含まれるか
+      #
+      # @param [Western::Calendar] date 日
+      #
+      # @return [True] 含まれる
+      # @return [False] 含まれない
+      #
+      def include?(date:)
+        date >= @start_date && date <= @end_date
+      end
+
+      #
+      # 不正な元号データかを確認する
+      #
+      # @return [True] 正しくない
+      # @return [True] 正しい
+      #
+      def invalid?
+        @year == -1
+      end
+
+      #
+      # 1元号年を追加する
+      #
+      def next_year
+        @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
+
+    #
+    # Set 元号セット
+    #
+    class Set
+      # @return [Integer] 元号セットID
+      attr_reader :id
+      # @return [String] 元号セット名
+      attr_reader :name
+      # @return [Western::Calendar] 元号セットでの終了日
+      attr_reader :end_date
+      # @return [Array<Gengou>] 元号リスト
+      attr_reader :list
+
+      #
+      # 初期化
+      #
+      # @param [Integer] id 元号セットID
+      # @param [String] name 元号セット名
+      # @param [Western::Calendar] end_date 元号セットでの終了日
+      # @param [Array<Gengou>] list 元号リスト
+      #
+      def initialize(id: -1, name: '', end_date: Western::Calendar.new, list: [])
+        @id = id
+        @name = name
+        @end_date = end_date
+        @list = list
+      end
+
+      #
+      # 指定した日付を含む元号を返す
+      #
+      # @param [Western::Calendar] date 日
+      #
+      # @return [Gengou] 元号
+      #
+      def include_item(date:)
+        @list.each do |item|
+          return item if item.include?(date: date)
+        end
+
+        Gengou.new
+      end
+
+      #
+      # 元号セットが不正かどうかを確認する
+      #
+      # @return [True] 正しくない
+      # @return [False] 正しい
+      #
+      def invalid?
+        @id == -1
+      end
+    end
+  end
+end

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

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+require_relative '../../western'
+require_relative './type'
+require 'yaml'
+
+# :nodoc:
+module Zakuro
+  #
+  # Japan 和暦
+  #
+  module Japan
+    #
+    # Validator yaml解析
+    #
+    module Validator
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+      #
+      # Set 元号セット情報の検証/展開
+      #
+      class Set
+        # @return [String] 元号セットID
+        attr_reader :id
+        # @return [String] 元号セット名
+        attr_reader :name
+        # @return [String] 終了日
+        attr_reader :end_date
+        # @return [Array<Hash<String, String>>] 元号情報
+        attr_reader :list
+
+        #
+        # 初期化
+        #
+        # @param [Hash<String, Object>] hash 元号セット情報
+        #
+        def initialize(hash:)
+          @id = hash['id']
+          @name = hash['name']
+          @end_date = hash['end_date']
+          @list = hash['list']
+        end
+
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] 不正メッセージ
+        #
+        def validate
+          failed = []
+          failed.push("invalid id. #{id}") unless id?
+
+          failed.push("invalid name. #{name}") unless name?
+
+          failed.push("invalid end_date. #{end_date}") unless western_date?
+
+          failed |= validate_list
+          failed
+        end
+
+        #
+        # IDを検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def id?
+          return false unless @id
+
+          @id.is_a?(Integer)
+        end
+
+        #
+        # 元号セット名を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def name?
+          return false unless @name
+
+          @name.is_a?(String)
+        end
+
+        #
+        # 日付文字列を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def western_date?
+          Western::Calendar.valid_date_string(str: @end_date)
+        end
+
+        #
+        # 元号情報を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def list?
+          return false unless @list
+
+          @list.is_a?(Array)
+        end
+
+        #
+        # 元号情報を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def validate_list
+          return ["invalid list. #{@list.class}"] unless list?
+
+          failed = []
+          list.each_with_index do |li, index|
+            failed |= Gengou.new(hash: li, index: index).validate
+          end
+          failed
+        end
+      end
+
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
+      #
+      # Gengou 元号情報
+      #
+      class Gengou
+        # @return [Integer] 要素位置
+        attr_reader :index
+        # @return [String] 元号名
+        attr_reader :name
+        # @return [String] 開始日
+        attr_reader :start_date
+        # @return [String] 元旦
+        attr_reader :new_year_date
+        # @return [String] 開始年
+        attr_reader :start_year
+
+        #
+        # 初期化
+        #
+        # @param [Hash<String, Strin>] hash 元号情報
+        # @param [Integer] index （元号セット内での）元号の要素位置
+        #
+        def initialize(hash:, index:)
+          @index = index
+          @name = hash['name']
+          @start_date = hash['start_date']
+          @new_year_date = hash['new_year_date']
+          @start_year = hash['start_year']
+        end
+
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] 不正メッセージ
+        #
+        def validate
+          prefix = "list[#{index}]. "
+          failed = []
+
+          failed.push(prefix + "invalid name. #{@name}") unless name?
+
+          failed.push(prefix + "invalid start_date. #{@start_date}") unless start_date?
+
+          failed.push(prefix + "invalid start_year. #{@start_year}") unless year?
+
+          failed.push(prefix + "invalid new_year_date. #{@new_year_date}") unless new_year_date?
+
+          failed
+        end
+
+        #
+        # 元号名を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def name?
+          return false unless @name
+
+          @name.is_a?(String)
+        end
+
+        #
+        # 開始日文字列を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def start_date?
+          Western::Calendar.valid_date_string(str: @start_date)
+        end
+
+        #
+        # 元旦文字列を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def new_year_date?
+          Western::Calendar.valid_date_string(str: @new_year_date)
+        end
+
+        #
+        # 元号年を検証する
+        #
+        # @return [True] 正しい
+        # @return [False] 正しくない
+        #
+        def year?
+          return true unless @start_year
+
+          @start_year.is_a?(Integer)
+        end
+      end
+
+      #
+      # 検証する
+      #
+      # @param [Hash<String, Object>] yaml_hash yaml取得結果
+      #
+      # @return [Array<String>] 不正メッセージ
+      #
+      def self.run(yaml_hash:)
+        Set.new(hash: yaml_hash).validate
+      end
+    end
+  end
+end