rcurses 2.4.1 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c231359439921bfa6f6da0d36db67cf20daf67054031b64b1362cf17a121f36
-  data.tar.gz: 07af990392aca529a25aec404f3a92db948eb64dddd4811c8b9f6f80adca5d55
+  metadata.gz: 72fa40a32c3bd2d5b8d9b877570cef06ac7717923e5ceb00beb25ff604042d6f
+  data.tar.gz: 4d98c839744b9715286ab94fe4d3f0e71c9c6ac2b755d9642b7ba2957c943200
 SHA512:
-  metadata.gz: c3d9d2f610c73f034474376e98aac7c63180e6ad1d224f8a0f57898ede77c37679548845b1d21e68f18aa59d187b64808ea417a3a1821b14a78041f35703c1f8
-  data.tar.gz: 006b678e16cd6108fc615cb87e7d7937d88d1e556407e7258a6e6b68a9d0d911652277b8ece6e08f11e6479527b081d994d486dfcd72d9fed592ef6bb5995803
+  metadata.gz: 530c8e9aa1f37ff1fabf89b70c03a6e572afddf6905d3a79d8c5a2f1e9f0ae582499e37168a9585b7e3ff0da1a49c6426e281fbc56d54884dd3cc610bd3575e9
+  data.tar.gz: b9d7694f652427485d65317c931da8399139fdc25436e2526c91ef37b835bda2ed9ef7fe1a4652f9ba1dd6fe50ca3fdf42b7990b578617a3ebed0426868aa016

data/README.md

@@ -101,6 +101,8 @@ l              | Set text to be printed blinking (example: `"TEST".l`)
 r              | Set text to be printed in reverse colors (example: `"TEST".r`)
 c(code)        | Use coded format like "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45 (the format is `.c("fg,bg,biulr"))
 pure           | Strip text of any "dressing" (example: with `text = "TEST".b`, you will have bold text in the variable `text`, then with `text.pure` it will show "uncoded" or pure text)
+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
 
 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.
 
@@ -121,8 +123,8 @@ up(n = 1)         | Move cursor up by n (default is 1 character up)
 down(n = 1)       | Move cursor down by n (default is 1 character down)
 left(n = 1)       | Move cursor backward by n (default is one character)
 right(n = 1)      | Move cursor forward by n (default is one character)
-next_line)        | Move cursor down to beginning of next line
-prev_line)        | Move cursor up to beginning of previous line
+next_line         | Move cursor down to beginning of next line
+prev_line         | Move cursor up to beginning of previous line
 clear_char(n = 1) | Erase n characters from the current cursor position (default is one character)
 clear_line        | Erase the entire current line and return to beginning of the line
 clear_line_before | Erase from the beginning of the line up to and including the current cursor position
@@ -202,6 +204,8 @@ 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.
+
 
 # Example
 

data/lib/rcurses/input.rb

@@ -1,8 +1,8 @@
 module Rcurses
   module Input
-    def getchr
+    def getchr(m = nil, t = nil)
       # Function to process key presses
-      c = $stdin.getch
+      c = $stdin.getch(min: m, time: t)
       case c
       when "\e"    # ANSI escape sequences
         return "ESC" if !$stdin.ready?

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: Show cursor on edit. Changed hide_cursor and show_cursor to hide and show.
+# Version:    2.4.2: Added parameters 'min' and 'time' to getchr
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling

data/lib/string_extensions.rb

@@ -1,5 +1,5 @@
 class String
-  # Add coloring to strings (with escaping for Readline)
+  # Existing methods...
   def fg(fg)    ; color(self, "\e[38;5;#{fg}m", "\e[0m")  ; end
   def bg(bg)    ; color(self, "\e[48;5;#{bg}m", "\e[0m")  ; end
   def fb(fg, bg); color(self, "\e[38;5;#{fg};48;5;#{bg}m"); end
@@ -8,10 +8,13 @@ class String
   def u         ; color(self, "\e[4m", "\e[24m")          ; end
   def l         ; color(self, "\e[5m", "\e[25m")          ; end
   def r         ; color(self, "\e[7m", "\e[27m")          ; end
+
   # Internal function
-  def color(text, sp, ep = "\e[0m"); "#{sp}#{text}#{ep}"; end
+  def color(text, sp, ep = "\e[0m")
+    "#{sp}#{text}#{ep}"
+  end
 
-  # Use format "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45
+  # Use format "TEST".c("204,45,bui") to print "TEST" in bold, underline, italic, fg=204 and bg=45
   def c(code)
     prop = "\e["
     prop += "38;5;#{code.match(/^\d+/).to_s};"      if code.match(/^\d+/)
@@ -31,4 +34,69 @@ class String
   def pure
     self.gsub(/\e\[\d+(?:;\d+)*m/, '')
   end
+
+  # Shortens the visible (pure) text to n characters, preserving any ANSI sequences.
+  def shorten(n)
+    count = 0
+    result = ""
+    i = 0
+    while i < self.length && count < n
+      if self[i] == "\e" # start of an ANSI escape sequence
+        if m = self[i..-1].match(/\A(\e\[\d+(?:;\d+)*m)/)
+          result << m[1]
+          i += m[1].length
+        else
+          # Fallback if pattern doesn’t match: treat as a normal character.
+          result << self[i]
+          i += 1
+          count += 1
+        end
+      else
+        result << self[i]
+        count += 1
+        i += 1
+      end
+    end
+    result
+  end
+
+  # Injects the given string at the given visible character position.
+  # A negative position is treated as an insertion at the end.
+  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
+
+    count = 0
+    result = ""
+    i = 0
+    injected = false
+
+    while i < self.length
+      if self[i] == "\e" # ANSI escape sequence – copy whole sequence without counting
+        if m = self[i..-1].match(/\A(\e\[\d+(?:;\d+)*m)/)
+          result << m[1]
+          i += m[1].length
+        else
+          result << self[i]
+          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
+        end
+        result << self[i]
+        count += 1
+        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
+    result
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.5
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 2025-03-20 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: Show cursor on edit.
-  Changed hide_cursor and show_cursor to hide and show. 2.4.1: Minor fixes'
+  in panes. Cursor movement around the terminal. New in 2.4.5: Added functions ''shorten''
+  and ''inject'' to the string class.'
 email: g@isene.com
 executables: []
 extensions: []