decentworks-date-support 0.1.1 → 0.2.0

data/lib/decentworks/date_support/time_with_zone.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/time" # ::ActiveSupport::TimeWithZone の定義元
+
+require_relative "time_extension"
+
+module ActiveSupport
+  class TimeWithZone
+    include ::Decentworks::DateSupport::TimeExtension
+  end
+end

data/lib/decentworks/date_support/version.rb

@@ -2,6 +2,6 @@
 
 module Decentworks
   module DateSupport
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/decentworks/date_support.rb

@@ -2,5 +2,9 @@
 
 require_relative "date_support/version"
 require_relative "date_support/configuration"
+require_relative "date_support/date_extension"
 require_relative "date_support/date"
-require_relative "active_support/time_with_zone_support"
+require_relative "date_support/time_extension"
+require_relative "date_support/time"
+require_relative "date_support/date_time"
+require_relative "date_support/time_with_zone"

data/lib/generators/decentworks/date_support/install/templates/decentworks_date_support.rb.tt

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "decentworks/date_support"
-
 ::Decentworks::DateSupport.configure do |config|
   # 第1四半期（上期）の開始月を指定します。
   # 指定可能な値:
@@ -18,7 +16,7 @@ require "decentworks/date_support"
   #   :november  # => 11月
   #   :december  # => 12月
 
-  config.beginning_of_first_quarter = :january # 1月始まり
+  config.first_quarter_month_name = :january # 1月始まり
   # 第1四半期：1月〜3月
   # 第2四半期：4月〜6月
   # 第3四半期：7月〜9月
@@ -26,7 +24,7 @@ require "decentworks/date_support"
   # 上期：1月〜6月
   # 下期：7月〜12月
 
-  # config.beginning_of_first_quarter = :april # 4月始まり
+  # config.first_quarter_month_name = :april # 4月始まり
   # 第1四半期：4月〜6月
   # 第2四半期：7月〜9月
   # 第3四半期：10月〜12月
@@ -34,7 +32,7 @@ require "decentworks/date_support"
   # 上期：4月〜9月
   # 下期：10月〜翌3月
 
-  # config.beginning_of_first_quarter = :july # 7月始まり
+  # config.first_quarter_month_name = :july # 7月始まり
   # 第1四半期：7月〜9月
   # 第2四半期：10月〜12月
   # 第3四半期：翌1月〜翌3月
@@ -42,7 +40,7 @@ require "decentworks/date_support"
   # 上期：7月〜12月
   # 下期：翌1月〜翌6月
 
-  # config.beginning_of_first_quarter = :october # 10月始まり
+  # config.first_quarter_month_name = :october # 10月始まり
   # 第1四半期：10月〜12月
   # 第2四半期：翌1月〜翌3月
   # 第3四半期：翌4月〜翌6月

data/sig/decentworks/date_support/configuration.rbs

@@ -1,14 +1,23 @@
 module Decentworks
   module DateSupport
+    def self.configure: () ?{ (::Decentworks::DateSupport::Configuration) -> void } -> void
+    def self.configuration: -> ::Decentworks::DateSupport::Configuration
+
+    def self.reset_configuration!: -> nil
+
+    def self.first_quarter_month_name: -> Symbol
+    def self.first_quarter_month: -> Integer
+    def self.first_quarter_month_offset: -> Integer
+
     class Configuration
       MONTHS: Hash[Symbol, Integer]
       DEFAULT: Symbol
 
-      attr_reader beginning_of_first_quarter: Symbol
+      attr_reader first_quarter_month_name: Symbol
 
-      def beginning_of_first_quarter=: (Symbol) -> void
+      def first_quarter_month_name=: (Symbol) -> void
 
-      def beginning_of_first_quarter_month: -> Integer
+      def first_quarter_month: -> Integer
 
       def first_quarter_month_offset: -> Integer
     end

data/sig/decentworks/date_support/date.rbs

@@ -1,168 +1,4 @@
-module Decentworks
-  module DateSupport
-    VERSION: String
-
-    def self.configure: -> void
-    def self.configuration: -> ::Decentworks::DateSupport::Configuration
-
-    def self.reset_configuration!: -> nil
-
-    def beginning_of_this_week: -> ::Date
-    def end_of_this_week: -> ::Date
-    def all_this_week: -> ::Range[::Date]
-
-    def all_this_month: -> ::Range[::Date]
-
-    def two_months_ago: -> ::Date
-    def three_months_ago: -> ::Date
-    def four_months_ago: -> ::Date
-    def five_months_ago: -> ::Date
-    def six_months_ago: -> ::Date
-    def half_year_ago: -> ::Date
-    def seven_months_ago: -> ::Date
-    def eight_months_ago: -> ::Date
-    def nine_months_ago: -> ::Date
-    def ten_months_ago: -> ::Date
-    def eleven_months_ago: -> ::Date
-
-    def two_months_since: -> ::Date
-    def three_months_since: -> ::Date
-    def four_months_since: -> ::Date
-    def five_months_since: -> ::Date
-    def six_months_since: -> ::Date
-    def half_year_since: -> ::Date
-    def seven_months_since: -> ::Date
-    def eight_months_since: -> ::Date
-    def nine_months_since: -> ::Date
-    def ten_months_since: -> ::Date
-    def eleven_months_since: -> ::Date
-
-    def beginning_of_january: -> ::Date
-    def end_of_january: -> ::Date
-    def all_january: -> ::Range[::Date]
-    def beginning_of_january?: -> bool
-    def end_of_january?: -> bool
-    def in_january?: -> bool
-
-    def beginning_of_february: -> ::Date
-    def end_of_february: -> ::Date
-    def all_february: -> ::Range[::Date]
-    def beginning_of_february?: -> bool
-    def end_of_february?: -> bool
-    def in_february?: -> bool
-
-    def beginning_of_march: -> ::Date
-    def end_of_march: -> ::Date
-    def all_march: -> ::Range[::Date]
-    def beginning_of_march?: -> bool
-    def end_of_march?: -> bool
-    def in_march?: -> bool
-
-    def beginning_of_april: -> ::Date
-    def end_of_april: -> ::Date
-    def all_april: -> ::Range[::Date]
-    def beginning_of_april?: -> bool
-    def end_of_april?: -> bool
-    def in_april?: -> bool
-
-    def beginning_of_may: -> ::Date
-    def end_of_may: -> ::Date
-    def all_may: -> ::Range[::Date]
-    def beginning_of_may?: -> bool
-    def end_of_may?: -> bool
-    def in_may?: -> bool
-
-    def beginning_of_june: -> ::Date
-    def end_of_june: -> ::Date
-    def all_june: -> ::Range[::Date]
-    def beginning_of_june?: -> bool
-    def end_of_june?: -> bool
-    def in_june?: -> bool
-
-    def beginning_of_july: -> ::Date
-    def end_of_july: -> ::Date
-    def all_july: -> ::Range[::Date]
-    def beginning_of_july?: -> bool
-    def end_of_july?: -> bool
-    def in_july?: -> bool
-
-    def beginning_of_august: -> ::Date
-    def end_of_august: -> ::Date
-    def all_august: -> ::Range[::Date]
-    def beginning_of_august?: -> bool
-    def end_of_august?: -> bool
-    def in_august?: -> bool
-
-    def beginning_of_september: -> ::Date
-    def end_of_september: -> ::Date
-    def all_september: -> ::Range[::Date]
-    def beginning_of_september?: -> bool
-    def end_of_september?: -> bool
-    def in_september?: -> bool
-
-    def beginning_of_october: -> ::Date
-    def end_of_october: -> ::Date
-    def all_october: -> ::Range[::Date]
-    def beginning_of_october?: -> bool
-    def end_of_october?: -> bool
-    def in_october?: -> bool
-
-    def beginning_of_november: -> ::Date
-    def end_of_november: -> ::Date
-    def all_november: -> ::Range[::Date]
-    def beginning_of_november?: -> bool
-    def end_of_november?: -> bool
-    def in_november?: -> bool
-
-    def beginning_of_december: -> ::Date
-    def end_of_december: -> ::Date
-    def all_december: -> ::Range[::Date]
-    def beginning_of_december?: -> bool
-    def end_of_december?: -> bool
-    def in_december?: -> bool
-
-    def beginning_of_first_quarter: -> ::Date
-    def end_of_first_quarter: -> ::Date
-    def all_first_quarter: -> ::Range[::Date]
-    def beginning_of_first_quarter?: -> bool
-    def end_of_first_quarter?: -> bool
-    def in_first_quarter?: -> bool
-
-    def beginning_of_second_quarter: -> ::Date
-    def end_of_second_quarter: -> ::Date
-    def all_second_quarter: -> ::Range[::Date]
-    def beginning_of_second_quarter?: -> bool
-    def end_of_second_quarter?: -> bool
-    def in_second_quarter?: -> bool
-
-    def beginning_of_third_quarter: -> ::Date
-    def end_of_third_quarter: -> ::Date
-    def all_third_quarter: -> ::Range[::Date]
-    def beginning_of_third_quarter?: -> bool
-    def end_of_third_quarter?: -> bool
-    def in_third_quarter?: -> bool
-
-    def beginning_of_fourth_quarter: -> ::Date
-    def end_of_fourth_quarter: -> ::Date
-    def all_fourth_quarter: -> ::Range[::Date]
-    def beginning_of_fourth_quarter?: -> bool
-    def end_of_fourth_quarter?: -> bool
-    def in_fourth_quarter?: -> bool
-
-    def beginning_of_first_half: -> ::Date
-    def end_of_first_half: -> ::Date
-    def all_first_half: -> ::Range[::Date]
-    def beginning_of_first_half?: -> bool
-    def end_of_first_half?: -> bool
-    def in_first_half?: -> bool
-
-    def beginning_of_second_half: -> ::Date
-    def end_of_second_half: -> ::Date
-    def all_second_half: -> ::Range[::Date]
-    def beginning_of_second_half?: -> bool
-    def end_of_second_half?: -> bool
-    def in_second_half?: -> bool
-
-    def whole_months_elapsed: (?from: ::Date, ?to: ::Date) -> ::Integer
-  end
+class Date
+  include ::Decentworks::DateSupport::DateExtension
+  extend ::Decentworks::DateSupport::DateExtension::ClassMethods
 end

data/sig/decentworks/date_support/date_extension.rbs

@@ -0,0 +1,244 @@
+module Decentworks
+  module DateSupport
+    # ::Date が備えているActiveSupport（DateAndTime::Calculations）由来のメソッドと、
+    # モジュール内部でレシーバとして使うメソッド。
+    #
+    # DateExtension のself型として指定することで、モジュール内部での
+    # レシーバ省略呼び出しを型検査できるようにする。
+    #
+    # self型に ::Date を直接指定すると、::Date が DateExtension をincludeしているため
+    # RBS::RecursiveAncestor（循環）になる。そのためinterfaceを経由する。
+    interface _DateCalculations
+      def ==: (untyped other) -> bool
+      def month: () -> ::Integer
+      def beginning_of_week: (?untyped start_day) -> ::Date
+      def beginning_of_month: () -> ::Date
+      def end_of_month: () -> ::Date
+      def months_ago: (untyped months) -> ::Date
+      def months_since: (untyped months) -> ::Date
+      def change: (untyped options) -> ::Date
+    end
+
+    # ::Date の日付拡張
+    #
+    # 各メソッドは ::Date を返す。
+    module DateExtension : _DateCalculations
+      module ClassMethods
+        def whole_months_elapsed: (from: ::Date, to: ::Date) -> ::Integer
+
+        private
+
+        def expiration_date: (from: ::Date, months: ::Integer) -> ::Date
+      end
+
+      def self.included: (untyped base) -> untyped
+
+      def beginning_of_this_week: -> ::Date
+      def end_of_this_week: -> ::Date
+      def all_this_week: -> ::Range[::Date]
+
+      def beginning_of_this_month: -> ::Date
+      def end_of_this_month: -> ::Date
+      def all_this_month: -> ::Range[::Date]
+
+      def two_months_ago: -> ::Date
+      def three_months_ago: -> ::Date
+      def four_months_ago: -> ::Date
+      def five_months_ago: -> ::Date
+      def six_months_ago: -> ::Date
+      def half_year_ago: -> ::Date
+      def seven_months_ago: -> ::Date
+      def eight_months_ago: -> ::Date
+      def nine_months_ago: -> ::Date
+      def ten_months_ago: -> ::Date
+      def eleven_months_ago: -> ::Date
+
+      def two_months_since: -> ::Date
+      def three_months_since: -> ::Date
+      def four_months_since: -> ::Date
+      def five_months_since: -> ::Date
+      def six_months_since: -> ::Date
+      def half_year_since: -> ::Date
+      def seven_months_since: -> ::Date
+      def eight_months_since: -> ::Date
+      def nine_months_since: -> ::Date
+      def ten_months_since: -> ::Date
+      def eleven_months_since: -> ::Date
+
+      def beginning_of_january: -> ::Date
+      def end_of_january: -> ::Date
+      def all_january: -> ::Range[::Date]
+      def beginning_of_january?: -> bool
+      def end_of_january?: -> bool
+      def in_january?: -> bool
+
+      def beginning_of_february: -> ::Date
+      def end_of_february: -> ::Date
+      def all_february: -> ::Range[::Date]
+      def beginning_of_february?: -> bool
+      def end_of_february?: -> bool
+      def in_february?: -> bool
+
+      def beginning_of_march: -> ::Date
+      def end_of_march: -> ::Date
+      def all_march: -> ::Range[::Date]
+      def beginning_of_march?: -> bool
+      def end_of_march?: -> bool
+      def in_march?: -> bool
+
+      def beginning_of_april: -> ::Date
+      def end_of_april: -> ::Date
+      def all_april: -> ::Range[::Date]
+      def beginning_of_april?: -> bool
+      def end_of_april?: -> bool
+      def in_april?: -> bool
+
+      def beginning_of_may: -> ::Date
+      def end_of_may: -> ::Date
+      def all_may: -> ::Range[::Date]
+      def beginning_of_may?: -> bool
+      def end_of_may?: -> bool
+      def in_may?: -> bool
+
+      def beginning_of_june: -> ::Date
+      def end_of_june: -> ::Date
+      def all_june: -> ::Range[::Date]
+      def beginning_of_june?: -> bool
+      def end_of_june?: -> bool
+      def in_june?: -> bool
+
+      def beginning_of_july: -> ::Date
+      def end_of_july: -> ::Date
+      def all_july: -> ::Range[::Date]
+      def beginning_of_july?: -> bool
+      def end_of_july?: -> bool
+      def in_july?: -> bool
+
+      def beginning_of_august: -> ::Date
+      def end_of_august: -> ::Date
+      def all_august: -> ::Range[::Date]
+      def beginning_of_august?: -> bool
+      def end_of_august?: -> bool
+      def in_august?: -> bool
+
+      def beginning_of_september: -> ::Date
+      def end_of_september: -> ::Date
+      def all_september: -> ::Range[::Date]
+      def beginning_of_september?: -> bool
+      def end_of_september?: -> bool
+      def in_september?: -> bool
+
+      def beginning_of_october: -> ::Date
+      def end_of_october: -> ::Date
+      def all_october: -> ::Range[::Date]
+      def beginning_of_october?: -> bool
+      def end_of_october?: -> bool
+      def in_october?: -> bool
+
+      def beginning_of_november: -> ::Date
+      def end_of_november: -> ::Date
+      def all_november: -> ::Range[::Date]
+      def beginning_of_november?: -> bool
+      def end_of_november?: -> bool
+      def in_november?: -> bool
+
+      def beginning_of_december: -> ::Date
+      def end_of_december: -> ::Date
+      def all_december: -> ::Range[::Date]
+      def beginning_of_december?: -> bool
+      def end_of_december?: -> bool
+      def in_december?: -> bool
+
+      def beginning_of_first_quarter: -> ::Date
+      def end_of_first_quarter: -> ::Date
+      def all_first_quarter: -> ::Range[::Date]
+      def beginning_of_first_quarter?: -> bool
+      def end_of_first_quarter?: -> bool
+      def in_first_quarter?: -> bool
+
+      def beginning_of_second_quarter: -> ::Date
+      def end_of_second_quarter: -> ::Date
+      def all_second_quarter: -> ::Range[::Date]
+      def beginning_of_second_quarter?: -> bool
+      def end_of_second_quarter?: -> bool
+      def in_second_quarter?: -> bool
+
+      def beginning_of_third_quarter: -> ::Date
+      def end_of_third_quarter: -> ::Date
+      def all_third_quarter: -> ::Range[::Date]
+      def beginning_of_third_quarter?: -> bool
+      def end_of_third_quarter?: -> bool
+      def in_third_quarter?: -> bool
+
+      def beginning_of_fourth_quarter: -> ::Date
+      def end_of_fourth_quarter: -> ::Date
+      def all_fourth_quarter: -> ::Range[::Date]
+      def beginning_of_fourth_quarter?: -> bool
+      def end_of_fourth_quarter?: -> bool
+      def in_fourth_quarter?: -> bool
+
+      def beginning_of_first_half: -> ::Date
+      def end_of_first_half: -> ::Date
+      def all_first_half: -> ::Range[::Date]
+      def beginning_of_first_half?: -> bool
+      def end_of_first_half?: -> bool
+      def in_first_half?: -> bool
+
+      def beginning_of_second_half: -> ::Date
+      def end_of_second_half: -> ::Date
+      def all_second_half: -> ::Range[::Date]
+      def beginning_of_second_half?: -> bool
+      def end_of_second_half?: -> bool
+      def in_second_half?: -> bool
+
+      def this_quarter_number: -> ::Integer
+      def beginning_of_this_quarter: -> ::Date
+      def end_of_this_quarter: -> ::Date
+      def all_this_quarter: -> ::Range[::Date]
+
+      def this_half_number: -> ::Integer
+      def beginning_of_this_half: -> ::Date
+      def end_of_this_half: -> ::Date
+      def all_this_half: -> ::Range[::Date]
+
+      def fiscal_year: -> ::Integer
+      def beginning_of_fiscal_year: -> ::Date
+      def end_of_fiscal_year: -> ::Date
+      def all_fiscal_year: -> ::Range[::Date]
+
+      def beginning_of_next_quarter: -> ::Date
+      def end_of_next_quarter: -> ::Date
+      def all_next_quarter: -> ::Range[::Date]
+      def beginning_of_prev_quarter: -> ::Date
+      def end_of_prev_quarter: -> ::Date
+      def all_prev_quarter: -> ::Range[::Date]
+
+      def beginning_of_next_half: -> ::Date
+      def end_of_next_half: -> ::Date
+      def all_next_half: -> ::Range[::Date]
+      def beginning_of_prev_half: -> ::Date
+      def end_of_prev_half: -> ::Date
+      def all_prev_half: -> ::Range[::Date]
+
+      def next_fiscal_year: -> ::Integer
+      def beginning_of_next_fiscal_year: -> ::Date
+      def end_of_next_fiscal_year: -> ::Date
+      def all_next_fiscal_year: -> ::Range[::Date]
+      def prev_fiscal_year: -> ::Integer
+      def beginning_of_prev_fiscal_year: -> ::Date
+      def end_of_prev_fiscal_year: -> ::Date
+      def all_prev_fiscal_year: -> ::Range[::Date]
+
+      # ActiveSupportのメソッドの上書き
+      def quarter: -> ::Integer
+      def beginning_of_quarter: -> ::Date
+      def at_beginning_of_quarter: -> ::Date
+      def end_of_quarter: -> ::Date
+      def at_end_of_quarter: -> ::Date
+      def all_quarter: -> ::Range[::Date]
+      def next_quarter: -> ::Date
+      def prev_quarter: -> ::Date
+      def last_quarter: -> ::Date
+    end
+  end
+end

data/sig/decentworks/date_support/date_time.rbs

@@ -0,0 +1,4 @@
+class DateTime
+  include ::Decentworks::DateSupport::TimeExtension[::DateTime]
+  extend ::Decentworks::DateSupport::TimeExtension::ClassMethods
+end

data/sig/decentworks/date_support/time.rbs

@@ -0,0 +1,4 @@
+class Time
+  include ::Decentworks::DateSupport::TimeExtension[::Time]
+  extend ::Decentworks::DateSupport::TimeExtension::ClassMethods
+end