slf4r 0.3.2 → 0.3.3

data/History.txt

@@ -0,0 +1,27 @@
+=== 0.3.3 / 2010-07-29
+
+* reworked Rakefile, pom.xml
+
+* better decision which default logger to use
+
+=== 0.3.2 / 2010-06-20
+
+* fixed non java case to fall back to rubylogger
+
+=== 0.3.1 / 2010-05-12
+
+* added fatal methods since they are just missing
+
+* check before triggering the log event, i.e. have string operations only when logging takes place
+
+=== 0.3.0 / 2010-05-09
+
+* added pom.xml for maven build
+
+* added facade for slf4j which will be default when running jruby and having the respective libraries in place
+
+=== 0.1.1 / 2008-12-19
+
+* fixed printoout of backtrace
+
+* added log methods for ruby_logger_adapter

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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/README.txt

@@ -0,0 +1,106 @@
+= SLF4R
+
+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 also http://slf4j.org/). 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 separately.
+
+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:
+
+* can replace other logging frameworks via adapters
+
+* for the actual logging it depends on a third party logging framework and its configuration
+
+== 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
+
+=== using with ruby logger
+
+require 'slf4r/ruby_logger'
+
+=== using the log4r adapter
+
+require 'log4r_adapter'
+
+=== using with rails/merb/datamapper logger
+
+require 'slf4r/wrapped_logger'
+
+Slf4r::LoggerFacade4WrappedLogger.logger = framwork_logger
+
+=== using with slf4j with jruby
+
+just get the needed jar files/ configuration files in the classpath
+(see http://slf4j.org/) or if you use maven then have a look and the
+pom.xml of that project.
+
+=== getting an instance of a logger
+
+Slf4r::LoggerFacade.new("Full::Qualified::Class::Name")
+
+or
+
+Slf4r::LoggerFacade.new(Full::Qualified::Class::Name)
+
+== REQUIREMENTS:
+
+* logging for slf4r/logging_logger
+
+* log4r for slf4r/log4r_logger
+
+* slf4j jars in the classpath for slf4j
+
+== INSTALL:
+
+* sudo gem install slf4r
+
+* sudo gem install logging # optional
+
+* sudo gem install log4r # optional
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 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,42 @@
+# -*- ruby -*-
+
+require 'rubygems'
+
+require 'spec'
+require 'spec/rake/spectask'
+
+BUILD_DIR = 'target'
+
+desc 'clean up'
+task :clean do
+  FileUtils.rm_rf(BUILD_DIR)
+  FileUtils.rm_rf('tmp')
+end
+
+desc 'package as a gem.'
+task :package do
+  require 'fileutils'
+  gemspec = Dir['*.gemspec'].first
+  Kernel.system("#{RUBY} -S gem build #{gemspec}")
+  FileUtils.mkdir_p(BUILD_DIR)
+  gem = Dir['*.gem'].first
+  FileUtils.mv(gem, File.join(BUILD_DIR,"#{gem}"))
+  puts File.join(BUILD_DIR,"#{gem}")
+end
+
+desc 'Install the package as a gem.'
+task :install => [:package] do
+  gem = Dir[File.join(BUILD_DIR, '*.gem')].first
+  extra = ENV['GEM_HOME'].nil? && ENV['GEM_PATH'].nil? ? "--user-install" : ""
+  Kernel.system("#{RUBY} -S gem install --local #{gem} --no-ri --no-rdoc #{extra}")
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  if File.exists?('spec/spec.opts')
+    t.spec_opts << '--options' << 'spec/spec.opts'
+  end
+  t.spec_files = Dir.glob('./spec/**/*_spec.rb')
+end
+
+# vim: syntax=Ruby

data/lib/slf4r/version.rb

@@ -1,3 +1,3 @@
 module Slf4r
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'.freeze
 end

data/lib/slf4r.rb

@@ -1,6 +1,18 @@
 require 'slf4r/logger'
 begin
-  require 'slf4r/java_logger'
+  # make sure we have java
+  require 'java'
+  begin
+    # make sure we have SLF4J in the classloader
+    import 'org.slf4j.LoggerFactory'
+
+    require 'slf4r/java_logger'
+    puts "using slf4j logger"
+  rescue NameError
+    puts "no SLF4J found in classloader - using ruby logger"
+    require 'slf4r/ruby_logger'
+  end
 rescue LoadError
+  puts "using ruby logger"
   require 'slf4r/ruby_logger'
 end

data/spec/spec_helper.rb

@@ -12,6 +12,8 @@ class File2String < String
 
 end
 
+require 'rubygems'
+
 $LOAD_PATH << Pathname(__FILE__).dirname.parent.expand_path + 'lib'
 require 'slf4r'
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 3
-    - 2
-  version: 0.3.2
+    - 3
+  version: 0.3.3
 platform: ruby
 authors: 
   - Kristian Meier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 +05:30
+date: 2010-07-31 00:00:00 +05:30
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -66,9 +66,14 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+  - History.txt
+  - README.txt
 files: 
+  - MIT-LICENSE
+  - History.txt
+  - README.txt
+  - Rakefile
   - lib/logging_adapter.rb
   - lib/slf4r.rb
   - lib/log4r_adapter.rb
@@ -95,8 +100,9 @@ homepage: http://github.com/mkristian/slf4r
 licenses: 
   - MIT-LICENSE
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+  - --main
+  - README.txt
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement