merch_calendar 0.1.0.rc1 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb41f5342b94855990d76a316fd9fe32a059e2ea
-  data.tar.gz: d16f77b34c7c286fae1a71795d00a2e87d034f8e
+  metadata.gz: 4258c9ca91b7427a13a40d020ea448f7a0bce7d3
+  data.tar.gz: e5892f68ea348e3901339aebdd186200773333bc
 SHA512:
-  metadata.gz: 0523a60e48200560bfe2218f7bdfb05e41fe99d83460654ccc192b2229cc0ca6fded1fd2504c10c5c053879e6c4187e59bee73bef503f67f2730e286a76e0d8b
-  data.tar.gz: 49e67aa34e6f46e62077d735fab174c6684b394c008b50377e9a451711c0b7da7fe18cace1f58790e181b518dc05759e013a58ce1d39f39abd809354e4faa7ea
+  metadata.gz: 50c31a68c19cc6edd3aecf26467788afd0c23d1f688c97d2d08ee1a06ebe2c2ea6cd67445f891a8b6f22371a509a7cb4779023f6d48e6022e54b2c4d1f5e9462
+  data.tar.gz: d5a02533ff081b5d4fe07b3ad80fd882a62834c19a79023351c3c079664b9b169fd5e7cfb2a8c5026aceb81e25e63637280dd0ed13402212df80530e47283e08

data/Gemfile.lock

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

data/README.md

@@ -18,16 +18,6 @@ Add the following line to your `Gemfile`:
 gem "merch_calendar"
 ```
 
-
-## Configuration
-```ruby
-# NOTE: Configuration will be added soon, but is currently NOT available.
-MerchCalendar.configure do |config|
-  # The month that Q1 begins. The default is 8 (August)
-  config.quarter_start_month = 8
-end
-```
-
 ## Usage
 
 For converting a date into a `MerchWeek` object.

data/lib/merch_calendar/util.rb

@@ -1,3 +1,6 @@
+require "merch_calendar/retail_calendar"
+require "merch_calendar/fiscal_year_calendar"
+
 module MerchCalendar
 
   # Utility methods for the merch calendar
@@ -85,7 +88,7 @@ module MerchCalendar
     #
     # @return [Date] the starting date of the specified quarter
     def start_of_quarter(year, quarter)
-      retail_calendar.start_of_quarter(year, quarter)
+      fiscal_year_calendar.start_of_quarter(year + 1, quarter)
     end
 
     # The end date of the quarter
@@ -95,7 +98,7 @@ module MerchCalendar
     #
     # @return [Date] the ending date of the specified quarter
     def end_of_quarter(year, quarter)
-      retail_calendar.end_of_quarter(year, quarter)
+      fiscal_year_calendar.end_of_quarter(year + 1, quarter)
     end
 
 
@@ -175,6 +178,10 @@ module MerchCalendar
       @retail_calendar ||= RetailCalendar.new
     end
 
+    def fiscal_year_calendar
+      @fiscal_year_calendar ||= FiscalYearCalendar.new
+    end
+
     # Reads the provided parameter and converts the value
     # to a MERCH MONTH
     def get_merch_month_param(param)
@@ -199,6 +206,28 @@ module MerchCalendar
   # Load the utils into the MerchCalendar namespace
   class << self
     include Util
+    extend Gem::Deprecate
+
+    [
+      :start_of_week, 
+      :end_of_week,
+      :start_of_month, 
+      :end_of_month,
+      :start_of_year, 
+      :end_of_year,
+      :weeks_in_year,
+      :merch_months_in,
+    ].each do |method|
+      deprecate method, "#{MerchCalendar::RetailCalendar}##{method}", DEPRECATION_DATE.year, DEPRECATION_DATE.month
+    end
+
+    [
+      :start_of_quarter, 
+      :end_of_quarter
+    ].each do |method|
+      deprecate method, "#{MerchCalendar::FiscalYearCalendar}##{method}", DEPRECATION_DATE.year, DEPRECATION_DATE.month
+    end
+
   end
 
 end

data/lib/merch_calendar/version.rb

@@ -1,3 +1,3 @@
 module MerchCalendar
-  VERSION = '0.1.0.rc1'
+  VERSION = '0.1.0.rc2'
 end

data/lib/merch_calendar.rb

@@ -1,13 +1,11 @@
 
 #
 module MerchCalendar
-
+  DEPRECATION_DATE = Date.new(2018, 1, 1)
 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/retail_calendar'
 require_relative 'merch_calendar/fiscal_year_calendar'

data/spec/merch_calendar_spec.rb

@@ -60,40 +60,86 @@ RSpec.describe MerchCalendar do
     end
   end
 
-  it "#start_of_month" do
-    expect(described_class.start_of_month(2014,1)).to be_a Date
+  describe "#start_of_month" do
+    it "returns the correct date for 2017-1" do
+      expect(described_class.start_of_month(2017, 1)).to eq Date.new(2017, 12, 31)
+    end
+
+    it "returns the correct date for 2017-5" do
+      expect(described_class.start_of_month(2017, 5)).to eq Date.new(2017, 4, 30)
+    end
+
+    it "returns the correct date for 2018-1" do
+      expect(described_class.start_of_month(2018, 1)).to eq Date.new(2019, 1, 6)
+    end
   end
 
-  it "#end_of_month" do
-    expect(described_class.end_of_month(2014,1)).to be_a Date
+  describe "#end_of_month" do
+    it "returns the correct date for 2017-1" do
+      expect(described_class.end_of_month(2017, 1)).to eq Date.new(2018, 2, 3)
+    end
+
+    it "returns the correct date for 2017-5" do
+      expect(described_class.end_of_month(2017, 5)).to eq Date.new(2017, 5, 27)
+    end
+
+    it "returns the correct date for 2018-1" do
+      expect(described_class.end_of_month(2018, 1)).to eq Date.new(2019, 2, 2)
+    end
   end
 
-  it "#start_of_year" do
-    expect(described_class.start_of_year(2014)).to be_a Date
+  describe "#start_of_year" do
+    it "returns the correct date for 2014" do
+      expect(described_class.start_of_year(2014)).to eq Date.new(2014, 2, 2)
+    end
+
+    it "returns the correct date for 2017" do
+      expect(described_class.start_of_year(2017)).to eq Date.new(2017, 1, 29)
+    end
   end
 
-  it "#end_of_year" do
-    expect(described_class.end_of_year(2014)).to be_a Date
+  describe "#end_of_year" do
+    it "returns the correct date for 2014" do
+      expect(described_class.end_of_year(2014)).to eq Date.new(2015, 1, 31)
+    end
+
+    it "returns the correct date for 2017" do
+      expect(described_class.end_of_year(2017)).to eq Date.new(2018, 2, 3)
+    end
   end
 
-  it "#start_of_quarter" do
-    expect(described_class.start_of_quarter(2014,1)).to be_a Date
+  describe "#start_of_quarter" do
+    it "returns the correct date for 2014-Q1" do
+      expect(described_class.start_of_quarter(2014,1)).to eq Date.new(2014, 8, 3)
+    end
   end
 
-  it "#end_of_quarter" do
-    expect(described_class.end_of_quarter(2014,1)).to be_a Date
+  describe "#end_of_quarter" do
+    it "returns the correct date for 2014-Q1" do
+      expect(described_class.end_of_quarter(2014,1)).to eq Date.new(2014, 11, 1)
+    end
   end
 
-  it "#weeks_in_year" do
-    expect(described_class.weeks_in_year(2014)).to be_a Fixnum
+  describe "#weeks_in_year" do
+    it "returns the right number of weeks for 2014" do
+      expect(described_class.weeks_in_year(2014)).to eq 52
+    end
+
+    it "returns the right number of weeks for 2017" do
+      expect(described_class.weeks_in_year(2017)).to eq 53
+    end
   end
 
-  it "#merch_to_julian" do
-    expect(described_class.merch_to_julian(1)).to be_a Fixnum
+  describe "#merch_to_julian" do
+    it "returns the right julian month" do
+      expect(described_class.merch_to_julian(1)).to eq 2
+    end
   end
 
-  it "#julian_to_merch" do
-    expect(described_class.julian_to_merch(1)).to be_a Fixnum
+  describe "#julian_to_merch" do
+    it "returns the right merch month" do
+      expect(described_class.julian_to_merch(1)).to eq 12
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -14,4 +14,15 @@ RSpec.configure do |config|
     mocks_config.verify_doubled_constant_names = true
     mocks_config.verify_partial_doubles = true
   end
-end
+
+  config.around do |example|
+    # Hide deprecation warnings within this gem from showing up in tests
+    if Date.today < MerchCalendar::DEPRECATION_DATE
+      Gem::Deprecate.skip_during do
+        example.run
+      end
+    else
+      example.run
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merch_calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Mitch Dempsey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -115,16 +115,12 @@ files:
 - README.md
 - Rakefile
 - lib/merch_calendar.rb
-- lib/merch_calendar/configurable.rb
-- lib/merch_calendar/configuration.rb
 - lib/merch_calendar/fiscal_year_calendar.rb
 - lib/merch_calendar/merch_week.rb
 - lib/merch_calendar/retail_calendar.rb
 - lib/merch_calendar/util.rb
 - lib/merch_calendar/version.rb
 - merch_calendar.gemspec
-- spec/merch_calendar/configurable_spec.rb
-- spec/merch_calendar/configuration_spec.rb
 - spec/merch_calendar/fiscal_year_calendar_spec.rb
 - spec/merch_calendar/merch_week_spec.rb
 - spec/merch_calendar/retail_calendar_spec.rb
@@ -156,8 +152,6 @@ signing_key:
 specification_version: 4
 summary: Utility for manipulating dates within a 4-5-4 retail calendar
 test_files:
-- spec/merch_calendar/configurable_spec.rb
-- spec/merch_calendar/configuration_spec.rb
 - spec/merch_calendar/fiscal_year_calendar_spec.rb
 - spec/merch_calendar/merch_week_spec.rb
 - spec/merch_calendar/retail_calendar_spec.rb

data/lib/merch_calendar/configurable.rb

@@ -1,28 +0,0 @@
-module MerchCalendar
-  class << self
-
-    attr_writer :configuration
-
-    # Returns the global configuration object
-    #
-    # @return [Configuration]
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    # Used in initializers to set the global configuration
-    #
-    # @return [void]
-    def configure
-      yield(configuration)
-    end
-
-    # Resets the configuration to default values
-    #
-    # @return [void]
-    def reset_config!
-      @configuration = Configuration.new
-    end
-
-  end
-end

data/lib/merch_calendar/configuration.rb

@@ -1,13 +0,0 @@
-module MerchCalendar
-  # @note WARNING: THIS IS NOT BEING USED YET
-  class Configuration
-
-    # The JULIAN month of the quarter start
-    attr_accessor :quarter_start_month
-
-    def initialize
-      @quarter_start_month = 8
-    end
-
-  end
-end

data/spec/merch_calendar/configurable_spec.rb

@@ -1,19 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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