timeboss 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082c0c9219e3f40e3e8f98a9850212b678fa895afd0c9062fe4dd21219e879e7'
-  data.tar.gz: 95f5b7c19bd48f94b458aed504f258a7942daf98e0e5f30d8eed50fdfb572811
+  metadata.gz: c8b4b4481ef5554103855a604563c4db3a4deddb298af24a219315f1a658c7ba
+  data.tar.gz: 8be65df968e3a044a81cf492f3be16a03e9d79a61fb80ac6ff4218c8a5b71aa3
 SHA512:
-  metadata.gz: a38a6b535c9b65bb8051e1c54003a05e2ce50c4b1e8d6575ef89f9d7f1ce8976f99b713a8a34e2380c98694696f5b8a4765416631f970ed035c85e7d1744a672
-  data.tar.gz: 3db1f8f1d6551f9c94c14496f2a13c9133d59ef9352cf638d91b3953a6d17981fef6f70b5a045de259f610cbed8d12fcd109b70df3b3dab08aeaae8b86567d69
+  metadata.gz: df28f604bbea294960ff8131b65b5b3315bf2cd2c2663866ee3b28e208abc25ef7811535482931620d4886ec8b39249967ed38cfa63cf4a865eba6ea31f11022
+  data.tar.gz: 8b8f043b358f21970af342263154ac3bcd40f9322b37c7e7c0587740c703214e77798e8b28ff56d627c9b6bab3f5306bb1e6e21ca52dd7589fa2d6e450a75178

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

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

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/README.md

@@ -1,19 +1,25 @@
 # 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)
-A gem providing convenient navigation of the [Broadcast Calendar](https://en.wikipedia.org/wiki/Broadcast_calendar).
+
+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
 ```
@@ -22,6 +28,7 @@ $ gem install timeboss
 Supports `year`, `half`, `quarter`, `month`, `week`, and `day`.
 
 Prepare your calendar for use:
+
 ```ruby
 require 'timeboss/calendars/broadcast'
 
@@ -30,6 +37,7 @@ calendar = TimeBoss::Calendars::Broadcast.new
 ```
 
 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>
@@ -56,11 +64,12 @@ calendar.years_back(2).map { |y| y.start_date.to_s } # run in 2020
 calendar.months_ago(3).name # run in 2020M7
 # => "2020M4"
 
-calendar.weeks_hence(3).name # run in 2020W29
+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
@@ -72,9 +81,11 @@ entry.format(:quarter)
 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"]
@@ -90,6 +101,7 @@ calendar.parse('2020Q1').months.map(&:name)
 ```
 
 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"
@@ -108,6 +120,7 @@ calendar.this_week.next_year.to_s # run 2020W29
 ```
 
 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"]
@@ -125,6 +138,7 @@ The examples above are just samples. Try different periods, operators, etc.
 ### Shell
 To open an IRB shell for the broadcast calendar, use the `tbsh` executable, or the `timeboss:calendars:broadcast:shell` rake task.
 You will find yourself in the context of an instantiated `TimeBoss::Calendars::Broadcast` object:
+
 ```bash
 $ tbsh
 2.4.1 :001 > next_quarter
@@ -190,17 +204,21 @@ 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
-  ```
+
+    ```ruby
+    calendar = MyCalendars::AugustFiscal.new
+    calendar.this_year
+    ```
+
 - via `TimeBoss::Calendars`:
-  ```ruby
-  require 'timeboss/calendars'
-  calendar = TimeBoss::Calendars[:august_fiscal]
-  calendar.this_year
-  ```
+
+    ```ruby
+    require 'timeboss/calendars'
+    calendar = TimeBoss::Calendars[:august_fiscal]
+    calendar.this_year
+    ```
 
 ## TODO
 - [ ] Add comprehensive documentation

data/lib/timeboss.rb

@@ -1,2 +1,6 @@
 # frozen_string_literal: true
 require "timeboss/version"
+
+# TimeBoss
+module TimeBoss
+end

data/lib/timeboss/calendar.rb

@@ -9,16 +9,33 @@ require_relative './calendar/support/month_basis'
 module TimeBoss
   class Calendar
     include Waypoints
+
+    # @!method parse
+    # Parse an identifier into a unit or period.
+    #   Valid identifiers can include simple units (like "2020Q3", "2020M8W3", "last_quarter"),
+    #   mathematical expressions (like "this_month+6"),
+    #   or period expressions (like "2020W1..2020W8", "this_quarter-2..next_quarter")
+    # @param identifier [String]
+    # @return [Support::Unit, Period]
+
     delegate :parse, to: :parser
 
+    # Get a name by which this calendar can be referenced.
+    # @return [String]
     def name
       self.class.to_s.demodulize.underscore
     end
 
+    # Get a friendly title for this calendar.
+    # @return [String]
     def title
       name.titleize
     end
 
+    def supports_weeks?
+      false
+    end
+
     protected
 
     attr_reader :basis

data/lib/timeboss/calendar/day.rb

@@ -8,27 +8,39 @@ module TimeBoss
         super(calendar, start_date, start_date)
       end
 
+      # Get a simple representation of this day.
+      # @return [String] (e.g. "2020-08-03")
       def name
         start_date.to_s
       end
 
+      # Get a "pretty" representation of this day.
+      # @return [String] (e.g. "August 3, 2020")
       def title
         start_date.strftime('%B %-d, %Y')
       end
 
-      def to_s
-        name
-      end
+      alias_method :to_s, :name
 
+      # Get the index of this day within its containing year.
+      # @return [Integer]
       def index
-        @_index ||= (start_date - calendar.year_for(start_date).start_date).to_i + 1
+        @_index ||= (start_date - year.start_date).to_i + 1
+      end
+
+      # Get the year number for this day.
+      # @return [Integer] (e.g. 2020)
+      def year_index
+        @_year_index ||= year.year_index
       end
 
-      def previous
+      private
+
+      def down
         self.class.new(calendar, start_date - 1.day)
       end
 
-      def next
+      def up
         self.class.new(calendar, start_date + 1.day)
       end
     end

data/lib/timeboss/calendar/half.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
-require_relative './support/month_based'
+require_relative './support/monthly_unit'
 
 module TimeBoss
   class Calendar
-    class Half < Support::MonthBased
+    class Half < Support::MonthlyUnit
       NUM_MONTHS = 6
 
+      # Get a simple representation of this half.
+      # @return [String] (e.g. "2020H2")
       def name
         "#{year_index}H#{index}"
       end
 
+      # Get a "pretty" representation of this half.
+      # @return [String] (e.g. "H2 2020")
       def title
         "H#{index} #{year_index}"
       end

data/lib/timeboss/calendar/month.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
-require_relative './support/month_based'
+require_relative './support/monthly_unit'
 
 module TimeBoss
   class Calendar
-    class Month < Support::MonthBased
+    class Month < Support::MonthlyUnit
       NUM_MONTHS = 1
 
+      # Get a simple representation of this month.
+      # @return [String] (e.g. "2020M8")
       def name
         "#{year_index}M#{index}"
       end
 
+      # Get a "pretty" representation of this month.
+      # @return [String] (e.g. "August 2020")
       def title
         "#{Date::MONTHNAMES[index]} #{year_index}"
       end

data/lib/timeboss/calendar/period.rb

@@ -3,9 +3,29 @@ module TimeBoss
   class Calendar
     class Period
       attr_reader :begin, :end
+
+      # @!method start_date
+      # Get the start date of this period.
+      # @return [Date]
       delegate :start_date, to: :begin
+
+      # @!method end_date
+      # Get the end date of this period.
+      # @return [Date]
       delegate :end_date, to: :end
 
+      # @!method name
+      # Get a simple representation of this period.
+      # @return [String]
+
+      # @!method title
+      # Get a "pretty" representation of this period.
+      # @return [String]
+
+      # @!method to_s
+      # Get a stringified representation of this period.
+      # @return [String]
+
       %i[name title to_s].each do |message|
         define_method(message) do
           text = self.begin.send(message)
@@ -14,7 +34,7 @@ module TimeBoss
         end
       end
 
-      %w[week month quarter half year].each do |size|
+      %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
@@ -27,20 +47,14 @@ module TimeBoss
         end
       end
 
+      # Does this period cover the current date?
+      # @return [Boolean]
       def current?
         to_range.include?(Date.today)
       end
 
-      def days
-        to_range.map { |d| Day.new(calendar, d) }
-      end
-
-      def day
-        entries = days
-        return nil unless entries.length == 1
-        entries.first
-      end
-
+      # Express this period as a date range.
+      # @return [Range<Date, Date>]
       def to_range
         @_to_range ||= start_date .. end_date
       end