fiscaly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e35eef30151ba7e2bdf12e56c758c48a827de4bf255a23a4121cd31170ee7d5
+  data.tar.gz: 05a92cbf15bc3e36f166eb7f6939dc9dfa360de24ab4c178d16294e7fc81e677
+SHA512:
+  metadata.gz: 6f09bfe91be211441b0286e843b9a01cab10cf569af8956a64f15ea2dccd9d949ebf0cc8f13011c917a9af4a7b9440701d6c00c5d5aca661d1f96e9c9d36b347
+  data.tar.gz: ab18257f45b1060ba5886bc50760bcf860c0405dd3dfad193edd7587ca16fb2c0cad7d1a5ba60fc45081e609f6d3115b342f679585af15f1f5d880600e543bdd

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+.project
+Gemfile.lock
+coverage/
+pkg/
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+gemfile:
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yoshikazu Kaneta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Fiscaly
+
+Financial date class for ruby.
+
+## Dependencies
+
+* ruby 2.3+
+* activesupport 5.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fiscaly'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Create from date:
+
+```ruby
+Fiscaly.ymd(2017, 1, 1)
+Fiscaly.date(Date.new(2017, 1, 1))
+Fiscaly.parse("2017-01-01")
+```
+
+Create from date having financial year:
+
+```ruby
+Fiscaly.fymd(2017, 1, 1)
+Fiscaly.fdate(Date.new(2017, 1, 1))
+Fiscaly.fparse("2017-01-01")
+```
+
+Change the start month of financial year:
+
+```ruby
+# set globally (non thread-safe)
+Fiscaly.start_month = 4
+
+# set by argument
+Fiscaly.date(date, start_month: 4)
+
+# set by block
+Fiscaly.with_start_month(4) do
+  ...
+end
+```
+
+Get range of financial calendar:
+
+```ruby
+fiscal = Fiscaly.ymd(2017, 1, 1)
+
+fiscal.beginning_of_fyear
+#=> 2016-04-01
+fiscal.end_of_fyear
+#=> 2017-03-31
+fiscal.range_of_fyear
+#=> 2016-04-01..2017-03-31
+
+fiscal.beginning_of_fhalf
+#=> 2016-10-01
+fiscal.end_of_fhalf
+#=> 2017-03-31
+fiscal.range_of_fhalf
+#=> 2016-10-01..2017-03-31
+
+fiscal.beginning_of_fhalf(0)
+#=> 2016-04-01
+fiscal.end_of_fhalf(0)
+#=> 2016-09-30
+fiscal.range_of_fhalf(0)
+#=> 2016-04-01..2016-09-30
+
+fiscal.beginning_of_fquarter
+#=> 2017-01-01
+fiscal.end_of_fquarter
+#=> 2017-03-31
+fiscal.range_of_fquarter
+#=> 2017-01-01..2017-03-31
+
+fiscal.beginning_of_fquarter(0)
+#=> 2016-04-01
+fiscal.end_of_fquarter(0)
+#=> 2017-03-31
+fiscal.range_of_fquarter(0)
+#=> 2016-04-01..2017-03-31
+```
+
+Extend ruby's standard `Date` class:
+
+```ruby
+require 'fiscaly/extension'
+
+date = Date.today.fiscaly
+date.fyear
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/fiscaly.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fiscaly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fiscaly.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fiscaly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fiscaly"
+  spec.version       = Fiscaly::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Financial date class for ruby}
+  spec.description   = %q{Financial date class for ruby}
+  spec.homepage      = "https://github.com/kanety/fiscaly"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/gemfiles/rails50.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "activesupport", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "activesupport", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/lib/fiscaly.rb

@@ -0,0 +1,146 @@
+require 'active_support/core_ext/integer'
+require 'active_support/core_ext/time'
+require 'fiscaly/version'
+
+class Fiscaly
+  KEY = :fiscaly_start_month
+
+  cattr_accessor :start_month
+  @@start_month = 4
+
+  attr_reader :date
+  attr_reader :start_month
+
+  def initialize(date, start_month: nil)
+    @start_month = start_month || self.class.global_start_month
+    @date = date
+  end
+
+  def method_missing(name, *args)
+    if @date.respond_to?(name)
+      @date.send(name, *args)
+    else
+      super
+    end
+  end
+
+  def fyear
+    if @date.month >= @start_month
+      @date.year
+    else
+      @date.year - 1
+    end
+  end
+
+  def fdate
+    Date.new(fyear, @date.month, @date.day);
+  end
+
+  def beginning_of_fyear
+    Date.new(fyear, @start_month)
+  end
+
+  def end_of_fyear
+    (beginning_of_fyear + 11.months).end_of_month
+  end
+
+  def range_of_fyear
+    beginning_of_fyear..end_of_fyear
+  end
+
+  def beginning_of_fhalf(index = nil)
+    if index
+      beginning_of_fyear + (index * 6).months
+    else
+      date = beginning_of_fyear
+      date += 6.months until @date <= date
+      date -= 6.months
+    end
+  end
+
+  def end_of_fhalf(index = nil)
+    (beginning_of_fhalf(index) + 5.months).end_of_month
+  end
+
+  def range_of_fhalf(index = nil)
+    beginning_of_fhalf(index)..end_of_fhalf(index)
+  end
+
+  def beginning_of_fquarter(index = nil)
+    if index
+      beginning_of_fyear + (index * 3).months
+    else
+      date = beginning_of_fyear
+      date += 3.months until @date <= date
+      date -= 3.months
+    end
+  end
+
+  def end_of_fquarter(index = nil)
+    (beginning_of_fquarter(index) + 2.months).end_of_month
+  end
+
+  def range_of_fquarter(index = nil)
+    beginning_of_fquarter(index)..end_of_fquarter(index)
+  end
+
+  def range_of_month
+    @date.beginning_of_month..@date.end_of_month
+  end
+
+  private
+
+  class << self
+    def today(options = {})
+      date(Date.today, options)
+    end
+
+    def date(date, options = {})
+      self.new(date, options)
+    end
+
+    def parse(str, options = {})
+      date(Date.parse(str), options)
+    end
+
+    def ymd(year, month = 1, day = 1, options = {})
+      date(Date.new(year, month, day), options)
+    end
+
+    def fdate(date, options = {})
+      self.new(normalize(date, options[:start_month]), options)
+    end
+
+    def fparse(str, options = {})
+      fdate(Date.parse(str), options)
+    end
+
+    def fymd(fyear, month = 1, day = 1, options = {})
+      fdate(Date.new(fyear, month, day), options)
+    end
+
+    def with_start_month(start_month)
+      Thread.current[KEY] ||= []
+      Thread.current[KEY].push(start_month)
+      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
+    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
+    end
+  end
+end

data/lib/fiscaly/extension.rb

@@ -0,0 +1,9 @@
+class Fiscaly
+  module Extension
+    def fiscaly(options = {})
+      Fiscaly.new(self, options)
+    end
+  end
+end
+
+Date.send(:include, Fiscaly::Extension)

data/lib/fiscaly/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: fiscaly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Financial date class for ruby
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fiscaly.gemspec
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- lib/fiscaly.rb
+- lib/fiscaly/extension.rb
+- lib/fiscaly/version.rb
+homepage: https://github.com/kanety/fiscaly
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Financial date class for ruby
+test_files: []