fiscaly 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e35eef30151ba7e2bdf12e56c758c48a827de4bf255a23a4121cd31170ee7d5
-  data.tar.gz: 05a92cbf15bc3e36f166eb7f6939dc9dfa360de24ab4c178d16294e7fc81e677
+  metadata.gz: 83bdffbd15520ef156308840e2f87e35521b6aeaea378e36985b1b061f6c74bd
+  data.tar.gz: 762a395022ca4cbb3aeae08155cda216f971f553598349e217b882f581f09859
 SHA512:
-  metadata.gz: 6f09bfe91be211441b0286e843b9a01cab10cf569af8956a64f15ea2dccd9d949ebf0cc8f13011c917a9af4a7b9440701d6c00c5d5aca661d1f96e9c9d36b347
-  data.tar.gz: ab18257f45b1060ba5886bc50760bcf860c0405dd3dfad193edd7587ca16fb2c0cad7d1a5ba60fc45081e609f6d3115b342f679585af15f1f5d880600e543bdd
+  metadata.gz: 32c6117fc0ee86b5e193d84d08f00f55d6450c1216fc7e6cbc19f5e53b3046fac9c1e81447159267ee5ac0eef33bff010c09ff15b071e4b5b34fd8eded8089c0
+  data.tar.gz: 16b76da26db027656d57f87f453b79384213666b5a1fda9b49753ac9c7ea581a8b80fb81afc73417c8eb4edb65764a164121e5d86a8d6123b6e51905e1e08e4a

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 gemfile:
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# CHANGELOG
+
+## 1.1.0
+
+Features:
+
+* Add forward_fyear option.
+
+Fixes:
+
+* Fix boundary of fhalf and fquarter.
+* Fix for leap day.
+
+## 1.0.0
+
+* First release.

data/README.md

@@ -1,6 +1,6 @@
 # Fiscaly
 
-Financial date class for ruby.
+Fiscal date class for ruby.
 
 ## Dependencies
 
@@ -21,38 +21,51 @@ Then execute:
 
 ## Usage
 
-Create from date:
+Configure fiscal year:
 
 ```ruby
-Fiscaly.ymd(2017, 1, 1)
-Fiscaly.date(Date.new(2017, 1, 1))
-Fiscaly.parse("2017-01-01")
+# set the start month of the fiscal year
+Fiscaly.start_month = 4
+
+# set true if the fiscal year is based on the following year
+Fiscaly.forward_fyear = false
 ```
 
-Create from date having financial year:
+Create from calendar year:
 
 ```ruby
-Fiscaly.fymd(2017, 1, 1)
-Fiscaly.fdate(Date.new(2017, 1, 1))
-Fiscaly.fparse("2017-01-01")
+fiscal = Fiscaly.ymd(2017, 1, 1)
+fiscal.date
+#=> 2017-01-01
+
+fiscal = Fiscaly.date(Date.new(2017, 1, 1))
+fiscal.date
+#=> 2017-01-01
+
+fiscal = Fiscaly.parse("2017-01-01")
+fiscal.date
+#=> 2017-01-01
 ```
 
-Change the start month of financial year:
+If you want to create from fiscal year, following methods are available:
 
 ```ruby
-# set globally (non thread-safe)
-Fiscaly.start_month = 4
+fiscal = Fiscaly.fymd(2017, 1, 1)
+fiscal.date
+#=> 2018-01-01
 
-# set by argument
-Fiscaly.date(date, start_month: 4)
+fiscal = Fiscaly.fdate(Date.new(2017, 1, 1))
+fiscal.date
+#=> 2018-01-01
 
-# set by block
-Fiscaly.with_start_month(4) do
-  ...
-end
+fiscal = Fiscaly.fparse("2017-01-01")
+fiscal.date
+#=> 2018-01-01
 ```
 
-Get range of financial calendar:
+Note that these methods converts the fiscal year to the calendar year but the month and the day are kept as it is.
+
+Get the range of financial calendar:
 
 ```ruby
 fiscal = Fiscaly.ymd(2017, 1, 1)
@@ -88,9 +101,23 @@ fiscal.range_of_fquarter
 fiscal.beginning_of_fquarter(0)
 #=> 2016-04-01
 fiscal.end_of_fquarter(0)
-#=> 2017-03-31
+#=> 2016-06-30
 fiscal.range_of_fquarter(0)
-#=> 2016-04-01..2017-03-31
+#=> 2016-04-01..2016-06-30
+```
+
+Change the configurations in some context:
+
+```ruby
+# set by argument
+fiscal = Fiscaly.ymd(2017, 10, 1, start_month: 10, forward_fyear: true)
+fiscal.fyear  #=> 2018
+
+# set by block
+Fiscaly.with(start_month: 10, forward_fyear: true) do
+  fiscal = Fiscaly.ymd(2017, 10, 1)
+  fiscal.fyear  #=> 2018
+end
 ```
 
 Extend ruby's standard `Date` class:

data/lib/fiscaly.rb

@@ -3,16 +3,19 @@ require 'active_support/core_ext/time'
 require 'fiscaly/version'
 
 class Fiscaly
-  KEY = :fiscaly_start_month
+  KEY = :fiscaly_options
 
-  cattr_accessor :start_month
-  @@start_month = 4
+  cattr_accessor :options
+  @@options = {
+    start_month: 4,
+    forward_fyear: false
+  }
 
   attr_reader :date
-  attr_reader :start_month
+  attr_reader :options
 
-  def initialize(date, start_month: nil)
-    @start_month = start_month || self.class.global_start_month
+  def initialize(date, options = {})
+    @options = self.class.global_options.merge(options)
     @date = date
   end
 
@@ -24,12 +27,19 @@ class Fiscaly
     end
   end
 
+  def start_month
+    @options[:start_month]
+  end
+
+  def forward_fyear?
+    @options[:forward_fyear]
+  end
+
   def fyear
-    if @date.month >= @start_month
-      @date.year
-    else
-      @date.year - 1
-    end
+    fy = @date.year
+    fy -= 1 if @date.month < start_month
+    fy += 1 if forward_fyear?
+    fy
   end
 
   def fdate
@@ -37,7 +47,8 @@ class Fiscaly
   end
 
   def beginning_of_fyear
-    Date.new(fyear, @start_month)
+    year = forward_fyear? ? fyear - 1 : fyear
+    Date.new(year, start_month)
   end
 
   def end_of_fyear
@@ -53,7 +64,7 @@ class Fiscaly
       beginning_of_fyear + (index * 6).months
     else
       date = beginning_of_fyear
-      date += 6.months until @date <= date
+      date += 6.months until @date < date
       date -= 6.months
     end
   end
@@ -71,7 +82,7 @@ class Fiscaly
       beginning_of_fyear + (index * 3).months
     else
       date = beginning_of_fyear
-      date += 3.months until @date <= date
+      date += 3.months until @date < date
       date -= 3.months
     end
   end
@@ -107,40 +118,48 @@ class Fiscaly
       date(Date.new(year, month, day), options)
     end
 
-    def fdate(date, options = {})
-      self.new(normalize(date, options[:start_month]), options)
+    def fdate(fdate, options = {})
+      fymd(fdate.year, fdate.month, fdate.day, options)
     end
 
-    def fparse(str, options = {})
-      fdate(Date.parse(str), options)
+    def fparse(fstr, options = {})
+      parsed = Date._parse(fstr)
+      fymd(parsed[:year], parsed[:mon], parsed[:mday], options)
     end
 
     def fymd(fyear, month = 1, day = 1, options = {})
-      fdate(Date.new(fyear, month, day), options)
+      self.new(normalize(fyear, month, day, options), options)
     end
 
-    def with_start_month(start_month)
+    def with(options = {})
       Thread.current[KEY] ||= []
-      Thread.current[KEY].push(start_month)
+      Thread.current[KEY].push(options)
       yield
     ensure
       Thread.current[KEY].pop
       Thread.current[KEY] = nil if Thread.current[KEY].empty?
     end
 
-    def global_start_month
-      (Thread.current[KEY].is_a?(Array) && Thread.current[KEY][-1]) || self.start_month
+    def global_options
+      @@options.merge((Thread.current[KEY].is_a?(Array) && Thread.current[KEY][-1]) || {})
+    end
+
+    def start_month=(val)
+      @@options[:start_month] = val
+    end
+
+    def forward_fyear=(val)
+      @@options[:forward_fyear] = val
     end
 
     private
 
-    def normalize(date, start_month)
-      start_month ||= global_start_month
-      if date.month < start_month
-        Date.new(date.year + 1, date.month, date.day)
-      else
-        date
-      end
+    def normalize(fyear, month, day, options = {})
+      options = global_options.merge(options)
+      year = fyear
+      year += 1 if month < options[:start_month]
+      year -= 1 if options[:forward_fyear]
+      Date.new(year, month, day)
     end
   end
 end

data/lib/fiscaly/version.rb

@@ -1,3 +1,3 @@
 class Fiscaly
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fiscaly
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -107,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Financial date class for ruby