lumber 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a46d745783b60fff11ef0721004f12f9f63bd96
+  data.tar.gz: 3eba30bf67000eb632ed7a43b874b9311c06ea7d
+SHA512:
+  metadata.gz: 90f2ac82d2c07a1c41de9f1135bf635826829bb26f055d65c0d71935276eb407a5f07f23e27a2bdcb41075f655492ce566392f8606cac0c440df7fac4f8874bc
+  data.tar.gz: e982a2aa70f9201f721cbd05fb9a32a7a6cdf651e9a2afb3ad324a9e3ae1bf4035c734049a4c4b52be67ef4b9c0480c61b5cb8cd2f96bc1c7955a1664376eef4

data/CHANGELOG

@@ -1,3 +1,15 @@
+1.0.1 (10/11/2013)
+------------------
+
+add log4r json formatter
+
+1.0.0 (10/11/2013)
+------------------
+
+Add coveralls and use poltergeist/phantomjs instead of capybara-webkit so we
+fix capybara usage for capybara 2.x for travis
+only supporting ruby 1.9.3 and higher
+
 0.13.6 (08/23/2013)
 -------------------
 

data/lib/lumber/json_formatter.rb

@@ -0,0 +1,114 @@
+require "log4r/formatter/formatter"
+require 'json'
+
+module Lumber
+
+  class JsonFormatter < Log4r::BasicFormatter
+
+    def initialize(hash={})
+      @key_mapping = {}
+      mapping = hash['key_mapping'] || {}
+      @key_mapping = Hash[mapping.collect {|k, v| [k.to_s, v.to_s.split('.')]}]
+    end
+
+    def format(logevent)
+      data = {}
+      assign_mapped_key(data, :timestamp, Time.now.to_s)
+      assign_mapped_key(data, :logger, logevent.fullname)
+      assign_mapped_key(data, :level, Log4r::LNAMES[logevent.level].downcase)
+
+      if logevent.data.kind_of? Exception
+        message = "Caught #{logevent.data.class}"
+        message << ": #{logevent.data.message}" if logevent.data.message
+        assign_mapped_key(data, :message, message)
+        assign_mapped_key(data, :exception, logevent.data.class.to_s)
+        trace = logevent.data.backtrace if logevent.data.respond_to?(:backtrace)
+        if trace
+          assign_mapped_key(data, :backtrace, trace.join("\n\t"))
+          assign_mapped_key(data, :file, trace[0].split(":")[0])
+          assign_mapped_key(data, :line, trace[0].split(":")[1].to_i)
+        end
+      else
+        assign_mapped_key(data, :message, format_object(logevent.data))
+      end
+
+      if logevent.tracer
+        file, line, method = parse_caller(logevent.tracer[0])
+        assign_mapped_key(data, :file, file)
+        assign_mapped_key(data, :line, line)
+        assign_mapped_key(data, :method, method)
+      end
+
+      gdc = Log4r::GDC.get
+      if gdc && gdc != $0
+        value = nil
+        begin
+          value = gdc.inspect
+        rescue
+        end
+        assign_mapped_key(data, :gdc, value)
+      end
+
+      if Log4r::NDC.get_depth > 0
+        value = []
+        Log4r::NDC.clone_stack.each do |x|
+          begin
+            value << x.inspect
+          rescue
+          end
+        end
+        assign_mapped_key(data, :ndc, value)
+      end
+
+      mdc = Log4r::MDC.get_context
+      if mdc && mdc.size > 0
+        value = {}
+        mdc.each do |k, v|
+          begin
+            value[k] = v.inspect
+          rescue
+          end
+        end
+        assign_mapped_key(data, :mdc, value)
+      end
+
+      data.to_json
+    end
+
+    private
+
+    def assign_mapped_key(data, key, value)
+      return if value.nil? || (value.respond_to?(:size) && value.size == 0)
+      key = key.to_s
+      mapped_key = @key_mapping[key]
+      if mapped_key.nil?
+        data[key] = value
+      else
+        current = data
+        mapped_key.each_with_index do |k, i|
+          if mapped_key.size > i+1
+            current[k] ||= {}
+            current = current[k]
+          else
+            current[k] = value
+          end
+        end
+      end
+    end
+
+    def parse_caller(line)
+      if /^(.+?):(\d+)(?::in `(.*)')?/ =~ line
+        file = Regexp.last_match[1]
+        line = Regexp.last_match[2].to_i
+        method = Regexp.last_match[3]
+        [file, line, method]
+      else
+        []
+      end
+    end
+  end
+
+end
+
+# Log4r yml config only looks for constants in Log4r namespace
+Log4r::JsonFormatter = Lumber::JsonFormatter

data/lib/lumber/version.rb

@@ -1,3 +1,3 @@
 module Lumber
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/lumber.rb

@@ -5,6 +5,7 @@ require "lumber/lumber"
 require "lumber/logger_support"
 require "lumber/log4r"
 require "lumber/level_util"
+require "lumber/json_formatter"
 
 
 if defined?(Rails::Railtie)

data/spec/json_formatter_spec.rb

@@ -0,0 +1,199 @@
+require "spec_helper"
+
+describe Lumber::JsonFormatter do
+
+  context "log4r yaml configuration" do
+
+    it "has default values without configuration" do
+      yml = <<-EOF
+        log4r_config:
+          pre_config:
+            root:
+              level: 'DEBUG'
+          loggers:
+            - name: "mylogger"
+
+          outputters:
+            - type: StdoutOutputter
+              name: stdout
+              formatter:
+                type: JsonFormatter
+      EOF
+
+      cfg = Log4r::YamlConfigurator
+      cfg.load_yaml_string(yml)
+      outputter = Log4r::Outputter['stdout']
+      outputter.formatter.should_not be_nil
+      outputter.formatter.should be_a_kind_of Lumber::JsonFormatter
+    end
+
+    it "can receive configuration" do
+      yml = <<-EOF
+        log4r_config:
+          pre_config:
+            root:
+              level: 'DEBUG'
+          loggers:
+            - name: "mylogger"
+
+          outputters:
+            - type: StdoutOutputter
+              name: stdout
+              formatter:
+                type: JsonFormatter
+                key_mapping:
+                  level: severity
+                  backtrace: exception.bt
+      EOF
+
+      cfg = Log4r::YamlConfigurator
+      cfg.load_yaml_string(yml)
+      outputter = Log4r::Outputter['stdout']
+      outputter.formatter.should_not be_nil
+      outputter.formatter.should be_a_kind_of Lumber::JsonFormatter
+      outputter.formatter.instance_variable_get(:@key_mapping).should eq({'level' => ['severity'], 'backtrace' => ['exception', 'bt']})
+    end
+
+  end
+  
+  context "#assign_mapped_key" do
+    
+    it "handles no mapping" do
+      formatter = Lumber::JsonFormatter.new()
+      data = {}
+      formatter.send(:assign_mapped_key, data, 'foo', 'bar')
+      data['foo'].should == 'bar'
+    end
+    
+    it "handles simple mapping" do
+      formatter = Lumber::JsonFormatter.new('key_mapping' => {'foo' => 'baz'})
+      data = {}
+      formatter.send(:assign_mapped_key, data, 'foo', 'bar')
+      data['foo'].should be_nil
+      data['baz'].should == 'bar'
+    end
+
+    it "handles deep mapping" do
+      formatter = Lumber::JsonFormatter.new('key_mapping' => {'foo' => 'baz.bum'})
+      data = {}
+      formatter.send(:assign_mapped_key, data, 'foo', 'bar')
+      data['foo'].should be_nil
+      data['baz'].should eq({'bum' => 'bar'})
+    end
+
+    it "handles overlapping deep mapping" do
+      formatter = Lumber::JsonFormatter.new('key_mapping' => {'foo' => 'baz.bum', 'dum' => 'baz.derf'})
+      data = {}
+      formatter.send(:assign_mapped_key, data, 'foo', 'bar')
+      formatter.send(:assign_mapped_key, data, 'dum', 'hum')
+      data['foo'].should be_nil
+      data['dum'].should be_nil
+      data['baz'].should eq({'bum' => 'bar', 'derf' => 'hum'})
+    end
+
+  end
+  
+  context "log contents" do
+
+    before(:each) do
+      @logger = Lumber.find_or_create_logger('mylogger')
+      @sio = StringIO.new
+      @outputter = Log4r::IOOutputter.new("sbout", @sio)
+      @formatter = Lumber::JsonFormatter.new
+      @outputter.formatter = @formatter
+      @logger.outputters.clear
+      @logger.outputters << @outputter
+
+      Log4r::GDC.set(nil)
+      Log4r::NDC.clear
+      Log4r::MDC.get_context.keys.each {|k| Log4r::MDC.remove(k) }
+    end
+    
+    it "logs as json" do
+      @logger.info("howdy")
+      @sio.string.size.should be_present
+      json = JSON.parse(@sio.string)
+      json['logger'].should == 'mylogger'
+      json['level'].should == 'info'
+      json['message'].should == 'howdy'
+      json['timestamp'].should be_present
+    end
+    
+    it "logs as json with mapping" do
+      @formatter = Lumber::JsonFormatter.new('key_mapping' => {'level' => 'severity'})
+      @outputter.formatter = @formatter
+
+      @logger.info("howdy")
+      json = JSON.parse(@sio.string)
+      json['level'].should be_nil
+      json['severity'].should == 'info'
+    end
+
+    it "logs exception as json" do
+      ex = StandardError.new("mybad")
+      raise ex rescue nil
+      @logger.error(ex)
+      json = JSON.parse(@sio.string)
+      json['message'].should == 'Caught StandardError: mybad'
+      json['level'].should == 'error'
+      json['backtrace'].should =~  /json_formatter_spec.rb:\d+/
+      json['file'].should =~ /^\/.*json_formatter_spec.rb$/
+      json['line'].should > 0
+    end
+    
+    it "doesn't set file/line/method by default" do
+      @logger.fatal("no tracing")
+      json = JSON.parse(@sio.string)
+      json['file'].should be_nil
+      json['line'].should be_nil
+      json['method'].should be_nil
+    end
+
+    it "uses trace data if enabled" do
+      @logger.trace = true
+      @logger.fatal("no tracing")
+      json = JSON.parse(@sio.string)
+      json['file'].should =~ /^\/.*json_formatter_spec.rb$/
+      json['line'].should > 0
+      json['method'].should be_present
+    end
+    
+    it "uses global log4r context if available" do
+      Log4r::GDC.set("mygdc")
+      @logger.info("context")
+      json = JSON.parse(@sio.string)
+      json['gdc'].should == '"mygdc"'
+    end
+    
+    it "uses nested log4r context if available" do
+      Log4r::NDC.push("myndc0")
+      Log4r::NDC.push(99)
+      @logger.info("context")
+      json = JSON.parse(@sio.string)
+      json['ndc'].should == ['"myndc0"', "99"]
+    end
+    
+    it "uses mapped log4r context if available" do
+      Log4r::MDC.put("foo", "mymdcfoo")
+      Log4r::MDC.put("lucky", 7)
+      Log4r::MDC.put("myclass", Object)
+      @logger.info("context")
+      json = JSON.parse(@sio.string)
+      json['mdc'].should == {"foo" => '"mymdcfoo"', "lucky" => "7", "myclass" => "Object"}
+    end
+
+    it "handles failure inspecting log4r context" do
+      o = Object.new
+      o.stub(:inspect).and_raise("bad")
+      Log4r::GDC.set(o)
+      Log4r::NDC.push(o); Log4r::NDC.push(5)
+      Log4r::MDC.put("obj", o); Log4r::MDC.put("foo", "bar")
+      @logger.info("context")
+      json = JSON.parse(@sio.string)
+      json['gdc'].should be_nil
+      json['ndc'].should == ["5"]
+      json['mdc'].should == {"foo" => '"bar"'}
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -5,7 +5,16 @@ if ENV['CI']
   Coveralls.wear!
 end
 
-Bundler.require(:development, :test)
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'sinatra'
 Sinatra::Base.set :environment, :test
 
 require 'lumber'

metadata

@@ -1,177 +1,159 @@
 --- !ruby/object:Gem::Specification
 name: lumber
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matt Conway
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.10
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.10
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: sinatra
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rack-test
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: capybara
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: poltergeist
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: awesome_print
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: sinatra-contrib
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
-description: Lumber tries to make it easy to use the more robust log4r logging system within your rails application.  To do this it sets up log4r configuration from a yml file, and provides utility methods for adding a :logger accessor to classes dynamicaly as they get created.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lumber tries to make it easy to use the more robust log4r logging system
+  within your rails application.  To do this it sets up log4r configuration from a
+  yml file, and provides utility methods for adding a :logger accessor to classes
+  dynamicaly as they get created.
 email:
 - matt@conwaysplace.com
 executables: []
@@ -193,6 +175,7 @@ files:
 - generators/lumber/lumber_generator.rb
 - generators/lumber/templates/log4r.yml
 - lib/lumber.rb
+- lib/lumber/json_formatter.rb
 - lib/lumber/level_util.rb
 - lib/lumber/log4r.rb
 - lib/lumber/logger_support.rb
@@ -213,6 +196,7 @@ files:
 - lib/lumber/server/views/levels.erb
 - lib/lumber/version.rb
 - lumber.gemspec
+- spec/json_formatter_spec.rb
 - spec/level_util_spec.rb
 - spec/logger_support_spec.rb
 - spec/lumber_spec.rb
@@ -222,7 +206,8 @@ files:
 homepage: http://github.com/wr0ngway/lumber
 licenses:
 - MIT
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -230,30 +215,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2
       version: '0'
-  none: false
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
 summary: Lumber integrates the log4r logging system within your application.
 test_files:
+- spec/json_formatter_spec.rb
 - spec/level_util_spec.rb
 - spec/logger_support_spec.rb
 - spec/lumber_spec.rb
 - spec/server_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+has_rdoc: