reasonable_log4r 0.9.0

data/.gitignore

@@ -0,0 +1,18 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+.idea/*
+database.yml
+/log/*.pid

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in partitioned.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem 'log4r', '1.1.10'
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    reasonable_log4r (0.9.0)
+      log4r (= 1.1.10)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    log4r (1.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  log4r (= 1.1.10)
+  reasonable_log4r!

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2010-2012, Fiksu, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+ o Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ o Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the
+   distribution.
+
+ o Fiksu, Inc. nor the names of its contributors may be used to
+   endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,10 @@
+Patches for Log4r
+=================
+
+* root loggers are no longer null loggers -- you can add outputters to them
+* the global logger is used to set a global log level (root is no longer used for this)
+* yaml configurator has been updated to handle new root logger semantics
+* yaml configurator has been updated to accept a set of files AND sections (default section: log4r_config)
+
+What this really means is that you can set up one outputter in the root
+logger to manage the default logging behavior.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+task :default => :spec
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ReasonableLog4r'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+

data/init.rb

@@ -0,0 +1 @@
+require 'reasonable_log4r.rb'

data/lib/reasonable_log4r.rb

@@ -0,0 +1,2 @@
+require 'reasonable_log4r/monkey_patch_log4r'
+require 'reasonable_log4r/version'

data/lib/reasonable_log4r/monkey_patch_log4r.rb

@@ -0,0 +1,188 @@
+require 'log4r/logger'
+require 'log4r/yamlconfigurator'
+
+module Log4r
+  class RootLogger < Logger
+    def initialize
+      Log4r.define_levels(*Log4rConfig::LogLevels) # ensure levels are loaded
+      @level = ALL
+      @outputters = []
+      Repository['root'] = self
+      LoggerFactory.define_methods(self)
+    end
+
+    def is_root?; true end
+
+    # Set the global level. Any loggers defined thereafter will
+    # not log below the global level regardless of their levels.
+
+    def level=(alevel); @level = alevel end
+
+    # Does nothing
+    def additive=(foo); end
+
+    def outputters=(foo)
+      super
+    end
+    def trace=(foo)
+      super
+    end
+    def add(*foo)
+      super
+    end
+    def remove(*foo)
+      super
+    end
+  end
+
+  class GlobalLogger < Logger
+    include Singleton
+
+    def initialize
+      Log4r.define_levels(*Log4rConfig::LogLevels) # ensure levels are loaded
+      @level = ALL
+      @outputters = []
+      Repository['global'] = self
+      LoggerFactory.undefine_methods(self)
+    end
+
+    def is_root?; true end
+
+    # Set the global level. Any loggers defined thereafter will
+    # not log below the global level regardless of their levels.
+
+    def level=(alevel); @level = alevel end
+
+    # Does nothing
+    def outputters=(foo); end
+    # Does nothing
+    def trace=(foo); end
+    # Does nothing
+    def additive=(foo); end
+    # Does nothing
+    def add(*foo); end
+    # Does nothing
+    def remove(*foo); end
+  end
+
+  class Logger
+    # Returns the root logger. Identical to Logger.global
+    def self.root; return RootLogger.instance end
+    # Returns the root logger. Identical to Logger.root
+    def self.global; return GlobalLogger.instance end
+    
+    # Get a logger with a fullname from the repository or nil if logger
+    # wasn't found.
+
+    def self.[](_fullname)
+      # forces creation of RootLogger if it doesn't exist yet.
+      if _fullname=='root'
+        return RootLogger.instance
+      end
+      if _fullname=='global'
+        return GlobalLogger.instance
+      end
+      Repository[_fullname]
+    end
+
+    class LoggerFactory #:nodoc:
+      # we want to log iff root.lev <= lev && logger.lev <= lev
+      # BTW, root is guaranteed to be defined by this point
+      def self.define_methods(logger)
+        undefine_methods(logger)
+        globlev = Log4r::Logger['global'].level
+        return if logger.level == OFF or globlev == OFF
+        toggle_methods(globlev, logger)
+      end
+
+      # Logger logging methods are defined here.
+      def self.set_log(logger, lname) 
+        # invoke caller iff the logger invoked is tracing
+        tracercall = (logger.trace ? "caller" : "nil")
+        # maybe pass parent a logevent. second arg is the switch
+        if logger.additive && !logger.is_root?
+          parentcall = "@parent.#{lname.downcase}(event, true)"
+        end
+        mstr = %-
+          def logger.#{lname.downcase}(data=nil, propagated=false)
+            if propagated then event = data
+            else
+              data = yield if block_given?
+              event = LogEvent.new(#{lname}, self, #{tracercall}, data)
+            end
+            @outputters.each {|o| o.#{lname.downcase}(event) }
+            #{parentcall}
+          end
+        -
+        module_eval mstr
+      end
+    end
+  end
+
+  class YamlConfigurator
+    # Given a filename, loads the YAML configuration for Log4r.
+    def self.load_yaml_files(filenames, yaml_sections = ['log4r_config'])
+      cfgs = []
+      yaml_sections.each do |yaml_section|
+        filenames.each do |filename|
+          log4r_config = nil
+          docs = File.open(filename)
+          begin
+            YAML.load_documents(docs) do |doc|
+              doc.has_key?(yaml_section) and log4r_config = doc[yaml_section] and break
+            end
+          rescue Exception => e
+            raise "YAML error, file: #{filename}, error=#{e.message}"
+          end
+          if log4r_config
+            cfgs << log4r_config
+          end
+        end
+      end
+
+      cfgs.each do |cfg|
+        decode_pre_config(cfg['pre_config']) unless cfg['pre_config'].nil?
+      end
+
+      cfgs.each do |cfg|
+        cfg['outputters'].each{ |op| decode_outputter(op)} unless cfg['outputters'].nil?
+      end
+
+      cfgs.each do |cfg|
+        cfg['loggers'].each{ |lo| decode_logger(lo)} unless cfg['loggers'].nil?
+      end
+
+      cfgs.each do |cfg|
+        cfg['logserver'].each{ |lo| decode_logserver(lo)} unless cfg['logserver'].nil?
+      end
+    end
+
+    def self.decode_pre_config(pre)
+      return Logger.root if pre.nil?
+      decode_custom_levels( pre['custom_levels'])
+      global_config( pre['global'])
+      root_config( pre['root'])
+      decode_parameters( pre['parameters'])
+    end
+
+    def self.root_config(e)
+      return if e.nil?
+      globlev = e['level']
+      return if globlev.nil?
+      lev = LNAMES.index(globlev)     # find value in LNAMES
+      Log4rTools.validate_level(lev, 4)  # choke on bad level
+      Logger.root.level = lev
+    end
+
+    def self.decode_logger(lo)
+      if lo['name'] == 'root'
+        l = Logger.root
+      elsif lo['name'] == 'global'
+        l = Logger.global
+      else
+        l = Logger.new lo['name']
+      end
+      decode_logger_common(l, lo)
+    end
+  end
+end

data/lib/reasonable_log4r/version.rb

@@ -0,0 +1,4 @@
+module ReasonableLog4r
+  # the current version of this gem
+  VERSION = "0.9.0"
+end

data/lib/tasks/desirable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :desirable do
+#   # Task goes here
+# end

data/logging/configure-log4r.yml

@@ -0,0 +1,32 @@
+log4r_config:
+  pre_config:
+    custom_levels:
+      - DEBUG
+      - DEBUG_FINE
+      - DEBUG_MEDIUM
+      - DEBUG_GROSS
+      - DETAIL
+      - INFO
+      - WARN
+      - ALARM
+      - ERROR
+      - FATAL
+    global:
+      level: ALL
+    root  :
+      level: ALL
+
+  loggers:
+    - name      : root
+      level     : ALL
+      outputters:
+        - stdout
+
+  outputters:
+    - type     : StdoutOutputter
+      name     : stdout
+      level    : DEBUG
+      formatter:
+        date_pattern: '%y%m%d %H:%M:%S.%L'
+        pattern     : '%d %p %C %l %M'
+        type        : PatternFormatter

data/reasonable_log4r.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "reasonable_log4r/version"
+
+Gem::Specification.new do |s|
+ s.name        = 'reasonable_log4r'
+ s.version     = ReasonableLog4r::VERSION
+ s.license     = 'New BSD License'
+ s.date        = '2012-09-16'
+ s.summary     = "Patches log4r gem to make it work in a reasonable way(Tm)."
+ s.description = "Reasonable patches to log4r gem including root loggers having outputters and yaml configurator supporting many files and yaml sections."
+ s.authors     = ["Keith Gabryelski"]
+ s.email       = 'keith@fiksu.com'
+ s.files       = `git ls-files`.split("\n")
+ s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+ s.require_path = 'lib'
+ s.homepage    = 'http://github.com/fiksu/reasonable_log4r'
+ s.add_dependency 'log4r', '1.1.10'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: reasonable_log4r
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Keith Gabryelski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+description: Reasonable patches to log4r gem including root loggers having outputters
+  and yaml configurator supporting many files and yaml sections.
+email: keith@fiksu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/reasonable_log4r.rb
+- lib/reasonable_log4r/monkey_patch_log4r.rb
+- lib/reasonable_log4r/version.rb
+- lib/tasks/desirable_tasks.rake
+- logging/configure-log4r.yml
+- reasonable_log4r.gemspec
+homepage: http://github.com/fiksu/reasonable_log4r
+licenses:
+- New BSD License
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Patches log4r gem to make it work in a reasonable way(Tm).
+test_files: []