@@ -1,9 +1,9 @@ development: - enabled: false + logging_enabled: true logger_class: <%= class_name %> test: - enabled: false + logging_enabled: false logger_class: <%= class_name %> production: - enabled: true + logging_enabled: true logger_class: <%= class_name %> generators/tartarus/templates/config/exceptions.yml @@ -22,5 +22,5 @@ #tartarus #exception { clear: both; } #tartarus #exception_actions { float: right; } -.toggle_data { display: none } -#backtrace_information .toggle_data { display: block; } +#tartarus .toggle_data { display: none } +#tartarus #backtrace_information .toggle_data { display: block; } generators/tartarus/templates/public/stylesheets/tartarus.css @@ -10,12 +10,15 @@ class Tartarus def logger_class configuration['logger_class'].constantize end + + def logging_enabled? + configuration['logging_enabled'] == true + end def log(controller, exception) logger_class.log(controller, exception) end end - end require 'tartarus/logger' lib/tartarus.rb @@ -6,7 +6,9 @@ module Tartarus::Rescue end def rescue_action_with_tartarus(exception) - if response_code_for_rescue(exception) == :internal_server_error + is_exception = response_code_for_rescue(exception) == :internal_server_error + + if is_exception and Tartarus.logging_enabled? Tartarus.log(self, exception) end lib/tartarus/rescue.rb @@ -20,6 +20,7 @@ describe Tartarus::Rescue do @exception = StandardError.new @controller.stub!(:rescue_action_without_tartarus) @controller.stub!(:response_code_for_rescue).and_return(:internal_server_error) + Tartarus.stub!(:logging_enabled?).and_return(true) Tartarus.stub!(:log) end @@ -34,6 +35,18 @@ describe Tartarus::Rescue do @controller.rescue_action_with_tartarus(@exception) end + it 'should log the exception with tartarus if exception logging is enabled' do + Tartarus.should_receive(:logging_enabled?).and_return(true) + @controller.rescue_action_with_tartarus(@exception) + end + + it 'should not log the exception with tartarus if exception logging is disabled' do + Tartarus.should_receive(:logging_enabled?).and_return(false) + Tartarus.should_receive(:log).never + + @controller.rescue_action_with_tartarus(@exception) + end + it 'should invoke rescue_action_without_tartarus' do @controller.should_receive(:rescue_action_without_tartarus) @controller.rescue_action_with_tartarus(@exception) spec/tartarus/rescue_spec.rb @@ -11,6 +11,19 @@ describe Tartarus do Tartarus.logger_class.should == LoggedException end end + + describe "#logging_enabled?" do + it 'should return false if logging is not enabled in the configuration' do + Tartarus.should_receive(:configuration).and_return({ 'logging_enabled' => false }) + Tartarus.logging_enabled?.should be_false + end + + it 'should return true if logging is enabled in the configuration' do + Tartarus.should_receive(:configuration).and_return({ 'logging_enabled' => true }) + Tartarus.logging_enabled?.should be_true + end + end + describe "#log" do before(:each) do @@ -32,7 +45,7 @@ describe Tartarus do describe "#configuration" do before(:each) do - YAML.stub!(:load_file).and_return({'development' => { 'enabled' => true }, 'test' => { 'enabled' => false } }) + YAML.stub!(:load_file).and_return({ 'development' => { 'enabled' => true }, 'test' => { 'enabled' => false } }) end it 'should parse the YAML configuration file for exceptional' do spec/tartarus_spec.rb 370e7f068ead1f4d1d9d28fcaa82c5b52ede9600 Daniel Insley dan@viviti.com http://github.com/dinsley/tartarus/commit/b5dfc9c012ea03e176421b0f2bbda6dd801966b6 b5dfc9c012ea03e176421b0f2bbda6dd801966b6 2009-10-22T13:01:05-07:00 2009-10-22T13:01:05-07:00 logging_enabled is configuration is now loaded to see if logging should occur or not dcaa39d3e774c26a49fb7d01b821eeccae2297cf Daniel Insley dan@viviti.com