timeboss 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0993a0cd3f9eaf4c63e71aac4b816950c7454d7cdbebb41032d4d52ed401fa9f'
-  data.tar.gz: 7b3ecd196897915c0ca137b21d2e70b3004513098fe1c880e7847106529f5e8b
+  metadata.gz: '082c0c9219e3f40e3e8f98a9850212b678fa895afd0c9062fe4dd21219e879e7'
+  data.tar.gz: 95f5b7c19bd48f94b458aed504f258a7942daf98e0e5f30d8eed50fdfb572811
 SHA512:
-  metadata.gz: 9e57840bb1b2645a1247a9868840abb1b1eed60de9106115b8a103aac7ee4689c476d0cbf44ac9596e1ff5ce538caa23666bcaedf85d732d84cd14d71671fde4
-  data.tar.gz: 6fd2d42323c56dd3af20a1312c993fa31ac7652cc01826fff856529ef2019c8b66da0d9b47b0563c3a8753ab15de84e6321e2a465d02611886fccc533ccfa3ce
+  metadata.gz: a38a6b535c9b65bb8051e1c54003a05e2ce50c4b1e8d6575ef89f9d7f1ce8976f99b713a8a34e2380c98694696f5b8a4765416631f970ed035c85e7d1744a672
+  data.tar.gz: 3db1f8f1d6551f9c94c14496f2a13c9133d59ef9352cf638d91b3953a6d17981fef6f70b5a045de259f610cbed8d12fcd109b70df3b3dab08aeaae8b86567d69

data/README.md

@@ -1,8 +1,6 @@
-# TimeBoss [![Build Status](https://travis-ci.com/kevinstuffandthings/timeboss.svg?branch=master)](https://travis-ci.com/kevinstuffandthings/timeboss)
+# 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).
 
-_This is a work in progress. Check back soon for the initial release!_
-
 ## Installation
 Add this line to your application's Gemfile:
 ```ruby
@@ -20,8 +18,6 @@ Or install it yourself as:
 $ gem install timeboss
 ```
 
-You can find the gem on [RubyGems](https://rubygems.org/gems/timeboss).
-
 ## Usage
 Supports `year`, `half`, `quarter`, `month`, `week`, and `day`.
 
@@ -127,10 +123,10 @@ period = calendar.parse('2020W3..2020Q1')
 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.
+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
-$ rake timeboss:calendars:broadcast:shell
+$ 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
@@ -207,4 +203,4 @@ With the new calendar implemented, it can be accessed in one of 2 ways:
   ```
 
 ## TODO
-- [x] 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.)
+- [ ] Add comprehensive documentation

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]&.calendar
+           else
+             TimeBoss::Calendars.first.calendar
+           end
+
+abort "Unknown calendar" if calendar.nil?
+
+puts "Active calendar: #{calendar.title}"
+TimeBoss::Support::Shellable.open(calendar)

data/lib/tasks/calendars.rake

@@ -4,6 +4,11 @@ namespace :timeboss do
   namespace :calendars do
     TimeBoss::Calendars.each do |entry|
       namespace entry.name do
+        desc "Evaluate an expression for the #{entry.name} calendar"
+        task :evaluate, %i[expression] => ['timeboss:init'] do |_, args|
+          puts entry.calendar.parse(args[:expression])
+        end
+
         desc "Open a shell with the #{entry.name} calendar"
         task shell: ['timeboss:init'] do
           require 'timeboss/support/shellable'

data/lib/timeboss/calendar.rb

@@ -11,6 +11,14 @@ module TimeBoss
     include Waypoints
     delegate :parse, to: :parser
 
+    def name
+      self.class.to_s.demodulize.underscore
+    end
+
+    def title
+      name.titleize
+    end
+
     protected
 
     attr_reader :basis

data/lib/timeboss/calendars.rb

@@ -17,7 +17,7 @@ module TimeBoss
     end
 
     def [](name)
-      find { |e| e.name == name.to_sym }&.calendar
+      find { |e| e.name == name&.to_sym }&.calendar
     end
 
     private

data/lib/timeboss/version.rb

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

data/spec/calendars_spec.rb

@@ -28,10 +28,16 @@ module TimeBoss
         c2 = described_class[:broadcast]
         expect(c1).to be_instance_of TimeBoss::Calendars::Broadcast
         expect(c1).to be c2
+
+        expect(c1.name).to eq 'broadcast'
+        expect(c1.title).to eq 'Broadcast'
       end
 
       it 'can return a new calendar' do
-        expect(described_class[:my_test_calendar]).to be_instance_of MyTestCalendar
+        c1 = described_class[:my_test_calendar]
+        expect(c1).to be_instance_of MyTestCalendar
+        expect(c1.name).to eq 'my_test_calendar'
+        expect(c1.title).to eq 'My Test Calendar'
       end
 
       it 'can graceully give you nothing' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeboss
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kevin McDonald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,8 @@ dependencies:
 description: Broadcast Calendar navigation in Ruby made simple
 email:
 - kevinstuffandthings@gmail.com
-executables: []
+executables:
+- tbsh
 extensions: []
 extra_rdoc_files: []
 files:
@@ -122,6 +123,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/tbsh
 - lib/tasks/calendars.rake
 - lib/tasks/timeboss.rake
 - lib/timeboss.rb
@@ -172,7 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Broadcast Calendar navigation in Ruby made simple