zakuro 0.0.1 → 0.1.2

data/lib/zakuro/era/japan/yaml/set-003-modern.yaml

@@ -0,0 +1,28 @@
+id: 3
+name: "近代（一世一元）"
+end_date: "9999-12-31"
+list:
+  - name: "明治"
+    # 1年9月8日
+    start_year: 1
+    start_date: "1868-10-23"
+    new_year_date: "1868-1-25"
+    note: ""
+  - name: "大正"
+    # 1年7月30日
+    start_year: 1
+    start_date: "1912-7-30"
+    new_year_date: "1912-1-1"
+    note: ""
+  - name: "昭和"
+    # 1年12月25日
+    start_year: 1
+    start_date: "1926-12-25"
+    new_year_date: "1926-1-1"
+    note: ""
+  - name: "令和"
+    # 1年5月1日
+    start_year: 1
+    start_date: "2019-5-1"
+    new_year_date: "2019-1-1"
+    note: ""

data/lib/zakuro/era/western.rb

@@ -109,7 +109,7 @@ module Zakuro
       end
     end
 
-    # :reek:TooManyMethods { max_methods: 17 }
+    # :reek:TooManyMethods { max_methods: 18 }
 
     #
     # Calendar 年月日情報（西暦）
@@ -344,6 +344,16 @@ module Zakuro
         self
       end
 
+      #
+      # 無効値（引数なし）かどうかを検証する
+      #
+      # @return [True] 無効値
+      # @return [False] 無効値以外
+      #
+      def invalid?
+        (@date == Date.new)
+      end
+
       #
       # 年月日をフォーマット化する
       #

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

@@ -0,0 +1,373 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../../era/western'
+require_relative './validator'
+require_relative './type'
+
+# :nodoc:
+module Zakuro
+  #
+  # Operation 運用
+  #
+  module Operation
+    #
+    # TypeParser 型ごと変換
+    #
+    module TypeParser
+      #
+      # 無効値かを判定する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [True] 無効値
+      # @return [False] 有効値
+      #
+      def self.invalid?(str:)
+        str == '-'
+      end
+
+      def self.text(str:)
+        return '' if invalid?(str: str)
+
+        str
+      end
+
+      #
+      # 有効行を変換する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [True] 有効
+      # @return [False] 無効
+      #
+      def self.modified?(str:)
+        str == 'true'
+      end
+
+      #
+      # 月を変換する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [Integer] 月
+      #
+      def self.month_number(str:)
+        return -1 if invalid?(str: str)
+
+        str.to_i
+      end
+
+      #
+      # 閏有無を変換する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [True] 閏あり
+      # @return [True] 閏なし/閏設定なし
+      #
+      def self.month_leaped(str:)
+        str == 'true'
+      end
+
+      #
+      # 西暦日を変換する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [Western::Calendar] 西暦日
+      #
+      def self.western_date(str:)
+        return Western::Calendar.new if invalid?(str: str)
+
+        Western::Calendar.parse(str: str)
+      end
+
+      #
+      # 日（差分）を変換する
+      #
+      # @param [String] str 文字列
+      #
+      # @return [Integer] 日（差分）
+      #
+      def self.days(str:)
+        return INVALID_DAY_VALUE if invalid?(str: str)
+
+        str.to_i
+      end
+
+      def self.solar_term_index(str:)
+        return -1 if invalid?(str: str)
+
+        str.to_i
+      end
+    end
+
+    #
+    # MonthParser 月情報解析（yaml）
+    #
+    module MonthParser
+      #
+      # 実行する
+      #
+      # @return [Array<MonthHistory>] 変更履歴
+      #
+      def self.run(filepath:)
+        hash = YAML.load_file(filepath)
+
+        failed = Validator.run(yaml_hash: hash)
+
+        raise ArgumentError, failed.join("\n") unless failed.empty?
+
+        load(yaml_hash: hash)
+      end
+
+      #
+      # 設定ファイルを読み込む
+      #
+      # @param [Hash] yaml_hash 設定ファイルテキスト
+      #
+      # @return [Array<MonthHistory>] 変更履歴
+      #
+      def self.load(yaml_hash: {})
+        histories = create_histories(yaml_hash: yaml_hash)
+
+        annotation_parser = AnnotationParser.new(yaml_hash: yaml_hash)
+        annotation_parser.create
+
+        add_annotations(histories: histories, annotation_parser: annotation_parser)
+      end
+
+      #
+      # 変更履歴を読み込む
+      #
+      # @param [Hash] yaml_hash 設定ファイルテキスト
+      #
+      # @return [Array<MonthHistory>] 変更履歴
+      #
+      def self.create_histories(yaml_hash: {})
+        result = []
+        yaml_hash.each do |month|
+          next unless Operation::TypeParser.modified?(str: month['modified'])
+
+          result.push(
+            create_history(yaml_hash: month)
+          )
+        end
+        result
+      end
+      private_class_method :create_histories
+
+      def self.create_history(yaml_hash: {})
+        diffs = MonthDiffsParser.create(yaml_hash: yaml_hash['diffs'])
+
+        western_date = Operation::TypeParser.western_date(str: yaml_hash['western_date'])
+        reference = Reference.new(page: yaml_hash['page'].to_i, number: yaml_hash['number'].to_i,
+                                  japan_date: yaml_hash['japan_date'])
+        MonthHistory.new(id: yaml_hash['id'],
+                         parent_id: Operation::TypeParser.text(str: yaml_hash['parent_id']),
+                         reference: reference,
+                         western_date: western_date,
+                         diffs: diffs)
+      end
+      private_class_method :create_history
+
+      def self.add_annotations(annotation_parser:, histories: [])
+        result = []
+        histories.each do |history|
+          id = history.id
+          result.push(
+            MonthHistory.new(
+              id: id, parent_id: history.parent_id, reference: history.reference,
+              western_date: history.western_date,
+              annotations: annotation_parser.specify(id: id),
+              diffs: history.diffs
+            )
+          )
+        end
+
+        result
+      end
+      private_class_method :add_annotations
+
+      def self.create_history_annnotations(history:, annotations: {}, relations: {})
+        history_id = history.id
+        history_annotations = []
+        [history_id, relations.fetch(history_id, '')].each do |id|
+          add_annotation(history_annotations: history_annotations,
+                         annotations: annotations, id: id)
+        end
+
+        history_annotations
+      end
+
+      def self.add_annotation(history_annotations: [], annotations: {}, id: '')
+        annotation = annotations.fetch(id, Annotation.new)
+        return if annotation.invalid?
+
+        history_annotations.push(annotation)
+      end
+      private_class_method :add_annotation
+    end
+
+    #
+    # AnnotationParser 注釈解析
+    #
+    class AnnotationParser
+      # @return [Hash<String, Annotation>] 注釈
+      attr_reader :annotations
+      # @return [Hash<String, String>] 関連注釈の対応関係
+      attr_reader :relations
+
+      #
+      # 初期化
+      #
+      # @param [Hash] yaml_hash 設定ファイルテキスト
+      #
+      def initialize(yaml_hash: {})
+        @annotations = {}
+        @relations = {}
+        @yaml_hash = yaml_hash
+      end
+
+      #
+      # 注釈を生成する
+      #
+      def create
+        @yaml_hash.each do |month|
+          AnnotationParser.resolve_history(
+            hash: month, annotations: @annotations, relations: @relations
+          )
+        end
+      end
+
+      #
+      # 月別履歴情報から注釈情報を取り出す
+      #
+      # @param [<Type>] hash 月別履歴情報yaml
+      # @param [Hash<String, Annotation>] annotations 注釈
+      # @param [Hash<String, String>] relations 関連注釈の対応関係
+      #
+      def self.resolve_history(hash: {}, annotations: {}, relations: {})
+        id = hash['id']
+        annotations[id] = Annotation.new(
+          id: id,
+          description: Operation::TypeParser.text(str: hash['description']),
+          note: Operation::TypeParser.text(str: hash['note'])
+        )
+        relation_id = hash['relation_id']
+
+        return if Operation::TypeParser.invalid?(str: relation_id)
+
+        relations[id] = relation_id
+      end
+
+      #
+      # 注釈を特定する
+      #
+      # @param [String] id ID
+      #
+      # @return [Array<Annotation>] 注釈
+      #
+      def specify(id: '')
+        ids = [id, relations.fetch(id, '')]
+        specify_by_ids(ids: ids)
+      end
+
+      private
+
+      def specify_by_ids(ids: [])
+        annotations = []
+        ids.each do |id|
+          add_annotation(id: id, annotations: annotations)
+        end
+
+        annotations
+      end
+
+      def add_annotation(id: '', annotations: [])
+        annotation = annotation(id: id)
+        return if annotation.invalid?
+
+        annotations.push(annotation)
+      end
+
+      def annotation(id: '')
+        @annotations.fetch(id, Annotation.new)
+      end
+    end
+
+    #
+    # MonthDiffsParser 月情報（差分）解析
+    #
+    module MonthDiffsParser
+      def self.create(yaml_hash: {})
+        Diffs.new(
+          month: create_month(yaml_hash: yaml_hash['month']),
+          solar_term: create_solar_term(yaml_hash: yaml_hash['solar_term']),
+          days: Operation::TypeParser.days(str: yaml_hash['days'])
+        )
+      end
+
+      def self.create_solar_term(yaml_hash: {})
+        SolarTerm::Direction.new(
+          source: create_source_solar_term(yaml_hash: yaml_hash['calc']),
+          destination: create_destination_solar_term(yaml_hash: yaml_hash['actual']),
+          days: Operation::TypeParser.days(str: yaml_hash['days'])
+        )
+      end
+      private_class_method :create_solar_term
+
+      def self.create_source_solar_term(yaml_hash: {})
+        SolarTerm::Source.new(
+          index: Operation::TypeParser.solar_term_index(str: yaml_hash['index']),
+          to: Operation::TypeParser.western_date(str: yaml_hash['to']),
+          zodiac_name: Operation::TypeParser.text(str: yaml_hash['zodiac_name'])
+        )
+      end
+      private_class_method :create_source_solar_term
+
+      def self.create_destination_solar_term(yaml_hash: {})
+        SolarTerm::Destination.new(
+          index: Operation::TypeParser.solar_term_index(str: yaml_hash['index']),
+          from: Operation::TypeParser.western_date(str: yaml_hash['from']),
+          zodiac_name: Operation::TypeParser.text(str: yaml_hash['zodiac_name'])
+        )
+      end
+      private_class_method :create_destination_solar_term
+
+      def self.create_month(yaml_hash: {})
+        Month.new(
+          number: create_month_number(yaml_hash: yaml_hash['number']),
+          leaped: create_month_leaped(yaml_hash: yaml_hash['leaped']),
+          is_many_days: create_month_day(yaml_hash: yaml_hash['days'])
+        )
+      end
+      private_class_method :create_month
+
+      def self.create_month_number(yaml_hash: {})
+        Number.new(
+          calc: Operation::TypeParser.month_number(str: yaml_hash['calc']),
+          actual: Operation::TypeParser.month_number(str: yaml_hash['actual'])
+        )
+      end
+      private_class_method :create_month_number
+
+      def self.create_month_leaped(yaml_hash: {})
+        Leaped.new(
+          calc: Operation::TypeParser.month_leaped(str: yaml_hash['calc']),
+          actual: Operation::TypeParser.month_leaped(str: yaml_hash['actual'])
+        )
+      end
+      private_class_method :create_month_leaped
+
+      def self.create_month_day(yaml_hash: {})
+        Days.new(
+          calc: yaml_hash['calc'],
+          actual: yaml_hash['actual']
+        )
+      end
+      private_class_method :create_month_day
+    end
+  end
+end

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

@@ -0,0 +1,453 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../../era/western'
+require_relative './validator'
+
+# :nodoc:
+module Zakuro
+  #
+  # Operation 運用
+  #
+  module Operation
+    #
+    # 日（差分）無効値
+    #
+    INVALID_DAY_VALUE = -30
+
+    # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+
+    #
+    # MonthHistory 変更履歴
+    #
+    class MonthHistory
+      # @return [String] ID
+      attr_reader :id
+      # @return [String] 親ID
+      attr_reader :parent_id
+      # @return [Reference] 参照
+      attr_reader :reference
+      # @return [Western::Calendar] 西暦日
+      attr_reader :western_date
+      # @return [Array<Annotation>] 注釈
+      attr_reader :annotations
+      # @return [Diffs] 総差分
+      attr_reader :diffs
+
+      # rubocop:disable Metrics/ParameterLists
+      # :reek:LongParameterList { max_params: 6 }
+
+      #
+      # 初期化
+      #
+      # @param [String] id ID
+      # @param [String] parent_id 親ID
+      # @param [Reference] reference 参照
+      # @param [Western::Calendar] western_date 西暦日
+      # @param [Array<Annotation>] annotations 注釈
+      # @param [Diffs] diffs 総差分
+      #
+      def initialize(id: '', parent_id: '', reference: Reference.new,
+                     western_date: Western::Calendar.new, annotations: [], diffs: Diffs.new)
+        @id = id
+        @parent_id = parent_id
+        @reference = reference
+        @western_date = western_date
+        @annotations = annotations
+        @diffs = diffs
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid?
+        id == ''
+      end
+    end
+
+    #
+    # Annotation 注釈
+    #
+    class Annotation
+      # @return [String] ID
+      attr_reader :id
+      # @return [String] 内容
+      attr_reader :description
+      # @return [String] 正誤訂正（zakuro）
+      attr_reader :note
+
+      #
+      # 初期化
+      #
+      # @param [String] id ID
+      # @param [String] description 内容
+      # @param [String] note 正誤訂正（zakuro）
+      #
+      def initialize(id: '', description: '', note: '')
+        @id = id
+        @description = description
+        @note = note
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid?
+        return true if @id == ''
+
+        @description == '' && @note == ''
+      end
+    end
+
+    #
+    # Reference 参照
+    #
+    class Reference
+      # @return [Integer] 頁数
+      attr_reader :page
+      # @return [Integer] 注釈番号
+      attr_reader :number
+      # @return [String] 和暦日
+      attr_reader :japan_date
+
+      #
+      # 初期化
+      #
+      # @param [Integer] page 頁数
+      # @param [Integer] number 注釈番号
+      # @param [String] japan_date 和暦日
+      #
+      def initialize(page: -1, number: -1, japan_date: '')
+        @page = page
+        @number = number
+        @japan_date = japan_date
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid?
+        page == -1
+      end
+    end
+
+    #
+    # Diffs 総差分
+    #
+    class Diffs
+      # @return [Month] 月差分
+      attr_reader :month
+      # @return [SolarTerm::Direction] 二十四節気差分
+      attr_reader :solar_term
+      # @return [Integer] 日差分
+      attr_reader :days
+
+      #
+      # 初期化
+      #
+      # @param [Month] month 月差分
+      # @param [SolarTerm::Direction] solar_term 二十四節気差分
+      # @param [Integer] days 日差分
+      #
+      def initialize(month: Month.new, solar_term: SolarTerm::Direction.new,
+                     days: INVALID_DAY_VALUE)
+        @month = month
+        @solar_term = solar_term
+        @days = days
+      end
+
+      #
+      # 日差分が無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid_days?
+        @days == INVALID_DAY_VALUE
+      end
+    end
+
+    #
+    # Month 月差分
+    #
+    class Month
+      # @return [Number] 月
+      attr_reader :number
+      # @return [Leaped] 閏有無
+      attr_reader :leaped
+      # @return [Days] 月の大小
+      attr_reader :is_many_days
+
+      # :reek:BooleanParameter
+
+      #
+      # 初期化
+      #
+      # @param [Number] number 月
+      # @param [Leaped] leaped 閏有無
+      # @param [Days] days 月の大小
+      #
+      def initialize(number: Number.new, leaped: Leaped.new, is_many_days: Days.new)
+        @number = number
+        @leaped = leaped
+        @is_many_days = is_many_days
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid?
+        number == -1
+      end
+    end
+
+    #
+    # 二十四節気
+    #
+    module SolarTerm
+      #
+      # Direction 二十四節気（移動）
+      #
+      class Direction
+        # @return [Source] 二十四節気（移動元）
+        attr_reader :source
+        # @return [Destination] 二十四節気（移動先）
+        attr_reader :destination
+        # @return [Integer] 大余差分
+        attr_reader :days
+
+        #
+        # 初期化
+        #
+        # @param [Source] source 二十四節気（移動元）
+        # @param [Destination] destination 二十四節気（移動先）
+        # @param [Integer] day 大余差分
+        #
+        def initialize(source: Source.new, destination: Destination.new,
+                       days: INVALID_DAY_VALUE)
+          @source = source
+          @destination = destination
+          @days = days
+        end
+
+        #
+        # 無効か（大余差分）
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid_days?
+          @days == INVALID_DAY_VALUE
+        end
+
+        #
+        # 無効か
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?
+          @source.invalid? && @destination.invalid?
+        end
+      end
+
+      #
+      # Source 二十四節気（移動元）
+      #
+      class Source
+        # @return [Integer] 二十四節気番号
+        attr_reader :index
+        # @return [Western::Calendar] 移動先の月初日
+        attr_reader :to
+        # @return [String] 十干十二支
+        attr_reader :zodiac_name
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 二十四節気番号
+        # @param [Western::Calendar] to 移動先の月初日
+        # @param [String] zodiac_name 十干十二支
+        #
+        def initialize(index: -1, to: Western::Calendar.new, zodiac_name: '')
+          @index = index
+          @to = to
+          @zodiac_name = zodiac_name
+        end
+
+        #
+        # 無効か
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?
+          @index == -1
+        end
+      end
+
+      #
+      # Destination 二十四節気（移動先）
+      #
+      class Destination
+        # @return [Integer] 二十四節気番号
+        attr_reader :index
+        # @return [Western::Calendar] 移動元の月初日
+        attr_reader :from
+        # @return [String] 十干十二支
+        attr_reader :zodiac_name
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 二十四節気番号
+        # @param [Western::Calendar] from 移動元の月初日
+        # @param [String] zodiac_name 十干十二支
+        #
+        def initialize(index: -1, from: Western::Calendar.new, zodiac_name: '')
+          @index = index
+          @from = from
+          @zodiac_name = zodiac_name
+        end
+
+        #
+        # 無効か
+        #
+        # @return [True] 無効
+        # @return [False] 有効
+        #
+        def invalid?
+          @index == -1
+        end
+      end
+    end
+
+    #
+    # Number 月
+    #
+    class Number
+      # @return [Integer] 計算
+      attr_reader :calc
+      # @return [Integer] 運用
+      attr_reader :actual
+
+      #
+      # 初期化
+      #
+      # @param [Integer] calc 計算
+      # @param [Integer] actual 運用
+      #
+      def initialize(calc: -1, actual: -1)
+        @calc = calc
+        @actual = actual
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効
+      # @return [False] 有効
+      #
+      def invalid?
+        @calc == -1 || @actual == -1
+      end
+    end
+
+    #
+    # Leaped 閏有無
+    #
+    class Leaped
+      # @return [True, False] 計算
+      attr_reader :calc
+      # @return [True, False] 運用
+      attr_reader :actual
+
+      # :reek:BooleanParameter
+
+      #
+      # 初期化
+      #
+      # @param [True, False] calc 計算
+      # @param [True, False] actual 運用
+      #
+      def initialize(calc: false, actual: false)
+        @calc = calc
+        @actual = actual
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効（設定値なし）
+      # @return [False] 有効
+      #
+      def invalid?
+        !@calc && !@actual
+      end
+    end
+
+    #
+    # Days 月大小
+    #
+    class Days
+      # @return [String] 29日
+      SMALL = '小'
+      # @return [String] 30日
+      BIG = '大'
+
+      #
+      # 初期化
+      #
+      # @param [String] calc 計算
+      # @param [String] actual 運用
+      #
+      def initialize(calc: '小', actual: '小')
+        @calc = calc
+        @actual = actual
+      end
+
+      #
+      # 計算値が大か
+      #
+      # @return [True] 大
+      # @return [False] 小
+      #
+      def calc
+        @calc == BIG
+      end
+
+      #
+      # 運用値が大か
+      #
+      # @return [True] 大
+      # @return [False] 小
+      #
+      def actual
+        @actual == BIG
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効（差分なし/設定値なし）
+      # @return [False] 有効
+      #
+      def invalid?
+        @calc == @actual
+      end
+    end
+  end
+end