jlogger 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGES

@@ -0,0 +1,15 @@
+0.0.4
+  Switch to underlying jlogger, not slf logger, to allow parameterized logging
+  
+0.0.3
+  Allow JLogger::Simple to act as a rootlogger (e.g., JLogger::Simple.info "hello", 
+  JLogger::Simple.startConsole, etc. will all work.)
+  
+  Provide a class-level 'log' method (e.g., MyClass.log.info 'hello') for use inside
+  class methods. (def self.hello; log 'hello'; end)
+  
+0.0.2
+  First gem
+
+0.0.1
+  First release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 BillDueber
+
+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.md

@@ -0,0 +1,66 @@
+# jlogger
+
+A simple wrapper around rjack-logback to make your logging easy.
+
+
+I wanted a way to just include a module and automatically get logging that integrated with the Java logging I already had. rjack-logback provided all the tools for me to make one.
+
+```ruby
+
+require 'jlogger'
+
+class MyClass
+  include JLogger::Simple
+  def hello
+    log.info "Calling hello" # 'log' method thanks to JLogger::Simple
+    puts 'Hello'
+  end
+end
+
+
+rootlog = JLogger::RootLogger.new
+
+# Start some log output. By default, NO logging is done!
+
+rootlog.startConsole # starts logging on STDERR
+rootlog.startFile 'mylog.log' # starts logging to the file
+
+
+c = MyClass.new
+
+rootlog.info 'Hello'  # logs to both STDERR and the file mylog.log
+c.hello # ditto
+
+rootlog.loglevel = :warn # use :debug, :info, :warn, :error, or :off
+
+rootlog.info 'hello'  # doesn't log to anywhere
+c.hello # ditto
+
+MyClass.loglevel = :info # set it just for this class and its subclasses
+
+rootlog.info 'hello'  # doesn't log to anywhere
+c.hello # logs again
+
+rootlog.stopFile('mylog.log') # stop logging to the file
+rootlog.stopConsole # stop logging to STDERR
+
+```
+
+
+## Bugs
+
+I can't seem to write a good wrapper to allow the use of File handles (converted to Outputstreams); that's something I would really like.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 BillDueber. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jlogger"
+    gem.summary = %Q{Simple wrapper around rjack-logback}
+    gem.description = %Q{Include in your modules to get a defaul 'log' object; then use it to log stuff}
+    gem.email = "bill@dueber.com"
+    gem.homepage = "http://github.com/billdueber/jlogger"
+    gem.authors = ["BillDueber"]
+
+    gem.add_dependency "rjack-logback"
+
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/jlogger.rb

@@ -0,0 +1,253 @@
+require 'rubygems'
+require 'rjack-logback'
+
+
+# Redefine how to get logger names
+module RJack
+  module SLF4J
+    def self.to_log_name classobject
+      classline = []
+      parent_is_a_logback = false
+      loggingname = 'none'
+      ancestors = []
+      classobject.ancestors.each do |c|
+        c = c.to_s
+        if c == "JLogger::Simple"
+          break
+        end
+        if c == "Object"
+          break;
+        end
+        classline.unshift c.split('::')
+      end
+      loggingname = classline.flatten.join('.')
+      return loggingname
+    end
+  end
+end
+
+# Allow access to teh underlying java logger
+module RJack
+  module Logback
+    class Logger
+      attr_reader :jlogger
+    end
+  end
+end
+
+
+# Create an outputstream logger
+# Whoops. Nothing happens, and I don't know why. Don't worry about it for now.
+
+# module RJack
+#   module Logback
+#     class StreamAppender < Java::ch.qos.logback.core.OutputStreamAppender
+#       include AppenderUtil
+# 
+#       # Sets defaults, yields self to block, and calls self.start
+#       def initialize( ioobject,  &block )
+#         super()
+#         set_defaults
+#         self.setOutputStream(ioobject.to_outputstream)
+#         self.encoding = "UTF-8"
+#         finish( &block )
+#       end
+#     end
+#   end
+# end
+# 
+
+
+module JLogger
+  module Simple
+    include RJack::Logback
+
+    Level = Java::ch.qos.logback.classic.Level
+    LEVELS = {
+      # :off => RJack::Logback::OFF,
+      :off => Level::OFF,
+      :trace => TRACE,
+      :debug => DEBUG,
+      :info => INFO,
+      :warn => WARN,
+      :error => ERROR,
+    }
+        
+    def self.method_missing(meth, *args)
+      @root.send(meth, *args)
+    end
+      
+    
+
+    # On inclusion, we set up a logger for this class
+  
+    def self.included klass
+      @root ||= JLogger::RootLogger.new
+      
+      class << klass
+        attr_accessor :_slflogger, :_logobject
+      
+        def createlogger
+          RJack::Logback.root.jlogger.detachAppender('console')
+          @_slflogger = RJack::SLF4J[self]
+          @_logobject = RJack::Logback[@_slflogger.name]
+          @_slflogger = @_logobject.jlogger
+        end
+        
+        def log
+          createlogger unless @_slflogger
+          return @_slflogger
+        end
+      
+        def loglevel= level
+          self.createlogger unless @_slflogger
+        
+          level = level.to_s.downcase.to_sym
+          unless LEVELS.has_key? level
+            raise ArgumentError, "'#{level}' is an invalid loglevel"
+          end
+        
+          @_logobject.level = LEVELS[level]
+        end
+      
+      end
+    end
+  
+  
+    # The log object. First thing we do is try to 
+    # get a logger from the class; if we can't, go
+    # ahead and build one
+  
+    def log
+      unless self.class._slflogger
+        self.class.createlogger
+      end
+      return self.class._slflogger
+    end
+    
+ 
+    
+    
+  end  
+end
+
+
+# The root logger
+
+module JLogger
+  class RootLogger
+    include JLogger::Simple
+    PATTERN = RJack::Logback::PatternLayout.new("%-5level\t%date{HH:mm:ss}\t%5r\t%-30logger\t%msg\n")
+    
+    def initialize
+      self.class._logobject = RJack::Logback.root
+      self.class._slflogger = self.class._logobject.jlogger
+      RJack::Logback.root.jlogger.detachAppender('console')
+    end
+    
+    # The logging methods
+    
+    def debug *args
+      log.debug *args
+    end
+    
+    def info *args
+      log.info *args
+    end
+
+    def warn *args
+      log.warn *args
+    end
+
+    def error *args
+      log.error *args
+    end
+    
+    
+    def debug?
+      return log.debug_enabled?
+    end
+
+    def info?
+      return log.info_enabled?
+    end
+
+    def warn?
+      return log.warn_enabled?
+    end
+
+    def error?
+      return log.error_enabled?
+    end
+    
+    # Set the log level
+    # Why do I need to redefine this here? self.class.loglevel = level fails with
+    # method not found.s
+    
+    def loglevel= level
+      self.class.createlogger unless self.class._logobject
+      level = level.to_s.downcase.to_sym
+      unless JLogger::Simple::LEVELS.has_key? level
+        raise ArgumentError, "'#{level}' is an invalid loglevel"
+      end
+    
+      self.class._logobject.level = JLogger::Simple::LEVELS[level]
+    end
+    
+    def startConsole pattern = nil
+      return if  RJack::Logback.root.jlogger.getAppender('jlconsole')  
+      jlconsole = RJack::Logback::ConsoleAppender.new do |a|
+        a.target = "System.err"
+        a.name = 'jlconsole'
+        a.layout = pattern || PATTERN
+      end
+      RJack::Logback.root.add_appender( jlconsole )
+    end
+
+    def stopConsole
+      RJack::Logback.root.jlogger.detachAppender('jlconsole')
+    end
+    
+    
+   
+    def startFile file, pattern = nil
+      
+      # Get the ID and class to use
+      
+      id = nil
+      mod = nil
+      if file.is_a? String
+         id = file
+         mod = RJack::Logback::FileAppender
+      # elsif file.respond_to? :to_outputstream
+      #   id = 'objid' + file.object_id.to_s
+      #   mod = RJack::Logback::StreamAppender
+      else
+        raise ArgumentError, "#{file} is not a valid target for file logging. Must be a filename"
+      end
+            
+      return if  RJack::Logback.root.jlogger.getAppender(id)  
+      
+      app = mod.new(file) do |a|
+        a.name = id
+        a.layout = pattern || PATTERN
+      end
+      RJack::Logback.root.add_appender( app )
+    end
+    
+    def stopFile file
+      if file.is_a? String
+         id = file
+      # elsif file.respond_to? :to_outputstream
+      #   id = 'objid' + file.object_id.to_s
+      else
+        raise ArgumentError, "#{file} is not a valid target for file logging"
+      end
+      RJack::Logback.root.jlogger.detachAppender(id)
+    end
+    
+    
+  end
+end
+    
+

data/spec/jlogger_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Jlogger" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jlogger'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: jlogger
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- BillDueber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rjack-logback
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Include in your modules to get a defaul 'log' object; then use it to log stuff
+email: bill@dueber.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- CHANGES
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/jlogger.rb
+- spec/jlogger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/billdueber/jlogger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple wrapper around rjack-logback
+test_files: 
+- spec/jlogger_spec.rb
+- spec/spec_helper.rb