pretty_trace 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7895d1287b0efe660fd6807cc8b26c6bde79d96aef0030b4da2fe97bd0b77cf
-  data.tar.gz: b0618c23b25b8cd17fe82ac77b4daace01828163c46a2f5af370e587f55e1b4f
+  metadata.gz: 8a8414a3aea1ebb47b1e194b2b9aefcbb8086064032148609d42b287b2f4eff6
+  data.tar.gz: 22649b6a4c529271f418c7212cfe735fa16f468c6a54a0e4057af6a88cf8c9d7
 SHA512:
-  metadata.gz: f90fb665503e3a4e273783874a0c032b4224453913ed7f7b1c4d9c11a8f5d8e7d3860e7805c6931221c21feb7a8a12d68cb441af4bc24bffde01120ba8bad854
-  data.tar.gz: 184e2517630768749a2aef7b051f9c7e75859ff09bec1fcd200d5140e2f040dcc0618d5e634575e9d1098ceb25fb34b42f6e95535cd9eb84ffad597000b9d7da
+  metadata.gz: ba665c8242bcf0eb200f25e6413f45cbf49073ab4da2700cf808dd879305fb301b0db9b608c26ab8491d4e247d4398a9d8d706e9c64dfeeb55bef88423428bd9
+  data.tar.gz: fd8e854d010fc604ce3d21c67acaa0b81d6a665f0361f1d8b678776902933395767c639e207bb947537958fe6cdf40a1c92533590c18267ea5e66211b0bec4b6

data/README.md

@@ -1,11 +1,19 @@
+<div align='center'>
+
 # Pretty Trace - Pretty Errors and Backtrace
 
 [![Gem Version](https://badge.fury.io/rb/pretty_trace.svg)](https://badge.fury.io/rb/pretty_trace)
 [![Build Status](https://github.com/DannyBen/pretty_trace/workflows/Test/badge.svg)](https://github.com/DannyBen/pretty_trace/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c9db6ec58ec7ac1484aa/maintainability)](https://codeclimate.com/github/DannyBen/pretty_trace/maintainability)
 
+![screenshot](support/screenshot/enabled.svg)
+
+</div>
+
 ---
 
+
+
 Make your Ruby backtrace pretty again. Just require `pretty_trace/enable` 
 in your ruby script, and errors will become clearer and more readable.
 
@@ -32,22 +40,16 @@ gem 'pretty_trace', require: 'pretty_trace/enable-trim'
 ```
 
 
-## Example
-
-### Create this ruby file:
+## Quick Start
 
 ```ruby
 # test.rb
 require "pretty_trace/enable-trim"
 require "fileutils"
+
 FileUtils.rm 'no_such_file'
 ```
 
-### Run it:
-
-![screenshot](/screenshot.gif)
-
-
 ## Usage
 
 The easiest way to use Pretty Trace is to require its activation script in
@@ -82,10 +84,12 @@ PrettyTrace.disable
 
 PrettyTrace.enable
 PrettyTrace.trim
-# Exceptions here will be formatted and trimmed
+PrettyTrace.reverse
+# Exceptions here will be formatted, trimmed and in reverse order
 
 PrettyTrace.no_trim
-# Exceptions here will not be trimmed
+PrettyTrace.no_reverse
+# Exceptions here will not be trimmed or reversed
 ```
 
 

data/lib/pretty_trace/backtrace_item.rb

@@ -6,17 +6,18 @@ module PrettyTrace
 
     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
+      return unless @original_line =~ /(.+):(-?\d+):in `(.+)'/
+
+      @formatted = true
+      @path = $1
+      @line = $2
+      @method = $3
+      @full_dir = File.dirname(@path)
+      @dir = @full_dir.split('/').last
+      @dir = @dir == '.' ? '' : "#{dir}/"
+      @file = File.basename @path
     end
 
     def formatted?
@@ -28,7 +29,7 @@ module PrettyTrace
     end
 
     def colored_line
-      "line %{green}#{line.to_s.ljust 4}%{reset} in %{cyan}#{dir}%{magenta}#{file}%{reset} > %{blue}#{method}%{reset}" % colors
+      "line %{green_bold}#{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

@@ -2,9 +2,16 @@ 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",
+        reset:   "\e[0m",
+        bold:    "\e[1m",
+        black:   "\e[30m",    black_bold:   "\e[1;30m",
+        red:     "\e[31m",    red_bold:     "\e[1;31m",
+        green:   "\e[32m",    green_bold:   "\e[1;32m",
+        yellow:  "\e[33m",    yellow_bold:  "\e[1;33m",
+        blue:    "\e[34m",    blue_bold:    "\e[1;34m",
+        magenta: "\e[35m",    magenta_bold: "\e[1;35m",
+        cyan:    "\e[36m",    cyan_bold:    "\e[1;36m",
+        white:   "\e[37m",    white_bold:   "\e[1;37m",
       }
     end
   end

data/lib/pretty_trace/handler.rb

@@ -1,70 +1,70 @@
-require 'singleton'
-
 module PrettyTrace
   class Handler
-    include Singleton
-    include Colors
+    class << self
+      include Colors
+
+      attr_writer :options
 
-    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 $!
-          $stderr.reopen IO::NULL
-          $stdout.reopen IO::NULL
+      def enable
+        @enabled = true
+        # :nocov: - this is actually covered through an external process
+        at_exit do
+          if @enabled && $! && !ignored.include?($!.class)
+            show_errors $!
+            $stderr.reopen IO::NULL
+            $stdout.reopen IO::NULL
+          end
         end
+        # :nocov:
       end
-      # :nocov:
-    end
 
-    def disable
-      @enabled = false
-    end
+      def disable
+        @enabled = false
+      end
 
-    def enabled?
-      @enabled
-    end
+      def enabled?
+        @enabled
+      end
 
-    def options
-      @options ||= default_options
-    end
+      def debug_tip?
+        !!(options[:debug_tip] and ENV['PRETTY_TRACE'] != 'full')
+      end
 
-    def options=(new_options)
-      @options = new_options
-    end
+      def options
+        @options ||= default_options
+      end
 
-  private
+    private
 
-    def ignored
-      # :nocov:
-      [ SystemExit ]
-      # :nocov:
-    end
+      def ignored
+        # :nocov:
+        [SystemExit]
+        # :nocov:
+      end
 
-    def show_errors(exception)
-      # :nocov:
-      backtrace = StructuredBacktrace.new exception.backtrace, options
+      def show_errors(exception)
+        # :nocov:
+        backtrace = StructuredBacktrace.new exception.backtrace, options
 
-      puts "\n#{backtrace}" unless backtrace.empty?
+        puts "\n#{backtrace}" unless backtrace.empty?
 
-      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
+        message = exception.message
+        puts "\n%{red}█ %{reset}%{bold}#{exception.class}%{reset}\n" % colors
+        unless message.empty?
+          puts "%{red}█ %{reset}%{yellow}#{message}%{reset}\n" % colors 
+        end
 
-      if options[:debug_tip] and ENV['PRETTY_TRACE'] != 'full'
-        puts "\nTIP: Run with %{cyan}PRETTY_TRACE=full%{reset} (or %{cyan}off%{reset}) for debug information" % colors
-      end
+        if debug_tip?
+          puts "\nTip: Run with %{cyan}PRETTY_TRACE=full%{reset} (or %{cyan}off%{reset}) for debug information" % colors
+        end
 
-      $stdout.flush
-      # :nocov:
-    end
+        $stdout.flush
+        # :nocov:
+      end
 
-    def default_options
-      { filter: [] }
+      def default_options
+        { filter: [] }
+      end
     end
   end
-end;
+end

data/lib/pretty_trace/module_methods.rb

@@ -1,33 +1,43 @@
 module PrettyTrace
-  def self.enable
-    Handler.instance.enable unless ENV['PRETTY_TRACE'] == 'off'
-  end
+  class << self
+    def enable
+      Handler.enable unless ENV['PRETTY_TRACE'] == 'off'
+    end
 
-  def self.disable
-    Handler.instance.disable
-  end
+    def disable
+      Handler.disable
+    end
 
-  def self.filter(filter)
-    if filter.is_a? Array
-      Handler.instance.options[:filter] += filter
-    else
-      Handler.instance.options[:filter] << filter
+    def filter(filter)
+      if filter.is_a? Array
+        Handler.options[:filter] += filter
+      else
+        Handler.options[:filter] << filter
+      end
     end
-  end
 
-  def self.debug_tip
-    Handler.instance.options[:debug_tip] = true
-  end
+    def debug_tip
+      Handler.options[:debug_tip] = true
+    end
 
-  def self.no_debug_tip
-    Handler.instance.options[:debug_tip] = false
-  end
+    def no_debug_tip
+      Handler.options[:debug_tip] = false
+    end
 
-  def self.trim
-    Handler.instance.options[:trim] = true
-  end
+    def trim
+      Handler.options[:trim] = true
+    end
+
+    def no_trim
+      Handler.options[:trim] = false
+    end
+
+    def reverse
+      Handler.options[:reverse] = true
+    end
 
-  def self.no_trim
-    Handler.instance.options[:trim] = false
+    def no_reverse
+      Handler.options[:reverse] = false
+    end
   end
-end
+end

data/lib/pretty_trace/structured_backtrace.rb

@@ -2,33 +2,20 @@ module PrettyTrace
   class StructuredBacktrace
     attr_reader :options, :backtrace
 
-    def initialize(backtrace, options={})
+    def initialize(backtrace, options = {})
       @options = options
       @backtrace = backtrace
     end
 
     def structure
-      filter = options[:filter] || []
-      filter = [filter] unless filter.is_a? Array
-
-      result = backtrace.dup
-
-      unless ENV['PRETTY_TRACE'] == 'full'
-        filter.each do |expression|
-          result.reject! { |trace| trace =~ expression }
-        end
+      result = backtrace_list.map { |line| BacktraceItem.new line }
+      result = if should_trim? result
+        result.group_by(&:path).flat_map { |_, items| [items.first, items.last].uniq }
+      else
+        result
       end
 
-      result.map! { |line| BacktraceItem.new line }
-      first_line = result[0]
-      result.reverse!
-      result.uniq!(&:path) if should_trim? result
-
-      if first_line and first_line.original_line != result[-1].original_line
-        result.push first_line
-      end
-
-      result
+      should_reverse? ? result.reverse : result
     end
 
     def formatted_backtrace
@@ -45,8 +32,29 @@ module PrettyTrace
 
   private
 
+    def backtrace_list
+      result = backtrace.dup
+
+      unless ENV['PRETTY_TRACE'] == 'full'
+        filters.each do |expression|
+          result.reject! { |trace| trace =~ expression }
+        end
+      end
+
+      result.reverse
+    end
+
+    def filters
+      result = options[:filter] || []
+      result.is_a?(Array) ? result : [result]
+    end
+
     def should_trim?(backtrace)
       options[:trim] and ENV['PRETTY_TRACE'] != 'full' and backtrace.size > 3
     end
+
+    def should_reverse?
+      options[:reverse]
+    end
   end
 end

data/lib/pretty_trace/version.rb

@@ -1,3 +1,3 @@
 module PrettyTrace
-  VERSION = "0.2.5"
-end
+  VERSION = '0.3.0'
+end

data/lib/pretty_trace.rb

@@ -5,4 +5,4 @@ require 'pretty_trace/handler'
 require 'pretty_trace/structured_backtrace'
 require 'pretty_trace/module_methods'
 
-require 'byebug' if ENV['BYEBUG']
+require 'debug' if ENV['DEBUGGER']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_trace
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2024-08-25 00:00:00.000000000 Z
 dependencies: []
 description: Display clean and colorful error messages and backtrace
 email: db@dannyben.com
@@ -29,8 +29,9 @@ files:
 homepage: https://github.com/DannyBen/pretty_trace
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,15 +39,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: Pretty backtrace and error messages
 test_files: []