fiscal_year 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284c5184ce2fd9503b81a6de26e657eacba6b917d8544e88ee37b771f9316b82
-  data.tar.gz: 072003b1e2b38f9c8e9e6ec6ce3fe549acd9fc06b9b403065e1605bf73bc0ba2
+  metadata.gz: 6cf15774708a32e8499e3228288a15749adf62d98a7dc72ccc31e9cfc0b5b842
+  data.tar.gz: 44dc1c5dc58d257bee352257abae21f5e02412d39d5aef76910ef34036a596bb
 SHA512:
-  metadata.gz: bae3fd2e63eb14fc7954e40e7e98e4861902b47b1f47a6f8038351373f899767aae0a70133a0d6fae274edefa9872596fa11ce23a81001e055b9b200ddb9245d
-  data.tar.gz: c3903b8302eb1f86ff53bc7ef74a2f43822e9a83eb2399491da321ab7c5af9a334bf0abd8fcb39db7fc828d451815d204d6baa6d43515768bcf1b8f222e48645
+  metadata.gz: 8e38a3d7c476be3d0e2889f608e73b52f04234553f2119fa665dc19143fb0fafadd6ef832dc4c42527096e7a402136992a4e2a4e5222109364522c32fca1de1a
+  data.tar.gz: 591f594009aa1cfb7595a3c18720c8d7f88974a7510252f870f981d5518ef296ebdd2fb8b5eb8397bc040c263fc33d4ae0acd09cc76993c4f52731eac15dce36

data/.rubocop.yml

@@ -1,5 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.6
+  Exclude:
+    - 'Steepfile'
+    - 'vendor/**/*'
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.3.0] - 2023-04-23
+- add rbs
+  - fit to rbs
+
+- improve workflow
+  - add dependabot
+  - add test coverage
+
 ## [0.2.0] - 2023-03-16
 - add test
 - fit to rubocop

data/Gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in fiscal_year.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+group :development do
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+  gem "simplecov"
+end

data/README.md

@@ -1,10 +1,14 @@
-![build badge](https://github.com/TsubasaKawajiri/fiscal_year/actions/workflows/main.yml/badge.svg?branch=master)
+![build badge](https://github.com/TsubasaKawajiri/fiscal_year/actions/workflows/test.yml/badge.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/fiscal_year.svg)](https://badge.fury.io/rb/fiscal_year)
 [![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.
+FiscalYear is calculates half-year, quarter-year, and YTD figures.
+It can take in a year's numerical value or a year and month and return the results as a Range.
+
+Additionally, it allows for the customization of the starting month of the fiscal period.
 
 ## Installation
 
@@ -54,7 +58,7 @@ configure start month
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/Steepfile

@@ -0,0 +1,6 @@
+target :lib do
+  signature "sig"
+  check "lib"
+
+  library "date", "activesupport"
+end

data/lib/fiscal_year/half.rb

@@ -4,11 +4,17 @@ module FiscalYear
   class Half
     class << self
       def first
-        FiscalYear.halfs.first
+        first = FiscalYear.halfs.first
+        return first if first.is_a? Array
+
+        []
       end
 
       def second
-        FiscalYear.halfs.second
+        second = FiscalYear.halfs.second
+        return second if second.is_a? Array
+
+        []
       end
 
       def first?(month)
@@ -23,19 +29,26 @@ module FiscalYear
         # 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)
+        end_month = first.last
+        raise StandardError if end_month.nil?
 
-        Date.parse("#{year}/#{first.first}/01")..Date.parse("#{end_year}/#{first.last}/01").end_of_month
+        end_year = normalize_year_by_month(year, end_month)
+
+        Date.parse("#{year}/#{first.first}/01")..Date.parse("#{end_year}/#{end_month}/01").end_of_month
       end
 
       def second_range_by(year)
         # 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)
+        first_month = second.first
+        end_month = second.last
+        raise StandardError if first_month.nil? || end_month.nil?
+
+        start_year = normalize_year_by_month(year, first_month)
+        end_year = normalize_year_by_month(year, end_month)
 
-        Date.parse("#{start_year}/#{second.first}/01")..Date.parse("#{end_year}/#{second.last}/01").end_of_month
+        Date.parse("#{start_year}/#{first_month}/01")..Date.parse("#{end_year}/#{end_month}/01").end_of_month
       end
 
       def range_by(date)

data/lib/fiscal_year/quarter.rb

@@ -26,7 +26,10 @@ module FiscalYear
       end
 
       def months(month)
-        FiscalYear.quarters.find { |a| a.include?(month) }
+        months = FiscalYear.quarters.find { |a| a.include?(month) }
+        raise ::StandardError if months.nil?
+
+        months
       end
 
       def range_by(date)
@@ -38,7 +41,9 @@ module FiscalYear
       end
 
       def quater_num(month)
-        (FiscalYear.quarters.rindex(months(month)) + 1)
+        rindex = FiscalYear.quarters.rindex(months(month))
+
+        rindex.nil? ? 0 : (rindex + 1)
       end
 
       def cross_year_in_quarter?(quarter)

data/lib/fiscal_year/version.rb

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

data/lib/fiscal_year/year_to_date.rb

@@ -14,11 +14,15 @@ module FiscalYear
         end
       end
 
-      def year_month_pairs(date)
+      # TODO: fit to Abc size
+      def year_month_pairs(date) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         month = date.month
+        month_index = FiscalYear.months.index(month)
+        months = FiscalYear.months[(0..month_index)]
+        raise StandardError if months.nil?
 
         pair = []
-        [date.year].product(FiscalYear.months.slice(0..FiscalYear.months.index(month))) do |e|
+        [date.year].product(months).each do |e|
           pair << if FiscalYear.cross_year_month?(month)
                     (FiscalYear.cross_year_month?(e.second) ? e : [e.first - 1, e.second])
                   else

data/lib/fiscal_year.rb

@@ -11,8 +11,8 @@ require "active_support"
 require "active_support/core_ext"
 
 module FiscalYear
+  # @type ivar @config: FiscalYear::Config
   @config ||= FiscalYear::Config.new
-
   class << self
     attr_reader :config
 
@@ -35,14 +35,21 @@ module FiscalYear
     def cross_year_months
       return [] if @config.start_month == 1
 
-      months.slice(months.rindex(1), months.length)
+      rindex = months.rindex(1).to_i
+
+      m = months.slice(rindex, months.length)
+      raise StandardError if m.nil?
+
+      m
     end
 
     def halfs
+      # @type self: singleton(FiscalYear)
       months.in_groups(2)
     end
 
     def quarters
+      # @type self: singleton(FiscalYear)
       months.in_groups(4)
     end
   end

data/rbs_collection.lock.yaml

@@ -0,0 +1,89 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 641dae8a456dc964cf7e447b7d994c709c7e5f96
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,15 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true

data/sig/fiscal_year/config.rbs

@@ -0,0 +1,5 @@
+module FiscalYear
+  class Config
+    attr_reader start_month: Integer
+  end
+end

data/sig/fiscal_year/half.rbs

@@ -0,0 +1,13 @@
+module FiscalYear
+  class Half
+    def self.first: () -> Array[Integer] | -> Array[untyped]
+    def self.second: () -> Array[Integer] | -> Array[untyped]
+    def self.first?: (Integer) -> bool
+    def self.second?: (Integer) -> bool
+    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.normalize_year_by_month: (Integer, Integer) -> Integer
+    def self.cross_year_in_half?: (Array[Integer]) -> bool
+  end
+end

data/sig/fiscal_year/quarter.rbs

@@ -0,0 +1,16 @@
+module FiscalYear
+  class Quarter
+    def self.first: () -> Array[Integer]
+    def self.second: () -> Array[Integer]
+    def self.third: () -> Array[Integer]
+    def self.fourth: () -> Array[Integer]
+    def self.first?: (Integer) -> bool
+    def self.second?: (Integer) -> bool
+    def self.third?: (Integer) -> bool
+    def self.fourth?: (Integer) -> bool
+    def self.months: (Integer) -> Array[Integer]
+    def self.range_by: (Date) -> Range[Date]
+    def self.quarter_num: (Integer) -> Integer
+    def self. cross_year_in_quarter?: (Array[Integer]) -> bool
+  end
+end

data/sig/fiscal_year/year_to_date.rbs

@@ -0,0 +1,8 @@
+module FiscalYear
+  class YearToDate
+    def self.range_by: (Date) -> Range[Date]
+    def self.year_month_pairs: (Date) -> Array[[Integer, Integer]]
+    def self.half_range_by: (Date) -> Range[Date]
+    def self.quarter_range_by: (Date) -> Range[Date]
+  end
+end

data/sig/fiscal_year.rbs

@@ -1,4 +1,13 @@
 module FiscalYear
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  @config: FiscalYear::Config
+
+  attr_reader self.config: FiscalYear::Config
+  def self.configure: () { (FiscalYear::Config) -> void } -> void | -> void
+  def self.cross_year_month?: (Integer) -> bool
+  def self.cross_year?: () -> bool
+  def self.months: -> Array[Integer]
+  def self.cross_year_months: () -> Array[Integer]
+  def self.halfs: () -> [Array[Integer], Array[Integer]]
+  def self.quarters: () -> [Array[Integer], Array[Integer], Array[Integer], Array[Integer]]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiscal_year
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tsubasa Kawajiri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: fiscal year, quarter, year to date calculate
 email:
 - tk.music.jpn@gmail.com
@@ -67,13 +39,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - lib/fiscal_year.rb
 - lib/fiscal_year/config.rb
 - lib/fiscal_year/half.rb
 - lib/fiscal_year/quarter.rb
 - lib/fiscal_year/version.rb
 - lib/fiscal_year/year_to_date.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sig/fiscal_year.rbs
+- sig/fiscal_year/config.rbs
+- sig/fiscal_year/half.rbs
+- sig/fiscal_year/quarter.rbs
+- sig/fiscal_year/year_to_date.rbs
 homepage: https://github.com/TsubasaKawajiri/fiscal_year
 licenses:
 - MIT
@@ -82,6 +61,7 @@ metadata:
   homepage_uri: https://github.com/TsubasaKawajiri/fiscal_year
   source_code_uri: https://github.com/TsubasaKawajiri/fiscal_year
   changelog_uri: https://github.com/TsubasaKawajiri/fiscal_year/CHANGEROG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: