rcurses 2.4.5 → 2.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72fa40a32c3bd2d5b8d9b877570cef06ac7717923e5ceb00beb25ff604042d6f
-  data.tar.gz: 4d98c839744b9715286ab94fe4d3f0e71c9c6ac2b755d9642b7ba2957c943200
+  metadata.gz: c3614072a43262fae0361e5fbca943f1e4da81a13a79b4bc2ea9ca7342d935c9
+  data.tar.gz: 4195f8f7ab5b5183f671487eb9df121a01db6991c4eafb5b5f81c19c0e190b12
 SHA512:
-  metadata.gz: 530c8e9aa1f37ff1fabf89b70c03a6e572afddf6905d3a79d8c5a2f1e9f0ae582499e37168a9585b7e3ff0da1a49c6426e281fbc56d54884dd3cc610bd3575e9
-  data.tar.gz: b9d7694f652427485d65317c931da8399139fdc25436e2526c91ef37b835bda2ed9ef7fe1a4652f9ba1dd6fe50ca3fdf42b7990b578617a3ebed0426868aa016
+  metadata.gz: c1f74c9ae9a72accf1b7cff35f772ca53b61bbc39f56dee8f190ead264fe6dc735e771bcac563832eae17b80452ea5b2098c63be6fbd20e386f18c3727112365
+  data.tar.gz: 06d521b146ed4962f5bd94d4c359bf8811ff1454ec6ede89e42ec2206fc32090186bf8bc8fc9df1acccdc0642f2cec2a5974656817969c76429d2b59f443b013

data/README.md

@@ -85,6 +85,7 @@ 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
+ask(prompt,text) | Short form of setting panel.prompt, then panel.text and then doing a panel.editline
 
 # class String extensions
 Method extensions provided for the class String:
@@ -204,7 +205,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,14 +1,21 @@
 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)
+      # Wait for input up to t seconds; if none, return nil (or a timeout indicator)
+      if t && !IO.select([$stdin], nil, nil, t)
+        return nil
+      end
+
+      c = $stdin.getch
       case c
-      when "\e"    # ANSI escape sequences
-        return "ESC" if !$stdin.ready?
+      when "\e"
+        # For escape sequences, use a very short timeout to check for extra bytes
+        unless IO.select([$stdin], nil, nil, 0.001)
+          return "ESC"
+        end
         second_char = $stdin.getc
         case second_char
-        when '['   # CSI
+        when '['
           third_char = $stdin.getc
           case third_char
           when 'A' then chr = "UP"
@@ -34,16 +41,18 @@ module Rcurses
           when '4', '8'
             fourth_char = $stdin.getc
             chr = fourth_char == '~' ? "END" : ""
-          else chr = ""
+          else
+            chr = ""
           end
-        when 'O'   # Function keys
+        when 'O'
           third_char = $stdin.getc
           case third_char
           when 'a' then chr = "C-UP"
           when 'b' then chr = "C-DOWN"
           when 'c' then chr = "C-RIGHT"
           when 'd' then chr = "C-LEFT"
-          else chr = ""
+          else
+            chr = ""
           end
         else
           chr = ""

data/lib/rcurses/pane.rb

@@ -13,6 +13,10 @@ module Rcurses
       @starty  = starty.is_a?(Proc) ? starty : -> { starty }
       @width   = width.is_a?(Proc)  ? width  : -> { width  }
       @height  = height.is_a?(Proc) ? height : -> { height }
+      @x       = @startx.call
+      @y       = @starty.call
+      @w       = @width.call
+      @h       = @height.call
       @fg, @bg = fg, bg
       @text    = ""              # Initialize text variable
       @align   = "l"             # Default alignment
@@ -28,6 +32,12 @@ module Rcurses
       refresh
     end
 
+    def ask(prompt, text)
+      @prompt = prompt
+      @text   = text
+      editline
+    end
+
     def refresh(cont = @text)
       @max_h, @max_w = IO.console.winsize
 

data/lib/rcurses.rb

@@ -5,7 +5,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    2.4.2: Added parameters 'min' and 'time' to getchr
+# Version:    2.4.7: Fixed getchr timeout, added panel function 'ask'
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling

data/lib/string_extensions.rb

@@ -60,10 +60,11 @@ class String
     result
   end
 
-  # Injects the given string at the given visible character position.
-  # A negative position is treated as an insertion at the end.
+  # Inserts the given substring at the provided visible character position.
+  # A negative position means insertion at the end.
+  # When inserting at the end and the string ends with an ANSI escape sequence,
+  # the insertion is placed before that trailing ANSI sequence.
   def inject(insertion, pos)
-    # Work on visible text; if pos is negative, set it to the length (i.e. end).
     pure_text = self.pure
     visible_length = pure_text.length
     pos = visible_length if pos < 0
@@ -74,7 +75,7 @@ class String
     injected = false
 
     while i < self.length
-      if self[i] == "\e" # ANSI escape sequence – copy whole sequence without counting
+      if self[i] == "\e"  # Start of an ANSI sequence.
         if m = self[i..-1].match(/\A(\e\[\d+(?:;\d+)*m)/)
           result << m[1]
           i += m[1].length
@@ -83,7 +84,6 @@ class String
           i += 1
         end
       else
-        # At the point when we've output exactly pos visible characters, do the injection.
         if count == pos && !injected
           result << insertion
           injected = true
@@ -93,10 +93,18 @@ class String
         i += 1
       end
     end
-    # In case pos equals the total visible length (i.e. insertion at the end) and
-    # no injection has occurred inside the loop, append now.
-    result << insertion unless injected
+
+    # If we haven't injected (i.e. pos equals visible_length),
+    # check for a trailing ANSI sequence and insert before it.
+    unless injected
+      if result =~ /(\e\[\d+(?:;\d+)*m)\z/
+        trailing = $1
+        result = result[0...-trailing.length] + insertion + trailing
+      else
+        result << insertion
+      end
+    end
+
     result
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.4.7
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-03-22 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.5: Added functions ''shorten''
-  and ''inject'' to the string class.'
+  in panes. Cursor movement around the terminal. New in 2.4.7: Fixed getchr timeout,
+  added panel function ''ask''.'
 email: g@isene.com
 executables: []
 extensions: []