lumberjack 1.0.0

data/lib/lumberjack/rack.rb

@@ -0,0 +1,5 @@
+module Lumberjack
+  module Rack
+    autoload :UnitOfWork, File.expand_path("../rack/unit_of_work.rb", __FILE__)
+  end
+end

data/lib/lumberjack/rack/unit_of_work.rb

@@ -0,0 +1,15 @@
+module Lumberjack
+  module Rack
+    class UnitOfWork
+      def initialize(app)
+        @app = app
+      end
+      
+      def call(env)
+        Lumberjack.unit_of_work do
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/lumberjack/severity.rb

@@ -0,0 +1,23 @@
+module Lumberjack
+  # The standard severity levels for logging messages.
+  module Severity
+    UNKNOWN = 5
+    FATAL = 4
+    ERROR = 3
+    WARN = 2
+    INFO = 1
+    DEBUG = 0
+    
+    SEVERITY_LABELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
+    
+    class << self
+      def level_to_label(severity)
+        SEVERITY_LABELS[severity] || SEVERITY_LABELS.last
+      end
+    
+      def label_to_level(label)
+        SEVERITY_LABELS.index(label.to_s.upcase) || UNKNOWN
+      end
+    end
+  end
+end

data/lib/lumberjack/template.rb

@@ -0,0 +1,71 @@
+module Lumberjack
+  # A template converts entries to strings. Templates can contain the following place holders to
+  # reference log entry values:
+  #
+  # * <tt>:time</tt>
+  # * <tt>:severity</tt>
+  # * <tt>:progname</tt>
+  # * <tt>:unit_of_work_id</tt>
+  # * <tt>:message</tt>
+  class Template
+    TEMPLATE_ARGUMENT_ORDER = %w(:time :severity :progname :pid :unit_of_work_id :message).freeze
+    DEFAULT_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S."
+    MILLISECOND_FORMAT = "%03d"
+    MICROSECOND_FORMAT = "%06d"
+    
+    # Create a new template from the markup. The +first_line+ argument is used to format only the first
+    # line of a message. Additional lines will be added to the message unformatted. If you wish to format
+    # the additional lines, use the <tt>:additional_lines</tt> options to specify a template. Note that you'll need
+    # to provide the line separator character in this template if you want to keep the message on multiple lines.
+    #
+    # The time will be formatted as YYYY-MM-DDTHH:MM:SSS.SSS by default. If you wish to change the format, you
+    # can specify the <tt>:time_format</tt> option which can be either a time format template as documented in
+    # +Time#strftime+ or the values +:milliseconds+ or +:microseconds+ to use the standard format with the
+    # specified precision.
+    #
+    # Messages will have white space stripped from both ends.
+    def initialize(first_line, options = {})
+      @first_line_template = compile(first_line)
+      additional_lines = options[:additional_lines] || "#{Lumberjack::LINE_SEPARATOR}:message"
+      @additional_line_template = compile(additional_lines)
+      # Formatting the time is relatively expensive, so only do it if it will be used
+      @template_include_time = first_line.include?(":time") || additional_lines.include?(":time")
+      @time_format = options[:time_format] || :milliseconds
+    end
+    
+    # Convert an entry into a string using the template.
+    def call(entry)
+      lines = entry.message.strip.split(Lumberjack::LINE_SEPARATOR)
+      formatted_time = format_time(entry.time) if @template_include_time
+      message = @first_line_template % [formatted_time, entry.severity_label, entry.progname, entry.pid, entry.unit_of_work_id, lines.shift]
+      lines.each do |line|
+        message << @additional_line_template % [formatted_time, entry.severity_label, entry.progname, entry.pid, entry.unit_of_work_id, line]
+      end
+      message
+    end
+    
+    private
+
+    def format_time(time) #:nodoc:
+      if @time_format.is_a?(String)
+        time.strftime(@time_format)
+      elsif @time_format == :milliseconds
+        time.strftime(DEFAULT_TIME_FORMAT) << MILLISECOND_FORMAT % (time.usec / 1000.0).round
+      else
+        time.strftime(DEFAULT_TIME_FORMAT) << MICROSECOND_FORMAT % time.usec
+      end
+    end
+    
+    # Compile the template string into a value that can be used with sprintf.
+    def compile(template) #:nodoc:
+      template.gsub(/:[a-z0-9_]+/) do |match|
+        position = TEMPLATE_ARGUMENT_ORDER.index(match)
+        if position
+          "%#{position + 1}$s"
+        else
+          match
+        end
+      end
+    end
+  end
+end

data/spec/device/date_rolling_log_file_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Lumberjack::Device::DateRollingLogFile do
+
+  before :all do
+    create_tmp_dir
+  end
+  
+  after :all do
+    delete_tmp_dir
+  end
+  
+  let(:one_day){ 60 * 60 * 24 }
+  
+  it "should roll the file daily" do
+    today = Date.today
+    now = Time.now
+    log_file = File.join(tmp_dir, "a#{rand(1000000000)}.log")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :daily, :template => ":message")
+    logger = Lumberjack::Logger.new(device, :buffer_size => 2)
+    logger.error("test day one")
+    logger.flush
+    Time.stub!(:now).and_return(now + one_day)
+    Date.stub!(:today).and_return(today + 1)
+    logger.error("test day two")
+    logger.close
+    
+    File.read("#{log_file}.#{today.strftime('%Y-%m-%d')}").should == "test day one#{Lumberjack::LINE_SEPARATOR}"
+    File.read(log_file).should == "test day two#{Lumberjack::LINE_SEPARATOR}"
+  end
+
+  it "should roll the file weekly" do
+    today = Date.today
+    now = Time.now
+    log_file = File.join(tmp_dir, "b#{rand(1000000000)}.log")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :weekly, :template => ":message")
+    logger = Lumberjack::Logger.new(device, :buffer_size => 2)
+    logger.error("test week one")
+    logger.flush
+    Time.stub!(:now).and_return(now + (7 * one_day))
+    Date.stub!(:today).and_return(today + 7)
+    logger.error("test week two")
+    logger.close
+    
+    File.read("#{log_file}.#{today.strftime('week-of-%Y-%m-%d')}").should == "test week one#{Lumberjack::LINE_SEPARATOR}"
+    File.read(log_file).should == "test week two#{Lumberjack::LINE_SEPARATOR}"
+  end
+
+  it "should roll the file monthly" do
+    today = Date.today
+    now = Time.now
+    log_file = File.join(tmp_dir, "c#{rand(1000000000)}.log")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :monthly, :template => ":message")
+    logger = Lumberjack::Logger.new(device, :buffer_size => 2)
+    logger.error("test month one")
+    logger.flush
+    Time.stub!(:now).and_return(now + (31 * one_day))
+    Date.stub!(:today).and_return(today + 31)
+    logger.error("test month two")
+    logger.close
+    
+    File.read("#{log_file}.#{today.strftime('%Y-%m')}").should == "test month one#{Lumberjack::LINE_SEPARATOR}"
+    File.read(log_file).should == "test month two#{Lumberjack::LINE_SEPARATOR}"
+  end
+
+end

data/spec/device/date_rolling_log_file_spec.rbc

@@ -0,0 +1,2118 @@
+!RBIX
+0
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+26
+5
+7
+0
+64
+47
+49
+1
+1
+15
+5
+45
+2
+3
+43
+4
+43
+5
+56
+6
+47
+50
+7
+1
+15
+2
+11
+I
+3
+I
+0
+I
+0
+I
+0
+n
+p
+8
+s
+11
+spec_helper
+x
+7
+require
+x
+10
+Lumberjack
+n
+x
+6
+Device
+x
+18
+DateRollingLogFile
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+63
+5
+7
+0
+56
+1
+47
+50
+2
+1
+15
+5
+7
+0
+56
+3
+47
+50
+4
+1
+15
+5
+7
+5
+56
+6
+47
+50
+7
+1
+15
+5
+7
+8
+64
+56
+9
+47
+50
+10
+1
+15
+5
+7
+11
+64
+56
+12
+47
+50
+10
+1
+15
+5
+7
+13
+64
+56
+14
+47
+50
+10
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+15
+x
+3
+all
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+4
+5
+48
+0
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+x
+14
+create_tmp_dir
+p
+3
+I
+0
+I
+6
+I
+4
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+0
+x
+6
+before
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+4
+5
+48
+0
+11
+I
+2
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+x
+14
+delete_tmp_dir
+p
+3
+I
+0
+I
+a
+I
+4
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+0
+x
+5
+after
+x
+7
+one_day
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+13
+4
+60
+4
+60
+49
+0
+1
+4
+24
+49
+0
+1
+11
+I
+3
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+1
+x
+1
+*
+p
+3
+I
+0
+I
+d
+I
+d
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+0
+x
+3
+let
+s
+26
+should roll the file daily
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+332
+45
+0
+1
+49
+2
+0
+19
+0
+15
+45
+3
+4
+49
+5
+0
+19
+1
+15
+45
+6
+7
+5
+48
+8
+7
+9
+5
+7
+10
+47
+49
+11
+1
+47
+101
+12
+7
+13
+63
+3
+49
+14
+2
+19
+2
+15
+45
+15
+16
+43
+17
+43
+18
+13
+71
+19
+47
+9
+99
+47
+49
+20
+0
+13
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+130
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+49
+19
+2
+19
+3
+15
+45
+15
+29
+43
+30
+13
+71
+19
+47
+9
+173
+47
+49
+20
+0
+13
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+193
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+49
+19
+2
+19
+4
+15
+20
+4
+7
+32
+64
+49
+33
+1
+15
+20
+4
+49
+34
+0
+15
+45
+3
+35
+7
+5
+49
+36
+1
+20
+1
+5
+48
+37
+81
+38
+49
+39
+1
+15
+45
+0
+40
+7
+2
+49
+36
+1
+20
+0
+79
+81
+38
+49
+39
+1
+15
+20
+4
+7
+41
+64
+49
+33
+1
+15
+20
+4
+49
+42
+0
+15
+45
+6
+43
+20
+2
+47
+101
+12
+7
+44
+20
+0
+7
+45
+64
+49
+46
+1
+47
+101
+12
+63
+3
+49
+47
+1
+49
+48
+0
+7
+32
+45
+15
+49
+43
+50
+47
+101
+12
+63
+2
+83
+51
+15
+45
+6
+52
+20
+2
+49
+47
+1
+49
+48
+0
+7
+41
+45
+15
+53
+43
+50
+47
+101
+12
+63
+2
+83
+51
+11
+I
+d
+I
+5
+I
+0
+I
+0
+I
+-2
+p
+54
+x
+4
+Date
+n
+x
+5
+today
+x
+4
+Time
+n
+x
+3
+now
+x
+4
+File
+n
+x
+7
+tmp_dir
+s
+1
+a
+I
+3b9aca00
+x
+4
+rand
+x
+4
+to_s
+s
+4
+.log
+x
+4
+join
+x
+10
+Lumberjack
+n
+x
+6
+Device
+x
+18
+DateRollingLogFile
+x
+3
+new
+x
+8
+allocate
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+4
+roll
+x
+5
+daily
+x
+3
+[]=
+x
+8
+template
+s
+8
+:message
+x
+10
+initialize
+n
+x
+6
+Logger
+x
+11
+buffer_size
+s
+12
+test day one
+x
+5
+error
+x
+5
+flush
+n
+x
+5
+stub!
+x
+7
+one_day
+x
+1
++
+x
+10
+and_return
+n
+s
+12
+test day two
+x
+5
+close
+n
+s
+1
+.
+s
+8
+%Y-%m-%d
+x
+8
+strftime
+x
+4
+read
+x
+6
+should
+n
+x
+14
+LINE_SEPARATOR
+x
+2
+==
+n
+n
+p
+27
+I
+0
+I
+10
+I
+9
+I
+11
+I
+12
+I
+12
+I
+2e
+I
+13
+I
+85
+I
+14
+I
+c4
+I
+15
+I
+cd
+I
+16
+I
+d3
+I
+17
+I
+e6
+I
+18
+I
+f7
+I
+19
+I
+100
+I
+1a
+I
+106
+I
+1c
+I
+132
+I
+1d
+I
+14c
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+5
+x
+5
+today
+x
+3
+now
+x
+8
+log_file
+x
+6
+device
+x
+6
+logger
+x
+2
+it
+s
+27
+should roll the file weekly
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+338
+45
+0
+1
+49
+2
+0
+19
+0
+15
+45
+3
+4
+49
+5
+0
+19
+1
+15
+45
+6
+7
+5
+48
+8
+7
+9
+5
+7
+10
+47
+49
+11
+1
+47
+101
+12
+7
+13
+63
+3
+49
+14
+2
+19
+2
+15
+45
+15
+16
+43
+17
+43
+18
+13
+71
+19
+47
+9
+99
+47
+49
+20
+0
+13
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+130
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+49
+19
+2
+19
+3
+15
+45
+15
+29
+43
+30
+13
+71
+19
+47
+9
+173
+47
+49
+20
+0
+13
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+193
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+49
+19
+2
+19
+4
+15
+20
+4
+7
+32
+64
+49
+33
+1
+15
+20
+4
+49
+34
+0
+15
+45
+3
+35
+7
+5
+49
+36
+1
+20
+1
+4
+7
+5
+48
+37
+49
+38
+1
+81
+39
+49
+40
+1
+15
+45
+0
+41
+7
+2
+49
+36
+1
+20
+0
+4
+7
+81
+39
+49
+40
+1
+15
+20
+4
+7
+42
+64
+49
+33
+1
+15
+20
+4
+49
+43
+0
+15
+45
+6
+44
+20
+2
+47
+101
+12
+7
+45
+20
+0
+7
+46
+64
+49
+47
+1
+47
+101
+12
+63
+3
+49
+48
+1
+49
+49
+0
+7
+32
+45
+15
+50
+43
+51
+47
+101
+12
+63
+2
+83
+52
+15
+45
+6
+53
+20
+2
+49
+48
+1
+49
+49
+0
+7
+42
+45
+15
+54
+43
+51
+47
+101
+12
+63
+2
+83
+52
+11
+I
+d
+I
+5
+I
+0
+I
+0
+I
+-2
+p
+55
+x
+4
+Date
+n
+x
+5
+today
+x
+4
+Time
+n
+x
+3
+now
+x
+4
+File
+n
+x
+7
+tmp_dir
+s
+1
+b
+I
+3b9aca00
+x
+4
+rand
+x
+4
+to_s
+s
+4
+.log
+x
+4
+join
+x
+10
+Lumberjack
+n
+x
+6
+Device
+x
+18
+DateRollingLogFile
+x
+3
+new
+x
+8
+allocate
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+4
+roll
+x
+6
+weekly
+x
+3
+[]=
+x
+8
+template
+s
+8
+:message
+x
+10
+initialize
+n
+x
+6
+Logger
+x
+11
+buffer_size
+s
+13
+test week one
+x
+5
+error
+x
+5
+flush
+n
+x
+5
+stub!
+x
+7
+one_day
+x
+1
+*
+x
+1
++
+x
+10
+and_return
+n
+s
+13
+test week two
+x
+5
+close
+n
+s
+1
+.
+s
+10
+%Y-week-%W
+x
+8
+strftime
+x
+4
+read
+x
+6
+should
+n
+x
+14
+LINE_SEPARATOR
+x
+2
+==
+n
+n
+p
+27
+I
+0
+I
+21
+I
+9
+I
+22
+I
+12
+I
+23
+I
+2e
+I
+24
+I
+85
+I
+25
+I
+c4
+I
+26
+I
+cd
+I
+27
+I
+d3
+I
+28
+I
+eb
+I
+29
+I
+fd
+I
+2a
+I
+106
+I
+2b
+I
+10c
+I
+2d
+I
+138
+I
+2e
+I
+152
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+5
+x
+5
+today
+x
+3
+now
+x
+8
+log_file
+x
+6
+device
+x
+6
+logger
+s
+28
+should roll the file monthly
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+338
+45
+0
+1
+49
+2
+0
+19
+0
+15
+45
+3
+4
+49
+5
+0
+19
+1
+15
+45
+6
+7
+5
+48
+8
+7
+9
+5
+7
+10
+47
+49
+11
+1
+47
+101
+12
+7
+13
+63
+3
+49
+14
+2
+19
+2
+15
+45
+15
+16
+43
+17
+43
+18
+13
+71
+19
+47
+9
+99
+47
+49
+20
+0
+13
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+130
+20
+2
+44
+43
+21
+80
+49
+22
+1
+13
+7
+23
+7
+24
+49
+25
+2
+15
+13
+7
+26
+7
+27
+64
+49
+25
+2
+15
+49
+19
+2
+19
+3
+15
+45
+15
+29
+43
+30
+13
+71
+19
+47
+9
+173
+47
+49
+20
+0
+13
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+47
+49
+28
+2
+15
+8
+193
+20
+3
+44
+43
+21
+79
+49
+22
+1
+13
+7
+31
+80
+49
+25
+2
+15
+49
+19
+2
+19
+4
+15
+20
+4
+7
+32
+64
+49
+33
+1
+15
+20
+4
+49
+34
+0
+15
+45
+3
+35
+7
+5
+49
+36
+1
+20
+1
+4
+31
+5
+48
+37
+49
+38
+1
+81
+39
+49
+40
+1
+15
+45
+0
+41
+7
+2
+49
+36
+1
+20
+0
+4
+31
+81
+39
+49
+40
+1
+15
+20
+4
+7
+42
+64
+49
+33
+1
+15
+20
+4
+49
+43
+0
+15
+45
+6
+44
+20
+2
+47
+101
+12
+7
+45
+20
+0
+7
+46
+64
+49
+47
+1
+47
+101
+12
+63
+3
+49
+48
+1
+49
+49
+0
+7
+32
+45
+15
+50
+43
+51
+47
+101
+12
+63
+2
+83
+52
+15
+45
+6
+53
+20
+2
+49
+48
+1
+49
+49
+0
+7
+42
+45
+15
+54
+43
+51
+47
+101
+12
+63
+2
+83
+52
+11
+I
+d
+I
+5
+I
+0
+I
+0
+I
+-2
+p
+55
+x
+4
+Date
+n
+x
+5
+today
+x
+4
+Time
+n
+x
+3
+now
+x
+4
+File
+n
+x
+7
+tmp_dir
+s
+1
+c
+I
+3b9aca00
+x
+4
+rand
+x
+4
+to_s
+s
+4
+.log
+x
+4
+join
+x
+10
+Lumberjack
+n
+x
+6
+Device
+x
+18
+DateRollingLogFile
+x
+3
+new
+x
+8
+allocate
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+4
+roll
+x
+7
+monthly
+x
+3
+[]=
+x
+8
+template
+s
+8
+:message
+x
+10
+initialize
+n
+x
+6
+Logger
+x
+11
+buffer_size
+s
+14
+test month one
+x
+5
+error
+x
+5
+flush
+n
+x
+5
+stub!
+x
+7
+one_day
+x
+1
+*
+x
+1
++
+x
+10
+and_return
+n
+s
+14
+test month two
+x
+5
+close
+n
+s
+1
+.
+s
+5
+%Y-%m
+x
+8
+strftime
+x
+4
+read
+x
+6
+should
+n
+x
+14
+LINE_SEPARATOR
+x
+2
+==
+n
+n
+p
+27
+I
+0
+I
+32
+I
+9
+I
+33
+I
+12
+I
+34
+I
+2e
+I
+35
+I
+85
+I
+36
+I
+c4
+I
+37
+I
+cd
+I
+38
+I
+d3
+I
+39
+I
+eb
+I
+3a
+I
+fd
+I
+3b
+I
+106
+I
+3c
+I
+10c
+I
+3e
+I
+138
+I
+3f
+I
+152
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+5
+x
+5
+today
+x
+3
+now
+x
+8
+log_file
+x
+6
+device
+x
+6
+logger
+p
+13
+I
+0
+I
+5
+I
+a
+I
+9
+I
+14
+I
+d
+I
+1e
+I
+f
+I
+29
+I
+20
+I
+34
+I
+31
+I
+3f
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+0
+x
+8
+describe
+p
+5
+I
+0
+I
+1
+I
+9
+I
+3
+I
+1a
+x
+80
+/Users/bdurand/dev/projects/lumberjack/spec/device/date_rolling_log_file_spec.rb
+p
+0