fiveruns-dash-ruby 0.8.8 → 0.8.9

data/lib/fiveruns/dash/configuration.rb

@@ -60,6 +60,10 @@ module Fiveruns::Dash
       Instrument.add(*meths, &block)
     end
     
+    def annotate_exceptions(&block)
+      ::Fiveruns::Dash.session.exception_recorder.add_annotation(&block)
+    end
+    
     # Merge in an existing recipe
     # call-seq:
     #   add_recipe :ruby

data/lib/fiveruns/dash/exception_recorder.rb

@@ -58,15 +58,21 @@ module Fiveruns
       @session = session
     end
     
+    def exception_annotations
+      @exception_annotaters ||= []
+    end
+    
     def ignore_exception?(exception)
       RULES.any? do |rule|
         rule.call(exception)
       end
     end
-
+    
     def record(exception, sample=nil)
       return if ignore_exception? exception
-
+      
+      run_annotations(sample)
+      
       data = extract_data_from_exception(exception)
       # Allow the sample data to override the exception's display name.
       data[:name] = sample.delete(:name) if sample and sample[:name]
@@ -91,11 +97,23 @@ module Fiveruns
     def reset
       exceptions.clear
     end
-
+    
+    def add_annotation(&annotation)
+      exception_annotations << annotation
+    end
+    
     #######
     private
     #######
     
+    def run_annotations(sample)
+      exception_annotations.each do |annotation|
+        annotation.call(sample)
+      end
+      
+      return sample
+    end
+    
     def flatten_sample(sample)
       case sample
       when Hash

data/lib/fiveruns/dash/session.rb

@@ -64,7 +64,7 @@ module Fiveruns::Dash
       #puts "Sending #{metric_payload.map { |met| [met[:name], met[:values].size] }.inspect} metrics"
       metric_payload
     end
-
+    
     def exception_data
       exception_recorder.data
     end

data/test/configuration_test.rb

@@ -79,7 +79,19 @@ class ConfigurationTest < Test::Unit::TestCase
         assert_equal %w(bar foo), @config.metrics.map { |m| m.name }.map { |i| i.to_s }.sort
       end
     end
-
+    
+    context 'for exception annotations' do
+      should 'add a block to the list of annotations' do
+        config.annotate_exceptions do |metadata|
+          metadata[:foo] = 'flop!'
+        end
+        
+        assert_equal 1, 
+          ::Fiveruns::Dash.session.
+            exception_recorder.exception_annotations.length
+      end
+    end
+    
   end
   
   #######

data/test/exception_recorder_test.rb

@@ -69,6 +69,17 @@ class ExceptionRecorderTest < Test::Unit::TestCase
       should "not serialize sample" do
         assert_equal({'key' => 'value'}, recorder.data.first[:sample])
       end      
+      should 'run annotations on exception samples' do
+        recorder.reset
+        recorder.add_annotation do |metadata|
+          metadata.delete :key
+          metadata[:foo] = 1
+          'flop'
+        end
+        recorder.record(build('Some exception'), {:key => 1})
+        
+        assert_equal({'foo' => '1'}, recorder.data.first[:sample])
+      end
     end
     
     context "when recording exceptions with the same message and backtrace" do

data/test/session_test.rb

@@ -43,7 +43,36 @@ class SessionTest < Test::Unit::TestCase
       end
       
     end
-
+    
+    context "exceptions" do
+      
+      setup do
+        @ex = generate_exception
+      end
+      
+      should 'add exceptions to the exception recorder' do
+        @session.add_exception(@ex)
+        
+        assert_exception_matches @ex, @session.exception_recorder.data.first
+      end
+      
+    end
+    
+  end
+  
+  protected
+  
+  def assert_exception_matches(exception, hash)
+    assert_equal exception.class.to_s, hash[:name]
+    assert_equal exception.message, hash[:message]
+  end
+  
+  def generate_exception
+    begin
+      raise Exception.new("OHS NOES")
+    rescue Exception => e
+      e
+    end
   end
 
 end

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.8.8
+  version: 0.8.9
 platform: ruby
 authors: 
 - FiveRuns Development Team
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-19 00:00:00 -07:00
+date: 2009-03-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,7 +32,6 @@ files:
 - lib/fiveruns/dash/host.rb
 - lib/fiveruns/dash/instrument.rb
 - lib/fiveruns/dash/metric.rb
-- lib/fiveruns/dash/read
 - lib/fiveruns/dash/recipe.rb
 - lib/fiveruns/dash/reporter.rb
 - lib/fiveruns/dash/scm.rb