safely 0.2.0 → 0.3.0

data/CHANGES

@@ -1,4 +1,12 @@
-0.1 (WIP)
+0.3 2011-05-07
+
+* Backtrace catcher support
+
+0.2 2011-05-07
+
+* Log support
+
+0.1 2011-05-07
 
 * Initial hoptoad support
 * Initial email support

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Safely is a simple exception handling and alerting mechanism extract from the daemon-kit[https://github.com/kennethkalmer/daemon-kit] project.
 
-Safely currently supports error reporting to Hoptoad, or via email.
+Safely currently supports error reporting to Hoptoad, or via email. Safely can also log all exceptions to a file when a program exited abnormally, shedding light on what caused the failures.
 
 == Installation and Usage
 

data/lib/safely.rb

@@ -2,11 +2,12 @@ $:.unshift File.expand_path('../', __FILE__)
 
 module Safely
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
-  autoload :Config,   'safely/config'
-  autoload :Mixin,    'safely/mixin'
-  autoload :Strategy, 'safely/strategy'
+  autoload :Backtrace, 'safely/backtrace'
+  autoload :Config,    'safely/config'
+  autoload :Mixin,     'safely/mixin'
+  autoload :Strategy,  'safely/strategy'
 
   class << self
 

data/lib/safely/backtrace.rb

@@ -0,0 +1,48 @@
+module Safely
+  class Backtrace
+    
+    class << self
+
+      attr_accessor :trace_directory
+
+      def enable!
+        @enabled = true
+        at_exit { log_exceptions }
+      end
+
+      def safe_shutdown!
+        @enabled = false
+      end
+
+      def log_exceptions
+        return unless @enabled && self.trace_directory && File.directory?( self.trace_directory )
+
+        require 'logger'
+
+        trace_file = File.join( self.trace_directory, "backtrace-#{Time.now.strftime('%Y%m%d%H%M%S')}-#{Process.pid}.log" )
+        trace_log = Logger.new( trace_file )
+
+        # Find the last exception
+        e = nil
+        ObjectSpace.each_object {|o|
+          if ::Exception === o
+            e = o
+          end
+        }
+
+        trace_log.info "*** Below you'll find the most recent exception thrown, this will likely (but not certainly) be the exception that made #{DaemonKit.configuration.daemon_name} exit abnormally ***"
+        trace_log.error e
+
+        trace_log.info "*** Below you'll find all the exception objects in memory, some of them may have been thrown in your application, others may just be in memory because they are standard exceptions ***"
+        ObjectSpace.each_object {|o|
+          if ::Exception === o
+            trace_log.error o
+          end
+        }
+
+        trace_log.close
+      end
+    end
+
+  end
+end

data/safely.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{safely}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenneth Kalmer"]
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/safely.rb",
+    "lib/safely/backtrace.rb",
     "lib/safely/config.rb",
     "lib/safely/mixin.rb",
     "lib/safely/strategy.rb",
@@ -34,6 +35,9 @@ Gem::Specification.new do |s|
     "lib/safely/strategy/log.rb",
     "lib/safely/strategy/mail.rb",
     "safely.gemspec",
+    "spec/backtrace/safe.rb",
+    "spec/backtrace/unsafe.rb",
+    "spec/backtrace_spec.rb",
     "spec/config_spec.rb",
     "spec/safely_spec.rb",
     "spec/spec_helper.rb",
@@ -48,6 +52,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.7.2}
   s.summary = %q{Safely run your code, keep track of exceptions}
   s.test_files = [
+    "spec/backtrace/safe.rb",
+    "spec/backtrace/unsafe.rb",
+    "spec/backtrace_spec.rb",
     "spec/config_spec.rb",
     "spec/safely_spec.rb",
     "spec/spec_helper.rb",

data/spec/backtrace/safe.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'safely'
+
+Safely::Backtrace.trace_directory = File.expand_path('../tmp', __FILE__)
+Safely::Backtrace.enable!
+
+safely do
+  raise "Oops :/"
+end
+
+Safely::Backtrace.safe_shutdown!

data/spec/backtrace/unsafe.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'safely'
+
+Safely::Backtrace.trace_directory = File.expand_path('../tmp', __FILE__)
+Safely::Backtrace.enable!
+
+raise "Oops :/"

data/spec/backtrace_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe Safely::Backtrace do
+  before(:each) do
+    @temp_dir = File.expand_path('../backtrace/tmp', __FILE__)
+
+    FileUtils.rm_rf( @temp_dir )
+    FileUtils.mkdir_p( @temp_dir )
+  end
+
+  it "can be configured" do
+    Safely::Backtrace.should respond_to(:trace_directory)
+  end
+
+  it "can be enabled" do
+    Safely::Backtrace.enable!
+  end
+
+  it "should log a backtrace on unsafe shutdown" do
+    `ruby #{File.expand_path('../backtrace/unsafe.rb', __FILE__)}`
+
+    entries = Dir["#{@temp_dir}/backtrace-*.log"]
+    entries.should_not be_empty
+  end
+
+  it "should not log a backtrace on a safe shutdown" do
+    `ruby #{File.expand_path('../backtrace/safe.rb', __FILE__)}`
+
+    entries = Dir["#{@temp_dir}/backtrace-*.log"]
+    entries.should be_empty
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: safely
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -120,6 +120,7 @@ files:
 - Rakefile
 - VERSION
 - lib/safely.rb
+- lib/safely/backtrace.rb
 - lib/safely/config.rb
 - lib/safely/mixin.rb
 - lib/safely/strategy.rb
@@ -127,6 +128,9 @@ files:
 - lib/safely/strategy/log.rb
 - lib/safely/strategy/mail.rb
 - safely.gemspec
+- spec/backtrace/safe.rb
+- spec/backtrace/unsafe.rb
+- spec/backtrace_spec.rb
 - spec/config_spec.rb
 - spec/safely_spec.rb
 - spec/spec_helper.rb
@@ -147,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2463736658289113276
+      hash: -1107195766842142569
       segments: 
       - 0
       version: "0"
@@ -165,6 +169,9 @@ signing_key:
 specification_version: 3
 summary: Safely run your code, keep track of exceptions
 test_files: 
+- spec/backtrace/safe.rb
+- spec/backtrace/unsafe.rb
+- spec/backtrace_spec.rb
 - spec/config_spec.rb
 - spec/safely_spec.rb
 - spec/spec_helper.rb