zakuro 0.0.3 → 0.1.0

data/lib/zakuro/output/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# TODO: outputモジュール内にする
+
 # :nodoc:
 module Zakuro
   #

data/lib/zakuro/output/logger.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# TODO: outputモジュール内にする
+
 # :nodoc:
 module Zakuro
   #

data/lib/zakuro/output/response.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'result'
+require_relative '../result/result'
+
+# TODO: outputモジュール内にする
 
 # :nodoc:
 module Zakuro
@@ -53,7 +55,7 @@ module Zakuro
         month = param.month
         date = param.date
         days = param.days
-        Result::SingleDay.new(
+        Result::Data::SingleDay.new(
           year: save_year(year: year),
           month: save_month(month: month, date: date, days: days),
           day: save_day(month: month, date: date, days: days)
@@ -71,11 +73,11 @@ module Zakuro
         multi_gengou = year.multi_gengou
         first = multi_gengou.first_line
         second = multi_gengou.second_line
-        Result::Year.new(
+        Result::Data::Year.new(
           first_gengou:
-            Result::Gengou.new(name: first.name, number: first.year),
+            Result::Data::Gengou.new(name: first.name, number: first.year),
           second_gengou:
-            Result::Gengou.new(name: second.name, number: second.year),
+            Result::Data::Gengou.new(name: second.name, number: second.year),
           zodiac_name: year.zodiac_name, total_days: year.total_days
         )
       end
@@ -91,8 +93,8 @@ module Zakuro
       # @return [Result::Month] 月データ
       #
       def self.save_month(month:, date:, days:)
-        Result::Month.new(
-          number: month.number, leaped: month.leaped, days_name: month.days_name,
+        Result::Data::Month.new(
+          number: month.number, leaped: month.leaped?, days_name: month.days_name,
           first_day: save_first_day(remainder: month.remainder,
                                     date: date, days: days),
           odd_solar_terms: save_solar_term(term: month.odd_term),
@@ -112,11 +114,11 @@ module Zakuro
       #
       def self.save_first_day(remainder:, date:, days:)
         western_date = date.clone - days
-        Result::Day.new(
+        Result::Data::Day.new(
           number: 1,
           zodiac_name: remainder.zodiac_name,
-          remainder: remainder.format,
-          western_date: western_date.format
+          remainder: remainder,
+          western_date: western_date
         )
       end
       private_class_method :save_first_day
@@ -134,9 +136,9 @@ module Zakuro
         return [] if term.invalid?
 
         [
-          Result::SolarTerm.new(
+          Result::Data::SolarTerm.new(
             index: term.index,
-            remainder: term.remainder.format
+            remainder: term.remainder
           )
         ]
       end
@@ -157,11 +159,11 @@ module Zakuro
           # 常に参照元のRemainderクラスで生成する
           remainder.class.new(day: days, minute: 0, second: 0)
         )
-        Result::Day.new(
+        Result::Data::Day.new(
           number: (days + 1),
           zodiac_name: remainder.zodiac_name,
-          remainder: remainder.format,
-          western_date: date.format
+          remainder: remainder,
+          western_date: date
         )
       end
       private_class_method :save_day

data/lib/zakuro/result/core.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../tools/stringifier'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # Core 共通処理
+    #
+    class Core
+      #
+      # 初期化
+      #
+      def initialize(*_args); end
+
+      #
+      # ハッシュ化する
+      #
+      # @return [Hash<String, Object>] ハッシュ
+      #
+      def to_h
+        Tools::Stringifier.to_h(obj: self, class_prefix: 'Zakuro::Result')
+      end
+
+      #
+      # JSON化する
+      #
+      # @param [JSON::State] _args 引数（ Struct#to_json ）
+      #
+      # @return [String] JSON文字列
+      #
+      def to_json(*_args)
+        JSON.generate(to_h)
+      end
+
+      #
+      # JSON（整形）化する
+      #
+      # @return [String] JSON（整形）文字列
+      #
+      def to_pretty_json
+        JSON.pretty_generate(to_h)
+      end
+    end
+  end
+end

data/lib/zakuro/result/data.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative './core'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # データ部
+    #
+    module Data
+      #
+      # SingleDay 1日
+      #
+      class SingleDay < Core
+        # @return [Year] 年
+        attr_reader :year
+        # @return [Month] 月
+        attr_reader :month
+        # @return [Day] 日
+        attr_reader :day
+
+        #
+        # 初期化
+        #
+        # @param [Year] year 年
+        # @param [Month] month 月
+        # @param [Day] day 日
+        #
+        def initialize(year:, month:, day:)
+          super
+          @year = year
+          @month = month
+          @day = day
+        end
+      end
+
+      #
+      # Gengou 元号
+      #
+      class Gengou
+        # @return [String] 元号名
+        attr_reader :name
+        # @return [Integer] 元号年
+        attr_reader :number
+
+        #
+        # 初期化
+        #
+        # @param [String] name 元号名
+        # @param [Integer] number 元号年
+        #
+        def initialize(name: '', number: -1)
+          @name = name
+          @number = number
+        end
+      end
+
+      #
+      # Year 年
+      #
+      class Year
+        # @return [Gengou] 元号（1行目）
+        attr_reader :first_gengou
+        # @return [Gengou] 元号（2行目）
+        attr_reader :second_gengou
+        # @return [String] 十干十二支
+        attr_reader :zodiac_name
+        # @return [Integer] 日数
+        attr_reader :total_days
+
+        #
+        # 初期化
+        #
+        # @param [Gengou] first_gengou 元号（1行目）
+        # @param [Gengou] second_gengou 元号（2行目）
+        # @param [String] zodiac_name 十干十二支
+        # @param [Integer] total_days 日数
+        #
+        def initialize(first_gengou:, second_gengou:, zodiac_name:, total_days:)
+          @first_gengou = first_gengou
+          @second_gengou = second_gengou
+          @zodiac_name = zodiac_name
+          @total_days = total_days
+        end
+      end
+
+      #
+      # SolarTerm 二十四節気
+      #
+      class SolarTerm
+        # @return [Integer] 連番
+        attr_reader :index
+        # @return [String] 大余小余
+        attr_reader :remainder
+
+        #
+        # 初期化
+        #
+        # @param [Integer] index 連番
+        # @param [String] remainder 大余小余
+        #
+        def initialize(index:, remainder:)
+          @index = index
+          @remainder = remainder
+        end
+      end
+
+      # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+
+      #
+      # Month 月
+      #
+      class Month
+        # @return [Integer] 月順（1-12）
+        attr_reader :number
+        # @return [True] 閏月
+        # @return [False] 平月
+        attr_reader :leaped
+        # @return [String] 月の大小
+        attr_reader :days_name
+        # @return [Day] 月初日データ
+        attr_reader :first_day
+        # @return [SolarTerm] 二十四節気（節気）
+        attr_reader :odd_solar_terms
+        # @return [SolarTerm] 二十四節気（中気）
+        attr_reader :even_solar_terms
+
+        # rubocop:disable Metrics/ParameterLists
+        # :reek:LongParameterList { max_params: 6 }
+
+        #
+        # 初期化
+        #
+        # @param [Integer] number 月順（1-12）
+        # @param [True, False] leaped 閏月/平月
+        # @param [String] days_name 月の大小
+        # @param [Day] first_day 月初日データ
+        # @param [SolarTerm] odd_solar_terms 二十四節気（節気）
+        # @param [SolarTerm] even_solar_terms 二十四節気（中気）
+        #
+        def initialize(number:, leaped:, days_name:, first_day:,
+                       odd_solar_terms:, even_solar_terms:)
+          @number = number
+          @leaped = leaped
+          @days_name = days_name
+          @first_day = first_day
+          @odd_solar_terms = odd_solar_terms
+          @even_solar_terms = even_solar_terms
+        end
+        # rubocop:enable Metrics/ParameterLists
+      end
+
+      #
+      # Day 日
+      #
+      class Day
+        # @return [Integer] 月初日から数えた日（M月d日のdに相当）
+        attr_reader :number
+        # @return [String] 十干十二支
+        attr_reader :zodiac_name
+        # @return [String] 大余小余
+        attr_reader :remainder
+        # @return [String] 年月日
+        attr_reader :western_date
+
+        #
+        # 初期化
+        #
+        # @param [Integer] number 月初日から数えた日（M月d日のdに相当）
+        # @param [String] zodiac_name 十干十二支
+        # @param [String] remainder 大余小余
+        # @param [String] western_date 年月日
+        #
+        def initialize(number:, zodiac_name:, remainder:, western_date:)
+          @number = number
+          @zodiac_name = zodiac_name
+          @remainder = remainder
+          @western_date = western_date
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/operation.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # 運用情報
+    #
+    module Operation
+      #
+      # Bundle 運用情報
+      #
+      class Bundle
+        # @return [True] 運用あり
+        # @return [False] 運用なし
+        attr_reader :operated
+        # @return [Month] 月別履歴情報
+        attr_reader :month
+        # @return [Data::SingleDay] 計算値
+        attr_reader :original
+
+        #
+        # 初期化
+        #
+        # @param [True, False] operated 運用有無
+        # @param [Month] month 月別履歴情報
+        # @param [Data::SingleDay] original 計算値
+        #
+        def initialize(operated:, month:, original:)
+          @operated = operated
+          @month = month
+          @original = original
+        end
+      end
+
+      #
+      # Month 月別履歴情報
+      #
+      class Month
+        # @return [Integer] 原文頁数
+        attr_reader :page
+        # @return [Integer] 原文注釈番号
+        attr_reader :number
+        # @return [Array<Zakuro::Result::Operation::Annotation>] 注釈
+        attr_reader :annotations
+
+        #
+        # 初期化
+        #
+        # @param [Integer] page 原文頁数
+        # @param [Integer] number 原文注釈番号
+        # @param [Array<Zakuro::Result::Operation::Annotation>] annotations 注釈
+        #
+        def initialize(page: -1, number: -1, annotations: [])
+          @page = page
+          @number = number
+          @annotations = annotations
+        end
+      end
+
+      #
+      # Annotation 注釈
+      #
+      class Annotation
+        # @return [String] 注釈内容
+        attr_reader :description
+        # @return [String] 注釈補記
+        attr_reader :note
+
+        #
+        # 初期化
+        #
+        # @param [String] description 注釈内容
+        # @param [<Type>] note 注釈補記
+        #
+        def initialize(description:, note:)
+          @description = description
+          @note = note
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/result/result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative './core'
+require_relative './data'
+require_relative './operation'
+
+# :nodoc:
+module Zakuro
+  #
+  # Result 演算結果
+  #
+  module Result
+    #
+    # Single 1日検索結果
+    #
+    class Single < Core
+      # @return [Data::SingleDay] 1日
+      attr_reader :data
+      # @return [Operation::Bundle] 運用情報
+      attr_reader :operation
+
+      #
+      # 初期化
+      #
+      # @param [Data::SingleDay] data 1日
+      # @param [Operation::Bundle] operation 運用情報
+      #
+      def initialize(data:, operation:)
+        super
+        @data = data
+        @operation = operation
+      end
+    end
+  end
+end