timestamped-logger 1.0.0

data/README

@@ -0,0 +1,31 @@
+TimestampedLogger gives you a simple way to create a well-formatted log, including timetsamps, and formatted logging of error messages.
+
+    # create the log
+    IMPORT_LOGGER = TimestampedLogger.new(“#{RAILS_ROOT}/log/imports.log”)
+    
+    # log normal information
+    IMPORT_LOGGER.info("Started importing")
+    # produces: 2010-01-02 03:04:05  |  Started importing
+    
+    # log without timestamp
+    IMPORT_LOGGER.info("I don't care when this happened", false)
+    # produces: "I don't care when this happened"
+    
+    # log some information, and then indent related info
+    IMPORT_LOGGER.info("started importing")
+    IMPORT_LOGGER.sub_info("started this sub-step")
+    IMPORT_LOGGER.sub_info("started this other sub-step")
+    IMPORT_LOGGER.info("ended importing")
+    # produces:
+    # 2010-01-02 03:04:05  |  started importing
+    # 2010-01-02 03:04:06  |      started this sub-step
+    # 2010-01-02 03:07:00  |      started this other sub-step
+    # 2010-01-02 03:09:36  |  ended importing
+    
+    # log an error and it's backtrace
+    IMPORT_LOGGER.backtrace(exception, "Oh no, error during import")
+    # produces:
+    # 2010-01-02 03:04:05  |  Oh no, error during import
+    # 2010-01-02 03:04:05  |  RuntimeException Foo
+    # 2010-01-02 03:04:06  |  ---> first line of the backtrace
+    # 2010-01-02 03:04:07  |  ---> second line of the backtrace

data/lib/timestamped_logger.rb

@@ -0,0 +1,27 @@
+class TimestampedLogger < Logger
+  
+  def info(message, include_timestamp = true)
+    message = "#{Time.now.to_s(:db)}  |  #{message}" if include_timestamp
+    super(message)
+  end
+  
+  def error(message)
+    super("#{Time.now.to_s(:db)}  |  #{message}")
+  end
+  
+  def sub_info(message, include_timestamp = true)
+    info("    #{message}", include_timestamp)
+  end
+  
+  def backtrace(exception, message = "")
+    if exception.respond_to?(:backtrace)
+      info("================================================", false)
+      error(message) unless message.empty?
+      error(exception.message)
+      exception.backtrace.to_a.each do |bt|
+        info(" ---> #{bt}", false)
+      end
+      info("================================================", false)
+    end
+  end
+end

data/spec/timestamped_logger_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), "/spec_helper")
+
+describe TimestampedLogger, "Adds an info message to the log" do
+  it "should call the logger info method with the timestamp on the front" do
+    File.delete(File.join(File.dirname(__FILE__), "/spec.log"))
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    t = Time.new
+    t.stubs(:to_s => "date")
+    Time.stubs(:now).returns(t)
+    log.info("message")
+    
+    File.open(File.join(File.dirname(__FILE__), "/spec.log"), 'r') { |f|
+      f.read.should include('date  |  message')
+    }
+  end
+end
+
+describe TimestampedLogger, "Adds an error message to the log" do
+  it "should call the logger error method with the timestamp on the front" do
+    File.delete(File.join(File.dirname(__FILE__), "/spec.log"))
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    t = Time.new
+    t.stubs(:to_s => "date")
+    Time.stubs(:now).returns(t)
+    log.error("message")
+    
+    File.open(File.join(File.dirname(__FILE__), "/spec.log"), 'r') { |f|
+      f.read.should include('date  |  message')
+    }
+  end
+end
+
+
+describe TimestampedLogger, "Adds a sub message to the log" do
+  it "should call the logger info method with the timestamp and spaces on the front and the default timestamp value" do
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    log.expects(:info).with("    message", true)
+    log.sub_info("message")
+  end
+  
+  it "should call the logger info method with the value of the timestamp parameter passed" do
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    log.expects(:info).with("    message", false)
+    log.sub_info("message", false)
+  end
+end
+
+describe TimestampedLogger, "Add a back trace error" do
+  it "should log nothing if what is passed doesn't responsd to the backtrace method" do
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    log.expects(:info).never
+    log.backtrace("string")
+  end
+  
+  it "should log the backtrace of the error passed" do
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    excep = mock('Exception', :backtrace => ['line 1', 'line 2'], :message => 'message')
+    log.expects(:info).with("================================================", false).twice
+    log.expects(:error).with('message')
+    log.expects(:info).with(" ---> line 1", false)
+    log.expects(:info).with(" ---> line 2", false)
+    log.backtrace(excep)
+  end
+  
+  it "should log the backtrace of the error passed and the message passed" do
+    log = TimestampedLogger.new(File.join(File.dirname(__FILE__), "/spec.log"))
+    excep = mock('Exception', :backtrace => ['line 1', 'line 2'], :message => 'message')
+    log.expects(:info).with("================================================", false).twice
+    log.expects(:error).with('message')
+    log.expects(:error).with('passing a message')
+    log.expects(:info).with(" ---> line 1", false)
+    log.expects(:info).with(" ---> line 2", false)
+    log.backtrace(excep, 'passing a message')
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: timestamped-logger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- William Spencer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/timestamped_logger.rb
+- README
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds timestamps to logs.  Adds formating for adding backtraces to logs.  Allows sub messages related to heading messages.
+test_files: 
+- spec/timestamped_logger_spec.rb