timeboss 0.0.10 → 0.1.0

data/lib/timeboss/calendar/week.rb

@@ -3,27 +3,38 @@ require_relative './support/unit'
 
 module TimeBoss
   class Calendar
+    # Representation of a single week within a calendar.
     class Week < Support::Unit
       def initialize(calendar, start_date, end_date)
         super(calendar, start_date, end_date)
       end
 
+      # Get a simple representation of this week.
+      # @return [String] (e.g. "2020W32")
       def name
         "#{year_index}W#{index}"
       end
 
+      # Get a "pretty" representation of this week.
+      # @return [String] (e.g. "Week of August 3, 2020")
       def title
         "Week of #{start_date.strftime('%B %-d, %Y')}"
       end
 
+      # Get a stringified representation of this week.
+      # @return [String] (e.g. "2020W32: 2020-08-03 thru 2020-08-09")
       def to_s
         "#{name}: #{start_date} thru #{end_date}"
       end
 
+      # Get the index of this week within its containing year.
+      # @return [Integer]
       def index
         @_index ||= (((start_date - year.start_date) + 1) / 7.0).to_i + 1
       end
 
+      # Get the year number for this week.
+      # @return [Integer] (e.g. 2020)
       def year_index
         @_year_index ||= year.year_index
       end

data/lib/timeboss/calendar/year.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
-require_relative './support/month_based'
+require_relative './support/monthly_unit'
 
 module TimeBoss
   class Calendar
-    class Year < Support::MonthBased
+    # Representation of a 12-month period within a calendar.
+    class Year < Support::MonthlyUnit
       NUM_MONTHS = 12
 
+      # Get a simple representation of this year.
+      # @return [String] (e.g. "2020")
       def name
         year_index.to_s
       end
 
-      def title
-        name
-      end
+      alias_method :title, :name
     end
   end
 end

data/lib/timeboss/calendars.rb

@@ -5,17 +5,23 @@ require_relative 'calendar'
 Dir[File.expand_path('../calendars/*.rb', __FILE__)].each { |f| require f }
 
 module TimeBoss
+  # A home for specific calendar implementations.
   module Calendars
     extend self
     extend Enumerable
     delegate :each, :length, to: :all
 
+    # Retrieve a list of all registered calendars.
+    # @return [Array<Entry>]
     def all
       @_all ||= TimeBoss::Calendar.subclasses.map do |klass|
         Entry.new(klass.to_s.demodulize.underscore.to_sym, klass)
       end
     end
 
+    # Retrieve an instance of the specified named calendar.
+    # @param name [String, Symbol] the name of the calendar to retrieve.
+    # @return [Calendar]
     def [](name)
       find { |e| e.name == name&.to_sym }&.calendar
     end
@@ -23,6 +29,16 @@ module TimeBoss
     private
 
     Entry = Struct.new(:name, :klass) do
+      # @!method name
+      # Get the name of the calendar referenced in this entry.
+      # @return [Symbol]
+
+      # @!method klass
+      # The class implementing this calendar.
+      # @return [Class<Calendar>]
+
+      # Get an instance of the calendar referenced in this entry.
+      # @return [Calendar]
       def calendar
         @_calendar ||= klass.new
       end

data/lib/timeboss/version.rb

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

data/spec/calendar/support/{month_based_spec.rb → monthly_unit_spec.rb}

@@ -1,15 +1,15 @@
 module TimeBoss
   class Calendar
     module Support
-      describe MonthBased do
-        class ChunkMonthBased < described_class
+      describe MonthlyUnit do
+        class MonthBasedChunk < described_class
           NUM_MONTHS = 2
 
           def name
             "#{year_index}C#{index}"
           end
         end
-        let(:described_class) { ChunkMonthBased }
+        let(:described_class) { MonthBasedChunk }
         let(:calendar) { double }
         let(:start_date) { Date.parse('2018-06-25') }
         let(:end_date) { Date.parse('2018-08-26') }
@@ -51,24 +51,24 @@ module TimeBoss
 
           describe '#previous' do
             it 'moves easily within itself' do
-              expect(calendar).to receive(:chunk_month_based).with(48, 3).and_return result
+              expect(calendar).to receive(:month_based_chunk).with(48, 3).and_return result
               expect(described_class.new(calendar, 48, 4, nil, nil).previous).to eq result
             end
 
             it 'flips to the previous container' do
-              expect(calendar).to receive(:chunk_month_based).with(47, 6).and_return result
+              expect(calendar).to receive(:month_based_chunk).with(47, 6).and_return result
               expect(described_class.new(calendar, 48, 1, nil, nil).previous).to eq result
             end
           end
 
           describe '#next' do
             it 'moves easily within itself' do
-              expect(calendar).to receive(:chunk_month_based).with(48, 3).and_return result
+              expect(calendar).to receive(:month_based_chunk).with(48, 3).and_return result
               expect(described_class.new(calendar, 48, 2, nil, nil).next).to eq result
             end
 
             it 'flips to the previous container' do
-              expect(calendar).to receive(:chunk_month_based).with(48, 1).and_return result
+              expect(calendar).to receive(:month_based_chunk).with(48, 1).and_return result
               expect(described_class.new(calendar, 47, 6, nil, nil).next).to eq result
             end
           end

data/spec/calendars/broadcast_spec.rb

@@ -133,8 +133,8 @@ module TimeBoss
           expect(quarters.map(&:name)).to eq ['2015Q3', '2015Q4', '2016Q1', '2016Q2', '2016Q3']
         end
 
-        it 'can get a quarter hence' do
-          quarter = subject.quarters_hence(4)
+        it 'can get a quarter ahead' do
+          quarter = subject.quarters_ahead(4)
           expect(quarter).to be_a TimeBoss::Calendar::Quarter
           expect(quarter.name).to eq '2016Q3'
         end
@@ -271,8 +271,8 @@ module TimeBoss
           expect(months.map(&:name)).to eq ['2015M3', '2015M4', '2015M5', '2015M6', '2015M7']
         end
 
-        it 'can get a month hence' do
-          month = subject.months_hence(4)
+        it 'can get a month ahead' do
+          month = subject.months_ahead(4)
           expect(month).to be_a TimeBoss::Calendar::Month
           expect(month.name).to eq '2015M7'
         end
@@ -510,7 +510,7 @@ module TimeBoss
       it 'can parse mathematic expressions' do
         result = subject.parse('this_month + 2')
         expect(result).to be_a TimeBoss::Calendar::Month
-        expect(result).to eq subject.months_hence(2)
+        expect(result).to eq subject.months_ahead(2)
       end
 
       context 'ranges' do
@@ -574,7 +574,7 @@ module TimeBoss
 
         it 'can shift to a different year' do
           allow(subject).to receive(:this_year).and_return subject.parse('2019')
-          result = basis.years_hence(3)
+          result = basis.years_ahead(3)
           expect(result).to be_a TimeBoss::Calendar::Day
           expect(result.to_s).to eq '2022-04-19'
           expect(basis.in_year).to eq 114
@@ -616,7 +616,7 @@ module TimeBoss
 
         it 'can shift to a different year' do
           allow(subject).to receive(:this_year).and_return subject.parse('2020')
-          result = basis.years_hence(4)
+          result = basis.years_ahead(4)
           expect(result).to be_a TimeBoss::Calendar::Month
           expect(result.name).to eq '2024M4'
           expect(basis.in_year).to eq 4

data/timeboss.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Broadcast Calendar navigation in Ruby made simple
 email:
 - kevinstuffandthings@gmail.com
@@ -121,12 +135,59 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/tbsh
+- doc/TimeBoss.html
+- doc/TimeBoss/Calendar.html
+- doc/TimeBoss/Calendar/Day.html
+- doc/TimeBoss/Calendar/Half.html
+- doc/TimeBoss/Calendar/Month.html
+- doc/TimeBoss/Calendar/Parser.html
+- doc/TimeBoss/Calendar/Period.html
+- doc/TimeBoss/Calendar/Quarter.html
+- doc/TimeBoss/Calendar/Support.html
+- doc/TimeBoss/Calendar/Support/Formatter.html
+- doc/TimeBoss/Calendar/Support/MonthBased.html
+- doc/TimeBoss/Calendar/Support/MonthBasis.html
+- doc/TimeBoss/Calendar/Support/MonthlyUnit.html
+- doc/TimeBoss/Calendar/Support/Navigable.html
+- doc/TimeBoss/Calendar/Support/Shiftable.html
+- doc/TimeBoss/Calendar/Support/Unit.html
+- doc/TimeBoss/Calendar/Waypoints.html
+- doc/TimeBoss/Calendar/Waypoints/Absolute.html
+- doc/TimeBoss/Calendar/Waypoints/Relative.html
+- doc/TimeBoss/Calendar/Week.html
+- doc/TimeBoss/Calendar/Year.html
+- doc/TimeBoss/Calendars.html
+- doc/TimeBoss/Calendars/Broadcast.html
+- doc/TimeBoss/Calendars/Broadcast/Basis.html
+- doc/TimeBoss/Calendars/Entry.html
+- doc/TimeBoss/Support.html
+- doc/TimeBoss/Support/Shellable.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/tasks/calendars.rake
 - lib/tasks/timeboss.rake
 - lib/timeboss.rb
@@ -137,13 +198,16 @@ files:
 - lib/timeboss/calendar/parser.rb
 - lib/timeboss/calendar/period.rb
 - lib/timeboss/calendar/quarter.rb
+- lib/timeboss/calendar/support.rb
 - lib/timeboss/calendar/support/formatter.rb
-- lib/timeboss/calendar/support/month_based.rb
 - lib/timeboss/calendar/support/month_basis.rb
+- lib/timeboss/calendar/support/monthly_unit.rb
 - lib/timeboss/calendar/support/navigable.rb
 - lib/timeboss/calendar/support/shiftable.rb
 - lib/timeboss/calendar/support/unit.rb
 - lib/timeboss/calendar/waypoints.rb
+- lib/timeboss/calendar/waypoints/absolute.rb
+- lib/timeboss/calendar/waypoints/relative.rb
 - lib/timeboss/calendar/week.rb
 - lib/timeboss/calendar/year.rb
 - lib/timeboss/calendars.rb
@@ -152,7 +216,7 @@ files:
 - lib/timeboss/version.rb
 - spec/calendar/day_spec.rb
 - spec/calendar/quarter_spec.rb
-- spec/calendar/support/month_based_spec.rb
+- spec/calendar/support/monthly_unit_spec.rb
 - spec/calendar/support/unit_spec.rb
 - spec/calendar/week_spec.rb
 - spec/calendars/broadcast_spec.rb
@@ -178,15 +242,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Broadcast Calendar navigation in Ruby made simple
 test_files:
 - spec/calendar/day_spec.rb
 - spec/calendar/quarter_spec.rb
-- spec/calendar/support/month_based_spec.rb
+- spec/calendar/support/monthly_unit_spec.rb
 - spec/calendar/support/unit_spec.rb
 - spec/calendar/week_spec.rb
 - spec/calendars/broadcast_spec.rb