timeboss 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d4c953bb1ef449bdc7d37f0ac3061da752b28a9f4df8c1901f9507c447ac89b
-  data.tar.gz: 752abd38f0afee607b6529894eec4189dfbbc462f5a27ddb4a6238720db35b4e
+  metadata.gz: cfac166bdd92d5f95689183603c5af386100642526cea8cbc405765655a1eb26
+  data.tar.gz: 00dfb8323ed9317cb214f532a7431bb9dc40d0ca3027ecda5f922bf72949ff0d
 SHA512:
-  metadata.gz: b1d04714bcb3514b386fda20f1aaad42f1db96382719848ef9ee5cf889b5c855a26bbb6c6039f50e08ce2484194924ceb8a2ee32f0242b1e3bbc928a9156a0b8
-  data.tar.gz: 1662c699fc80d9b37744a2f7f4fffa5d72e64d912bab4e19b1d113ba466a16201c003e32b26d1d8697da8c2feb21d4e16be344bc2bacdb2358f2a46ed6646c49
+  metadata.gz: bf61f841ed2aa51150656da6d849b01a44511e478a8a0012e0074ec9a85fee8569a0bd162c22f3105b33d565c863df556bbee8bb65ea8d9b938272ff4b702b76
+  data.tar.gz: 1dff56f1577ab2e91eb4b5fcfee2928979c261ae02812eec1d2ab0c8788bd7078fbba7f95aec56c830f219d3c07f92513402cd3bb9035233283ffabdcb17fb0e

data/.replit

@@ -0,0 +1,2 @@
+language = "ruby"
+run = "bundle exec rake timeboss:calendars:broadcast:repl"

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# 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) [![Run on Repl.it](https://repl.it/badge/github/kevinstuffandthings/timeboss)](https://repl.it/github/kevinstuffandthings/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.
 
@@ -135,12 +135,12 @@ period = calendar.parse('2020W3..2020Q1')
 
 The examples above are just samples. Try different periods, operators, etc. All of the non-week-based operations will work similarly on the `TimeBoss::Calendars::Gregorian` calendar.
 
-### Shell
-To open an IRB shell for the broadcast calendar, use the `tbsh` executable, or the `timeboss:calendars:broadcast:shell` rake task.
+### REPL
+To open a REPL for the broadcast calendar, use the `tbsh` executable, or the `timeboss:calendars:broadcast:repl` rake task.
 
 For the Gregorian calendar (or any other implemented calendars), supply the name on the command line.
 - `tbsh gregorian`
-- `rake timeboss:calendars:gregorian:shell`
+- `rake timeboss:calendars:gregorian:repl`
 
 You will find yourself in the context of an instantiated `TimeBoss::Calendar` object:
 
@@ -154,7 +154,7 @@ $ tbsh
  => ["2020M7", "2020M8", "2020M9", "2020M10", "2020M11", "2020M12", "2021M1", "2021M2", "2021M3", "2021M4", "2021M5", "2021M6", "2021M7", "2021M8", "2021M9"]
 ```
 
-_Having trouble with the shell? If you are using the examples from the [Usage](#Usage) section, keep in mind that the shell is already in the context of the calendar -- so you don't need to specify the receiver!_
+_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!_
 
 ## Creating new calendars
 To create a custom calendar, simply extend the `TimeBoss::Calendar` class, and implement a new `TimeBoss::Calendar::Support::MonthBasis` for it.
@@ -221,6 +221,10 @@ With the new calendar implemented, it can be accessed in one of 2 ways:
 
     ```ruby
     require 'timeboss/calendars'
+    TimeBoss::Calendars.register(:august_fiscal, MyCalendars::AugustFiscal)
+
+    # You'll get a cached instance of your calendar here.
+    # Handy when switching back and forth between different calendar implementations.
     calendar = TimeBoss::Calendars[:august_fiscal]
     calendar.this_year
     ```

data/lib/tasks/calendars.rake

@@ -9,11 +9,13 @@ namespace :timeboss do
           puts entry.calendar.parse(args[:expression])
         end
 
-        desc "Open a shell with the #{entry.name} calendar"
-        task shell: ['timeboss:init'] do
+        desc "Open a REPL with the #{entry.name} calendar"
+        task repl: ['timeboss:init'] do
           require 'timeboss/support/shellable'
           TimeBoss::Support::Shellable.open(entry.calendar)
         end
+
+        task shell: ["timeboss:calendars:#{entry.name}:repl"]
       end
     end
   end

data/lib/timeboss/calendar.rb

@@ -25,6 +25,7 @@ module TimeBoss
     def name
       self.class.to_s.demodulize.underscore
     end
+    alias_method :to_s, :name
 
     # Get a friendly title for this calendar.
     # @return [String]
@@ -40,6 +41,12 @@ module TimeBoss
       true
     end
 
+    def self.register!
+      return unless TimeBoss::Calendars.method_defined?(:register)
+      TimeBoss::Calendars.register(self.name.to_s.demodulize.underscore, self)
+    end
+    private_class_method :register!
+
     protected
 
     attr_reader :basis

data/lib/timeboss/calendar/parser.rb

@@ -11,7 +11,8 @@ module TimeBoss
       end
 
       def parse(identifier = nil)
-        return parse_identifier(identifier.presence) unless identifier&.include?(RANGE_DELIMITER)
+        return nil unless (identifier || '').strip.length > 0
+        return parse_identifier(identifier) unless identifier&.include?(RANGE_DELIMITER)
         bases = identifier.split(RANGE_DELIMITER).map { |i| parse_identifier(i.strip) } unless identifier.nil?
         bases ||= [parse_identifier(nil)]
         Period.new(calendar, *bases)

data/lib/timeboss/calendar/period.rb

@@ -34,25 +34,96 @@ module TimeBoss
         end
       end
 
+      #
+      # i hate this
+      #
+
+      ### Days
+
+      # @!method days
+      # Get a list of days that fall within this period.
+      # @return [Array<Calendar::Day>]
+
+      # @!method day(index = nil)
+      # Get the day this period represents.
+      # Returns nil if no single day can be identified.
+      # @return [Array<Calendar::Day>, nil]
+
+      ### Weeks
+
+      # @!method weeks
+      # Get a list of weeks that fall within this period.
+      # @return [Array<Calendar::Week>]
+
+      # @!method week(index = nil)
+      # Get the week this period represents.
+      # Returns nil if no single week can be identified.
+      # @return [Array<Calendar::Week>, nil]
+
+      ### Months
+
+      # @!method months
+      # Get a list of months that fall within this period.
+      # @return [Array<Calendar::Month>]
+
+      # @!method month(index = nil)
+      # Get the month this period represents.
+      # Returns nil if no single month can be identified.
+      # @return [Array<Calendar::Month>, nil]
+
+      ### Quarters
+
+      # @!method quarters
+      # Get a list of quarters that fall within this period.
+      # @return [Array<Calendar::Quarter>]
+
+      # @!method quarter(index = nil)
+      # Get the quarter this period represents.
+      # Returns nil if no single quarter can be identified.
+      # @return [Array<Calendar::Quarter>, nil]
+
+      ### Halves
+
+      # @!method halves
+      # Get a list of halves that fall within this period.
+      # @return [Array<Calendar::Half>]
+
+      # @!method half(index = nil)
+      # Get the half this period represents.
+      # Returns nil if no single half can be identified.
+      # @return [Array<Calendar::Half>, nil]
+
+      ### Years
+
+      # @!method years
+      # Get a list of years that fall within this period.
+      # @return [Array<Calendar::Year>]
+
+      # @!method year(index = nil)
+      # Get the year this period represents.
+      # Returns nil if no single year can be identified.
+      # @return [Array<Calendar::Year>, nil]
+
+      # Does this period cover the current date?
+      # @return [Boolean]
+      def current?
+        to_range.include?(Date.today)
+      end
+
       %w[day week month quarter half year].each do |size|
         define_method(size.pluralize) do
           entry = calendar.send("#{size}_for", self.begin.start_date)
           build_entries entry
         end
 
-        define_method(size) do
+        define_method(size) do |index = nil|
           entries = send(size.pluralize)
+          return entries[index - 1] unless index.nil?
           return nil unless entries.length == 1
           entries.first
         end
       end
 
-      # Does this period cover the current date?
-      # @return [Boolean]
-      def current?
-        to_range.include?(Date.today)
-      end
-
       # Express this period as a date range.
       # @return [Range<Date, Date>]
       def to_range

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

@@ -2,6 +2,8 @@ module TimeBoss
   class Calendar
     module Support
       # @abstract
+      # A MonthBasis must define a `#start_date` and `#end_date` method.
+      # These methods should be calculated based on the incoming `#year` and `#month` values.
       class MonthBasis
         attr_reader :year, :month
 

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

@@ -10,8 +10,9 @@ module TimeBoss
 
           define_method(periods) { calendar.send("#{periods}_for", self) }
 
-          define_method(period) do
+          define_method(period) do |index = nil|
             entries = send(periods)
+            return entries[index - 1] unless index.nil?
             return nil unless entries.length == 1
             entries.first
           end
@@ -27,7 +28,7 @@ module TimeBoss
         # Get a list of days that fall within this unit.
         # @return [Array<Calendar::Day>]
 
-        # @!method day
+        # @!method day(index = nil)
         # Get the day this unit represents.
         # Returns nil if no single day can be identified.
         # @return [Array<Calendar::Day>, nil]
@@ -38,7 +39,7 @@ module TimeBoss
         # Get a list of weeks that fall within this unit.
         # @return [Array<Calendar::Week>]
 
-        # @!method week
+        # @!method week(index = nil)
         # Get the week this unit represents.
         # Returns nil if no single week can be identified.
         # @return [Array<Calendar::Week>, nil]
@@ -49,7 +50,7 @@ module TimeBoss
         # Get a list of months that fall within this unit.
         # @return [Array<Calendar::Month>]
 
-        # @!method month
+        # @!method month(index = nil)
         # Get the month this unit represents.
         # Returns nil if no single month can be identified.
         # @return [Array<Calendar::Month>, nil]
@@ -60,7 +61,7 @@ module TimeBoss
         # Get a list of quarters that fall within this unit.
         # @return [Array<Calendar::Quarter>]
 
-        # @!method quarter
+        # @!method quarter(index = nil)
         # Get the quarter this unit represents.
         # Returns nil if no single quarter can be identified.
         # @return [Array<Calendar::Quarter>, nil]
@@ -71,7 +72,7 @@ module TimeBoss
         # Get a list of halves that fall within this unit.
         # @return [Array<Calendar::Half>]
 
-        # @!method half
+        # @!method half(index = nil)
         # Get the half this unit represents.
         # Returns nil if no single half can be identified.
         # @return [Array<Calendar::Half>, nil]
@@ -82,7 +83,7 @@ module TimeBoss
         # Get a list of years that fall within this unit.
         # @return [Array<Calendar::Year>]
 
-        # @!method year
+        # @!method year(index = nil)
         # Get the year this unit represents.
         # Returns nil if no single year can be identified.
         # @return [Array<Calendar::Year>, nil]

data/lib/timeboss/calendars.rb

@@ -1,28 +1,33 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/class/subclasses'
 require_relative 'calendar'
 
-Dir[File.expand_path('../calendars/*.rb', __FILE__)].each { |f| require f }
-
 module TimeBoss
   module Calendars
     extend self
     extend Enumerable
     delegate :each, :length, to: :all
 
+    # Register a new calendar
+    # @return [Entry]
+    def register(name, klass)
+      Entry.new(name.to_sym, klass).tap do |entry|
+        (@entries ||= {})[name.to_sym] = entry
+      end
+    end
+
     # 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
+      return if @entries.nil?
+      @entries.values.sort_by { |e| e.name.to_s }
     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
+      return if @entries.nil?
+      @entries[name&.to_sym]&.calendar
     end
 
     private
@@ -44,3 +49,5 @@ module TimeBoss
     end
   end
 end
+
+Dir[File.expand_path('../calendars/*.rb', __FILE__)].each { |f| require f }

data/lib/timeboss/calendars/broadcast.rb

@@ -4,6 +4,8 @@ require_relative '../calendar'
 module TimeBoss
   module Calendars
     class Broadcast < Calendar
+      register!
+
       def initialize
         super(basis: Basis)
       end

data/lib/timeboss/calendars/gregorian.rb

@@ -4,6 +4,8 @@ require_relative '../calendar'
 module TimeBoss
   module Calendars
     class Gregorian < Calendar
+      register!
+
       def initialize
         super(basis: Basis)
       end

data/lib/timeboss/version.rb

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

data/spec/calendars/broadcast_spec.rb

@@ -493,10 +493,9 @@ module TimeBoss
         expect(date.end_date).to eq Date.parse('2017-04-08')
       end
 
-      it 'gives you this year if you give it nothing' do
-        year = subject.this_year
-        expect(subject.parse(nil)).to eq year
-        expect(subject.parse('')).to eq year
+      it 'gives you nothing if you give it nothing' do
+        expect(subject.parse(nil)).to be nil
+        expect(subject.parse('')).to be nil
       end
     end
 

data/spec/calendars/gregorian_spec.rb

@@ -475,10 +475,9 @@ module TimeBoss
         expect(date.end_date).to eq Date.parse('2017-04-08')
       end
 
-      it 'gives you this year if you give it nothing' do
-        year = subject.this_year
-        expect(subject.parse(nil)).to eq year
-        expect(subject.parse('')).to eq year
+      it 'gives you nothing if you give it nothing' do
+        expect(subject.parse(nil)).to be nil
+        expect(subject.parse('')).to be nil
       end
     end
 

data/spec/calendars_spec.rb

@@ -1,11 +1,13 @@
 module TimeBoss
   describe Calendars do
-    class MyTestCalendar < TimeBoss::Calendar
+    class MyCal < TimeBoss::Calendar
       def initialize
         super(basis: nil)
       end
     end
 
+    TimeBoss::Calendars.register(:my_amazing_calendar, MyCal)
+
     describe '#all' do
       let(:all) { described_class.all }
 
@@ -17,7 +19,7 @@ module TimeBoss
 
       context 'enumerability' do
         it 'can get a list of names' do
-          expect(described_class.map(&:name)).to include(:broadcast, :my_test_calendar)
+          expect(described_class.map(&:name)).to include(:broadcast, :my_amazing_calendar)
         end
       end
     end
@@ -34,10 +36,10 @@ module TimeBoss
       end
 
       it 'can return a new calendar' do
-        c1 = described_class[:my_test_calendar]
-        expect(c1).to be_instance_of MyTestCalendar
-        expect(c1.name).to eq 'my_test_calendar'
-        expect(c1.title).to eq 'My Test Calendar'
+        c1 = described_class[:my_amazing_calendar]
+        expect(c1).to be_instance_of MyCal
+        expect(c1.name).to eq 'my_cal'
+        expect(c1.title).to eq 'My Cal'
       end
 
       it 'can graceully give you nothing' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
+- ".replit"
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"