log-block 0.1.0

data/LICENSE

@@ -0,0 +1,17 @@
+log-block :: Automatic indenting of ruby log messages
+Copyright (C) 2009 Jon Moses
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+

data/README.rdoc

@@ -0,0 +1,25 @@
+= log-block
+
+Simply library to allow logging with indenting for ease of reading.
+
+= Example
+
+  @logger = Logger.new( STDOUT )
+  @logger.debug("Trying something new")
+  @logger.with "-> " do |log|
+    log.debug "First step"
+    # Do something
+    
+    log.debug "Second step"
+  end
+  
+Produces the following in your log:
+
+  D, [2009-03-27T20:50:16.910769 #29567] DEBUG -- : Trying something new
+  D, [2009-03-27T20:50:16.911328 #29567] DEBUG -- :   -> First step
+  D, [2009-03-27T20:50:16.911421 #29567] DEBUG -- :   -> Second step
+
+
+== Copyright
+
+Copyright (c) 2009 Jon Moses. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/log_block.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+class Logger
+  def with( prefix, indent_size = 2 )
+    yield get_block_logger( prefix, indent_size )
+  end
+  
+  def get_block_logger( prefix, indent_size = 2)
+    BlockLogger.new( self, prefix, indent_size )
+  end
+end
+
+class BlockLogger
+  def initialize( logger, prefix, indent_size = 2 )
+    @logger = logger
+    @indent_size = indent_size
+    @prefix = prefix
+  end
+
+  def method_missing( meth, *args )
+    if [:debug, :info, :warn, :error, :fatal, :unknown].include?(meth)
+      @logger.send(meth, message(args.first))
+    else
+      super
+    end
+  end
+  
+  def message( msg )
+    "#{' ' * @indent_size}#{@prefix}#{msg}"
+  end
+  
+end

data/test/log_block_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class LogBlockTest < Test::Unit::TestCase
+  context "using a default logger" do
+    setup do
+      @output = Tempfile.new("logblocktest")
+      @logger = Logger.new( @output )
+      @logger.datetime_format = "%Y-%m-%d"
+    end
+    
+    should "not indent" do
+      @logger.debug("Testing")
+      assert_last_line @output, "Testing"
+    end
+    
+    context "with one level" do
+      setup do
+        @block_logger = @logger.get_block_logger "Block:"
+      end
+      should "indent by one level" do
+        @block_logger.debug("123Testing")
+        assert_last_line @output, "  Block:123Testing"
+      end
+    end
+    
+    should "return a block logger for `with`" do
+      @logger.with "Block" do |block_logger|
+        block_logger.debug("In Block")
+        assert_last_line @output, "  Block:In Block"
+      end
+    end
+  end
+  
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'tempfile'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'log_block'
+
+class Test::Unit::TestCase
+  def last_line( file )
+    file.rewind
+    file.read.split("\n").last
+  end
+  
+  def assert_last_line( file, message, level = 'DEBUG' )
+    line = last_line(file)
+    assert "#{level[0]}, \[#{Time.now.strftime('%Y-%m-%d')}#\d+\] #{level} -- : #{message}"
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: log-block
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jon Moses
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-27 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jon@burningbush.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- VERSION.yml
+- README.rdoc
+- lib/log_block.rb
+- test/test_helper.rb
+- test/log_block_test.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/jmoses/log-block
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Automatic indenting of ruby log messages
+test_files: []
+