enhanced_errors 0.1.4 → 0.1.6

data/lib/enhanced_errors.rb

@@ -5,6 +5,20 @@ require_relative 'colors'
 require_relative 'error_enhancements'
 require_relative 'binding'
 
+# While we could just catch StandardError, we would miss a number of things.
+
+IGNORED_EXCEPTIONS = [
+  SystemExit,
+  NoMemoryError,
+  SignalException,
+  Interrupt,
+  ScriptError,
+  LoadError,
+  NotImplementedError,
+  SyntaxError,
+  SystemStackError
+]
+
 # The EnhancedErrors class provides mechanisms to enhance exception handling by capturing
 # additional context such as binding information, variables, and method arguments when exceptions are raised.
 # It offers customization options for formatting and filtering captured data.
@@ -147,7 +161,8 @@ class EnhancedErrors
     # @param options [Hash] Additional configuration options.
     # @yield [void] A block for additional configuration.
     # @return [void]
-    def enhance!(enabled: true, debug: false, **options, &block)
+    def enhance!(enabled: true, debug: false, capture_events: default_capture_events, **options, &block)
+      capture_events = Array(capture_events)
       @output_format = nil
       @eligible_for_capture = nil
       @original_global_variables = nil
@@ -160,6 +175,7 @@ class EnhancedErrors
         @debug = debug
         @original_global_variables = global_variables
 
+        validate_and_set_capture_events(capture_events)
         options.each do |key, value|
           setter_method = "#{key}="
           if respond_to?(setter_method)
@@ -311,7 +327,7 @@ class EnhancedErrors
     def apply_skip_list(binding_info)
       unless @debug
         variables = binding_info[:variables]
-        variables[:instances]&.reject! { |var, _| skip_list.include?(var) || var.to_s.start_with?('@__') }
+        variables[:instances]&.reject! { |var, _| skip_list.include?(var) || (var.to_s.start_with?('@_') && !@debug) }
         variables[:locals]&.reject! { |var, _| skip_list.include?(var) }
         variables[:globals]&.reject! { |var, _| skip_list.include?(var) }
       end
@@ -323,7 +339,7 @@ class EnhancedErrors
     # @param binding_info [Hash] The binding information to validate.
     # @return [Hash, nil] The validated binding information or `nil` if invalid.
     def validate_binding_format(binding_info)
-      unless binding_info.keys.include?(:capture_type) && binding_info[:variables].is_a?(Hash)
+      unless binding_info.keys.include?(:capture_event) && binding_info[:variables].is_a?(Hash)
         puts "Invalid binding_info format."
         return nil
       end
@@ -335,8 +351,8 @@ class EnhancedErrors
     # @param binding_info [Hash] The binding information to format.
     # @return [String] The formatted string.
     def binding_info_string(binding_info)
-      capture_type = binding_info[:capture_type].to_s.capitalize
-      result = "#{Colors.red(capture_type)}: #{Colors.blue(binding_info[:source])}"
+      capture_event = binding_info[:capture_event].to_s.capitalize
+      result = "#{Colors.red(capture_event)}: #{Colors.blue(binding_info[:source])}"
 
       result += method_and_args_desc(binding_info[:method_and_args])
 
@@ -348,7 +364,6 @@ class EnhancedErrors
 
       instance_vars_to_display = variables[:instances] || {}
 
-
       if instance_vars_to_display && !instance_vars_to_display.empty?
         result += "\n#{Colors.green('Instances:')}\n#{variable_description(instance_vars_to_display)}"
       end
@@ -365,6 +380,11 @@ class EnhancedErrors
         result = result[0...max_length] + "... (truncated)"
       end
       result + "\n"
+    rescue => e
+      # we swallow and don't re-raise to avoid any recursion problems. We don't want to
+      # mess up the original exception handling.
+      puts "EnhancedErrors error in binding_info_string: #{e.message} #{e.backtrace}"
+      return ''
     end
 
     private
@@ -375,11 +395,10 @@ class EnhancedErrors
     def start_tracing
       return if @trace && @trace.enabled?
 
-      events = [:raise]
-      events << :rescue if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.3.0')
+      events = @capture_events ? @capture_events.to_a : [:raise]
 
       @trace = TracePoint.new(*events) do |tp|
-        next if Thread.current[:enhanced_errors_processing] || tp.raised_exception.is_a?(NoMemoryError)
+        next if Thread.current[:enhanced_errors_processing] || IGNORED_EXCEPTIONS.include?(tp.raised_exception)
         Thread.current[:enhanced_errors_processing] = true
         exception = tp.raised_exception
         capture_me = EnhancedErrors.eligible_for_capture.call(exception)
@@ -425,10 +444,9 @@ class EnhancedErrors
           globals = (global_variables - @original_global_variables).map { |var|
             [var, get_global_variable_value(var)]
           }.to_h
-          puts "Global Variables: #{globals.inspect}"
         end
 
-        capture_type = tp.event.to_s  # 'raise' or 'rescue'
+        capture_event = tp.event.to_s  # 'raise' or 'rescue'
         location = "#{tp.path}:#{tp.lineno}"
 
         binding_info = {
@@ -444,7 +462,7 @@ class EnhancedErrors
             globals: globals
           },
           exception: exception.class.name,
-          capture_type: capture_type.to_s
+          capture_event: capture_event.to_s
         }
 
         if on_capture_hook
@@ -469,6 +487,7 @@ class EnhancedErrors
       @trace.enable
     end
 
+
     # Retrieves the current test name from RSpec, if available.
     #
     # @return [String, nil] The current test name or `nil` if not in a test context.
@@ -480,6 +499,42 @@ class EnhancedErrors
       nil
     end
 
+    # Helper method to determine the default capture types based on Ruby version
+    #
+    # @return [Set<Symbol>] The default set of capture types
+    def default_capture_events
+      default_events = [:raise]
+      default_events << :rescue if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.3.0')
+      Set.new(default_events)
+    end
+
+    def validate_and_set_capture_events(capture_events)
+      if capture_events.nil? || !valid_capture_events?(capture_events)
+        puts "EnhancedErrors: Invalid capture_events provided. Falling back to defaults."
+        capture_events = default_capture_events
+      end
+
+      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.3.0') && capture_events.include?(:rescue)
+        puts "EnhancedErrors: Warning: :rescue capture_event is not supported in Ruby versions below 3.3.0 and will be ignored."
+        capture_events.delete(:rescue)
+      end
+
+      if capture_events.empty?
+        puts "No valid capture_events provided to EnhancedErrors.enhance! Falling back to defaults."
+        capture_events = default_capture_events
+      end
+
+      @capture_events = capture_events.to_a
+    end
+
+
+    # Validate capture_events: must be an Array or Set containing only :raise and/or :rescue.
+    def valid_capture_events?(capture_events)
+      return false unless capture_events.is_a?(Array) || capture_events.is_a?(Set)
+      valid_types = [:raise, :rescue].to_set
+      capture_events.to_set.subset?(valid_types)
+    end
+
     # Extracts method arguments from the TracePoint binding.
     #
     # @param tp [TracePoint] The current TracePoint.
@@ -560,6 +615,8 @@ class EnhancedErrors
     # @return [String] The formatted variable.
     def format_variable(variable)
       (awesome_print_available? && Colors.enabled?) ? variable.ai : variable.inspect
+    rescue => e
+      return "#{variable.to_s.truncate(30)}: [Inspection Error]"
     end
 
     # Checks if the `AwesomePrint` gem is available.

data/lib/error_enhancements.rb

@@ -1,9 +1,12 @@
 module ErrorEnhancements
   def message
     original_message = super()
-    "#{original_message}\n#{variables_message}"
+    if original_message.include?(variables_message)
+      original_message
+    else
+      "#{original_message}\n#{variables_message}"
+    end
   rescue => e
-    puts "Error in message method: #{e.message}"
     original_message
   end
 
@@ -31,7 +34,7 @@ module ErrorEnhancements
     bindings_of_interest = []
 
     binding_infos.each do |info|
-      if info[:capture_type] == 'raise' && !info[:library]
+      if info[:capture_event] == 'raise' && !info[:library]
         bindings_of_interest << info
         break
       end
@@ -43,7 +46,7 @@ module ErrorEnhancements
 
     # find the last rescue binding if there is one
     binding_infos.reverse.each do |info|
-      if info[:capture_type] == 'rescue'
+      if info[:capture_event] == 'rescue'
         bindings_of_interest << info
         break
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -52,9 +52,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: With no extra dependencies, and using only Ruby's built-in TracePoint,
-  EnhancedErrors will automatically enhance your errors with messages containing variable
-  values from the moment they were raised.
+description: 'EnhancedErrors will automatically enhance your errors with messages
+  containing variable values from the moment they were raised, using no extra dependencies,
+  and only Ruby''s built-in TracePoint. '
 email:
 executables: []
 extensions: []
@@ -68,6 +68,7 @@ files:
 - LICENSE
 - README.md
 - benchmark/benchmark.rb
+- benchmark/memory_bench.rb
 - benchmark/stackprofile.rb
 - doc/Binding.html
 - doc/Colors.html