resque-logger 0.0.1 → 0.1.0

data/README.md

@@ -35,6 +35,10 @@ Usage
 
       def self.perform(args = {})
         (...)
+
+        logger.info('it works!')
+
+        (...)
       end
     end
 

data/lib/resque/plugins/logger.rb

@@ -7,7 +7,28 @@ module Resque
       # Returns a logger instance based on queue name.
       #
       def logger
-        Resque::Plugins::Logger::Factory.get @queue
+        @logger ||= create_logger
+      end
+
+      private
+
+      #
+      # Creates a new instance of logger given a queue name, retrieving
+      # configuration from Resque.logger.
+      #
+      def create_logger
+        config = Resque.logger
+        log_path = config[:folder]
+        class_name = config[:class_name]
+        class_args = config[:class_args]
+
+        file_path = File.join log_path, "#{@queue}.log"
+
+        logger = class_name.new file_path, *class_args
+        logger.level = config[:level] if config[:level]
+        logger.formatter = config[:formatter] if config[:formatter]
+
+        logger
       end
     end
   end

data/lib/resque/setup.rb

@@ -2,11 +2,7 @@
 
 module Resque
   module Plugins
-    autoload :Logger,     'resque/plugins/logger'
-
-    module Logger
-      autoload :Factory,  'resque/plugins/logger/factory'
-    end
+    autoload :Logger, 'resque/plugins/logger'
   end
 end
 

data/lib/resque_logger/version.rb

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

data/resque-logger.gemspec

@@ -1,17 +1,18 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "resque_logger/version"
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'resque_logger/version'
 
 Gem::Specification.new do |s|
-  s.name        = "resque-logger"
+  s.name        = 'resque-logger'
   s.version     = ResqueLogger::VERSION
-  s.authors     = ["Marcelo Correia Pinheiro"]
-  s.email       = ["salizzar@gmail.com"]
-  s.homepage    = ""
+  s.authors     = ['Marcelo Correia Pinheiro']
+  s.email       = ['salizzar@gmail.com']
+  s.homepage    = 'https://github.com/salizzar/resque-logger'
   s.summary     = %q{A Resque plugin to provides logger for each worker}
   s.description = %q{A simple mechanism to create custom log files based on queue names of Resque workers.}
 
-  s.rubyforge_project = "resque-logger"
+  s.rubyforge_project = 'resque-logger'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

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

@@ -3,15 +3,98 @@
 require 'spec_helper'
 
 describe Resque::Plugins::Logger do
-  include Resque::Plugins::Logger
+  @worker_queue = :worker_queue
 
-  @queue = :an_queue
+  class ResqueWorker 
+    extend Resque::Plugins::Logger
 
-  let(:a_logger) { double 'an mock' }
+    @queue = @worker_queue
 
-  it 'returns a instance created by a logger factory' do
-    Resque::Plugins::Logger::Factory.should_receive(:get).with(@queue).and_return(a_logger)
-    logger.should == a_logger
+    def self.perform(args = {})
+      logger.info 'It works!'
+    end
+  end
+
+  let(:file_path)     { File.join config[:folder], "#{@worker_queue}.log" }
+  let(:logger_mock)   { mock Logger }
+
+  let(:config) do
+    {
+      folder:     '/path/to/your/log/folder',
+      class_name: Logger,
+      class_args: [ 'daily', 1024 ],
+      level:      Logger::INFO,
+      formatter:  Logger::Formatter.new,
+    }
+  end
+
+  before :each do
+    Resque.stub(:logger).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
+  end
+
+  describe 'getting a logger based on queue' do
+    before :each do
+      config.delete :level
+      config.delete :formatter
+    end
+
+    it 'creates a logger based on configuration' do
+      Logger.should_receive(:new).with(file_path, config[:class_args].first, config[:class_args].last).and_return(logger_mock)
+
+      ResqueWorker.perform
+    end
+
+    it 'returns a previously created logger' do
+      Logger.stub(:new).and_return(logger_mock)
+      ResqueWorker.perform
+
+      Logger.should_not_receive(:new)
+      ResqueWorker.perform
+    end
+
+    it 'accepts a logger without additional args' 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)
+    end
+
+    it 'configures logger level if informed' do
+      config.delete :formatter
+
+      logger_mock.should_receive(:level=).with(config[:level])
+
+      ResqueWorker.perform
+    end
+
+    it 'configures logger formatter if informed' do
+      config.delete :level
+
+      logger_mock.should_receive(:formatter=).with(config[:formatter])
+
+      ResqueWorker.perform
+    end
+
+    it 'not configures level and formatter if not exists' do
+      config.delete :level
+      config.delete :formatter
+
+      logger_mock.should_not_receive(:level=)
+      logger_mock.should_not_receive(:formatter=)
+
+      ResqueWorker.perform
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70257554434120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257554434120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70257554433360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257554433360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70257554432580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257554432580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple mechanism to create custom log files based on queue names of
   Resque workers.
 email:
@@ -60,17 +75,15 @@ files:
 - UNLICENSE
 - lib/resque-logger.rb
 - lib/resque/plugins/logger.rb
-- lib/resque/plugins/logger/factory.rb
 - lib/resque/setup.rb
 - lib/resque_logger.rb
 - lib/resque_logger/version.rb
 - resque-logger.gemspec
-- spec/lib/resque/plugins/logger/factory_spec.rb
 - spec/lib/resque/plugins/logger_spec.rb
 - spec/lib/resque_logger_spec.rb
 - spec/spec_helper.rb
 - spec/support/rspec_macros.rb
-homepage: ''
+homepage: https://github.com/salizzar/resque-logger
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -84,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2417837300736213772
+      hash: 1231085515247237098
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -93,15 +106,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2417837300736213772
+      hash: 1231085515247237098
 requirements: []
 rubyforge_project: resque-logger
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Resque plugin to provides logger for each worker
 test_files:
-- spec/lib/resque/plugins/logger/factory_spec.rb
 - spec/lib/resque/plugins/logger_spec.rb
 - spec/lib/resque_logger_spec.rb
 - spec/spec_helper.rb

data/lib/resque/plugins/logger/factory.rb

@@ -1,49 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-module Resque
-  module Plugins
-    module Logger
-      class Factory
-        @queue_map = {}
-
-        #
-        # Returns a new instance of configured logger given a queue name.
-        # If queue logger is already created, returns previous instance.
-        #
-        def self.get(queue)
-          queue_name = queue.to_sym
-          logger = @queue_map[queue_name]
-
-          if logger.nil?
-            logger = create_logger queue_name
-            @queue_map[queue_name] = logger
-          end
-
-          logger
-        end
-
-        private
-
-        #
-        # Creates a new instance of logger given a queue name, retrieving
-        # configuration from Resque.logger.
-        #
-        def self.create_logger(queue)
-          config = Resque.logger
-          log_path = config[:folder]
-          class_name = config[:class_name]
-          class_args = config[:class_args]
-
-          file_path = File.join log_path, "#{queue}.log"
-
-          logger = class_name.new file_path, *class_args
-          logger.level = config[:level] if config[:level]
-          logger.formatter = config[:formatter] if config[:formatter]
-
-          logger
-        end
-      end
-    end
-  end
-end
-

data/spec/lib/resque/plugins/logger/factory_spec.rb

@@ -1,69 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'spec_helper'
-
-describe Resque::Plugins::Logger::Factory do
-  include RSpecMacros
-
-  let(:subject)     { Resque::Plugins::Logger::Factory }
-
-  let(:logger)      { double Logger }
-  let(:queue)       { :an_queue }
-  let(:file_path)   { File.join config[:folder], "#{queue}.log" }
-
-  before :each do
-    Resque.stub(:logger).and_return(config)
-  end
-
-  describe 'creating a logger given a queue' do
-    before :each do
-      config.delete :level
-      config.delete :formatter
-    end
-
-    it 'returns a new instance of configured logger if not exists' do
-      Logger.should_receive(:new).with(file_path, config[:class_args].first, config[:class_args].last).and_return(logger)
-
-      subject.get(queue).should == logger
-    end
-
-    it 'returns previous created logger if exists' do
-      Logger.should_not_receive(:new)
-
-      subject.get queue
-    end
-  end
-
-  describe 'setting configurations' do
-    before :each do
-      Logger.should_receive(:new).and_return(logger)
-    end
-
-    it 'configures level if exists' do
-      config.delete :formatter
-
-      logger.should_receive(:level=).with(config[:level])
-
-      subject.get :a_queue_with_level
-    end
-
-    it 'configures formatter if exists' do
-      config.delete :level
-
-      logger.should_receive(:formatter=).with(config[:formatter])
-
-      subject.get :a_queue_with_formatter
-    end
-
-    it 'not assigns level and formatter if not exists' do
-      config.delete :level
-      config.delete :formatter
-
-      logger.should_not_receive(:level=)
-      logger.should_not_receive(:formatter=)
-
-      subject.get :a_basic_queue_config
-    end
-  end
-end
-