madvertise-logging 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p0@madvertise-logging

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in madvertise-logging.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'syslogger', :require => false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 madvertise Mobile Advertising GmbH
+
+MIT License
+
+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,29 @@
+# Madvertise::Logging
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'madvertise-logging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install madvertise-logging
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]

data/lib/madvertise-logging.rb

@@ -0,0 +1,3 @@
+require 'madvertise/logging/version'
+require 'madvertise/logging/improved_logger'
+require 'madvertise/logging/multi_logger'

data/lib/madvertise/logging/improved_logger.rb

@@ -0,0 +1,265 @@
+require 'logger'
+require 'stringio'
+
+module Madvertise
+  module Logging
+    class ImprovedLogger
+
+      attr_accessor :copy_to_stdout
+      attr_accessor :transaction_token
+      attr_accessor :progname
+
+      @severities = {
+        :debug   => Logger::DEBUG,
+        :info    => Logger::INFO,
+        :warn    => Logger::WARN,
+        :error   => Logger::ERROR,
+        :fatal   => Logger::FATAL,
+        :unknown => Logger::UNKNOWN
+      }
+
+      @silencer = true
+
+      class << self
+        attr_reader :severities
+        attr_accessor :silencer
+      end
+
+      def initialize(logfile = nil, progname = nil)
+        @copy_to_stdout = false
+        @progname = progname || File.basename($0)
+        self.logger = logfile || STDERR
+      end
+
+      # Silence the logger for the duration of the block.
+      def silence(temporary_level = :error)
+        if self.class.silencer
+          begin
+            old_level, self.level = self.level, temporary_level
+            yield self
+          ensure
+            self.level = old_level
+          end
+        else
+          yield self
+        end
+      end
+
+      def debug(msg)
+        add(:debug, msg)
+      end
+
+      def debug?
+        self.level == :debug
+      end
+
+      def info(msg)
+        add(:info, msg)
+      end
+
+      def info?
+        self.level == :info
+      end
+
+      def warn(msg)
+        add(:warn, msg)
+      end
+
+      def warn?
+        self.level == :warn
+      end
+
+      def error(msg)
+        add(:error, msg)
+      end
+
+      def error?
+        self.level == :error
+      end
+
+      def fatal(msg)
+        add(:fatal, msg)
+      end
+
+      def fatal?
+        self.level == :fatal
+      end
+
+      def unknown(msg)
+        add(:unknown, msg)
+      end
+
+      def unknown?
+        self.level == :unknown
+      end
+
+      def exception(e)
+        if e.is_a?(::Exception)
+          message = "EXCEPTION: #{e.message}: #{clean_trace(e.backtrace)}"
+        else
+          message = e
+        end
+        add(:error, message, true)
+      end
+
+      def add(severity, message, skip_caller = false)
+        message = "#{called(caller)}: #{message}" unless skip_caller
+        message = "[#{@transaction_token}] #{message}" if @transaction_token
+
+        self.logger.add(self.class.severities[severity]) { message }
+
+        STDOUT.puts(message) if self.copy_to_stdout && self.class.severities[severity] >= self.logger.level
+      end
+
+      def level
+        self.class.severities.invert[@logger.level]
+      end
+
+      def level=(level)
+        level = (Symbol === level ? self.class.severities[level] : level)
+        self.logger.level = level
+      end
+
+      def new_transaction(v)
+        @transaction_token = v
+      end
+
+      def end_transaction
+        @transaction_token = nil
+      end
+
+      def save_transaction(obj)
+        if @transaction_token && obj
+          @transactions ||= {}
+          @transactions[obj.object_id] = @transaction_token
+        end
+      end
+
+      def restore_transaction(obj)
+        @transactions ||= {}
+        @transaction_token = @transactions.delete(obj.object_id) if obj
+      end
+
+      def logger
+        @logger ||= create_logger
+      end
+
+      def logger=(value)
+        @logger.close rescue nil
+
+        if value.is_a?(Logger)
+          @backend = :logger
+          @logger = value
+        elsif value.is_a?(Symbol)
+          @backend = value
+          @logger = create_logger
+        else
+          @backend = :logger
+          @logfile = value
+          @logger = create_logger
+        end
+      end
+
+      def clean_trace(trace)
+        trace = trace.map { |l| l.gsub(ROOT, '') }
+        trace = trace.reject { |l| l =~ /gems\/madvertise-logging/ }
+        trace = trace.reject { |l| l =~ /vendor\/madvertise-logging/ }
+        trace
+      end
+
+      def close
+        case @backend
+        when :logger
+          self.logger.close
+          @logger = nil
+        end
+      end
+
+      def buffer
+        if @backend == :buffer && @buffer
+          @buffer.string
+        end
+      end
+
+      private
+
+      def called(trace)
+        l = trace.detect('unknown:0') do |l|
+          l.index(File.basename(__FILE__)).nil?
+        end
+
+        file, num, _ = l.split(':')
+        [ File.basename(file), num ].join(':')
+      end
+
+      def create_logger
+        case @backend
+        when :buffer
+          create_buffering_logger
+        when :syslog
+          create_syslog_logger
+        else
+          create_standard_logger
+        end
+      end
+
+      def create_buffering_logger
+        @buffer = StringIO.new
+        Logger.new(@buffer).tap do |l|
+          l.formatter = Formatter.new
+          l.progname = progname
+        end
+      end
+
+      def create_standard_logger
+        @logfile ||= STDERR
+
+        if @logfile.is_a?(String)
+          logdir = File.dirname(@logfile)
+
+          begin
+            FileUtils.mkdir_p(logdir)
+          rescue
+            STDERR.puts "#{logdir} not writable, using STDERR for logging"
+            @logfile = STDERR
+          end
+        end
+
+        Logger.new(@logfile).tap do |l|
+          l.formatter = Formatter.new
+          l.progname = progname
+        end
+      end
+
+      def create_syslog_logger
+        begin
+          require 'syslogger'
+          Syslogger.new(progname, Syslog::LOG_PID, Syslog::LOG_LOCAL1)
+        rescue LoadError
+          self.logger = :logger
+          self.error("Couldn't load syslogger gem, reverting to standard logger")
+        end
+      end
+
+      class Formatter
+
+        # YYYY:MM:DD HH:MM:SS.MS daemon_name(pid) level: message
+        @format = "%s %s(%d) [%s] %s\n"
+
+        class << self
+          attr_accessor :format
+        end
+
+        def call(severity, time, progname, msg)
+          self.class.format % [format_time( time ), progname, $$, severity, msg.to_s]
+        end
+
+        private
+
+        def format_time(time)
+          time.strftime("%Y-%m-%d %H:%M:%S.") + time.usec.to_s
+        end
+      end
+    end
+  end
+end

data/lib/madvertise/logging/multi_logger.rb

@@ -0,0 +1,24 @@
+module Madvertise
+  module Logging
+    class MultiLogger
+      def initialize(*loggers)
+        @loggers = loggers
+      end
+
+      def attach(logger)
+        logger.new_transaction(@loggers.first.transaction_token)
+        @loggers << logger
+      end
+
+      def detach(logger)
+        @loggers.delete(logger)
+      end
+
+      def method_missing(name, *args)
+        @loggers.each do |l|
+          l.send(name, *args)
+        end
+      end
+    end
+  end
+end

data/lib/madvertise/logging/version.rb

@@ -0,0 +1,5 @@
+module Madvertise
+  module Logging
+    VERSION = "0.1.0"
+  end
+end

data/madvertise-logging.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/madvertise/logging/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Benedikt Böhm"]
+  gem.email         = ["benedikt.boehm@madvertise.com"]
+  gem.description   = %q{Advanced logging classes with buffer backend, transactions, multi logger, etc}
+  gem.summary       = %q{Advanced logging classes with buffer backend, transactions, multi logger, etc}
+  gem.homepage      = "https://github.com/madvertise/logging"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "madvertise-logging"
+  gem.require_paths = ["lib"]
+  gem.version       = Madvertise::Logging::VERSION
+
+  gem.add_development_dependency("bundler")
+  gem.add_development_dependency("rake")
+end

data/spec/improved_logger_spec.rb

@@ -0,0 +1,239 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include Madvertise::Logging
+
+RSpec::Matchers.define :have_received_message do |expected|
+  match do |actual|
+    IO.readlines(actual).last.match(Regexp.new(expected))
+  end
+end
+
+describe ImprovedLogger do
+
+  before(:each) do
+    @logfile = "#{ROOT}/log/spec.log"
+    @logger = ImprovedLogger.new(@logfile)
+    @logger.level = :debug
+  end
+
+  it "should have a backend logger" do
+    @logger.logger.should_not be_nil
+  end
+
+  it "should accept a different backend" do
+    l = Logger.new('/dev/null')
+    @logger.logger = l
+    @logger.logger.should == l
+  end
+
+  it "should be able to log to STDOUT as well" do
+    @logger.copy_to_stdout = true
+    STDOUT.should_receive(:puts).with(/test/)
+
+    @logger.debug "test"
+    @logfile.should have_received_message("test")
+  end
+
+  it "should log debug level messages" do
+    @logger.debug("Debug test")
+    @logfile.should have_received_message(/\[DEBUG\].*Debug test/)
+  end
+
+  it "should return true if debug level is set" do
+    @logger.level = :debug
+    @logger.debug?.should be true
+  end
+
+  it "should log info level messages" do
+    @logger.info("Info test")
+    @logfile.should have_received_message(/\[INFO\].*Info test/)
+  end
+
+  it "should return true if info level is set" do
+    @logger.level = :info
+    @logger.info?.should be true
+  end
+
+  it "should log warn level messages" do
+    @logger.warn("Warn test")
+    @logfile.should have_received_message(/\[WARN\].*Warn test/)
+  end
+
+  it "should return true if warn level is set" do
+    @logger.level = :warn
+    @logger.warn?.should be true
+  end
+
+  it "should log error level messages" do
+    @logger.error("Err test")
+    @logfile.should have_received_message(/\[ERROR\].*Err test/)
+  end
+
+  it "should return true if error level is set" do
+    @logger.level = :error
+    @logger.error?.should be true
+  end
+
+  it "should log fatal level messages" do
+    @logger.fatal("Fatal test")
+
+    @logfile.should have_received_message(/\[FATAL\].*Fatal test/)
+  end
+
+  it "should return true if fatal level is set" do
+    @logger.level = :fatal
+    @logger.fatal?.should be true
+  end
+
+  it "should log unknown level messages" do
+    @logger.unknown("Unknown test")
+    @logfile.should have_received_message(/\[ANY\].*Unknown test/)
+  end
+
+  it "should return true if unknown level is set" do
+    @logger.level = :unknown
+    @logger.unknown?.should be true
+  end
+
+  it "should log the caller file and line number" do
+    f = File.basename(__FILE__)
+    l = __LINE__ + 2
+
+    @logger.info("Caller test")
+    @logfile.should have_received_message("#{f}:#{l}:")
+  end
+
+  it "should log exceptions with daemon traces" do
+    fake_trace = [
+                  "/home/jdoe/app/libexec/app.rb:1:in `foo'",
+                  "/usr/lib/ruby/gems/1.8/gems/madvertise-logging-0.1.0/lib/madvertise/logging/improved_logger.rb:42: in `info'"
+                 ]
+
+    e = RuntimeError.new('Test error')
+    e.set_backtrace(fake_trace)
+
+    @logger.exception(e)
+    @logfile.should have_received_message("EXCEPTION: Test error")
+  end
+
+  it "should log exceptions without framework traces" do
+    fake_trace = [
+                  "/home/jdoe/app/libexec/app.rb:1:in `foo'",
+                  "/usr/lib/ruby/gems/1.8/gems/madvertise-logging-0.1.0/lib/madvertise/logging/improved_logger.rb:42: in `info'"
+                 ]
+
+    clean_trace = @logger.clean_trace(fake_trace)
+    clean_trace.should include("/home/jdoe/app/libexec/app.rb:1:in `foo'")
+    clean_trace.should_not include("/usr/lib/ruby/gems/1.8/gems/madvertise-logging-0.1.0/lib/madvertise/logging/improved_logger.rb:42: in `info'")
+  end
+
+  it "should not handle a backtrace if object is not an exception" do
+    @logger.exception("not an exception object")
+    @logfile.should_not have_received_message("EXCEPTION:")
+  end
+
+  it "should support reopening log files" do
+    @logger.close
+
+    FileUtils.rm(@logfile)
+
+    @logger.info('Reopen')
+    @logfile.should have_received_message("Reopen")
+  end
+
+  it "should support silencing" do
+    @logger.silence do |logger|
+      logger.info "This should never be logged"
+    end
+
+    @logfile.should_not have_received_message("This should never be logged")
+
+    @logger.info "This should be logged"
+    @logfile.should have_received_message("This should be logged")
+  end
+
+  it "should not discard messages if silencer is disabled globally" do
+    ImprovedLogger.silencer = false
+
+    @logger.silence do |logger|
+      logger.info "This should actually be logged"
+    end
+
+    @logfile.should have_received_message("This should actually be logged")
+
+    ImprovedLogger.silencer = true
+  end
+
+  it "should support a transaction token" do
+    token = "3d5e27f7-b97c-4adc-b1fd-adf1bd4314e0"
+
+    @logger.new_transaction(token)
+    @logger.info "This should include a transaction token"
+    @logfile.should have_received_message(token)
+
+    @logger.end_transaction
+    @logger.info "This should not include a transaction token"
+    @logfile.should_not have_received_message(token)
+  end
+
+  it "should support save/restore on transaction tokens" do
+    token1 = "3d5e27f7-b97c-4adc-b1fd-adf1bd4314e0"
+    token2 = "1bdef605-34b9-4ec7-9a1c-cb58efc8a635"
+
+    obj1 = Object.new
+
+    @logger.new_transaction(token1)
+    @logger.info "This should include transaction token1"
+    @logfile.should have_received_message(token1)
+
+    @logger.save_transaction(obj1)
+    @logger.new_transaction(token2)
+    @logger.info "This should include transaction token2"
+    @logfile.should have_received_message(token2)
+    @logger.end_transaction
+
+    @logger.restore_transaction(obj1)
+    @logger.info "This should include transaction token1"
+    @logfile.should have_received_message(token1)
+
+    @logger.end_transaction
+    @logger.info "This should not include a transaction token"
+    @logfile.should_not have_received_message(token1)
+    @logfile.should_not have_received_message(token2)
+  end
+
+  it "should support a buffered logger" do
+    @logger = ImprovedLogger.new(:buffer)
+    @logger.level = :debug
+    @logger.info "test"
+    @logger.buffer.should match(/test/)
+  end
+
+  it "should fall back to STDERR if logfile is not writable" do
+    STDERR.should_receive(:puts).with(/not writable.*STDERR/)
+
+    @logfile = "/not/writable/spec.log"
+    @logger = ImprovedLogger.new(@logfile)
+    @logger.level = :debug
+
+    STDERR.should_receive(:write).with(/test/)
+    @logger.info "test"
+  end
+
+  it "should fallback to standard logger if syslogger gem is missing" do
+    syslogger_paths = $:.select { |p| p.match(/gems\/.*syslogger-/) }
+    $:.replace($: - syslogger_paths)
+
+    STDERR.should_receive(:write).with(/reverting to standard logger/)
+    @logger = ImprovedLogger.new(:syslog)
+    @logger.logger.should be_instance_of(Logger)
+
+    $:.replace($: + syslogger_paths)
+  end
+
+  it "should support a syslog backend" do
+    @logger = ImprovedLogger.new(:syslog)
+    @logger.level = :debug
+    @logger.logger.should be_instance_of(Syslogger)
+  end
+end

data/spec/multi_logger_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include Madvertise::Logging
+
+describe MultiLogger do
+
+  before(:each) do
+    @logger = ImprovedLogger.new
+    @logger.level = :debug
+    @ml = MultiLogger.new(@logger)
+  end
+
+  it "should support attach/detach of loggers" do
+    buflog = ImprovedLogger.new(:buffer)
+    @ml.attach(buflog)
+
+    STDERR.should_receive(:write).with(/test1/)
+    @ml.info("test1")
+    buflog.buffer.should match(/test1/)
+
+    @ml.detach(buflog)
+
+    STDERR.should_receive(:write).with(/test2/)
+    @ml.info("test2")
+    buflog.buffer.should_not match(/test2/)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rspec'
+require 'fileutils'
+
+require 'simplecov'
+SimpleCov.start
+
+ROOT = "#{File.dirname(__FILE__)}/../tmp"
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'madvertise-logging'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # setup a fake root
+  config.before(:all) { File.directory?(ROOT) ? FileUtils.rm_rf("#{ROOT}/*") : FileUtils.mkdir_p(ROOT) }
+  config.after(:all) { FileUtils.rm_rf("#{ROOT}/*") }
+end

data/tasks/rspec.rake

@@ -0,0 +1,20 @@
+begin
+  require 'rspec'
+rescue LoadError
+  require 'rubygems'
+  require 'rspec'
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run the specs"
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = ['--options', "spec/spec.opts"]
+  end
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: madvertise-logging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benedikt Böhm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &15364280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15364280
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &15363560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15363560
+description: Advanced logging classes with buffer backend, transactions, multi logger,
+  etc
+email:
+- benedikt.boehm@madvertise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/madvertise-logging.rb
+- lib/madvertise/logging/improved_logger.rb
+- lib/madvertise/logging/multi_logger.rb
+- lib/madvertise/logging/version.rb
+- madvertise-logging.gemspec
+- spec/improved_logger_spec.rb
+- spec/multi_logger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/madvertise/logging
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3354586897547183297
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3354586897547183297
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Advanced logging classes with buffer backend, transactions, multi logger,
+  etc
+test_files:
+- spec/improved_logger_spec.rb
+- spec/multi_logger_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb