later 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in later.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Erol Fornoles
+
+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,80 @@
+# Later
+
+[**Later**](erol.github.com/later) is a Redis-backed event scheduling library for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'later'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install later
+
+## Usage
+
+If you're not using Bundler to require your gems, you will need to require Later in your application:
+
+    require 'later'
+
+Later allows you to manage multiple schedule sets:
+
+    Later[:reservations]
+    Later[:appointments]
+
+The schedule sets are referenced based on the default Redis instance. If you need a schedule set which resides on a different Redis instance, you can pass a [Nest](github.com/soveran/nest) object.
+
+	redis = Redis.new host: host, port: port
+    key = Nest.new :reservations, redis
+
+    Later[key]
+
+Setting an event schedule is simple:
+
+	Later[key].set 'my-unique-event', Time.now + 60
+	
+And can be reset with equal simplicity:
+
+	Later[key].set 'my-unique-event', Time.now + 120
+
+An event schedule can also be unset:
+
+	Later[key].unset 'my-unique-event'
+	
+Note that event names should be unique in the scope of the schedule set.
+	
+### Workers
+
+Workers are Ruby processes that run forever. They allow you to process event schedules in the background:
+
+	require 'later'
+	
+    Later[:reservations].each do |event|
+      # Do something with the event.
+    end
+    
+    # This line is never reached.
+    
+If for some reason, a worker has to stop itself from running:
+
+    Later[:reservations].each do |event|
+      # Do something with the event.
+
+      Later[:reservations].stop if stop?
+    end
+    
+    # This line is reached if stop? is true.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch ( `git checkout -b my-new-feature` )
+3. Create tests and make them pass ( `rake test` )
+4. Commit your changes ( `git commit -am 'Added some feature'` )
+5. Push to the branch ( `git push origin my-new-feature` )
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/lib/*.rb']
+  t.verbose = true
+end

data/later.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/later/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Erol Fornoles']
+  gem.email         = ['erol.fornoles@gmail.com']
+  gem.description   = %q{Later is a Redis-backed event scheduling library for Ruby}
+  gem.summary       = %q{Later is a Redis-backed event scheduling library for Ruby}
+  gem.homepage      = 'http://erol.github.com/later'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'later'
+  gem.require_paths = ['lib']
+  gem.version       = Later::VERSION
+
+  gem.add_dependency 'redis'
+  gem.add_dependency 'nest'
+
+  gem.add_development_dependency 'minitest'
+end

data/lib/later.rb

@@ -0,0 +1,80 @@
+require 'later/version'
+require 'redis'
+require 'nest'
+
+module Later
+  class Schedule
+    def key
+      @key
+    end
+
+    def initialize(key)
+      if key.is_a?(Nest)
+        @key = key
+      else
+        @key = Later.key[key]
+      end
+    end
+
+    def [](event)
+      Time.at key[:schedule].zscore(event) rescue nil
+    end
+
+    def count
+      key[:schedule].zcard
+    end
+
+    def set(event, time)
+      key[:schedule].zadd time.to_i, event
+    end
+
+    def unset(event)
+      key[:schedule].zrem event
+    end
+
+    def stop
+      @stop = true
+    end
+
+    def each(&block)
+      @stop = false
+
+      loop do
+        break if @stop
+
+        time = Time.now.to_i
+
+        key[:schedule].redis.multi
+        key[:schedule].zrangebyscore '-inf', time
+        key[:schedule].zremrangebyscore '-inf', time
+        ids = key[:schedule].redis.exec.first
+
+        key.redis.pipelined do
+          ids.each do |id|
+            key[:queue].lpush id
+          end
+        end
+
+        event = key[:queue].brpoplpush(key[:now], 1)
+
+        next unless event
+
+        block.call event
+      end
+    end
+  end
+
+  @schedules = {}
+
+  def self.key
+    Nest.new('Later')
+  end
+
+  def self.[](schedule)
+    if @schedules[schedule.to_sym]
+      @schedules[schedule.to_sym]
+    else
+      @schedules[schedule.to_sym] = Schedule.new schedule
+    end
+  end
+end

data/lib/later/version.rb

@@ -0,0 +1,3 @@
+module Later
+  VERSION = '0.1.0'
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'later'
+require 'minitest/autorun'
+
+class MiniTest::Unit::TestCase
+  def setup
+    system 'redis-server', File.join(File.dirname(__FILE__), 'redis.conf')
+    until File.exist? 'redis.pid'
+      sleep 1
+    end
+  end
+
+  def teardown
+    system "kill `cat redis.pid`"
+    sleep 1
+  end
+end

data/test/lib/later.rb

@@ -0,0 +1,74 @@
+require_relative '../helper.rb'
+
+class LaterTest < MiniTest::Unit::TestCase
+  def setup
+    super
+
+    @redis = Redis.new host: '127.0.0.1', port: 6666
+    @key = Nest.new 'Events', @redis
+  end
+
+  def test_set_a_unique_event_schedule
+    time = Time.now
+
+    Later[@key].set '1', time
+
+    assert_equal 1, Later[@key].count
+    assert_in_delta time, Later[@key]['1'], 1
+  end
+
+  def test_unset_a_unique_event_schedule
+    time = Time.now
+
+    Later[@key].set '1', time
+    Later[@key].unset '1'
+
+    assert_equal 0, Later[@key].count
+    assert_equal nil, Later[@key]['1']
+  end
+
+  def test_count_set_and_unset_event_schedules
+    time = Time.now
+
+    1.upto(10) do |i|
+      Later[@key].set i.to_s, time
+      assert_equal i, Later[@key].count
+    end
+
+    1.upto(10) do |i|
+      Later[@key].unset i.to_s
+      assert_equal 10 - i, Later[@key].count
+    end
+  end
+
+  def test_process_many_event_schedules
+    start = Time.now + 20
+
+    times = []
+    schedules = Hash.new { |h,k| h[k] = [] }
+
+    1.upto(1000) do |i|
+      time = start + i / 100
+      times.unshift time
+      schedules[time].unshift event: i.to_s, time: time
+    end
+
+    times.map{ |time| schedules[time] }.flatten.shuffle.each do |schedule|
+      Later[@key].set schedule[:event], schedule[:time]
+    end
+
+    Thread.new do
+      sleep 30
+      Later[@key].stop
+    end
+
+    Later[@key].each do |event|
+      time = times.pop
+
+      assert_in_delta time, Time.now, 1.2
+      assert_includes schedules[time], {event: event, time: time}
+    end
+
+    assert_equal 0, Later[@key].count
+  end
+end

data/test/redis.conf

@@ -0,0 +1,3 @@
+daemonize yes
+port 6666
+pidfile ./redis.pid

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: later
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Erol Fornoles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Later is a Redis-backed event scheduling library for Ruby
+email:
+- erol.fornoles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- later.gemspec
+- lib/later.rb
+- lib/later/version.rb
+- test/helper.rb
+- test/lib/later.rb
+- test/redis.conf
+homepage: http://erol.github.com/later
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Later is a Redis-backed event scheduling library for Ruby
+test_files:
+- test/helper.rb
+- test/lib/later.rb
+- test/redis.conf