zakuro 0.6.1 → 0.7.0

data/lib/zakuro/era/western/calendar.rb

@@ -381,18 +381,18 @@ module Zakuro
       #
       # 年月日情報（西暦）を生成する
       #
-      # @param [String] str 日付文字列
+      # @param [String] text 日付文字列
       # @param [Symbol] type 日付種別
       #
       # @return [Calendar] 年月日情報（西暦）
       #
-      def self.parse(str: '', type: Type::DEFAULT)
-        unless Calendar.valid_date_string(str: str, type: type)
-          raise ArgumentError, "invalid date string: #{str}"
+      def self.parse(text: '', type: Type::DEFAULT)
+        unless Calendar.valid_date_string(text: text, type: type)
+          raise ArgumentError, "invalid date string: #{text}"
         end
 
         start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
-        date = Date.parse(str, start)
+        date = Date.parse(text, start)
 
         Calendar.new(
           year: date.year, month: date.month, day: date.day, type: type
@@ -402,18 +402,18 @@ module Zakuro
       #
       # 日付文字列を検証する
       #
-      # @param [String] str 日付文字列
+      # @param [String] text 日付文字列
       # @param [Symbol] type 日付種別
       #
       # @return [True] 正しい
       # @return [True] 正しくない
       #
-      def self.valid_date_string(str: '', type: Type::DEFAULT)
+      def self.valid_date_string(text: '', type: Type::DEFAULT)
         start = DATE_START.fetch(type, DATE_START[Type::DEFAULT])
         begin
-          Date.parse(str, start)
+          Date.parse(text, start)
         rescue ArgumentError => _e
-          false
+          return false
         end
         true
       end

data/lib/zakuro/exception/case/pattern.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative './template'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Pattern 原因パターン
+      #
+      module Pattern
+        INTERNAL_ERROR = Template.new(
+          code: 'ERROR_0001',
+          message: '致命的なエラーです。',
+          length: 0
+        )
+
+        INVALID_DATE = Template.new(
+          code: 'ERROR_0002',
+          message: '一日検索の日付指定が誤っています。',
+          length: 0
+        )
+
+        INVALID_RANGE = Template.new(
+          code: 'ERROR_0003',
+          message: '範囲検索の日付指定が誤っています。',
+          length: 0
+        )
+      end
+    end
+  end
+end

data/lib/zakuro/exception/case/preset.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative './template'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Preset プリセット
+      #
+      class Preset
+        # @return [Template] テンプレート
+        attr_reader :template
+        # @return [Array<Object>] メッセージ引数
+        attr_reader :args
+
+        #
+        # 初期化
+        #
+        # @param [String] args メッセージ引数
+        # @param [String] template テンプレート
+        #
+        def initialize(*args, template:)
+          @template = template
+          @args = args
+        end
+
+        #
+        # エラーコードを取得する
+        #
+        # @return [String] エラーコード
+        #
+        def code
+          @template.code
+        end
+
+        #
+        # メッセージを作成する
+        #
+        # @return [String] メッセージ
+        #
+        def message
+          @template.format(*args)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/exception/case/template.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # :nodoc:
+    module Case
+      #
+      # Template テンプレート
+      #
+      class Template
+        # @return [String] エラーコード
+        attr_reader :code
+        # @return [String] メッセージ
+        attr_reader :message
+        # @return [Integer] テンプレート引数長
+        attr_reader :length
+
+        #
+        # 初期化
+        #
+        # @param [String] code エラーコード
+        # @param [String] message メッセージ
+        # @param [Integer] length テンプレート引数長
+        #
+        def initialize(code:, message:, length: 0)
+          @code = code
+          @message = message
+          @length = length
+        end
+
+        #
+        # メッセージを作成する
+        #
+        # @param [Array<Object>] args テンプレート引数長
+        #
+        # @return [String] メッセージ
+        #
+        def format(*args)
+          return '' unless args.size == length
+
+          super(message, *args)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/exception/cause.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    #
+    # Cause 原因
+    #
+    class Cause
+      # @return [String] エラーコード
+      attr_reader :code
+      # @return [String] メッセージ
+      attr_reader :message
+
+      #
+      # 初期化
+      #
+      # @param [String] code エラーコード
+      # @param [String] message メッセージ
+      #
+      def initialize(code:, message:)
+        @code = code
+        @message = message
+      end
+    end
+  end
+end

data/lib/zakuro/exception/exception.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../output/logger'
+
+require_relative './cause'
+
+require_relative './case/pattern'
+
+require_relative './zakuro_error'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    # @return [Output::Logger] ロガー
+    LOGGER = Output::Logger.new(location: 'exception')
+
+    # @return [String] 共通メッセージ
+    MESSAGE = 'an error has occurred'
+
+    #
+    # 例外を取得する
+    #
+    # @param [Array<Template>] presets 原因プリセット
+    #
+    # @return [ZakuroError] ライブラリエラー
+    #
+    def self.get(presets: [])
+      causes = []
+      presets.each do |preset|
+        causes.push(Cause.new(code: preset.code, message: preset.message))
+      end
+
+      ZakuroError.new(msg: MESSAGE, causes: causes)
+    end
+  end
+end

data/lib/zakuro/exception/zakuro_error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative './cause'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Exception
+    #
+    # ZakuroError ライブラリ内エラー
+    #
+    class ZakuroError < StandardError
+      # @return [Array<ErrorMessage>] エラーメッセージ
+      attr_reader :causes
+
+      #
+      # 初期化
+      #
+      # @param [String] msg メッセージ
+      # @param [Array<Cause>] causes 原因
+      #
+      def initialize(msg: '', causes: [])
+        super(msg)
+        @causes = causes
+      end
+    end
+  end
+end

data/lib/zakuro/gateway/locale/date.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative '../../era/japan/calendar'
+require_relative '../../era/western/calendar'
+
+require 'date'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gateway
+    # :nodoc:
+    class Locale
+      #
+      # Date 日付
+      #
+      class Date
+        INDALID = Object::Date.new
+
+        # @return [Western::Calendar] 西暦日
+        attr_reader :western_date
+        # @return [Japan::Calendar] 和暦日
+        attr_reader :japan_date
+
+        #
+        # 初期化
+        #
+        # @param [Date, String] date 日付
+        #
+        def initialize(date: INDALID)
+          @western_date = Western::Calendar.new
+          @japan_date = Japan::Calendar.new
+
+          parse(date: date)
+        end
+
+        #
+        # 和暦日が有効か
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def valid_japan?
+          !invalid_japan?
+        end
+
+        #
+        # 和暦日が不正か
+        #
+        # @return [True] 不正
+        # @return [False] 不正なし
+        #
+        def invalid_japan?
+          @japan_date.invalid?
+        end
+
+        #
+        # 西暦日が有効か
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def valid_western?
+          !invalid_western?
+        end
+
+        #
+        # 西暦日が不正か
+        #
+        # @return [True] 不正
+        # @return [False] 不正なし
+        #
+        def invalid_western?
+          @western_date.invalid?
+        end
+
+        #
+        # 不正か
+        #
+        # @return [True] 不正
+        # @return [False] 不正なし
+        #
+        def invalid?
+          invalid_japan? && invalid_western?
+        end
+
+        private
+
+        #
+        # 解析する
+        #
+        # @param [Date, String] date 日付
+        #
+        def parse(date:)
+          return unless date
+
+          return if date == INDALID
+
+          if date.is_a?(Object::Date)
+            @western_date = Western::Calendar.create(date: date)
+            return
+          end
+
+          return unless date.is_a?(String)
+
+          parse_text(text: date)
+        end
+
+        #
+        # 文字解析する
+        #
+        # @param [String] text 日付文字列
+        #
+        def parse_text(text:)
+          if Western::Calendar.valid_date_string(text: text)
+            @western_date = Western::Calendar.parse(text: text)
+            return
+          end
+
+          return unless Japan::Calendar.valid_date_string(text: text)
+
+          @japan_date = Japan::Calendar.parse(text: text)
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/gateway/locale/range.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative './date'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gateway
+    # :nodoc:
+    class Locale
+      #
+      # Range 範囲
+      #
+      class Range
+        # @return [LocaleDate] 開始日
+        attr_reader :start_date
+        # @return [LocaleDate] 終了日
+        attr_reader :last_date
+
+        #
+        # 初期化
+        #
+        # @param [Hash<Symbol, Object>] range 範囲
+        #
+        def initialize(range:)
+          @start_date = Date.new
+          @last_date = Date.new
+
+          return unless range
+
+          @start_date = Date.new(date: range[:start])
+          @last_date = Date.new(date: range[:last])
+        end
+
+        #
+        # 西暦日は有効か
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def valid_western?
+          @start_date.valid_western? && @last_date.valid_western?
+        end
+
+        #
+        # 和暦日は有効か
+        #
+        # @return [True] 有効
+        # @return [False] 無効
+        #
+        def valid_japan?
+          @start_date.valid_japan? && @last_date.valid_japan?
+        end
+
+        #
+        # 不正か
+        #
+        # @return [True] 不正
+        # @return [False] 不正なし
+        #
+        def invalid?
+          @start_date.invalid? && @last_date.invalid?
+        end
+      end
+    end
+  end
+end

data/lib/zakuro/gateway/range.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative '../calculation/summary/japan/range'
+require_relative '../calculation/summary/western/range'
+require_relative '../exception/case/preset'
+require_relative '../exception/exception'
+
+require_relative './locale/range'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gateway
+    #
+    # Range 範囲
+    #
+    class Range
+      # @return [Context] 暦コンテキスト
+      attr_reader :context
+      # @return [Locale::Range] 範囲
+      attr_reader :range
+
+      #
+      # 初期化
+      #
+      # @param [Context] context 暦コンテキスト
+      # @param [Hash<Symbol, Object>] range 範囲
+      #
+      def initialize(context:, range:)
+        @context = context
+        @range = Locale::Range.new(range: range)
+      end
+
+      #
+      # 不正か
+      #
+      # @return [True] 不正
+      # @return [False] 不正なし
+      #
+      def invalid?
+        @range.invalid?
+      end
+
+      #
+      # 検索結果を取得する
+      #
+      # @return [Result::Range] 範囲検索結果（和暦日）
+      #
+      def get
+        start_date = range.start_date
+        last_date = range.last_date
+
+        return western(start_date: start_date, last_date: last_date) if range.valid_western?
+
+        return japan(start_date: start_date, last_date: last_date) if range.valid_japan?
+
+        raise Exception.get(
+          presets: [
+            Exception::Case::Preset.new(
+              template: Exception::Case::Pattern::INVALID_RANGE
+            )
+          ]
+        )
+      end
+
+      private
+
+      #
+      # 西暦日による結果を取得する
+      #
+      # @param [Locale::Date] start_date 西暦開始日
+      # @param [Locale::Date] last_date 西暦終了日
+      #
+      # @return [Result::Range] 範囲検索結果（和暦日）
+      #
+      def western(start_date: Locale::Date.new, last_date: Locale::Date.new)
+        Calculation::Summary::Western::Range.get(
+          context: context, start_date: start_date.western_date,
+          last_date: last_date.western_date
+        )
+      end
+
+      #
+      # 和暦日による結果を取得する
+      #
+      # @param [Locale::Date] start_date 和暦開始日
+      # @param [Locale::Date] last_date 和暦終了日
+      #
+      # @return [Result::Range] 範囲検索結果（和暦日）
+      #
+      def japan(start_date: Locale::Date.new, last_date: Locale::Date.new)
+        Calculation::Summary::Japan::Range.get(
+          context: context, start_date: start_date.japan_date,
+          last_date: last_date.japan_date
+        )
+      end
+    end
+  end
+end

data/lib/zakuro/gateway/single.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../calculation/summary/japan/single'
+require_relative '../calculation/summary/western/single'
+require_relative '../exception/case/preset'
+require_relative '../exception/exception'
+
+require_relative './locale/date'
+
+# :nodoc:
+module Zakuro
+  # :nodoc:
+  module Gateway
+    #
+    # Single 1日
+    #
+    class Single
+      # @return [Locale::Date] 日付
+      attr_reader :date
+
+      #
+      # 初期化
+      #
+      # @param [Context] context 暦コンテキスト
+      # @param [Date, String] date 日付
+      #
+      def initialize(context:, date:)
+        @context = context
+        @date = Locale::Date.new(date: date)
+      end
+
+      #
+      # 不正か
+      #
+      # @return [True] 不正
+      # @return [False] 不正なし
+      #
+      def invalid?
+        @date.invalid?
+      end
+
+      #
+      # 検索結果を取得する
+      #
+      # @return [Result::Single] 一日検索結果（和暦日）
+      #
+      def get
+        if date.valid_western?
+          return Calculation::Summary::Western::Single.get(
+            context: @context, date: date.western_date
+          )
+        end
+
+        if date.valid_japan?
+          return Calculation::Summary::Japan::Single.get(
+            context: @context, date: date.japan_date
+          )
+        end
+
+        raise Exception.get(
+          presets: [
+            Exception::Case::Preset.new(
+              template: Exception::Case::Pattern::INVALID_DATE
+            )
+          ]
+        )
+      end
+    end
+  end
+end