class_logger 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/README.md

@@ -0,0 +1,130 @@
+Class Logger
+============
+
+Makes adding multiple loggers or custom loggers to any ruby class. Written mainly to have certain models in Rails log to a different file while maintaining the original logger (or overwriting it).
+
+The idea came from [eandrejko](https://github.com/eandrejko) and his class_logger. I just added some more flexibility and made it to work outside of Rails.
+
+Installation
+------------
+
+gem install class_logger
+
+Options
+-------
+
+ClassLogger supports a bunch of options that are passed straight to the Logger. Most of these options should make sense, but they are described in further detail in Logger's rdoc files.
+
+<dl>
+  <dt><strong>:rotate</strong></dt>
+  <dd>Set this to daily, weekly, etc. - anything Logger supports</dd>
+
+  <dt><strong>:max_size</strong></dt>
+  <dd>Set this to the size you want the log to rotate at (or set +rotate+ above)</dd>
+
+  <dt><strong>:keep</strong></dt>
+  <dd>Set this to how many logfiles you want to keep after rotating (or set +rotate+ above)</dd>
+
+  <dt><strong>:path</strong></dt>
+  <dd>The path to your log folder. (Default: "%&lt;rails_root>s/log") -- see Interpolations section</dd>
+
+  <dt><strong>:in</strong></dt>
+  <dd>This is the name of your logfile. (Use: "%&lt;class_name>s" to interpolate the class's name) (Default: "%&lt;class_name>s.log") -- see Interpolations section</dd>
+
+  <dt><strong>:as</strong></dt>
+  <dd>This is the method your logger will be available to the class as. (Default: logger)</dd>
+
+  <dt><strong>:formatter</strong></dt>
+  <dd>This can be any custom proc or method you want to assign. (See Logger's rdoc files for more details on this)</dd>
+
+  <dt><strong>:level</strong></dt>
+  <dd>This is the log level</dd>
+</dl>
+
+Interpolations
+--------------
+
+The following can be used in the *path* or *in* options.
+
+<dl>
+  <dt><strong>%&lt;rails_root>s</strong></dt>
+  <dd>Will replace itself with Rails.root when in a rails app</dd>
+
+  <dt><strong>%&lt;current>s</strong></dt>
+  <dd>Will replace itself with the +dirname+ of the file</dd>
+
+  <dt><strong>%&lt;parent>s</strong></dt>
+  <dd>Will replace itself with the parent directory of the file</dd>
+
+  <dt><strong>%&lt;class_name>s</strong></dt>
+  <dd>Will replace itself with the name of the class.</dd>
+</dl>
+  
+Example Usage
+-------------
+
+<pre>
+  # simple use case to override active records logger
+  class Transaction &lt; ActiveRecord::Base
+    include ClassLogger
+    has_logger
+  
+    def process!
+      logger.info "Creating transation: #{amount}"  # => goes to log/transaction.log
+    end
+  end
+  
+
+  # custom logs for special models within rails
+  # specifying a custom logfile and logger name
+  class Transaction &lt; ActiveRecord::Base
+    include ClassLogger
+    has_logger :in => 'gateway.log', :as => :gateway_logger
+  
+    def process!
+      gateway_logger.info "Creating transation: #{amount}"  # => goes to log/gateway.log
+      logger.info "Hello default logger!"                   # => goes to log/&lt;environment>.log
+    end
+  end
+  
+  # overriding active record's default logger with a custom logfile
+  class Transaction &lt; ActiveRecord::Base
+    include ClassLogger
+    has_logger :in => 'gateway.log'
+  
+    def process!
+      logger.info "Creating transation: #{amount}"  # => goes to log/gateway.log
+    end
+  end
+
+  # create a logger for a module
+  module Something
+    include ClassLogger
+    has_logger :path => File.expand_path("../log", __FILE__), :in => 'my_module.log'
+    has_logger :path => '/var/log', :in => 'utoh.log', :as => :utoh_logger
+    
+    # has_logger only makes instance methods, so we need to wrap it up
+    def self.logger
+      self.loggers[:logger]
+    end
+    
+    def self.utoh
+      self.loggers[:utoh_logger]
+    end
+  end
+  Something.logger.info "Testing 123"
+  Something.utoh.error "oops!"
+  
+  # inside a class with a custom formatter
+  class Something
+    include ClassLogger
+    has_logger :path => "%&lt;current>s/log", :rotate => :daily, 
+      :formatter => proc{ |severity, time, program_name, message| "[%s](Something): %s\n" % [severity, message] }
+
+    def initialize
+      logger.debug "Created Something."
+    end
+  end
+  Something.new
+  Something.loggers[:logger].debug "System logger"
+</pre>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/class_logger.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "class_logger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "class_logger"
+  s.version     = ClassLogger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rob Hurring"]
+  s.email       = ["rob@ubrio.us"]
+  s.homepage    = ""
+  s.summary     = %q{Adds custom logger(s) to any ruby module or class}
+  s.description = %q{Allows you to create multiple loggers for any given class}
+
+  s.rubyforge_project = "class_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"]
+end

data/lib/class_logger/version.rb

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

data/lib/class_logger.rb

@@ -0,0 +1,52 @@
+require 'logger'
+
+module ClassLogger
+  def self.included(base)
+    base.extend DSL
+  end
+  
+  module DSL
+    def has_logger(options = {})
+      send :extend, ClassMethods
+      default_options = {
+        :rotate => nil,
+        :max_size => nil,
+        :keep => nil,
+        :path => "%<rails_root>s/log",
+        :in => "%<class_name>s.log",
+        :as => :logger,
+        :formatter => proc{ |severity, time, program_name, message| "[%s,%s]: %s\n" % [severity, time, message] },
+        :level => ::Logger::DEBUG
+      }
+      self.setup_logger(default_options.merge(options))
+    end
+  end
+  
+  module ClassMethods
+    def loggers
+      @@loggers ||= {}
+    end
+    
+    def setup_logger(options)
+      interpolations = {
+        :rails_root => (defined?(Rails) ? Rails.root : ''),
+        :class_name => self.to_s.downcase,
+        :current => File.dirname($FILENAME),
+        :parent => File.expand_path('../../', $FILENAME)
+      }
+      
+      file_path = File.join(options[:path], options[:in]).to_s % interpolations
+      if (rotate = options[:rotate])
+        _logger = ::Logger.new(file_path, rotate)
+      else
+        _logger = ::Logger.new(file_path, options[:keep], options[:max_size])
+      end
+      _logger.formatter = options[:formatter]
+      _logger.level = options[:level]
+
+      as = options[:as]
+      self.loggers[as] = _logger
+      define_method(as){ self.class.loggers[as] }
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: class_logger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob Hurring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Allows you to create multiple loggers for any given class
+email: 
+- rob@ubrio.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- class_logger.gemspec
+- lib/class_logger.rb
+- lib/class_logger/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: class_logger
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds custom logger(s) to any ruby module or class
+test_files: []
+