rcurses 2.4.6 → 2.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f120b89280037a3485515b1cc75f7a08f122fde4faff32b2234b602bb37dbecf
-  data.tar.gz: 71aa736312930bf945f8af1e021430e4ff9ce23be9a12402a3ec046c272f5055
+  metadata.gz: 45d89af8ee783dbbc7fe8e465de5b5d8915960c0893b5ee809c1b88b2848ce56
+  data.tar.gz: 9b31fbc3c918b06070ae7ebca455521c7b2226a0f672d7d04799e6dc3017153e
 SHA512:
-  metadata.gz: fa2b26d81b024bd82cdeab5fc643072f4c4b1120cd96720a41926e5bafcc49c535b9df25242f534c99448a501000d3c30fd8331777f2eff03720472c3747182f
-  data.tar.gz: 2153244b482b08beb7234df2dd91fc542f438b6a814016ccdec68c32bd818e92744165bf10b87fa6a4d5167d30106a9bc7bcd4b259ab05eecb581112cbe8b2ab
+  metadata.gz: 5bcc37f94f6a7e24d97027fe78ac821d7398ddc8375c290b885ec6ee7699fd63c675f6a0d103e139081324e4df96b1d382127d94ff1f36aa9a701aa26199a09a
+  data.tar.gz: 814630dbef4a3d1afceab3bb0a3395f3075cf73adf48172192dc733cb116a8e430eac9d41be304c675d7180b756eeb4222f35a72e03df569b694a8b9e054256c

data/README.md

@@ -85,6 +85,8 @@ move(x,y)      | Move the pane by `x`and `y` (`mypane.move(-4,5)` will move the
 refresh        | Refreshes/redraws the Pane with content
 edit           | An editor for the Pane. When this is invoked, all existing font dressing is stripped and the user gets to edit the raw text. The user can add font effects similar to Markdown; Use an asterisk before and after text to be drawn in bold, text between forward-slashes become italic, and underline before and after text means the text will be underlined, a hash-sign before and after text makes the text reverse colored. You can also combine a whole set of dressings in this format: `<23,245,biurl|Hello World!>` - this will make "Hello World!" print in the color 23 with the background color 245 (regardless of the Pane's fg/bg setting) in bold, italic, underlined, reversed colored and blinking. Hitting `ESC` while in edit mode will disregard the edits, while `Ctrl-S` will save the edits
 editline       | Used for one-line Panes. It will print the content of the property `prompt` and then the property `text` that can then be edited by the user. Hitting `ESC` will disregard the edits, while `ENTER` will save the edited text
+puts(text)     | Short form for setting panel.text, then doing a refresh of that panel
+ask(prompt,text) | Short form of setting panel.prompt, then panel.text, doing a panel.editline and then returning panel.text
 
 # class String extensions
 Method extensions provided for the class String:
@@ -204,7 +206,7 @@ while $stdin.ready?
   chr += $stdin.getc
 end
 ```
-You can also pass two parameters to `getchr` with `getchr(min, time)` where `min` instructs getchr to wait for the minimum number of characters to return (not very useful) - and `time` is the timeout for waiting (can be very useful). You can happily call `getchr` without these parameters.
+You can also pass a timeout to `getchr` with `getchr(time)` to wait for `time` number of seconds and returning `nil` if the user does not press a key.
 
 
 # Example

data/lib/rcurses/input.rb

@@ -1,11 +1,20 @@
 module Rcurses
   module Input
-    def getchr(m = nil, t = nil)
-      # Function to process key presses
-      c = $stdin.getch(min: m, time: t)
+    def getchr(t = nil)
+      begin
+        # If a timeout is provided, wrap the blocking getch call in Timeout.timeout.
+        c = t ? Timeout.timeout(t) { $stdin.getch } : $stdin.getch
+      rescue Timeout::Error
+        return nil
+      end
+
+      # Process the character (including escape sequences)
       case c
       when "\e"    # ANSI escape sequences
-        return "ESC" if !$stdin.ready?
+        # Check quickly for any following bytes
+        unless IO.select([$stdin], nil, nil, 0.001)
+          return "ESC"
+        end
         second_char = $stdin.getc
         case second_char
         when '['   # CSI
@@ -34,7 +43,8 @@ module Rcurses
           when '4', '8'
             fourth_char = $stdin.getc
             chr = fourth_char == '~' ? "END" : ""
-          else chr = ""
+          else
+            chr = ""
           end
         when 'O'   # Function keys
           third_char = $stdin.getc
@@ -48,7 +58,8 @@ module Rcurses
         else
           chr = ""
         end
-      when "\r" then chr = "ENTER"
+      # Treat both "\r" and "\n" as Enter
+      when "\r", "\n" then chr = "ENTER"
       when "\t" then chr = "TAB"
       when "\u007F", "\b" then chr = "BACK"
       when "\u0001" then chr = "C-A"
@@ -59,7 +70,6 @@ module Rcurses
       when "\u0006" then chr = "C-F"
       when "\u0007" then chr = "C-G"
       when "\u0008" then chr = "C-H"
-      when "\u000A" then chr = "C-J"
       when "\u000B" then chr = "C-K"
       when "\u000C" then chr = "C-L"
       when "\u000D" then chr = "C-M"
@@ -79,7 +89,9 @@ module Rcurses
       when /[[:print:]]/ then chr = c
       else chr = ""
       end
+
       chr
     end
   end
 end
+

data/lib/rcurses/pane.rb

@@ -32,6 +32,18 @@ module Rcurses
       refresh
     end
 
+    def ask(prompt, text)
+      @prompt = prompt
+      @text   = text
+      editline
+      @text
+    end
+
+    def puts(text)
+      @text = text
+      refresh
+    end
+
     def refresh(cont = @text)
       @max_h, @max_w = IO.console.winsize
 

data/lib/rcurses.rb

@@ -5,10 +5,11 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    2.4.6: Added x,y,w,h at panel creation, not just on refresh
+# Version:    2.4.7: Fixed getchr timeout, added panel function 'ask'
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling
+require 'timeout'
 
 require_relative 'string_extensions'
 require_relative 'rcurses/cursor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: 2.4.6
+  version: 2.4.8
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -29,8 +29,8 @@ description: 'Create curses applications for the terminal easier than ever. Crea
   up text (in panes or anywhere in the terminal) in bold, italic, underline, reverse
   color, blink and in any 256 terminal colors for foreground and background. Use a
   simple editor to let users edit text in panes. Left, right or center align text
-  in panes. Cursor movement around the terminal. New in 2.4.6: Added x,y,w,h at panel
-  creation, not just on refresh.'
+  in panes. Cursor movement around the terminal. New in 2.4.8: Fixed getchr timeout
+  bug, ''ask'' now returns panel.text, added panel function ''puts''.'
 email: g@isene.com
 executables: []
 extensions: []