pretty_trace 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 579685ff281ef135925131b6f4e3c08a8e5d9072
-  data.tar.gz: 75179399e4b8548338bfe95ca77392374bae5397
+  metadata.gz: 01f4109d20baa996682e6f71ce0ea1b03d7d95ac
+  data.tar.gz: ecb6f5346c533dc4915df2abe151c098423627da
 SHA512:
-  metadata.gz: ef62bb07f161ce52abc03b6f68ee7ae08de4c8306aba1a5c2562cfdcac5f9494aeb7ccad487201cd8e5826fa94477cb1c3de7ec57898fa0a1a9436597ba71c05
-  data.tar.gz: 8aa643e2e3380994e7c759d6271e3d8244e1f5134f9ae2303a35568d3a56c55dd1249bbd19595c60594c7f08e80d4ec4026967aa15afa68018dacd869d83aab5
+  metadata.gz: 0a4c2476428a4a7e4a29d6fcc183c0159fe5b51aed461a15a207394b6fac1cad2124a648be183e24fb4dd819272c7a8cd988e3ae63d945cc943a8d2cc10e88b4
+  data.tar.gz: cb7c2888add66b808803af25b5b52c5ee37e51a87149df709757c5e90c56e204c302c64cea6a55ee18d1cb334e6802c417c04446f0a758b962954aaa0f08b979

data/README.md

@@ -23,7 +23,14 @@ $ gem install pretty_trace
 Or with bundler:
 
 ```
+# Just install, do not activate
+$ gem 'pretty_trace'
+
+# Install and enable
 $ gem 'pretty_trace', require: 'pretty_trace/enable'
+
+# Install, enable and enable trimming
+$ gem 'pretty_trace', require: 'pretty_trace/enable-trim'
 ```
 
 Example
@@ -55,8 +62,15 @@ require 'pretty_trace/enable'
 
 From this point on, any exception will be formatted.
 
-If you prefer to enable/disable the formatted backtrace manually, use 
-`PrettyTrace.enable` and `PrettyTrace.disable`
+If you wish to show a trimmed version of the backtrace (only the first and 
+last line), require this script instead:
+
+```ruby
+require 'pretty_trace/enable-trim'
+```
+
+If you prefer to have more control,you can use configure these settings 
+manually:
 
 ```ruby
 require 'pretty_trace'
@@ -70,6 +84,14 @@ PrettyTrace.enable
 PrettyTrace.disable
 
 # Exceptions here will not be formatted
+
+PrettyTrace.trim
+
+# Exceptions here will be trimmed
+
+PrettyTrace.no_trim
+
+# Exceptions here will not be trimmed
 ```
 
 
@@ -95,3 +117,11 @@ to see the full trace paths), you can set the environment variable
 ```
 $ PRETTY_TRACE=off ruby myscript.rb
 ```
+
+If you wish to temporarily disable trimming, you can set the environment 
+variable `PRETTY_TRACE=full` before running your script:
+
+```
+$ PRETTY_TRACE=full ruby myscript.rb
+```
+

data/lib/pretty_trace/enable-trim.rb

@@ -0,0 +1,3 @@
+require 'pretty_trace'
+PrettyTrace.enable
+PrettyTrace.trim

data/lib/pretty_trace/formatter.rb

@@ -8,6 +8,8 @@ module PrettyTrace
         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
@@ -36,5 +38,14 @@ module PrettyTrace
         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

data/lib/pretty_trace/handler.rb

@@ -31,4 +31,4 @@ module PrettyTrace
       { filter: [] }
     end
   end
-end
+end;

data/lib/pretty_trace/module_methods.rb

@@ -14,4 +14,12 @@ module PrettyTrace
       Handler.instance.options[:filter] << filter
     end
   end
+
+  def self.trim
+    ENV['PRETTY_TRACE_TRIM'] = '1'
+  end
+
+  def self.no_trim
+    ENV['PRETTY_TRACE_TRIM'] = nil
+  end
 end

data/lib/pretty_trace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_trace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/pretty_trace.rb
+- lib/pretty_trace/enable-trim.rb
 - lib/pretty_trace/enable.rb
 - lib/pretty_trace/formatter.rb
 - lib/pretty_trace/handler.rb