madvertise-logging 0.6.0 → 0.7.0

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -4,10 +4,10 @@ gemspec
 
 group :development, :test do
   gem 'bundler'
+  gem 'kramdown'
   gem 'pry'
   gem 'pry-doc'
   gem 'rake'
-  gem 'redcarpet'
   gem 'reek'
   gem 'rspec'
   gem 'ruby2ruby', '=1.3.0' # 1.3.1 is broken :(

data/benchmark.rb

@@ -0,0 +1,52 @@
+require 'bundler/setup'
+require 'madvertise-logging'
+require 'benchmark'
+
+puts "Using " + %x(ruby -v)
+puts
+
+$log = Madvertise::Logging::ImprovedLogger.new(:buffer)
+
+STRING_A = ("a string"*10).freeze
+STRING_B = ("b string"*10).freeze
+
+n = 2000000
+
+puts ">>> Testing String interpolation vs. concatenation (n=#{n})"
+
+Benchmark.bmbm do |x|
+  x.report("append double") { n.times do; "" << STRING_A << STRING_B << STRING_A; end }
+  x.report("concat double") { n.times do; STRING_A + STRING_B + STRING_A; end }
+  x.report("concat interp") { n.times do; "#{STRING_A}#{STRING_B}#{STRING_A}"; end }
+end
+
+n = 50000
+
+puts
+puts ">>> Testing caller"
+Benchmark.bmbm do |x|
+  x.report("caller") { n.times do; caller; end }
+end
+
+$debug = false
+$log.level = :info
+
+puts
+puts ">>> Testing log.debug with debug disabled (n=#{n})"
+Benchmark.bmbm do |x|
+  x.report("debug w/  guard") { n.times do; $log.debug(STRING_A) if $debug; end }
+  x.report("debug w/  block") { n.times do; $log.debug{STRING_A}; end }
+  x.report("debug w/  block + concat") { n.times do; $log.debug{"#{STRING_A}#{STRING_B}#{STRING_A}"}; end }
+  x.report("debug w/o guard") { n.times do; $log.debug(STRING_A); end }
+  x.report("debug w/o guard + concat") { n.times do; $log.debug("#{STRING_A}#{STRING_B}#{STRING_A}"); end }
+end
+
+$debug = true
+$log.level = :debug
+
+puts
+puts ">>> Testing log.debug with debug enabled (n=#{n})"
+Benchmark.bmbm do |x|
+  x.report("debug w/  guard") { n.times do; $log.debug(STRING_A) if $debug; end }
+  x.report("debug w/o guard") { n.times do; $log.debug(STRING_A); end }
+end

data/lib/madvertise-logging.rb

@@ -1,3 +1,6 @@
 require 'madvertise/logging/version'
 require 'madvertise/logging/improved_logger'
 require 'madvertise/logging/multi_logger'
+
+ImprovedLogger = Madvertise::Logging::ImprovedLogger
+MultiLogger = Madvertise::Logging::MultiLogger

data/lib/madvertise/logging/improved_logger.rb

@@ -3,6 +3,16 @@ require 'stringio'
 
 require 'madvertise/logging/improved_io'
 
+class String
+  def clean_quote
+    if index(/["\s]/)
+      %{"#{tr('"', "'")}"}
+    else
+      self
+    end
+  end
+end
+
 module Madvertise
   module Logging
 
@@ -18,6 +28,12 @@ module Madvertise
       # Arbitrary token to prefix log messages with.
       attr_accessor :token
 
+      # Log the file/line where the message came from
+      attr_accessor :log_caller
+
+      # Log filename for file backend.
+      attr_reader :logfile
+
       @severities = {
         :debug   => Logger::DEBUG,
         :info    => Logger::INFO,
@@ -41,6 +57,7 @@ module Madvertise
       def initialize(backend = STDERR, progname = nil)
         self.progname = progname || File.basename($0)
         self.logger = backend
+        self.log_caller = false
       end
 
       # Get the backend logger.
@@ -58,7 +75,8 @@ module Madvertise
       # @return [Logger] The newly created backend logger object.
       def logger=(value)
         @backend = value
-        create_backend
+        @logger = create_backend
+        define_level_methods
       end
 
       # Close any connections/descriptors that may have been opened by the
@@ -79,7 +97,8 @@ module Madvertise
       #
       # @return [Symbol] Current logging level.
       def level
-        self.class.severities.invert[@logger.level]
+        @severities_inverted ||= self.class.severities.invert
+        @severities_inverted[@logger.level]
       end
 
       # Set the logging level.
@@ -87,41 +106,33 @@ module Madvertise
       # @param [Symbol, Fixnum] level  New level as Symbol or Fixnum from Logger class.
       # @return [Fixnum] New level converted to Fixnum from Logger class.
       def level=(level)
-        level = level.is_a?(Symbol) ? self.class.severities[level] : level
-        logger.level = level
-      end
-
-      # Log a debug level message.
-      def debug(msg)
-        add(:debug, msg)
-      end
-
-      # Log an info level message.
-      def info(msg)
-        add(:info, msg)
+        logger.level = level.is_a?(Symbol) ? self.class.severities[level] : level
+        define_level_methods
       end
 
-      # Log a warning level message.
-      def warn(msg)
-        add(:warn, msg)
-      end
-
-      # Log an error level message.
-      def error(msg)
-        add(:error, msg)
-      end
-
-      # Log a fatal level message.
-      def fatal(msg)
-        add(:fatal, msg)
-      end
-
-      # Log a message with unknown level.
-      def unknown(msg)
-        add(:unknown, msg)
+      # @private
+      def define_level_methods
+        # We do this dynamically here, so we can implement a no-op for levels
+        # which are disabled.
+        self.class.severities.each do |severity, num|
+          if num >= logger.level
+            instance_eval(<<-EOM, __FILE__, __LINE__)
+              def #{severity}(*args, &block)
+                if block_given?
+                  add(:#{severity}, *yield)
+                else
+                  add(:#{severity}, *args)
+                end
+              end
+            EOM
+          else
+            instance_eval("def #{severity}(*args); end", __FILE__, __LINE__)
+          end
+        end
       end
 
-      # Log an info level message
+      # Compatibility method
+      # @private
       def <<(msg)
         add(:info, msg)
       end
@@ -130,14 +141,15 @@ module Madvertise
 
       # Log an exception with fatal level.
       #
-      # @param [Exception, String] exc  The exception to log. If exc is a
-      #   String no backtrace will be generated.
-      # @param [String] prefix  Additional message to log.
-      def exception(exc, prefix=nil)
-        msg = "EXCEPTION"
-        msg << ": #{prefix}" if prefix
-        msg << ": #{exc.message}: #{clean_trace(exc.backtrace)}" if exc.is_a?(::Exception)
-        fatal(msg)
+      # @param [Exception] exc  The exception to log.
+      # @param [String] message  Additional reason to log.
+      def exception(exc, message=nil)
+        fatal("exception", {
+          class: exc.class,
+          reason: exc.message,
+          message: message,
+          backtrace: clean_trace(exc.backtrace)
+        })
       end
 
       # Save the current token and associate it with obj#object_id.
@@ -187,14 +199,15 @@ module Madvertise
           line.match(/(improved_logger|multi_logger)\.rb/).nil?
         end
 
-        file, num, discard = location.split(':')
+        file, num, _ = location.split(':')
         [ File.basename(file), num ].join(':')
       end
 
-      def add(severity, message)
+      def add(severity, message, attribs={})
         severity = self.class.severities[severity]
-        message = "#{called_from}: #{message}"
+        message = "#{called_from}: #{message}" if @log_caller
         message = "[#{@token}] #{message}" if @token
+        message = "#{message} #{attribs.map{|k,v| "#{k}=#{v.to_s.clean_quote}"}.join(' ')}" if attribs.any?
         logger.add(severity) { message }
         return nil
       end
@@ -275,8 +288,7 @@ module Madvertise
 
         # @private
         def call(severity, time, progname, msg)
-          # this is so ugly because ruby 1.8 does not support %N in strftime
-          time = time.strftime("%Y-%m-%d %H:%M:%S.") + sprintf('%.6f', time.usec.to_f/1000/1000)[2..-1]
+          time = time.strftime("%Y-%m-%d %H:%M:%S.%N")
           self.class.format % [time, progname, $$, severity, msg.to_s]
         end
       end

data/lib/madvertise/logging/version.rb

@@ -1,6 +1,6 @@
 module Madvertise
   module Logging
     # @private
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/spec/improved_logger_spec.rb

@@ -6,50 +6,50 @@ include Madvertise::Logging
 
 RSpec::Matchers.define :have_received_message do |expected|
   match do |actual|
-    last = IO.readlines(actual).last
-    last ? last.match(Regexp.new(expected)) : false
+    @last = IO.readlines(actual).last rescue nil
+    @last ? @last.match(Regexp.new(expected)) : false
   end
-end
-
-describe ImprovedLogger do
 
-  before(:each) do
-    @logfile = Tempfile.new("spec").path
-    @logger = ImprovedLogger.new(@logfile)
-    @logger.level = :debug
+  failure_message_for_should do |actual|
+    "expected #{@last.inspect} to contain #{expected}"
   end
 
-  it "should be an IO object" do
-    @logger.should be_a(IO)
+  failure_message_for_should_not do |actual|
+    "expected #{@last.inspect} to not contain #{expected}"
   end
+end
 
-  it "should have a backend logger" do
-    @logger.logger.should_not be_nil
-  end
+describe ImprovedLogger do
 
-  it "should accept a different backend" do
-    l = Logger.new('/dev/null')
-    @logger.logger = l
-    @logger.logger.should == l
+  before(:all) do
+    Tempfile.new("spec").tap do |tmpfile|
+      @logfile = tmpfile.path
+      tmpfile.close
+    end
   end
 
-  it "should support reopening log files" do
-    @logger.close
-
-    FileUtils.rm(@logfile)
-
-    @logger.info('Reopen')
-    @logfile.should have_received_message("Reopen")
+  after(:all) do
+    File.unlink(@logfile) rescue nil
   end
 
-  it "should log debug level messages" do
-    @logger.debug("Debug test")
-    @logfile.should have_received_message(/\[DEBUG\].*Debug test/)
+  before(:each) do
+    File.unlink(@logfile) rescue nil
+    @logger = ImprovedLogger.new(@logfile)
+    @logger.level = :debug
   end
 
-  it "should log info level messages" do
-    @logger.info("Info test")
-    @logfile.should have_received_message(/\[INFO\].*Info test/)
+  subject { @logger }
+
+  it { should be_a IO }
+  its(:logger) { should_not be_nil }
+
+  ImprovedLogger.severities.keys.each do |level|
+    describe level do
+      subject { @logfile }
+      before { @logger.send(level, "test") }
+      let(:prefix) { level == :unknown ? "ANY" : level.to_s.upcase }
+      it { should have_received_message(/\[#{prefix}\].*test/) }
+    end
   end
 
   it "should log info level messages with write and << compat methods" do
@@ -59,74 +59,82 @@ describe ImprovedLogger do
     @logfile.should have_received_message(/\[INFO\].*Info test2/)
   end
 
-  it "should log warn level messages" do
-    @logger.warn("Warn test")
-    @logfile.should have_received_message(/\[WARN\].*Warn test/)
+  it "should support additional attributes" do
+    @logger.info("foo", key: "value", test: "with space")
+    @logfile.should have_received_message(/key=value test="with space"/)
   end
 
-  it "should log error level messages" do
-    @logger.error("Err test")
-    @logfile.should have_received_message(/\[ERROR\].*Err test/)
+  it "should support lazy-evaluation via blocks" do
+    @logger.debug { "debug message" }
+    @logfile.should have_received_message(/debug message/)
+    @logger.debug { ["debug message", {key: "value"}] }
+    @logfile.should have_received_message(/debug message.*key=value/)
   end
 
-  it "should log fatal level messages" do
-    @logger.fatal("Fatal test")
-    @logfile.should have_received_message(/\[FATAL\].*Fatal test/)
+  it "should accept a different backend" do
+    l = Logger.new('/dev/null')
+    @logger.logger = l
+    @logger.logger.should == l
   end
 
-  it "should log unknown level messages" do
-    @logger.unknown("Unknown test")
-    @logfile.should have_received_message(/\[ANY\].*Unknown test/)
+  it "should support reopening log files" do
+    @logger.close
+    FileUtils.rm(@logfile)
+    @logger.info('Reopen')
+    @logfile.should have_received_message("Reopen")
   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
+  describe :log_caller do
+    it "should log the caller file and line number" do
+      f = File.basename(__FILE__)
+      l = __LINE__ + 3
 
-  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'"
-                 ]
+      @logger.log_caller = true
+      @logger.info("Caller test")
+      @logfile.should have_received_message("#{f}:#{l}:")
+    end
 
-    e = RuntimeError.new('Test error')
-    e.set_backtrace(fake_trace)
+    it "should not log the caller file and line number" do
+      f = File.basename(__FILE__)
+      l = __LINE__ + 3
 
-    @logger.exception(e)
-    @logfile.should have_received_message("EXCEPTION: Test error")
+      @logger.log_caller = false
+      @logger.info("Caller test")
+      @logfile.should_not have_received_message("#{f}:#{l}:")
+    end
   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'")
+  let(:fake_trace) do
+    [
+      "/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'"
+    ]
   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
+  describe :exceptions do
+    let(:exc) do
+      RuntimeError.new('Test error').tap do |exc|
+        exc.set_backtrace(fake_trace)
+      end
+    end
 
-  it "should log additional info on exceptions" 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'"
-                 ]
+    subject { @logfile }
 
-    e = RuntimeError.new('Test error')
-    e.set_backtrace(fake_trace)
+    context "with exception object" do
+      before { @logger.exception(exc) }
+      it { should have_received_message("exception class=RuntimeError reason=\"Test error\"") }
+    end
 
-    @logger.exception(e, "app failed to foo")
-    @logfile.should have_received_message("app failed to foo")
+    context "with exception object and prefix" do
+      before { @logger.exception(exc, "app failed to foo") }
+      it { should have_received_message("app failed to foo") }
+    end
+  end
+
+  describe :clean_trace do
+    subject { @logger.clean_trace(fake_trace) }
+    it { should include("/home/jdoe/app/libexec/app.rb:1:in `foo'") }
+    it { 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 support silencing" do
@@ -217,21 +225,10 @@ describe ImprovedLogger do
       @logger.close_write
     end
 
-    it "should be in sync mode" do
-      @logger.sync.should == true
-    end
-
-    it "should return self on flush" do
-      @logger.flush.should == @logger
-    end
-
-    it "should return self on set_encoding" do
-      @logger.set_encoding.should == @logger
-    end
-
-    it "should ne be a tty" do
-      @logger.tty?.should == false
-    end
+    its(:flush) { should == @logger }
+    its(:set_encoding) { should == @logger }
+    its(:sync) { should == true }
+    its(:tty?) { should == false }
 
     it "should support printf" do
       @logger.printf("%.2f %s", 1.12345, "foo")
@@ -249,11 +246,19 @@ describe ImprovedLogger do
       @logger.puts("a", "b")
       @logfile.should have_received_message("b")
       @logger.puts(["c", "d"])
-      @logfile.should have_received_message("b")
+      @logfile.should have_received_message("d")
       @logger.puts(1, 2, 3)
       @logfile.should have_received_message("3")
     end
 
+    it "should not implement closed?" do
+      expect { @logger.closed? }.to raise_error(NotImplementedError)
+    end
+
+    it "should not implement sync=" do
+      expect { @logger.sync = false }.to raise_error(NotImplementedError)
+    end
+
     it "should implement readbyte, readchar, readline" do
       {
         :readbyte => :getbyte,
@@ -261,24 +266,10 @@ describe ImprovedLogger do
         :readline => :gets,
       }.each do |m, should|
         @logger.should_receive(should)
-        lambda {
-          @logger.send(m)
-        }.should raise_error(IOError)
+        expect { @logger.send(m) }.to raise_error(IOError)
       end
     end
 
-    it "should not implement closed?" do
-      lambda {
-        @logger.closed?
-      }.should raise_error(NotImplementedError)
-    end
-
-    it "should not implement sync=" do
-      lambda {
-        @logger.sync = false
-      }.should raise_error(NotImplementedError)
-    end
-
     [
       :bytes,
       :chars,
@@ -299,41 +290,30 @@ describe ImprovedLogger do
       :ungetc
     ].each do |m|
       it "should raise IOError for method #{m}" do
-        lambda {
-          @logger.send(m)
-        }.should raise_error(IOError)
+        expect { @logger.send(m) }.to raise_error(IOError)
       end
     end
   end
 
   context "buffer backend" do
-    before(:each) do
-      @logger = ImprovedLogger.new(:buffer)
-      @logger.level = :debug
-    end
+    before { @logger = ImprovedLogger.new(:buffer) }
+    its(:sync) { should == false }
 
     it "should support a buffered logger" do
       @logger.info "test"
       @logger.buffer.should match(/test/)
     end
-
-    it "should not be in sync mode" do
-      @logger.sync.should == false
-    end
   end
 
   context "syslog backend" do
-    before(:each) do
-      @logger = ImprovedLogger.new(:syslog)
-      @logger.level = :debug
-    end
-
-    it "should have a syslog backend" do
-      @logger.logger.should be_instance_of(Syslogger)
-    end
+    before { @logger = ImprovedLogger.new(:syslog) }
+    its(:sync) { should == true }
+    its(:logger) { should be_instance_of(Syslogger) }
+  end
 
-    it "should be in sync mode" do
-      @logger.sync.should == true
+  context "unknown backend" do
+    it "should raise for unknown backends " do
+      expect { ImprovedLogger.new(:unknown_logger) }.to raise_error(RuntimeError)
     end
   end
 

data/spec/spec.opts

@@ -1 +1,2 @@
 --colour
+--format documentation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madvertise-logging
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies: []
 description: Advanced logging classes with buffer backend, transactions, multi logger,
   etc
@@ -27,6 +27,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark.rb
 - lib/madvertise-logging.rb
 - lib/madvertise/logging/improved_io.rb
 - lib/madvertise/logging/improved_logger.rb
@@ -55,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1250046391813060871
+      hash: -920573810095702507
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1250046391813060871
+      hash: -920573810095702507
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17