buffered_logger 0.1.1 → 0.1.2

data/TODO

@@ -1,3 +1,3 @@
 TODO
 - tests for Buffering module
-- tests for Logger (include classic functionality)
+- tests for active_support/buffered_logger functionality

data/lib/buffered_logger/formatting.rb

@@ -3,23 +3,29 @@ require 'term/ansicolor'
 module BufferedLogger::Formatting
   DEFAULT_LEVEL = :default
 
-private
-
   def initialize
     @formatter = BufferedLogger::ThreadHash.new { |h,k| h[k] = {} }
+    @color = stdout?
     super()
   end
 
+  def color?; @color end
+  def toggle_color; @color = !@color end
+  def disable_color; @color = false end
+  def enable_color; @color = true end
+
+private
+
   def formatter(severity = DEFAULT_LEVEL)
     @formatter[Thread.current][severity] || @formatter[master_thread][severity] || default_formatter
   end
 
   def set_formatter(severity = DEFAULT_LEVEL, format = nil)
-    @formatter[Thread.current][severity] = BufferedLogger::Formatter.new(:format => format, :color => color?)
+    @formatter[Thread.current][severity] = BufferedLogger::Formatter.new(:format => format, :logger => self)
   end
 
   def default_formatter
-    @formatter[master_thread][DEFAULT_LEVEL] ||= BufferedLogger::Formatter.new(:color => color?)
+    @formatter[master_thread][DEFAULT_LEVEL] ||= BufferedLogger::Formatter.new(:logger => self)
   end
 
 # magic format getters/setters
@@ -44,7 +50,7 @@ class BufferedLogger::Formatter
 
   def initialize(params = {})
     @format = params[:format] || FORMAT
-    @color = params[:color] == false ? false : COLOR
+    @logger = params[:logger]
   end
 
 # format accessors
@@ -60,11 +66,7 @@ class BufferedLogger::Formatter
 # color accessors
 
   def color?
-    @color 
-  end
-
-  def toggle_color
-    @color = !@color
+    @logger ?  @logger.color? : COLOR
   end
 
 # formatting
@@ -81,15 +83,12 @@ private
     color_matcher = /#{color_methods.map {|m| "\\$#{m}\\s?"}.join('|')}/
 
     strings = message.split(color_matcher)
-    if color?
-      colors = message.scan(color_matcher).map { |c| c[1..-1].strip }
+    return strings.join if (!color? || strings.empty?)
 
-      colored_message = ''
-      strings[1..-1].each_with_index { |s,i| colored_message << self.send(colors[i], s) }
-      strings[0] + colored_message
-    else
-      strings.join('')
-    end
+    colors = message.scan(color_matcher).map { |c| c[1..-1].strip }
+    colored_message = ''
+    strings[1..-1].each_with_index { |s,i| colored_message << self.send(colors[i], s) }
+    strings[0] + colored_message
   end
 
 end

data/lib/buffered_logger/indentation.rb

@@ -1,5 +1,5 @@
 module BufferedLogger::Indentation
-# padding is set at the thread level
+  INDENT_LEVEL = 2
 
   def initialize
     @padding = BufferedLogger::ThreadHash.new { |h,k| h[k] = BufferedLogger::Padding.new }
@@ -10,7 +10,7 @@ module BufferedLogger::Indentation
     @padding[Thread.current]
   end
 
-  def indent(level, &block)
+  def indent(level = INDENT_LEVEL, &block)
     if block_given?
       padding.indent(level)
       ret_val = block.call

data/lib/buffered_logger/logger.rb

@@ -34,8 +34,6 @@ class BufferedLogger
 
   def initialize(log, level = DEBUG, params = {})
     @master_thread = Thread.current
-    super()
-
     @level = severity_to_const(level)
     if log.respond_to?(:write)
       @log = log
@@ -45,6 +43,7 @@ class BufferedLogger
       FileUtils.mkdir_p(File.dirname(log))
       @log = open_log(log, (File::WRONLY | File::APPEND | File::CREAT))
     end
+    super()
     params.each { |k,v| SEVERITY_LEVELS.include?(k) ? set_formatter(k, v) : next }
   end
 
@@ -69,7 +68,7 @@ class BufferedLogger
   for severity in SEVERITY_LEVELS
     class_eval <<-EOT, __FILE__, __LINE__ + 1
       def #{severity}(message = nil, progname = nil, &block)
-        add(#{SEVERITY_MAP[severity]}, padding % (formatter(:#{severity}) % message.to_s), progname, &block)                  
+        add(#{SEVERITY_MAP[severity]}, formatter(:#{severity}) % (padding % message.to_s), progname, &block)                  
         nil
       end                                                            
 
@@ -79,6 +78,10 @@ class BufferedLogger
     EOT
   end
 
+  def print_blank_line
+    add(0, "\n")
+  end
+
   # Silences the logger for the duration of the block.
   def silence(temporary_level = ERROR)
     if silencer
@@ -95,7 +98,7 @@ class BufferedLogger
 
 private
 
-  def color?
+  def stdout?
     @log == STDOUT
   end
 

data/spec/formatting_spec.rb

@@ -23,17 +23,11 @@ describe BufferedLogger::Formatter do
       @f.color?.should be_true
     end
 
-    it 'should toggle the color setting' do
-      @f.toggle_color
-      @f.color?.should be_false
-      @f.toggle_color
-      @f.color?.should be_true
-    end
-
     it 'should construct a formatter object based on params' do
-      f = BufferedLogger::Formatter.new(:format => '%s%s%s', :color => false)
+      l = BufferedLogger.new(STDOUT)
+      f = BufferedLogger::Formatter.new(:format => '%s%s%s', :logger => l)
       f.to_s.should == '%s%s%s'
-      f.color?.should be_false
+      f.color?.should be_true
     end
   end
 
@@ -58,6 +52,7 @@ describe BufferedLogger do
   before :each do
     @f = StringIO.new
     @l = BufferedLogger.new(@f)
+    @l.enable_color
   end
 
   describe 'formatting' do
@@ -77,7 +72,7 @@ describe BufferedLogger do
       @l.info "haha"
 
       # colors are off so the keywords won't be parsed
-      @f.string.should == "oh\nblah\nhey\nhaha\n"
+      @f.string.should == "\e[34moh\e[0m\n\e[31mblah\e[0m\n\e[34mhey\e[0m\n\e[34mhaha\e[0m\n"
     end
 
     it 'should use appropriate formatting for each severity level' do
@@ -85,7 +80,7 @@ describe BufferedLogger do
       @l.send(:set_formatter, :info, "$blue %s")
       @l.error 'error'
       @l.info 'info'
-      @f.string.should == "error\ninfo\n"
+      @f.string.should == "\e[31merror\e[0m\n\e[34minfo\e[0m\n"
     end
 
     it 'should use the master thread formatter if one isnt set' do
@@ -95,7 +90,7 @@ describe BufferedLogger do
       t = Thread.new do
         @l.error 'blah'
       end; t.join
-      @f.string.should == "test\nblah\n"
+      @f.string.should == "\e[31mtest\e[0m\n\e[31mblah\e[0m\n"
     end
 
     it 'should use the master thread default formatter if one isnt set' do

data/spec/indentation_spec.rb

@@ -59,7 +59,7 @@ end
 describe BufferedLogger do
   before :each do
     @f = StringIO.new
-    @l = BufferedLogger.new(@f)
+    @l = BufferedLogger.new(@f, 0, :error => "ERROR: %s")
   end
 
   describe 'indentation' do
@@ -85,8 +85,17 @@ describe BufferedLogger do
       @l.indent(4) do
         @l.info 'blah'
       end
+      @l.indent do
+        @l.info 'hehe'
+      end
       @l.info 'blah'
-      @f.string.should == "    blah\nblah\n"
+      @f.string.should == "    blah\n  hehe\nblah\n"
+    end
+
+    it "should indent message content but not formatting" do
+      @l.indent(4)
+      @l.error "error"
+      @f.string.should == "ERROR:     error\n" 
     end
   end
 end

data/spec/logger_spec.rb

@@ -21,13 +21,26 @@ describe BufferedLogger do
       @f.string.should == "info\nwarn\n"
     end
 
-    it 'should support color when printing to STDOUT' do
+    it 'should be able to toggle color' do
+      @l.color?.should == false
+      @l.enable_color
+      @l.color?.should == true
+      @l.disable_color
+      @l.color?.should == false
+      @l.toggle_color
+      @l.color?.should == true
+    end
+
+    it 'should support color for STDOUT unless forced' do
       l = BufferedLogger.new(STDOUT)
-      l.send(:color?).should == true
+      l.send(:stdout?).should == true
+      l.color?.should == true
     end
 
-    it 'should not support color when not printing to STDOUT' do
-      @l.send(:color?).should == false
+    it 'should not support color when not printing to STDOUT unless forced' do
+      @l.color?.should == false
+      @l.toggle_color
+      @l.color?.should == true
     end
 
     it 'should autoset formatters during init' do
@@ -70,6 +83,16 @@ describe BufferedLogger do
       @l.flush
       @f.string.should == "test\ntest2\n"
     end
+
+    it 'should insert a blank line' do
+      @l.print_blank_line
+      @f.string.should == "\n"
+    end
+
+    it 'should log an empty string' do
+      @l.info
+      @f.string.should == "\n"
+    end
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: buffered_logger
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Alex Skryl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 -05:00
+date: 2011-07-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency