zakuro 0.0.3 → 0.1.0

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

@@ -0,0 +1,452 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../../era/western'
+require_relative './validator'
+
+# :nodoc:
+module Zakuro
+  #
+  # Operation 運用
+  #
+  module Operation
+    #
+    # 日（差分）無効値
+    #
+    INVALID_DAY_VALUE = -30
+
+    #
+    # 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
+
+      #
+      # 初期化
+      #
+      # @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
+
+      #
+      # 無効か
+      #
+      # @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 :days
+
+      # :reek:BooleanParameter
+
+      #
+      # 初期化
+      #
+      # @param [Number] number 月
+      # @param [Leaped] leaped 閏有無
+      # @param [Days] days 月の大小
+      #
+      def initialize(number: Number.new, leaped: Leaped.new, days: Days.new)
+        @number = number
+        @leaped = leaped
+        @days = 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 = '大'
+
+      # @return [String] 計算
+      attr_reader :calc
+      # @return [String] 運用
+      attr_reader :actual
+
+      #
+      # 初期化
+      #
+      # @param [String] calc 計算
+      # @param [String] actual 運用
+      #
+      def initialize(calc: '小', actual: '小')
+        @calc = calc
+        @actual = actual
+      end
+
+      #
+      # 計算値が大か
+      #
+      # @return [True] 大
+      # @return [False] 小
+      #
+      def many_days_calc?
+        @calc == BIG
+      end
+
+      #
+      # 運用値が大か
+      #
+      # @return [True] 大
+      # @return [False] 小
+      #
+      def many_days_actual?
+        @actual == BIG
+      end
+
+      #
+      # 無効か
+      #
+      # @return [True] 無効（差分なし/設定値なし）
+      # @return [False] 有効
+      #
+      def invalid?
+        @calc == @actual
+      end
+    end
+  end
+end

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

@@ -0,0 +1,498 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../../era/western'
+
+# :nodoc:
+module Zakuro
+  #
+  # Operation 運用
+  #
+  module Operation
+    #
+    # Validator バリデーション
+    #
+    module Validator
+      #
+      # Types 型判定
+      #
+      module Types
+        EMPTY_STRING = '-'
+        BOOLEANS = %w[true false].freeze
+
+        # :reek:NilCheck
+
+        def self.string?(str: '')
+          !str.nil? && !str.empty? && str.is_a?(String)
+        end
+
+        # :reek:NilCheck
+
+        def self.empiable_string?(str: '')
+          !str.nil? && str.is_a?(String)
+        end
+
+        # :reek:NilCheck
+
+        def self.positive?(str: '')
+          return true if str == EMPTY_STRING
+
+          !str.nil? && !str.empty? && /^[0-9]+$/.match?(str)
+        end
+
+        # :reek:NilCheck
+
+        def self.num?(str: '')
+          return true if str == EMPTY_STRING
+
+          !str.nil? && !str.empty? && /^[-0-9]+$/.match?(str)
+        end
+
+        def self.bool?(str: '')
+          BOOLEANS.include?(str)
+        end
+
+        def self.empiable_bool?(str: '')
+          return true if str == EMPTY_STRING
+
+          bool?(str: str)
+        end
+
+        def self.month_days?(str: '')
+          return true if str == EMPTY_STRING
+
+          !str.nil? && !str.empty? && /^[大小]$/.match?(str)
+        end
+
+        def self.western_date?(str: '')
+          return Western::Calendar.new if str == EMPTY_STRING
+
+          Western::Calendar.valid_date_string(str: str)
+        end
+      end
+
+      #
+      # MonthHistory 変更履歴
+      #
+      class MonthHistory
+        attr_reader :index, :id, :parend_id, :western_date, :modified
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @id = yaml_hash['id']
+          @parent_id = yaml_hash['parent_id']
+          @western_date = yaml_hash['western_date']
+          @modified = yaml_hash['modified']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}] invalid"
+
+          failed.push("#{prefix} 'id'. #{@id}") unless id?
+
+          failed.push("#{prefix} 'parent_id'. #{@id}") unless parent_id?
+
+          failed.push("#{prefix} 'western_date'. #{@western_date}") unless western_date?
+
+          failed.push("#{prefix} 'modified'. #{@modified}") unless modified?
+
+          failed
+        end
+
+        def id?
+          Types.string?(str: @id)
+        end
+
+        def parent_id?
+          Types.string?(str: @parent_id)
+        end
+
+        def western_date?
+          Types.western_date?(str: @western_date)
+        end
+
+        def modified?
+          Types.bool?(str: @modified)
+        end
+      end
+
+      #
+      # Annotation 注釈
+      #
+      class Annotation
+        attr_reader :index, :id, :description, :note
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @id = yaml_hash['id']
+          @description = yaml_hash['description']
+          @note = yaml_hash['note']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}] invalid"
+
+          failed.push("#{prefix} 'id'. #{@id}") unless id?
+
+          failed.push("#{prefix} 'description'. #{@description}") unless description?
+
+          failed.push("#{prefix} 'note'. #{@note}") unless note?
+
+          failed
+        end
+
+        def id?
+          Types.string?(str: @id)
+        end
+
+        def description?
+          Types.empiable_string?(str: @description)
+        end
+
+        def note?
+          Types.string?(str: @note)
+        end
+      end
+
+      #
+      # Reference 参照
+      #
+      class Reference
+        attr_reader :index, :page, :number, :japan_date
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @page = yaml_hash['page']
+          @number = yaml_hash['number']
+          @japan_date = yaml_hash['japan_date']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}] invalid"
+
+          failed.push("#{prefix} 'page'. #{@page}") unless page?
+
+          failed.push("#{prefix} 'number'. #{@number}") unless number?
+
+          failed.push("#{prefix} 'japan_date'. #{@japan_date}") unless japan_date?
+
+          failed
+        end
+
+        def page?
+          Types.positive?(str: @page)
+        end
+
+        def number?
+          Types.positive?(str: @number)
+        end
+
+        def japan_date?
+          Types.string?(str: @japan_date)
+        end
+      end
+
+      #
+      # Diffs 総差分
+      #
+      class Diffs
+        attr_reader :index, :month, :solar_term, :days
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @month = Month.new(index: index, yaml_hash: yaml_hash['month'])
+          @solar_term = SolarTerm::Direction.new(index: index, yaml_hash: yaml_hash['solar_term'])
+          @days = yaml_hash['days']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}] invalid"
+
+          failed += @month.validate
+
+          failed += @solar_term.validate
+
+          failed.push("#{prefix} 'days'. #{@days}") unless days?
+
+          failed
+        end
+
+        def days?
+          Types.num?(str: @days)
+        end
+      end
+
+      #
+      # Month 月
+      #
+      class Month
+        attr_reader :index, :number, :leaped, :days
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @number = Number.new(index: index, yaml_hash: yaml_hash['number'])
+          @leaped = Leaped.new(index: index, yaml_hash: yaml_hash['leaped'])
+          @days = Days.new(index: index, yaml_hash: yaml_hash['days'])
+        end
+
+        def validate
+          failed = []
+
+          failed += @number.validate
+
+          failed += @leaped.validate
+
+          failed += @days.validate
+
+          failed
+        end
+      end
+
+      module SolarTerm
+        #
+        # Direction 二十四節気（移動）
+        #
+        class Direction
+          attr_reader :index, :source, :destination, :days
+
+          #
+          # 初期化
+          #
+          # @param [Source] source 二十四節気（移動元）
+          # @param [Destination] destination 二十四節気（移動先）
+          # @param [Integer] day 大余差分
+          #
+          def initialize(index:, yaml_hash: {})
+            @index = index
+            @source = Source.new(diff_index: index, yaml_hash: yaml_hash['calc'])
+            @destination = Destination.new(diff_index: index, yaml_hash: yaml_hash['actual'])
+            @days = yaml_hash['days']
+          end
+
+          def days?
+            Types.positive?(str: @days)
+          end
+
+          def validate
+            failed = []
+
+            prefix = "[#{index}][solar_term] invalid"
+
+            failed += @source.validate
+
+            failed += @destination.validate
+
+            failed.push("#{prefix} 'days'. #{@days}") unless days?
+
+            failed
+          end
+        end
+
+        #
+        # Source 二十四節気（移動元）
+        #
+        class Source
+          attr_reader :diff_index, :index, :to, :zodiac_name
+
+          def initialize(diff_index:, yaml_hash: {})
+            @diff_index = diff_index
+            @index = yaml_hash['index']
+            @to = yaml_hash['to']
+            @zodiac_name = yaml_hash['zodiac_name']
+          end
+
+          def validate
+            failed = []
+
+            prefix = "[#{@diff_index}][solar_term.calc] invalid"
+
+            failed.push("#{prefix} 'index'. #{@index}") unless index?
+
+            failed.push("#{prefix} 'to'. #{@to}") unless to?
+
+            failed.push("#{prefix} 'zodiac_name'. #{@zodiac_name}") unless zodiac_name?
+
+            failed
+          end
+
+          def index?
+            Types.positive?(str: @index)
+          end
+
+          def to?
+            Types.western_date?(str: @to)
+          end
+
+          def zodiac_name?
+            Types.string?(str: @zodiac_name)
+          end
+        end
+
+        #
+        # Destination 二十四節気（移動先）
+        #
+        class Destination
+          attr_reader :diff_index, :index, :from, :zodiac_name
+
+          def initialize(diff_index:, yaml_hash: {})
+            @diff_index = diff_index
+            @index = yaml_hash['index']
+            @from = yaml_hash['from']
+            @zodiac_name = yaml_hash['zodiac_name']
+          end
+
+          def validate
+            failed = []
+
+            prefix = "[#{@diff_index}][solar_term.actual] invalid"
+
+            failed.push("#{prefix} 'index'. #{@index}") unless index?
+
+            failed.push("#{prefix} 'from'. #{@from}") unless from?
+
+            failed.push("#{prefix} 'zodiac_name'. #{@zodiac_name}") unless zodiac_name?
+
+            failed
+          end
+
+          def index?
+            Types.positive?(str: @index)
+          end
+
+          def from?
+            Types.western_date?(str: @from)
+          end
+
+          def zodiac_name?
+            Types.string?(str: @zodiac_name)
+          end
+        end
+      end
+
+      #
+      # Number 月
+      #
+      class Number
+        NAME = 'number'
+
+        attr_reader :index, :calc, :actual
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @calc = yaml_hash['calc']
+          @actual = yaml_hash['actual']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}][#{NAME}] invalid"
+
+          failed.push("#{prefix} 'calc'. #{@calc}") unless calc?
+
+          failed.push("#{prefix} 'actual'. #{@actual}") unless actual?
+
+          failed
+        end
+
+        def calc?
+          Types.positive?(str: @calc)
+        end
+
+        def actual?
+          Types.positive?(str: @actual)
+        end
+      end
+
+      #
+      # Leaped 閏有無
+      #
+      class Leaped
+        NAME = 'leaped'
+
+        attr_reader :index, :calc, :actual
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @calc = yaml_hash['calc']
+          @actual = yaml_hash['actual']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}][#{NAME}] invalid"
+
+          failed.push("#{prefix} 'calc'. #{@calc}") unless calc?
+
+          failed.push("#{prefix} 'actual'. #{@actual}") unless actual?
+
+          failed
+        end
+
+        def calc?
+          Types.empiable_bool?(str: @calc)
+        end
+
+        def actual?
+          Types.empiable_bool?(str: @actual)
+        end
+      end
+
+      #
+      # 月日数（大小）
+      #
+      class Days
+        NAME = 'days'
+
+        attr_reader :index, :calc, :actual
+
+        def initialize(index:, yaml_hash: {})
+          @index = index
+          @calc = yaml_hash['calc']
+          @actual = yaml_hash['actual']
+        end
+
+        def validate
+          failed = []
+
+          prefix = "[#{@index}][#{NAME}] invalid"
+
+          failed.push("#{prefix} 'calc'. #{@calc}") unless calc?
+
+          failed.push("#{prefix} 'actual'. #{@actual}") unless actual?
+
+          failed
+        end
+
+        def calc?
+          Types.month_days?(str: @calc)
+        end
+
+        def actual?
+          Types.month_days?(str: @actual)
+        end
+      end
+
+      def self.run(yaml_hash: {})
+        failed = []
+        yaml_hash.each_with_index do |history, index|
+          failed += MonthHistory.new(index: index, yaml_hash: history).validate
+          failed += Annotation.new(index: index, yaml_hash: history).validate
+          failed += Reference.new(index: index, yaml_hash: history).validate
+          failed += Diffs.new(index: index, yaml_hash: history['diffs']).validate
+        end
+
+        failed
+      end
+    end
+  end
+end