em-scheduled-timer 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leo Cassarani
+
+MIT License
+
+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/README.md

@@ -0,0 +1,66 @@
+# EM::ScheduledTimer
+
+EventMachine timers are great, but they work by waiting for a specified
+time interval before firing. Instead, `EM::ScheduledTimer` lets you
+specify a `Time`, `Date` or `DateTime` object (or indeed anything that will
+respond to `to_time`).
+
+## Why is this useful?
+
+Imagine you're polling an HTTP-based API for changes. Because the API is
+nice, it will set `Expires` response headers so you know when to make
+the next request. With `EM::ScheduledTimer` (and the
+[em-http-request](https://github.com/igrigorik/em-http-request) gem),
+this becomes very easy:
+
+    def poll_api
+      http = EM::HttpRequest.new("http://api.example.com/changes")
+      http.callback do
+        expires = http.response_header['EXPIRES']
+        time = Time.httpdate(expires)
+        EM::ScheduledTimer.new(time) { poll_api }
+      end
+    end
+
+## Usage
+
+Generally speaking, the API for a `ScheduledTimer` is modelled after
+that of a regular `EM::Timer`.
+
+You can create `EM::ScheduledTimer` instances and pass in a block:
+
+    EM::ScheduledTimer.new(some_future_time) do
+      puts "Fire!"
+    end
+
+Alternatively, you can pass in any object that responds to `#call`
+(including a `Proc`):
+
+    callback = -> { puts "Fire!" }
+    EM::ScheduledTimer.new(some_future_time, callback)
+
+A `ScheduledTimer` can also be cancelled:
+
+    timer = EM::ScheduledTimer.new(some_future_time) do
+      puts "Fire!"
+    end
+
+    timer.cancel # The timer won't fire
+
+As with regular timers, a convenience method is available on the
+`EventMachine` module:
+
+    EM.add_scheduled_timer(some_future_time) do
+      puts "Fire!"
+    end
+
+Note that in the latter case, you won't be able to cancel a timer that
+you've scheduled.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/em-scheduled-timer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'em-scheduled-timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "em-scheduled-timer"
+  spec.version       = EventMachine::ScheduledTimer::VERSION
+  spec.authors       = ["Leo Cassarani"]
+  spec.email         = ["leo.cassarani@me.com"]
+  spec.description   = %q{EM::ScheduledTimer provides EventMachine timers that let you specify a time, rather than an interval, at which to fire.}
+  spec.summary       = %q{EventMachine timers that fire at a given time in the future}
+  spec.homepage      = "https://github.com/leocassarani/em-scheduled-timer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "eventmachine", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/em-scheduled-timer.rb

@@ -0,0 +1,26 @@
+require "eventmachine"
+require "em-scheduled-timer/version"
+
+module EventMachine
+  class ScheduledTimer
+    def initialize(time, callback = nil, &block)
+      @signature = EventMachine.add_timer(interval(time), callback || block)
+    end
+
+    def cancel
+      EventMachine.cancel_timer(@signature)
+    end
+
+    private
+
+    def interval(time)
+      time.to_time - Time.now
+    end
+  end
+
+  def self.add_scheduled_timer(*args, &block)
+    interval = args.shift
+    callback = args.shift || block
+    EventMachine::ScheduledTimer.new(interval, callback)
+  end
+end

data/lib/em-scheduled-timer/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  class ScheduledTimer
+    VERSION = "0.1.0"
+  end
+end

data/spec/em-scheduled-timer_spec.rb

@@ -0,0 +1,73 @@
+require 'em-scheduled-timer'
+require 'time'
+require File.expand_path('../support/eventmachine_helper', __FILE__)
+
+describe EM::ScheduledTimer do
+  include EventMachineHelper
+
+  let(:soon) { Time.now + 0.1 }
+
+  describe "instantiating new ScheduledTimers directly" do
+    it "runs a block at the given time" do
+      EM.run {
+        EventMachine::ScheduledTimer.new(soon) { pass }
+        fail_after(0.2)
+      }
+    end
+
+    it "can be given a callable object instead of a block" do
+      EM.run {
+        callback = lambda { pass }
+        EventMachine::ScheduledTimer.new(soon, callback)
+        fail_after(0.2)
+      }
+    end
+
+    it "can be cancelled" do
+      EM.run {
+        timer = EventMachine::ScheduledTimer.new(soon) do
+          fail "Expected timer not to fire, but it did"
+        end
+
+        timer.cancel
+
+        pass_after(0.2)
+      }
+    end
+  end
+
+  describe "using the EM.add_scheduled_timer convenience method" do
+    it "runs a block at the given time" do
+      EM.run {
+        EM.add_scheduled_timer(soon) { pass }
+        fail_after(0.2)
+      }
+    end
+
+    it "can be given a callable object instead of a block" do
+      EM.run {
+        callback = lambda { pass }
+        EM.add_scheduled_timer(soon, callback)
+        fail_after(0.2)
+      }
+    end
+  end
+
+  describe "specifying a firing time" do
+    it "supports DateTime objects" do
+      EM.run {
+        datetime = soon.to_datetime
+        EventMachine::ScheduledTimer.new(datetime) { pass }
+        fail_after(0.2)
+      }
+    end
+
+    it "supports any object that responds to #to_time" do
+      EM.run {
+        future = mock(:future, to_time: soon)
+        EventMachine::ScheduledTimer.new(future) { pass }
+        fail_after(0.2)
+      }
+    end
+  end
+end

data/spec/support/eventmachine_helper.rb

@@ -0,0 +1,15 @@
+module EventMachineHelper
+  def fail_after(interval)
+    EM.add_timer(interval) do
+      fail "Expected timer to fire at the scheduled time, but it didn't"
+    end
+  end
+
+  def pass
+    EM.stop
+  end
+
+  def pass_after(interval)
+    EM.add_timer(interval) { pass }
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: em-scheduled-timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Leo Cassarani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: EM::ScheduledTimer provides EventMachine timers that let you specify
+  a time, rather than an interval, at which to fire.
+email:
+- leo.cassarani@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- em-scheduled-timer.gemspec
+- lib/em-scheduled-timer.rb
+- lib/em-scheduled-timer/version.rb
+- spec/em-scheduled-timer_spec.rb
+- spec/support/eventmachine_helper.rb
+homepage: https://github.com/leocassarani/em-scheduled-timer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3497934660945191801
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3497934660945191801
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: EventMachine timers that fire at a given time in the future
+test_files:
+- spec/em-scheduled-timer_spec.rb
+- spec/support/eventmachine_helper.rb