coaster 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e42c64476dc3536ab28c684c29502752c78fc7
-  data.tar.gz: a475bf582422996c60cc6637351a2d8dd94549d2
+  metadata.gz: cf1f98ccd896c61cd25584533b7895e027599525
+  data.tar.gz: f2ce5af045ad7c1c75511cb01b96c5b0153ab800
 SHA512:
-  metadata.gz: 5e55f6702cfe92f287b2b8c22da4175d987411f684b34b737cc84b36b92307e313b9fe3d015b5e4957296054c61a7eb9ffe786cdd09b9c400cdbc92cc2302a85
-  data.tar.gz: fd7b2ee0ac10cac922407537ec667cf9ff5a6388dd778e0c3e576af43c4e7b31d7738a10c7bfe1c9723458a14feccd6116a60052d65d4b81558b9a060dcd697c
+  metadata.gz: 2af452b0fcd5316cd5da74cbcbaf37cd46a5ee4cd32e938dc5f910aa89a7bcdbaa017a0245a2dbb5d56a5348cfeecf95e35c28d96fcdc0a0e532c336ef1cba92
+  data.tar.gz: 0b5b7d294968de6501437e3763fff5301caae53b18d45cfc916956e60b5720590ff388681abc06131659014a189afa2bccbcb811162bd610c98a1e65399a63e4

data/lib/coaster/backtrace_cleaner.rb

@@ -0,0 +1,78 @@
+class Coaster::BacktraceCleaner
+  attr_accessor :least
+
+  def initialize
+    @filters, @silencers = [], []
+    @least = 10
+  end
+
+  # Returns the backtrace after all filters and silencers have been run
+  # against it. Filters run first, then silencers.
+  def clean(backtrace, kind = :silent)
+    filtered = filter_backtrace(backtrace)
+
+    case kind
+    when :silent
+      silence(filtered)
+    when :noise
+      noise(filtered)
+    else
+      filtered
+    end
+  end
+  alias :filter :clean
+
+  # Adds a filter from the block provided. Each line in the backtrace will be
+  # mapped against this filter.
+  #
+  #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+  #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+  def add_filter(&block)
+    @filters << block
+  end
+
+  # Adds a silencer from the block provided. If the silencer returns +true+
+  # for a given line, it will be excluded from the clean backtrace.
+  #
+  #   # Will reject all lines that include the word "mongrel", like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
+  #   backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
+  def add_silencer(&block)
+    @silencers << block
+  end
+
+  # Removes all silencers, but leaves in the filters. Useful if your
+  # context of debugging suddenly expands as you suspect a bug in one of
+  # the libraries you use.
+  def remove_silencers!
+    @silencers = []
+  end
+
+  # Removes all filters, but leaves in the silencers. Useful if you suddenly
+  # need to see entire filepaths in the backtrace that you had already
+  # filtered out.
+  def remove_filters!
+    @filters = []
+  end
+
+  private
+    def filter_backtrace(backtrace)
+      @filters.each do |f|
+        backtrace = backtrace.map { |line| f.call(line) }
+      end
+
+      backtrace
+    end
+
+    def silence(backtrace)
+      least_bt = backtrace.shift(least)
+      @silencers.each do |s|
+        backtrace = backtrace.reject { |line| s.call(line) }
+      end
+
+      least_bt + backtrace
+    end
+
+    def noise(backtrace)
+      backtrace - silence(backtrace)
+    end
+end

data/lib/coaster/core_ext/standard_error.rb

@@ -1,7 +1,7 @@
 require 'coaster/core_ext/object_translation'
 
 class StandardError
-  cattr_accessor :cleaner
+  cattr_accessor :cleaner, :cause_cleaner
 
   class << self
     def status
@@ -51,20 +51,23 @@ class StandardError
         @tkey = hash.delete(:tkey)
         msg = cause.message if msg.nil? && cause
         @attributes.merge!(hash)
-      when String, NilClass then
+      when String then
         msg = message
-      when FalseClass then
-        msg = false
+      when FalseClass, NilClass then
+        msg = ''
       else
-        msg = message
+        msg = message.class.name
         @attributes[:object] = message
     end
 
     @fingerprint = [] unless @fingerprint.is_a?(Array)
     @tags = {} unless @tags.is_a?(Hash)
-    msg = nil if msg == false
+    msg ||= ''
     super(msg)
-    set_backtrace(cause.backtrace) if cause
+  end
+
+  def safe_message
+    message || ''
   end
 
   def status
@@ -98,7 +101,7 @@ class StandardError
   def description
     dsc = attributes[:description] || attributes[:desc]
     return dsc if dsc
-    msg = message.dup
+    msg = safe_message.dup
     msg.instance_variable_set(:@raw, true)
     msg
   end
@@ -141,7 +144,7 @@ class StandardError
 
   def to_detail
     lg = "[#{self.class.name}] status:#{status}"
-    lg += "\n\tMESSAGE: #{message.gsub(/\n/, "\n\t\t")}"
+    lg += "\n\tMESSAGE: #{safe_message.gsub(/\n/, "\n\t\t")}"
     instance_variables.each do |var|
       if var.to_s.start_with?('@_')
         next
@@ -160,6 +163,9 @@ class StandardError
       else
         lg += "\n\tCAUSE: #{cause.class.name}: #{cause.message.gsub(/\n/, "\n\t\t")}"
       end
+      if cause_cleaner && cause.backtrace
+        lg += cause_cleaner.clean(cause.backtrace).join("\n\t\t")
+      end
     end
     lg << "\n"
   end
@@ -185,8 +191,8 @@ class StandardError
     msg = to_detail
 
     if cl && backtrace
-      msg += "\t\t"
-      msg += cleaner.clean(backtrace).join("\n\t\t")
+      msg += "\tBACKTRACE:\n\t"
+      msg += cl.clean(backtrace).join("\n\t")
     end
 
     logger.tagged(*rails_tag) do

data/lib/coaster/version.rb

@@ -1,3 +1,3 @@
 module Coaster
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

data/lib/coaster.rb

@@ -22,3 +22,4 @@ module Coaster
 end
 
 require 'coaster/core_ext'
+require 'coaster/backtrace_cleaner'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coaster
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - buzz jung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -186,6 +186,7 @@ files:
 - README.md
 - Rakefile
 - lib/coaster.rb
+- lib/coaster/backtrace_cleaner.rb
 - lib/coaster/core_ext.rb
 - lib/coaster/core_ext/object_translation.rb
 - lib/coaster/core_ext/standard_error.rb