merch_calendar 0.0.1

data/lib/merch_calendar/util.rb

@@ -0,0 +1,160 @@
+module MerchCalendar
+
+  # Utility methods for the merch calendar
+  module Util
+
+    # The start date of the month
+    #
+    # @example
+    #  # The following are all equivalent, and refer to May 2015
+    #  MerchCalendar.start_of_month(2015, 5)
+    #  MerchCalendar.start_of_month(2015, month: 5)
+    #  MerchCalendar.start_of_month(2015, julian_month: 5)
+    #  MerchCalendar.start_of_month(2015, merch_month: 4)
+    #
+    # @param year [Fixnum] the merch year
+    # @param month_param [Fixnum,Hash] an integer specifying the julian month. This can also be a named hash
+    # @option month_param [Fixnum] :month the julian month
+    # @option month_param [Fixnum] :julian_month the julian month
+    # @option month_param [Fixnum] :merch_month the MERCH month
+    #
+    # @return [Date] the starting date of the specified month
+    def start_of_month(year, month_param)
+      merch_month = get_merch_month_param(month_param)
+      date_calc.start_of_month(year, merch_month)
+    end
+
+    # The end date of the month
+    #
+    # @param year [Fixnum] the merch year
+    # @param month_param [Hash] month hash
+    #
+    # @see #start_of_month The start_of_month method for examples using month_param
+    #
+    # @return [Date]
+    def end_of_month(year, month_param)
+      merch_month = get_merch_month_param(month_param)
+      date_calc.end_of_month(year, merch_month)
+    end
+
+    # The start date of the year
+    #
+    # @param year [Fixnum] the merch year
+    #
+    # @return [Date] the starting date of the specified year
+    def start_of_year(year)
+      date_calc.start_of_year(year)
+    end
+
+    # The end date of the year
+    #
+    # @param year [Fixnum] the merch year
+    #
+    # @return [Date] the ending date of the specified year
+    def end_of_year(year)
+      date_calc.end_of_year(year)
+    end
+
+
+    # The start date of the quarter
+    #
+    # @param year [Fixnum] the merch year
+    # @param quarter [Fixnum] the quarter
+    #
+    # @return [Date] the starting date of the specified quarter
+    def start_of_quarter(year, quarter)
+      date_calc.start_of_quarter(year, quarter)
+    end
+
+    # The end date of the quarter
+    #
+    # @param year [Fixnum] the merch year
+    # @param quarter [Fixnum] the quarter
+    #
+    # @return [Date] the ending date of the specified quarter
+    def end_of_quarter(year, quarter)
+      date_calc.end_of_quarter(year, quarter)
+    end
+
+
+    # Returns the number of weeks in a given merch year
+    #
+    # @param year [Fixnum] the merch year
+    #
+    # @return [Fixnum] number of weeks
+    def weeks_in_year(year)
+      date_calc.weeks_in_year(year)
+    end
+
+
+
+    # Converts a merch month to the correct julian month
+    #
+    # @param month [Fixnum] the merch month to convert
+    # @return [Fixnum] the julian month
+    def merch_to_julian(month)
+      date_calc.merch_to_julian(month)
+    end
+
+    # Converts a julian month to a merch month
+    #
+    # @param month [Fixnum] the julian month to convert
+    # @return [Fixnum] the merch month
+    def julian_to_merch(month)
+      date_calc.julian_to_merch(month)
+    end
+
+    # An array of merch weeks in a given month
+    #
+    # @param year [Fixnum] the merch year
+    # @param month_param [Hash] month hash
+    #
+    # @see #start_of_month The start_of_month method for examples using month_param
+    #
+    # @return [Array<MerchWeek>]
+    def weeks_for_month(year, month_param)
+      merch_month = get_merch_month_param(month_param)
+
+      start_date = date_calc.start_of_month(year, merch_month)
+
+      weeks = (date_calc.end_of_month(year, merch_month) - start_date + 1) / 7
+
+      (1..weeks).map do |week_num|
+        week_start = start_date + ((week_num - 1) * 7)
+        week_end = week_start + 6
+        MerchWeek.new(week_start, { start_of_week: week_start, end_of_week: week_end, week: week_num })
+      end
+    end
+
+
+    private
+
+    def date_calc
+      @date_calc ||= DateCalculator.new
+    end
+
+    # Reads the provided parameter and converts the value
+    # to a MERCH MONTH
+    def get_merch_month_param(param)
+      if param.is_a? Fixnum
+        return date_calc.julian_to_merch(param)
+      elsif param.is_a? Hash
+        julian_month = param.delete(:julian_month) || param.delete(:month)
+        merch_month = param.delete(:merch_month)
+        if merch_month
+          return merch_month
+        elsif julian_month
+          return date_calc.julian_to_merch(julian_month)
+        end
+      end
+      raise ArgumentError
+    end
+
+  end
+
+  # Load the utils into the MerchCalendar namespace
+  class << self
+    include Util
+  end
+
+end

data/lib/merch_calendar/version.rb

@@ -0,0 +1,3 @@
+module MerchCalendar
+  VERSION = '0.0.1'
+end

data/lib/merch_calendar.rb

@@ -0,0 +1,12 @@
+
+#
+module MerchCalendar
+
+end
+
+require_relative 'merch_calendar/version'
+require_relative 'merch_calendar/util'
+require_relative 'merch_calendar/configurable'
+require_relative 'merch_calendar/configuration'
+require_relative 'merch_calendar/merch_week'
+require_relative 'merch_calendar/date_calculator'

data/merch_calendar.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'merch_calendar/version'
+
+Gem::Specification.new do |s|
+  s.name        = "merch_calendar"
+  s.version     = MerchCalendar::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Mitch Dempsey']
+  s.email       = ['mitch@stitchfix.com']
+  s.licenses    = ['MIT']
+  s.homepage    = "https://github.com/stitchfix/merch_calendar"
+  s.summary     = "Utility for manipulating dates within a 4-5-4 retail calendar"
+  s.description = "Utility for manipulating dates within a 4-5-4 retail calendar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ">= 3.0.0"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "pry"
+end

data/spec/merch_calendar/configurable_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+
+describe MerchCalendar do
+  describe "#reset_config!" do
+    it "resets the configuration to defaults" do
+      MerchCalendar.configure do |config|
+        config.quarter_start_month = 1
+      end
+
+      MerchCalendar.reset_config!
+
+      expect(MerchCalendar.configuration.quarter_start_month).to eq MerchCalendar::Configuration.new.quarter_start_month
+
+    end
+  end
+
+  
+end

data/spec/merch_calendar/configuration_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe MerchCalendar::Configuration do
+  describe "#quarter_start_month" do
+    it "default value is 8" do
+      expect(described_class.new.quarter_start_month).to eq 8
+    end
+  end
+
+  describe "#quarter_start_month=" do
+    it "can set value" do
+      config = described_class.new
+      config.quarter_start_month = 7
+      expect(config.quarter_start_month).to eq 7
+    end
+  end
+end

data/spec/merch_calendar/date_calculator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe MerchCalendar::DateCalculator do
+
+  subject { described_class.new }
+
+  describe "#julian_to_merch" do
+    it { expect(subject.julian_to_merch(1)).to eq 12 }
+    it { expect(subject.julian_to_merch(2)).to eq 1 }
+    it { expect(subject.julian_to_merch(3)).to eq 2 }
+    it { expect(subject.julian_to_merch(4)).to eq 3 }
+    it { expect(subject.julian_to_merch(5)).to eq 4 }
+    it { expect(subject.julian_to_merch(6)).to eq 5 }
+    it { expect(subject.julian_to_merch(7)).to eq 6 }
+    it { expect(subject.julian_to_merch(8)).to eq 7 }
+    it { expect(subject.julian_to_merch(9)).to eq 8 }
+    it { expect(subject.julian_to_merch(10)).to eq 9 }
+    it { expect(subject.julian_to_merch(11)).to eq 10 }
+    it { expect(subject.julian_to_merch(12)).to eq 11 }
+  end
+
+  describe "#merch_to_julian" do
+    it { expect(subject.merch_to_julian(12)).to eq 1 }
+    it { expect(subject.merch_to_julian(1)).to eq 2 }
+    it { expect(subject.merch_to_julian(2)).to eq 3 }
+    it { expect(subject.merch_to_julian(3)).to eq 4 }
+    it { expect(subject.merch_to_julian(4)).to eq 5 }
+    it { expect(subject.merch_to_julian(5)).to eq 6 }
+    it { expect(subject.merch_to_julian(6)).to eq 7 }
+    it { expect(subject.merch_to_julian(7)).to eq 8 }
+    it { expect(subject.merch_to_julian(8)).to eq 9 }
+    it { expect(subject.merch_to_julian(9)).to eq 10 }
+    it { expect(subject.merch_to_julian(10)).to eq 11 }
+    it { expect(subject.merch_to_julian(11)).to eq 12 }
+  end
+
+  describe "#weeks_in_year" do
+    it "returns 53 for a leap year" do
+      expect(subject.weeks_in_year(2012)).to eq 53
+    end
+
+    it "returns 52 for a normal year" do
+      expect(subject.weeks_in_year(2013)).to eq 52
+    end
+  end
+
+  it "#start_of_quarter"
+
+  it "#end_of_quarter"
+
+end
+

data/spec/merch_calendar/merch_week_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe MerchCalendar::MerchWeek do
+
+  describe ".find" do
+    it "returns an array of weeks" do
+      weeks = described_class.find(2014,1)
+      expect(weeks).to be_an Array
+      expect(weeks.size).to eq 4
+    end
+
+    it "with year, month, week" do
+      mw = described_class.find(2014,1,1)
+      expect(mw.year).to eq 2014
+      expect(mw.month).to eq 1
+      expect(mw.merch_month).to eq 12
+      expect(mw.week).to eq 1
+    end
+  end
+
+  describe ".from_date" do
+
+    context "parameters" do
+      context "allows valid date types" do
+        it "allows a date string" do
+          mw = described_class.from_date("1990-10-01")
+          expect(mw.date.to_s).to eq "1990-10-01"
+          expect(mw.date.month).to eq 10
+        end
+      end
+
+      context "throws exception for invalid types" do
+        it { expect{described_class.from_date}.to raise_error(ArgumentError) }
+        it { expect{described_class.from_date(1)}.to raise_error(ArgumentError) }
+        it { expect{described_class.from_date(true)}.to raise_error(ArgumentError) }
+        it { expect{described_class.from_date(1.0)}.to raise_error(ArgumentError) }
+      end
+
+      context "throws exception for invalid dates" do
+        it { expect{described_class.from_date("2015")}.to raise_error(ArgumentError) }
+        it { expect{described_class.from_date("2015-04")}.to raise_error(ArgumentError) }
+      end
+    end
+  end
+
+  describe ".today" do
+    it "returns a merch week based on today's date" do
+      mw = described_class.today
+      expect(mw.date.to_s).to eq Date.today.to_s
+    end
+  end
+
+  describe "#to_s" do
+    let(:merch_week) { described_class.from_date("2014-01-01") }
+
+    it ":short / default format" do
+      expect(merch_week.to_s(:short)).to eq "Dec W5"
+      expect(merch_week.to_s).to eq "Dec W5"
+      expect("#{merch_week}").to eq "Dec W5"
+    end
+
+    it ":long format" do
+      expect(merch_week.to_s(:long)).to eq "2013:48 Dec W5"
+    end
+
+    it ":elasticsearch format" do
+      expect(merch_week.to_s(:elasticsearch)).to eq "2013-12w05"
+    end
+  end
+
+  it "#end_of_week" do
+    mw = described_class.find(2014,1,1)
+
+    expect(mw.end_of_week).to eq (mw.start_of_week + 6)
+  end
+
+
+  describe "#end_of_month" do
+    it "for a 4 week month" do
+      mw = described_class.find(2014, 2, 1)
+      expect(mw.end_of_month - mw.start_of_month + 1).to eq (4*7)
+    end
+
+    it "for a 5 week month" do
+      mw = described_class.find(2014, 3, 1)
+      expect(mw.end_of_month - mw.start_of_month + 1).to eq (5*7)
+    end
+
+    it "for a 4 to 5 week month in a leap year" do
+      mw = described_class.find(2011, 1, 1)
+      expect(mw.end_of_month - mw.start_of_month + 1).to eq (4*7)
+
+      mw = described_class.find(2012, 1, 1)
+      expect(mw.end_of_month - mw.start_of_month + 1).to eq (5*7)
+    end
+  end
+
+  describe "#season" do
+    context "Fall/Winter" do
+      it { expect(described_class.from_date("2011-08-06").season).to eq "Fall/Winter" }
+      it { expect(described_class.from_date("2011-09-06").season).to eq "Fall/Winter" }
+      it { expect(described_class.from_date("2011-10-06").season).to eq "Fall/Winter" }
+      it { expect(described_class.from_date("2011-11-06").season).to eq "Fall/Winter" }
+      it { expect(described_class.from_date("2011-12-06").season).to eq "Fall/Winter" }
+      it { expect(described_class.from_date("2012-01-06").season).to eq "Fall/Winter" }
+    end
+
+    context "Spring/Summer" do
+      it { expect(described_class.from_date("2011-02-06").season).to eq "Spring/Summer" }
+      it { expect(described_class.from_date("2011-03-06").season).to eq "Spring/Summer" }
+      it { expect(described_class.from_date("2011-04-06").season).to eq "Spring/Summer" }
+      it { expect(described_class.from_date("2011-05-06").season).to eq "Spring/Summer" }
+      it { expect(described_class.from_date("2011-06-06").season).to eq "Spring/Summer" }
+      it { expect(described_class.from_date("2011-07-06").season).to eq "Spring/Summer" }
+    end
+  end
+
+
+  context "logic" do
+    [
+      OpenStruct.new(date: "2011-05-01", year: 2011, month: 5,  week: 1, quarter: 4, year_week: 14, start_date: "2011-01-30"),
+
+      OpenStruct.new(date: "2014-08-31", year: 2014, month: 9,  week: 1, quarter: 1, year_week: 31, start_date: "2014-02-02"),
+      OpenStruct.new(date: "2017-12-30", year: 2017, month: 12, week: 5, quarter: 2, year_week: 48, start_date: "2017-01-29"),
+      OpenStruct.new(date: "2014-01-01", year: 2013, month: 12, week: 5, quarter: 2, year_week: 48, start_date: "2013-02-03"),
+      OpenStruct.new(date: "2014-01-04", year: 2013, month: 12, week: 5, quarter: 2, year_week: 48, start_date: "2013-02-03"),
+      OpenStruct.new(date: "2014-01-05", year: 2013, month: 1,  week: 1, quarter: 2, year_week: 49, start_date: "2013-02-03"),
+      OpenStruct.new(date: "2014-01-12", year: 2013, month: 1,  week: 2, quarter: 2, year_week: 50, start_date: "2013-02-03"),
+      OpenStruct.new(date: "2014-01-19", year: 2013, month: 1,  week: 3, quarter: 2, year_week: 51, start_date: "2013-02-03"),
+      OpenStruct.new(date: "2014-01-26", year: 2013, month: 1,  week: 4, quarter: 2, year_week: 52, start_date: "2013-02-03"),
+
+      # 2013
+      OpenStruct.new(date: "2013-02-03", year: 2013, month: 2,  week: 1, quarter: 3, year_week: 1,  start_date: "2013-02-03"),
+
+      # 2014
+      OpenStruct.new(date: "2014-02-02", year: 2014, month: 2,  week: 1, quarter: 3, year_week: 1,  start_date: "2014-02-02"),
+      OpenStruct.new(date: "2015-01-31", year: 2014, month: 1,  week: 4, quarter: 2, year_week: 52, start_date: "2014-02-02"),
+
+      OpenStruct.new(date: "2014-02-01", year: 2013, month: 1,  week: 4, quarter: 2, year_week: 52, start_date: "2013-02-03"),
+
+      OpenStruct.new(date: "2015-02-01", year: 2015, month: 2,  week: 1, quarter: 3, year_week: 1, start_date: "2015-02-01"),
+
+    ].each do |date_check|
+
+      context "using date '#{date_check.date}'" do
+        let(:merch_week) { described_class.from_date(date_check.date) }
+
+        it "#year_week" do
+          expect(merch_week.year_week).to eq date_check.year_week
+        end
+
+        it "#month" do
+          expect(merch_week.month).to eq date_check.month
+        end
+
+        it "#quarter" do
+          expect(merch_week.quarter).to eq date_check.quarter
+        end
+
+        it "#week" do
+          expect(merch_week.week).to eq date_check.week
+        end
+
+        it "#start_of_year" do
+          expect(merch_week.start_of_year.to_s).to eq date_check.start_date
+        end
+
+        it "#year" do
+          expect(merch_week.year).to eq date_check.year
+        end
+      end
+    end
+  end
+
+end

data/spec/merch_calendar/util_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe MerchCalendar::Util do
+
+  describe "#weeks_for_month" do
+    context "correct number of weeks" do
+      it "returns 4 weeks for a 4-week month" do
+        weeks = MerchCalendar.weeks_for_month(2014, 4)
+        expect(weeks.size).to eq 4
+      end
+      
+      it "returns 5 weeks for a 5-week month" do
+        weeks = MerchCalendar.weeks_for_month(2014, 3)
+        expect(weeks.size).to eq 5
+      end
+
+      it "returns 5 weeks for a 4-week end month if leap year" do
+        weeks = MerchCalendar.weeks_for_month(2012, 1)
+        expect(weeks.size).to eq 5
+
+        weeks = MerchCalendar.weeks_for_month(2014, 1)
+        expect(weeks.size).to eq 4
+      end
+    end
+
+    context "gives correct weeks" do
+      let!(:weeks) { MerchCalendar.weeks_for_month(2014,1) }
+      
+      it "misc checks" do
+        expect(weeks.size).to eq 4
+      end
+
+      it "#week" do
+        expect(weeks[0].week).to eq 1
+        expect(weeks[1].week).to eq 2
+        expect(weeks[2].week).to eq 3
+        expect(weeks[3].week).to eq 4
+      end
+
+      it "#date" do
+        expect(weeks[0].date).to eq Date.new(2015,1,4)
+        expect(weeks[1].date).to eq Date.new(2015,1,11)
+        expect(weeks[2].date).to eq Date.new(2015,1,18)
+        expect(weeks[3].date).to eq Date.new(2015,1,25)
+      end
+
+      it "#start_of_week" do
+        expect(weeks[0].start_of_week).to eq Date.new(2015,1,4)
+        expect(weeks[1].start_of_week).to eq Date.new(2015,1,11)
+        expect(weeks[2].start_of_week).to eq Date.new(2015,1,18)
+        expect(weeks[3].start_of_week).to eq Date.new(2015,1,25)
+      end
+      
+      it "#start_of_year" do
+        expect(weeks.map(&:start_of_year)).to all( eq Date.new(2014,2,2) )
+      end
+
+      it "#end_of_year" do
+        expect(weeks.map(&:end_of_year)).to all( eq Date.new(2015,1,31) )
+      end
+
+      it "#month" do
+        expect(weeks.map(&:month)).to all( eq 1 )
+      end
+
+    end
+  end
+
+  describe '#get_merch_month_param' do
+    let(:date_calc) { MerchCalendar::DateCalculator.new }
+    before(:each) do
+      allow(MerchCalendar).to receive(:date_calc).and_return(date_calc)
+    end
+
+    context "valid calls" do
+      before(:each) do
+        expect(date_calc).to receive(:start_of_month).with(2014, 1)
+      end      
+      it "assumes an integer is a julian month" do
+        MerchCalendar.start_of_month(2014, 2)
+      end
+
+      context "when passed a hash" do
+        it "accepts :month as julian month" do
+          MerchCalendar.start_of_month(2014, month: 2)
+        end
+
+        it "accepts :julian_month as julian month" do
+          MerchCalendar.start_of_month(2014, julian_month: 2)
+        end
+
+        it "accepts :merch_month as merch month" do
+          MerchCalendar.start_of_month(2014, merch_month: 1)
+        end
+      end
+    end
+
+    context "errors" do
+      before(:each) do
+        expect(date_calc).to_not receive(:start_of_month)
+      end
+      it { expect { MerchCalendar.start_of_month(2014, :april) }.to raise_error(ArgumentError) }
+    end
+  end
+end

data/spec/merch_calendar_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe MerchCalendar do
+  context "responds to util methods" do
+    [
+      :start_of_month, :end_of_month,
+      :start_of_year, :end_of_year,
+      :start_of_quarter, :end_of_quarter,
+      :merch_to_julian,
+      :julian_to_merch,
+      :weeks_in_year,
+      :weeks_for_month
+    ].each do |method_name|
+      it "responds to the #{method_name} method" do
+        expect(described_class).to respond_to(method_name)
+      end
+    end
+  end
+
+
+  it "#start_of_month" do
+    expect(described_class.start_of_month(2014,1)).to be_a Date
+  end
+
+  it "#end_of_month" do
+    expect(described_class.end_of_month(2014,1)).to be_a Date
+  end
+
+  it "#start_of_year" do
+    expect(described_class.start_of_year(2014)).to be_a Date
+  end
+
+  it "#end_of_year" do
+    expect(described_class.end_of_year(2014)).to be_a Date
+  end
+
+
+  it "#start_of_quarter" do
+    expect(described_class.start_of_quarter(2014,1)).to be_a Date
+  end
+
+  it "#end_of_quarter" do
+    expect(described_class.end_of_quarter(2014,1)).to be_a Date
+  end
+
+  it "#weeks_in_year" do
+    expect(described_class.weeks_in_year(2014)).to be_a Fixnum
+  end
+
+
+  it "#merch_to_julian" do
+    expect(described_class.merch_to_julian(1)).to be_a Fixnum
+  end
+  it "#julian_to_merch" do
+    expect(described_class.julian_to_merch(1)).to be_a Fixnum
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "pry"
+require "merch_calendar"
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks_config|
+    mocks_config.verify_doubled_constant_names = true
+    mocks_config.verify_partial_doubles = true
+  end
+end