zakuro 0.1.0 → 0.1.1

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

@@ -15,6 +15,8 @@ module Zakuro
     #
     INVALID_DAY_VALUE = -30
 
+    # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+
     #
     # MonthHistory 変更履歴
     #
@@ -32,6 +34,9 @@ module Zakuro
       # @return [Diffs] 総差分
       attr_reader :diffs
 
+      # rubocop:disable Metrics/ParameterLists
+      # :reek:LongParameterList { max_params: 6 }
+
       #
       # 初期化
       #
@@ -51,6 +56,7 @@ module Zakuro
         @annotations = annotations
         @diffs = diffs
       end
+      # rubocop:enable Metrics/ParameterLists
 
       #
       # 無効か

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

@@ -20,50 +20,118 @@ module Zakuro
         EMPTY_STRING = '-'
         BOOLEANS = %w[true false].freeze
 
-        # :reek:NilCheck
-
+        #
+        # 有効文字列か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
         def self.string?(str: '')
-          !str.nil? && !str.empty? && str.is_a?(String)
-        end
+          return false if str == ''
 
-        # :reek:NilCheck
+          return false unless str
 
-        def self.empiable_string?(str: '')
-          !str.nil? && str.is_a?(String)
+          str.is_a?(String)
         end
 
-        # :reek:NilCheck
+        #
+        # 有効文字列（空文字許容）か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def self.empiable_string?(str: '')
+          return false unless str
 
+          str.is_a?(String)
+        end
+
+        #
+        # 正数か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 正数
+        # @return [False] 負数
+        #
         def self.positive?(str: '')
           return true if str == EMPTY_STRING
 
-          !str.nil? && !str.empty? && /^[0-9]+$/.match?(str)
-        end
+          return false unless str
 
-        # :reek:NilCheck
+          /^[0-9]+$/.match?(str)
+        end
 
+        #
+        # 数値か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 数値
+        # @return [False] 非数値
+        #
         def self.num?(str: '')
           return true if str == EMPTY_STRING
 
-          !str.nil? && !str.empty? && /^[-0-9]+$/.match?(str)
+          return false unless str
+
+          /^[-0-9]+$/.match?(str)
         end
 
+        #
+        # booleanか
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] boolean
+        # @return [False] 非boolean
+        #
         def self.bool?(str: '')
           BOOLEANS.include?(str)
         end
 
+        #
+        # boolean（空許容）か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] boolean
+        # @return [False] 非boolean
+        #
         def self.empiable_bool?(str: '')
           return true if str == EMPTY_STRING
 
           bool?(str: str)
         end
 
+        #
+        # 月差分か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
         def self.month_days?(str: '')
           return true if str == EMPTY_STRING
 
-          !str.nil? && !str.empty? && /^[大小]$/.match?(str)
+          return false unless str
+
+          /^[大小]$/.match?(str)
         end
 
+        #
+        # 西暦日か
+        #
+        # @param [String] str 対象文字列
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
         def self.western_date?(str: '')
           return Western::Calendar.new if str == EMPTY_STRING
 
@@ -71,12 +139,33 @@ module Zakuro
         end
       end
 
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
       #
       # MonthHistory 変更履歴
       #
       class MonthHistory
-        attr_reader :index, :id, :parend_id, :western_date, :modified
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] ID
+        attr_reader :id
+        # @return [String] 親ID
+        attr_reader :parend_id
+        # @return [String] 西暦日
+        attr_reader :western_date
+        # @return [String] 有効行
+        attr_reader :modified
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :id ID
+        # @option yaml_hash [String] :parent_id 親ID
+        # @option yaml_hash [String] :western_date 西暦日
+        # @option yaml_hash [String] :modified 有効行
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @id = yaml_hash['id']
@@ -85,6 +174,13 @@ module Zakuro
           @modified = yaml_hash['modified']
         end
 
+        # :reek:TooManyStatements { max_statements: 7 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -122,8 +218,24 @@ module Zakuro
       # Annotation 注釈
       #
       class Annotation
-        attr_reader :index, :id, :description, :note
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] ID
+        attr_reader :id
+        # @return [String] 注釈内容
+        attr_reader :description
+        # @return [String] 補足
+        attr_reader :note
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :id ID
+        # @option yaml_hash [String] :description 注釈内容
+        # @option yaml_hash [String] :note 補足
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @id = yaml_hash['id']
@@ -131,6 +243,13 @@ module Zakuro
           @note = yaml_hash['note']
         end
 
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -162,8 +281,24 @@ module Zakuro
       # Reference 参照
       #
       class Reference
-        attr_reader :index, :page, :number, :japan_date
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] 原文頁数
+        attr_reader :page
+        # @return [String] 原文注釈番号
+        attr_reader :number
+        # @return [String] 和暦日
+        attr_reader :japan_date
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :page 原文頁数
+        # @option yaml_hash [String] :number 原文注釈番号
+        # @option yaml_hash [String] :japan_date 和暦日
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @page = yaml_hash['page']
@@ -171,6 +306,13 @@ module Zakuro
           @japan_date = yaml_hash['japan_date']
         end
 
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -202,8 +344,24 @@ module Zakuro
       # Diffs 総差分
       #
       class Diffs
-        attr_reader :index, :month, :solar_term, :days
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [Hash] 月差分
+        attr_reader :month
+        # @return [Hash] 二十四節気差分
+        attr_reader :solar_term
+        # @return [String] 日差分
+        attr_reader :days
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash] yaml_hash yaml
+        # @option yaml_hash [Hash] :month 月差分
+        # @option yaml_hash [Hash] :solar_term 二十四節気差分
+        # @option yaml_hash [String] :days 日差分
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @month = Month.new(index: index, yaml_hash: yaml_hash['month'])
@@ -211,6 +369,13 @@ module Zakuro
           @days = yaml_hash['days']
         end
 
+        # :reek:TooManyStatements { max_statements: 6 }
+
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -234,8 +399,24 @@ module Zakuro
       # Month 月
       #
       class Month
-        attr_reader :index, :number, :leaped, :days
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [Hash] 月差分
+        attr_reader :number
+        # @return [Hash] 閏有無差分
+        attr_reader :leaped
+        # @return [String] 中気差分
+        attr_reader :days
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, Object>] yaml_hash yaml
+        # @option yaml_hash [Hash] :number 月差分
+        # @option yaml_hash [Hash] :leaped 閏有無差分
+        # @option yaml_hash [String] :days 中気差分
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @number = Number.new(index: index, yaml_hash: yaml_hash['number'])
@@ -243,6 +424,11 @@ module Zakuro
           @days = Days.new(index: index, yaml_hash: yaml_hash['days'])
         end
 
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -261,14 +447,23 @@ module Zakuro
         # Direction 二十四節気（移動）
         #
         class Direction
-          attr_reader :index, :source, :destination, :days
+          # @return [Integer] 連番
+          attr_reader :index
+          # @return [Source] 移動元
+          attr_reader :source
+          # @return [Destination] 移動先
+          attr_reader :destination
+          # @return [String] 中気差分
+          attr_reader :days
 
           #
           # 初期化
           #
-          # @param [Source] source 二十四節気（移動元）
-          # @param [Destination] destination 二十四節気（移動先）
-          # @param [Integer] day 大余差分
+          # @param [Integer] index 連番
+          # @param [Hash<String, Object>] yaml_hash yaml
+          # @option yaml_hash [Hash] :calc 移動元
+          # @option yaml_hash [Hash] :actual 移動先
+          # @option yaml_hash [String] :days 中気差分
           #
           def initialize(index:, yaml_hash: {})
             @index = index
@@ -281,6 +476,13 @@ module Zakuro
             Types.positive?(str: @days)
           end
 
+          # :reek:TooManyStatements { max_statements: 6 }
+
+          #
+          # 検証する
+          #
+          # @return [Array<String>] エラーメッセージ
+          #
           def validate
             failed = []
 
@@ -300,8 +502,24 @@ module Zakuro
         # Source 二十四節気（移動元）
         #
         class Source
-          attr_reader :diff_index, :index, :to, :zodiac_name
+          # @return [Integer] 連番
+          attr_reader :diff_index
+          # @return [String] 移動対象の二十四節気番号
+          attr_reader :index
+          # @return [String] 移動先の月初日
+          attr_reader :to
+          # @return [String] 十干十二支
+          attr_reader :zodiac_name
 
+          #
+          # 初期化
+          #
+          # @param [Integer] diff_index 連番
+          # @param [Hash<String, String>] yaml_hash yaml
+          # @option yaml_hash [String] :index 移動対象の二十四節気番号
+          # @option yaml_hash [String] :to 移動先の月初日
+          # @option yaml_hash [String] :zodiac_name 十干十二支
+          #
           def initialize(diff_index:, yaml_hash: {})
             @diff_index = diff_index
             @index = yaml_hash['index']
@@ -309,6 +527,13 @@ module Zakuro
             @zodiac_name = yaml_hash['zodiac_name']
           end
 
+          # :reek:TooManyStatements { max_statements: 6 }
+
+          #
+          # 検証する
+          #
+          # @return [Array<String>] エラーメッセージ
+          #
           def validate
             failed = []
 
@@ -340,8 +565,24 @@ module Zakuro
         # Destination 二十四節気（移動先）
         #
         class Destination
-          attr_reader :diff_index, :index, :from, :zodiac_name
+          # @return [Integer] 連番
+          attr_reader :diff_index
+          # @return [String] 移動対象の二十四節気番号
+          attr_reader :index
+          # @return [String] 移動元の月初日
+          attr_reader :from
+          # @return [String] 十干十二支
+          attr_reader :zodiac_name
 
+          #
+          # 初期化
+          #
+          # @param [Integer] diff_index 連番
+          # @param [Hash<String, String>] yaml_hash yaml
+          # @option yaml_hash [String] :index 移動対象の二十四節気番号
+          # @option yaml_hash [String] :from 移動元の月初日
+          # @option yaml_hash [String] :zodiac_name 十干十二支
+          #
           def initialize(diff_index:, yaml_hash: {})
             @diff_index = diff_index
             @index = yaml_hash['index']
@@ -349,6 +590,13 @@ module Zakuro
             @zodiac_name = yaml_hash['zodiac_name']
           end
 
+          # :reek:TooManyStatements { max_statements: 6 }
+
+          #
+          # 検証する
+          #
+          # @return [Array<String>] エラーメッセージ
+          #
           def validate
             failed = []
 
@@ -383,14 +631,32 @@ module Zakuro
       class Number
         NAME = 'number'
 
-        attr_reader :index, :calc, :actual
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] 計算
+        attr_reader :calc
+        # @return [String] 運用
+        attr_reader :actual
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :calc 計算
+        # @option yaml_hash [String] :actual 運用
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @calc = yaml_hash['calc']
           @actual = yaml_hash['actual']
         end
 
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -418,14 +684,32 @@ module Zakuro
       class Leaped
         NAME = 'leaped'
 
-        attr_reader :index, :calc, :actual
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] 計算
+        attr_reader :calc
+        # @return [String] 運用
+        attr_reader :actual
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :calc 計算
+        # @option yaml_hash [String] :actual 運用
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @calc = yaml_hash['calc']
           @actual = yaml_hash['actual']
         end
 
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -448,19 +732,37 @@ module Zakuro
       end
 
       #
-      # 月日数（大小）
+      # Days 月日数（大小）
       #
       class Days
         NAME = 'days'
 
-        attr_reader :index, :calc, :actual
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] 計算
+        attr_reader :calc
+        # @return [String] 運用
+        attr_reader :actual
 
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [Hash<String, String>] yaml_hash yaml
+        # @option yaml_hash [String] :calc 計算
+        # @option yaml_hash [String] :actual 運用
+        #
         def initialize(index:, yaml_hash: {})
           @index = index
           @calc = yaml_hash['calc']
           @actual = yaml_hash['actual']
         end
 
+        #
+        # 検証する
+        #
+        # @return [Array<String>] エラーメッセージ
+        #
         def validate
           failed = []
 
@@ -482,6 +784,8 @@ module Zakuro
         end
       end
 
+      # :reek:TooManyStatements { max_statements: 7 }
+
       def self.run(yaml_hash: {})
         failed = []
         yaml_hash.each_with_index do |history, index|