fiscal_year 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd01c4ef4840fe76c0c0b183751fb430c3eea13947fdb306ef60ef51f07971d
-  data.tar.gz: a1073241fe4d94bec00779aef5ab57a57f23e6439f2d32e7a61a645a3f8d1bdf
+  metadata.gz: 284c5184ce2fd9503b81a6de26e657eacba6b917d8544e88ee37b771f9316b82
+  data.tar.gz: 072003b1e2b38f9c8e9e6ec6ce3fe549acd9fc06b9b403065e1605bf73bc0ba2
 SHA512:
-  metadata.gz: d8efaaecee78bcbdd07200d5d26bc77f9946df6eb2d06804e0ff2765f88928ec439daba62a97487de9679565e86020d3f9225e440629944f9815a01aeec70454
-  data.tar.gz: 0d0727ca3cef12d4e2a9a3d1d692e75a3172813eb2bde55b39635d8b52be7afc88b3cda2bd2e16e61bafc56a506efd45228a8ae15f8d9be35092fb9263da1c17
+  metadata.gz: bae3fd2e63eb14fc7954e40e7e98e4861902b47b1f47a6f8038351373f899767aae0a70133a0d6fae274edefa9872596fa11ce23a81001e055b9b200ddb9245d
+  data.tar.gz: c3903b8302eb1f86ff53bc7ef74a2f43822e9a83eb2399491da321ab7c5af9a334bf0abd8fcb39db7fc828d451815d204d6baa6d43515768bcf1b8f222e48645

data/.rubocop.yml

@@ -11,3 +11,10 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## [Unreleased]
+## [0.2.0] - 2023-03-16
+- add test
+- fit to rubocop
+
+- fix some methods
 
 ## [0.1.0] - 2023-03-14
 

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at noodles@aznyn.jp. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tk.music.jpn@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/README.md

@@ -1,9 +1,22 @@
+![build badge](https://github.com/TsubasaKawajiri/fiscal_year/actions/workflows/main.yml/badge.svg?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/39fdb48501c5f53235a9/maintainability)](https://codeclimate.com/github/TsubasaKawajiri/fiscal_year/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/39fdb48501c5f53235a9/test_coverage)](https://codeclimate.com/github/TsubasaKawajiri/fiscal_year/test_coverage)
+
 # FiscalYear
 
+Calculate fiscal year half, quarter, and year to date.
 
 ## Installation
 
-TODO
+```
+gem 'fiscal_year'
+```
+
+then,
+
+```
+bundle install
+```
 
 ## Usage
 
@@ -12,6 +25,20 @@ require 'fiscal_year'
 
 FiscalYear.quarters
 => [[4, 5, 6], [7, 8, 9], [10, 11, 12], [1, 2, 3]]
+
+date = Date.parse('2023/08/01')
+
+# get current Half range
+FiscalYear::Half.range_by(date)
+=> Sat, 01 Apr 2023..Sat, 30 Sep 2023
+
+# get current quarter range
+FiscalYear::Quarter.range_by(date)
+=> Sat, 01 Jul 2023..Sat, 30 Sep 2023
+
+# get year to date
+FiscalYear::YearToDate.range_by(date)
+=> Sat, 01 Apr 2023..Thu, 31 Aug 2023
 ```
 
 configure start month
@@ -31,7 +58,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fiscal_year. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fiscal_year/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/TsubasaKawajiri/fiscal_year. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/TsubasaKawajiri/fiscal_year/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -39,4 +66,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the FiscalYear project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fiscal_year/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the FiscalYear project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/TsubasaKawajiri/fiscal_year/blob/master/CODE_OF_CONDUCT.md).

data/lib/fiscal_year/config.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module FiscalYear
   class Config
     attr_accessor :start_month
 
     def initialize
-      @start_month = 8
+      @start_month = 4
     end
   end
 end

data/lib/fiscal_year/half.rb

@@ -3,7 +3,6 @@
 module FiscalYear
   class Half
     class << self
-
       def first
         FiscalYear.halfs.first
       end
@@ -21,22 +20,44 @@ module FiscalYear
       end
 
       def first_range_by(year)
-        Date.parse("#{year}/#{first.first}")..Date.parse("#{year}/#{first.last}").end_of_month
+        # care Date#parse 2 digit year auto complete.
+        # 99 + 1 = 100, but expect 2000 this context.
+        year = 1999 if year == 99
+        end_year = normalize_year_by_month(year, first.last)
+
+        Date.parse("#{year}/#{first.first}/01")..Date.parse("#{end_year}/#{first.last}/01").end_of_month
       end
 
       def second_range_by(year)
-        Date.parse("#{year}/#{second.first}")..Date.parse("#{year + 1}/#{second.last}").end_of_month
+        # care Date#parse 2 digit year auto complete.
+        # 99 + 1 = 100, but expect 2000 this context.
+        year = 1999 if year == 99
+        start_year = normalize_year_by_month(year, second.first)
+        end_year = normalize_year_by_month(year, second.last)
+
+        Date.parse("#{start_year}/#{second.first}/01")..Date.parse("#{end_year}/#{second.last}/01").end_of_month
       end
 
       def range_by(date)
         month = date.month
         year = date.year
+        # if passed crossed year value, normalize to not crossed year value
+        year -= 1 if FiscalYear.cross_year_month?(month)
+
+        first?(month) ? first_range_by(year) : second_range_by(year)
+      end
+
+      def normalize_year_by_month(year, month)
         if FiscalYear.cross_year_month?(month)
-          Date.parse("#{year - 1}/#{second.first}")..Date.parse("#{year}/#{second.last}").end_of_month
+          year + 1
         else
-          first?(month) ? first_range_by(date.year) : second_range_by(date.year)
+          year
         end
       end
+
+      def cross_year_in_half?(half)
+        FiscalYear.cross_year? && half.any? { |month| month == 12 }
+      end
     end
   end
 end

data/lib/fiscal_year/quarter.rb

@@ -31,14 +31,19 @@ module FiscalYear
 
       def range_by(date)
         year = date.year
-        this_quater_months = months(date.month)
+        this_quater = months(date.month)
+        last_year = cross_year_in_quarter?(this_quater) ? year + 1 : year
 
-        Date.parse("#{year}/#{this_quater_months.first}")..Date.parse("#{year}/#{this_quater_months.last}").end_of_month
+        Date.parse("#{year}/#{this_quater.first}/01")..Date.parse("#{last_year}/#{this_quater.last}/01").end_of_month
       end
 
       def quater_num(month)
         (FiscalYear.quarters.rindex(months(month)) + 1)
       end
+
+      def cross_year_in_quarter?(quarter)
+        FiscalYear.cross_year? && quarter.any? { |month| month == 12 }
+      end
     end
   end
 end

data/lib/fiscal_year/version.rb

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

data/lib/fiscal_year/year_to_date.rb

@@ -8,9 +8,9 @@ module FiscalYear
         month = date.month
 
         if FiscalYear.cross_year_month?(month)
-          Date.parse("#{year - 1}/#{FiscalYear.config.start_month}")..date.end_of_month.to_date
+          Date.parse("#{year - 1}/#{FiscalYear.config.start_month}/01")..date.end_of_month.to_date
         else
-          Date.parse("#{year}/#{FiscalYear.config.start_month}")..date.end_of_month.to_date
+          Date.parse("#{year}/#{FiscalYear.config.start_month}/01")..date.end_of_month.to_date
         end
       end
 
@@ -29,24 +29,36 @@ module FiscalYear
         pair
       end
 
-      def half_range_by(date)
+      # TODO: fit to Abc size
+      def half_range_by(date) # rubocop:disable Metrics/AbcSize
         year = date.year
         month = date.month
 
-        return Date.parse("#{year}/#{Half.first.first}")..date.end_of_month.to_date if Half.first?(month)
+        if Half.first?(month)
+          return (Date.parse("#{FiscalYear.cross_year_month?(month) ? year - 1 : year}/#{Half.first.first}/01")..
+            date.end_of_month.to_date
+                 )
+        end
 
-        Date.parse("#{FiscalYear.cross_year_month?(month) ? year - 1 : year}/#{Half.second.first}")..date.end_of_month.to_date
+        Date.parse(
+          "#{FiscalYear::Half.cross_year_in_half?(Half.second) ? year - 1 : year}/#{Half.second.first}"
+        )..date.end_of_month.to_date
       end
 
       def quarter_range_by(date)
         year = date.year
         month = date.month
 
-        %i[first? second? third? fourth?].each do |method_name|
-          if FiscalYear::Quarter.public_send(method_name, month)
-            Date.parse("#{year}/#{Quarter.public_send(method_name).first}")..date.end_of_month.to_date
-          end
-        end
+        quarter_method = %i[first? second? third? fourth?]
+                         .filter { |method_name| FiscalYear::Quarter.public_send(method_name, month) }
+                         .first.to_s.gsub("?", "").to_sym
+
+        quarter = Quarter.public_send(quarter_method)
+
+        (
+          Date.parse("#{FiscalYear.cross_year_month?(month) ? year - 1 : year}/#{quarter.first}/01")..
+          date.end_of_month.to_date
+        )
       end
     end
   end

data/lib/fiscal_year.rb

@@ -2,38 +2,39 @@
 
 require_relative "fiscal_year/version"
 
-require 'fiscal_year/half'
-require 'fiscal_year/quarter'
-require 'fiscal_year/year_to_date'
-require 'fiscal_year/config'
+require "fiscal_year/half"
+require "fiscal_year/quarter"
+require "fiscal_year/year_to_date"
+require "fiscal_year/config"
 
-require 'active_support'
-require 'active_support/core_ext'
+require "active_support"
+require "active_support/core_ext"
 
 module FiscalYear
-  @@config ||= FiscalYear::Config.new
+  @config ||= FiscalYear::Config.new
+
   class << self
-    def config
-      @@config
-    end
-  
-    def configure(&block)
-      yield(@@config) if block_given?
+    attr_reader :config
+
+    def configure
+      yield(@config) if block_given?
     end
 
     def cross_year_month?(month)
       cross_year_months.include?(month)
     end
-  
+
     def cross_year?
       months.rindex(1) != 0
     end
 
     def months
-      (1..12).to_a.tap { |arr| arr.concat(arr.shift(@@config.start_month - 1)) }
+      (1..12).to_a.tap { |arr| arr.concat(arr.shift(@config.start_month - 1)) }
     end
 
     def cross_year_months
+      return [] if @config.start_month == 1
+
       months.slice(months.rindex(1), months.length)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiscal_year
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tsubasa Kawajiri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport