abstractivator 0.0.31 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e21da1a080a716ba7807d66781ef4c0cb8bcee6a
-  data.tar.gz: 77814c5cff83133dac82c76758e568bc6d1055a9
+  metadata.gz: 0a6548a23dbbb3727663ad80929bb8a10f30abe2
+  data.tar.gz: 739a8d584e2c49765477507abfdbae0f1060c16a
 SHA512:
-  metadata.gz: 89ae1ba1cbd05b247c480256cb132d8f2e50784e42355cb3fb2802f06e1c7f25f36d6d8e11d839079a322460edde3ed6368df3f44c186efb4f3d915097792b59
-  data.tar.gz: 751e1e23feda00161a008f5674fefd3ace2ee128647fb9bf7523097d2bf2e8fa67fdba899e8bc2f8137634b0cbc9217b4ea756c22016b135026ca79d152f3429
+  metadata.gz: 0e621bd42c5d2d7d6a3607ba27e1ffdc76f5889408d48cc4f43b20db5bc6c5f929b810a4cb658fb897ebb4d475dc42112c8e93f0b48a6920d5347f68f26259f0
+  data.tar.gz: d39b5ed89186aa413261018dace9671357abd4a01a2e423322191868682da45f5a74fd830343fac56f29590a0ef064ecc7c3ee017747febd23738ba261303728

data/abstractivator.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'eventmachine'
+
   spec.add_runtime_dependency 'activesupport', '~> 4.0'
   spec.add_runtime_dependency 'sourcify', '> 0'
 end

data/lib/abstractivator/schedule/schedule.rb

@@ -0,0 +1,104 @@
+class Schedule
+
+  WEEKDAYS = 'UMTWRFS' # Sunday through Saturday
+
+  def initialize(str)
+    @periods = parse_periods(str)
+    unless @periods.any?
+      raise 'At least one period must be specified'
+    end
+  end
+
+  def permits?(localtime)
+    @periods.any?{|p| p.includes?(localtime)}
+  end
+
+  def downtime_minutes_from(localtime)
+    return 0 if permits?(localtime)
+    wmin = Wmin.from_localtime(localtime)
+    @periods.map{|p| (p.start - wmin + Wmin::WEEK) % Wmin::WEEK}.min
+  end
+
+  private
+
+  def parse_periods(str)
+    str.split(/[, ]+/).map(&method(:parse_period)).flatten
+  end
+
+  def parse_period(str)
+    # the regex for matching a period.
+    # don't restrict days here; otherwise, garbage will cause the optional days clause to fail,
+    # which would be massaged to "UMTWRFS", which is not what we want.
+    m = str.match /^(?<sh>\d\d?):(?<sm>\d\d?)-(?<eh>\d\d?):(?<em>\d\d?)([^\d:\-\.UMTWRFS ](?<days>.+))?$/
+    m or raise "Could not parse period: #{str}"
+    day_chars = m[:days] || WEEKDAYS
+    day_chars.chars.map do |day_char|
+      start = Wmin.parse(day_char, m[:sh], m[:sm])
+      stop = Wmin.parse(day_char, m[:eh], m[:em])
+      if stop < start
+        stop = Wmin.add_day(stop)
+      end
+      if stop < Wmin::WEEK
+        Period.new(start, stop)
+      else
+        [Period.new(start, Wmin::WEEK), Period.new(0, stop % Wmin::WEEK)]
+      end
+    end
+  end
+
+  class Period
+    attr_accessor :start # inclusive
+    attr_accessor :stop  # exclusive
+
+    def initialize(start, stop)
+      @start = start
+      @stop = stop
+    end
+
+    def includes?(localtime)
+      wmin = Wmin.from_localtime(localtime)
+      result = start <= wmin && wmin < stop
+      #puts "#{to_s} includes? #{to_clock(wmin)} (#{localtime}) : #{result}"
+      #puts "  #{start} <= #{wmin} && #{wmin} < #{stop}"
+      result
+    end
+
+    def to_s
+      "#{to_clock(start)}-#{to_clock(stop)}"
+    end
+
+    def to_clock(wmin)
+      day = (wmin / Wmin::DAY) % 7
+      minutes = wmin % Wmin::DAY
+      "#{minutes / 60}:#{minutes % 60}#{WEEKDAYS[day]}"
+    end
+  end
+
+  # a 'wmin' is a week-minute: a time in any given week, represented as the number of minutes since
+  # midnight on Sunday. Saturday 23:59 is the largest wmin (7 * 24 * 60 - 1)
+  module Wmin
+    DAY = 24 * 60
+    WEEK = 7 * DAY
+
+    def self.parse(day_char, hour, min)
+      day = WEEKDAYS.index(day_char)
+      unless day
+        raise "Invalid day specifier: '#{day_char}'"
+      end
+      make(day, hour.to_i, min.to_i)
+    end
+
+    def self.make(day, hour, minute)
+      minute + hour * 60 + day * 24 * 60
+    end
+
+    def self.from_localtime(localtime)
+      make(localtime.wday, localtime.hour, localtime.min)
+    end
+
+    def self.add_day(wmin)
+      wmin + DAY
+    end
+
+  end
+end

data/lib/abstractivator/schedule/schedule_runner.rb

@@ -0,0 +1,34 @@
+begin
+  require 'eventmachine'
+rescue
+  raise "ScheduleRunner requires EventMachine but `require 'eventmachine'` failed."
+end
+
+# Performs an action periodically, but only at times allowed by a Schedule.
+class ScheduleRunner
+  def self.run_on_schedule(task, &action)
+    ScheduleRunner.new(task, action).start
+  end
+
+  def initialize(task, action)
+    @task = task
+    @action = action
+  end
+
+  def start
+    run_after(@task.interval_seconds)
+  end
+
+  def run_after(seconds_to_wait)
+    @task.before_waiting(seconds_to_wait)
+    @task.pump.add_timer(seconds_to_wait) do
+      schedule = @task.schedule
+      if schedule.permits?(Time.now)
+        @action.call
+        run_after(@task.interval_seconds)
+      else
+        run_after(schedule.downtime_minutes_from(Time.now) * 60)
+      end
+    end
+  end
+end

data/lib/abstractivator/schedule.rb

@@ -0,0 +1,2 @@
+require 'abstractivator/schedule/schedule'
+require 'abstractivator/schedule/schedule_runner'

data/lib/abstractivator/version.rb

@@ -1,3 +1,3 @@
 module Abstractivator
-  VERSION = '0.0.31'
+  VERSION = '0.1.0'
 end

data/spec/lib/abstractivator/schedule/em_util.rb

@@ -0,0 +1,16 @@
+require 'eventmachine'
+
+def em
+  EM.run do
+    EM.add_timer(in_debug_mode? ? 999999 : 3) { raise 'EM spec timed out' }
+    yield
+  end
+end
+
+def in_debug_mode?
+  ENV['RUBYLIB'] =~ /ruby-debug-ide/ # http://stackoverflow.com/questions/22039807/determine-if-a-program-is-running-in-debug-mode
+end
+
+def done
+  EM.stop
+end

data/spec/lib/abstractivator/schedule/schedule_runner_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec/core'
+require 'abstractivator/schedule/schedule'
+require 'abstractivator/schedule/schedule_runner'
+require_relative './em_util'
+
+describe ScheduleRunner do
+  let(:task) {double}
+  let(:interval) {0.1}
+
+  before(:each) do
+    allow(task).to receive(:interval_seconds) {interval}
+    allow(task).to receive(:before_waiting)
+    allow(task).to receive(:pump) {EventMachine}
+    allow(task).to receive(:schedule) {Schedule.new('00:00-24:00')}
+  end
+
+  describe '::run_on_schedule' do
+    it 'waits for an interval before starting' do
+      em do
+        start = Time.now
+        ScheduleRunner.run_on_schedule(task) do
+          expect(Time.now - start).to be_within(ten_percent_of(interval)).of(interval)
+          done
+        end
+      end
+    end
+    it 'runs periodically' do
+      em do
+        last = Time.now
+        n = 0
+        ScheduleRunner.run_on_schedule(task) do
+          n += 1
+          expect(Time.now - last).to be_within(ten_percent_of(interval)).of(interval)
+          last = Time.now
+          done if n == 3
+        end
+      end
+    end
+    it 'only runs during scheduled times' do
+      em do
+        start = Time.now + 3 * 60
+        stop = Time.now + 4 * 60
+        allow(task).to receive(:schedule) {Schedule.new("#{start.hour}:#{start.min}-#{stop.hour}:#{stop.min}")}
+        orig_add_timer = EventMachine.method(:add_timer)
+        expect(EventMachine).to receive(:add_timer).with(interval) {|s, &block| orig_add_timer.(s, &block)}.ordered
+        expect(EventMachine).to receive(:add_timer).with(3 * 60) {done}.ordered
+        ScheduleRunner.run_on_schedule(task) {}
+      end
+    end
+    it 'calls before_waiting before waiting' do
+      em do
+        expect(task).to receive(:before_waiting).with(interval).ordered
+        expect(EventMachine).to receive(:add_timer) {done}.ordered
+        ScheduleRunner.run_on_schedule(task) {}
+      end
+    end
+  end
+
+  def ten_percent_of(x)
+    x / 10.0
+  end
+end

data/spec/lib/abstractivator/schedule/schedule_spec.rb

@@ -0,0 +1,97 @@
+require 'rspec/core'
+require 'abstractivator/schedule/schedule'
+
+describe Schedule do
+  let(:sunday) { 0 }
+  let(:monday) { 1 }
+  let(:tuesday) { 2 }
+  let(:wednesday) { 3 }
+  let(:thursday) { 4 }
+  let(:friday) { 5 }
+  let(:saturday) { 6 }
+  describe '#new' do
+    it 'raises an exception when no periods are specified' do
+      expect{Schedule.new('')}.to raise_exception StandardError
+      expect{Schedule.new(',,,')}.to raise_exception StandardError
+      expect{Schedule.new('asdf')}.to raise_exception StandardError
+    end
+    it 'accepts schedule strings delimited by commas and/or spaces' do
+      expect(Schedule.new('1:00-12:00,15:00-16:00')).to be_a Schedule
+      expect(Schedule.new('1:00-12:00 15:00-16:00')).to be_a Schedule
+      expect(Schedule.new('1:00-12:00, 15:00-16:00')).to be_a Schedule
+      expect(Schedule.new('1:00-12:00 ,15:00-16:00')).to be_a Schedule
+    end
+  end
+  describe '#permits?' do
+    it 'indicates if schedule permits the given time' do
+      s = Schedule.new('1:00-2:00')
+      assert_rejects(s, 0, 59)
+      assert_permits(s, 1, 0)
+      assert_permits(s, 1, 30)
+      assert_permits(s, 1, 59)
+      assert_rejects(s, 2, 00)
+    end
+    it 'allows day-of-week specifiers' do
+      s = Schedule.new('1:00-2:00#MWF')
+      assert_rejects(s, 1, 30, sunday)
+      assert_permits(s, 1, 30, monday)
+      assert_rejects(s, 1, 30, tuesday)
+      assert_permits(s, 1, 30, wednesday)
+      assert_rejects(s, 1, 30, thursday)
+      assert_permits(s, 1, 30, friday)
+      assert_rejects(s, 1, 30, saturday)
+    end
+    it 'allows any reasonable day-of-week delimiter' do
+      good = %w(# @ / |)
+      good.each do |delimiter|
+        Schedule.new("1:00-2:00#{delimiter}MWF")
+      end
+      bad = %w(- : . 4 M) + [' ']
+      bad.each do |delimiter|
+        expect { Schedule.new("1:00-2:00#{delimiter}MWF") }.to raise_error
+      end
+    end
+    it 'raises an exception when a bad day-of-week specifier is provided' do
+      expect{Schedule.new('1:00-2:00#X')}.to raise_exception RuntimeError
+    end
+    it 'handles periods that cross midnight' do
+      s = Schedule.new('23:30-0:30')
+      assert_rejects(s, 23, 29)
+      assert_permits(s, 23, 30)
+      assert_permits(s, 0, 29)
+      assert_rejects(s, 0, 30)
+    end
+    it 'handles periods that cross the end of the week' do
+      s = Schedule.new('23:30-0:30#S')
+      assert_rejects(s, 23, 29, saturday)
+      assert_permits(s, 23, 30, saturday)
+      assert_permits(s, 0, 29, sunday)
+      assert_rejects(s, 0, 30, sunday)
+    end
+  end
+  describe '#downtime_minutes_from' do
+    it 'returns zero if the given time is permitted' do
+      s = Schedule.new('1:00-2:00')
+      expect(s.downtime_minutes_from(make_time(1, 23))).to eql 0
+    end
+    it 'returns the number of seconds until the start of the next permitted period' do
+      s = Schedule.new('1:00-2:00#M,3:00-4:00#M,3:00-4:00#T')
+      expect(s.downtime_minutes_from(make_time(0, 55, monday))).to eql 5
+      expect(s.downtime_minutes_from(make_time(2, 55, monday))).to eql 5
+      expect(s.downtime_minutes_from(make_time(4, 00, monday))).to eql 23 * 60
+      expect(s.downtime_minutes_from(make_time(4, 00, tuesday))).to eql (21 + 5 * 24) * 60
+    end
+  end
+
+  def assert_permits(s, hour, minute, day_of_week=0)
+    expect(s.permits?(make_time(hour, minute, day_of_week))).to be true
+  end
+
+  def assert_rejects(s, hour, minute, day_of_week=0)
+    expect(s.permits?(make_time(hour, minute, day_of_week))).to be false
+  end
+
+  def make_time(hour, minute, day_of_week=0, seconds=0)
+    Time.local(2014, 6, day_of_week + 1, hour, minute, seconds)
+  end
+end

data/spec/lib/enumerable_ext_spec.rb

@@ -8,9 +8,6 @@ describe Enumerable do
       result = xs.stable_sort{|a, b| a.abs <=> b.abs}
       expected_result = [1, -1, -2, 2]
       expect(result).to eql expected_result
-
-      normal_sort_result = xs.sort{|a, b| a.abs <=> b.abs}
-      expect(normal_sort_result).to_not eql expected_result
     end
 
     it 'does not require a block' do

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: abstractivator
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Winton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sourcify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 description: Utilities
@@ -73,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,6 +101,9 @@ files:
 - lib/abstractivator/enum.rb
 - lib/abstractivator/enumerable_ext.rb
 - lib/abstractivator/proc_ext.rb
+- lib/abstractivator/schedule.rb
+- lib/abstractivator/schedule/schedule.rb
+- lib/abstractivator/schedule/schedule_runner.rb
 - lib/abstractivator/trees.rb
 - lib/abstractivator/trees/block_collector.rb
 - lib/abstractivator/trees/recursive_delete.rb
@@ -100,6 +117,9 @@ files:
 - spec/lib/abstractivator/enum_spec.rb
 - spec/lib/abstractivator/enumerable_ext_spec.rb
 - spec/lib/abstractivator/proc_ext_spec.rb
+- spec/lib/abstractivator/schedule/em_util.rb
+- spec/lib/abstractivator/schedule/schedule_runner_spec.rb
+- spec/lib/abstractivator/schedule/schedule_spec.rb
 - spec/lib/abstractivator/trees/recursive_delete_spec.rb
 - spec/lib/abstractivator/trees/tree_compare_spec.rb
 - spec/lib/abstractivator/trees/tree_map_spec.rb
@@ -114,17 +134,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Utilities
@@ -135,6 +155,9 @@ test_files:
 - spec/lib/abstractivator/enum_spec.rb
 - spec/lib/abstractivator/enumerable_ext_spec.rb
 - spec/lib/abstractivator/proc_ext_spec.rb
+- spec/lib/abstractivator/schedule/em_util.rb
+- spec/lib/abstractivator/schedule/schedule_runner_spec.rb
+- spec/lib/abstractivator/schedule/schedule_spec.rb
 - spec/lib/abstractivator/trees/recursive_delete_spec.rb
 - spec/lib/abstractivator/trees/tree_compare_spec.rb
 - spec/lib/abstractivator/trees/tree_map_spec.rb