timeboss 1.1.3 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f9e2cd955a728e0efd00e99f530f1ff6dbb7ee0c8cee7e25499466fb10edc9
-  data.tar.gz: 9523e2983ffff0d5d33cf9b07e7fd4cd1b26b54c68e8a3f77d8996aaa7ad991d
+  metadata.gz: 3299b203ac582ad852fb3411015fb1c8d53ab9b59fbae51f133e79e4750ba912
+  data.tar.gz: ae84c4d98f8996519c30b05700f359faca2f66492c78e46f2eda0cf9e2fcc60c
 SHA512:
-  metadata.gz: 1f850961e4659cee0b07e59d4421f1444c39e3882338f5189cd5821e5d4ec00228c4043aef7c001df8a2181cf4161671943653e7e0c843f419f4f7d91b6bb99d
-  data.tar.gz: 24a8f28844c20caf7f0294a5e5db155ff809f46ad76e421e97d807b929ceca37035d9b89539a5600713d9420ba8f799fa1668c61e47b040a8728c41df12a67df
+  metadata.gz: d2c3e30df4a6256bab1428fb470cbc21f7d44c89747ebd08b390d7b324b010980c2592fbbab3e503c0a21dc20705c03036cd9e68d6c67b844bf372ee19ad9bc0
+  data.tar.gz: 79994538d0477b935d1b17887f9e2748f73e59511d84e0dfffb236e0798bc39d1416cecc3e452965a7e96b0ddce156f92771cdeaf73080ca9b6892b1b5ace896

data/.github/workflows/gem-push.yml

@@ -14,10 +14,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 3.1
 
     - name: Publish to RubyGems
       run: |

data/.github/workflows/ruby.yml

@@ -19,15 +19,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
 
     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@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/PERIOD_SPECIFIERS.md

@@ -0,0 +1,70 @@
+# TimeBoss Period Specifiers
+Below is a list of examples for TimeBoss period specifiers. This list is by no means comprehensive, but hopefully serves as a guide to help
+you understand how to communicate with TimeBoss.
+
+All specifiers are resolved within the context of the utilized calendar (Gregorian, Broadcast, etc).
+
+## Absolute Periods
+An "absolute" period is one that never changes, regardless of the current date. "December of 2019" always references the same time period,
+regardless of what today is.
+
+_Assuming the Broadcast calendar is in use:_
+| Specifier                  | Description                         | Resolution              |
+| -------------------------- | ----------------------------------- | ----------------------- |
+| `2020Q3`                   | 3rd quarter of 2020                 | 6/29/2020 - 9/27/2020   |
+| `2022M1`                   | 1st month of 2022                   | 12/27/2021 - 1/30/2022  |
+| `2021H1M2`                 | 2nd month of the first half of 2021 | 2/1/2021 - 2/28/2021    |
+| `2020W40`                  | 40th week of 2020                   | 9/28/2020 - 10/4/2020   |
+| `2027`                     | 2027                                | 12/28/2026 - 12/26/2027 |
+| `1999-07-31` or `19990731` | July 31, 1999                       | 7/31/1999 - 7/31/1999   |
+
+The sub-identifiers for period granularities are:
+- `D`: day
+- `W`: week
+- `M`: month
+- `Q`: quarter
+- `H`: half
+
+## Relative Periods
+A "relative" period is one that changes based on the current date. "Last week" means something different today than it will a month from now.
+
+_Assuming today is April 29, 2022, in the Gregorian calendar:_
+| Specifier       | Description                         | Resolution            |
+| --------------- | ----------------------------------- | --------------------- |
+| `last_month`    | March 2022                          | 3/1/2022 - 3/31/2022  |
+| `this_month-2`  | February 2022                       | 2/1/2022 - 2/28/2022  |
+| `this_week`     | Week of April 25, 2022              | 4/25/2022 - 5/1/2022  |
+| `yesterday`     | April 28, 2022                      | 4/28/2022 - 4/28/2022 |
+| `today+4`       | May 3, 2022                         | 5/3/2022 - 5/3/2022   |
+| `next_year`     | 2023                                | 1/1/2023 - 12/31/2023 |
+
+The relative prefixes can be used in conjuction with any period granularity. The terms here should be joined with the underscore (`_`) character as in the examples above.
+
+Relative prefixes are:
+- `last`
+- `this`
+- `next`
+
+Period granularities are:
+- `day`
+- `week`
+- `month`
+- `quarter`
+- `half`
+- `year`
+
+Accepted single-day specifiers:
+- `yesterday`
+- `today`
+- `tomorrow`
+
+## Compound Periods
+Absolute and/or relative periods can be combined together to build "compound" periods by utilizing TimeBoss' "range" operator (`..`):
+
+_Assuming today is April 29, 2022, in the Gregorian calendar:_
+| Specifier                  | Description                                                              | Resolution            |
+| -------------------------- | ------------------------------------------------------------------------ | --------------------- |
+| `yesterday..today`         | Yesterday and Today                                                      | 4/28/2022 - 4/29/2022 |
+| `last_quarter..this_month` | From the first day of last quarter, through the end of the current month | 1/1/2022 - 4/30/2022  |
+| `this_week-2..next_week`   | From the first day of 2 weeks ago, through the last day of next week     | 4/11/2022 - 5/8/2022  |
+| `2022M2..this_year`        | From the first day of February, through the last day of this year        | 2/1/2022 - 12/31/2022 |

data/README.md

@@ -25,7 +25,7 @@ $ gem install timeboss
 ```
 
 ## Usage
-Supports `year`, `half`, `quarter`, `month`, `week` (non-gregorian calendars only), and `day`.
+Supports `year`, `half`, `quarter`, `month`, `week`, and `day`.
 
 Prepare your calendar for use:
 

data/lib/tasks/calendars.rake

@@ -1,3 +1,4 @@
+require "./lib/timeboss"
 require "./lib/timeboss/calendars"
 
 namespace :timeboss do

data/lib/timeboss/calendar/period.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "./support/clampable"
+
 module TimeBoss
   class Calendar
     class Period
+      include Calendar::Support::Clampable
       attr_reader :begin, :end
 
       # @!method start_date

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TimeBoss
+  class Calendar
+    module Support
+      module Clampable
+        # Clamp this unit to the range of the provided unit.
+        # @return [Period]
+        def clamp(unit)
+          new_start_date = start_date.clamp(unit.start_date, unit.end_date)
+          new_end_date = end_date.clamp(unit.start_date, unit.end_date)
+          return unless new_start_date.between?(start_date, end_date) && new_end_date.between?(start_date, end_date)
+          calendar.parse("#{new_start_date}..#{new_end_date}")
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 require_relative "./navigable"
 require_relative "./translatable"
 require_relative "./shiftable"
+require_relative "./clampable"
 require_relative "./formatter"
 
 module TimeBoss
@@ -12,6 +13,7 @@ module TimeBoss
         include Navigable
         include Translatable
         include Shiftable
+        include Clampable
         attr_reader :calendar, :start_date, :end_date
 
         UnsupportedUnitError = Class.new(StandardError)
@@ -84,15 +86,6 @@ module TimeBoss
           @_to_range ||= start_date..end_date
         end
 
-        # Clamp this unit to the range of the provided unit.
-        # @return [Period]
-        def clamp(unit)
-          new_start_date = start_date.clamp(unit.start_date, unit.end_date)
-          new_end_date = end_date.clamp(unit.start_date, unit.end_date)
-          return unless new_start_date.between?(start_date, end_date) && new_end_date.between?(start_date, end_date)
-          calendar.parse("#{new_start_date}..#{new_end_date}")
-        end
-
         def inspect
           "#<#{self.class.name} start_date=#{start_date}, end_date=#{end_date}>"
         end

data/lib/timeboss/calendar/waypoints/absolute.rb

@@ -15,6 +15,7 @@ module TimeBoss
           end
 
           define_method "#{type}_for" do |date|
+            date = date.to_date
             window = public_send(type, date.year - 1, 1)
             loop do
               break window if window.to_range.include?(date)

data/lib/timeboss/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TimeBoss
-  VERSION = "1.1.3"
+  VERSION = "1.1.5"
 end

data/lib/timeboss.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/all"
 require "timeboss/version"
 
 # TimeBoss

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,6 +184,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- PERIOD_SPECIFIERS.md
 - README.md
 - Rakefile
 - bin/tbsh
@@ -197,6 +198,7 @@ files:
 - lib/timeboss/calendar/parser.rb
 - lib/timeboss/calendar/period.rb
 - lib/timeboss/calendar/quarter.rb
+- lib/timeboss/calendar/support/clampable.rb
 - lib/timeboss/calendar/support/formatter.rb
 - lib/timeboss/calendar/support/has_fiscal_weeks.rb
 - lib/timeboss/calendar/support/has_iso_weeks.rb
@@ -244,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Broadcast Calendar navigation in Ruby made simple