enhanced_errors 2.0.4 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8930564c886592e2009e80692afc91e246a3568c5aa3014cc8c75cc9707ab79
-  data.tar.gz: 50f4106e4f94eaaadde9a0e1a1ef3f6783863edfbba7a40a95453c3fb82b6f9d
+  metadata.gz: 9e6ed241407a54376e0c64f2c1adc087e3dae4980ac5b7e84c947d92ff787392
+  data.tar.gz: 4f949a5145869e73e7f795a9c009800433956162a6d25695c2a9e8ba3a39da05
 SHA512:
-  metadata.gz: c1e15a12dc7fe9823160a57d989fc281dd53bdbdfac17dc249be8f6e821c44cf2c089c1c7414b42245dc9be2c63ff98efb723ef26cb63550d019f8d48e7457d0
-  data.tar.gz: cda1322bd0d6371ed9f12a7faf165dfd4f838387b98c1d34c22c03c89534e5b2de4570894d941ef22c7019278cad0ee569984e6abc6632403e563051044acbcb
+  metadata.gz: 02312f5287c4214c59b4b4a53e723d53d4dff511f24c335a7f7a84f049bb06638f77ea22f488cba5682fba66f581116b2bb1a4b3a79d8b6a5a290f5f822f1ea8
+  data.tar.gz: 13d06fa670a3f34bb67624ec40bc9a87810536aace8c2867e64620092c13d8e48d25675241491d821491cb2f3a893c1d8faa2ede7ff2f22c45b50fb506fbbd74

data/.yardoc/checksums

@@ -1,4 +1,4 @@
-lib/enhanced/colors.rb 4fdbc5803b62201392c6a2ee46c5012a6f79685e
-lib/enhanced_errors.rb 9572612271c977a4063fab6a9c9bee75198e9166
-lib/enhanced/exception.rb 72c62e85ce9cea875bc3e835240059bbf1b00f0b
-lib/enhanced/integrations/rspec_error_failure_message.rb 3404247ebb2c7cf6b7dc9abb215c59c46a041cee
+lib/colors.rb a4314ef9531d4713907c3fea22955c943fdb8cf3
+lib/binding.rb fdd7d5a2dd2edde22e3b10773510738dcdce4aeb
+lib/enhanced_errors.rb d12ce0629f2565e5179ae5076be8a495e19ecda2
+lib/error_enhancements.rb a97d0f139d35f6e1b5bf49386271b1f4cf71761c

data/README.md

@@ -79,33 +79,19 @@ exceptions except those that pass by during the RSpec run.
 ```ruby
 
 RSpec.configure do |config|
-   
-  # add these config changes to your RSpec config to get variable messages
-  config.before(:suite) do
-    RSpec::Core::Example.prepend(Enhanced::Integrations::RSpecErrorFailureMessage)
-  end
-  
   config.before(:example) do |_example|
     EnhancedErrors.start_rspec_binding_capture
   end
 
   config.after(:example) do |example|
     example.metadata[:expect_binding] = EnhancedErrors.stop_rspec_binding_capture
+    EnhancedErrors.override_exception_message(example.exception, example.metadata[:expect_binding])
   end
-  
 end
-
 ```
 
-## Minitest
-
-Untested as of yet, but enhance_exceptions!(override_messages: true) is likely to work.
+## TODO: Minitest
 
-If anyone wants to look into an integration implementation like RSpec, it would
-be welcomed. With a more targeted approach like the RSpec one, exceptions could be captured and 
-modified only during test time, like the RSpec approach. This would be advantageous as
-it wouldn't modify the exception message itself, but still makes the variable output available in
-test messages.
 
 ## Enhancing .message
 

data/enhanced_errors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "2.0.4"
+  spec.version = "2.0.6"
   spec.authors = ["Eric Beland"]
 
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."

data/lib/enhanced/colors.rb

@@ -1,6 +1,7 @@
 module Enhanced
   class Colors
-    COLORS = { red: 31, green: 32, yellow: 33, blue: 34, purple: 35, cyan: 36, white: 0 }
+    COLORS = { red: 31, green: 32, yellow: 33, blue: 34, purple: 35, cyan: 36, white: 0 }.freeze
+    RESET_CODE = "\e[0m".freeze
 
     class << self
       def enabled?
@@ -12,11 +13,12 @@ module Enhanced
       end
 
       def color(num, string)
-        @enabled ? "#{code(num)}#{string}#{code(0)}" : string
+        return string unless @enabled
+        "#{code(num)}#{string}#{RESET_CODE}"
       end
 
       def code(num)
-        "\e[#{num}m"
+        "\e[#{num}m".freeze
       end
 
       COLORS.each do |color, code|

data/lib/enhanced_errors.rb

@@ -3,15 +3,13 @@
 require 'set'
 require 'json'
 
-require_relative 'enhanced/integrations/rspec_error_failure_message'
 require_relative 'enhanced/colors'
 
 IGNORED_EXCEPTIONS = %w[SystemExit NoMemoryError SignalException Interrupt
-                        ScriptError LoadError NotImplementedError SyntaxError
-                        RSpec::Expectations::ExpectationNotMetError
-                        RSpec::Matchers::BuiltIn::RaiseError
-                        SystemStackError Psych::BadAlias]
-
+ ScriptError LoadError NotImplementedError SyntaxError
+ RSpec::Expectations::ExpectationNotMetError
+ RSpec::Matchers::BuiltIn::RaiseError
+ SystemStackError Psych::BadAlias]
 
 class EnhancedErrors
   extend ::Enhanced
@@ -22,17 +20,19 @@ class EnhancedErrors
                   :override_messages
 
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    DEFAULT_MAX_LENGTH = 3000
+    RSPEC_EXAMPLE_REGEXP = /RSpec::ExampleGroups::[A-Z0-9]+.*/
+    DEFAULT_MAX_LENGTH = 2000
 
     # Maximum binding infos we will track per-exception instance. This is intended as an extra
     # safety rail, not a normal scenario.
-    MAX_BINDING_INFOS = 10
+    MAX_BINDING_INFOS = 3
 
     # Add @__memoized and @__inspect_output to the skip list so they don't appear in output
     RSPEC_SKIP_LIST = Set.new([
                                 :@assertions,
                                 :@integration_session,
                                 :@example,
+                                :@assertion_delegator,
                                 :@fixture_cache,
                                 :@fixture_cache_key,
                                 :@fixture_connections,
@@ -45,7 +45,7 @@ class EnhancedErrors
                                 :@matcher_definitions,
                                 :@__memoized,
                                 :@__inspect_output
-                              ])
+                              ]).freeze
 
     RAILS_SKIP_LIST = Set.new([
                                 :@new_record,
@@ -53,8 +53,11 @@ class EnhancedErrors
                                 :@association_cache,
                                 :@readonly,
                                 :@previously_new_record,
-                                :@routes, # usually just shows #<ActionDispatch::Routing::RouteSet:0x000000016087d708>
+                                :@_routes, # usually just shows #<ActionDispatch::Routing::RouteSet:0x000000016087d708>
+                                :@routes,
+                                :@app,
                                 :@destroyed,
+                                :@response, #usually big, gets truncated anyway
                                 :@marked_for_destruction,
                                 :@destroyed_by_association,
                                 :@primary_key,
@@ -63,13 +66,16 @@ class EnhancedErrors
                                 :@strict_loading_mode,
                                 :@mutations_before_last_save,
                                 :@mutations_from_database,
+                                :@integration_session,
                                 :@relation_delegate_cache,
                                 :@predicate_builder,
                                 :@generated_relation_method,
                                 :@find_by_statement_cache,
                                 :@arel_table,
                                 :@response_klass,
-                              ])
+                              ]).freeze
+
+    DEFAULT_SKIP_LIST = (RAILS_SKIP_LIST + RSPEC_SKIP_LIST).freeze
 
     @enabled = false
 
@@ -92,18 +98,15 @@ class EnhancedErrors
     end
 
     def skip_list
-      @skip_list ||= default_skip_list
-    end
-
-    def default_skip_list
-      Set.new(RAILS_SKIP_LIST).merge(RSPEC_SKIP_LIST)
+      @skip_list ||= DEFAULT_SKIP_LIST.dup
     end
 
     # takes an exception and bindings, calculates the variables message
     # and modifies the exceptions .message to display the variables
     def override_exception_message(exception, binding_or_bindings)
       # Ensure binding_or_bindings is always an array for compatibility
-      return exception if binding_or_bindings.nil? || binding_or_bindings.empty? || exception.respond_to?(:unaltered_message)
+      return exception if binding_or_bindings.nil? || binding_or_bindings.empty?
+      return exception if exception.respond_to?(:unaltered_message)
       variable_str = EnhancedErrors.format(binding_or_bindings)
       message_str = exception.message
       exception.define_singleton_method(:unaltered_message) { message_str }
@@ -125,21 +128,19 @@ class EnhancedErrors
       @original_global_variables = nil
       @override_messages = override_messages
 
-      if enabled == false
+      if !enabled
         @original_global_variables = nil
         @enabled = false
         @trace&.disable
-        @trace = nil
       else
         # if there's an old one, disable it before replacing it
         # this seems to actually matter, although it seems like it
         # shouldn't
         @trace&.disable
-        @trace = nil
 
         @enabled = true
         @debug = debug
-        @original_global_variables = global_variables
+        @original_global_variables = global_variables if @debug
 
         options.each do |key, value|
           setter_method = "#{key}="
@@ -177,36 +178,44 @@ class EnhancedErrors
 
     def safely_prepend_rspec_custom_failure_message
       return if @rspec_failure_message_loaded
-      if defined?(RSpec::Core::Example)
+      if defined?(RSpec::Core::Example) && !RSpec::Core::Example < Enhanced::Integrations::RSpecErrorFailureMessage
         RSpec::Core::Example.prepend(Enhanced::Integrations::RSpecErrorFailureMessage)
         @rspec_failure_message_loaded = true
-      else
-
       end
     rescue => e
-      puts "Failed "
+      puts "Failed to prepend RSpec custom failure message: #{e.message}"
     end
 
     def start_rspec_binding_capture
       @rspec_example_binding = nil
+      @capture_next_binding = false
 
       # In the Exception binding infos, I observed that re-setting
       # the tracepoint without disabling it seemed to accumulate traces
       # in the test suite where things are disabled and re-enabled often.
       @rspec_tracepoint&.disable
-      @rspec_tracepoint = nil
 
-      @rspec_tracepoint = TracePoint.new(:b_return) do |tp|
+      @rspec_tracepoint = TracePoint.new(:raise, :b_return) do |tp|
         # This is super-kluge-y and should be replaced with... something TBD
-
-        # early easy checks to nope out of the object name and other checks
-        if tp.method_id.nil? && !(tp.path.to_s =~ /rspec/) && tp.path.to_s =~ /_spec\.rb$/
-         # fixes cases where class and name are screwed up or overridden
-          if determine_object_name(tp) =~ /RSpec::ExampleGroups::[A-Z0-9]+.*/ &&
-            @rspec_example_binding = tp.binding
+        # only look at block returns once we have seen an ExpectationNotMetError
+
+        case tp.event
+        when :b_return
+          # only active if we are capturing the next binding
+          next unless @capture_next_binding && @rspec_example_binding.nil?
+          # early easy checks to nope out of the object name and other checks
+          if @capture_next_binding && tp.method_id.nil? && !(tp.path.include?('rspec')) && tp.path.end_with?('_spec.rb')
+            # fixes cases where class and name are screwed up or overridden
+            if determine_object_name(tp) =~ RSPEC_EXAMPLE_REGEXP
+              @rspec_example_binding = tp.binding
+            end
+          end
+        when :raise
+          # turn on capture of next binding
+          if tp.raised_exception.class.name == 'RSpec::Expectations::ExpectationNotMetError'
+            @capture_next_binding ||= true
           end
         end
-
       end
 
       @rspec_tracepoint.enable
@@ -214,8 +223,8 @@ class EnhancedErrors
 
     def stop_rspec_binding_capture
       @rspec_tracepoint&.disable
-      @rspec_tracepoint = nil
       binding_info = convert_binding_to_binding_info(@rspec_example_binding) if @rspec_example_binding
+      @capture_next_binding = false
       @rspec_example_binding = nil
       binding_info
     end
@@ -261,8 +270,7 @@ class EnhancedErrors
 
       # Apply skip list to remove @__memoized and @__inspect_output from output
       # but only after extracting let variables.
-      binding_info = default_on_capture(binding_info)
-      binding_info
+      default_on_capture(binding_info)
     end
 
     def eligible_for_capture(&block)
@@ -358,12 +366,11 @@ class EnhancedErrors
     end
 
     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?('@_') && !@debug) }
-        variables[:locals]&.reject! { |var, _| skip_list.include?(var) }
-        variables[:globals]&.reject! { |var, _| skip_list.include?(var) }
-      end
+      variables = binding_info[:variables]
+      variables[:instances]&.reject! { |var, _| skip_list.include?(var) || (var.to_s.start_with?('@_') && !@debug) }
+      variables[:locals]&.reject! { |var, _| skip_list.include?(var) }
+      return binding_info unless @debug
+      variables[:globals]&.reject! { |var, _| skip_list.include?(var) }
       binding_info
     end
 
@@ -394,7 +401,7 @@ class EnhancedErrors
 
       instance_vars_to_display = variables[:instances] || {}
 
-      if instance_vars_to_display && !instance_vars_to_display.empty?
+      unless instance_vars_to_display.empty?
         result += "\n#{Colors.green('Instances:')}\n#{variable_description(instance_vars_to_display)}"
       end
 
@@ -520,11 +527,12 @@ class EnhancedErrors
     end
 
     def default_capture_events
+      return @default_capture_events if @default_capture_events
       events = [:raise]
       if capture_rescue && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.3.0')
         events << :rescue
       end
-      Set.new(events)
+      @default_capture_events = events
     end
 
     def validate_and_set_capture_events(capture_events)
@@ -624,7 +632,7 @@ class EnhancedErrors
 
     def variable_description(vars_hash)
       vars_hash.map do |name, value|
-        "  #{Colors.purple(name)}: #{format_variable(value)}\n"
+        " #{Colors.purple(name)}: #{format_variable(value)}\n"
       end.join
     rescue
       ''
@@ -647,15 +655,20 @@ class EnhancedErrors
     end
 
     def safe_inspect(variable)
-      variable.inspect
+      str = variable.inspect
+      if str.length > 1200
+        str[0...1200] + '...'
+      else
+        str
+      end
     rescue
       safe_to_s(variable)
     end
 
     def safe_to_s(variable)
       str = variable.to_s
-      if str.length > 140
-        str[0...140] + '...'
+      if str.length > 120
+        str[0...120] + '...'
       else
         str
       end
@@ -689,4 +702,4 @@ class EnhancedErrors
       !ignored && !rspec
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.6
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -96,7 +96,6 @@ files:
 - examples/example_spec.rb
 - lib/enhanced/colors.rb
 - lib/enhanced/exception.rb
-- lib/enhanced/integrations/rspec_error_failure_message.rb
 - lib/enhanced_errors.rb
 homepage: https://github.com/ericbeland/enhanced_errors
 licenses: []

data/lib/enhanced/integrations/rspec_error_failure_message.rb

@@ -1,13 +0,0 @@
-module Enhanced
-  module Integrations
-    module RSpecErrorFailureMessage
-      def execution_result
-        result = super
-        if result.exception
-          EnhancedErrors.override_exception_message(result.exception, self.metadata[:expect_binding])
-        end
-        result
-      end
-    end
-  end
-end