spok 1.0.0

data/lib/spok/version.rb

@@ -0,0 +1,3 @@
+class Spok
+  VERSION = "1.0.0"
+end

data/lib/spok/workday.rb

@@ -0,0 +1,117 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'set'
+require 'yaml'
+
+class Spok
+  # Public: Various methods useful for checking for restdays and workdays.
+  # All methods are module methods and should be called on the Spok::Workday
+  # module.
+  module Workday
+    # Public: Array of available calendars.
+    CALENDARS = %i(brasil bovespa)
+
+    # Public: Hash containing all holidays for each available calendar.
+    HOLIDAYS = CALENDARS.map do |calendar|
+      holidays_file = File.open(File.join(File.dirname(__FILE__), "config/#{calendar}.yml"))
+      holidays = YAML.safe_load(holidays_file.read, [Date])
+      [calendar, Set.new(holidays[calendar.to_s])]
+    end.to_h
+
+    # Public: Checks if a given day is a restday.
+    #
+    # date     - The Date to be checked.
+    # calendar - Symbol informing in which calendar the date will be checked
+    #            (default: :brasil).
+    #
+    # Examples
+    #
+    #   Spok::Workday.restday?(Date.new(2012, 8, 6))
+    #   # => false
+    #
+    # Returns a boolean.
+    def self.restday?(date, calendar: :brasil)
+      self.weekend?(date) || self.holiday?(date, calendar: calendar)
+    end
+
+    # Public: Checks if a given day is a workday.
+    #
+    # date     - The Date to be checked.
+    # calendar - Symbol informing in which calendar the date will be checked
+    #            (default: :brasil).
+    #
+    # Examples
+    #
+    #   Spok::Workday.workday?(Date.new(2012, 8, 6))
+    #   # => true
+    #
+    # Returns a boolean.
+    def self.workday?(date, calendar: :brasil)
+      !restday?(date, calendar: calendar)
+    end
+
+    # Public: Checks if a given Date is on a weekend.
+    #
+    # date - The Date to be checked.
+    #
+    # Examples
+    #
+    #   Spok::Workday.weekend?(Date.new(2012, 8, 6))
+    #   # => false
+    #
+    # Returns a boolean.
+    def self.weekend?(date)
+      weekday = date.wday
+
+      weekday == 0 || weekday == 6
+    end
+
+    # Public: Checks if a given Date is on a holiday.
+    #
+    # date     - The Date to be checked.
+    # calendar - Symbol informing in which calendar the date will be checked
+    #            (default: :brasil).
+    #
+    # Examples
+    #
+    #   Spok::Workday.holiday?(Date.new(2012, 5, 1))
+    #   # => true
+    #
+    # Returns a boolean.
+    def self.holiday?(date, calendar: :brasil)
+      HOLIDAYS[calendar].include?(date.to_date)
+    end
+
+    # Public: Returns the last workday until the informed date.
+    # It returns the informed date in case it is a workday.
+    #
+    # date     - End Date to check for workdays.
+    # calendar - Symbol informing in which calendar to check for workdays
+    #            (default: :brasil).
+    #
+    # Examples
+    #   Spok::Workday.last_workday(Date.new(2012, 10, 21))
+    #   # => #<Date: 2012-10-19 ((2456220j,0s,0n),+0s,2299161j)>
+    def self.last_workday(date, calendar: :brasil)
+      return date if workday?(date, calendar: calendar)
+
+      last_workday((date - 1.day), calendar: calendar)
+    end
+
+    # Public: Returns the next workday starting from the informed date.
+    # It returns the informed date in case it is a workday.
+    #
+    # date     - Start Date to check for workdays.
+    # calendar - Symbol informing in which calendar to check for workdays
+    #            (default: :brasil).
+    #
+    # Examples
+    #   Spok::Workday.next_workday(Date.new(2012, 10, 21))
+    #   # => #<Date: 2012-10-19 ((2456220j,0s,0n),+0s,2299161j)>
+    def self.next_workday(date, calendar: :brasil)
+      return date if workday?(date, calendar: calendar)
+
+      next_workday((date + 1.day), calendar: calendar)
+    end
+  end
+end

data/spec/lib/spok/workday_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+require 'spok/workday'
+
+describe Spok::Workday do
+  describe '#workday?' do
+    context 'monday' do
+      it 'is a workday' do
+        expect(described_class.workday?(Date.new(2012, 8, 6))).to eq(true)
+      end
+    end
+
+    context 'saturday' do
+      it 'is not a workday' do
+        expect(described_class.workday?(Date.new(2012, 8, 4))).to eq(false)
+      end
+    end
+
+    context 'sunday' do
+      it 'is not a workday' do
+        expect(described_class.workday?(Date.new(2012, 8, 5))).to eq(false)
+      end
+    end
+
+    context 'holidays using brasil calendar' do
+      it 'is not a workday' do
+        ['2012-06-07', '2012-09-07', '2012-10-12',
+         '2012-11-02', '2012-11-15', '2012-12-25'].each do |holiday|
+          expect(described_class.workday?(Date.parse(holiday))).to eq(false)
+        end
+      end
+    end
+
+    context 'holidays using bovespa calendar' do
+      it 'is not a workday' do
+        ['2012-07-09', '2012-11-20', '2012-12-24'].each do |holiday|
+          expect(described_class.workday?(Date.parse(holiday), calendar: :bovespa)).to eq(false)
+        end
+      end
+    end
+
+  end
+
+  describe '#restday?' do
+    context 'Using Date objects' do
+      context 'monday' do
+        it 'is not a restday' do
+          expect(described_class.restday?(Date.new(2012, 8, 6))).to eq(false)
+        end
+      end
+
+      context 'saturday' do
+        it 'is a restday' do
+          expect(described_class.restday?(Date.new(2012, 8, 4))).to eq(true)
+        end
+      end
+
+      context 'sunday' do
+        it 'is a restday' do
+          expect(described_class.restday?(Date.new(2012, 8, 5))).to eq(true)
+        end
+      end
+
+      context 'holiday' do
+        [
+          Date.new(2012, 6, 07),
+          Date.new(2012, 9, 07),
+          Date.new(2012, 10, 12),
+          Date.new(2012, 11, 02),
+          Date.new(2012, 11, 15),
+          Date.new(2012, 12, 25)
+        ].each do |holiday|
+          it 'is a restday' do
+            expect(described_class.restday?(holiday)).to eq(true)
+          end
+        end
+      end
+    end
+
+    context 'using DateTime objects' do
+      context 'monday' do
+        it 'is not a restday' do
+          expect(described_class.restday?(DateTime.new(2012, 8, 6, 12))).to eq(false)
+        end
+      end
+
+      context 'saturday' do
+        it 'is a restday' do
+          expect(described_class.restday?(DateTime.new(2012, 8, 4, 12))).to eq(true)
+        end
+      end
+
+      context 'sunday' do
+        it 'is a restday' do
+          expect(described_class.restday?(DateTime.new(2012, 8, 5, 13))).to eq(true)
+        end
+      end
+
+      context 'holiday' do
+        [
+          DateTime.new(2017, 01, 01, 00),
+          DateTime.new(2017, 10, 12, 01),
+          DateTime.new(2017, 11, 02, 02),
+          DateTime.new(2017, 11, 15, 03),
+          DateTime.new(2017, 12, 25, 04)
+        ].each do |holiday|
+          it 'is a restday' do
+            expect(described_class.restday?(holiday)).to eq(true)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#weekend?' do
+    it 'returns true when date is a Saturday' do
+      expect(described_class.weekend?(Date.new(2018, 8, 11))).to eq(true)
+    end
+
+    it 'returns true when date is a Sunday' do
+      expect(described_class.weekend?(Date.new(2018, 8, 12))).to eq(true)
+    end
+
+    it 'returns false when date is not a Saturday or Sunday' do
+      expect(described_class.weekend?(Date.new(2018, 8, 13))).to eq(false)
+      expect(described_class.weekend?(Date.new(2018, 8, 14))).to eq(false)
+      expect(described_class.weekend?(Date.new(2018, 8, 15))).to eq(false)
+      expect(described_class.weekend?(Date.new(2018, 8, 16))).to eq(false)
+      expect(described_class.weekend?(Date.new(2018, 8, 17))).to eq(false)
+    end
+  end
+
+  describe '#holiday?' do
+    it 'returns false when date is not a holiday on the given calendar' do
+      expect(described_class.holiday?(Date.new(2018, 05, 02), calendar: :brasil)).to eq(false)
+      expect(described_class.holiday?(Date.new(2018, 12, 15), calendar: :bovespa)).to eq(false)
+    end
+
+    it 'returns true when date is a holiday on the given calendar' do
+      expect(described_class.holiday?(Date.new(2018, 05, 01), calendar: :brasil)).to eq(true)
+      expect(described_class.holiday?(Date.new(2018, 12, 25), calendar: :bovespa)).to eq(true)
+    end
+  end
+
+  describe '#last_workday' do
+    context 'when date is 2012-10-25 (Thursday)' do
+      it 'returns the same date' do
+        expect(described_class.last_workday(Date.new(2012, 10, 25))).to eq(Date.new(2012, 10, 25))
+      end
+    end
+
+    context 'when date is 2012-10-21 (Sunday)' do
+      it 'returns 2012-10-19 (Friday)' do
+        expect(described_class.last_workday(Date.new(2012, 10, 21))).to eq(Date.new(2012, 10, 19))
+      end
+    end
+
+    context 'when date is 2012-10-20 (Saturday)' do
+      it 'returns 2012-10-19 (Friday)' do
+        expect(described_class.last_workday(Date.new(2012, 10, 20))).to eq(Date.new(2012, 10, 19))
+      end
+    end
+
+    context 'when bovespa calendar' do
+      context 'when date is 2013-01-01 (bovespa holiday)' do
+        it 'returns 2012-12-30,  because 2012-12-31 is also a bovespa holiday and 2012-01-30|29 is a weekend' do
+          expect(described_class.last_workday(Date.new(2013, 1, 1), calendar: :bovespa)).to eq(Date.new(2012, 12, 28))
+        end
+      end
+    end
+  end
+
+  describe '#next_workday' do
+    context 'when date is 2012-10-26 (Friday)' do
+      it 'returns the same date' do
+        expect(described_class.next_workday(Date.new(2012, 10, 26))).to eq(Date.new(2012, 10, 26))
+      end
+    end
+
+    context 'when date is 2012-10-21 (Sunday)' do
+      it 'returns 2012-10-22 (Monday)' do
+        expect(described_class.next_workday(Date.new(2012, 10, 21))).to eq(Date.new(2012, 10, 22))
+      end
+    end
+
+    context 'when date is 2012-10-20 (Saturday)' do
+      it 'returns 2012-10-22 (Monday)' do
+        expect(described_class.next_workday(Date.new(2012, 10, 20))).to eq(Date.new(2012, 10, 22))
+      end
+    end
+
+    context 'when bovespa calendar' do
+      context 'when date is 2012-12-30 (sunday)' do
+        it 'returns 2013-01-02, because 2012, 12, 31 and 2013-01-01 are bovespa holidays' do
+          expect(described_class.next_workday(Date.new(2012, 12, 30), calendar: :bovespa)).to eq(Date.new(2013, 1, 2))
+        end
+      end
+    end
+  end
+end

data/spec/lib/spok_spec.rb

@@ -0,0 +1,209 @@
+require 'spec_helper'
+require 'spok'
+
+describe Spok do
+  let(:sunday) { Date.new(2012, 1, 1) }
+  let(:monday) { Date.new(2012, 1, 2) }
+  let(:tuesday) { Date.new(2012, 1, 3) }
+
+  subject(:spok) { described_class.new(sunday, tuesday) }
+
+  describe '.parse' do
+    it { expect(described_class.parse('20120101-20120103')).to eq(spok) }
+
+    context 'when the input string is wrong' do
+      it { expect(described_class.parse('20120101')).to be_nil }
+      it { expect(described_class.parse(nil)).to be_nil }
+      it { expect(described_class.parse('')).to be_nil }
+    end
+  end
+
+  describe '#initialize' do
+    it 'does not raise error when start date is before or equals to the end date' do
+      expect { subject }.not_to raise_error
+      expect { described_class.new(sunday, sunday) }.not_to raise_error
+    end
+
+    it 'raises exception when the start date is nil' do
+      expect { described_class.new(nil, sunday) }.to raise_error(ArgumentError)
+    end
+
+    it 'raises exception when the end date is nil' do
+      expect { described_class.new(tuesday, nil) }.to raise_error(ArgumentError)
+    end
+
+    it 'raises exception when the start date is greater than the end date' do
+      expect { described_class.new(tuesday, sunday) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#date_as_integer' do
+    it 'represents the start date as integer' do
+      expect(subject.start_date_as_integer).to eq(20120101)
+    end
+
+    it 'represents the end date as integer' do
+      expect(subject.end_date_as_integer).to eq(20120103)
+    end
+  end
+
+  describe '#date_as_string' do
+    it 'represents the start date as string' do
+      expect(subject.start_date_as_string).to eq('20120101')
+    end
+
+    it 'represents the end date as string' do
+      expect(subject.end_date_as_string).to eq('20120103')
+    end
+  end
+
+  describe '#to_s' do
+    it 'successfully converts Spok to String' do
+      expect(spok.to_s).to eq('20120101-20120103')
+    end
+  end
+
+  describe '#workdays' do
+    subject(:spok) { described_class.new(sunday, wednesday) }
+
+    let(:sunday) { Date.new(2013, 7, 7) }
+    let(:monday) { Date.new(2013, 7, 8) }
+    let(:bovespa_holiday) { Date.new(2013, 7, 9) }
+    let(:wednesday) { Date.new(2013, 7, 10) }
+
+    it 'returns all workdays when no calendar is selected' do
+      expect(spok.workdays).to eq([monday, bovespa_holiday, wednesday])
+    end
+
+    it 'returns only bovespa workdays when bovespa calendar is selected' do
+      expect(subject.workdays(:bovespa)).to eq([monday, wednesday])
+    end
+  end
+
+  describe '#to_calendar' do
+    context 'when bovespa is the calendar' do
+      subject { described_class.new(sunday, tuesday).to_calendar(:bovespa) }
+      context 'and start date on a bovespa holiday' do
+        let(:start_date) { Date.new(2013, 7, 8) }
+        let(:sunday)      { Date.new(2013, 7, 9) } # bovespa holiday
+        let(:tuesday)      { Date.new(2013, 7, 11) }
+        it 'returns the last bovespa workday as the start date' do
+          expect(subject.start_date).to eq(start_date)
+        end
+      end
+
+      context 'and end date on a bovespa holiday' do
+        let(:sunday)    { Date.new(2013, 7, 7) }
+        let(:tuesday)    { Date.new(2013, 7, 9) } # bovespa holiday
+        let(:end_date) { Date.new(2013, 7, 8) }
+        it 'returns the last bovespa workday as the end date' do
+          expect(subject.end_date).to eq(end_date)
+        end
+      end
+
+      context 'and start and end date on a bovespa holiday' do
+        let(:sunday)    { Date.new(2012, 12, 31) } #bovespa holiday
+        let(:tuesday)    { Date.new(2013, 1, 1) } # bovespa holiday
+        it 'start and end date are going to be the same' do
+          expect(subject.start_date).to eq(subject.end_date)
+        end
+      end
+    end
+
+    context 'when brasil is the calendar' do
+      subject { described_class.new(sunday, tuesday).to_calendar(:brasil) }
+
+      context 'and the start date is holiday' do
+        let(:start_date) { Date.new(2013, 9, 6) }
+        let(:sunday)      { Date.new(2013, 9, 7) } # brasil holiday
+        let(:tuesday)      { Date.new(2013, 9, 10) }
+        it 'returns the last workday as the start date' do
+          expect(subject.start_date).to eq(start_date)
+        end
+      end
+
+      context 'end date on a bovespa holiday' do
+        let(:sunday)    { Date.new(2013, 9, 5) }
+        let(:tuesday)    { Date.new(2013, 9, 7) } # brasil holiday
+        let(:end_date) { Date.new(2013, 9, 6) }
+        it 'returns the last bovespa workday as the end date' do
+          expect(subject.end_date).to eq(end_date)
+        end
+      end
+    end
+  end
+
+  describe '#one_day?' do
+    context 'when the start and end date are the same' do
+      let(:tuesday)    { sunday }
+      it { expect(subject).to be_one_day }
+    end
+
+    context 'when the start and end date are different' do
+      it { expect(subject).not_to be_one_day }
+    end
+  end
+
+  describe '#days_count' do
+    it 'counts number of days on spok' do
+      spok = described_class.new(sunday, tuesday)
+
+      expect(spok.days_count).to eq(2)
+    end
+
+    it 'returns 0 when start date is equal to the end date' do
+      spok = described_class.new(sunday, sunday)
+
+      expect(spok.days_count).to eq(0)
+    end
+  end
+
+  describe '#years_count' do
+    let(:start_date) { Date.new(2013, 1, 1) }
+
+    it 'calculates integer result' do
+      end_date = Date.new(2014, 1, 1)
+
+      expect(described_class.new(start_date, end_date).years_count).to eq(1)
+    end
+
+    it 'calculates fraction result' do
+      spok = described_class.new(start_date, Date.new(2014, 7, 1))
+      greater_spok = described_class.new(start_date, Date.new(2014, 9, 1))
+
+      expect(spok.years_count).to eq(1.5)
+      expect(greater_spok.years_count).to eq(1.7)
+    end
+  end
+
+  describe '#==' do
+    let(:spok) { Spok.new(sunday, tuesday) }
+
+    context 'when spoks are equal' do
+      let(:other_spok) { Spok.new(sunday, tuesday) }
+
+      it { expect(spok == other_spok).to eq(true) }
+    end
+
+    context 'when spoks are not equal' do
+      let(:other_spok) { Spok.new(sunday, monday) }
+
+      it { expect(spok == other_spok).to eq(false) }
+    end
+
+    context 'when the comparison does respond to start date' do
+      let(:other_spok) { double(:other_spok, :end_date => double(:end_date)) }
+      it { expect(spok == other_spok).to eq(false) }
+    end
+
+    context 'when the comparison does respond to end date' do
+      let(:other_spok) { double(:other_spok, :start_date => sunday) }
+      it { expect(spok == other_spok).to eq(false) }
+    end
+  end
+
+  describe '#to_range' do
+    subject { Spok.new(sunday, tuesday).to_range }
+    it { is_expected.to eq((sunday..tuesday)) }
+  end
+end