merch_calendar 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03d1ef8749bf05803819f78ae5b53330c5556401
-  data.tar.gz: 229bd27912548d1064dfcc67eac8a45050411af4
+  metadata.gz: 753130ad5089afe3bbf400936388243467903ece
+  data.tar.gz: c070388ae4bc90740a312caa54af3c973f38c5d7
 SHA512:
-  metadata.gz: 69a83b60890605d93cc33896bbb927313975396d833cc7377de66e52061fcda98ea20884c4ce19b3f6a50b0befd506b8a018c15c176dbb4be7a35d66f4f62216
-  data.tar.gz: ab095357f4b3ef7fbb07733d374ed387b39a399c4680916b5238c0dcc870732d6a6bfddd71b0e6afc10e95252d2e4e2b465b522e7f8db443086e6c27be93a83e
+  metadata.gz: 2309d87f9066582a29f97c1c5bcff1c87ae6beaabc74586ad221f889c7092b5f3787d6948942364bab59441d625a869c60a1cce5c865286072875edc8530837b
+  data.tar.gz: 07d1d3dff25f45f0a7ca81e308c8e1cf27ec455088238e130f9b2131745628c43175bf50e5937f0d41f885d008ba456a17f08c9f963341463ad387a33d9bf6ae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    merch_calendar (0.0.3)
+    merch_calendar (0.0.4)
 
 GEM
   remote: https://www.rubygems.org/

data/README.md

@@ -1,7 +1,7 @@
 # Merch Calendar
 
 [![Gem Version](https://badge.fury.io/rb/merch_calendar.svg)](http://badge.fury.io/rb/merch_calendar)
-[![Build Status](https://travis-ci.org/stitchfix/merch_calendar.svg)](https://travis-ci.org/stitchfix/merch_calendar)
+[![Build Status](https://travis-ci.org/stitchfix/merch_calendar.svg?branch=master)](https://travis-ci.org/stitchfix/merch_calendar)
 [![Code Climate](https://codeclimate.com/github/stitchfix/merch_calendar/badges/gpa.svg)](https://codeclimate.com/github/stitchfix/merch_calendar)
 [![Coverage Status](https://coveralls.io/repos/stitchfix/merch_calendar/badge.svg)](https://coveralls.io/r/stitchfix/merch_calendar)
 
@@ -73,6 +73,44 @@ MerchCalendar.start_of_month(2014, julian_month: 5)
 MerchCalendar.start_of_month(2014, merch_month: 4)
 ```
 
+#### Confusing things to look out for:
+
+Merch calendars have the first month in February, and the last (12th) month is in January of the following year. In the code block above, each method is *asking* a very different question. This will definitely cause confusion, so here are some explanations.
+
+```ruby
+# This is asking "In the Merch year of 2014, where is the month of January?"
+# January is the last (12th) month of a merch year, so this date will be in the NEXT
+# julian calendar year
+MerchCalendar.start_of_month(2014, 1)
+MerchCalendar.start_of_month(2014, month: 1)
+MerchCalendar.start_of_month(2014, julian_month: 1)
+# => 2015-01-04
+#    ^^^^ - NEXT year
+
+# This is asking "When is the start of the FIRST month of the merch year 2014"
+MerchCalendar.start_of_month(2014, merch_month: 1)
+# => 2014-02-02
+
+```
+
+This table should describe the progression of dates:
+
+| N  | `start_of_month(2014, N)` | `start_of_month(2014, merch_month: N)` |
+| ------------- | ------------- | ------------- |
+| 1  | **2015-01-04**  | 2014-02-02 |
+| 2  | 2014-02-02  | 2014-03-02 |
+| 3  | 2014-03-02  | 2014-04-06 |
+| 4  | 2014-04-06  | 2014-05-04 |
+| 5  | 2014-05-04  | 2014-06-01 |
+| 6  | 2014-06-01  | 2014-07-06 |
+| 7  | 2014-07-06  | 2014-08-03 |
+| 8  | 2014-08-03  | 2014-08-31 |
+| 9  | 2014-08-31  | 2014-10-05 |
+| 10  | 2014-10-05  | 2014-11-02 |
+| 11  | 2014-11-02  | 2014-11-30 |
+| 12  | 2014-11-30  | **2015-01-04** |
+
+
 Other useful methods:
 
 ```ruby

data/lib/merch_calendar/date_calculator.rb

@@ -98,6 +98,18 @@ module MerchCalendar
       end
     end
 
-
+    def merch_months_in(start_date, end_date)
+      merch_months = []
+      prev_date = start_date - 2
+      date = start_date
+      while date <= end_date do
+        date = MerchCalendar.start_of_month(date.year, merch_month: date.month)
+        next if prev_date == date
+        merch_months.push(date)
+        prev_date = date
+        date += 14
+      end
+      merch_months
+    end
   end
-end
+end

data/lib/merch_calendar/util.rb

@@ -87,6 +87,16 @@ module MerchCalendar
     end
 
 
+    # An array of merch dates in start_date to end_date
+    #
+    # @param start_date [Date] the start date
+    # @param end_date [Date] the end date
+    #
+    # @return [Array<Date>] array of merch months
+    def merch_months_in(start_date, end_date)
+      date_calc.merch_months_in(start_date, end_date)
+    end
+
 
     # Converts a merch month to the correct julian month
     #

data/lib/merch_calendar/version.rb

@@ -1,3 +1,3 @@
 module MerchCalendar
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/merch_calendar/date_calculator_spec.rb

@@ -48,5 +48,43 @@ describe MerchCalendar::DateCalculator do
 
   it "#end_of_quarter"
 
+  describe "#merch_months_in" do
+    it "returns merch date for start_date if start_date is the same as end_date" do
+      start_date = Date.new(2014,8,1)
+      end_date = start_date
+      start_merch_date = MerchCalendar.start_of_month(start_date.year, merch_month: start_date.month)
+
+      merch_months = subject.merch_months_in(start_date, end_date)
+      expect(merch_months.count).to be(1)
+      expect(merch_months.first.year).to eq start_merch_date.year
+      expect(merch_months.first.month).to eq start_merch_date.month
+      expect(merch_months.first.day).to eq start_merch_date.day
+    end
+
+    it "returns valid merch dates for 2014" do
+      start_date = Date.new(2014, 1, 1)
+      end_date = Date.new(2014, 12, 1)
+
+      merch_months = subject.merch_months_in(start_date, end_date)
+      expect(merch_months.count).to be 11
+
+      merch_months.each do |merch_month|
+        expect(merch_month.year).to be 2014
+      end
+
+      expect(merch_months[0].strftime('%Y-%m-%d')).to eq  '2014-02-02'
+      expect(merch_months[1].strftime('%Y-%m-%d')).to eq  '2014-03-02'
+      expect(merch_months[2].strftime('%Y-%m-%d')).to eq  '2014-04-06'
+      expect(merch_months[3].strftime('%Y-%m-%d')).to eq  '2014-05-04'
+      expect(merch_months[4].strftime('%Y-%m-%d')).to eq  '2014-06-01'
+      expect(merch_months[5].strftime('%Y-%m-%d')).to eq  '2014-07-06'
+      expect(merch_months[6].strftime('%Y-%m-%d')).to eq  '2014-08-03'
+      expect(merch_months[7].strftime('%Y-%m-%d')).to eq  '2014-08-31'
+      expect(merch_months[8].strftime('%Y-%m-%d')).to eq  '2014-10-05'
+      expect(merch_months[9].strftime('%Y-%m-%d')).to eq  '2014-11-02'
+      expect(merch_months[10].strftime('%Y-%m-%d')).to eq '2014-11-30'
+    end
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merch_calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mitch Dempsey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Utility for manipulating dates within a 4-5-4 retail calendar