timeboss 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bd79ad6e3e02088a3dc23390a8aef1a37d2db8a
+  data.tar.gz: 43e17929b3ffc20b7372282db1ca9024e87e11e3
+SHA512:
+  metadata.gz: d72e587075701c343742b094537502127206ef2bc8beac51759d5e05bf35eb8306b1cea2161d3de76ed187a85cf04166e91273249ca399a44babeca35f4c17fd
+  data.tar.gz: 37660d7992674849d783c35c662bf6c1fa921363a25c7a95afbdb1855d94583d3d469e8374ab67b2a6edeb8d8c8ef0e11e509a1cb46e6da27a40f07ee66d8cf5

data/.gitignore

@@ -0,0 +1,2 @@
+/*.gem
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.4
+- 2.5
+- 2.6
+script:
+- bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: LKpYdRJImFZgpZ8NP5jah0pWUUwlmrXIW+dCfyFitm4Xf91XkZ3n4/g1WaUoZwmb/9FAian7PR/3XPuiNSEitr3J8DdbJMH9A/CG3VSyIgj/NE9w5Zl/mC6Pz8F0Ry7iSQ3kjhiW74927vRxc6VenHkm/oaBOwz3NfZQCoIEo27rDW1Xu+K4RviPL76k53Pm06C3xupibQ2m2+OKqwW8QlPCfcN1Q4Vkv/gokXjxGlxBYxxvEfZzCc3ul6TZTWeJgkSsfha6/MjHUj2q40sY+m4MMOrgdWGqau9xayJSQuDdP8c0C6hSyL2arHwbPDSO/4hsm0/h0Alfwrmm4sQmPcI2gVowL7yM44vTtTnuigRKhOFhgaNJH+mNTCGtAxH9Ke5Vx0ZjRKpWAXeE1Js1WARNX5gNj5jhZeyeQn5USV/YLJSqiB188Y0lnt3qdLc7h5FJlXWGgKf3+EPnnPupLaSkL9VWdMCVcP1hlp2CUhJo7dBKANzPiUP+sAsSuA3Ez681OOXPjRTfXFhfBSCd7XBnkvw/iZQeIiiZNbh/3CTKQ0tkJIwnnLR4qKsty3KZHH2cqxYfQkaSjmKDeHymQywWqPO9rUL6oxUz2chkLeiv9iEk/t8pTp+RBRx2K1fVB7/tZ1Ys+eGZBdS1lIrRmvvcVE0g6mAfcwhhyJHuPsk=
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin McDonald
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# TimeBoss [![Build Status](https://travis-ci.com/kevinstuffandthings/timeboss.svg?branch=master)](https://travis-ci.com/kevinstuffandthings/timeboss)
+A gem providing convenient navigation of the [Broadcast Calendar](https://en.wikipedia.org/wiki/Broadcast_calendar).
+
+_This is a work in progress. Check back soon for the initial release!_
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+# update with the version of your choice
+gem 'timeboss', '0.0.1', git: "https://github.com/kevinstuffandthings/timeboss.git"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install timeboss
+```
+
+## Usage
+Supports `year`, `half`, `quarter`, `month`, `week`, and `day`.
+
+Prepare your calendar for use:
+```ruby
+require 'timeboss/calendars/broadcast'
+
+calendar = TimeBoss::Calendars::Broadcast.new
+# => #<TimeBoss::Calendars::Broadcast:0x007f82d50f0af0 @basis=TimeBoss::Calendars::Broadcast::Basis>
+```
+
+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>
+period.to_s
+# => "2019Q4: 2019-09-30 thru 2019-12-29"
+period.next.start_date.to_s # try previous, too!
+# => "2019-12-30"
+(period + 3).start_date.to_s # try subtraction, too!
+# => "2020-06-29"
+period.offset(3).start_date.to_s # works with negatives, too!
+# => "2020-06-29"
+period.current? # does today fall within this period?
+# => false
+
+calendar.year_for(Date.parse('2018-12-31')).to_s
+# => "2019: 2018-12-31 thru 2019-12-29"
+
+calendar.this_month.to_s # your results may vary
+# => "2019M12: 2019-11-25 thru 2019-12-29"
+
+calendar.years_back(2).map { |y| y.start_date.to_s } # run in 2020
+# => ["2018-12-31", "2019-12-30"]
+
+calendar.months_ago(3).name # run in 2020M7
+# => "2020M4"
+
+calendar.weeks_hence(3).name # run in 2020W29
+# => "2020W32"
+```
+
+The resulting periods can be formatted a variety of (parsable) ways:
+```ruby
+entry = calendar.parse('2020M24')
+entry.format
+# => "2020H1Q2M3W2"
+
+entry.format(:quarter)
+# => "2020Q2W11"
+
+entry.format(:quarter, :month)
+# => "2020Q2M3W2"
+```
+
+Each type of period can give you information about its constituent periods:
+```ruby
+calendar.this_month.weeks.map(&:to_s)
+# => ["2020M1W1: 2019-12-30 thru 2020-01-05", "2020M1W2: 2020-01-06 thru 2020-01-12", "2020M1W3: 2020-01-13 thru 2020-01-19", "2020M1W4: 2020-01-20 thru 2020-01-26"]
+
+calendar.this_year.weeks.last.to_s
+# => "2020W52: 2020-12-21 thru 2020-12-27"
+
+calendar.last_month.quarter.title # today is 2020-07-15
+# => "Q2 2020"
+
+calendar.parse('2020Q1').months.map(&:name)
+# => ["2020M1", "2020M2", "2020M3"]
+```
+
+Period shifting is easy. Note that the shifts are relative to today, not the base date. A shift examines the base period to find its offset into the shifting period size, and project it relative to now.
+```ruby
+calendar.parse('Q3').years_ago(5).title
+# => "Q3 2015"
+
+week = calendar.this_week # run 2020W29
+"#{week.name}: #{week.in_quarter} of #{week.quarter.name}; #{week.in_year} of #{week.year.name}"
+# => "2020W29: 3 of 2020Q3; 29 of 2020"
+
+# run 2020W29, this generates the same as above, because shifts are relative to date run!
+week = calendar.parse('2014W29').this_week
+"#{week.name}: #{week.in_quarter} of #{week.quarter.name}; #{week.in_year} of #{week.year.name}"
+# => "2020W29: 3 of 2020Q3; 29 of 2020"
+
+calendar.this_week.next_year.to_s # run 2020W29
+# => "2021W29: 2021-07-12 thru 2021-07-18"
+```
+
+Complicated range expressions can be parsed using the `..` range operator, or evaluated with `thru`:
+```ruby
+calendar.parse('2020M1 .. 2020M2').weeks.map(&:title)
+# => ["Week of December 30, 2019", "Week of January 6, 2020", "Week of January 13, 2020", "Week of January 20, 2020", "Week of January 27, 2020", "Week of February 3, 2020", "Week of February 10, 2020", "Week of February 17, 2020"]
+
+calendar.this_quarter.thru(calendar.this_quarter+2).months.map(&:name) # run in 2020Q3
+# => ["2020M7", "2020M8", "2020M9", "2020M10", "2020M11", "2020M12", "2021M1", "2021M2", "2021M3"]
+
+period = calendar.parse('2020W3..2020Q1')
+"#{period.name}: from #{period.start_date} thru #{period.end_date} (current=#{period.current?})"
+# => "2020W3 .. 2020Q1: from 2020-01-13 thru 2020-03-29 (current=false)"
+```
+
+The examples above are just samples. Try different periods, operators, etc.
+
+### Shell
+To open an IRB shell for the broadcast calendar, use the `timeboss:calendars:broadcast:shell` rake task.
+You will find yourself in the context of an instantiated `TimeBoss::Calendars::Broadcast` object:
+```bash
+$ rake timeboss:calendars:broadcast:shell
+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)>>
+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)>>
+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"]
+```
+
+_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!_
+
+## Creating new calendars
+To create a custom calendar, simply extend the `TimeBoss::Calendar` class, and implement a new `TimeBoss::Calendar::Support::MonthBasis` for it.
+
+```ruby
+require 'timeboss/calendar'
+
+module MyCalendars
+  class AugustFiscal < TimeBoss::Calendar
+    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
+      # `start_date` and `end_date` values, based on the desired behavior of the calendar.
+      # With month rules defined, TimeBoss will be able to navigate all the relative periods
+      # within the calendar.
+      super(basis: Basis)
+    end
+
+    private
+
+    class Basis < TimeBoss::Calendar::Support::MonthBasis
+      # In this example, August is the first month of the fiscal year. So an incoming 2020/1
+      # value would translate to a gregorian 2019/8.
+      START_MONTH = 8
+
+      def start_date
+        @_start_date ||= begin
+                           date = Date.civil(year_index, month_index, 1)
+                           date - (date.wday + 7) % 7 # In this calendar, months start Sunday.
+                         end
+      end
+
+      def end_date
+        @_end_date ||= begin
+                         date = Date.civil(year_index, month_index, -1)
+                         date - (date.wday + 1)
+                       end
+      end
+
+      private
+
+      def month_index
+        ((month + START_MONTH - 2) % 12) + 1
+      end
+
+      def year_index
+        month >= START_MONTH ? year : year - 1
+      end
+    end
+  end
+end
+```
+
+With the new calendar implemented, it can be accessed in one of 2 ways:
+- via traditional instantiation:
+  ```ruby
+  calendar = MyCalendars::AugustFiscal.new
+  calendar.this_year
+  ```
+- via `TimeBoss::Calendars`:
+  ```ruby
+  require 'timeboss/calendars'
+  calendar = TimeBoss::Calendars[:august_fiscal]
+  calendar.this_year
+  ```
+
+## TODO
+- [ ] Add gem deployment via [Travis-CI](https://docs.travis-ci.com/user/deployment/rubygems/#:~:text=Travis%20CI%20can%20automatically%20release,RubyGems%20after%20a%20successful%20build.&text=If%20you%20tag%20a%20commit,tags%20are%20uploaded%20to%20GitHub.&text=You%20will%20be%20prompted%20to,key%20on%20the%20command%20line.)

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/lib/tasks/calendars.rake

@@ -0,0 +1,15 @@
+require './lib/timeboss/calendars'
+
+namespace :timeboss do
+  namespace :calendars do
+    TimeBoss::Calendars.each do |entry|
+      namespace entry.name do
+        desc "Open a shell with the #{entry.name} calendar"
+        task shell: ['timeboss:init'] do
+          require 'timeboss/support/shellable'
+          TimeBoss::Support::Shellable.open(entry.calendar)
+        end
+      end
+    end
+  end
+end

data/lib/tasks/timeboss.rake

@@ -0,0 +1,6 @@
+namespace :timeboss do
+  task :init do
+    require './lib/timeboss'
+    require './lib/timeboss/calendars'
+  end
+end

data/lib/timeboss.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "timeboss/version"

data/lib/timeboss/calendar.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'active_support/inflector'
+require 'active_support/core_ext/numeric/time'
+
+%w[day week month quarter half year].each { |f| require_relative "./calendar/#{f}" }
+%w[waypoints period parser].each { |f| require_relative "./calendar/#{f}" }
+require_relative './calendar/support/month_basis'
+
+module TimeBoss
+  class Calendar
+    include Waypoints
+    delegate :parse, to: :parser
+
+    protected
+
+    attr_reader :basis
+
+    def initialize(basis:)
+      @basis = basis
+    end
+
+    private
+
+    def parser
+      @_parser ||= Parser.new(self)
+    end
+  end
+end

data/lib/timeboss/calendar/day.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require_relative './support/unit'
+
+module TimeBoss
+  class Calendar
+    class Day < Support::Unit
+      def initialize(calendar, start_date)
+        super(calendar, start_date, start_date)
+      end
+
+      def name
+        start_date.to_s
+      end
+
+      def title
+        start_date.strftime('%B %-d, %Y')
+      end
+
+      def to_s
+        name
+      end
+
+      def index
+        @_index ||= (start_date - calendar.year_for(start_date).start_date).to_i + 1
+      end
+
+      def previous
+        self.class.new(calendar, start_date - 1.day)
+      end
+
+      def next
+        self.class.new(calendar, start_date + 1.day)
+      end
+    end
+  end
+end

data/lib/timeboss/calendar/half.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative './support/month_based'
+
+module TimeBoss
+  class Calendar
+    class Half < Support::MonthBased
+      NUM_MONTHS = 6
+
+      def name
+        "#{year_index}H#{index}"
+      end
+
+      def title
+        "H#{index} #{year_index}"
+      end
+    end
+  end
+end

data/lib/timeboss/calendar/month.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative './support/month_based'
+
+module TimeBoss
+  class Calendar
+    class Month < Support::MonthBased
+      NUM_MONTHS = 1
+
+      def name
+        "#{year_index}M#{index}"
+      end
+
+      def title
+        "#{Date::MONTHNAMES[index]} #{year_index}"
+      end
+    end
+  end
+end

data/lib/timeboss/calendar/parser.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module TimeBoss
+  class Calendar
+    class Parser
+      RANGE_DELIMITER = '..'
+      InvalidPeriodIdentifierError = Class.new(StandardError)
+      attr_reader :calendar
+
+      def initialize(calendar)
+        @calendar = calendar
+      end
+
+      def parse(identifier = nil)
+        return parse_identifier(identifier.presence) 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)
+      rescue ArgumentError
+        raise InvalidPeriodIdentifierError
+      end
+
+      private
+
+      def parse_identifier(identifier)
+        captures = identifier&.match(/^([^-]+)(\s*[+-]\s*[0-9]+)$/)&.captures
+        base, offset = captures || [identifier, '0']
+        period = parse_period(base&.strip) or raise InvalidPeriodIdentifierError
+        period.offset(offset.gsub(/\s+/, '').to_i)
+      end
+
+      def parse_period(identifier)
+        return calendar.send(identifier) if calendar.respond_to?(identifier.to_s)
+        parse_term(identifier || Date.today.year.to_s)
+      end
+
+      def parse_term(identifier)
+        return Day.new(calendar, Date.parse(identifier)) if identifier.match?(/^[0-9]{4}-?[01][0-9]-?[0-3][0-9]$/)
+
+        raise InvalidPeriodIdentifierError unless identifier.match?(/^[HQMWD0-9]+$/)
+        period = if identifier.to_i == 0 then calendar.this_year else calendar.year(identifier.to_i) end
+        %w[half quarter month week day].each do |size|
+          prefix = size[0].upcase
+          next unless identifier.include?(prefix)
+          junk, identifier = identifier.split(prefix)
+          raise InvalidPeriodIdentifierError if junk.match?(/\D/)
+          period = period.send(size.pluralize)[identifier.to_i - 1] or raise InvalidPeriodIdentifierError
+        end
+        period
+      end
+    end
+  end
+end