tartarus 1.0.0 → 1.0.1

data/README.rdoc

@@ -16,8 +16,8 @@ dependencies are used:
 
 === Installation
 
-1. Install the gem:
-     [sudo] gem install tartarus
+1. Install the gem from:
+     [sudo] gem install tartarus --source=http://gemcutter.org
 2. Add the exceptional gem dependency to your enviroment.rb:
      config.gem "tartarus"
 3. Run the generator from the root of your Rails application:
@@ -27,7 +27,6 @@ dependencies are used:
 5. Add the javascript and stylesheet includes in your layout:
      <script type="text/javascript" src="/javascripts/tartarus.jquery.js"></script>
      <link href="/stylesheets/tartarus.css" media="all" rel="stylesheet" type="text/css" />
-6. View the generated 'config/exceptions.yml' file and make sure the default options are correct.
 
 === License
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/generators/tartarus/tartarus_generator.rb

@@ -46,6 +46,5 @@ class TartarusGenerator < Rails::Generator::NamedBase
     puts "\nIn order for exceptional to function properly, you'll need to complete the following steps to complete the installation process: \n\n"
     puts "  1) Run 'rake db:migrate' to generate the logging table for your model.\n"
     puts "  2) Add '/javascripts/tartarus.jquery.js', and 'stylesheets/tartarus.css' to your applications layout.\n"
-    puts "  3) View 'config/exceptions.yml' and make sure the default options are correct.\n\n"
   end
 end

data/generators/tartarus/templates/config/exceptions.yml

@@ -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 %> 

data/generators/tartarus/templates/public/javascripts/tartarus.jquery.js

@@ -1,6 +1,8 @@
-$(function(){
-  $('.togglable').each(function() {
-    var toggle_data = $(this).find('.toggle_data');
-    $(this).find('.toggle_link').click(function() { toggle_data.toggle(); })
+(function($) {
+  $(function() {
+    $('.togglable').each(function() {
+      var toggle_data = $(this).find('.toggle_data');
+      $(this).find('.toggle_link').click(function() { toggle_data.toggle(); })
+    });
   });
-});
+})(jQuery);

data/generators/tartarus/templates/public/stylesheets/tartarus.css

@@ -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; }

data/lib/tartarus/logger.rb

@@ -20,23 +20,20 @@ module Tartarus::Logger
     end
 
     def normalize_request_data(request)
+      enviroment = request.env.dup
+
       request_details = {
-        :enviroment => {},
+        :enviroment => { :process => $$, :server => `hostname -s`.chomp },
+        :session => { :variables => enviroment['rack.session'].to_hash, :cookie => enviroment['rack.request.cookie_hash'] },
         :http_details => { 
           :method => request.method.to_s.upcase,
           :url => "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.request_uri}",
           :format => request.format.to_s,
           :parameters => request.parameters
-        },
-
-        :session => {
-          :variables => request.env['rack.session'],
-          :options => request.env['rack.session.options'],
-          :cookie => request.env['rack.request.cookie_hash']
         }
       }
 
-      request.env.each_pair do |key, value|
+      enviroment.each_pair do |key, value|
         request_details[:enviroment][key.downcase] = value if key.match(/^[A-Z_]*$/)
       end
 

data/lib/tartarus/rescue.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
 

data/lib/tartarus.rb

@@ -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'

data/spec/tartarus/logger_spec.rb

@@ -42,12 +42,13 @@ describe Tartarus::Logger do
     
     it 'should have a enviroment hash that contains a hash of only the uppercase keys of the original controller request hash' do
       @request_data[:enviroment].should_not be_blank
-      @request_data[:enviroment].should == { "http_host" => "test_host", "loooooooong_key_two" => "key_two_value", "key_one" => "key_one_value"}
+      @request_data[:enviroment].should == { "http_host" => "test_host", "loooooooong_key_two" => "key_two_value", "key_one" => "key_one_value", :server => `hostname -s`.chomp, :process => $$ }
     end
 
     it 'should have a session hash' do
       @request_data[:session].should_not be_blank
-      @request_data[:session].should == { :cookie => {}, :options => {}, :variables => { :id=>"123123" } }
+      @request_data[:session].should be_an_instance_of(Hash)
+      @request_data[:session].should == { :cookie => {}, :variables => { :id=>"123123" } }
     end
 
     it 'should have a http details hash' do

data/spec/tartarus/rescue_spec.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)

data/spec/tartarus_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

data/tartarus.gemspec

@@ -0,0 +1,113 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tartarus}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Insley"]
+  s.date = %q{2009-11-24}
+  s.description = %q{Provides exception logging and a generator for creating a clean interface to manage exceptions.}
+  s.email = %q{dinsley@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/tartarus/USAGE",
+     "generators/tartarus/tartarus_generator.rb",
+     "generators/tartarus/templates/app/controllers/exceptions_controller.rb",
+     "generators/tartarus/templates/app/models/logged_exception.rb",
+     "generators/tartarus/templates/app/views/exceptions/_exception.html.erb",
+     "generators/tartarus/templates/app/views/exceptions/details.html.erb",
+     "generators/tartarus/templates/app/views/exceptions/index.html.erb",
+     "generators/tartarus/templates/config/exceptions.yml",
+     "generators/tartarus/templates/db/migrate/add_logged_exceptions.rb",
+     "generators/tartarus/templates/public/javascripts/tartarus.jquery.js",
+     "generators/tartarus/templates/public/stylesheets/tartarus.css",
+     "generators/tartarus/templates/spec/controllers/exceptions_controller_spec.rb",
+     "generators/tartarus/templates/spec/models/logged_exception_spec.rb",
+     "lib/tartarus.rb",
+     "lib/tartarus/logger.rb",
+     "lib/tartarus/rescue.rb",
+     "rails/init.rb",
+     "spec/rails/app/controllers/application_controller.rb",
+     "spec/rails/app/models/logged_exception.rb",
+     "spec/rails/config/boot.rb",
+     "spec/rails/config/database.yml",
+     "spec/rails/config/environment.rb",
+     "spec/rails/config/environments/development.rb",
+     "spec/rails/config/environments/production.rb",
+     "spec/rails/config/environments/test.rb",
+     "spec/rails/config/exceptions.yml",
+     "spec/rails/config/initializers/backtrace_silencers.rb",
+     "spec/rails/config/initializers/inflections.rb",
+     "spec/rails/config/initializers/mime_types.rb",
+     "spec/rails/config/initializers/new_rails_defaults.rb",
+     "spec/rails/config/initializers/session_store.rb",
+     "spec/rails/config/locales/en.yml",
+     "spec/rails/config/routes.rb",
+     "spec/rails/db/test.sqlite3",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/tartarus/logger_spec.rb",
+     "spec/tartarus/rescue_spec.rb",
+     "spec/tartarus_spec.rb",
+     "tartarus.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dinsley/tartarus}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Exception Logging for Rails}
+  s.test_files = [
+    "spec/rails/app/controllers/application_controller.rb",
+     "spec/rails/app/models/logged_exception.rb",
+     "spec/rails/config/boot.rb",
+     "spec/rails/config/environment.rb",
+     "spec/rails/config/environments/development.rb",
+     "spec/rails/config/environments/production.rb",
+     "spec/rails/config/environments/test.rb",
+     "spec/rails/config/initializers/backtrace_silencers.rb",
+     "spec/rails/config/initializers/inflections.rb",
+     "spec/rails/config/initializers/mime_types.rb",
+     "spec/rails/config/initializers/new_rails_defaults.rb",
+     "spec/rails/config/initializers/session_store.rb",
+     "spec/rails/config/routes.rb",
+     "spec/spec_helper.rb",
+     "spec/tartarus/logger_spec.rb",
+     "spec/tartarus/rescue_spec.rb",
+     "spec/tartarus_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+      s.add_development_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+    else
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tartarus
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Daniel Insley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-21 00:00:00 -07:00
+date: 2009-11-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,7 @@ files:
 - spec/tartarus/logger_spec.rb
 - spec/tartarus/rescue_spec.rb
 - spec/tartarus_spec.rb
+- tartarus.gemspec
 has_rdoc: true
 homepage: http://github.com/dinsley/tartarus
 licenses: []