kcaco 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kcaco (0.0.1)
+    kcaco (0.0.2)
       guid
 
 GEM

data/README.md

@@ -42,6 +42,25 @@ write out the exception object to `Kcaco.save_path` in a file named
 the same as that GUID. You can disable the save behavior with
 `Kcaco.auto_save = false`.
 
+### Payloads
+
+If you have additional information to store, you can do so by parsing
+in a payload with the block syntax (`examples/block.rb`).
+
+```ruby
+Kcaco.pretty(exception) { "payload" }
+```
+
+This will not affect the logged message but will write out the payload
+in the saved exception. This can be useful if you want to store
+state. For example, if your application is processing a queue and you
+got an exception, you could store the queue message that triggered the
+error in the payload for later debugging.
+
+### Customize log message
+
+TBD.
+
 ## Example
 
     $ bundle exec examples/simple.rb
@@ -109,14 +128,15 @@ have to run with verbose logging:
     D, [2012-01-06T16:28:33.903784 #736] DEBUG -- : examples/no_kcaco_different_levels.rb:10:in `explosions'
     D, [2012-01-06T16:28:33.903814 #736] DEBUG -- : examples/no_kcaco_different_levels.rb:17
     
-Or you can roll your own smarts. Repeatedly. Or just use some like Kcaco. Quite simply what it does is:
+Or you can roll your own smarts. Repeatedly. Or just use something
+like Kcaco. Quite simply what it does is:
 
 * Save you having to format the log message by doing it for you.
 * Write more detail to a separate file where you can inspect it later.
 
 .. and you get
 
-    bundle exec examples/simple.rb
+    $ bundle exec examples/simple.rb
     E, [2012-01-06T16:29:50.730922 #793] ERROR -- : ae58d80f-4bc3-899a-fd0b-2c831833510c MichaelBay::Boom: ba da bloom [simple.rb L11]
 
 In this example, you could see the saved exception

data/examples/block.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "logger"
+require "kcaco"
+
+class MichaelBay
+
+  class Boom < RuntimeError; end
+  
+  def explosions
+    raise Boom.new("ba da bloom")
+  end
+end
+
+if __FILE__ == $0
+  logger = Logger.new(STDOUT)
+  begin
+    MichaelBay.new.explosions
+  rescue => e
+    logger.error Kcaco.pretty(e) { "custom payload" }
+  end
+end

data/lib/kcaco.rb

@@ -34,6 +34,7 @@ module Kcaco
     
     def pretty(exception)
       wrapped_exception = Kcaco::WrappedException.new(exception)
+      wrapped_exception.payload = yield if block_given?
       save(wrapped_exception) if auto_save?
       wrapped_exception.pretty
     end

data/lib/kcaco/file_writer.rb

@@ -20,6 +20,7 @@ module Kcaco
          ["time", Time.now.iso8601],
          ["type", exception.type],
          ["message", exception.message],
+         ["payload", exception.payload],
         ].each do |label, text|
           f.puts([label, text].join(": "))
         end

data/lib/kcaco/version.rb

@@ -1,7 +1,7 @@
 module Kcaco
 
   def version
-    "0.0.1"
+    "0.0.2"
   end
   module_function :version
 end

data/lib/kcaco/wrapped_exception.rb

@@ -4,7 +4,7 @@ module Kcaco
     require "guid"
 
     
-    attr_accessor :exception
+    attr_accessor :exception, :payload
     
     def initialize(exception)
       self.exception = exception

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kcaco
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marc Bowes
@@ -71,10 +71,12 @@ extra_rdoc_files: []
 
 files: 
 - examples/no_kcaco_different_levels.rb
+- examples/block.rb
 - examples/simple.rb
 - examples/no_kcaco_one_line.rb
 - Rakefile
 - README.md
+- pkg/kcaco-0.0.1.gem
 - Gemfile
 - kcaco.gemspec
 - spec/support/boom.rb