timeboss 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082c0c9219e3f40e3e8f98a9850212b678fa895afd0c9062fe4dd21219e879e7'
-  data.tar.gz: 95f5b7c19bd48f94b458aed504f258a7942daf98e0e5f30d8eed50fdfb572811
+  metadata.gz: c9e8eba82ecc236c031a9cd96befc6c3a7454dea1720653426af4db4df227a74
+  data.tar.gz: f13fecfd700ffadc07d665addf4d9e7905f042452ede028ab9aa5b517b31bff8
 SHA512:
-  metadata.gz: a38a6b535c9b65bb8051e1c54003a05e2ce50c4b1e8d6575ef89f9d7f1ce8976f99b713a8a34e2380c98694696f5b8a4765416631f970ed035c85e7d1744a672
-  data.tar.gz: 3db1f8f1d6551f9c94c14496f2a13c9133d59ef9352cf638d91b3953a6d17981fef6f70b5a045de259f610cbed8d12fcd109b70df3b3dab08aeaae8b86567d69
+  metadata.gz: 860b8b74668c08a9ec37b37ae5c450babc26f0b130342081b40a94eec468af374618f369791a8ebeb31245ddd7e94b7c4a162e505a8924f12c2a9651e5dad1c2
+  data.tar.gz: be224a555d90519241d32b8e2232fe357b7feca228cdd789a011d6ea76ef388bfee1528adcafeefb9a19058c0aab276ca5576b41192e844a439f730f76705af8

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/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,23 @@
 # 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).
+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 +26,7 @@ $ gem install timeboss
 Supports `year`, `half`, `quarter`, `month`, `week`, and `day`.
 
 Prepare your calendar for use:
+
 ```ruby
 require 'timeboss/calendars/broadcast'
 
@@ -30,6 +35,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>
@@ -61,6 +67,7 @@ calendar.weeks_hence(3).name # run in 2020W29
 ```
 
 The resulting periods can be formatted a variety of (parsable) ways:
+
 ```ruby
 entry = calendar.parse('2020M24')
 entry.format
@@ -72,9 +79,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 +99,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 +118,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 +136,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 +202,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/calendar/day.rb

@@ -24,11 +24,13 @@ module TimeBoss
         @_index ||= (start_date - calendar.year_for(start_date).start_date).to_i + 1
       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/support/month_based.rb

@@ -13,22 +13,6 @@ module TimeBoss
           @index = index
         end
 
-        def next
-          if index == max_index
-            calendar.send(self.class.type, year_index + 1, 1)
-          else
-            calendar.send(self.class.type, year_index, index + 1)
-          end
-        end
-
-        def previous
-          if index == 1
-            calendar.send(self.class.type, year_index - 1, max_index)
-          else
-            calendar.send(self.class.type, year_index, index - 1)
-          end
-        end
-
         def to_s
           "#{name}: #{start_date} thru #{end_date}"
         end
@@ -45,6 +29,22 @@ module TimeBoss
         def max_index
           12 / self.class::NUM_MONTHS
         end
+
+        def up
+          if index == max_index
+            calendar.send(self.class.type, year_index + 1, 1)
+          else
+            calendar.send(self.class.type, year_index, index + 1)
+          end
+        end
+
+        def down
+          if index == 1
+            calendar.send(self.class.type, year_index - 1, max_index)
+          else
+            calendar.send(self.class.type, year_index, index - 1)
+          end
+        end
       end
     end
   end

data/lib/timeboss/calendar/support/navigable.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module TimeBoss
+  class Calendar
+    module Support
+      module Navigable
+        def previous(quantity = nil)
+          return down if quantity.nil?
+          gather(:previous, quantity).reverse
+        end
+
+        def next(quantity = nil)
+          return up if quantity.nil?
+          gather(:next, quantity)
+        end
+
+        def ago(quantity)
+          previous(quantity + 1).first
+        end
+
+        def hence(quantity)
+          self.next(quantity + 1).last
+        end
+
+        def until(end_date)
+          entry = self
+          [entry].tap do |entries|
+            until entry.end_date >= end_date
+              entry = entry.next
+              entries << entry
+            end
+          end
+        end
+
+        private
+
+        def gather(navigator, quantity)
+          [].tap do |entries|
+            entry = self
+            while quantity > 0
+              entries << entry
+              entry = entry.send(navigator)
+              quantity -= 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/timeboss/calendar/support/unit.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require_relative './navigable'
 require_relative './shiftable'
 require_relative './formatter'
 
@@ -6,6 +7,7 @@ module TimeBoss
   class Calendar
     module Support
       class Unit
+        include Navigable
         include Shiftable
         attr_reader :calendar, :start_date, :end_date
 

data/lib/timeboss/calendar/waypoints.rb

@@ -21,54 +21,12 @@ module TimeBoss
         end
       end
 
-      %i[day week month quarter half year].each do |type|
-        define_method("this_#{type}") { send("#{type}_for", Date.today) }
-        define_method("last_#{type}") { send("this_#{type}").previous }
-        define_method("next_#{type}") { send("this_#{type}").next }
-
-        define_method "#{type.to_s.pluralize}_for" do |entry|
-          first = send("#{type}_for", entry.start_date)
-          constituents = [first]
-          until first.end_date >= entry.end_date
-            first = first.next
-            constituents << first
-          end
-          constituents
-        end
-
-        define_method "#{type.to_s.pluralize}_back" do |quantity|
-          windows = []
-          window = send("this_#{type}")
-          while quantity > 0
-            windows << window.dup
-            window = window.previous
-            quantity -= 1
-          end
-          windows.reverse
-        end
-
-        define_method "#{type.to_s.pluralize}_ago" do |quantity|
-          send("#{type.to_s.pluralize}_back", quantity + 1).first
-        end
-
-        define_method type.to_s.pluralize do |quantity|
-          windows = []
-          window = send("this_#{type}")
-          while quantity > 0
-            windows << window.dup
-            window = window.next
-            quantity -= 1
-          end
-          windows
-        end
-
-        define_method "#{type.to_s.pluralize}_hence" do |quantity|
-          send(type.to_s.pluralize, quantity + 1).last
-        end
+      def week(year_index, index)
+        year(year_index).weeks[index - 1]
       end
 
-      %i[yesterday today tomorrow].each do |period|
-        define_method(period) { Day.new(self, Date.send(period)) }
+      def week_for(date)
+        year_for(date).weeks.find { |w| w.to_range.include?(date) }
       end
 
       def day(year_index, index)
@@ -79,9 +37,26 @@ module TimeBoss
         Day.new(self, date)
       end
 
-      def week_for(date)
-        year_for(date).weeks.find { |w| w.to_range.include?(date) }
+      %i[day week month quarter half year].each do |type|
+        types = type.to_s.pluralize
+
+        define_method("this_#{type}") { send("#{type}_for", Date.today) }
+        define_method("last_#{type}") { send("this_#{type}").previous }
+        define_method("next_#{type}") { send("this_#{type}").next }
+
+        define_method("#{types}_for") { |p| send("#{type}_for", p.start_date).until(p.end_date) }
+
+        define_method("#{types}_back") { |q| send("this_#{type}").previous(q) }
+        define_method("#{types}_ago") { |q| send("this_#{type}").ago(q) }
+
+        define_method("#{types}_forward") { |q| send("this_#{type}").next(q) }
+        define_method("#{types}_hence") { |q| send("this_#{type}").hence(q) }
+        alias_method types.to_sym, "#{types}_forward".to_sym
       end
+
+      alias_method :yesterday, :last_day
+      alias_method :today, :this_day
+      alias_method :tomorrow, :next_day
     end
   end
 end

data/lib/timeboss/calendar/week.rb

@@ -24,7 +24,9 @@ module TimeBoss
         "#{name}: #{start_date} thru #{end_date}"
       end
 
-      def previous
+      private
+
+      def down
         if index == 1
           (calendar.year_for(start_date) - 1).weeks.last
         else
@@ -32,7 +34,7 @@ module TimeBoss
         end
       end
 
-      def next
+      def up
         weeks = calendar.year_for(start_date).weeks
         if index == weeks.last.index
           self.class.new(calendar, year_index + 1, 1, start_date + 1.week, end_date + 1.week)

data/lib/timeboss/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module TimeBoss
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/calendars/broadcast_spec.rb

@@ -2,6 +2,26 @@ module TimeBoss
   describe Calendars::Broadcast do
     let(:subject) { described_class.new }
 
+    context 'days' do
+      it 'can get today' do
+        day = subject.today
+        expect(day).to be_instance_of(TimeBoss::Calendar::Day)
+        expect(day.start_date).to eq Date.today
+      end
+
+      it 'can get yesterday' do
+        day = subject.yesterday
+        expect(day).to be_instance_of(TimeBoss::Calendar::Day)
+        expect(day.start_date).to eq Date.yesterday
+      end
+
+      it 'can get tomorrow' do
+        day = subject.tomorrow
+        expect(day).to be_instance_of(TimeBoss::Calendar::Day)
+        expect(day.start_date).to eq Date.tomorrow
+      end
+    end
+
     context 'quarters' do
       describe '#quarter' do
         it 'knows 2017Q2' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,9 +116,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -137,6 +140,7 @@ files:
 - lib/timeboss/calendar/support/formatter.rb
 - lib/timeboss/calendar/support/month_based.rb
 - lib/timeboss/calendar/support/month_basis.rb
+- lib/timeboss/calendar/support/navigable.rb
 - lib/timeboss/calendar/support/shiftable.rb
 - lib/timeboss/calendar/support/unit.rb
 - lib/timeboss/calendar/waypoints.rb