eventmachinealignedperiodic 2.1.1

data/History.txt

@@ -0,0 +1,27 @@
+# History for EventMachineAlignedPeriodic
+
+## v2.1.1 (April 13 2013)
+
+* forgot to interpolate a token in a log message
+
+## v2.1.0 (April 13 2013)
+
+* add a fourth arg to the constructor, an optional logger that must respond to #debug.  If provided, it logs exceptions in the periodic scheduler and the time of the next event after scheduling
+
+## v2.0.1 (April 7 2013)
+
+* use thread mutex in periodic caller as well
+
+## v2.0.0 (April 4 2013)
+
+* changed invocation style.  You now call start on the object rather than runner.go
+* added poke method to kick off the periodic event outside of normal times. Note that attempting to poke when the periodic scheduler is not running throws an exception
+* added stop method to stop event scheduling.  This calls the periodic event one last time with a true arg
+* protected public methods with a thread mutex
+* made private that which should be private
+* added an reader :nextevent with the time the next event should kick off
+* fixed arg to periodic event: should always reflect whether the method represents a full period or not
+
+## v1.0.0 (March 15 2013)
+
+* initial version released on Github

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012, 2013 James FitzGibbon <james@nadt.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+LICENSE.txt
+Rakefile
+lib/eventmachine_alignedperiodic.rb
+eventmachinealignedperiodic.gemspec

data/README.txt

@@ -0,0 +1,85 @@
+# EventMachineAlignedPeriodic
+
+home :: https://github.com/jf647/EventMachineAlignedPeriodic
+
+## SUMMARY:
+
+EventMachine helper to call a block on a periodic schedule with clock alignment.
+
+## DESCRIPTION
+
+EventMachineAlignedPeriodic helps to kick off a block of code on a periodic
+schedule aligned with a time period.  Rather than have something starting at
+2 seconds, 17 seconds, 32 seconds and so on you can have it consistently
+launch at 0, 15, 30.
+
+## SYNOPSIS:
+
+    require 'eventmachine'
+    require 'eventmachine_alignedperiodic'
+    require 'logger'
+
+    log = Logger.new(STDOUT)
+    log.level = Logger::DEBUG
+
+    periodic = EventMachine::AlignedPeriodic.new(interval, proc {
+          |partial| do_something(partial)
+    }, offset, log)
+
+    def do_something(partial)
+        puts "Yay! I just did something"
+        if partial
+            puts "... but only partially"
+        end
+    end
+
+    EM.run {
+        periodic.start
+        puts "next event is at #{periodic.nextevent}"
+        periodic.poke
+        periodic.stop
+    }
+
+Assuming that interval was 900 (15 minutes) and offset was 30, do_something will be called
+at the next aligned 15 minute interval.  So if you started your program at 10:07:06, it would
+be called at 10:15:30, then at 10:30:30, 10:45:30 and so on.
+
+Clock resolution and EventMachine latency means that the proc is usually kicked off tens or
+hundreds of microseconds after the interval.
+
+The first time the proc is called and the last time (when the EventMachine loop shuts down) the
+partial flag will be true.  Every other time it will be false.
+
+## LICENSE:
+
+The MIT License (MIT)
+
+Copyright (c) 2012, 2013 James FitzGibbon <james@nadt.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+## Contributing to EventMachineAlignedPeriodic
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the version or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+require 'hoe'
+
+Hoe.plugin :gemspec
+Hoe.plugin :bundler
+
+Hoe.spec 'eventmachinealignedperiodic' do
+    developer("James FitzGibbon", "james@nadt.net")
+    license "MIT"
+    dependency 'eventmachine', '~> 1.0.3'
+    dependency 'hoe', '~> 3.7.1', :dev
+    dependency 'hoe-gemspec', '~> 1.0.0', :dev
+    dependency 'hoe-bundler', '~> 1.2.0', :dev
+    dependency 'simplecov', '~> 0.7.1', :dev
+    dependency 'simplecov-console', '~> 0.1.1', :dev
+    dependency 'minitest', '~> 5.0.8', :dev
+    dependency 'minitest-debugger', '~> 1.0.2', :dev
+end
+
+task :default => [:unit_tests]
+
+task :package => [ 'gem:spec', 'bundler:gemfile' ]
+
+desc "Run basic tests"
+Rake::TestTask.new("unit_tests") { |t|
+    t.libs.push 'lib'
+    t.libs.push 'test'
+    t.pattern = 'test/test_*.rb'
+    t.verbose = true
+    t.warning = false
+}

data/eventmachinealignedperiodic.gemspec

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "eventmachinealignedperiodic"
+  s.version = "2.1.1.20131112160551"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James FitzGibbon"]
+  s.date = "2013-11-13"
+  s.description = "EventMachineAlignedPeriodic helps to kick off a block of code on a periodic\nschedule aligned with a time period.  Rather than have something starting at\n2 seconds, 17 seconds, 32 seconds and so on you can have it consistently\nlaunch at 0, 15, 30."
+  s.email = ["james@nadt.net"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt", "Rakefile", "lib/eventmachine_alignedperiodic.rb", "eventmachinealignedperiodic.gemspec", "test/test_eventmachine_alignedperiodic.rb", ".gemtest"]
+  s.homepage = "https://github.com/jf647/EventMachineAlignedPeriodic"
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "eventmachinealignedperiodic"
+  s.rubygems_version = "1.8.23"
+  s.summary = "EventMachineAlignedPeriodic helps to kick off a block of code on a periodic schedule aligned with a time period"
+  s.test_files = ["test/test_eventmachine_alignedperiodic.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, ["~> 1.0.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.7.1"])
+      s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.7.1"])
+      s.add_development_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+      s.add_development_dependency(%q<minitest>, ["~> 5.0.8"])
+      s.add_development_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+    else
+      s.add_dependency(%q<eventmachine>, ["~> 1.0.3"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.7.1"])
+      s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+      s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+      s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
+      s.add_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+      s.add_dependency(%q<minitest>, ["~> 5.0.8"])
+      s.add_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, ["~> 1.0.3"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.7.1"])
+    s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+    s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+    s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
+    s.add_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+    s.add_dependency(%q<minitest>, ["~> 5.0.8"])
+    s.add_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+  end
+end

data/lib/eventmachine_alignedperiodic.rb

@@ -0,0 +1,98 @@
+require 'eventmachine'
+require 'date'
+require 'thread'
+
+module EventMachine
+
+    class AlignedPeriodic
+
+        VERSION = '2.1.1'
+    
+        attr_reader :nextevent
+
+        def initialize(interval, p, offset = 0, logger = nil)
+            @interval = interval
+            @offset = offset
+            @p = p
+            @logger = logger
+            @partial = true
+            @running = false
+            @mutex = Mutex.new
+        end
+
+        def start
+            @mutex.synchronize {
+                EventMachine.add_shutdown_hook { @p.call(true) }
+                @running = true
+                schedule_first_event
+            }
+        end
+
+        def poke
+            @mutex.synchronize {
+                # if we aren't running, we can't be poked
+                unless @running
+                    raise "periodic schedulder not running; can't be poked"
+                end
+                EventMachine.cancel_timer(@timer)
+                @p.call(true)
+                @partial = true
+                schedule_next_event
+            }
+        end
+        
+        def stop
+            @mutex.synchronize {
+                EventMachine.cancel_timer(@timer)
+                @running = false
+                @p.call(true)
+            }
+        end
+        
+        private
+        
+        def do_periodic
+            @mutex.synchronize {
+                # we can't remove shutdown hooks, so if we aren't running, do nothing
+                return unless @running
+                begin
+                    @p.call(@partial)
+                rescue => e
+                    if ! @logger.nil?
+                        @logger.debug("exception in do_periodic: #{e}")
+                    end
+                end
+                @partial = false if @partial
+                @lastevent = @nextevent
+                schedule_next_event
+            }
+        end
+        
+        def schedule_first_event
+            now = Time.now
+            if @lastevent.nil?
+                @lastevent = now.to_date.to_time + @offset
+                while @lastevent + @interval < now
+                    @lastevent += @interval
+                end
+            end
+            @nextevent = @lastevent + @interval
+            schedule
+        end
+        
+        def schedule_next_event
+            @nextevent = @lastevent + @interval
+            schedule
+        end
+        
+        def schedule
+            if ! @logger.nil?
+                @logger.debug("next event is at #{@nextevent}")
+            end
+            nextevent_in = @nextevent - Time.now
+            @timer = EventMachine.add_timer(nextevent_in) { do_periodic() }
+        end
+    
+    end
+
+end

data/test/test_eventmachine_alignedperiodic.rb

@@ -0,0 +1,8 @@
+require 'minitest_helper'
+
+class TestEVMAAlignedPeriodic < Minitest::Test
+    def test_constructor
+        aligned = EventMachine::AlignedPeriodic.new(900, proc { puts "foo" })
+        assert_instance_of EventMachine::AlignedPeriodic, aligned, "constructor works"
+    end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: eventmachinealignedperiodic
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+  prerelease: 
+platform: ruby
+authors:
+- James FitzGibbon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hoe-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: minitest-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: ! 'EventMachineAlignedPeriodic helps to kick off a block of code on a
+  periodic
+
+  schedule aligned with a time period.  Rather than have something starting at
+
+  2 seconds, 17 seconds, 32 seconds and so on you can have it consistently
+
+  launch at 0, 15, 30.'
+email:
+- james@nadt.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+- Rakefile
+- lib/eventmachine_alignedperiodic.rb
+- eventmachinealignedperiodic.gemspec
+- test/test_eventmachine_alignedperiodic.rb
+- .gemtest
+homepage: https://github.com/jf647/EventMachineAlignedPeriodic
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: eventmachinealignedperiodic
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: EventMachineAlignedPeriodic helps to kick off a block of code on a periodic
+  schedule aligned with a time period
+test_files:
+- test/test_eventmachine_alignedperiodic.rb