zakuro 0.1.0 → 0.1.1

data/doc/operation/transfer.rb

@@ -5,12 +5,16 @@ require 'yaml'
 
 table = CSV.read('csv/month.csv', headers: true)
 
+# :reek:UtilityFunction
+
 def month_str_to_number(str)
   return str if str == '-'
 
   str.match('([0-9]{1,2})')[0]
 end
 
+# :reek:UtilityFunction
+
 def month_str_to_leaped(str)
   return str if str == '-'
 
@@ -23,8 +27,8 @@ result = []
 table.each do |row|
   hash = {
     'id' => row['ID'],
-    'relation_id' => row['関連内容ID'],
-    'parent_id' => row['親ID'],
+    'relation_id' => row['関連注釈ID'],
+    'parent_id' => row['親注釈ID'],
     'page' => row['頁数'],
     'number' => row['注番'],
     'japan_date' => row['和暦'],

data/lib/zakuro/condition.rb

@@ -25,8 +25,6 @@ module Zakuro
         @date = date
       end
 
-      # :reek:NilCheck
-
       #
       # 検証する
       #
@@ -36,7 +34,9 @@ module Zakuro
       #
       def self.validate(date:)
         failed = []
-        return failed if date.nil? || date.is_a?(Date) || date.is_a?(String)
+        return failed unless date
+
+        return failed if date.is_a?(Date) || date.is_a?(String)
 
         failed.push("invalid date: #{date}")
         failed
@@ -64,7 +64,7 @@ module Zakuro
         @last = hash[:last]
       end
 
-      # :reek:TooManyStatements { max_statements: 7 } and :reek:NilCheck
+      # :reek:TooManyStatements { max_statements: 7 }
 
       #
       # 検証する
@@ -75,7 +75,7 @@ module Zakuro
       #
       def self.validate(hash:)
         failed = []
-        return failed if hash.nil?
+        return failed unless hash
 
         unless hash.is_a?(Hash)
           failed.push("invalid range type. #{hash}. should be hash")
@@ -106,8 +106,6 @@ module Zakuro
         @columns = columns
       end
 
-      # :reek:NilCheck
-
       #
       # 検証する
       #
@@ -118,7 +116,10 @@ module Zakuro
       def self.validate(columns:)
         # TODO: 列内容のバリデーション
         failed = []
-        return failed if columns.nil? || columns.is_a?(Array)
+
+        return failed unless columns
+
+        return failed if columns.is_a?(Array)
 
         failed.push("invalid columns type. #{columns}. should be array")
 
@@ -148,7 +149,6 @@ module Zakuro
       end
 
       # TODO: オプションキーのバリデーション
-      # :reek:NilCheck
 
       #
       # 検証する
@@ -159,7 +159,9 @@ module Zakuro
       #
       def self.validate(options:)
         failed = []
-        return failed if options.nil? || options.is_a?(Hash)
+        return failed unless options
+
+        return failed if options.is_a?(Hash)
 
         failed.push("invalid options type. #{options}. should be hash")
 
@@ -222,8 +224,6 @@ module Zakuro
       failed
     end
 
-    # :reek:NilCheck
-
     #
     # 上書きする
     #
@@ -233,7 +233,10 @@ module Zakuro
       instance_variables.each do |var|
         key = var.to_s.delete('@')
         val = hash[key.intern]
-        instance_variable_set(var, val) unless val.nil?
+
+        next unless val
+
+        instance_variable_set(var, val)
       end
     end
   end

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

@@ -48,8 +48,6 @@ module Zakuro
           @start_year = hash['start_year']
         end
 
-        # :reek:NilCheck
-
         #
         # 元号情報を生成する
         #
@@ -58,7 +56,7 @@ module Zakuro
         def create
           start_date = Western::Calendar.parse(str: @start_date)
           new_year_date = Western::Calendar.parse(str: @new_year_date)
-          start_year = @start_year.nil? ? 1 : @start_year
+          start_year = @start_year || 1
 
           Gengou.new(name: @name, start_date: start_date, new_year_date: new_year_date,
                      year: start_year)

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

@@ -58,8 +58,6 @@ module Zakuro
         nil
       end
 
-      # :reek:NilCheck
-
       #
       # 日付が有効かどうかを確認する
       #
@@ -69,7 +67,9 @@ module Zakuro
       # @return [False] 無効
       #
       def self.valid_date(date:)
-        !date.nil? && date.is_a?(Western::Calendar)
+        return false unless date
+
+        date.is_a?(Western::Calendar)
       end
 
       #

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

@@ -60,8 +60,6 @@ module Zakuro
           failed
         end
 
-        # :reek:NilCheck
-
         #
         # IDを検証する
         #
@@ -69,7 +67,9 @@ module Zakuro
         # @return [False] 正しくない
         #
         def id?
-          !(@id.nil? || !@id.is_a?(Integer))
+          return false unless @id
+
+          @id.is_a?(Integer)
         end
 
         #
@@ -79,7 +79,9 @@ module Zakuro
         # @return [False] 正しくない
         #
         def name?
-          !(@name.nil? || !@name.is_a?(String))
+          return false unless @name
+
+          @name.is_a?(String)
         end
 
         #
@@ -92,8 +94,6 @@ module Zakuro
           Western::Calendar.valid_date_string(str: @end_date)
         end
 
-        # :reek:NilCheck
-
         #
         # 元号情報を検証する
         #
@@ -101,7 +101,9 @@ module Zakuro
         # @return [False] 正しくない
         #
         def list?
-          (!@list.nil? || @list.is_a?(Array))
+          return false unless @list
+
+          @list.is_a?(Array)
         end
 
         #
@@ -121,6 +123,8 @@ module Zakuro
         end
       end
 
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+
       #
       # Gengou 元号情報
       #
@@ -172,8 +176,6 @@ module Zakuro
           failed
         end
 
-        # :reek:NilCheck
-
         #
         # 元号名を検証する
         #
@@ -181,7 +183,9 @@ module Zakuro
         # @return [False] 正しくない
         #
         def name?
-          (!@name.nil? || @name.is_a?(String))
+          return false unless @name
+
+          @name.is_a?(String)
         end
 
         #
@@ -204,8 +208,6 @@ module Zakuro
           Western::Calendar.valid_date_string(str: @new_year_date)
         end
 
-        # :reek:NilCheck
-
         #
         # 元号年を検証する
         #
@@ -213,7 +215,7 @@ module Zakuro
         # @return [False] 正しくない
         #
         def year?
-          return true if @start_year.nil?
+          return true unless @start_year
 
           @start_year.is_a?(Integer)
         end

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

@@ -130,42 +130,30 @@ module Zakuro
       # @return [Array<MonthHistory>] 変更履歴
       #
       def self.load(yaml_hash: {})
-        annotations = {}
-        relations = {}
-        histories = create_histories(yaml_hash: yaml_hash, annotations: annotations,
-                                     relations: relations)
+        histories = create_histories(yaml_hash: yaml_hash)
 
-        add_annotations(histories: histories, annotations: annotations, relations: relations)
+        annotation_parser = AnnotationParser.new(yaml_hash: yaml_hash)
+        annotation_parser.create
+
+        add_annotations(histories: histories, annotation_parser: annotation_parser)
       end
 
       #
       # 変更履歴を読み込む
       #
       # @param [Hash] yaml_hash 設定ファイルテキスト
-      # @param [Hash] annotations 注釈（空）
-      # @param [Hash] relations 関連ID設定（空）
       #
       # @return [Array<MonthHistory>] 変更履歴
       #
-      def self.create_histories(yaml_hash: {}, annotations: {}, relations: {})
+      def self.create_histories(yaml_hash: {})
         result = []
         yaml_hash.each do |month|
-          id = month['id']
-          annotations[id] = Annotation.new(
-            id: id,
-            description: Operation::TypeParser.text(str: month['description']),
-            note: Operation::TypeParser.text(str: month['note'])
-          )
-          relation_id = month['relation_id']
-
-          relations[id] = relation_id unless Operation::TypeParser.invalid?(str: relation_id)
-
           next unless Operation::TypeParser.modified?(str: month['modified'])
 
-          history = create_history(yaml_hash: month)
-          result.push(history)
+          result.push(
+            create_history(yaml_hash: month)
+          )
         end
-
         result
       end
       private_class_method :create_histories
@@ -177,21 +165,22 @@ module Zakuro
         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: yaml_hash['parent_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(histories: [], annotations: {}, relations: {})
+      def self.add_annotations(annotation_parser:, histories: [])
         result = []
         histories.each do |history|
+          id = history.id
           result.push(
             MonthHistory.new(
-              id: history.id, reference: history.reference, western_date: history.western_date,
-              annotations: create_history_annnotations(history: history, annotations: annotations,
-                                                       relations: relations),
+              id: id, parent_id: history.parent_id, reference: history.reference,
+              western_date: history.western_date,
+              annotations: annotation_parser.specify(id: id),
               diffs: history.diffs
             )
           )
@@ -214,11 +203,100 @@ module Zakuro
 
       def self.add_annotation(history_annotations: [], annotations: {}, id: '')
         annotation = annotations.fetch(id, Annotation.new)
-        history_annotations.push(annotation) unless annotation.invalid?
+        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 月情報（差分）解析
     #
@@ -259,19 +337,37 @@ module Zakuro
       private_class_method :create_destination_solar_term
 
       def self.create_month(yaml_hash: {})
-        number = yaml_hash['number']
-        leaped = yaml_hash['leaped']
-        days = yaml_hash['days']
-
         Month.new(
-          number: Number.new(calc: Operation::TypeParser.month_number(str: number['calc']),
-                             actual: Operation::TypeParser.month_number(str: number['actual'])),
-          leaped: Leaped.new(calc: Operation::TypeParser.month_leaped(str: leaped['calc']),
-                             actual: Operation::TypeParser.month_leaped(str: leaped['actual'])),
-          days: Days.new(calc: days['calc'], actual: days['actual'])
+          number: create_month_number(yaml_hash: yaml_hash['number']),
+          leaped: create_month_leaped(yaml_hash: yaml_hash['leaped']),
+          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