timeboss 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd2408c9c89006534d10c61c485b8adf4adc5fb8d3fd819ce904ed99c8985db8
-  data.tar.gz: e27776f25a4fae89655cc04c07e91e8b607fcc50eb65090be0e6ecd16349c4e3
+  metadata.gz: 3091d788f78273741aeb0206a87765fed72e3908099c2596b70589740aa63c26
+  data.tar.gz: 2a0cd5b28cc9b05c07d3fe06aef86644876864b7b24eda946105706d0626622f
 SHA512:
-  metadata.gz: 5b7e5694b2955fbf6043d2e52bc8d0e6e15cbedc8fdee19123473b0487f2a9ba48b88b5cf8bd6e0eeb93db2537724e12a9aeb00378e9cad4022dbc9fc01c8887
-  data.tar.gz: aefad770303d38a8d2b31baa406cccee9ababea5b2415d6599ec2645e5fca418c61ccbe8f4b6f4aa29a7ead7aea3200b2bce0b83f58f6e6416fb7fb3c9f38b21
+  metadata.gz: f58a6f56a3bf0cb2f44a00aee3b5a4d09fdbcd4b2cd8b06c2942fa4eefc508b0afff19dd577bef26bd7b5f187ca1ccb380e5efdd5b357da829ad2936d36c12ff
+  data.tar.gz: 5f2b1b5013f49c81e3e5f9066e9e4c3063ddd70231a7199010a79b822bc3531ead0d0bf285d9d045fb0434dcfa6e0a5564aac138a8b25b07e2a374b1c049faf9

data/.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2

data/README.md

@@ -1,4 +1,4 @@
-# TimeBoss ![Build Status](https://github.com/kevinstuffandthings/timeboss/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/timeboss.svg)](https://badge.fury.io/rb/timeboss) [![Run on Repl.it](https://repl.it/badge/github/kevinstuffandthings/timeboss)](https://repl.it/github/kevinstuffandthings/timeboss)
+# TimeBoss ![Build Status](https://github.com/kevinstuffandthings/timeboss/actions/workflows/ruby.yml/badge.svg) [![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), the standard Gregorian calendar, and is easily extensible to support multiple financial calendars.
 
@@ -160,7 +160,7 @@ $ tbsh
 If you want to try things out locally without installing the gem or updating your ruby environment, you can use [Docker](https://docker.com):
 
 ```bash
-$ docker run --rm -it ruby:2.6.6-slim /bin/bash -c "gem install timeboss >/dev/null && tbsh"
+$ docker run --rm -it ruby:3.0-slim /bin/bash -c "gem install timeboss shellable >/dev/null && tbsh"
 ```
 
 _Having trouble with the REPL? If you are using the examples from the [Usage](#Usage) section, keep in mind that the REPL is already in the context of the calendar -- so you don't need to specify the receiver!_
@@ -170,9 +170,14 @@ To create a custom calendar, simply extend the `TimeBoss::Calendar` class, and i
 
 ```ruby
 require 'timeboss/calendar'
+require 'timeboss/calendar/support/has_fiscal_weeks'
 
 module MyCalendars
   class AugustFiscal < TimeBoss::Calendar
+    # The calendar we wish to implement has "fiscal weeks", meaning that the weeks start on
+    # the day of the containing period.
+    include TimeBoss::Calendar::Support::HasFiscalWeeks
+
     def initialize
       # For each calendar, operation, the class will be instantiated with an ordinal value
       # for `year` and `month`. It is the instance's job to translate those ordinals into

data/lib/timeboss/calendar/period.rb

@@ -113,8 +113,10 @@ module TimeBoss
 
       %w[day week month quarter half year].each do |size|
         define_method(size.pluralize) do
-          entry = calendar.public_send("#{size}_for", self.begin.start_date)
-          build_entries entry
+          entry = calendar.public_send("#{size}_for", self.begin.start_date) || self.begin.public_send(size, 1)
+          entries = build_entries(entry)
+          entries.pop if size == "week" && self.end.next.public_send(size, 1) == entries.last
+          entries
         end
 
         define_method(size) do |index = nil|

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TimeBoss
+  class Calendar
+    module Support
+      module HasFiscalWeeks
+        def weeks_in(year:)
+          num_weeks = (((year.end_date - year.start_date) + 1) / 7.0).to_i
+          num_weeks.times.map do |i|
+            start_date = year.start_date + (i * 7).days
+            Week.new(self, start_date, start_date + 6.days)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TimeBoss
+  class Calendar
+    module Support
+      module HasIsoWeeks
+        def weeks_in(year:)
+          weeks = []
+          start_date = Date.commercial(year.year_index)
+          end_date = Date.commercial(year.next.year_index)
+          while start_date < end_date
+            weeks << Week.new(self, start_date, start_date + 6.days)
+            start_date += 7.days
+          end
+          weeks
+        end
+
+        class Week < Calendar::Week
+          def index
+            start_date.cweek
+          end
+
+          def year
+            calendar.year(start_date.cwyear)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,10 +23,9 @@ module TimeBoss
         # Get a list of weeks contained within this period.
         # @return [Array<Week>]
         def weeks
+          raise UnsupportedUnitError unless calendar.supports_weeks?
           base = calendar.year(year_index)
-          num_weeks = (((base.end_date - base.start_date) + 1) / 7.0).to_i
-          num_weeks.times.map { |i| Week.new(calendar, base.start_date + (i * 7).days, base.start_date + ((i * 7) + 6).days) }
-            .select { |w| w.start_date.between?(start_date, end_date) }
+          calendar.weeks_in(year: base).select { |w| (w.dates & dates).count >= 4 }
         end
 
         private

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

@@ -87,6 +87,12 @@ module TimeBoss
         def inspect
           "#<#{self.class.name} start_date=#{start_date}, end_date=#{end_date}>"
         end
+
+        protected
+
+        def dates
+          @_dates ||= to_range.to_a
+        end
       end
     end
   end

data/lib/timeboss/calendar.rb

@@ -35,11 +35,11 @@ module TimeBoss
     end
 
     # Can this calendar support weeks?
-    # For custom calendars, this value can generally not be overridden.
-    # But for calendars like our Gregorian implementation, weeks are irrelevant, and should be suppressed.
+    # To support weeks, a calendar must implement a `#weeks_in(year:)` method that returns an array of
+    # `Calendar::Week` objects.
     # @return [Boolean]
     def supports_weeks?
-      true
+      respond_to?(:weeks_in)
     end
 
     def self.register!

data/lib/timeboss/calendars/broadcast.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "../calendar"
+require_relative "../calendar/support/has_fiscal_weeks"
 
 module TimeBoss
   module Calendars
     class Broadcast < Calendar
+      include Support::HasFiscalWeeks
       register!
 
       def initialize

data/lib/timeboss/calendars/gregorian.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
 
 require_relative "../calendar"
+require_relative "../calendar/support/has_iso_weeks"
 
 module TimeBoss
   module Calendars
     class Gregorian < Calendar
+      include Support::HasIsoWeeks
       register!
 
       def initialize
         super(basis: Basis)
       end
 
-      def supports_weeks?
-        false
-      end
-
       private
 
       class Basis < Calendar::Support::MonthBasis

data/lib/timeboss/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TimeBoss
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/timeboss.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_support/isolated_execution_state"
 require "timeboss/version"
 
 # TimeBoss

data/spec/calendar/support/monthly_unit_spec.rb

@@ -11,7 +11,7 @@ module TimeBoss
 
       describe MonthlyUnit do
         let(:described_class) { TestMonthBasedChunk }
-        let(:calendar) { double }
+        let(:calendar) { double(supports_weeks?: false, weeks_in: nil) }
         let(:start_date) { Date.parse("2018-06-25") }
         let(:end_date) { Date.parse("2018-08-26") }
         let(:subject) { described_class.new(calendar, 2018, 4, start_date, end_date) }
@@ -27,29 +27,34 @@ module TimeBoss
         end
 
         describe "#weeks" do
-          let(:base) { double(start_date: Date.parse("2018-01-01"), end_date: Date.parse("2018-12-30")) }
-          before(:each) { allow(calendar).to receive(:year).with(2018).and_return base }
+          let(:supports_weeks) { false }
+          before(:each) { allow(calendar).to receive(:supports_weeks?).and_return supports_weeks }
 
-          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 [
-              "2018-06-25",
-              "2018-07-02",
-              "2018-07-09",
-              "2018-07-16",
-              "2018-07-23",
-              "2018-07-30",
-              "2018-08-06",
-              "2018-08-13",
-              "2018-08-20"
-            ]
+          context "unsupported" do
+            it "blows up when weeks are not supported" do
+              expect { subject.weeks }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+            end
           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
+          context "supported" do
+            let(:supports_weeks) { true }
+            let(:base) { double(start_date: Date.parse("2018-01-01"), end_date: Date.parse("2018-12-30")) }
+            let(:weeks) do
+              ["2018-04-19", "2018-06-25", "2018-07-16", "2018-08-20", "2018-09-30"].map do |date|
+                start_date = Date.parse(date)
+                TimeBoss::Calendar::Week.new(calendar, start_date, start_date + 6.days)
+              end
+            end
+            before(:each) do
+              allow(calendar).to receive(:year).with(2018).and_return base
+              allow(calendar).to receive(:weeks_in).with(year: base).and_return weeks
+            end
+
+            it "can get the relevant weeks for the period" do
+              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 ["2018-06-25", "2018-07-16", "2018-08-20"]
+            end
           end
         end
 

data/spec/calendars/gregorian_spec.rb

@@ -1,7 +1,6 @@
 module TimeBoss
   describe Calendars::Gregorian do
-    let(:subject) { described_class.new }
-
+    subject { described_class.new }
     context "days" do
       it "can get today" do
         day = subject.today
@@ -293,10 +292,80 @@ module TimeBoss
     end
 
     context "weeks" do
-      it "is uninterested in weeks" do
-        expect { subject.this_week }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
-        expect { subject.parse("2020W3") }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
-        expect { subject.weeks_ago(2) }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+      before(:each) { allow(Date).to receive(:today).and_return Date.parse("2019-08-23") }
+
+      it "knows this week " do
+        expect(subject.this_week.name).to eq "2019W34"
+        expect(subject.this_week.title).to eq "Week of August 19, 2019"
+      end
+
+      it "knows last week" do
+        expect(subject.last_week.name).to eq "2019W33"
+        expect(subject.last_week.title).to eq "Week of August 12, 2019"
+      end
+
+      it "knows next week" do
+        expect(subject.next_week.name).to eq "2019W35"
+        expect(subject.next_week.title).to eq "Week of August 26, 2019"
+      end
+
+      describe "over the years" do
+        [
+          [2010, "2010-01-04", 52, "2010-12-27"],
+          [2011, "2011-01-03", 52, "2011-12-26"],
+          [2012, "2012-01-02", 52, "2012-12-24"],
+          [2013, "2012-12-31", 52, "2013-12-23"],
+          [2014, "2013-12-30", 52, "2014-12-22"],
+          [2015, "2014-12-29", 53, "2015-12-28"],
+          [2016, "2016-01-04", 52, "2016-12-26"],
+          [2017, "2017-01-02", 52, "2017-12-25"],
+          [2018, "2018-01-01", 52, "2018-12-24"],
+          [2019, "2018-12-31", 52, "2019-12-23"],
+          [2020, "2019-12-30", 53, "2020-12-28"],
+          [2021, "2021-01-04", 52, "2021-12-27"],
+          [2022, "2022-01-03", 52, "2022-12-26"],
+          [2023, "2023-01-02", 52, "2023-12-25"],
+          [2024, "2024-01-01", 52, "2024-12-23"],
+          [2025, "2024-12-30", 52, "2025-12-22"],
+          [2026, "2025-12-29", 53, "2026-12-28"],
+          [2027, "2027-01-04", 52, "2027-12-27"],
+          [2028, "2028-01-03", 52, "2028-12-25"],
+          [2029, "2029-01-01", 52, "2029-12-24"],
+          [2030, "2029-12-31", 52, "2030-12-23"]
+        ].each do |year_number, first_start, num_weeks, last_start|
+          context "year #{year_number}" do
+            let(:year) { subject.year(year_number) }
+            let(:weeks) { year.weeks }
+
+            it "knows the first week of #{year_number} starts on #{first_start}" do
+              expect(weeks.first.start_date).to eq Date.parse(first_start)
+            end
+
+            it "can navigate to the second week of the year" do
+              week = weeks.first.next
+              expect(week.start_date).to eq Date.parse(first_start) + 7.days
+              expect(week.year).to eq year
+            end
+
+            it "knows that every week is 7 days" do
+              weeks.each { |w| expect(w.end_date - w.start_date).to eq 6 }
+            end
+
+            it "knows there are #{num_weeks} in #{year_number}" do
+              expect(weeks.count).to eq num_weeks
+            end
+
+            it "knows the last week of #{year_number} starts on #{last_start}" do
+              expect(weeks.first.start_date).to eq Date.parse(first_start)
+            end
+
+            it "can navigate to the first week of the next year" do
+              week = weeks.last.next
+              expect(week.start_date).to eq Date.parse(last_start) + 7.days
+              expect(week.year).to eq year.next
+            end
+          end
+        end
       end
     end
 
@@ -394,7 +463,7 @@ module TimeBoss
           let(:entry) { subject.parse("2020D201") }
 
           it "can do a default format" do
-            expect(entry.format).to eq "2020H2Q1M1D19"
+            expect(entry.format).to eq "2020H2Q1M1W3D7"
           end
         end
       end
@@ -449,16 +518,25 @@ module TimeBoss
         expect(date.name).to eq "2017M4"
       end
 
-      it "cannot parse a week within a year" do
-        expect { subject.parse("2018W37") }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+      it "can parse a week within a year" do
+        date = subject.parse("2018W37")
+        expect(date).to be_a TimeBoss::Calendar::Week
+        expect(date).to be_instance_of TimeBoss::Calendars::Gregorian::Week
+        expect(date.name).to eq "2018W37"
       end
 
-      it "cannot parse a week within a quarter" do
-        expect { subject.parse("2017Q2W2") }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+      it "can parse a week within a quarter" do
+        date = subject.parse("2017Q2W2")
+        expect(date).to be_a TimeBoss::Calendar::Week
+        expect(date).to be_instance_of TimeBoss::Calendars::Gregorian::Week
+        expect(date.name).to eq "2017W15"
       end
 
-      it "cannot parse a week within a month" do
-        expect { subject.parse("2017M4W1") }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+      it "can parse a week within a month" do
+        date = subject.parse("2017M4W1")
+        expect(date).to be_a TimeBoss::Calendar::Week
+        expect(date).to be_instance_of TimeBoss::Calendars::Gregorian::Week
+        expect(date.name).to eq "2017W14"
       end
 
       it "can parse a date" do
@@ -518,8 +596,11 @@ module TimeBoss
             expect(entries.map(&:name)).to include("2016M1", "2016M9", "2017M3", "2018M12")
           end
 
-          it "cannot get the weeks included in a range" do
-            expect { result.weeks }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+          it "can get the weeks included in a range" do
+            entries = result.weeks
+            entries.each { |e| expect(e).to be_a TimeBoss::Calendars::Gregorian::Week }
+            expect(entries.count).to eq 156
+            expect(entries.map(&:name)).to include("2016W1", "2016W38", "2017W15", "2017W52", "2018W52")
           end
 
           it "can get the days included in a range" do
@@ -535,9 +616,12 @@ module TimeBoss
       context "from day" do
         let(:basis) { subject.parse("2020-04-21") }
 
-        it "cannot shift to a different week" do
-          expect { basis.last_week }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
-          expect { basis.in_week }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+        it "can shift to a different week" do
+          allow(subject).to receive(:this_week).and_return subject.parse("2020W23")
+          result = basis.last_week
+          expect(result).to be_a TimeBoss::Calendar::Day
+          expect(result.to_s).to eq "2020-05-26"
+          expect(basis.in_week).to eq 2
         end
 
         it "can shift to a different quarter" do
@@ -557,12 +641,37 @@ module TimeBoss
         end
       end
 
+      context "from week" do
+        let(:basis) { subject.parse("2017W8") }
+
+        it "cannot shift to a different day" do
+          expect(basis.last_day).to be nil
+          expect(basis.in_day).to be nil
+        end
+
+        it "can shift to a different month" do
+          allow(subject).to receive(:this_month).and_return subject.parse("2020M4")
+          result = basis.next_month
+          expect(result).to be_a TimeBoss::Calendars::Gregorian::Week
+          expect(result.to_s).to eq "2020W22: 2020-05-25 thru 2020-05-31"
+          expect(basis.in_month).to eq 4
+        end
+
+        it "can shift to a different half" do
+          allow(subject).to receive(:this_half).and_return subject.parse("2019H1")
+          result = basis.last_half
+          expect(result).to be_a TimeBoss::Calendars::Gregorian::Week
+          expect(result.to_s).to eq "2018W34: 2018-08-20 thru 2018-08-26"
+          expect(basis.in_half).to eq 8
+        end
+      end
+
       context "from month" do
         let(:basis) { subject.parse("2017M4") }
 
         it "cannot shift to a different week" do
-          expect { basis.last_week }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
-          expect { basis.in_week }.to raise_error TimeBoss::Calendar::Support::Unit::UnsupportedUnitError
+          expect(basis.last_week).to be nil
+          expect(basis.in_week).to be nil
         end
 
         it "can shift to a different year" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,6 +184,8 @@ files:
 - lib/timeboss/calendar/period.rb
 - lib/timeboss/calendar/quarter.rb
 - lib/timeboss/calendar/support/formatter.rb
+- lib/timeboss/calendar/support/has_fiscal_weeks.rb
+- lib/timeboss/calendar/support/has_iso_weeks.rb
 - lib/timeboss/calendar/support/month_basis.rb
 - lib/timeboss/calendar/support/monthly_unit.rb
 - lib/timeboss/calendar/support/navigable.rb