slf4r 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-12-19
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/log4r_adapter.rb
+lib/logging_adapter.rb
+lib/ruby_logger_adapter.rb
+lib/slf4r.rb
+lib/slf4r/abstract_logger_facade.rb
+lib/slf4r/logger.rb
+lib/slf4r/logging_logger.rb
+lib/slf4r/noop_logger.rb
+lib/slf4r/ruby_logger.rb
+lib/slf4r/version.rb
+lib/slf4r/wrapped_logger.rb
+test/test_slf4r.rb

data/README.txt

@@ -0,0 +1,99 @@
+= slf4r
+
+* FIX (url)
+
+== DESCRIPTION:
+
+the main idea is from www.slf4j.org which is to provide a uniform interface for instantiating und using of a logger. but the actual logging is done by some third party logging framework.
+
+one idea is to have a logger per class or object (see ). in ruby you would have something like
+
+   @logger = Slf4r::LoggerFacade.new(self.class)
+
+or the convinience module
+
+   include Slf4r::Logger
+
+if the underlying logging framework allows it (like logging or log4r) then you get a logger for each namespace of your class and create a hierachy of loggers. with this you can control the log level for each logger and/or namespace.
+
+for example you have a framework A with namespace 'A' then you can set the log level for the logger with name 'A' to debug and get all the debug from the framework, etc.
+
+in case you have a framework B which uses log4r internally you can use the 'log4r_adapter' to delegate the logger creation from log4r to slf4r. in this way you have only one place where logging gets configured and controlled.
+
+== FEATURES/PROBLEMS:
+
+* can replace other logging frameworks via adapters
+
+* for the actual logging it depends on a third party logging framework
+
+== SYNOPSIS:
+
+=== using with logging gem
+
+require 'slf4r/logging_logger'
+
+Logging.init :debug, :info, :warn, :error
+
+appender = Logging::Appender.stdout
+appender.layout = Logging::Layouts::Pattern.new(:pattern => "%d [%-l] (%c) %m\n")
+logger = Logging::Logger.new(:root)
+logger.add_appenders(appender)
+logger.level = :debug
+logger.info "initialized logger . . ."
+
+=== using with ruby logger
+
+require 'slf4r/ruby_logger'
+
+=== using the log4r adapter
+
+require 'log4r_adapter'
+
+=== using with rails/merb/datamapper logger
+
+require 'slf4r/wrappered_logger'
+
+LoggerFacade4WrappedLogger.logger(framwork_logger)
+
+=== getting an instance of a logger
+
+Slf4r::LoggerFacade.new("Full::Qualified::Class::Name")
+
+== REQUIREMENTS:
+
+* logging for slf4r/logging_logger
+
+* log4r for slf4r/log4r_logger
+
+== INSTALL:
+
+* sudo gem install slf4r
+
+* sudo gem install logging # optional
+
+* sudo gem install log4r # optional
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 kristian meier
+
+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/Rakefile

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/slf4r/version.rb'
+
+Hoe.new('slf4r', Slf4r::VERSION) do |p|
+  p.rubyforge_name = 'slf4r' # if different than lowercase project name
+  p.summary = 'Slf4r provides a uniform interface for instantiating und using of a logger'
+  p.url = 'http://slf4r.rubyforge.com/'
+  p.developer('mkristian', 'm.kristian@web.de')
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Release to root
+end
+
+desc 'Install the package as a gem.'
+task :install => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "gem install --local #{gem} --no-ri --no-rdoc"
+end
+
+# vim: syntax=Ruby

data/lib/log4r_adapter.rb

@@ -0,0 +1,12 @@
+module Log4r
+  class Logger
+
+    def initialize(_fullname, _level=nil, _additive=true, _trace=false)
+      @logger = ::Slf4r::LoggerFacade.new(_fullname)
+    end
+    
+    def method_missing(method, *args, &block)
+      @logger.send(method, *args, &block) if @logger.respond_to?(method)
+    end
+  end
+end

data/lib/logging_adapter.rb

@@ -0,0 +1,16 @@
+module Logging
+  class Logger
+
+    def initialize(name)
+      @logger = ::Slf4r::LoggerFacade.new(name)
+    end
+
+    class << self
+      alias :[] :new
+    end
+    
+    def method_missing(method, *args, &block)
+      @logger.send(method, *args, &block) if @logger.respond_to?(method)
+    end
+  end
+end

data/lib/ruby_logger_adapter.rb

@@ -0,0 +1,10 @@
+class Logger
+
+  def initialize(*args)
+    @logger = ::Slf4r::LoggerFacade.new(:root)
+  end
+  
+  def method_missing(method, *args, &block)
+    @logger.send(method, *args, &block) if @logger.respond_to?(method)
+  end
+end

data/lib/slf4r/abstract_logger_facade.rb

@@ -0,0 +1,70 @@
+module Slf4r
+  class AbstractLoggerFacade
+
+    protected
+
+    def format(exception)
+      ": #{exception.message}:\n\t#{exception.backtrace.join('\n\t')}" if exception
+    end
+    
+    def _debug(msg)
+      raise NotImplementedError
+    end
+
+    def _info(msg)
+      raise NotImplementedError
+    end
+
+    def _warn(msg)
+      raise NotImplementedError
+    end
+
+    def _error(msg)
+      raise NotImplementedError
+    end
+
+    public 
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def debug?
+      raise NotImplementedError
+    end
+
+    def debug(msg = nil, exception = nil)
+      msg, exception = yield if block_given?
+      _debug("#{msg}#{format(exception)}")
+    end
+
+    def info?
+      raise NotImplementedError
+    end
+
+    def info(msg = nil, exception = nil)
+      msg, exception = yield if block_given?
+      _info("#{msg}#{format(exception)}")
+    end
+
+    def warn?
+      raise NotImplementedError
+    end
+
+    def warn(msg = nil, exception = nil)
+      msg, exception = yield if block_given?
+      _warn("#{msg}#{format(exception)}")
+    end
+
+    def error?
+      raise NotImplementedError
+    end
+
+    def error(msg = nil, exception = nil)
+      msg, exception = yield if block_given?
+      _error("#{msg}#{format(exception)}")
+    end
+  end
+end

data/lib/slf4r/logger.rb

@@ -0,0 +1,9 @@
+module Slf4r
+  module Logger
+
+    def logger
+      @logger ||= LoggerFacade.new(self.class == Class ? name : self.class)
+    end
+
+  end
+end

data/lib/slf4r/logging_logger.rb

@@ -0,0 +1,63 @@
+require 'logging'
+require 'slf4r/abstract_logger_facade'
+
+module Slf4r
+  class LoggerFacade < AbstractLoggerFacade
+    
+    attr_reader :logger
+    
+    def initialize(name)
+      super
+      log_name = nil
+      name.to_s.split("::").each do |n|
+        if log_name
+          log_name += "::#{n}"
+        else
+          log_name = n
+        end
+        @logger = ::Logging::Logger.new(log_name)
+      end
+    end
+
+    private
+
+    def log(type, msg)
+      @logger.add(type, msg)
+    end
+
+    public 
+
+    def debug?
+      @logger.level == 0
+    end
+
+    def _debug(msg)
+      log(0, msg)
+    end
+
+    def info?
+      @logger.level <= 1
+    end
+
+    def _info(msg)
+      log(1, msg)
+    end
+
+    def warn?
+      @logger.level <= 2
+    end
+
+    def _warn(msg)
+      log(2, msg)
+    end
+
+    def error?
+      @logger.level <= 3
+    end
+
+    def _error(msg)
+      log(3, msg)
+    end
+    
+  end
+end

data/lib/slf4r/noop_logger.rb

@@ -0,0 +1,40 @@
+module Slf4r
+  class LoggerFacade
+
+    def initialize(name)
+      @name = name
+    end
+
+    public 
+
+    attr_reader :name
+    
+    def debug?
+      false
+    end
+
+    def debug(msg = nil, exception = nil)
+    end
+
+    def info?
+      false
+    end
+
+    def info(msg = nil, exception = nil)
+    end
+
+    def warn?
+      false
+    end
+
+    def warn(msg = nil, exception = nil)
+    end
+
+    def error?
+      false
+    end
+
+    def error(msg = nil, exception = nil)
+    end
+  end
+end

data/lib/slf4r/ruby_logger.rb

@@ -0,0 +1,80 @@
+require 'logger.rb'
+require 'slf4r/abstract_logger_facade'
+
+module Slf4r
+  class LoggerFacade4RubyLogger
+    
+    @@level = ::Logger::INFO
+    @@file = STDERR
+    @@datetime_format = "%Y-%m-%d %H:%M:%S "
+
+    def self.new_logger_facade(name)
+      @name = name
+      @logger = ::Logger.new(@@file)
+      @logger.level = @@level
+      @logger.datetime_format = @@datetime_format
+      @logger
+    end
+
+    def self.level=(level)
+      @@level = level.instance_of?(Fixnum) ? level : 
+        ::Logger.get_const(level.to_s.upcase)
+    end
+
+    def self.datetime_format=(format)
+      @@datetime_format = format
+    end
+
+    def self.file=(file)
+      @@file = file
+    end
+  end
+   
+  class LoggerFacade < AbstractLoggerFacade
+     
+    def initialize(name)
+      super
+      @logger = LoggerFacade4RubyLogger.new_logger_facade(name)
+    end
+
+    private
+
+    def log(type, msg)
+      @logger.add(type, msg, @name)
+    end
+
+    public 
+
+    def debug?
+      @logger.debug?
+    end
+
+    def _debug(msg)
+      log(::Logger::DEBUG, msg)
+    end
+
+    def info?
+      @logger.info?
+    end
+
+    def _info(msg)
+      log(::Logger::INFO, msg)
+    end
+
+    def warn?
+      @logger.warn?
+    end
+
+    def _warn(msg)
+      log(::Logger::WARN, msg)
+    end
+
+    def error?
+      @logger.error?
+    end
+
+    def _error(msg)
+      log(::Logger::ERROR, msg)
+    end
+  end
+end

data/lib/slf4r/version.rb

@@ -0,0 +1,3 @@
+module Slf4r
+  VERSION = '0.1.0'
+end

data/lib/slf4r/wrapped_logger.rb

@@ -0,0 +1,60 @@
+require 'abstract_logger_facade'
+module Slf4r
+  class LoggerFacade4WrappedLogger
+
+    @@logger = nil
+
+    def self.new_logger_facade(name)
+      raise "set logger first" unless @@logger
+      @@logger
+    end
+
+    def self.logger=(logger)
+      @@logger = logger
+    end
+  end
+
+  class LoggerFacade < AbstractLoggerFacade
+
+    def initialize(name)
+      super
+      @logger = LoggerFacade4WrappedLogger.new_logger_facade(name)
+    end
+
+    protected
+
+    def _debug(msg)
+      @logger.debug(msg)
+    end
+
+    def _info(msg)
+      @logger.info(msg)
+    end
+
+    def _warn(msg)
+      @logger.warn(msg)
+    end
+
+    def _error(msg)
+      @logger.error(msg)
+    end
+
+    public 
+
+    def debug?
+      @logger.debug?
+    end
+
+    def info?
+      @logger.info?
+    end
+
+    def warn?
+      @logger.warn?
+    end
+
+    def error?
+      @logger.error?
+    end
+  end
+end

data/lib/slf4r.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'pathname'
+
+dir = Pathname(__FILE__).dirname.expand_path + 'slf4r'
+
+require dir + 'version'
+require dir + 'logger'
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: slf4r
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- mkristian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-08 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: the main idea is from www.slf4j.org which is to provide a uniform interface for instantiating und using of a logger. but the actual logging is done by some third party logging framework.  one idea is to have a logger per class or object (see ). in ruby you would have something like  @logger = Slf4r::LoggerFacade.new(self.class)  or the convinience module  include Slf4r::Logger  if the underlying logging framework allows it (like logging or log4r) then you get a logger for each namespace of your class and create a hierachy of loggers. with this you can control the log level for each logger and/or namespace.  for example you have a framework A with namespace 'A' then you can set the log level for the logger with name 'A' to debug and get all the debug from the framework, etc.  in case you have a framework B which uses log4r internally you can use the 'log4r_adapter' to delegate the logger creation from log4r to slf4r. in this way you have only one place where logging gets configured and controlled.
+email: 
+- m.kristian@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/log4r_adapter.rb
+- lib/logging_adapter.rb
+- lib/ruby_logger_adapter.rb
+- lib/slf4r.rb
+- lib/slf4r/abstract_logger_facade.rb
+- lib/slf4r/logger.rb
+- lib/slf4r/logging_logger.rb
+- lib/slf4r/noop_logger.rb
+- lib/slf4r/ruby_logger.rb
+- lib/slf4r/version.rb
+- lib/slf4r/wrapped_logger.rb
+- test/test_slf4r.rb
+has_rdoc: true
+homepage: http://slf4r.rubyforge.com/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: slf4r
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Slf4r provides a uniform interface for instantiating und using of a logger
+test_files: 
+- test/test_slf4r.rb