resque-logger 0.1.0 → 0.2.0

data/README.md

@@ -20,7 +20,7 @@ Configuration
       formatter:  Logger::Formatter.new,    # optional
     }
 
-    Resque.logger = config
+    Resque.logger_config = config
 
 Usage
 =====
@@ -32,6 +32,7 @@ Usage
       extend Resque::Plugins::Logger
 
       @queue = :my_killer_worker_job
+      @log_name = "my_killer_log_name.log" # Optional - defaults to using the queue name.
 
       def self.perform(args = {})
         (...)

data/lib/resque/plugins/logger.rb

@@ -3,6 +3,7 @@
 module Resque
   module Plugins
     module Logger
+      DEFAULT_LOG_NAME = "worker.log"
       #
       # Returns a logger instance based on queue name.
       #
@@ -11,18 +12,23 @@ module Resque
       end
 
       private
-
       #
       # Creates a new instance of logger given a queue name, retrieving
       # configuration from Resque.logger.
       #
       def create_logger
-        config = Resque.logger
+        config = Resque.logger_config
         log_path = config[:folder]
         class_name = config[:class_name]
         class_args = config[:class_args]
 
-        file_path = File.join log_path, "#{@queue}.log"
+        file_basename = @log_name ||
+          (if (queue_name = Resque.queue_from_class(self))
+            "#{queue_name}.log"
+          else
+            DEFAULT_LOG_NAME
+          end)
+        file_path = File.join log_path, file_basename
 
         logger = class_name.new file_path, *class_args
         logger.level = config[:level] if config[:level]

data/lib/resque_logger.rb

@@ -5,8 +5,8 @@ require "resque/setup"
 
 module ResqueLogger
   module ClassMethods
-    def logger
-      @logger
+    def logger_config
+      @logger_config
     end
 
     #
@@ -21,10 +21,10 @@ module ResqueLogger
     #
     # Hash keys will be symbols to work.
     #
-    def logger=(options)
+    def logger_config=(options)
       check_logger_args! options
 
-      @logger = options
+      @logger_config = options
     end
 
     private

data/lib/resque_logger/version.rb

@@ -1,3 +1,3 @@
 module ResqueLogger
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/lib/resque/plugins/logger_spec.rb

@@ -3,15 +3,17 @@
 require 'spec_helper'
 
 describe Resque::Plugins::Logger do
-  @worker_queue = :worker_queue
+  before do
+    @worker_queue = :worker_queue
 
-  class ResqueWorker 
-    extend Resque::Plugins::Logger
+    class ResqueWorker
+      extend Resque::Plugins::Logger
 
-    @queue = @worker_queue
+      @queue = @worker_queue
 
-    def self.perform(args = {})
-      logger.info 'It works!'
+      def self.perform(args = {})
+        logger.info 'It works!'
+      end
     end
   end
 
@@ -29,11 +31,12 @@ describe Resque::Plugins::Logger do
   end
 
   before :each do
-    Resque.stub(:logger).and_return(config)
+    Resque.stub(:logger_config).and_return(config)
     logger_mock.should_receive(:info).any_number_of_times
 
     # FIXME: find a better way to test
     ResqueWorker.instance_variable_set '@logger', nil
+    ResqueWorker.instance_variable_set(:@queue, @worker_queue)
   end
 
   describe 'getting a logger based on queue' do
@@ -65,6 +68,88 @@ describe Resque::Plugins::Logger do
     end
   end
 
+  describe 'log file auto-naming' do
+    before(:each) do
+      config.delete :class_args
+      config.delete :level
+      config.delete :formatter
+    end
+
+    context 'class instance variable is set' do
+      before(:each) do
+        ResqueWorker.instance_variable_set(:@queue, "custom_queue")
+        @file_path = File.join config[:folder], "custom_queue.log"
+      end
+      after(:each) do
+        ResqueWorker.instance_variable_set(:@queue, @worker_queue)
+      end
+
+      it 'uses the correct log name' do
+        Logger.should_receive(:new).with(@file_path).and_return(logger_mock)
+
+        ResqueWorker.perform
+      end
+    end
+
+    context 'class queue method exists' do
+      before(:each) do
+        ResqueWorker.instance_variable_set(:@queue, nil)
+        ResqueWorker.class_eval do
+          def self.queue
+            "another_queue"
+          end
+        end
+        @file_path = File.join config[:folder], "another_queue.log"
+      end
+      after(:each) do
+        ResqueWorker.class_eval do
+          class << self
+            remove_method :queue
+          end
+        end
+      end
+
+      it 'uses the correct log name' do
+        Logger.should_receive(:new).with(@file_path).and_return(logger_mock)
+
+        ResqueWorker.perform
+      end
+    end
+
+    context 'no queue name is specified' do
+      before do
+        ResqueWorker.instance_variable_set(:@queue, nil)
+        Resque.queue_from_class(ResqueWorker).should be_false
+      end
+      it 'uses a default log name' do
+        default_file_path = File.join(config[:folder], Resque::Plugins::Logger::DEFAULT_LOG_NAME)
+        Logger.should_receive(:new).with(default_file_path).and_return(logger_mock)
+
+        ResqueWorker.perform
+      end
+    end
+  end
+
+  describe 'explicitly setting the log name' do
+    before(:each) do
+      @base = "hey_a_log_file.log"
+      @file_path = File.join config[:folder], @base
+      ResqueWorker.instance_variable_set("@log_name", @base)
+      config.delete :level
+      config.delete :formatter
+    end
+    after(:each) do
+      ResqueWorker.instance_variable_set("@log_name", nil)
+    end
+
+    it 'uses the log_name method' do
+      config.delete :class_args
+      Logger.should_receive(:new).with(@file_path).and_return(logger_mock)
+
+      ResqueWorker.perform
+    end
+  end
+
   describe 'setting logger options from configuration' do
     before :each do
       Logger.stub(:new).and_return(logger_mock)

data/spec/lib/resque_logger_spec.rb

@@ -11,7 +11,7 @@ describe ResqueLogger do
 
       error = ArgumentError.new 'Folder must be supplied'
 
-      expect { Resque.logger = config }.to raise_error(error.class, error.message)
+      expect { Resque.logger_config = config }.to raise_error(error.class, error.message)
     end
 
     it 'raises an error if class name is not found' do
@@ -19,11 +19,16 @@ describe ResqueLogger do
 
       error = ArgumentError.new 'Logger must be supplied'
 
-      expect { Resque.logger = config }.to raise_error(error.class, error.message)
+      expect { Resque.logger_config = config }.to raise_error(error.class, error.message)
     end
 
     it 'not raises otherwise' do
-      expect { Resque.logger = config }.to_not raise_error
+      expect { Resque.logger_config = config }.to_not raise_error
+    end
+
+    it 'does not collide with the Resque.logger namespace' do
+      Resque.logger_config = config
+      expect { Resque.logger.info("Test message") }.to_not raise_error
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -95,26 +95,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1231085515247237098
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1231085515247237098
 requirements: []
 rubyforge_project: resque-logger
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Resque plugin to provides logger for each worker
-test_files:
-- spec/lib/resque/plugins/logger_spec.rb
-- spec/lib/resque_logger_spec.rb
-- spec/spec_helper.rb
-- spec/support/rspec_macros.rb
+test_files: []