pretty_trace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d8187f1a160dfa57ad3431758d0ef5a5db5e579
+  data.tar.gz: e5523337c8797d52d4f8e2b698afcfd35ee33f91
+SHA512:
+  metadata.gz: b6e4ae015526639834b3a5b9872241ae65b7d3614a890f3f715a52071e6001b30cc44ad1b1b57ab148b7534c188de4e9ee4f198d88013c0cc1c96e613a78c4fc
+  data.tar.gz: 0fd788761adcb08c129d9c606ed94d9c5e0582ce9056b31e3e6bfa9c459a119cb230bf5485f6868103e030f2479f1540ff34c5ee15b37839b884a3ce2e8bee43

data/README.md

@@ -0,0 +1,34 @@
+Pretty Trace - Pretty Errors and Backtrace
+==================================================
+
+This forces any of your Ruby scripts to show a pretty backtrace.
+
+Install
+--------------------------------------------------
+
+    $ gem install pretty_trace
+
+Example
+--------------------------------------------------
+
+1. Create this ruby file:
+
+```ruby
+# test.rb
+require "pretty_trace/enable"
+require "fileutils"
+FileUtils.rm 'no_such_file'
+```
+
+2. Run it:
+
+    $ ruby test.rb
+
+3. Get a pretty exception
+
+![screenshot](/screenshot.png)
+
+
+
+
+

data/lib/pretty_trace/enable.rb

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

data/lib/pretty_trace/formatter.rb

@@ -0,0 +1,44 @@
+require 'ostruct'
+
+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.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
+
+    private
+
+    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
+  end
+end

data/lib/pretty_trace/handler.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module PrettyTrace
+  class Handler
+    include Singleton
+
+    def trace_point
+      @trace_point ||= trace_point!
+    end
+
+    def options
+      @options ||= default_options
+    end
+
+    def options=(new_options)
+      @options = new_options
+    end
+
+    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
+      end
+    end
+
+    def default_options
+      { filter: [] }
+    end
+  end
+end

data/lib/pretty_trace/module_methods.rb

@@ -0,0 +1,17 @@
+module PrettyTrace
+  def self.enable
+    Handler.instance.trace_point.enable unless ENV['PRETTY_TRACE'] == 'off'
+  end
+
+  def self.disable
+    Handler.instance.trace_point.disable
+  end
+
+  def self.filter(filter)
+    if filter.is_a? Array
+      Handler.instance.options[:filter] += filter
+    else
+      Handler.instance.options[:filter] << filter
+    end
+  end
+end

data/lib/pretty_trace/version.rb

@@ -0,0 +1,3 @@
+module PrettyTrace
+  VERSION = "0.0.1"
+end

data/lib/pretty_trace.rb

@@ -0,0 +1,4 @@
+require 'pretty_trace/version'
+require 'pretty_trace/handler'
+require 'pretty_trace/formatter'
+require 'pretty_trace/module_methods'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pretty_trace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Display clean and colorful error messages and backtrace
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pretty_trace.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/version.rb
+homepage: https://github.com/DannyBen/pretty_trace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Pretty backtrace and error messages
+test_files: []