timeboss 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b6b0fe418ccba6ac446549992d5a9d1317b095afd603fd8517f9f43ddb2754
-  data.tar.gz: 494e8602b7ce8662503ce8720da802a3351a74116e73b6e9cee64c1b8bf82895
+  metadata.gz: 7a66336923993e3b4319dd8d0dc925d936ba7e6897f50f1c679a23f37a35e8f8
+  data.tar.gz: 3925a5fd244c6fac67ba026f0f3738398bc67f6cc75e015f8eea21caf78f5d84
 SHA512:
-  metadata.gz: 82fec7e7f6e798469d99853dc30b6233eb55a55bd8e09d79143be086c790677d8249cbeacb72ab94c6ce20ad9a5dd2d4ecf4f96d3d7c4c65179749c7ae8597ca
-  data.tar.gz: 03a6a53d9b0316ec5074855ed5f240cad7a578a72ce12eda272d6fa6a2a4f70237416814bd3783342849e47e21503fc3e75d3170e79388a58be23244c307d7c6
+  metadata.gz: 87ebf1f8c61e12cd086c33336abca2b5a76ee59cc6117711f166672bd9958c753eb68e38e29ed6aeaccb927520eabaf819da50a62b11879186778f97c982c632
+  data.tar.gz: 5bc4914fb3f90bb391fb0e3bb852d25764f926492fccc74ff4ecc56ba321fbad9030fb3812423d4c2ed8bc2c61b2e79b9def7ed34a7789061a2367f122888da1

data/.replit

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

data/README.md

@@ -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/timeboss/calendar.rb

@@ -41,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,7 @@ module TimeBoss
       end
 
       def parse(identifier = nil)
-        return nil unless identifier.present?
+        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)]

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/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.5"
+  VERSION = "0.3.0"
 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.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport