financial_year 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 701c98650abc37b740e16462da810261981df5df
+  data.tar.gz: fb03b49858c482984b636eba9d2d31fb0ef0920d
+SHA512:
+  metadata.gz: c48dd66b63a7fc6cf167eb1c8792d0d896fe5fa53489d2bd6bdf04a13980335a8e51fcfe12d44985302620ef439b6a098f8ce6c3270d44e084d9bbe56398b88e
+  data.tar.gz: 2012cb698e486d228f8385f8056b5aff2d22e8f6cda48d0fa47c5f302c99de157c49f5552e833372d9e84947af9ded2371e1f9ed340d2a0154799d995c5b6bc6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in financial_year.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jack Wu( [♠]]] )
+
+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,32 @@
+# FinancialYear
+
+> A gem tells you what financial year is it now, and also the date range of it
+
+### How to user it
+
+```ruby
+  klass = FinancialYear::FinancialYear.config(
+    start_month = 4,
+    start_day = 1,
+    end_month = 3,
+    end_day = 31
+  )
+
+  financial_year = klass.for_year(2017)
+  financial_year.financial_year_range
+  # expect(instance.financial_year_range).to eq Date.new(2016, 4, 1)..Date.new(2017, 3, 31)
+
+  financial_year.ytd_range
+  # expect(instance.ytd_range).to eq Date.new(2017, 4, 1)..Date.today
+
+
+  # Real life example
+  today = Date.today
+
+  start_last_year = today.month >= FinancialYear.start_month ? today.year - 1 : today.year - 2
+  # Last financial year
+  last_year = FinancialYear.for_year(start_last_year).financial_year_range
+
+  # This on going financial year
+  current_year_ytd = FinancialYear.for_year(start_last_year + 1).ytd_range
+```

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 "financial_year"
+
+# 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(__FILE__)

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/financial_year.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "financial_year/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "financial_year"
+  spec.version       = FinancialYear::VERSION
+  spec.authors       = ["Jack Wu"]
+  spec.email         = ["xuwupeng2000@gmail.com"]
+
+  spec.summary       = %q{A gem tells you what financial year is it now, and also the date range of it}
+  spec.description   = %q{A gem tells you what financial year is it now, and also the date range of it}
+  spec.homepage      = "https://github.com/xuwupeng2000/financial_year"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/financial_year.rb

@@ -0,0 +1,41 @@
+require 'time'
+require "financial_year/version"
+
+module FinancialYear
+  class FinancialYear
+    attr_accessor :start_date, :end_date
+
+    def initialize(start_date, end_date)
+      @start_date  = start_date
+      @end_date = end_date
+    end
+
+    class << self
+      attr_accessor :start_month, :start_day, :end_month, :end_day
+
+      def for_year(year)
+        new(
+          Date.new(year, start_month, start_day),
+          Date.new(year + 1, end_month, end_day)
+        )
+      end
+
+      def config(start_month=4, start_day=1, end_month=3, end_day=31)
+        self.start_month = start_month
+        self.start_day = start_day
+        self.end_month = end_month
+        self.end_day= end_day
+      end
+    end
+
+    # The range of that financial year
+    def financial_year_range
+      start_date..end_date
+    end
+
+    # From that financial_year to now
+    def ytd_range
+      start_date..Date.today
+    end
+  end
+end

data/lib/financial_year/version.rb

@@ -0,0 +1,3 @@
+module FinancialYear
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: financial_year
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Wu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem tells you what financial year is it now, and also the date range
+  of it
+email:
+- xuwupeng2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- financial_year.gemspec
+- lib/financial_year.rb
+- lib/financial_year/version.rb
+homepage: https://github.com/xuwupeng2000/financial_year
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem tells you what financial year is it now, and also the date range of
+  it
+test_files: []