timeboss 0.2.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c7b388d456d8eec7675cc2a654f4f966b6f3f1f00b12e047e49012a135ca2b25
-  data.tar.gz: 8251a808044da5726a9934e10e1f32d7f6fd41c38a6bb16e38632b3e7d4da412
+SHA1:
+  metadata.gz: 847be3292a921e4222074f98d62271bfbea96b9b
+  data.tar.gz: 40866d6a468f3dddc282af7ef893637a8e323b9f
 SHA512:
-  metadata.gz: af06d432fc9e1384e4a9e575061b7ca8107bdf7913bfda744c4a8328148e4e2e81d1bfda9f2ece79c2abd1dea49591f06ec349240b6f2e981950f469266deaac
-  data.tar.gz: 7733f507d6d8d96b0d59639d38063cb6b68a4d6ccbb03c02a2e563dfef743e4dc76756628ebe703d04965aa7e7ea02e89f5aebf467733876d9f5ce85f72917bb
+  metadata.gz: e06fb2e4b8d023d3725a2db5fb98a427cf4b705be7f34e5ca7a52a4c8e3aca9a142868d0f5e01529727c46fa86513daf8a27cdb20fabca5b783b4d74145691a1
+  data.tar.gz: ef5d7f72b7f26469cc5c34d3628faae0a75cdcc91b0d41c84cb2d81c9767abcf3729269a453fe352dbe69d09e4a719f24688d2495e735f17faf3bc0d4e5bb512

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.replit

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

data/.travis.yml

@@ -5,12 +5,3 @@ rvm:
 - 2.6
 script:
 - bundle exec rspec
-deploy:
-  provider: rubygems
-  api_key:
-    secure: jUWa2Jx0HRVv7Dl0zYPTskHQ+RJGy2TUcBWOjyFbBUbeDKiRh8J/NnbMuCOvmL94htSaFk5lcs6k74Itu6jW12+KyT98OAnOardFPFuI0cHHhIMEhF6ms8EhyOCZ0vvR9zav11gfNzyF716qO09DQSDuoKWWNdhrYj8a5paLdbHuRqQiw3YUmnjVQ/v9SPYaZ7ziXC4X4tBxQhK2ujNsNfztSVrpYb6pnsXnt+hFQOnskzi0+er4854iymykeyNVgB71KgivrE3T55ZTXPPglshsZQE7M7FlYA5L3bwzR7SlA202yFYHB3hUN3obwO3BjO4OiAdKQnSosBHaXI13ZvCOz02AfEJhwoxkBXw1/2CvSQ12QQPVgqkpxWY03h+URk+gGHCV+JaqZPCV9excmVWg/IOQou0IJ6h84VFViyVc2aFVN2AIdoaG3NsppbV3j4VuLG6J2VVpNmUzN3pGgi5YSjVq9Hp+huXZFfWpnUgAxc680hKgcFajE3JNANG+NbNEeoDmITvZyV5kvJklgUKPsl2wNk+wY/GGrSBgNOVlyXqTWLZb/8Z/cSrN5DEc6D5BIS/SG95wlCRT8jUqbyEPjT+H77TH2ySfwWZzblLqbIxaLiZr3hX16oMdUx7Cya5LKLFgQBpU6cFUxvZX7SqHwjk1vnuG592Kxd9GkX4=
-  gem: timeboss
-  on:
-    tags: true
-    repo: kevinstuffandthings/timeboss
-  skip_cleanup: 'true'

data/README.md

@@ -40,7 +40,7 @@ You can ask simple questions of the calendar:
 
 ```ruby
 period = calendar.parse('2019Q4') # or '2018', or '2019-12-21', or '2020W32', or '2020M3W2'
-# => #<TimeBoss::Calendar::Quarter:0x007f82d50e2478>
+# => #<TimeBoss::Calendar::Quarter start_date=2019-09-30, end_date=2019-12-29>
 period.to_s
 # => "2019Q4: 2019-09-30 thru 2019-12-29"
 period.next.start_date.to_s # try previous, too!
@@ -117,6 +117,9 @@ week = calendar.parse('2014W29').this_week
 
 calendar.this_week.next_year.to_s # run 2020W29
 # => "2021W29: 2021-07-12 thru 2021-07-18"
+
+calendar.week(2016, this_week.in_year) # run 2020-07-22
+# => #<TimeBoss::Calendar::Week start_date=2016-07-18, end_date=2016-07-24>
 ```
 
 Complicated range expressions can be parsed using the `..` range operator, or evaluated with `thru`:
@@ -136,7 +139,7 @@ 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.
 
 ### REPL
-To open a REPL for the broadcast calendar, use the `tbsh` executable, or the `timeboss:calendars:broadcast:repl` rake task.
+To open a [REPL](https://repl.it/github/kevinstuffandthings/timeboss) locally 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`
@@ -147,13 +150,19 @@ You will find yourself in the context of an instantiated `TimeBoss::Calendar` ob
 ```bash
 $ tbsh
 2.4.1 :001 > next_quarter
- => #<TimeBoss::Calendar::Quarter:0x007fe04c16a1c8 @calendar=#<TimeBoss::Calendars::Broadcast:0x007fe04c1a0458 @basis=TimeBoss::Calendars::Broadcast::Basis>, @year_index=2020, @index=4, @start_date=#<Date: 2020-09-28 ((2459121j,0s,0n),+0s,2299161j)>, @end_date=#<Date: 2020-12-27 ((2459211j,0s,0n),+0s,2299161j)>>
+ => #<TimeBoss::Calendar::Quarter start_date=2020-09-28, end_date=2020-12-27>
 2.4.1 :002 > last_year
- => #<TimeBoss::Calendar::Year:0x007fe04c161ca8 @calendar=#<TimeBoss::Calendars::Broadcast:0x007fe04c1a0458 @basis=TimeBoss::Calendars::Broadcast::Basis>, @year_index=2019, @index=1, @start_date=#<Date: 2018-12-31 ((2458484j,0s,0n),+0s,2299161j)>, @end_date=#<Date: 2019-12-29 ((2458847j,0s,0n),+0s,2299161j)>>
+ => #<TimeBoss::Calendar::Year start_date=2018-12-31, end_date=2019-12-29>
 2.4.1 :003 > parse('this_quarter .. this_quarter+4').months.map(&:name)
  => ["2020M7", "2020M8", "2020M9", "2020M10", "2020M11", "2020M12", "2021M1", "2021M2", "2021M3", "2021M4", "2021M5", "2021M6", "2021M7", "2021M8", "2021M9"]
 ```
 
+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"
+```
+
 _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
@@ -221,9 +230,14 @@ 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
     ```
 
-## TODO
-- [ ] Add comprehensive documentation
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/timeboss/issues).
+We'll figure out how to get you up and running with TimeBoss as smoothly as possible.

data/bin/tbsh

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'timeboss/calendars'
-require 'timeboss/support/shellable'
+require 'shellable'
 
 calendar = if ARGV.length == 1
              TimeBoss::Calendars[ARGV.first]
@@ -12,4 +12,4 @@ calendar = if ARGV.length == 1
 abort "Unknown calendar" if calendar.nil?
 
 puts "Active calendar: #{calendar.title}"
-TimeBoss::Support::Shellable.open(calendar)
+Shellable.open(calendar)

data/lib/tasks/calendars.rake

@@ -11,8 +11,8 @@ namespace :timeboss 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)
+          require 'shellable'
+          Shellable.open(entry.calendar)
         end
 
         task shell: ["timeboss:calendars:#{entry.name}:repl"]

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,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,31 +34,106 @@ 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
         @_to_range ||= start_date .. end_date
       end
 
+      def inspect
+        "#<#{self.class.name}[#{self.begin.inspect}..#{self.end.inspect}] start_date=#{start_date}, end_date=#{end_date}>"
+      end
+
       private
 
       attr_reader :calendar

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/unit.rb

@@ -82,6 +82,10 @@ module TimeBoss
         def to_range
           @_to_range ||= start_date .. end_date
         end
+
+        def inspect
+          "#<#{self.class.name} start_date=#{start_date}, end_date=#{end_date}>"
+        end
       end
     end
   end

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.4"
+  VERSION = "1.0.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

data/timeboss.gemspec

@@ -27,5 +27,6 @@ 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 "shellable"
   spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin McDonald
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-16 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: shellable
+  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'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".replit"
 - ".rspec"
@@ -168,7 +183,6 @@ files:
 - 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
 - spec/calendar/quarter_spec.rb
@@ -184,7 +198,7 @@ homepage: https://github.com/kevinstuffandthings/timeboss
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,8 +213,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
 specification_version: 4
 summary: Broadcast Calendar navigation in Ruby made simple
 test_files:

data/lib/timeboss/support/shellable.rb

@@ -1,17 +0,0 @@
-module TimeBoss
-  module Support
-    module Shellable
-      def self.open(context)
-        context.extend(self).open_shell
-      end
-
-      def open_shell
-        require 'irb'
-        IRB.setup nil
-        IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
-        require 'irb/ext/multi-irb'
-        IRB.irb nil, self
-      end
-    end
-  end
-end