flail 0.0.7 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flail (0.0.6)
+    flail (0.0.7)
 
 GEM
   remote: http://rubygems.org/

data/lib/flail/backtrace.rb

@@ -0,0 +1,122 @@
+class Flail
+  # Front end to parsing the backtrace for each notice
+  class Backtrace
+
+    DEFAULT_FILTERS = [
+      lambda { |line| line.gsub(/^\.\//, "") },
+      lambda { |line|
+        if defined?(Gem)
+          Gem.path.inject(line) do |line, path|
+            line.gsub(/#{path}/, "[GEM_ROOT]")
+          end
+        end
+      },
+      lambda { |line| line if line !~ %r{lib/flail} }
+    ].freeze
+
+    # Handles backtrace parsing line by line
+    class Line
+
+      # regexp (optionnally allowing leading X: for windows support)
+      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze # `
+
+      # The file portion of the line (such as app/models/user.rb)
+      attr_reader :file
+
+      # The line number portion of the line
+      attr_reader :number
+
+      # The method of the line (such as index)
+      attr_reader :method
+
+      # Parses a single line of a given backtrace
+      # @param [String] unparsed_line The raw line from +caller+ or some backtrace
+      # @return [Line] The parsed backtrace line
+      def self.parse(unparsed_line)
+        _, file, number, method = unparsed_line.match(INPUT_FORMAT).to_a
+        new(file, number, method)
+      end
+
+      def initialize(file, number, method)
+        self.file   = file
+        self.number = number
+        self.method = method
+      end
+
+      # Reconstructs the line in a readable fashion
+      def to_s
+        "#{file}:#{number}:in `#{method}'"
+      end
+
+      def ==(other)
+        to_s == other.to_s
+      end
+
+      def inspect
+        "<Line:#{to_s}>"
+      end
+
+      private
+
+      attr_writer :file, :number, :method
+    end
+
+    # holder for an Array of Backtrace::Line instances
+    attr_reader :lines
+
+    def self.parse(ruby_backtrace, opts = {})
+      ruby_lines = split_multiline_backtrace(ruby_backtrace)
+
+      filters = opts[:filters] || []
+      filtered_lines = ruby_lines.to_a.map do |line|
+        filters.inject(line) do |line, proc|
+          proc.call(line)
+        end
+      end.compact
+
+      lines = filtered_lines.collect do |unparsed_line|
+        Line.parse(unparsed_line)
+      end
+
+      instance = new(lines)
+    end
+
+    def initialize(lines)
+      self.lines = lines
+    end
+
+    def inspect
+      "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
+    end
+
+    def ==(other)
+      if other.respond_to?(:lines)
+        lines == other.lines
+      else
+        false
+      end
+    end
+
+    def to_ary
+      lines.inject([]) do |collector, line|
+        collector << {
+          :number => line.number,
+          :file => line.file,
+          :method => line.method
+        }
+      end
+    end
+
+    private
+
+    attr_writer :lines
+
+    def self.split_multiline_backtrace(backtrace)
+      if backtrace.to_a.size == 1
+        backtrace.to_a.first.split(/\n\s*/)
+      else
+        backtrace
+      end
+    end
+  end
+end

data/lib/flail/exception.rb

@@ -42,12 +42,26 @@ class Flail
           clean_unserializable_data(value, stack + [data.object_id])
         end
       else
-        data.to_s
+        input = if ''.respond_to?(:encode)
+                  data.to_s.encode(Encoding::UTF_8, :undef => :replace)
+                else
+                  require 'iconv'
+                  ic = Iconv.new("UTF-8//IGNORE", "UTF-8")
+                  ic.iconv(data.to_s + ' ')[0..-2]
+                end
+        begin
+          input.to_json
+        rescue Exception => e
+          input = "redundant utf-8 sequence"
+        end
+
+        input
       end
     end
 
     def clean_rack_env(data)
       data.delete("rack.request.form_vars")
+      data.delete("rack.input")
       data
     end
 
@@ -64,16 +78,18 @@ class Flail
                      info = {}
 
                      # rack env
-                     info[:rack]        = clean_rack_env(clean_unserializable_data(@env))
+                     info[:rack]        = clean_unserializable_data(clean_rack_env(@env))
 
-                     info[:class_name]  = @exception.class.to_s             # @exception class
+                     info[:class_name]  = @exception.class.name             # @exception class
                      info[:message]     = @exception.to_s                   # error message
-                     info[:trace]       = @exception.backtrace              # backtrace of error
                      info[:target_url]  = request_data[:target_url]         # url of request
                      info[:referer_url] = request_data[:referer_url]        # referer
                      info[:user_agent]  = request_data[:user_agent]         # user agent
                      info[:user]        = request_data[:user]               # current user
 
+                     # backtrace of error
+                     info[:trace]       = Flail::Backtrace.parse(@exception.backtrace, :filters => Flail::Backtrace::DEFAULT_FILTERS).to_ary
+
                      # request parameters
                      info[:parameters]  = clean_unserializable_data(request_data[:parameters])
 
@@ -83,7 +99,7 @@ class Flail
                      # special variables
                      info[:environment] = Flail.configuration.env
                      info[:hostname]    = Flail.configuration.hostname
-                     info[:tag]    = Flail.configuration.tag
+                     info[:tag]         = Flail.configuration.tag
 
                      info
                    end

data/lib/flail/version.rb

@@ -1,3 +1,3 @@
 class Flail
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/flail.rb

@@ -4,6 +4,7 @@ require 'socket'
 
 require 'flail/base'
 require 'flail/configuration'
+require 'flail/backtrace'
 require 'flail/exception'
 require 'flail/rack'
 

data/spec/backtrace_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+require 'flail/backtrace'
+
+describe Flail::Backtrace do
+
+  SAMPLE_BACKTRACE = [
+                      "app/models/user.rb:13:in `magic'",
+                      "app/controllers/users_controller.rb:8:in `index'"
+                     ]
+
+
+  it "should parse a backtrace into lines" do
+    backtrace = Flail::Backtrace.parse(SAMPLE_BACKTRACE)
+
+    line = backtrace.lines.first
+    line.number.should == '13'
+    line.file.should == 'app/models/user.rb'
+    line.method.should == 'magic'
+
+    line = backtrace.lines.last
+    line.number.should == '8'
+    line.file.should == 'app/controllers/users_controller.rb'
+    line.method.should == 'index'
+  end
+
+
+  it "should parse a windows backtrace into lines" do
+    array = [
+      "C:/Program Files/Server/app/models/user.rb:13:in `magic'",
+      "C:/Program Files/Server/app/controllers/users_controller.rb:8:in `index'"
+    ]
+
+    backtrace = Flail::Backtrace.parse(array)
+
+    line = backtrace.lines.first
+    line.number.should == '13'
+    line.file.should == 'C:/Program Files/Server/app/models/user.rb'
+    line.method.should == 'magic'
+
+    line = backtrace.lines.last
+    line.number.should == '8'
+    line.file.should == 'C:/Program Files/Server/app/controllers/users_controller.rb'
+    line.method.should == 'index'
+  end
+
+  it "should be equal with equal lines" do
+    one = SAMPLE_BACKTRACE
+    two = one.dup
+
+    Flail::Backtrace.parse(one).should == Flail::Backtrace.parse(two)
+  end
+
+  it "should parse massive one-line exceptions into multiple lines" do
+    original_backtrace = Flail::Backtrace.parse(["one:1:in `one'\n   two:2:in `two'\n      three:3:in `three`"])
+    expected_backtrace = Flail::Backtrace.parse(["one:1:in `one'", "two:2:in `two'", "three:3:in `three`"])
+
+    expected_backtrace.should == original_backtrace
+  end
+
+  it "should remove notifier trace" do
+    inside_notifier  = ['lib/flail/exception.rb:13:in `voodoo`']
+    outside_notifier = ['users_controller:8:in `index`']
+
+    without_inside = Flail::Backtrace.parse(outside_notifier)
+    with_inside    = Flail::Backtrace.parse(inside_notifier + outside_notifier,
+                                            :filters => Flail::Backtrace::DEFAULT_FILTERS)
+
+    without_inside.should == with_inside
+  end
+
+  it "should run filters on the backtrace" do
+    filters = [lambda { |line| line.sub('foo', 'bar') }]
+
+    input = Flail::Backtrace.parse(["foo:13:in `one'",
+                                    "baz:14:in `two'"
+                                   ], :filters => filters)
+
+    expected = Flail::Backtrace.parse(["bar:13:in `one'",
+                                       "baz:14:in `two'"
+                                      ])
+
+    expected.should == input
+  end
+end

data/spec/exception_spec.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+require 'ostruct'
+require 'flail/backtrace'
+require 'flail/exception'
+
+describe Flail::Exception do
+
+  subject { Flail::Exception.new({}, Exception.new) }
+  SAMPLE_BACKTRACE = [
+                      "app/models/user.rb:13:in `magic'",
+                      "app/controllers/users_controller.rb:8:in `index'"
+                     ]
+
+  it "should not choke on bad utf-8" do
+    b1r = 0xc0..0xc2
+    b2r = 0x80..0xbf
+    b1r.each do |b1|
+      b2r.each do |b2|
+        string = [b1,b2].pack("C*")
+
+        lambda { subject.clean_unserializable_data({:test => string}).to_json }.should_not raise_error
+      end
+    end
+  end
+end

data/spec/rescue_action_spec.rb

@@ -49,5 +49,39 @@ describe Flail::Rails::RescueAction do
 
       FlailArmory.payload['user'].should == {'id' => 1, 'login' => 'jlong'}
     end
+
+    it "should call session.to_hash if available" do
+      hash_data = {:key => :value}
+
+      session = ActionController::TestSession.new
+      stub(ActionController::TestSession).new { session }
+      stub(session).to_hash { hash_data }
+
+      FlailArmory.process_action_with_error
+
+      session.should have_received.to_hash
+      session.should_not have_received.data
+      FlailArmory.payload.should_not be_nil
+    end
+
+    it "should call session.to_hash if available" do
+      hash_data = {:key => :value}
+
+      session = ActionController::TestSession.new
+      stub(ActionController::TestSession).new { session }
+      stub(session).data { hash_data }
+
+      if session.respond_to?(:to_hash)
+        class << session
+          undef :to_hash
+        end
+      end
+
+      FlailArmory.process_action_with_error
+
+      session.should_not have_received.to_hash
+      session.should have_received.data
+      FlailArmory.payload.should_not be_nil
+    end
   end
 end

data/spec/spec_helper.rb

@@ -20,6 +20,9 @@ require 'flail'
 require 'flail/rails/controller_methods'
 require 'flail/rails/rescue_action'
 
+
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].map {|file| require(file)}
+
 class FlailArmory
 
   module ClassMethods

data/spec/support/rr.rb

@@ -0,0 +1,42 @@
+# --- add this as spec/support/rr.rb ---
+
+# RR doesn't have support for RSpec 2.
+#
+# Source: <https://github.com/btakita/rr/issues#issue/45>
+
+require 'rr'
+
+module RR
+  module Adapters
+    module RSpec2
+      include RRMethods
+
+      def setup_mocks_for_rspec
+        RR.reset
+      end
+      def verify_mocks_for_rspec
+        RR.verify
+      end
+      def teardown_mocks_for_rspec
+        RR.reset
+      end
+
+      def have_received(method = nil)
+        RR::Adapters::Rspec::InvocationMatcher.new(method)
+      end
+    end
+  end
+end
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+      include RR::Adapters::RSpec2
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.mock_framework = RSpec::Core::MockFrameworkAdapter
+  config.backtrace_clean_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flail
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -157,6 +157,7 @@ files:
 - Rakefile
 - flail.gemspec
 - lib/flail.rb
+- lib/flail/backtrace.rb
 - lib/flail/base.rb
 - lib/flail/configuration.rb
 - lib/flail/exception.rb
@@ -168,9 +169,12 @@ files:
 - lib/flail/railtie.rb
 - lib/flail/version.rb
 - rails/init.rb
+- spec/backtrace_spec.rb
 - spec/base_spec.rb
+- spec/exception_spec.rb
 - spec/rescue_action_spec.rb
 - spec/spec_helper.rb
+- spec/support/rr.rb
 homepage: https://github.com/asceth/flail
 licenses: []
 post_install_message: 
@@ -196,6 +200,9 @@ signing_key:
 specification_version: 3
 summary: Rails exception handler
 test_files:
+- spec/backtrace_spec.rb
 - spec/base_spec.rb
+- spec/exception_spec.rb
 - spec/rescue_action_spec.rb
 - spec/spec_helper.rb
+- spec/support/rr.rb