timeboss 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfac166bdd92d5f95689183603c5af386100642526cea8cbc405765655a1eb26
+  data.tar.gz: 00dfb8323ed9317cb214f532a7431bb9dc40d0ca3027ecda5f922bf72949ff0d
+SHA512:
+  metadata.gz: bf61f841ed2aa51150656da6d849b01a44511e478a8a0012e0074ec9a85fee8569a0bd162c22f3105b33d565c863df556bbee8bb65ea8d9b938272ff4b702b76
+  data.tar.gz: 1dff56f1577ab2e91eb4b5fcfee2928979c261ae02812eec1d2ab0c8788bd7078fbba7f95aec56c830f219d3c07f92513402cd3bb9035233283ffabdcb17fb0e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add code/outputs to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc

data/.replit

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.4
+- 2.5
+- 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/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevinstuffandthings@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

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,233 @@
+# 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.
+
+Originally developed for [Simulmedia](https://simulmedia.com).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'timeboss'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install timeboss
+```
+
+## Usage
+Supports `year`, `half`, `quarter`, `month`, `week` (non-gregorian calendars only), 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_ahead(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"
+```
+
+_Note: all parsable descriptors should be ordered by chronological specificity (from least to most)_
+
+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. 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.
+
+For the Gregorian calendar (or any other implemented calendars), supply the name on the command line.
+- `tbsh gregorian`
+- `rake timeboss:calendars:gregorian:repl`
+
+You will find yourself in the context of an instantiated `TimeBoss::Calendar` object:
+
+```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)>>
+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 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.
+
+```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'
+    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

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/bin/tbsh

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