fiscal_year 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f35e4820f8a076879f9e461f172479e79899b71b71e4933fb8598b8c91b0dd7
-  data.tar.gz: 7616d720fff1de8d186b6809dfc2c465be1dfee8637808f3d8c490c15b253327
+  metadata.gz: a66a9750908c6de12be50a3ddac4da7070d3e7b43898151ada109d586e26d983
+  data.tar.gz: 407e156b9e5e8f154c68059a652b62cb0016c8aa901b69686c6d8046aa599a6b
 SHA512:
-  metadata.gz: 69d7ffc53eb33c6a65fabd20bd0b8757f40b71d11ce63a6a5754bb3af5312ad0641642a1701fc88820a7fd2764dfe29a140c045d0d524e4557d30304458c5ad5
-  data.tar.gz: d8c1ada946d9fd2e0ca21818e6885903fa99203a847c016759019828ca602ebf15cb03b8d94653c1801ff9a5c0ed942fa4c2afa224675563a875ad24fcf16e97
+  metadata.gz: 89fe574b9f0e5cd38a7b2add1caf81d1fdfec9fcf4a321da81aa11ffba72e25df925a343ba20703b66cece55407e40da6b30b101baa9e4e9e543836d71db6ab1
+  data.tar.gz: 4a67105553886931e1868e47b724b5dc983f507961625a7fb498d45697342ba1fe91aa951320faabf6e1c10c8a0bc47dd856b89675b0f06804077553b1f4f4e8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.0.0] - 2024-07-24
+celebrate 1.0.0 release!! 🎉
+No Breaking Changes, Some futures.
+
+- add `passed_month_count_by` and `passed_month_count_by_month` to each FiscalYear, Half, Quarter.
+- fix wrong example comment on `FiscalYear::YearToDate.quarter_range_by`.
+- robust `Config.start_month`. you can no longer pass invalid month. now only pass number 1-12, or short symbol like `:jan`, `:dec`.
+
+Thank you for gave me courage to release, ruby-jp!
+
 ## [0.7.0] - 2024-07-11
 - add YARD comment.
 - fix `FiscalYear::YearToDate.quarter_range_by` logic.

data/lib/fiscal_year/config.rb

@@ -1,11 +1,52 @@
 # frozen_string_literal: true
 
+require "fiscal_year/invalid_start_month_error"
+
 module FiscalYear
   class Config
-    attr_accessor :start_month
+    attr_reader :start_month
+
+    VALID_START_MONTHS = {
+      jan: 1,
+      feb: 2,
+      mar: 3,
+      apr: 4,
+      may: 5,
+      jun: 6,
+      jul: 7,
+      aug: 8,
+      sep: 9,
+      oct: 10,
+      nov: 11,
+      dec: 12
+    }.freeze
 
     def initialize
       @start_month = 4
     end
+
+    def start_month=(month)
+      valid_start_month?(month)
+
+      @start_month = fetch_start_month(month)
+    end
+
+    private
+
+    def valid_start_month?(month)
+      if month.is_a? Integer
+        VALID_START_MONTHS.values.include?(month)
+      else
+        VALID_START_MONTHS.keys.include?(month)
+      end || raise(InvalidStartMonthError)
+    end
+
+    def fetch_start_month(month)
+      if month.is_a? Integer
+        VALID_START_MONTHS.rassoc(month)&.last
+      else
+        VALID_START_MONTHS.assoc(month)&.last
+      end || raise(StandardError)
+    end
   end
 end

data/lib/fiscal_year/half.rb

@@ -5,18 +5,12 @@ module FiscalYear
     class << self
       # @return [Array<Integer>] the first half of the fiscal year.
       def first
-        first = FiscalYear.halfs.first
-        return first if first.is_a? Array
-
-        []
+        FiscalYear.halfs.first || raise(StandardError)
       end
 
       # @return [Array<Integer>] the second half of the fiscal year.
       def second
-        second = FiscalYear.halfs.second
-        return second if second.is_a? Array
-
-        []
+        FiscalYear.halfs.second || raise(StandardError)
       end
 
       # @param month [Integer] the month
@@ -31,14 +25,19 @@ module FiscalYear
         !first?(month)
       end
 
+      # @param month [Integer] the month
+      # @return [Array<Integer>] the half months by the month.
+      def months(month)
+        first?(month) ? first : second
+      end
+
       # @param year [Integer] the calendar year
       # @return [Range<Date>] the range of the first half of the fiscal year.
       def first_range_by(year)
         # care Date#parse 2 digit year auto complete.
         # 99 + 1 = 100, but expect 2000 this context.
         year = 1999 if year == 99
-        end_month = first.last
-        raise StandardError if end_month.nil?
+        end_month = first.last || raise(StandardError)
 
         end_year = FiscalYear.increase_year_by_month(year, end_month)
 
@@ -51,9 +50,8 @@ module FiscalYear
         # care Date#parse 2 digit year auto complete.
         # 99 + 1 = 100, but expect 2000 this context.
         year = 1999 if year == 99
-        first_month = second.first
-        end_month = second.last
-        raise StandardError if first_month.nil? || end_month.nil?
+        first_month = second.first || raise(StandardError)
+        end_month = second.last || raise(StandardError)
 
         start_year = FiscalYear.increase_year_by_month(year, first_month)
         end_year = FiscalYear.increase_year_by_month(year, end_month)
@@ -77,6 +75,24 @@ module FiscalYear
       def cross_year_in_half?(half)
         FiscalYear.cross_year? && half.any? { |month| month == 12 }
       end
+
+      # start by 0.
+      #
+      # @see passed_month_count_by_month
+      # @param date [Date] the date
+      # @return [Integer] the passed month count from the beginning of the half.
+      def passed_month_count_by(date)
+        passed_month_count_by_month(date.month)
+      end
+
+      # start by 0.
+      #
+      # @see passed_month_count_by_month
+      # @param date [Date] the date
+      # @return [Integer] the passed month count from the beginning of the half.
+      def passed_month_count_by_month(month)
+        months(month).find_index(month) || raise(StandardError)
+      end
     end
   end
 end

data/lib/fiscal_year/invalid_start_month_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module FiscalYear
+  class InvalidStartMonthError < StandardError
+    def message
+      "Invalid start month. please set 1-12 or :jan, :feb, :mar, :apr, :may, :jun, :jul, :aug, :sep, :oct, :nov, :dec."
+    end
+  end
+end

data/lib/fiscal_year/quarter.rb

@@ -45,12 +45,9 @@ module FiscalYear
       end
 
       # @param month [Integer] the month
-      # @return [Array<Integer>] the quarter month by the month.
+      # @return [Array<Integer>] the quarter months by the month.
       def months(month)
-        months = FiscalYear.quarters.find { |a| a.include?(month) }
-        raise ::StandardError if months.nil?
-
-        months
+        FiscalYear.quarters.find { |a| a.include?(month) } || raise(StandardError)
       end
 
       # @param date [Date] the date
@@ -76,6 +73,22 @@ module FiscalYear
       def cross_year_in_quarter?(quarter)
         FiscalYear.cross_year? && quarter.any? { |month| month == 12 }
       end
+
+      # start by 0.
+      #
+      # @param date [Date] the date
+      # @return [Integer] the passed quarter count by the date.
+      def passed_month_count_by(date)
+        passed_month_count_by_month(date.month)
+      end
+
+      # start by 0.
+      #
+      # @param month [Integer] the month
+      # @return [Integer] the passed quarter count by the month.
+      def passed_month_count_by_month(month)
+        months(month).find_index(month) || raise(StandardError)
+      end
     end
   end
 end

data/lib/fiscal_year/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FiscalYear
-  VERSION = "0.7.0"
+  VERSION = "1.0.0"
 end

data/lib/fiscal_year/year_to_date.rb

@@ -75,7 +75,7 @@ module FiscalYear
       #  => Thu, 01 Jul 2021..Tue, 31 Aug 2021
       #
       #  FiscalYear::YearToDate.quarter_range_by(Date.parse("2021-01-01"))
-      #  =>  Wed, 01 Jan 2020..Sun, 31 Jan 2021
+      #  =>  Fri, 01 Jan 2021..Sun, 31 Jan 2021
       def quarter_range_by(date)
         year = date.year
         month = date.month

data/lib/fiscal_year.rb

@@ -53,10 +53,7 @@ module FiscalYear
 
       rindex = months.rindex(1).to_i
 
-      m = months.slice(rindex, months.length)
-      raise StandardError if m.nil?
-
-      m
+      months.slice(rindex, months.length) || raise(StandardError)
     end
 
     # @return [Array(Array<Integer>, Array<Integer>)] the first half and the second half of the fiscal year.
@@ -110,5 +107,22 @@ module FiscalYear
 
       FiscalYear::Half.first_range_by(normalized_year).first..FiscalYear::Half.second_range_by(normalized_year).last
     end
+
+    # start by 0.
+    #
+    # @see passed_month_count_by_month
+    # @param date [Date] the date
+    # @return [Integer] the passed month count from the beginning of the fiscal year.
+    def passed_month_count_by(date)
+      passed_month_count_by_month(date.month)
+    end
+
+    # start by 0.
+    #
+    # @param month [Integer] the month
+    # @return [Integer] the passed month count from the beginning of the fiscal year.
+    def passed_month_count_by_month(month)
+      months.find_index(month) || raise(StandardError)
+    end
   end
 end

data/sig/fiscal_year/config.rbs

@@ -1,6 +1,10 @@
 module FiscalYear
   class Config
     attr_reader start_month: Integer
+    VALID_START_MONTHS: Hash[Symbol, Integer]
     def initialize: -> Integer
+    def start_month=: (Integer|Symbol) -> bool
+    def valid_start_month?: (Integer|Symbol) -> bool
+    def fetch_start_month: (Integer|Symbol) -> Integer
   end
 end

data/sig/fiscal_year/half.rbs

@@ -4,9 +4,12 @@ module FiscalYear
     def self.second: () -> Array[Integer] | -> Array[untyped]
     def self.first?: (Integer) -> bool
     def self.second?: (Integer) -> bool
+    def self.months: (Integer) -> Array[Integer]
     def self.first_range_by: (Integer) -> Range[Date]
     def self.second_range_by: (Integer) -> Range[Date]
     def self.range_by: (Date) -> Range[Date]
     def self.cross_year_in_half?: (Array[Integer]) -> bool
+    def self.passed_month_count_by: (Date) -> Integer
+    def self.passed_month_count_by_month: (Integer) -> Integer
   end
 end

data/sig/fiscal_year/invalid_start_month_error.rbs

@@ -0,0 +1,5 @@
+module FiscalYear
+  class InvalidStartMonthError < StandardError
+    def message: -> String
+  end
+end

data/sig/fiscal_year/quarter.rbs

@@ -12,5 +12,7 @@ module FiscalYear
     def self.range_by: (Date) -> Range[Date]
     def self.quarter_num: (Integer) -> Integer
     def self. cross_year_in_quarter?: (Array[Integer]) -> bool
+    def self.passed_month_count_by: (Date) -> Integer
+    def self.passed_month_count_by_month: (Integer) -> Integer
   end
-end
+end

data/sig/fiscal_year.rbs

@@ -12,5 +12,7 @@ module FiscalYear
   def self.quarters: () -> [Array[Integer], Array[Integer], Array[Integer], Array[Integer]]
   def self.increase_year_by_month: (Integer, Integer) -> Integer
   def self.decrease_year_by_month: (Integer, Integer) -> Integer
-  def self.range_by: (Date) -> Range
+  def self.range_by: (Date) -> Range[Date]
+  def self.passed_month_count_by: (Date) -> Integer
+  def self.passed_month_count_by_month: (Integer) -> Integer
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiscal_year
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tsubasa Kawajiri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,7 @@ files:
 - lib/fiscal_year.rb
 - lib/fiscal_year/config.rb
 - lib/fiscal_year/half.rb
+- lib/fiscal_year/invalid_start_month_error.rb
 - lib/fiscal_year/quarter.rb
 - lib/fiscal_year/version.rb
 - lib/fiscal_year/year_to_date.rb
@@ -51,6 +52,7 @@ files:
 - sig/fiscal_year.rbs
 - sig/fiscal_year/config.rbs
 - sig/fiscal_year/half.rbs
+- sig/fiscal_year/invalid_start_month_error.rbs
 - sig/fiscal_year/quarter.rbs
 - sig/fiscal_year/year_to_date.rbs
 homepage: https://github.com/TsubasaKawajiri/fiscal_year