schedulability 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50fb75892fe34a90d09b2b053f07d7e60209aee6
+  data.tar.gz: fc229096b9d9395dbc2717194a4b6391440f6266
+SHA512:
+  metadata.gz: 774433974b322f79241580ff4378173f009526cfad3b93a49bea994719fa8df0dbb15d0393bd9fe046c9a3a4ed6be9a842c1bc7abdd110449c763bb77276d2a5
+  data.tar.gz: 2cc54b3bfc288409a73eeea2c68881354766c7fde08c47aa77cfc41392fc104c402f131ea4efe3f3e2f4a706fecbecac652fdda05be4d17c6ca62400c57755c2

data.tar.gz.sig

@@ -0,0 +1 @@
+��k�ʚ���$���0�	�������_�

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Tab indentation
+[**.*]
+indent_style = tab
+
+[**.rdoc]
+indent_style = space

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start do
+	add_filter 'spec'
+	add_group "Tags" do |file|
+		file.filename =~ /tag.rb$/
+	end
+	add_group "Needing tests" do |file|
+		file.covered_percent < 90
+	end
+end

data/ChangeLog

@@ -0,0 +1,87 @@
+2015-12-30  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Backed out tag for v0.1.0; trying again
+	[342ac3d0b6db] [tip]
+
+	* Rakefile, schedulability.gemspec:
+	Explicitly set urls in the Hoespec, since Hoe can't read Markdown.
+	[19eb06e85937]
+
+	* .hgtags:
+	Added tag v0.1.0 for changeset 99d3bb8480ac
+	[c509bc778115]
+
+	* .hgsigs:
+	Added signature for changeset 39de155fb60f
+	[99d3bb8480ac]
+
+	* History.md, lib/schedulability.rb, lib/schedulability/schedule.rb:
+	Fix the version, history file, and some comments.
+	[39de155fb60f]
+
+	* .hgtags:
+	Backed out changeset 9def227667f5
+
+	Fixing the version and some little aesthetic things.
+	[c75030b1d915]
+
+	* .hgtags:
+	Added tag v0.11.0 for changeset efc2ba3917c1
+	[9def227667f5]
+
+	* .hgsigs:
+	Added signature for changeset 9a401a820265
+	[efc2ba3917c1]
+
+	* README.md, lib/schedulability/parser.rb,
+	lib/schedulability/schedule.rb,
+	spec/schedulability/schedule_spec.rb:
+	Implement negated periods; invert the meaning of empty schedule.
+	[9a401a820265] [github/master]
+
+	* lib/schedulability/parser.rb, lib/schedulability/schedule.rb,
+	spec/schedulability/schedule_spec.rb:
+	Implement boolean operations for the Schedule object.
+	[aaa0d5f6ed3f]
+
+	* lib/schedulability/parser.rb, spec/schedulability/schedule_spec.rb:
+	Fix the 12pm edge case for time parsing
+	[8687eaead89b]
+
+	* Manifest.txt, README.md, lib/schedulability.rb,
+	lib/schedulability/parser.rb, lib/schedulability/schedule.rb:
+	Break out schedule-parsing functions into a module.
+	[6ae39f6f0e6d]
+
+	* Manifest.txt, README.md, lib/schedulability/schedule.rb,
+	spec/schedulability/schedule_spec.rb:
+	Use counted week of month for `week` scale.
+	[bdf32f4fb2ef]
+
+2015-12-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* README.md, lib/schedulability.rb, lib/schedulability/mixins.rb,
+	lib/schedulability/schedule.rb, spec/helpers.rb,
+	spec/schedulability/schedule_spec.rb:
+	Finished up initial work on period parsing
+	[19fcd47d5dbc]
+
+	* Rakefile, schedulability.gemspec:
+	Add missing loggability dependency.
+	[8054ca4ee4a2]
+
+	* Manifest.txt, schedulability.gemspec:
+	Update build files, switch docs to Markdown.
+	[2b12bb7ae802]
+
+2015-12-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* .editorconfig, .gems, .hgignore, .hgsigs, .hgtags, .pryrc, .rvmrc,
+	.simplecov, .tm_properties, .travis.yml, Gemfile, History.md,
+	Manifest.txt, README.md, Rakefile, lib/schedulability.rb,
+	lib/schedulability/exceptions.rb, lib/schedulability/schedule.rb,
+	spec/helpers.rb, spec/schedulability/schedule_spec.rb,
+	spec/schedulability_spec.rb:
+	Initial commit
+	[eb1dd1197f1e]

data/History.md

@@ -0,0 +1,4 @@
+## v0.1.0 [2015-12-30] Michael Granger <ged@FaerieMUD.org>
+
+First release.  Happy New Year!
+

data/Manifest.txt

@@ -0,0 +1,15 @@
+.editorconfig
+.simplecov
+ChangeLog
+History.md
+Manifest.txt
+README.md
+Rakefile
+lib/schedulability.rb
+lib/schedulability/exceptions.rb
+lib/schedulability/mixins.rb
+lib/schedulability/parser.rb
+lib/schedulability/schedule.rb
+spec/helpers.rb
+spec/schedulability/schedule_spec.rb
+spec/schedulability_spec.rb

data/README.md

@@ -0,0 +1,236 @@
+# schedulability
+
+home
+: http://deveiate.org/projects/schedulability
+
+code
+: http://bitbucket.org/ged/schedulability
+
+docs
+: http://deveiate.org/code/schedulability
+
+github
+: http://github.com/ged/schedulability
+
+
+## Description
+
+Schedulability is a library for describing scheduled time. You can specify one or more periods of time using a simple syntax, then combine them to describe more-complex schedules.
+
+
+## Usage
+
+Schedules are represented with Schedulability::Schedule objects, which are empty by default:
+
+    schedule = Schedulability::Schedule.new
+    # => #<Schedulability::Schedule:0x007ffcf2b982b8 (empty)>
+
+An empty Schedule has no time restrictions, and will match any time.
+
+To specify matching times, you'll need to construct a Schedule with one or more periods.
+
+
+### Periods
+
+A schedule is specified as a String that contains a comma-separated list of period descriptions. The string `"never"` can be specified to explicitly create a schedule which will not match any time.
+
+A period description is of the form
+
+    scale {range [range ...]} [scale {range [range ...]}]
+
+Scale must be one of nine different scales (or their equivalent codes):
+
+    Scale  | Scale | Valid Range Values
+           | Code  |
+    -------+-------+------------------------------------------------------
+    year   |  yr   | n     where n is a 4-digit integer
+    month  |  mo   | 1-12  or  jan, feb, mar, apr, may, jun, jul,
+           |       |           aug, sep, oct, nov, dec
+    week   |  wk   | 1-6
+    yday   |  yd   | 1-366
+    mday   |  md   | 1-31
+    wday   |  wd   | 1-7   or  sun, mon, tue, wed, thu, fri, sat
+    hour   |  hr   | 0-23  or  12am 1am-11am 12noon 12pm 1pm-11pm
+    minute |  min  | 0-59
+    second |  sec  | 0-59
+
+The same scale type may be specified multiple times. Additional scales are unioned with the ranges defined by previous scales of the same type in the same sub-period.
+
+A `range` is an exclusive Time range in the form:
+
+    t
+or
+
+    t1-t2
+
+For two-value ranges, the range is defined as the period between `t1` and `t2`. Scales which are in
+seconds granularity are exclusive of their end value, but the rest are inclusive. For example, `hr {9am-5pm}` means 9:00:00 AM until 4:59:59 PM, but `wd {Wed-Sat}` runs until one second before midnight on Saturday.
+
+If the first value is larger than the second value (e.g. `min {20-10}`), the range wraps (except when the scale specification is `year`). For example, `month {9-2}` is the same as specifying `month {1-2 9-12}` or `month {1-2} month {9-12}` or even `month {Jan-Feb Sep-Dec}`.
+
+The range specified by the single-value specification is implicitly between the value of `t` and its next sequential whole value. For example, `hr {9}` is the same as specifying `hr {9-10}`, `mday {15}` is the same as `mday {15-16}`, etc.
+
+Neither extra whitespace or case are significant in a period description. Scales must be specified either in long form (`year`, `month`, `week`, etc.) or in code form (`yr`, `mo`, `wk`, etc.). Scale forms may be mixed in a period statement.
+
+Values for week days can be abbreviated to two characters (`Wednesday` == `Wed` == `we`), and months can be abbreviated to three (`September` == `Sep`).
+
+
+#### Period Examples
+
+<dl>
+<dt><code>wd {Mon-Fri} hr {9am-4pm}</code></dt>
+<dd>Monday through Friday, 9am to 5pm</dd>
+
+<dt><code>wd {Mon Wed Fri} hr {9am-4pm}, wd{Tue Thu} hr {9am-2pm}</code></dt>
+<dd>Monday through Friday, 9:00:00am to 3:59:59pm on Monday, Wednesday, and Friday, 
+  and 9:00:00am to 1:59:59pm on Tuesday and Thursday</dd>
+
+<dt><code>wk {1 3 5} wd {Mon-Fri} hr {9am-5pm}</code></dt>
+<dd>Mon-Fri 9:00:00am-4:59:59pm, on odd weeks in the month</dd>
+
+<dt><code>month {Jan-Feb Nov-Dec}</code></dt>
+<dd>During Winter in the northern hemisphere.</dd>
+
+<dt><code>mo {Nov-Feb}</code></dt>
+<dd>The same thing (Winter) as a wrapped range.</dd>
+
+<dt><code>mo {jan feb nov dec}</code></dt>
+<dd>Northern Winter as single months</dd>
+
+<dt><code>mo {Jan Feb}, mo {Nov Dec}</code></dt>
+<dd>Also Northern Winter.</dd>
+
+<dt><code>mo {Jan Feb} mo {Nov Dec}</code></dt>
+<dd>Northern Winter.</dd>
+
+<dt><code>minute { 0-29 }</code></dt>
+<dd>The first half of every hour.</dd>
+
+<dt><code>hour { 12am-12pm }</code></dt>
+<dd>During the morning.</dd>
+
+<dt><code>sec {0-4 10-14 20-24 30-34 40-44 50-54}</code></dt>
+<dd>Alternating 5-second periods every hour.</dd>
+
+<dt><code>wd {1 3 5 7} min {0-29}, wd {2 4 6} min {30-59}</code></dt>
+<dd>Every first half-hour on alternating week days, and the second half-hour the
+  rest of the week.</dd>
+</dl>
+        
+
+### Schedule Objects
+
+Schedules are immutable after they're created, but they have mutator methods to
+allow you to compose the schedule you want by combining them, or by using mutator
+methods that return a changed copy of the original:
+
+    weekend = Schedulability::Schedule( "wd {Sat - Sun}" )
+    weekdays = Schedulability::Schedule( "wd {Mon - Fri}" )
+    work_hours = Schedulability::Schedule( "hour {9am - 5pm}" )
+    off_hours = Schedulability::Schedule( "hour {5pm - 9am}" )
+
+    ### Boolean operators
+    on_duty = weekdays | work_hours
+    off_duty = weekend + ( weekdays | off_hours )
+    # -or-
+    off_duty = ~on_duty
+
+    ### Exclusivity predicates
+    on_duty.overlaps?( off_duty )
+    # => false
+    on_duty.exclusive?( off_duty )
+    # => true
+
+    ### Time predicates
+    Time.now
+    # => 2015-12-22 12:05:44 -0800
+    on_duty.include?( Time.now )
+    # => true
+    on_duty.now?
+    # => true
+    off_duty.now?
+    # => false
+
+    ### Case equality (=== operator)
+    case Time.now
+    when on_duty
+        send_sms( "Stuff happened." )
+    when off_duty
+        send_email( "Stuff happened." )
+    end
+
+	### Enumerators
+	on_duty.each_minute
+	# => #<Enumerator: ...>
+	on_duty.each_hour
+	# => #<Enumerator: ...>
+	on_duty.each_day
+	# => #<Enumerator: ...>
+
+
+## Prerequisites
+
+* Ruby 2.2.0 or better
+
+
+## Installation
+
+    $ gem install schedulability
+
+
+## Contributing
+
+You can check out the current development source with
+[Mercurial](https://bitbucket.org/ged/schedulability), or if you prefer Git, via
+[its Github mirror](https://github.com/ged/schedulability).
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+## License
+
+This library borrows much of its schedule description syntax and several implementation strategies from the Time::Period Perl module by Patrick Ryan, used under the terms of the Perl Artistic License.
+
+  Patrick Ryan <perl@pryan.org> wrote it.
+  Paul Boyd <pboyd@cpan.org> fixed a few bugs.
+
+  Copyright (c) 1997 Patrick Ryan. All rights reserved. This Perl 
+  module uses the conditions given by Perl. This module may only
+  be distributed and or modified under the conditions given by Perl.
+
+The rest is:
+
+Copyright (c) 2015, Michael Granger and Mahlon E. Smith
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/Rakefile

@@ -0,0 +1,88 @@
+#!/usr/bin/env rake
+
+require 'rake/clean'
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires 'hoe' (gem install hoe)"
+end
+
+GEMSPEC = 'schedulability.gemspec'
+
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+Hoe.plugin :deveiate
+
+Hoe.plugins.delete :rubyforge
+
+hoespec = Hoe.spec 'schedulability' do
+	self.readme_file = 'README.md'
+	self.history_file = 'History.md'
+	self.extra_rdoc_files = FileList[ '*.md' ]
+	self.urls = {
+		home:   'http://deveiate.org/projects/schedulability',
+		code:   'http://bitbucket.org/ged/schedulability',
+		docs:   'http://deveiate.org/code/schedulability',
+		github: 'http://github.com/ged/schedulability',
+	}
+
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	self.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
+
+	self.dependency 'loggability',     '~> 0.11'
+
+	self.dependency 'timecop',         '~> 0.8', :developer
+	self.dependency 'hoe-deveiate',    '~> 0.4', :developer
+	self.dependency 'hoe-bundler',     '~> 1.2', :developer
+	self.dependency 'simplecov',       '~> 0.7', :developer
+
+	self.license "BSD-3-Clause"
+	self.require_ruby_version( '>=2.2.0' )
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
+
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+end
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => [ :check_history, :check_manifest, :gemspec, :spec ]
+
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+CLOBBER.include( 'coverage' )
+
+
+# Use the fivefish formatter for docs generated from development checkout
+if File.directory?( '.hg' )
+	require 'rdoc/task'
+
+	Rake::Task[ 'docs' ].clear
+	RDoc::Task.new( 'docs' ) do |rdoc|
+	    rdoc.main = "README.md"
+	    rdoc.rdoc_files.include( "*.rdoc", "*.md", "ChangeLog", "lib/**/*.rb" )
+	    rdoc.generator = :sixfish
+		rdoc.title = 'Schedulability'
+	    rdoc.rdoc_dir = 'doc'
+	end
+end
+
+task :gemspec => GEMSPEC
+file GEMSPEC => __FILE__
+task GEMSPEC do |task|
+	spec = $hoespec.spec
+	spec.files.delete( '.gemtest' )
+	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	File.open( task.name, 'w' ) do |fh|
+		fh.write( spec.to_ruby )
+	end
+end
+
+CLOBBER.include( GEMSPEC.to_s )
+