redis-scheduler 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4c61ee6608f6112456f84933f3b209f879a3401
-  data.tar.gz: ae05d544a25078cd248a0e70ea005fca7df1e629
+  metadata.gz: d86d2f1e9780f66e41e977a2f8e282e75b50c3e8
+  data.tar.gz: 9df37814b8decc86caa1a3da82a8500b59653b3d
 SHA512:
-  metadata.gz: ce8cd9ee9ba8b78a436bb1e680cb7f34b6fb3bdb41907a4bb8825053371e286e8082935f768b1fe727b3b509848d1405c44a12aaffd7ad4ca99c4a189e40765a
-  data.tar.gz: 257cbd5324c02e216ee497a72ea4adbe3c9fa74d9795d7fd4143be41b3d186d08559883d969f29ce97837dd99e52a7bff0a2bd09f52e4197ace5122f7000b9e9
+  metadata.gz: e91b0f8151013796b90d91dc87cf9c12210a68f5e65309064c3ccc93eec0058da8e379ed2cbc07fe1ab154a3cf587b079c8f58d519d26049d9d379cec4abf4a0
+  data.tar.gz: bdb246caeb6415100a6549eb63dd79afe7709031079d33dd233aa8821f2521cdc562c999034cd7e304abe891c82eb02859cb2f4af1830ab3f55cb03fbbd06f24

data/COPYING

@@ -1,4 +1,4 @@
-Redis Scheduler is copyright (c) 2012 William Morgan <wmorgan@masanjin.net>
+Redis Scheduler is copyright (c) 2012-2014 William Morgan <wmorgan@masanjin.net>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/lib/redis-scheduler.rb

@@ -67,7 +67,10 @@ class RedisScheduler
     @counter = [@namespace, "counter"].join
   end
 
-  ## Schedule an item at a specific time. item will be converted to a string.
+  attr_reader :redis, :namespace, :blocking, :uniq, :queue
+
+  ## Schedule an item at a specific time. Item is any Ruby object that can
+  ## be marshalled.
   def schedule! item, time
     @redis.zadd @queue, time.to_f, make_entry(item)
   end
@@ -116,7 +119,7 @@ class RedisScheduler
   ## to the schedule happen while iterating.
   ##
   ## For these reasons, this is mainly useful for debugging purposes.
-  def items; ItemEnumerator.new(@redis, @queue, @uniq) end
+  def items; ItemEnumerator.new(self) end
 
   ## Returns an Array of [item, timestamp, descriptor] tuples representing the
   ## set of in-process items. The timestamp corresponds to the time at which
@@ -128,28 +131,38 @@ class RedisScheduler
     end
   end
 
+  ## the inverse of #make_entry below. public because it must also be called by
+  ## ItemEnumerator.
+  def parse_entry entry
+    item = if @uniq
+      entry
+    else
+      delim = entry.index ":"
+      entry[(delim + 1) .. -1]
+    end
+    begin
+      Marshal.load item
+    rescue TypeError
+      ## fall back to treating the item as a string--it's possible the schedule contains
+      ## items inserted from a pre-0.9 release, in which case they'll be stored
+      ## as pure strings.
+      item
+    end
+  end
+
 private
 
   ## generate the value actually stored in redis
   def make_entry item
+    item = Marshal.dump item
     if @uniq
-      item.to_s
+      item
     else
       id = @redis.incr @counter
       "#{id}:#{item}"
     end
   end
 
-  ## the inverse of #make_item_value
-  def parse_entry entry
-    if @uniq
-      entry
-    else
-      entry =~ /^\d+:(\S+)$/ or raise InvalidEntryException, entry
-      $1
-    end
-  end
-
   def get descriptor; @blocking ? blocking_get(descriptor) : nonblocking_get(descriptor) end
 
   def blocking_get descriptor
@@ -190,10 +203,8 @@ private
   ## Supports random access with #[], with the same caveats as above.
   class ItemEnumerator
     include Enumerable
-    def initialize redis, q, uniq
-      @redis = redis
-      @q = q
-      @uniq = uniq
+    def initialize scheduler
+      @scheduler = scheduler
     end
 
     PAGE_SIZE = 50
@@ -207,24 +218,14 @@ private
     end
 
     def [] start, num=nil
-      elements = @redis.zrange @q, start, start + (num || 0), :withscores => true
+      elements = @scheduler.redis.zrange @scheduler.queue, start, start + (num || 0), :withscores => true
       v = elements.map do |entry, at|
-        item = parse_entry entry
+        item = @scheduler.parse_entry entry
         [item, Time.at(at.to_f)]
       end
       num ? v : v.first
     end
 
-    def size; @redis.zcard @q end
-
-    ## duplicated :(
-    def parse_entry entry
-      if @uniq
-        entry
-      else
-        entry =~ /^\d+:(\S+)$/ or raise InvalidEntryException, entry
-        $1
-      end
-    end
+    def size; @scheduler.redis.zcard @scheduler.queue end
   end
 end

data/test/redis-scheduler.rb

@@ -115,4 +115,31 @@ class RedisSchedulerTest < Minitest::Test
       assert_equal ["b", "a"], items
     end
   end
+
+  class Potato
+    def initialize x, y, z
+      @x = x
+      @y = y
+      @z = z
+    end
+
+    attr_reader :x, :y, :z
+  end
+
+  def test_can_schedule_ruby_objects
+    Timecop.freeze TIME do
+      @scheduler.schedule! Potato.new(10, ["hello", :there], /bob/), (TIME + 99)
+    end
+
+    Timecop.freeze(TIME + 99) do
+      potato = nil
+      @scheduler.each do |item, ts|
+        potato = item
+      end
+
+      assert_equal 10, potato.x
+      assert_equal ["hello", :there], potato.y
+      assert_equal /bob/, potato.z
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-scheduler
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - William Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A simple, production-ready chronological scheduler for Redis. It allows you to schedule items to be processed at arbitrary points in the future, and easily
@@ -23,7 +23,8 @@ files:
 - lib/redis-scheduler.rb
 - test/redis-scheduler.rb
 homepage: http://gitub.com/wmorgan/redis-scheduler
-licenses: []
+licenses:
+- COPYING
 metadata: {}
 post_install_message: 
 rdoc_options: