zakuro 0.6.1 → 0.8.0

data/lib/zakuro/calculation/era/gengou/internal/reserve.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../../era/western/calendar'
-require_relative './reserve/range'
-require_relative './reserve/list'
+require_relative './reserve/dated_range'
 
 # :nodoc:
 module Zakuro
@@ -15,26 +14,28 @@ module Zakuro
       # 元号に基づき計算範囲を予約する
       #
       module Reserve
-        #
-        # 予約結果を取得する
-        #
-        #   * 開始日・終了日から計算する範囲を求める
-        #   * 開始日・終了日の範囲内にある元号全てが対象となる
-        #   * 元号に応じて計算範囲は変化する
-        #     * 元号の開始日（改元日）が開始日よりも前であれば、結果開始日は前者になる
-        #     * 元号の終了日（改元前日）が終了日よりも後であれば、結果終了日は前者になる
-        #     * 南北朝のように複数元号に属する場合、より広い範囲の元号に合わせる
-        #   * 属する元号よりもさらに範囲を広げる場合がある
-        #     * 開始日が最初の元号の改元後30日以内の場合、さらに前の元号まで対象にする
-        #     * 終了日が最後の元号の改元前日30日以内の場合、さらに次の元号まで対象にする
-        #
-        # @param [Western::Calendar] start_date 開始日
-        # @param [Western::Calendar] last_date 終了日
-        #
-        # @return [Range] 予約済み計算範囲
-        #
-        def self.get(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
-          Range.new(start_date: start_date, last_date: last_date)
+        class << self
+          #
+          # 予約結果を取得する
+          #
+          #   * 開始日・終了日から計算する範囲を求める
+          #   * 開始日・終了日の範囲内にある元号全てが対象となる
+          #   * 元号に応じて計算範囲は変化する
+          #     * 元号の開始日（改元日）が開始日よりも前であれば、結果開始日は前者になる
+          #     * 元号の終了日（改元前日）が終了日よりも後であれば、結果終了日は前者になる
+          #     * 南北朝のように複数元号に属する場合、より広い範囲の元号に合わせる
+          #   * 属する元号よりもさらに範囲を広げる場合がある
+          #     * 開始日が最初の元号の改元後30日以内の場合、さらに前の元号まで対象にする
+          #     * 終了日が最後の元号の改元前日30日以内の場合、さらに次の元号まで対象にする
+          #
+          # @param [Western::Calendar] start_date 開始日
+          # @param [Western::Calendar] last_date 終了日
+          #
+          # @return [Range] 予約済み計算範囲
+          #
+          def get(start_date: Western::Calendar.new, last_date: Western::Calendar.new)
+            DatedRange.new(start_date: start_date, last_date: last_date)
+          end
         end
       end
     end

data/lib/zakuro/calculation/era/gengou/named_scroll.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './abstract_scroll'
+require_relative './internal/reserve/named_range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Gengou
+      # NamedScroll
+      #
+      # 元号スクロール
+      #
+      class NamedScroll < AbstractScroll
+        #
+        # 初期化
+        #
+        # @param [String] start_name 開始元号名
+        # @param [String] last_name 終了元号名
+        #
+        def initialize(start_name: INVALID_NAME, last_name: INVALID_NAME)
+          range = Reserve::NamedRange.new(start_name: start_name, last_name: last_name)
+          super(range: range)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/era/version/internal/crawler.rb

@@ -13,37 +13,54 @@ module Zakuro
       # 暦検索
       #
       module Crawler
-        #
-        # 暦の範囲を取得する
-        #
-        # @param [Integer] start_year 開始西暦年
-        # @param [Integer] last_year 終了西暦年
-        #
-        # @return [Array<Range>] 暦の範囲
-        #
-        def self.get(start_year:, last_year:)
-          ranges = Japan::Version.ranges_with_year(start_year: start_year, last_year: last_year)
-
-          result = []
-
-          ranges.each do |range|
-            next unless range.released
+        class << self
+          #
+          # 暦の範囲を取得する
+          #
+          # @param [Integer] start_year 開始西暦年
+          # @param [Integer] last_year 終了西暦年
+          #
+          # @return [Array<Range>] 暦の範囲
+          #
+          def get(start_year:, last_year:)
+            ranges = Japan::Version.ranges_with_year(start_year: start_year, last_year: last_year)
 
+            result = []
+
+            ranges.each do |range|
+              next unless range.released
+
+              narrowed_range = narrow(range: range, start_year: start_year, last_year: last_year)
+
+              result.push(narrowed_range)
+            end
+
+            result
+          end
+
+          private
+
+          #
+          # 範囲を開始年・終了年に合わせて狭める
+          #
+          # @param [Range] range 範囲
+          # @param [Integer] start_year 開始西暦年
+          # @param [Integer] last_year 終了西暦年
+          #
+          # @return [Range] 範囲
+          #
+          def narrow(range:, start_year:, last_year:)
             range_start_year = range.start_year
             range_start_year = start_year if start_year > range.start_year
 
             range_last_year = range.last_year
             range_last_year = last_year if last_year < range.last_year
 
-            result.push(
-              Range.new(
-                name: range.name, start_date: range.start_date.clone,
-                start_year: range_start_year, last_year: range_last_year
-              )
+            Range.new(
+              name: range.name, start_date: range.start_date.clone,
+              start_year: range_start_year, last_year: range_last_year
             )
           end
-
-          result
         end
       end
     end

data/lib/zakuro/calculation/era/version/version.rb

@@ -8,16 +8,18 @@ module Zakuro
   module Calculation
     # :nodoc:
     module Version
-      #
-      # 暦の範囲を取得する
-      #
-      # @param [Integer] start_year 開始西暦年
-      # @param [Integer] last_year 終了西暦年
-      #
-      # @return [Array<Range>] 暦の範囲
-      #
-      def self.get(start_year:, last_year:)
-        Crawler.get(start_year: start_year, last_year: last_year)
+      class << self
+        #
+        # 暦の範囲を取得する
+        #
+        # @param [Integer] start_year 開始西暦年
+        # @param [Integer] last_year 終了西暦年
+        #
+        # @return [Array<Range>] 暦の範囲
+        #
+        def get(start_year:, last_year:)
+          Crawler.get(start_year: start_year, last_year: last_year)
+        end
       end
     end
   end

data/lib/zakuro/calculation/monthly/abstract_lunar_phase.rb

@@ -2,6 +2,8 @@
 
 require_relative '../../output/logger'
 
+require_relative './const'
+
 # :nodoc:
 module Zakuro
   # :nodoc:
@@ -16,8 +18,10 @@ module Zakuro
         LOGGER = Output::Logger.new(location: 'lunar_phase')
 
         # @return [Array<String>] 月内の弦
-        PHASE_INDEXES = %w[朔日 上弦 望月 下弦].freeze
+        PHASE_INDEXES = Const::PHASE_INDEXES
 
+        # @return [Cycle::AbstractRemainder] 弦
+        attr_reader :quarter
         # @return [Cycle::AbstractRemainder] 経
         attr_reader :average_remainder
         # @return [Solar::AbstractLocation] 入定気
@@ -30,14 +34,14 @@ module Zakuro
         #
         # 初期化
         #
-        # @param [Cycle::AbstractRemainder] quater 弦
+        # @param [Cycle::AbstractRemainder] quarter 弦
         # @param [Solar::AbstractLocation] average_remainder 経
         # @param [Solar::AbstractLocation] solar_location 入定気
         # @param [Lunar::AbstractLocation] lunar_location 入暦
         #
-        def initialize(quater:, average_remainder:, solar_location:, lunar_location:)
+        def initialize(quarter:, average_remainder:, solar_location:, lunar_location:)
           # 弦
-          @quarter = quater
+          @quarter = quarter
           # 経
           @average_remainder = average_remainder
           # 入定気
@@ -87,7 +91,7 @@ module Zakuro
         #
         def next_index
           @index += 1
-          @index = 0 if @index >= PHASE_INDEXES.size
+          @index = 0 if index >= PHASE_INDEXES.size
           @index
         end
 
@@ -98,7 +102,7 @@ module Zakuro
         # @return [False] 朔月ではない
         #
         def first_phase?
-          @index.zero?
+          index.zero?
         end
 
         #
@@ -157,9 +161,9 @@ module Zakuro
         end
 
         def add_quarter_moon_size
-          @average_remainder.add!(@quarter)
-          @solar_location.add_quarter
-          @lunar_location.add_quarter
+          average_remainder.add!(quarter)
+          solar_location.add_quarter
+          lunar_location.add_quarter
 
           next_index
         end

data/lib/zakuro/calculation/monthly/const.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Calculation
+    # :nodoc:
+    module Monthly
+      #
+      # Const 定数
+      #
+      module Const
+        # @return [Array<String>] 月内の弦
+        PHASE_INDEXES = %w[朔日 上弦 望月 下弦].freeze
+      end
+    end
+  end
+end

data/lib/zakuro/calculation/monthly/initialized_month.rb

@@ -25,7 +25,7 @@ module Zakuro
         #
         # 初期化
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [MonthLabel] month_label 月表示名
         # @param [Array<SolarTerm>] solar_terms 二十四節気
         # @param [FirstDay] first_day 月初日（朔日）
@@ -67,43 +67,6 @@ module Zakuro
           )
         end
 
-        #
-        # 中気の連番に合わせて月を返す
-        #
-        # @example
-        #   20: 9月
-        #   22: 10月
-        #   0: 11月
-        #   2: 12月
-        #   4: 1月
-        #
-        # @param [Integer] index 中気番号
-        #
-        # @return [Integer] 月
-        #
-        def self.month_number_by_even_term_index(index)
-          half_index = index / 2
-
-          # 11月、12月
-          return half_index + 11 if half_index < 2
-
-          # 1月～10月
-          half_index - 1
-        end
-
-        #
-        # 節気の連番に合わせて月を返す
-        #
-        # @param [Integer] index 節気番号
-        #
-        # @return [Integer] 月
-        #
-        def self.month_number_by_odd_term_index(index)
-          even_index = index - 1
-
-          month_number_by_even_term_index(even_index)
-        end
-
         #
         # 一ヶ月戻す
         #
@@ -119,6 +82,45 @@ module Zakuro
         def solar_term_size
           solar_terms.size
         end
+
+        class << self
+          #
+          # 中気の連番に合わせて月を返す
+          #
+          # @example
+          #   20: 9月
+          #   22: 10月
+          #   0: 11月
+          #   2: 12月
+          #   4: 1月
+          #
+          # @param [Integer] index 中気番号
+          #
+          # @return [Integer] 月
+          #
+          def month_number_by_even_term_index(index)
+            half_index = index / 2
+
+            # 11月、12月
+            return half_index + 11 if half_index < 2
+
+            # 1月～10月
+            half_index - 1
+          end
+
+          #
+          # 節気の連番に合わせて月を返す
+          #
+          # @param [Integer] index 節気番号
+          #
+          # @return [Integer] 月
+          #
+          def month_number_by_odd_term_index(index)
+            even_index = index - 1
+
+            month_number_by_even_term_index(even_index)
+          end
+        end
       end
     end
   end

data/lib/zakuro/calculation/monthly/month.rb

@@ -14,7 +14,7 @@ module Zakuro
       # Month 月情報
       #
       class Month
-        # @return [Context] 暦コンテキスト
+        # @return [Context::Context] 暦コンテキスト
         attr_reader :context
         # @return [MonthLabel] 月表示名
         attr_reader :month_label
@@ -28,14 +28,14 @@ module Zakuro
         #
         # 初期化
         #
-        # @param [Context] context 暦コンテキスト
+        # @param [Context::Context] context 暦コンテキスト
         # @param [MonthLabel] month_label 月表示名
         # @param [FirstDay] first_day 月初日（朔日）
         # @param [Array<SolarTerm>] solar_terms 二十四節気
         # @param [Base::Gengou] gengou 元号
         #
-        def initialize(context: Context.new, month_label: MonthLabel.new, first_day: FirstDay.new,
-                       solar_terms: [], gengou: Base::Gengou.new)
+        def initialize(context: Context::Context.new, month_label: MonthLabel.new,
+                       first_day: FirstDay.new, solar_terms: [], gengou: Base::Gengou.new)
           @context = context
           @month_label = month_label
           @first_day = first_day
@@ -50,7 +50,7 @@ module Zakuro
         # @return [False] 不正なし
         #
         def invalid?
-          @context.invalid?
+          context.invalid?
         end
 
         #
@@ -68,7 +68,7 @@ module Zakuro
         # @return [Western::Calendar] 西暦日
         #
         def western_date
-          @first_day.western_date
+          first_day.western_date
         end
 
         #
@@ -77,7 +77,7 @@ module Zakuro
         # @return [Remainder] 大余小余
         #
         def remainder
-          @first_day.remainder
+          first_day.remainder
         end
 
         #
@@ -87,7 +87,7 @@ module Zakuro
         # @return [False] 小の月（29日）
         #
         def many_days?
-          @month_label.is_many_days
+          month_label.is_many_days
         end
 
         #
@@ -96,7 +96,7 @@ module Zakuro
         # @return [Integer] 日数
         #
         def days
-          @month_label.days
+          month_label.days
         end
 
         #
@@ -105,7 +105,7 @@ module Zakuro
         # @return [String] 月の名前（大小）
         #
         def days_name
-          @month_label.days_name
+          month_label.days_name
         end
 
         #
@@ -114,7 +114,7 @@ module Zakuro
         # @return [Integer] 月（xx月のxx）
         #
         def number
-          @month_label.number
+          month_label.number
         end
 
         #
@@ -124,7 +124,7 @@ module Zakuro
         # @return [False] 平月
         #
         def leaped?
-          @month_label.leaped
+          month_label.leaped
         end
 
         #
@@ -147,7 +147,7 @@ module Zakuro
         # @return [False] 設定あり
         #
         def empty_solar_term?
-          @solar_terms.empty?
+          solar_terms.empty?
         end
 
         #
@@ -156,7 +156,7 @@ module Zakuro
         # @return [SolarTerm] 中気
         #
         def even_term
-          @solar_terms.each do |term|
+          solar_terms.each do |term|
             return term if term.index.even?
           end
 
@@ -169,7 +169,7 @@ module Zakuro
         # @return [SolarTerm] 節気
         #
         def odd_term
-          @solar_terms.each do |term|
+          solar_terms.each do |term|
             return term if term.index.odd?
           end
 
@@ -182,7 +182,7 @@ module Zakuro
         # @param [SolarTerm] term 二十四節気
         #
         def add_term(term:)
-          @solar_terms.push(term)
+          solar_terms.push(term)
         end
 
         #
@@ -228,6 +228,45 @@ module Zakuro
 
           true
         end
+
+        #
+        # 範囲内か
+        #
+        # @param [Japan::Calendar] date 日付
+        #
+        # @return [True] 範囲内
+        # @return [False] 範囲外
+        #
+        def include_by_japan_date?(date:)
+          return false if invalid?
+
+          linear_gengou = gengou.match_by_name(name: date.gengou)
+          return false if linear_gengou.invalid?
+
+          return false unless linear_gengou.name == date.gengou
+
+          return false unless linear_gengou.year == date.year
+
+          same_by_japan_date?(date: date)
+        end
+
+        private
+
+        #
+        # 同一の月情報かを検証する
+        #
+        # @param [Japan::Calendar] date 日付
+        #
+        # @return [True] 同一の月
+        # @return [False] 異なる月
+        #
+        def same_by_japan_date?(date: Japan::Calendar.new)
+          return false unless number == date.month
+
+          return false unless leaped? == date.leaped
+
+          true
+        end
       end
     end
   end

data/lib/zakuro/calculation/monthly/month_label.rb

@@ -43,7 +43,7 @@ module Zakuro
         # @return [Integer] 日数
         #
         def days
-          @is_many_days ? 30 : 29
+          is_many_days ? 30 : 29
         end
 
         #
@@ -52,7 +52,7 @@ module Zakuro
         # @return [String] 月の名前（大小）
         #
         def days_name
-          @is_many_days ? '大' : '小'
+          is_many_days ? '大' : '小'
         end
 
         #
@@ -64,7 +64,7 @@ module Zakuro
         def back_to_last_month
           @number -= 1
 
-          return false if @number.positive?
+          return false if number.positive?
 
           @number = 12
 
@@ -80,7 +80,7 @@ module Zakuro
         # @return [False] 異なる月
         #
         def same?(other:)
-          @number == other.number && @leaped == other.leaped
+          number == other.number && leaped == other.leaped
         end
       end
     end