resque-logger 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor/bundle

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque_logger.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+Resque Per-worker Logger Plugin
+===============================
+
+Tired of create mechanisms to isolate log files to each [Resque][] worker in your application?
+The gem resque-logger gives you a simple plugin to create a log file based on queue name.
+
+Configuration
+=============
+
+### Using a initializer
+    # config/initializers/resque.rb
+
+    log_path = File.join Rails.root, 'log'
+
+    config = {
+      folder:     log_path,                 # destination folder
+      class_name: Logger,                   # logger class name
+      class_args: [ 'daily', 1.kilobyte ],  # logger additional parameters
+      level:      Logger::INFO,             # optional
+      formatter:  Logger::Formatter.new,    # optional
+    }
+
+    Resque.logger = config
+
+Usage
+=====
+
+### Adding to a resque worker
+    # app/workers/my_killer_worker.rb
+
+    class MyKillerWorker
+      extend Resque::Plugins::Logger
+
+      @queue = :my_killer_worker_job
+
+      def self.perform(args = {})
+        (...)
+      end
+    end
+
+Dependencies
+============
+
+* resque
+
+Installation
+============
+
+### With rubygems:
+    $ [sudo] gem install resque-logger
+
+Authors
+=======
+
+* Marcelo Correia Pinheiro - <http://salizzar.net/>
+
+License
+=======
+
+ResqueLogger is free and unencumbered public domain software. For more
+information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
+
+[Resque]: https://github.com/defunkt/resque
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/UNLICENSE

@@ -0,0 +1,25 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
+

data/lib/resque-logger.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+
+require 'resque_logger'
+

data/lib/resque/plugins/logger.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+module Resque
+  module Plugins
+    module Logger
+      #
+      # Returns a logger instance based on queue name.
+      #
+      def logger
+        Resque::Plugins::Logger::Factory.get @queue
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,49 @@
+# -*- 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/lib/resque/setup.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+
+module Resque
+  module Plugins
+    autoload :Logger,     'resque/plugins/logger'
+
+    module Logger
+      autoload :Factory,  'resque/plugins/logger/factory'
+    end
+  end
+end
+

data/lib/resque_logger.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+require "resque_logger/version"
+require "resque/setup"
+
+module ResqueLogger
+  module ClassMethods
+    def logger
+      @logger
+    end
+
+    #
+    # Configures ResqueLogger with the following hash:
+    # {
+    #   folder: <folder location for logs>,
+    #   class_name: <class name to be created>,
+    #   class_args: <an array of class arguments to be passed in constructor>,
+    #   level: <logger level>,
+    #   formatter: <a new instance of formatter class to add in logger>
+    # }
+    #
+    # Hash keys will be symbols to work.
+    #
+    def logger=(options)
+      check_logger_args! options
+
+      @logger = options
+    end
+
+    private
+
+    #
+    # Check for necessary keys and raises if not found.
+    #
+    def check_logger_args!(options)
+      keys = options.keys
+
+      raise ArgumentError.new 'Folder must be supplied' unless keys.include?(:folder)
+      raise ArgumentError.new 'Logger must be supplied' unless keys.include?(:class_name)
+    end
+  end
+end
+
+Resque.extend ResqueLogger::ClassMethods
+

data/lib/resque_logger/version.rb

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

data/resque-logger.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resque_logger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-logger"
+  s.version     = ResqueLogger::VERSION
+  s.authors     = ["Marcelo Correia Pinheiro"]
+  s.email       = ["salizzar@gmail.com"]
+  s.homepage    = ""
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency  'rake'
+  s.add_development_dependency  'rspec'
+  s.add_runtime_dependency      'resque'
+end

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

@@ -0,0 +1,69 @@
+# -*- 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
+

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

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Resque::Plugins::Logger do
+  include Resque::Plugins::Logger
+
+  @queue = :an_queue
+
+  let(:a_logger) { double 'an mock' }
+
+  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
+  end
+end
+

data/spec/lib/resque_logger_spec.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe ResqueLogger do
+  include RSpecMacros
+
+  describe 'checking configured values' do
+    it 'raises an error if folder is not found' do
+      config.delete :folder
+
+      error = ArgumentError.new 'Folder must be supplied'
+
+      expect { Resque.logger = config }.to raise_error(error.class, error.message)
+    end
+
+    it 'raises an error if class name is not found' do
+      config.delete :class_name
+
+      error = ArgumentError.new 'Logger must be supplied'
+
+      expect { Resque.logger = config }.to raise_error(error.class, error.message)
+    end
+
+    it 'not raises otherwise' do
+      expect { Resque.logger = config }.to_not raise_error
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+require 'bundler'
+require 'rspec'
+require 'resque'
+require 'resque-logger'
+require 'logger'
+
+RSpec.configure do |config|
+  # spec/support files
+  Dir[File.join File.dirname(__FILE__), 'support', '**', '*.rb'].each { |f| require f }
+end
+

data/spec/support/rspec_macros.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+module RSpecMacros
+  def self.included(spec)
+    spec.let(:config) do
+      {
+        folder:     '/path/to/your/log/folder',
+        class_name: Logger,
+        class_args: [ 'daily', 1024 ],
+        level:      Logger::INFO,
+        formatter:  Logger::Formatter.new,
+      }
+    end
+  end
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: resque-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Correia Pinheiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70257554434120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257554434120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70257554433360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257554433360
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70257554432580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257554432580
+description: A simple mechanism to create custom log files based on queue names of
+  Resque workers.
+email:
+- salizzar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- 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: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2417837300736213772
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2417837300736213772
+requirements: []
+rubyforge_project: resque-logger
+rubygems_version: 1.8.10
+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
+- spec/support/rspec_macros.rb