timeboss 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b27f1fec825b8ddb084a029a0621d939bd2525a67f33879611dfc36f6a722d4c
-  data.tar.gz: 93fb0c6366dab6a4e577c1507d8cb99ddbb952ebfeea5ec67f134d1ba0c33c14
+  metadata.gz: c8b4b4481ef5554103855a604563c4db3a4deddb298af24a219315f1a658c7ba
+  data.tar.gz: 8be65df968e3a044a81cf492f3be16a03e9d79a61fb80ac6ff4218c8a5b71aa3
 SHA512:
-  metadata.gz: dab7d412003da6fd0b753e49a46c8d877f15cf802997fa3ad172ad48b2fd571aeb9288572254bf8b4a9289f4eccdaef2f6cc1d88e4a0d0512beea946022fe7df
-  data.tar.gz: 197ae44718c8dca52c091d90ab6c0a80f0e45d3207b095ff8194801b06481f20efabb6612ba822270c682429da12b16c0e08c87b91ff7e0b72440dcf8b3573ee
+  metadata.gz: df28f604bbea294960ff8131b65b5b3315bf2cd2c2663866ee3b28e208abc25ef7811535482931620d4886ec8b39249967ed38cfa63cf4a865eba6ea31f11022
+  data.tar.gz: 8b8f043b358f21970af342263154ac3bcd40f9322b37c7e7c0587740c703214e77798e8b28ff56d627c9b6bab3f5306bb1e6e21ca52dd7589fa2d6e450a75178

data/README.md

@@ -1,5 +1,7 @@
 # TimeBoss [![Build Status](https://travis-ci.com/kevinstuffandthings/timeboss.svg?branch=master)](https://travis-ci.com/kevinstuffandthings/timeboss) [![Gem Version](https://badge.fury.io/rb/timeboss.svg)](https://badge.fury.io/rb/timeboss)
-A gem providing convenient navigation of the [Broadcast Calendar](https://en.wikipedia.org/wiki/Broadcast_calendar).
+
+A gem providing convenient navigation of the [Broadcast Calendar](https://en.wikipedia.org/wiki/Broadcast_calendar), the standard Gregorian calendar, and is easily extensible to support multiple financial calendars.
+
 Originally developed for [Simulmedia](https://simulmedia.com).
 
 ## Installation

data/lib/timeboss/calendar.rb

@@ -32,6 +32,10 @@ module TimeBoss
       name.titleize
     end
 
+    def supports_weeks?
+      false
+    end
+
     protected
 
     attr_reader :basis

data/lib/timeboss/calendar/support/formatter.rb

@@ -14,6 +14,7 @@ module TimeBoss
         def initialize(unit, periods)
           @unit = unit
           @periods = PERIODS & periods.map(&:to_sym).push(unit.class.type.to_sym)
+          @periods -= [:week] unless unit.calendar.supports_weeks?
         end
 
         def to_s

data/lib/timeboss/calendar/support/unit.rb

@@ -13,6 +13,8 @@ module TimeBoss
         include Shiftable
         attr_reader :calendar, :start_date, :end_date
 
+        UnsupportedUnitError = Class.new(StandardError)
+
         def self.type
           self.name.demodulize.underscore
         end

data/lib/timeboss/calendar/week.rb

@@ -5,6 +5,7 @@ module TimeBoss
   class Calendar
     class Week < Support::Unit
       def initialize(calendar, start_date, end_date)
+        raise UnsupportedUnitError unless calendar.supports_weeks?
         super(calendar, start_date, end_date)
       end
 

data/lib/timeboss/calendars/broadcast.rb

@@ -8,6 +8,10 @@ module TimeBoss
         super(basis: Basis)
       end
 
+      def supports_weeks?
+        true
+      end
+
       private
 
       class Basis < Calendar::Support::MonthBasis

data/lib/timeboss/calendars/gregorian.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require_relative '../calendar'
+
+module TimeBoss
+  module Calendars
+    class Gregorian < Calendar
+      def initialize
+        super(basis: Basis)
+      end
+
+      private
+
+      class Basis < Calendar::Support::MonthBasis
+        def start_date
+          @_start_date ||= Date.civil(year, month, 1)
+        end
+
+        def end_date
+          @_end_date ||= Date.civil(year, month, -1)
+        end
+      end
+    end
+  end
+end

data/lib/timeboss/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module TimeBoss
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/calendar/support/monthly_unit_spec.rb

@@ -30,6 +30,7 @@ module TimeBoss
           before(:each) { allow(calendar).to receive(:year).with(2018).and_return base }
 
           it 'can get the relevant weeks for the period' do
+            allow(calendar).to receive(:supports_weeks?).and_return true
             result = subject.weeks
             result.each { |w| expect(w).to be_instance_of TimeBoss::Calendar::Week }
             expect(result.map { |w| w.start_date.to_s }).to eq [
@@ -44,6 +45,11 @@ module TimeBoss
               '2018-08-20'
             ]
           end
+
+          it 'blows up when weeks are not supported' do
+            allow(calendar).to receive(:supports_weeks?).and_return false
+            expect { subject.weeks }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+          end
         end
 
         context 'navigation' do

data/spec/calendar/week_spec.rb

@@ -1,11 +1,16 @@
 module TimeBoss
   class Calendar
     describe Week do
-      let(:calendar) { instance_double(TimeBoss::Calendar) }
+      let(:calendar) { instance_double(TimeBoss::Calendar, supports_weeks?: true) }
       let(:start_date) { Date.parse('2048-04-06') }
       let(:end_date) { Date.parse('2048-04-12') }
       let(:subject) { described_class.new(calendar, start_date, end_date) }
 
+      it "doesn't even exist if its calendar doesn't support weeks" do
+        allow(calendar).to receive(:supports_weeks?).and_return false
+        expect { subject }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+      end
+
       it 'knows its stuff' do
         expect(subject.start_date).to eq start_date
         expect(subject.end_date).to eq end_date

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin McDonald
@@ -166,6 +166,7 @@ files:
 - lib/timeboss/calendar/year.rb
 - lib/timeboss/calendars.rb
 - lib/timeboss/calendars/broadcast.rb
+- lib/timeboss/calendars/gregorian.rb
 - lib/timeboss/support/shellable.rb
 - lib/timeboss/version.rb
 - spec/calendar/day_spec.rb