lumber 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Conway
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.rdoc

@@ -0,0 +1,36 @@
+= lumber
+
+Lumber tries to make it easy to use the more robust log4r[http://log4r.sourceforge.net/] logging system within your rails application.
+To do this it sets up log4r configuration from a yml file, and provides utility methods for adding a
+:logger accessor to classes dynamically as they get created.  In the default setup shown below, calls
+to logger from a model/controller/mailer, will include that classes name in the log output.
+
+To use it, first "gem install lumber", run the lumber generator (./script generate lumber) to get the log4r.yml config file, then make the following edits
+to config/environment.rb:
+
+  # before Rails::Initializer.run
+  #
+  require 'lumber'
+  Lumber.init()
+
+  # Inside the block for Rails::Initializer.run
+  #
+  config.after_initialize do
+    # setup log4r heirarchy - these need to happen after frameworks
+    # are loaded, but before subclasses get defined
+    Lumber.setup_logger_heirarchy(ActiveRecord::Base, "rails::models")
+    Lumber.setup_logger_heirarchy(ActionController::Base, "rails::controllers")
+    Lumber.setup_logger_heirarchy(ActionMailer::Base, "rails::mailers")
+  end
+
+If you want to change the log level for a different environment, add a line like below to the config/environments/<env>.rb
+
+  # Set info as the default log level for production
+  Log4r::Logger.root.level = Log4r::INFO
+
+You should be able to use lumber in a non-rails project too, but your call to Lumber.init will need to be different.
+I don't currently need to do this, so let me know if you have any problems.
+
+== Copyright
+
+Copyright (c) 2009 Matt Conway. See LICENSE for details.

data/TODO

@@ -0,0 +1,2 @@
+* Add hook to allow tweaking log level for a running process
+* Add web app to access tweaking of log levels

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/lumber/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Prepares the rails application for using log4 by installing sample configuration
+
+Examples:
+    ./script/generate lumber

data/generators/lumber/lumber_generator.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+require 'find'
+
+class LumberGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.file('log4r.yml', 'config/log4r.yml')
+    end
+  end
+
+  protected
+
+  def banner
+    usage = "Usage: #{$0} lumber\n"
+    usage << "    Install configuration files for lumber\n"
+    return usage
+  end
+end

data/generators/lumber/templates/log4r.yml

@@ -0,0 +1,18 @@
+log4r_config:
+  pre_config:
+    root:
+      level: DEBUG
+  loggers:
+    - name: "rails"
+      outputters:
+        - logfile
+
+  outputters:
+    - type: FileOutputter
+      name: logfile
+      filename: "#{log_file}"
+      trunc: 'false'
+      formatter   :
+        date_pattern: '%H:%M:%S'
+        pattern     : '%-5l %d #{hostname} %c[#{Process.pid}]: %m'
+        type        : PatternFormatter

data/lib/lumber/log4r.rb

@@ -0,0 +1,40 @@
+require 'log4r'
+require 'log4r/yamlconfigurator'
+require 'log4r/outputter/datefileoutputter'
+require 'active_support/core_ext/array.rb'
+require 'active_support/core_ext/class/attribute_accessors.rb'
+
+class Log4r::Logger
+  # Set to false to disable the silencer
+  cattr_accessor :silencer
+  self.silencer = true
+
+  # Silences the logger for the duration of the block.
+  def silence(temporary_level = nil)
+    temporary_level = Log4r::ERROR unless temporary_level
+    if silencer
+      begin
+        old_logger_level, self.level = level, temporary_level
+        yield self
+      ensure
+        self.level = old_logger_level
+      end
+    else
+      yield self
+    end
+  end
+
+  # Convenience method for logging exceptions
+  def log_exception(exception, details = {})
+    details = details.stringify_keys
+    max = details.keys.max { |a,b| a.length <=> b.length }
+    env = details.keys.sort.inject [] do |env, key|
+      env << '* ' + ("%-*s: %s" % [max.length, key, details[key].to_s.strip])
+    end
+
+    details_str = env.join("\n")
+    trace = exception.backtrace.join("\n")
+    error("Exception '#{exception.class_name}', '#{exception.message}', details:\n#{details_str}\nBacktrace:\n#{trace}")
+  end
+
+end

data/lib/lumber/lumber.rb

@@ -0,0 +1,72 @@
+require "socket"
+
+module Lumber
+
+  # Initializes log4r system.  Needs to happen in
+  # config/environment.rb before Rails::Initializer.run
+  #
+  # Options:
+  #
+  # * :root - defaults to RAILS_ROOT if defined
+  # * :env - defaults to RAILS_ENV if defined
+  # * :config_file - defaults to <root>}/config/log4r.yml
+  # * :log_file - defaults to <root>}/log/<env>.log
+  #
+  # All config options get passed through to the log4r
+  # configurator for use in defining outputters
+  #
+  def self.init(opts = {})
+    opts[:root] ||= RAILS_ROOT if defined?(RAILS_ROOT)
+    opts[:env] ||= RAILS_ENV if defined?(RAILS_ENV)
+    opts[:config_file] ||= "#{opts[:root]}/config/log4r.yml"
+    opts[:log_file] ||= "#{opts[:root]}/log/#{opts[:env]}.log"
+    raise "Lumber.init missing one of :root, :env" unless opts[:root] && opts[:env]
+
+    cfg = Log4r::YamlConfigurator
+    opts.each do |k, v|
+      cfg[k.to_s] = v
+    end
+    cfg['hostname'] = Socket.gethostname
+
+    cfg.load_yaml_file(opts[:config_file])
+
+    # Workaround for rails bug: http://dev.rubyonrails.org/ticket/8665
+    if defined?(RAILS_DEFAULT_LOGGER)
+      Object.send(:remove_const, :RAILS_DEFAULT_LOGGER)
+    end
+    Object.const_set('RAILS_DEFAULT_LOGGER', Log4r::Logger['rails'])
+
+  end
+
+  # Makes :logger exist independently for subclasses and sets that logger
+  # to one that inherits from base_class for each subclass as its created.
+  # This allows you to have a finer level of control over logging, for example,
+  # put just a single class, or heirarchy of classes, into debug log level
+  #
+  # for example:
+  #
+  #   Lumber.setup_logger_heirarchy(ActiveRecord::Base, "rails::models")
+  #
+  # causes all models that get created to have a log4r logger named
+  # "rails::models::<class_name>".  This class can individually be
+  # put into debug log mode in production (see {log4r docs}[http://log4r.sourceforge.net/manual.html]), and log
+  # output will include "<class_name>" on every log from this class
+  # so that you can tell where a log statement came from
+  #
+  def self.setup_logger_heirarchy(base_class, parent_fullname)
+    base_class.class_eval do
+      class_inheritable_accessor :logger
+      self.logger = Log4r::Logger.new(parent_fullname)
+
+      class << self
+        def inherited_with_lumber_log4r(subclass)
+          inherited_without_lumber_log4r(subclass)
+          subclass.logger = Log4r::Logger.new("#{logger.fullname}::#{subclass.name}")
+        end
+        alias_method_chain :inherited, :lumber_log4r
+      end
+
+    end
+  end
+
+end

data/lib/lumber.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__))
+
+# before config block
+require "lumber/lumber"
+require "lumber/log4r"
+

data/test/lumber_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class LumberTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lumber'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: lumber
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Lumber tries to make it easy to use the more robust log4r logging system within your rails application.  To do this it sets up log4r configuration from a yml file, and provides utility methods for adding a :logger accessor to classes dynamicaly as they get created.
+email: matt@conwaysplace.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- TODO
+- VERSION
+- generators/lumber/USAGE
+- generators/lumber/lumber_generator.rb
+- generators/lumber/templates/log4r.yml
+- lib/lumber.rb
+- lib/lumber/log4r.rb
+- lib/lumber/lumber.rb
+has_rdoc: true
+homepage: http://github.com/wr0ngway/lumber
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Lumber integrates the log4r logging system within your application.
+test_files: 
+- test/lumber_test.rb
+- test/test_helper.rb