adrian 1.2.0 → 1.3.0

data/lib/adrian/array_queue.rb

@@ -2,16 +2,17 @@ require 'adrian/queue'
 
 module Adrian
   class ArrayQueue < Queue
-    def initialize(array = [])
+    def initialize(array = [], options = {})
+      super(options)
       @array = array.map { |item| wrap_item(item) }
       @mutex = Mutex.new
     end
 
-    def pop
+    def pop_item
       @mutex.synchronize { @array.shift }
     end
 
-    def push(item)
+    def push_item(item)
       item = wrap_item(item)
       @mutex.synchronize { @array << item }
       self

data/lib/adrian/composite_queue.rb

@@ -3,6 +3,7 @@ require 'adrian/queue'
 module Adrian
   class CompositeQueue < Queue
     def initialize(*queues)
+      super()
       @queues = queues.flatten
     end
 

data/lib/adrian/directory_queue.rb

@@ -19,6 +19,7 @@ module Adrian
     #   1. It's much simpler than introducing a seperate monitoring process to handle lock expiry.
     #   2. This is an acceptable and rare event. e.g. it only happens when the process working on the item crashes without being able to release the lock
     def initialize(options = {})
+      super
       @available_path = options.fetch(:path)
       @reserved_path  = options.fetch(:reserved_path, default_reserved_path)
       @logger         = options[:logger]
@@ -26,7 +27,7 @@ module Adrian
       filters << Filters::Delay.new(:duration => options[:delay]) if options[:delay]
     end
 
-    def pop
+    def pop_item
       items.each do |item|
         return item if reserve(item)
       end
@@ -34,7 +35,7 @@ module Adrian
       nil
     end
 
-    def push(value)
+    def push_item(value)
       item = wrap_item(value)
       item.move(available_path)
       item.touch

data/lib/adrian/dispatcher.rb

@@ -25,7 +25,17 @@ module Adrian
       @running = true
 
       while @running do
-        if item = queue.pop
+        begin
+          item = queue.pop
+        rescue Adrian::Queue::ItemTooOldError => e
+          if handler = @failure_handler.handle(e)
+            handler.call(e.item, nil, e)
+          end
+          item = nil
+          next
+        end
+
+        if item
           delegate_work(item, worker_class)
         else
           if @stop_when_done

data/lib/adrian/queue.rb

@@ -1,11 +1,45 @@
 module Adrian
   class Queue
+    class ItemTooOldError < RuntimeError
+      attr_reader :item, :queue
+
+      def initialize(item, queue)
+        super()
+        @item  = item
+        @queue = queue
+      end
+    end
+
+    def initialize(options = {})
+      @options = options
+    end
+
     def pop
-      raise "#{self.class.name}#pop is not defined"
+      verify_age!(pop_item)
     end
 
     def push(item)
-      raise "#{self.class.name}#push is not defined"
+      push_item(item)
+    end
+
+    def verify_age!(item)
+      if item && max_age && item.age > max_age
+        raise ItemTooOldError.new(item, self)
+      end
+
+      item
+    end
+
+    def max_age
+      @max_age ||= @options[:max_age]
+    end
+
+    def pop_item
+      raise "#{self.class.name}#pop_item is not defined"
+    end
+
+    def push_item(item)
+      raise "#{self.class.name}#push_item is not defined"
     end
   end
 end

data/lib/adrian/queue_item.rb

@@ -6,5 +6,9 @@ module Adrian
       @value      = value
       @created_at = created_at
     end
+
+    def age
+      Time.now - created_at
+    end
   end
 end

data/lib/adrian/version.rb

@@ -1,3 +1,3 @@
 module Adrian
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/test/dispatcher_test.rb

@@ -3,7 +3,7 @@ require_relative 'test_helper'
 describe Adrian::Dispatcher do
   before do
     $done_items = []
-    @q          = Adrian::ArrayQueue.new
+    @q          = Adrian::ArrayQueue.new([], :max_age => 1000)
     @dispatcher = Adrian::Dispatcher.new(:stop_when_done => true)
     @worker     = TestWorker
   end
@@ -16,7 +16,7 @@ describe Adrian::Dispatcher do
     end
 
     def perform
-      $done_items << [@boss, @item.value]
+      $done_items << @item.value
     end
 
     def report_to(boss)
@@ -33,7 +33,38 @@ describe Adrian::Dispatcher do
 
       @dispatcher.start(@q, @worker)
 
-      $done_items.must_equal([[@dispatcher, 1], [@dispatcher, 2], [@dispatcher, 3]])
+      $done_items.must_equal([1, 2, 3])
+    end
+  end
+
+  describe "a queue with old items" do
+    before do
+      @q.push(Adrian::QueueItem.new(1, Time.now))
+      @old_item = Adrian::QueueItem.new(2, Time.now - 2000)
+      @q.push(@old_item)
+      @q.push(Adrian::QueueItem.new(3, Time.now))
+    end
+
+    it 'skips the old items' do
+      @dispatcher.start(@q, @worker)
+
+      $done_items.must_equal([1, 3])
+    end
+
+    it 'calls the handler for Adrian::Queue::ItemTooOldError' do
+      handled_items      = []
+      handled_exceptions = []
+
+      @dispatcher.on_failure(Adrian::Queue::ItemTooOldError) do |item, worker, exception|
+        handled_items      << item
+        handled_exceptions << exception
+      end
+
+      @dispatcher.start(@q, @worker)
+
+      handled_items.must_equal [@old_item]
+      handled_exceptions.size.must_equal 1
+      handled_exceptions.first.must_be_instance_of Adrian::Queue::ItemTooOldError
     end
   end
 

data/test/queue_test.rb

@@ -0,0 +1,30 @@
+require_relative 'test_helper'
+
+describe Adrian::Queue do
+  class TestQueue < Adrian::Queue
+    attr_accessor :item
+
+    def pop_item
+      @item
+    end
+
+    def push_item(item)
+      @item = item
+    end
+  end
+
+  describe 'when a max age is defined' do
+    before { @q = TestQueue.new(:max_age => 60) }
+
+    it 'validates the age of items' do
+      item = Adrian::QueueItem.new('value', Time.now)
+      @q.push(item)
+      @q.pop.must_equal item
+
+      item = Adrian::QueueItem.new('value', Time.now - 120)
+      @q.push(item)
+      lambda { @q.pop }.must_raise(Adrian::Queue::ItemTooOldError)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adrian
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,6 +105,7 @@ files:
 - test/file_item_test.rb
 - test/filters_test.rb
 - test/girl_friday_dispatcher_test.rb
+- test/queue_test.rb
 - test/rotating_directory_queue_test.rb
 - test/test_helper.rb
 - test/worker_test.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4323319423024807981
+      hash: -2683630190484643052
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4323319423024807981
+      hash: -2683630190484643052
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -150,6 +151,7 @@ test_files:
 - test/file_item_test.rb
 - test/filters_test.rb
 - test/girl_friday_dispatcher_test.rb
+- test/queue_test.rb
 - test/rotating_directory_queue_test.rb
 - test/test_helper.rb
 - test/worker_test.rb