rcurses 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5132248f03d0f62fed76d2f525b0a84bf512ba0454054623e4d8528b435d9f64
-  data.tar.gz: 11ab84d968557065955885eb27d188677889d78e5ee46acc1a62064bc9b27116
+  metadata.gz: ce484ba636e927e6344a8bb0552c49aec18df5cf3d2ebcb1c80c1d3927da3005
+  data.tar.gz: 9565880d7a799a27f364e3ec543f69c5061db9e9951684b3747cad5380b5ce85
 SHA512:
-  metadata.gz: 12c461a57d353bc5a7273de1a664676a95c2d9ef445096e08222b447b45a1b0b847e9cc1570e475046e24f49264cabb1ae9b9c1e2944e09639bd9b2c881e20b6
-  data.tar.gz: 8602247bbf7c6e6377349f68dc7c2f8ff422f28890886ad5772a5aa1f5b6aed7acd1dcee8d1a66afeb7cf563dc4da832dc3caf4225922e1ffa7d6591f9204d28
+  metadata.gz: b6406ba055a63fcd8b187920f4280931b046d651919b08e3792db6a09de8ef5d5383de853847cd44cebf579ccb71c8a7a19b2d147cf825579dca6c96113130b1
+  data.tar.gz: 5522b3932739d6b726bed53a9b349006f0c7ab44bd79038008ed1f4db2cde530d0fe95e6f38d25bbf627b03a2dea4e8dd10f89991761ea048c65eec79f5dd92c

data/README.md

@@ -10,14 +10,23 @@ Here's a somewhat simple example of a TUI program using rcurses: The [T-REX](htt
 
 And here's a much more involved example: The [RTFM](https://github.com/isene/RTFM) terminal file manager.
 
-# NOTE: Version 5.0.0 brings major improvements!
-- **Memory leak fixes** - Better memory management and history limits
-- **Terminal state protection** - Proper terminal restoration on crashes
-- **Enhanced Unicode support** - Better handling of CJK characters and emojis
-- **Error handling improvements** - More robust operation in edge cases
-- **Performance optimizations** - Maintains the speed of version 4.8.3
+# NOTE: Version 6.1.1 adds optional error logging!
+- **Error logging** - Set `RCURSES_ERROR_LOG=1` to log crashes to `/tmp/rcurses_errors_PID.log`
+- **Race-condition free** - Uses process-specific filenames to avoid conflicts
+- **Stack trace preservation** - Full backtraces logged even when screen is cleared
+- **Completely opt-in** - Zero impact unless explicitly enabled
 - **Full backward compatibility** - All existing applications work unchanged
 
+Previous improvements in 6.1.0:
+- **Safe regex substitution** - New `safe_gsub` methods prevent ANSI code corruption
+- **ANSI detection** - Check if strings contain ANSI codes with `has_ansi?`
+- **Visible length calculation** - Get true text length with `visible_length`
+- **Conditional coloring** - Apply colors only when needed with `safe_fg`/`safe_bg`
+
+Previous major improvements in 5.0.0:
+- Memory leak fixes, terminal state protection, enhanced Unicode support
+- Error handling improvements and performance optimizations
+
 Version 4.5 gave full RGB support in addition to 256-colors. Just write a color as a string - e.g. `"d533e0"` for a hexadecimal RGB color (or use the terminal 256 colors by supplying an integer in the range 0-255)
 
 # Why?
@@ -129,12 +138,34 @@ pure           | Strip text of any "dressing" (example: with `text = "TEST".b`,
 clean_ansi     | Strip seemingly uncolored strings of ansi code (those that are enclosed in "\e[0m"
 shorten(n)     | Shorten the pure version of the string to 'n' characters, preserving any ANSI coding
 inject("chars",pos) | Inject "chars" at position 'pos' in the pure version of the string (if 'pos' is '-1', then append at end). Preserves any ANSI code
+safe_gsub(pattern, replacement) | Apply regex substitution without corrupting existing ANSI codes (example: `colored_text.safe_gsub(/\[([^\]]*)\]/) { |m| m.fg(46) }`)
+safe_gsub!(pattern, replacement) | In-place version of safe_gsub
+has_ansi?      | Check if string contains ANSI escape sequences (returns true/false)
+visible_length | Get the visible length of text (excluding ANSI codes)
+safe_fg(fg)    | Apply foreground color only if string doesn't already have ANSI codes
+safe_bg(bg)    | Apply background color only if string doesn't already have ANSI codes
 
 PS: Blink does not work in conjunction with setting a background color in urxvt. It does work in gnome-terminal. But the overall performance in urxvt as orders of magnitude better than gnome-terminal.
 
 # Cleaning up upon exit
 End a program with `Rcurses.clear_screen` to clear the screen for any rcurses residues.
 
+# Error Logging (New in 6.1.1)
+When applications using rcurses crash, stack traces are typically lost because rcurses clears the screen on exit. To debug crashes, you can now enable error logging:
+
+```bash
+RCURSES_ERROR_LOG=1 my_rcurses_app
+```
+
+This will create a detailed error log at `/tmp/rcurses_errors_PID.log` containing:
+- Full stack trace with line numbers
+- Error class and message
+- Process information (PID, program name, working directory)
+- Ruby and rcurses version information
+- Relevant environment variables
+
+Each process gets its own log file (using PID) to prevent race conditions when multiple rcurses applications are running simultaneously. The feature is completely opt-in and has zero performance impact when disabled.
+
 # module Cursor
 To use this module, first do `include Rcurses::Cursor`. Create a new cursor object with `mycursor = Rcurses::Cursor`. Then you can apply the following methods to `mycursor`:
 

data/lib/rcurses.rb

@@ -5,7 +5,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    6.1.0: Added safe_gsub methods to prevent ANSI code corruption
+# Version:    6.1.1: Added optional error logging with RCURSES_ERROR_LOG=1
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling
@@ -124,15 +124,18 @@ module Rcurses
     
     # Private: Display error information after terminal cleanup
     def display_error(error)
+      # Log error to file if RCURSES_ERROR_LOG is set
+      log_error_to_file(error) if ENV['RCURSES_ERROR_LOG'] == '1'
+
       # Only display if we're in a TTY and not in a test environment
       return unless $stdout.tty?
-      
+
       # Add some spacing and make the error very visible
       puts "\n\n\e[41;37m                    APPLICATION CRASHED                    \e[0m"
       puts "\e[31m═══════════════════════════════════════════════════════════\e[0m"
       puts "\e[33mError Type:\e[0m #{error.class}"
       puts "\e[33mMessage:\e[0m    #{error.message}"
-      
+
       # Show backtrace if debug mode is enabled
       if ENV['DEBUG'] || ENV['RCURSES_DEBUG']
         puts "\n\e[33mBacktrace:\e[0m"
@@ -142,11 +145,54 @@ module Rcurses
       else
         puts "\n\e[90mTip: Set DEBUG=1 or RCURSES_DEBUG=1 to see the full backtrace\e[0m"
       end
-      
+
       puts "\e[31m═══════════════════════════════════════════════════════════\e[0m"
       puts "\e[33mNote:\e[0m The application state above shows where the error occurred."
+
+      # Show log file location if logging is enabled
+      if ENV['RCURSES_ERROR_LOG'] == '1'
+        puts "\e[33mError logged to:\e[0m /tmp/rcurses_errors_#{Process.pid}.log"
+      end
       puts ""
     end
+
+    # Private: Log error details to a PID-specific file
+    def log_error_to_file(error)
+      return unless ENV['RCURSES_ERROR_LOG'] == '1'
+
+      log_file = "/tmp/rcurses_errors_#{Process.pid}.log"
+      timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+
+      begin
+        File.open(log_file, "a") do |f|
+          f.puts "=" * 60
+          f.puts "RCURSES ERROR LOG - #{timestamp}"
+          f.puts "PID: #{Process.pid}"
+          f.puts "Program: #{$0}"
+          f.puts "Working Directory: #{Dir.pwd}"
+          f.puts "Ruby Version: #{RUBY_VERSION}"
+          f.puts "Rcurses Version: 6.1.1"
+          f.puts "=" * 60
+          f.puts "Error Class: #{error.class}"
+          f.puts "Error Message: #{error.message}"
+          f.puts
+          f.puts "Full Backtrace:"
+          error.backtrace.each_with_index do |line, i|
+            f.puts "  #{i}: #{line}"
+          end
+          f.puts
+          f.puts "Environment Variables:"
+          ENV.select { |k, v| k.start_with?('RCURSES') || k == 'DEBUG' }.each do |k, v|
+            f.puts "  #{k}=#{v}"
+          end
+          f.puts "=" * 60
+          f.puts
+        end
+      rescue => file_error
+        # Silently fail if we can't write to log file - don't interfere with main error display
+        # This prevents cascading errors that could hide the original problem
+      end
+    end
     
     # Public: Run a block with proper error handling and terminal cleanup
     # This ensures errors are displayed after terminal is restored

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-01 00:00:00.000000000 Z
+date: 2025-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard