rcurses 2.4.7 → 2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3614072a43262fae0361e5fbca943f1e4da81a13a79b4bc2ea9ca7342d935c9
-  data.tar.gz: 4195f8f7ab5b5183f671487eb9df121a01db6991c4eafb5b5f81c19c0e190b12
+  metadata.gz: d761408b4f05dc23d8ce7bbccee6e205f197a7121755ecda26a12f07cf1c3270
+  data.tar.gz: 0abd1a9a7b67cb96a9a00c537d17c414f8ceb78e78747627cd49305bf22bf57f
 SHA512:
-  metadata.gz: c1f74c9ae9a72accf1b7cff35f772ca53b61bbc39f56dee8f190ead264fe6dc735e771bcac563832eae17b80452ea5b2098c63be6fbd20e386f18c3727112365
-  data.tar.gz: 06d521b146ed4962f5bd94d4c359bf8811ff1454ec6ede89e42ec2206fc32090186bf8bc8fc9df1acccdc0642f2cec2a5974656817969c76429d2b59f443b013
+  metadata.gz: 641587c5622dee1f388f027a3bbec71f5072a74cdbe0ed7dc26fcc33e17fc112a22422d81785f32ca3d46398130809d44cd6f6f3f831819fd005bee791735b77
+  data.tar.gz: e6b7d6ccb2024490326d3a2452a361b8886b5518f0c9a2d8015f79345911cbc7898b64ecf228333dd6099631c9214aa09a56ea9a8d089fa30d02494f802a85fa

data/README.md

@@ -43,12 +43,10 @@ This will create a pane/box starting at terminal column/x 80 and row/y 30 with t
 
 The format for creating a pane is:
 ```
-Rcurses::Pane.new(startx, starty, width, height, foregroundcolor, backgroundcolor)
+Rcurses::Pane.new(x, y, w, h, fg, bg)
 ```
 You can drop the last two 256-color codes to create a pane with the defaults for your terminal. 
 
-You can add anything as `startx`, `starty`, `width` or `height` as those values will be evaluated and stored in readable variables `x`, `y`, `w` and `h` respectively. 
-
 By adding values for the terminal size in your program:
 ```
 @max_h, @max_w = IO.console.winsize
@@ -59,14 +57,10 @@ Avaliable properties/variables:
 
 Property       | Description
 ---------------|---------------------------------------------------------------
-startx         | The `x` value to be "Eval-ed"
-x              | The readable x-value for the Pane
-starty         | The `y` value to be "Eval-ed"
-y              | The readable y-value for the Pane
-width          | The Pane width to be "Eval-ed"
-w              | The readable w-value for the Pane
-height         | The Pane height to be "Eval-ed"
-h              | The readable h-value for the Pane
+x              | The x (column) position of the Pane
+y              | The y (row) position of the Pane
+w              | The width of the Pane
+h              | The heigth of the Pane
 fg             | Foreground color for the Pane
 bg             | Background color for the Pane
 border         | Draw border around the Pane (=true) or not (=false), default being false
@@ -80,12 +74,13 @@ The methods for Pane:
 
 Method         | Description
 ---------------|---------------------------------------------------------------
-new/init       | Initializes a Pane with optional arguments startx, starty, width, height, foregroundcolor and backgroundcolor
+new/init       | Initializes a Pane with optional arguments `x, y, w, h, fg and bg`
 move(x,y)      | Move the pane by `x`and `y` (`mypane.move(-4,5)` will move the pane left four characters and five characters down)
 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
+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:
@@ -214,7 +209,7 @@ Try this in `irb`:
 ```
 require 'rcurses'
 @max_h, @max_w = IO.console.winsize
-mypane = Pane.new(@maxw/2, 30, 30, 10, 19, 229)
+mypane = Pane.new(@max_w/2, 30, 30, 10, 19, 229)
 mypane.border = true
 mypane.text = "Hello".i + " World!".b.i + "\n \n" + "rcurses".r + " " + "is cool".c("16,212")
 mypane.refresh

data/lib/rcurses/input.rb

@@ -1,21 +1,23 @@
 module Rcurses
   module Input
     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)
+      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
 
-      c = $stdin.getch
+      # Process the character (including escape sequences)
       case c
-      when "\e"
-        # For escape sequences, use a very short timeout to check for extra bytes
+      when "\e"    # ANSI escape sequences
+        # 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 '['
+        when '['   # CSI
           third_char = $stdin.getc
           case third_char
           when 'A' then chr = "UP"
@@ -44,20 +46,20 @@ module Rcurses
           else
             chr = ""
           end
-        when 'O'
+        when 'O'   # Function keys
           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 = ""
         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"
@@ -68,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"
@@ -88,7 +89,9 @@ module Rcurses
       when /[[:print:]]/ then chr = c
       else chr = ""
       end
+
       chr
     end
   end
 end
+

data/lib/rcurses/pane.rb

@@ -3,20 +3,14 @@ module Rcurses
     require 'clipboard'  # Ensure the 'clipboard' gem is installed
     include Cursor
     include Input
-    attr_accessor :startx, :starty, :width, :height, :fg, :bg
-    attr_accessor :x, :y, :w, :h
+    attr_accessor :x, :y, :w, :h, :fg, :bg
     attr_accessor :border, :scroll, :text, :ix, :align, :prompt
 
-    def initialize(startx = 1, starty = 1, width = 1, height = 1, fg = nil, bg = nil)
-      # Using Procs or Lambdas instead of eval
-      @startx  = startx.is_a?(Proc) ? startx : -> { startx }
-      @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
+    def initialize(x = 1, y = 1, w = 1, h = 1, fg = nil, bg = nil)
+      @x       = x
+      @y       = y
+      @w       = w
+      @h       = h
       @fg, @bg = fg, bg
       @text    = ""              # Initialize text variable
       @align   = "l"             # Default alignment
@@ -27,8 +21,8 @@ module Rcurses
     end
 
     def move(x, y)
-      @startx = -> { @x + x }
-      @starty = -> { @y + y }
+      @x += x
+      @y += y
       refresh
     end
 
@@ -36,6 +30,12 @@ module Rcurses
       @prompt = prompt
       @text   = text
       editline
+      @text
+    end
+
+    def puts(text)
+      @text = text
+      refresh
     end
 
     def refresh(cont = @text)
@@ -137,10 +137,6 @@ module Rcurses
 
       # Start the actual refresh
       o_row, o_col = pos
-      @x = @startx.call
-      @y = @starty.call
-      @w = @width.call
-      @h = @height.call
 
       # Adjust pane dimensions and positions
       if @border # Keep panes inside screen
@@ -410,10 +406,6 @@ module Rcurses
         Rcurses::Cursor.show
 
         # Initialize position and dimensions
-        @x = @startx.call
-        @y = @starty.call
-        @w = @width.call
-        @h = @height.call
         # Ensure pane is within screen bounds
         @x = [[@x, 1].max, @max_w - @w + 1].min
         @y = [[@y, 1].max, @max_h - @h + 1].min

data/lib/rcurses.rb

@@ -9,6 +9,7 @@
 
 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.7
+  version: '2.5'
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-03-26 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.7: Fixed getchr timeout,
-  added panel function ''ask''.'
+  in panes. Cursor movement around the terminal. New in 2.5: Simplified the over-engineering,
+  removing startx, starty, width and height of pane creation.'
 email: g@isene.com
 executables: []
 extensions: []