adrian 1.1.2 → 1.2.0

data/lib/adrian.rb

@@ -1,13 +1,14 @@
 require 'adrian/version'
 
 module Adrian
-  autoload :ArrayQueue,           'adrian/array_queue'
-  autoload :CompositeQueue,       'adrian/composite_queue'
-  autoload :DirectoryQueue,       'adrian/directory_queue'
-  autoload :Dispatcher,           'adrian/dispatcher'
-  autoload :FileItem,             'adrian/file_item'
-  autoload :Filters,              'adrian/filters'
-  autoload :GirlFridayDispatcher, 'adrian/girl_friday_dispatcher'
-  autoload :QueueItem,            'adrian/queue_item'
-  autoload :Worker,               'adrian/worker'
+  autoload :ArrayQueue,             'adrian/array_queue'
+  autoload :CompositeQueue,         'adrian/composite_queue'
+  autoload :DirectoryQueue,         'adrian/directory_queue'
+  autoload :RotatingDirectoryQueue, 'adrian/rotating_directory_queue'
+  autoload :Dispatcher,             'adrian/dispatcher'
+  autoload :FileItem,               'adrian/file_item'
+  autoload :Filters,                'adrian/filters'
+  autoload :GirlFridayDispatcher,   'adrian/girl_friday_dispatcher'
+  autoload :QueueItem,              'adrian/queue_item'
+  autoload :Worker,                 'adrian/worker'
 end

data/lib/adrian/directory_queue.rb

@@ -11,7 +11,7 @@ module Adrian
       queue
     end
 
-    attr_reader :available_path, :reserved_path
+    attr_reader :available_path, :reserved_path, :logger
 
     # Note:
     # There is the possibility of an item being consumed by multiple processes when its still in the queue after its lock expires.
@@ -21,6 +21,7 @@ module Adrian
     def initialize(options = {})
       @available_path = options.fetch(:path)
       @reserved_path  = options.fetch(:reserved_path, default_reserved_path)
+      @logger         = options[:logger]
       filters << Filters::FileLock.new(:duration => options[:lock_duration], :reserved_path => reserved_path)
       filters << Filters::Delay.new(:duration => options[:delay]) if options[:delay]
     end
@@ -35,7 +36,7 @@ module Adrian
 
     def push(value)
       item = wrap_item(value)
-      item.move(@available_path)
+      item.move(available_path)
       item.touch
       self
     end
@@ -48,11 +49,13 @@ module Adrian
     protected
 
     def wrap_item(value)
-      value.is_a?(FileItem) ? value : FileItem.new(value)
+      item = value.is_a?(FileItem) ? value : FileItem.new(value)
+      item.logger ||= logger
+      item
     end
 
     def reserve(item)
-      item.move(@reserved_path)
+      item.move(reserved_path)
       item.touch
       true
     rescue Errno::ENOENT => e
@@ -60,7 +63,7 @@ module Adrian
     end
 
     def items
-      items = files.map { |file| FileItem.new(file) }
+      items = files.map { |file| wrap_item(file) }
       items.reject! { |item| !item.exist? || filter?(item) }
       items.sort_by(&:updated_at)
     end
@@ -70,11 +73,11 @@ module Adrian
     end
 
     def available_files
-      Dir.glob("#{@available_path}/*")
+      Dir.glob("#{available_path}/*")
     end
 
     def reserved_files
-      Dir.glob("#{@reserved_path}/*")
+      Dir.glob("#{reserved_path}/*")
     end
 
     def default_reserved_path

data/lib/adrian/file_item.rb

@@ -1,5 +1,6 @@
 module Adrian
   class FileItem < QueueItem
+    attr_accessor :logger
 
     def initialize(value, created_at = Time.now)
       @value      = value
@@ -22,6 +23,7 @@ module Adrian
 
     def move(destination)
       destination_path = File.join(destination, File.basename(path))
+      logger.info("Moving #{path} to #{destination_path}") if logger
       File.rename(path, destination_path)
       @value = destination_path
     end

data/lib/adrian/rotating_directory_queue.rb

@@ -0,0 +1,25 @@
+require 'adrian/directory_queue'
+require 'fileutils'
+
+module Adrian
+
+  class RotatingDirectoryQueue < DirectoryQueue
+    attr_reader :time_format
+
+    def initialize(options = {})
+      super
+      @time_format = options.fetch(:time_format, '%Y-%m-%d')
+    end
+
+    def available_path
+      path = "#{super}/#{Time.now.strftime(time_format)}"
+
+      if path != @previous_avaliable_path
+        FileUtils.mkdir_p(path)
+        @previous_avaliable_path = path
+      end
+
+      path
+    end
+  end
+end

data/lib/adrian/version.rb

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

data/test/directory_queue_test.rb

@@ -2,10 +2,12 @@ require_relative 'test_helper'
 require 'tempfile'
 require 'tmpdir'
 require 'fileutils'
+require 'logger'
 
 describe Adrian::DirectoryQueue do
   before do
-    @q = Adrian::DirectoryQueue.create(:path => Dir.mktmpdir('dir_queue_test'), :delay => 0)
+    @logger = Logger.new('/dev/null')
+    @q = Adrian::DirectoryQueue.create(:path => Dir.mktmpdir('dir_queue_test'), :delay => 0, :logger => @logger)
   end
 
   after do
@@ -87,6 +89,12 @@ describe Adrian::DirectoryQueue do
         assert_equal nil, @q.pop
       end
 
+      it "set's the logger on the item" do
+        @item.logger.must_be_nil
+        @q.push(@item)
+        @q.pop.logger.must_equal @logger
+      end
+
     end
 
     describe 'push' do

data/test/file_item_test.rb

@@ -59,6 +59,17 @@ describe Adrian::FileItem do
       assert_equal @destination, File.dirname(@item.path)
     end
 
+    it 'logs the move on the logger' do
+      destination_file_name = File.join(@destination, File.basename(@item.path))
+      logger = MiniTest::Mock.new
+      logger.expect(:info, nil, ["Moving #{@item.path} to #{destination_file_name}"])
+      @item.logger = logger
+
+      @item.move(@destination)
+
+      logger.verify
+    end
+
   end
 
   describe 'touch' do

data/test/rotating_directory_queue_test.rb

@@ -0,0 +1,57 @@
+require_relative 'test_helper'
+require 'tempfile'
+require 'tmpdir'
+require 'fileutils'
+
+describe Adrian::RotatingDirectoryQueue do
+  before do
+    @root_path = Dir.mktmpdir('dir_queue_test')
+    @q = Adrian::RotatingDirectoryQueue.create(:path => @root_path)
+  end
+
+  after do
+   FileUtils.rm_r(@root_path, :force => true)
+  end
+
+  describe 'pop' do
+    it 'only provides files available in the current time-stamped directory' do
+      @item1 = Adrian::FileItem.new(Tempfile.new('item1').path)
+      @item2 = Adrian::FileItem.new(Tempfile.new('item2').path)
+      @item3 = Adrian::FileItem.new(Tempfile.new('item3').path)
+
+      Time.stub(:now, Time.now) do
+        todays_directory    = File.join(@root_path, Time.now.strftime('%Y-%m-%d'))
+        tomorrows_directory = File.join(@root_path, (Time.now + 60 * 60 * 24).strftime('%Y-%m-%d'))
+
+        FileUtils.mkdir_p(todays_directory)
+        FileUtils.mkdir_p(tomorrows_directory)
+
+        @item1.move(todays_directory)
+        @item2.move(tomorrows_directory)
+        @item3.move(@root_path)
+
+        @q.pop.must_equal @item1
+        @q.pop.must_be_nil
+      end
+    end
+  end
+
+  describe 'push' do
+    before do
+      @item = Adrian::FileItem.new(Tempfile.new('item').path)
+    end
+
+    it 'moves the file to the time-stamped available directory' do
+      Time.stub(:now, Time.now) do
+        original_path = @item.path
+        @q.push(@item)
+
+        assert_equal false, File.exist?(original_path)
+        assert_equal true,  File.exist?(File.join(@q.available_path, @item.name))
+
+        @item.path.must_equal File.join(@root_path, Time.now.strftime('%Y-%m-%d'), @item.name)
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adrian
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -92,6 +92,7 @@ files:
 - lib/adrian/girl_friday_dispatcher.rb
 - lib/adrian/queue.rb
 - lib/adrian/queue_item.rb
+- lib/adrian/rotating_directory_queue.rb
 - lib/adrian/version.rb
 - lib/adrian/worker.rb
 - lib/adrian.rb
@@ -104,6 +105,7 @@ files:
 - test/file_item_test.rb
 - test/filters_test.rb
 - test/girl_friday_dispatcher_test.rb
+- test/rotating_directory_queue_test.rb
 - test/test_helper.rb
 - test/worker_test.rb
 - README.md
@@ -120,15 +122,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4323319423024807981
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4323319423024807981
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Adrian does not do any real work, but is really good at delegating it
@@ -142,5 +150,6 @@ test_files:
 - test/file_item_test.rb
 - test/filters_test.rb
 - test/girl_friday_dispatcher_test.rb
+- test/rotating_directory_queue_test.rb
 - test/test_helper.rb
 - test/worker_test.rb