enhanced_errors 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c52d576256ec4fc2c77dde8744813310bb49c1108e123725b610d6fc9a09902a
-  data.tar.gz: 7917a2419c729feb708b100a19ee7c3a8b9defec42d34f991331e054cd1800f5
+  metadata.gz: b74f8777e19b73bcfd4024c4d3191abf98acfa397adaf99252b80cbbabf583af
+  data.tar.gz: 47df87c1b8820fc1f0c0bdea2abe48ad4ed817472b22d8728328b52397e21b4c
 SHA512:
-  metadata.gz: 225ec06e204a1783a479e1eed7d648a0c564e4fe93408d96e7d9e7f20153cb6ec481eb254e7d230c888a8d512b69333ff245244fe638d4257a7899de62896410
-  data.tar.gz: aacbe2caa5ddbf1b73cc3544136ddec8f97975f5ad2a977a14163200874d02db8aa75d421878206d275f78d859876bb6c96770aba97668842f2aa3c1c198f63a
+  metadata.gz: c1db064f46691c84d3321b735c4bbf3258aa9d6f71a1611096cbe21d9a52bd67a352cc750a2fe16ad5f9fb46911fd4111e5166f4bb08844e28b80b64ba4af7ee
+  data.tar.gz: cb1664d2de142e882f6d408817ac9c7a8b0bb14a54dedf30fa35fde05ba215bed7b42c17eef3109ffa4e7736f35f9eb937eac1c37a6d9a7278a6a989baff070f

data/README.md

@@ -34,38 +34,36 @@ foo
 
 ##### Output:
 
-<img src="./doc/images/enhanced-error.png" style="height: 171px; width: 440px;"></img>
-
+<img src="./doc/images/enhanced-error.png" style="height: 215px; width: 429px;"></img>
 <br>
-
 #### Enhanced Exception In Specs:
 
 ```ruby
-  describe 'attains enlightenment' do
-    let(:the_matrix) { 'code rains, dramatically' }
+describe 'sees through' do
 
-    before(:each) do
-      @spoon = 'there is no spoon'
-    end
+  let(:the_matrix) { 'code rains, dramatically' }
 
-    it 'in the matrix' do
-      #activate memoized item
-      the_matrix
-      stop = 'bullets'
-      raise 'No!'
-    end
+  before(:each) do
+    @spoon = 'there is no spoon'
   end
+
+  it 'the matrix' do
+    #activate memoized item
+    the_matrix
+    stop = 'bullets'
+    raise 'No!'
+  end
+end
 ```
 
 #### Output:
 
-<img src="./doc/images/enhanced-spec.png" style="height: 426px; width: 712px;"></img>
+<img src="./doc/images/enhanced-spec.png" style="height: 369px; width: 712px;"></img>
 
 
 ## Features
 
-- **Pure Ruby**: No external dependencies or C extensions.
-- **Standalone**: Does not rely on any external libraries.
+- **Pure Ruby**: No external dependencies, C extensions, or C API calls.
 - **Lightweight**: Minimal performance impact, as tracing is only active during exception raising.
 - **Customizable Output**: Supports multiple output formats (`:json`, `:plaintext`, `:terminal`).
 - **Flexible Hooks**: Redact or modifying captured data via the `on_capture` hook.
@@ -149,6 +147,10 @@ end
 - `enabled`: Enables or disables the enhancement (default: `true`).
 - `max_length`: Sets the maximum length of the enhanced message (default: `2500`).
 
+Currently, the first `raise` exception binding is presented. 
+This may be changed in the future to allow more binding data to be presented.
+
+
 ### Environment-Based Defaults
 
 EnhancedErrors adjusts its default settings based on the environment:
@@ -265,14 +267,13 @@ The skip list is pre-populated with common variables to exclude and can be exten
 
 
 
-
 ### Capture Levels
 
 EnhancedErrors supports different capture levels to control the verbosity of the captured data:
 
 - **Info Level**: Respects the skip list, excluding predefined sensitive or irrelevant variables. Global variables are ignored.
 - **Debug Level**: Ignores the skip lists, capturing all variables including those typically excluded and global variables.
-  Global variables,
+  Global variables are only captured in debug mode, and they exclude the default Ruby global variables.
 
 **Default Behavior**: By default, `info` level is used, which excludes variables in the skip list to protect sensitive information. In `debug` mode, the skip lists are ignored to provide more comprehensive data, which is useful during development but should be used cautiously to avoid exposing sensitive data.
 The info mode is recommended.
@@ -287,7 +288,7 @@ EnhancedErrors differentiates between two types of capture events:
 - **`rescue`**: Captures the context when an exception is last rescued.
 
 **Default Behavior**: By default, EnhancedErrors returns the first `raise` and the last `rescue` event for each exception. 
-This provides a clear picture of where and how the exception was handled.
+The `rescue` exception is only available in Ruby 3.2+ as it was added to TracePoint events in Ruby 3.2.
 
 
 ### Example: Redacting Sensitive Information
@@ -304,39 +305,6 @@ EnhancedErrors.on_capture do |binding_info|
 end
 ```
 
-### Example: Encrypting Data in Custom Format
-
-
-```ruby
-# config/initializers/encryption.rb
-
-require 'active_support'
-
-# Retrieve the encryption key from Rails credentials or environment variables
-ENCRYPTION_KEY = Rails.application.credentials.encryption_key || ENV['ENCRYPTION_KEY']
-
-# It's recommended to use a 256-bit key (32 bytes)
-# If your key is in hex or another format, ensure it's properly decoded
-key = ActiveSupport::KeyGenerator.new(ENCRYPTION_KEY).generate_key('enhanced_errors', 32)
-ENCRYPTOR = ActiveSupport::MessageEncryptor.new(key)
-```
-
-```ruby
-
-require_relative 'path_to/enhanced_errors' # Adjust the path accordingly
-require 'active_support/message_encryptor'
-
-# Ensure the encryptor is initialized
-encryptor = ENCRYPTOR
-
-EnhancedErrors.on_format = lambda do |formatted_string|
-  encrypted_data = encryptor.encrypt_and_sign(formatted_string)
-  encrypted_base64 = Base64.strict_encode64(encrypted_data)
-  "ENCRYPTED[#{encrypted_base64}]"
-end
-```
-
-
 ## How It Works
 
 EnhancedErrors uses Ruby's `TracePoint` to listen for `:raise` and `:rescue` events. 

data/enhanced_errors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "enhanced_errors"
-  spec.version = "0.1.1"
+  spec.version = "0.1.2"
   spec.authors = ["Eric Beland"]
 
   spec.summary = "Automatically enhance your errors with messages containing variable values from the moment they were raised."
@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
     end
   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"
+
+  spec.add_development_dependency "awesome_print", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "> 0.9"
 end

data/examples/example_spec.rb

@@ -10,14 +10,14 @@ RSpec.describe 'Neo' do
     EnhancedErrors.enhance!
   end
 
-  describe 'attains enlightenment' do
+  describe 'sees through' do
     let(:the_matrix) { 'code rains, dramatically' }
 
     before(:each) do
       @spoon = 'there is no spoon'
     end
 
-    it 'in the matrix' do
+    it 'the matrix' do
       #activate memoized item
       the_matrix
       stop = 'bullets'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enhanced_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Eric Beland
@@ -11,47 +11,47 @@ cert_chain: []
 date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 0.9.33
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 0.9.33
+        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.