pretty_trace 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01f4109d20baa996682e6f71ce0ea1b03d7d95ac
-  data.tar.gz: ecb6f5346c533dc4915df2abe151c098423627da
+  metadata.gz: e47618bf9096072c8371be60df52dd3fe429a184
+  data.tar.gz: 8f3b516b840401db8c357a3d0ba953bee0340efa
 SHA512:
-  metadata.gz: 0a4c2476428a4a7e4a29d6fcc183c0159fe5b51aed461a15a207394b6fac1cad2124a648be183e24fb4dd819272c7a8cd988e3ae63d945cc943a8d2cc10e88b4
-  data.tar.gz: cb7c2888add66b808803af25b5b52c5ee37e51a87149df709757c5e90c56e204c302c64cea6a55ee18d1cb334e6802c417c04446f0a758b962954aaa0f08b979
+  metadata.gz: b68ad25758b5553c56d9378f33bdfb0fe80ab0fc10e3c90092145a9bc134276169da802b6855bb8de5ac93a834e352e7060bd53c90e1fb3c51e50a0cda1cbfa7
+  data.tar.gz: 7a9315f338a691b7e61d8e1e55288942571ad1c8f8dd086799984ed69239d3ef2f738864a1785508c4898030d211f966c391013451303e481628e71f992ed037

data/README.md

@@ -24,13 +24,13 @@ Or with bundler:
 
 ```
 # Just install, do not activate
-$ gem 'pretty_trace'
+gem 'pretty_trace'
 
-# Install and enable
-$ gem 'pretty_trace', require: 'pretty_trace/enable'
+# Or, install and enable
+gem 'pretty_trace', require: 'pretty_trace/enable'
 
-# Install, enable and enable trimming
-$ gem 'pretty_trace', require: 'pretty_trace/enable-trim'
+# Or, install, enable and enable trimming
+gem 'pretty_trace', require: 'pretty_trace/enable-trim'
 ```
 
 Example
@@ -69,7 +69,7 @@ last line), require this script instead:
 require 'pretty_trace/enable-trim'
 ```
 
-If you prefer to have more control,you can use configure these settings 
+If you prefer to have more control, you can use configure these settings 
 manually:
 
 ```ruby

data/lib/pretty_trace/backtrace_item.rb

@@ -0,0 +1,34 @@
+module PrettyTrace
+  class BacktraceItem
+    include Colors
+
+    attr_reader :original_line, :path, :file, :line, :dir, :method, :full_dir
+
+    def initialize(original_line)
+      @original_line = original_line
+      @path, @file, @line, @dir, @full_dir = nil, nil, nil, nil, nil
+      @formatted = false
+
+      if @original_line =~ /(.+):(-?\d+):in `(.+)'/
+        @formatted = true
+        @path, @line, @method = $1, $2, $3
+        @full_dir = File.dirname(@path)
+        @dir = @full_dir.split('/').last
+        @dir = @dir == '.' ? '' : "#{dir}/"
+        @file = File.basename @path
+      end
+    end
+
+    def formatted?
+      @formatted
+    end
+
+    def formatted_line
+      formatted? ? colored_line : original_line
+    end
+
+    def colored_line
+      "line %{green}#{line.to_s.ljust 4}%{reset} in %{cyan}#{dir}%{magenta}#{file}%{reset} > %{blue}#{method}%{reset}" % colors
+    end
+  end
+end

data/lib/pretty_trace/colors.rb

@@ -0,0 +1,11 @@
+module PrettyTrace
+  module Colors
+    def colors
+      {
+        reset:  "\e[0m",  black:  "\e[30m", red:    "\e[31m",
+        green:  "\e[32m", yellow: "\e[33m", blue:   "\e[34m",
+        magenta:"\e[35m", cyan:   "\e[36m", white:  "\e[37m",
+      }
+    end
+  end
+end

data/lib/pretty_trace/handler.rb

@@ -3,9 +3,26 @@ require 'singleton'
 module PrettyTrace
   class Handler
     include Singleton
+    include Colors
 
-    def trace_point
-      @trace_point ||= trace_point!
+    def enable
+      @enabled = true
+      # :nocov: - this is actually covered through an external process
+      at_exit do
+        if @enabled and $! and !ignored.include? $!.class
+          show_errors $!
+          exit! 1
+        end
+      end
+      # :nocov:
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enabled?
+      @enabled
     end
 
     def options
@@ -18,13 +35,24 @@ module PrettyTrace
 
     private
 
-    def trace_point!
-      TracePoint.new :raise do |tp|
-        exception = tp.raised_exception
-        backtrace = exception.backtrace
-        pretty_trace = Formatter.pretty_trace backtrace, options
-        exception.set_backtrace pretty_trace
+    def ignored
+      # :nocov:
+      [ SystemExit ]
+      # :nocov:
+    end
+
+    def show_errors(exception)
+      # :nocov:
+      backtrace = StructuredBacktrace.new exception.backtrace, options
+      puts "\n#{backtrace}"
+      message = exception.message
+      if message.empty?
+        puts "\n%{blue}#{exception.class}%{reset}\n" % colors
+      else
+        puts "\n%{blue}#{exception.class}\n%{red}#{message}%{reset}\n" % colors
       end
+      STDOUT.flush
+      # :nocov:
     end
 
     def default_options

data/lib/pretty_trace/module_methods.rb

@@ -1,10 +1,10 @@
 module PrettyTrace
   def self.enable
-    Handler.instance.trace_point.enable unless ENV['PRETTY_TRACE'] == 'off'
+    Handler.instance.enable unless ENV['PRETTY_TRACE'] == 'off'
   end
 
   def self.disable
-    Handler.instance.trace_point.disable
+    Handler.instance.disable
   end
 
   def self.filter(filter)
@@ -16,10 +16,10 @@ module PrettyTrace
   end
 
   def self.trim
-    ENV['PRETTY_TRACE_TRIM'] = '1'
+    Handler.instance.options[:trim] = true
   end
 
   def self.no_trim
-    ENV['PRETTY_TRACE_TRIM'] = nil
+    Handler.instance.options[:trim] = false
   end
 end

data/lib/pretty_trace/structured_backtrace.rb

@@ -0,0 +1,44 @@
+module PrettyTrace
+  class StructuredBacktrace
+    attr_reader :options, :backtrace
+
+    def initialize(backtrace, options={})
+      @options = options
+      @backtrace = backtrace
+    end
+
+    def structure
+      filter = options[:filter] || []
+      filter = [filter] unless filter.is_a? Array
+
+      result = backtrace.dup
+
+      filter.each do |expression|
+        result.reject! { |trace| trace =~ expression }
+      end
+
+      result.map! { |line| BacktraceItem.new line }
+      first_line = result[0]
+      result.reverse!
+      result.uniq!(&:path) if should_trim? result
+
+      result.push first_line unless first_line.original_line == result[-1].original_line
+
+      result
+    end
+
+    def formatted_backtrace
+      structure.map(&:formatted_line)
+    end
+
+    def to_s
+      formatted_backtrace.join "\n"
+    end
+
+    private
+
+    def should_trim?(backtrace)
+      options[:trim] and ENV['PRETTY_TRACE'] != 'full' and backtrace.size > 3
+    end
+  end
+end

data/lib/pretty_trace/version.rb

@@ -1,3 +1,3 @@
 module PrettyTrace
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/pretty_trace.rb

@@ -1,4 +1,6 @@
 require 'pretty_trace/version'
+require 'pretty_trace/colors'
+require 'pretty_trace/backtrace_item'
 require 'pretty_trace/handler'
-require 'pretty_trace/formatter'
+require 'pretty_trace/structured_backtrace'
 require 'pretty_trace/module_methods'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_trace
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -88,11 +88,13 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/pretty_trace.rb
+- lib/pretty_trace/backtrace_item.rb
+- lib/pretty_trace/colors.rb
 - lib/pretty_trace/enable-trim.rb
 - lib/pretty_trace/enable.rb
-- lib/pretty_trace/formatter.rb
 - lib/pretty_trace/handler.rb
 - lib/pretty_trace/module_methods.rb
+- lib/pretty_trace/structured_backtrace.rb
 - lib/pretty_trace/version.rb
 homepage: https://github.com/DannyBen/pretty_trace
 licenses:

data/lib/pretty_trace/formatter.rb

@@ -1,51 +0,0 @@
-module PrettyTrace
-  class Formatter
-    def self.pretty_trace(backtrace, opts={})
-      filter = opts[:filter] || []
-      filter = [filter] unless filter.is_a? Array
-
-      filter.each do |expression|
-        backtrace.reject! { |trace| trace =~ expression }
-      end
-
-      backtrace = trim backtrace if should_trim? backtrace
-
-      backtrace.map! do |item|
-        if item =~ /(.+):(-?\d+):in `(.+)'/
-          file, line, method = $1, $2, $3
-          dir = File.dirname(file).split('/').last
-          dir = dir == '.' ? '' : "#{dir}/"
-          file = File.basename file
-
-          item = "line %{green}#{line.to_s.ljust 4}%{reset} in %{cyan}#{dir}%{magenta}#{file}%{reset} > %{blue}#{method}%{reset}" % colors
-        end
-        item
-      end
-
-      backtrace
-    end
-
-    def self.colors
-      {
-        reset:  "\e[0m",
-        black:  "\e[30m",
-        red:    "\e[31m",
-        green:  "\e[32m",
-        yellow: "\e[33m",
-        blue:   "\e[34m",
-        magenta:"\e[35m",
-        cyan:   "\e[36m",
-        white:  "\e[37m",
-      }
-    end
-
-    def self.trim(backtrace)
-      [backtrace[0], '......    (trimmed)', backtrace[-1]] 
-    end
-
-    def self.should_trim?(backtrace)
-      ENV['PRETTY_TRACE_TRIM'] and ENV['PRETTY_TRACE'] != 'full' and
-        backtrace.size > 3
-    end
-  end
-end