RubyGems - enhanced_errors - Versions diffs - 0.1.0 → 0.1.1 - Mend

enhanced_errors 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

checksums.yaml +4 -4
data/.yardoc/checksums +4 -0
data/.yardoc/complete +0 -0
data/.yardoc/object_types +0 -0
data/.yardoc/objects/root.dat +0 -0
data/.yardoc/proxy_types +0 -0
data/README.md +33 -19
data/doc/Binding.html +137 -0
data/doc/Colors.html +384 -0
data/doc/Debugging.html +181 -0
data/doc/EnhancedErrors.html +2742 -0
data/doc/ErrorEnhancements.html +252 -0
data/doc/_index.html +151 -0
data/doc/class_list.html +54 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +503 -0
data/doc/file.README.html +432 -0
data/doc/file_list.html +59 -0
data/doc/frames.html +22 -0
data/doc/images/enhanced-error.png +0 -0
data/doc/index.html +432 -0
data/doc/js/app.js +344 -0
data/doc/js/full_list.js +242 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +286 -0
data/doc/top-level-namespace.html +112 -0
data/enhanced_errors.gemspec +4 -2
data/lib/enhanced_errors.rb +43 -30
metadata +56 -4

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.37
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Debugging.html" title="Debugging (module)">Debugging</a></span>, <span class='object_link'><a href="ErrorEnhancements.html" title="ErrorEnhancements (module)">ErrorEnhancements</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Binding.html" title="Binding (class)">Binding</a></span>, <span class='object_link'><a href="Colors.html" title="Colors (class)">Colors</a></span>, <span class='object_link'><a href="EnhancedErrors.html" title="EnhancedErrors (class)">EnhancedErrors</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Tue Oct 22 23:16:25 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.1.3).
+</div>
+    </div>
+  </body>
+</html>

data/enhanced_errors.gemspec CHANGED Viewed

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "0.1.0"
+  spec.version = "0.1.1"
   spec.authors = ["Eric Beland"]
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."
   spec.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."
-  spec.homepage = "https://github.com/ericbeland/enhanced_errors."
+  spec.homepage = "https://github.com/ericbeland/enhanced_errors"
   spec.required_ruby_version = ">= 3.0.0"
   spec.metadata["homepage_uri"] = spec.homepage
@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
   spec.add_development_dependency "rspec", "> 3.4.0"
+  spec.add_development_dependency "awesome_print", "> 1.9.0"
+  spec.add_development_dependency "yard", "> 0.9.33"
 end

data/lib/enhanced_errors.rb CHANGED Viewed

@@ -10,48 +10,59 @@ require_relative 'binding'
 # It offers customization options for formatting and filtering captured data.
 class EnhancedErrors
   class << self
-    # @!attribute [rw] enabled
-    #   @return [Boolean] Indicates whether EnhancedErrors is enabled.
+    # Indicates whether EnhancedErrors is enabled.
+    #
+    # @return [Boolean]
     attr_accessor :enabled
-    # @!attribute [rw] trace
-    #   @return [TracePoint, nil] The TracePoint object used for tracing exceptions.
+    # The TracePoint object used for tracing exceptions.
+    #
+    # @return [TracePoint, nil]
     attr_accessor :trace
-    # @!attribute [rw] config_block
-    #   @return [Proc, nil] The configuration block provided during enhancement.
+    # The configuration block provided during enhancement.
+    #
+    # @return [Proc, nil]
     attr_accessor :config_block
-    # @!attribute [rw] max_length
-    #   @return [Integer] The maximum length of the formatted exception message.
+    # The maximum length of the formatted exception message.
+    #
+    # @return [Integer]
     attr_accessor :max_length
-    # @!attribute [rw] on_capture_hook
-    #   @return [Proc, nil] Hook to modify binding information upon capture.
+    # Hook to modify binding information upon capture.
+    #
+    # @return [Proc, nil]
     attr_accessor :on_capture_hook
-    # @!attribute [rw] capture_let_variables
-    #   @return [Boolean] Determines whether RSpec `let` variables are captured.
+    # Determines whether RSpec `let` variables are captured.
+    #
+    # @return [Boolean]
     attr_accessor :capture_let_variables
-    # @!attribute [rw] eligible_for_capture
-    #   @return [Proc, nil] A proc that determines if an exception is eligible for capture.
+    # A proc that determines if an exception is eligible for capture.
+    #
+    # @return [Proc, nil]
     attr_accessor :eligible_for_capture
-    # @!attribute [rw] skip_list
-    #   @return [Set<Symbol>] A set of variable names to exclude from binding information.
+    # A set of variable names to exclude from binding information.
+    #
+    # @return [Set<Symbol>]
     attr_accessor :skip_list
-    # @!constant GEMS_REGEX
-    #   @return [Regexp] Regular expression to identify gem paths.
+    # Regular expression to identify gem paths.
+    #
+    # @return [Regexp]
     GEMS_REGEX = %r{[\/\\]gems[\/\\]}
-    # @!constant DEFAULT_MAX_LENGTH
-    #   @return [Integer] The default maximum length for formatted exception messages.
+    # The default maximum length for formatted exception messages.
+    #
+    # @return [Integer]
     DEFAULT_MAX_LENGTH = 2500
-    # @!constant RSPEC_SKIP_LIST
-    #   @return [Set<Symbol>] A set of RSpec-specific instance variables to skip.
+    # A set of RSpec-specific instance variables to skip.
+    #
+    # @return [Set<Symbol>]
     RSPEC_SKIP_LIST = Set.new([
                                 :@fixture_cache,
                                 :@fixture_cache_key,
@@ -62,8 +73,9 @@ class EnhancedErrors
                                 :@matcher_definitions,
                               ])
-    # @!constant RAILS_SKIP_LIST
-    #   @return [Set<Symbol>] A set of Rails-specific instance variables to skip.
+    # A set of Rails-specific instance variables to skip.
+    #
+    # @return [Set<Symbol>]
     RAILS_SKIP_LIST = Set.new([
                                 :@new_record,
                                 :@attributes,
@@ -221,7 +233,7 @@ class EnhancedErrors
     # Formats the captured binding information into a string based on the specified format.
     #
     # @param captured_bindings [Array<Hash>] The array of captured binding information.
-    # @param output_format [Symbol] The format to use for output (:json, :plaintext, :terminal).
+    # @param output_format [Symbol] The format to use (:json, :plaintext, :terminal).
     # @return [String] The formatted exception message.
     def format(captured_bindings = [], output_format = get_default_format_for_environment)
       result = binding_infos_array_to_string(captured_bindings, output_format)
@@ -456,6 +468,9 @@ 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.
     def test_name
       return RSpec&.current_example&.full_description if defined?(RSpec)
       nil
@@ -475,19 +490,17 @@ class EnhancedErrors
         parameters = method_obj.parameters
         locals = bind.local_variables
-        return parameters.map do |(type, name)|
+        parameters.map do |(type, name)|
           value = locals.include?(name) ? bind.local_variable_get(name) : nil
           "#{name}=#{value.inspect}"
         rescue => e
           "#{name}=#<Error getting argument: #{e.message}>"
         end.join(", ")
-      end
       rescue => e
-      "#<Error getting arguments: #{e.message}>"
+        "#<Error getting arguments: #{e.message}>"
+      end
     end
     # Determines the object name based on the TracePoint and method name.
     #
     # @param tp [TracePoint] The current TracePoint.

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Beland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,34 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.33
 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.
@@ -32,13 +60,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - LICENSE
 - README.md
 - benchmark/benchmark.rb
 - benchmark/stackprofile.rb
+- doc/Binding.html
+- doc/Colors.html
+- doc/Debugging.html
+- doc/EnhancedErrors.html
+- doc/ErrorEnhancements.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
 - doc/images/enhance.png
 - doc/images/enhanced-error.png
 - doc/images/enhanced-spec.png
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - enhanced_errors.gemspec
 - examples/division_by_zero_example.rb
 - examples/example_spec.rb
@@ -46,10 +98,10 @@ files:
 - lib/colors.rb
 - lib/enhanced_errors.rb
 - lib/error_enhancements.rb
-homepage: https://github.com/ericbeland/enhanced_errors.
+homepage: https://github.com/ericbeland/enhanced_errors
 licenses: []
 metadata:
-  homepage_uri: https://github.com/ericbeland/enhanced_errors.
+  homepage_uri: https://github.com/ericbeland/enhanced_errors
   source_code_uri: https://github.com/ericbeland/enhanced_errors
 post_install_message:
 rdoc_options: []