retail_calendar 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79f246262c55db15d88fa6dd5cd1450d3ba3fbd2
+  data.tar.gz: 13338541df1e303ce732d76057ec38305061407b
+SHA512:
+  metadata.gz: 2c107c94d647936706b3010f5da70f3221d77f3ef3a6f0112259d19ba7de4b0e5d5cb4635ea67b7beb41d028a6e6a7923f2fc53173992a8b00642f18c6c9085d
+  data.tar.gz: 77f074f0aa6ef995e03b307895d216c8ec87beb7db85164bdf0d01a2990995731c1ea0a5e54d2935535f7eb49699f72c8a4eb720aca7b2cb786960ec35187639

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.0.0
+
+script: 'bundle exec rspec'
+
+notifications:
+  email:
+    recipients:
+      - adi.version1@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in retail_calendar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kunwar Aditya Raghuwanshi
+
+MIT License
+
+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,104 @@
+# RetailCalendar
+
+[![Build Status](https://travis-ci.org/kitwalker12/retail_calendar.svg?branch=master)](https://travis-ci.org/kitwalker12/retail_calendar)
+
+Gem for finding ranges in Retail or the [4-5-4 Calendar format](http://en.wikipedia.org/wiki/4%E2%80%934%E2%80%935_calendar)
+
+Reference Calendars:
+
+* [2014](http://www.nrf.com/modules.php?name=Documents&op=viewlive&sp_id=7464)
+* [2006 Retail Leap year](http://www.nrf.com/modules.php?name=Documents&op=viewlive&sp_id=245)
+
+## Credits
+
+* [Retail Calendar Gem](https://github.com/Totokaelo/retail_calendar)
+* [DateTime::Fiscal::Retail454](https://metacpan.org/pod/DateTime::Fiscal::Retail454)
+* [How to Set Up a 4-5-4 Calendar](http://www.smythretail.com/general-retailing/how-to-set-up-a-4-5-4-calendar/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'retail_calendar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install retail_calendar
+
+## Usage
+
+Instantiate RetailCalendar::Finder object to get start and end dates for weeks/periods(months)/quarters/seasons/years
+
+```
+> cal = RetailCalendar::Finder.new
+=> #<RetailCalendar::Finder:0x00000102125a40 @offset="+0000">
+```
+
+Instantiate with time zone
+
+```
+> cal = RetailCalendar::Finder.new('+7000')
+=> #<RetailCalendar::Finder:0x000001021a3328 @offset="+7000">
+```
+
+### Functions
+
+```
+> res = cal.week(2014, 1, 1)
+=> #<Dish::Plate:0x0000010214e6c0
+ @_original_hash=
+  {"start_date"=>Sun, 02 Feb 2014 00:00:00 +0000,
+   "end_date"=>Sat, 08 Feb 2014 00:00:00 +0000}>
+
+> res.start_date
+=> Sun, 02 Feb 2014 00:00:00 +0000
+
+> res.end_date
+=> Sat, 08 Feb 2014 00:00:00 +0000
+
+> res = cal.period(2014, 1)
+=> #<Dish::Plate:0x000001014bd7a8
+ @_original_hash=
+  {"start_date"=>Sun, 02 Feb 2014 00:00:00 +0000,
+   "end_date"=>Sat, 01 Mar 2014 00:00:00 +0000}>
+
+> res = cal.quarter(2014, 1)
+=> #<Dish::Plate:0x0000010153e628
+ @_original_hash=
+  {"start_date"=>Sun, 02 Feb 2014 00:00:00 +0000,
+   "end_date"=>Sat, 03 May 2014 00:00:00 +0000}>
+
+> res = cal.season(2014, 1)
+=> #<Dish::Plate:0x0000010188eee0
+ @_original_hash=
+  {"start_date"=>Sun, 02 Feb 2014 00:00:00 +0000,
+   "end_date"=>Sat, 02 Aug 2014 00:00:00 +0000}>
+
+> res = cal.year(2014)
+=> #<Dish::Plate:0x000001019100a8
+ @_original_hash=
+  {"start_date"=>Sun, 02 Feb 2014 00:00:00 +0000,
+   "end_date"=>Sat, 31 Jan 2015 00:00:00 +0000}>
+```
+
+Handles Retail Leap years
+
+```
+> res = cal.year(2006)
+=> #<Dish::Plate:0x00000101979558
+ @_original_hash=
+  {"start_date"=>Sun, 29 Jan 2006 00:00:00 +0000,
+   "end_date"=>Sat, 03 Feb 2007 00:00:00 +0000}>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/kitwalker12/retail_calendar/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/retail_calendar.rb

@@ -0,0 +1,5 @@
+require "retail_calendar/version"
+require "retail_calendar/finder"
+
+module RetailCalendar
+end

data/lib/retail_calendar/finder.rb

@@ -0,0 +1,194 @@
+require "active_support/all"
+require "dish"
+
+module RetailCalendar
+  class Finder
+    attr_accessor :offset
+    @offset
+
+    YEAR_LENGTH = 364
+    SEASON_LENGTH = YEAR_LENGTH / 2
+    QUARTER_LENGTH = SEASON_LENGTH / 2
+
+    def initialize(offset = '+0000')
+      @offset = offset
+    end
+
+    def week(year, period, week)
+      period = period.to_i
+      raise ArgumentError, 'invalid period' if (period > 12 or period < 1)
+      week = week.to_i
+      raise ArgumentError, 'invalid week' if (week > 5 or week < 1)
+      start_date = period(year, period).start_date
+      for i in 1..(week - 1)
+        start_date = start_date + 7
+      end
+      end_date = start_date + 1.week - 1
+      create_return_object(start_date,end_date)
+    end
+
+    def period(year, period)
+      period = period.to_i
+      raise ArgumentError, 'invalid period' if (period > 12 or period < 1)
+      start_date = start_time_for_year(year)
+      for i in 1..(period - 1)
+        start_date = start_date + weeks_in_month((i % 12) + 1).weeks
+      end
+      end_date = start_date + weeks_in_month((period % 12) + 1).weeks - 1
+      if year_has_extra_week?(year) and period == 12
+        end_date = end_date + 1.week
+      end
+      create_return_object(start_date,end_date)
+    end
+
+    def quarter(year, quarter)
+      quarter = quarter.to_i
+      raise ArgumentError, 'invalid quarter' if (quarter > 4 or quarter < 1)
+      start_date = start_time_for_year(year) + (QUARTER_LENGTH * (quarter - 1))
+      end_date = start_date + QUARTER_LENGTH - 1
+      if year_has_extra_week?(year) and quarter == 4
+        end_date = end_date + 1.week
+      end
+      create_return_object(start_date,end_date)
+    end
+
+    def season(year, season)
+      season = season.to_i
+      raise ArgumentError, 'invalid season' if (season > 2 or season < 1)
+      start_date = start_time_for_year(year) + (SEASON_LENGTH * (season - 1))
+      end_date = start_date + SEASON_LENGTH - 1
+      if year_has_extra_week?(year) and season == 2
+        end_date = end_date + 1.week
+      end
+      create_return_object(start_date,end_date)
+    end
+
+    def year(year)
+      start_date = start_time_for_year(year)
+      end_date = start_date + YEAR_LENGTH - 1
+      end_date = year_has_extra_week?(year) ? (end_date + 1.week) : end_date
+      create_return_object(start_date,end_date)
+    end
+
+    def last_year
+      previous_year = DateTime.now.change(:offset => @offset).year - 1
+      year(previous_year)
+    end
+
+    def last_season
+      current_year = DateTime.now.change(:offset => @offset).year
+      current_season = get_current_season
+      if current_season == 1
+        previous_year = current_year - 1
+        previous_season = 2
+      else
+        previous_year = current_year
+        previous_season = current_season - 1
+      end
+      season(previous_year, previous_season)
+    end
+
+    def last_quarter
+      current_year = DateTime.now.change(:offset => @offset).year
+      current_quarter = get_current_quarter
+      if current_quarter == 1
+        previous_year = current_year - 1
+        previous_quarter = 4
+      else
+        previous_year = current_year
+        previous_quarter = current_quarter - 1
+      end
+      quarter(previous_year, previous_quarter)
+    end
+
+    def last_period
+      current_year = DateTime.now.change(:offset => @offset).year
+      current_period = get_current_period
+      if current_period == 1
+        previous_year = current_year - 1
+        previous_period = 12
+      else
+        previous_year = current_year
+        previous_period = current_period - 1
+      end
+      period(previous_year, previous_period)
+    end
+
+    def last_week
+      start_date = DateTime.now.change(:offset => @offset) - 1.week
+      start_date = start_date.beginning_of_week(start_day = :sunday)
+      end_date = start_date + 1.week - 1
+      create_return_object(start_date,end_date)
+    end
+
+    private
+
+    def get_current_season
+      curr_date = DateTime.now.change(:offset => @offset)
+      start_date = start_time_for_year(curr_date.year)
+      days_passed = (curr_date.to_date - start_date.to_date).to_i
+      days_passed < SEASON_LENGTH ? 1 : 2
+    end
+
+    def get_current_quarter
+      curr_date = DateTime.now.change(:offset => @offset)
+      start_date = start_time_for_year(curr_date.year)
+      days_passed = (curr_date.to_date - start_date.to_date).to_i
+      case days_passed
+      when 0..91
+        1
+      when 92..182
+        2
+      when 183..273
+        3
+      else
+        4
+      end
+    end
+
+    def get_current_period
+      curr_date = DateTime.now.change(:offset => @offset)
+      start_date = start_time_for_year(curr_date.year)
+      period = 1
+      while start_date < curr_date
+        no_weeks = weeks_in_month(period + 1)
+        start_date += no_weeks.weeks
+        period += 1
+      end
+      period - 1
+    end
+
+    def create_return_object(start_date, end_date)
+      Dish({
+        start_date: start_date,
+        end_date: end_date
+      })
+    end
+
+    def weeks_in_month(month)
+      month = month.to_i
+      month % 3 == 0 ? 5 : 4
+    end
+
+    def start_time_for_year(year)
+      year = year.to_i
+      jan31 = DateTime.new(year,1,31).change(:offset => @offset)
+      jan31day = jan31.cwday
+      if jan31day < 3
+        start = jan31 - jan31day
+      elsif jan31day < 7
+        start = jan31 + (7 - jan31day)
+      elsif jan31day == 7
+        start = jan31
+      end
+      start
+    end
+
+    def year_has_extra_week?(year)
+      year = year.to_i
+      expected = start_time_for_year(year) + 364
+      actual = start_time_for_year(year + 1)
+      actual > expected ? true : false
+    end
+  end
+end

data/lib/retail_calendar/version.rb

@@ -0,0 +1,3 @@
+module RetailCalendar
+  VERSION = "1.0.1"
+end

data/retail_calendar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'retail_calendar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "retail_calendar"
+  spec.version       = RetailCalendar::VERSION
+  spec.authors       = ["Aditya Raghuwanshi"]
+  spec.email         = ["adi.version1@gmail.com"]
+  spec.summary       = %q{Find Dates in the Retails Calendar}
+  spec.description   = %q{Gem for finding ranges in Retail or the 4-5-4 Calendar format}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "dish"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/finder_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe RetailCalendar::Finder do
+  let(:cal) { RetailCalendar::Finder.new }
+
+  it "should return correct week start and end dates" do
+    res = cal.week(2014, 1, 1)
+    expect(res.start_date).to eq(DateTime.new(2014,2,2))
+    expect(res.end_date).to eq(DateTime.new(2014,2,8))
+    res = cal.week(2014, 5, 2)
+    expect(res.start_date).to eq(DateTime.new(2014,6,8))
+    expect(res.end_date).to eq(DateTime.new(2014,6,14))
+    res = cal.week(2014, 12, 3)
+    expect(res.start_date).to eq(DateTime.new(2015,1,18))
+    expect(res.end_date).to eq(DateTime.new(2015,1,24))
+  end
+
+  it "should return correct period start and end dates" do
+    res = cal.period(2014, 1)
+    expect(res.start_date).to eq(DateTime.new(2014,2,2))
+    expect(res.end_date).to eq(DateTime.new(2014,3,1))
+    res = cal.period(2014, 4)
+    expect(res.start_date).to eq(DateTime.new(2014,5,4))
+    expect(res.end_date).to eq(DateTime.new(2014,5,31))
+    res = cal.period(2014, 8)
+    expect(res.start_date).to eq(DateTime.new(2014,8,31))
+    expect(res.end_date).to eq(DateTime.new(2014,10,4))
+    res = cal.period(2014, 12)
+    expect(res.start_date).to eq(DateTime.new(2015,1,4))
+    expect(res.end_date).to eq(DateTime.new(2015,1,31))
+  end
+
+  it "should return correct quarter start and end dates" do
+    res = cal.quarter(2014, 1)
+    expect(res.start_date).to eq(DateTime.new(2014,2,2))
+    expect(res.end_date).to eq(DateTime.new(2014,5,3))
+    res = cal.quarter(2014, 2)
+    expect(res.start_date).to eq(DateTime.new(2014,5,4))
+    expect(res.end_date).to eq(DateTime.new(2014,8,2))
+    res = cal.quarter(2014, 3)
+    expect(res.start_date).to eq(DateTime.new(2014,8,3))
+    expect(res.end_date).to eq(DateTime.new(2014,11,1))
+    res = cal.quarter(2014, 4)
+    expect(res.start_date).to eq(DateTime.new(2014,11,2))
+    expect(res.end_date).to eq(DateTime.new(2015,1,31))
+  end
+
+  it "should return correct season start and end dates" do
+    res = cal.season(2014, 1)
+    expect(res.start_date).to eq(DateTime.new(2014,2,2))
+    expect(res.end_date).to eq(DateTime.new(2014,8,2))
+    res = cal.season(2014, 2)
+    expect(res.start_date).to eq(DateTime.new(2014,8,3))
+    expect(res.end_date).to eq(DateTime.new(2015,1,31))
+  end
+
+  it "should return correct year start and end dates" do
+    res = cal.year(2014)
+    expect(res.start_date).to eq(DateTime.new(2014,2,2))
+    expect(res.end_date).to eq(DateTime.new(2015,1,31))
+  end
+
+  it "handle leap years" do
+    res = cal.year(2006)
+    expect(res.start_date).to eq(DateTime.new(2006,1,29))
+    expect(res.end_date).to eq(DateTime.new(2007,2,3))
+    res = cal.season(2006,2)
+    expect(res.start_date).to eq(DateTime.new(2006,7,30))
+    expect(res.end_date).to eq(DateTime.new(2007,2,3))
+    res = cal.quarter(2006,3)
+    expect(res.start_date).to eq(DateTime.new(2006,7,30))
+    expect(res.end_date).to eq(DateTime.new(2006,10,28))
+    res = cal.period(2006,12)
+    expect(res.start_date).to eq(DateTime.new(2006,12,31))
+    expect(res.end_date).to eq(DateTime.new(2007,2,3))
+    res = cal.week(2006,12,5)
+    expect(res.start_date).to eq(DateTime.new(2007,1,28))
+    expect(res.end_date).to eq(DateTime.new(2007,2,3))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'pry'
+require 'retail_calendar'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: retail_calendar
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Aditya Raghuwanshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: activesupport
+  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: dish
+  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: pry
+  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: Gem for finding ranges in Retail or the 4-5-4 Calendar format
+email:
+- adi.version1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/retail_calendar.rb
+- lib/retail_calendar/finder.rb
+- lib/retail_calendar/version.rb
+- retail_calendar.gemspec
+- spec/finder_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Find Dates in the Retails Calendar
+test_files:
+- spec/finder_spec.rb
+- spec/spec_helper.rb