curses-extension 1.1.4 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ace1645f195ea2d92bbf0cb9b84955194bfc10d1eaee5f9d535a0dd8c18668
-  data.tar.gz: 9b2b5cc6e581753260fd16c9a474f0bdf19fc108a050d1e64671212009eb42f4
+  metadata.gz: 7a03325b4dbf6aa5c2cd506e50e642f62588a07cc543314d98eafce40cb7d2e3
+  data.tar.gz: 2862dc209031c64df476ca07c3bd7fcba8f2929620966492f53f858903f30207
 SHA512:
-  metadata.gz: 49d8d315491a99d4c3cb343d10d2d0c8f1bdce3d988458e9fdea17a38b213822accc77e49ac5f517c329a987131e13fc8cb761d12f64259f7bed05e683a7dd6a
-  data.tar.gz: 2a1de1c02140013d55fd8ae130ab55267ba80a5ba3374727aac41ad1d9652031a1a853127a5d67fdea1799287237457b55217cac3891df3861747e67fe2d4aed
+  metadata.gz: be4ab27081169af7f9219df23272012e287e3f838f78407bc495d7470f522d1c1fd9c945c7b3ce99ea9dd48a81930ab2a7411e76efbe0b11d75da18a86af425d
+  data.tar.gz: 3eaa3fba2972af226cffa6380d55a3a3e034bc0ba8984c2893d6cec6cee7801eafdbbae023c711195217f5def9e48e34450dbf97229762d9a20d1f7b8ad4a6bd

data/lib/README.md

@@ -0,0 +1,31 @@
+# Ruby-Curses-Class-Extension
+Extending the Ruby Curses module with some obvious functionality
+
+## Attributes
+Attribute           | Description
+--------------------|--------------------------------------------------------
+color               | Set the window's color to an already initiated color pair (with `init_pair(index, forground, backround`)
+fg                  | Foreground color for window (0-255)
+bg                  | Background color for window (0-255)
+attr                | Attributes for window (such as Curses::A_BOLD) - string with "\|" (such as Curses::A_BOLD \| Curses::A_UNDERLINE)
+update				| Whether to update the window on the next refresh
+
+## Functions
+Function							| Description
+------------------------------------|--------------------------------------------------------
+clr									| Clears window without flicker (win.clear flickers)
+clr_to_cur_pos						| Clears the window up to the current line
+clr_from_cur_pos					| Clears the rest of the window after the current line
+fill								| Fill window with color as set by :color ( or :bg if not :color is set)
+fill_to_cur_pos						| Fill the window up to the current line
+fill_from_cur_pos					| Fill the rest of the window after the current line
+p(text)								| Write text to window with color or fg/bg and attributes (will handle the exceptions if no colors are set)
+pclr(text)							| As `p(text)` but also clears the rest of the window
+pa(fg, bg, attr, text)				| Write text to window with specified fg, bg and attribute(s)
+paclr(text)							| As `pa(text)` but also clears the rest of the window
+print(text, fg=255, bg=0, attr=0)	| Print text (from current position) with optional attributes
+puts(text, fg=255, bg=0, attr=0)	| Clears window and puts text with optional attributes
+format_text(text)					| Format text so that it linebreaks neatly inside window
+
+## Curses template
+The `curses_template.rb` includes the class extension and serves as the basis for my curses applications.

data/lib/curses-extension.rb

@@ -1,6 +1,6 @@
 class Curses::Window # CLASS EXTENSION 
   # General extensions (see https://github.com/isene/Ruby-Curses-Class-Extension)
-  attr_accessor :color, :fg, :bg, :attr, :update
+  attr_accessor :color, :fg, :bg, :attr, :update, :index
   # Set self.color for an already defined color pair such as: init_pair(1, 255, 3)
   # The color pair is defined like this: init_pair(index, foreground, background)
   # self.fg is set for the foreground color (and is used if self.color is not set)
@@ -88,4 +88,20 @@ class Curses::Window # CLASS EXTENSION
     self.attron(color_pair(self.fg) | self.attr) { self << text }
     self.refresh
   end
+  def puts(text, fg=255, bg=0, attr=0) # Clears window and puts text with optional attributes
+    self.clr
+    self.refresh
+    self.setpos(0, 0)
+    self.print(text, fg, bg, attr)
+  end
+  def print(text, fg=255, bg=0, attr=0) # Print text (from current position) with optional attributes
+    init_pair(fg, fg, bg)
+    self.attron(color_pair(fg) | attr) { self << text }
+    self.refresh
+  end
+  def format_text(text) # Format text so that it linebreaks neatly inside window
+    return "\n" + text.gsub(/(.{1,#{self.maxx}})( +|$\n?)|(.{1,#{self.maxx}})/, "\\1\\3\n")
+  end
 end
+
+# vim: set sw=2 sts=2 et fdm=syntax fdn=2 fcs=fold\:\ :

data/lib/curses-template.rb

@@ -16,20 +16,23 @@
 # | @w_b                          |
 # +-------------------------------+
 
-require 'io/console'
-require 'curses'
-include  Curses
+begin #Basic setup
+  require 'io/console'
+  require 'io/wait'
+  require 'curses'
+  include  Curses
 
-Curses.init_screen
-Curses.start_color
-Curses.curs_set(0)
-Curses.noecho
-Curses.cbreak
-Curses.stdscr.keypad = true
+  Curses.init_screen
+  Curses.start_color
+  Curses.curs_set(0)
+  Curses.noecho
+  Curses.cbreak
+  Curses.stdscr.keypad = true
+end
 
 class Curses::Window # CLASS EXTENSION 
   # General extensions (see https://github.com/isene/Ruby-Curses-Class-Extension)
-  attr_accessor :color, :fg, :bg, :attr, :update
+  attr_accessor :color, :fg, :bg, :attr, :update, :index
   # Set self.color for an already defined color pair such as: init_pair(1, 255, 3)
   # The color pair is defined like this: init_pair(index, foreground, background)
   # self.fg is set for the foreground color (and is used if self.color is not set)
@@ -117,15 +120,30 @@ class Curses::Window # CLASS EXTENSION
     self.attron(color_pair(self.fg) | self.attr) { self << text }
     self.refresh
   end
+  def puts(text, fg=255, bg=0, attr=0) # Clears window and puts text with optional attributes
+    self.clr
+    self.refresh
+    self.setpos(0, 0)
+    self.print(text, fg, bg, attr)
+  end
+  def print(text, fg=255, bg=0, attr=0) # Print text (from current position) with optional attributes
+    init_pair(fg, fg, bg)
+    self.attron(color_pair(fg) | attr) { self << text }
+    self.refresh
+  end
+  def format_text(text) # Format text so that it linebreaks neatly inside window
+    return "\n" + text.gsub(/(.{1,#{self.maxx}})( +|$\n?)|(.{1,#{self.maxx}})/, "\\1\\3\n")
+  end
 end
 
-def getchr # PROCESS KEY PRESSES
-  c = STDIN.getch(min: 0, time: 1)
+def getchr # Process key presses
+  c = STDIN.getch
+  #c = STDIN.getch(min: 0, time: 1) # Use this if you need to poll for user keys
   case c
   when "\e"    # ANSI escape sequences
-    case $stdin.getc
+    case STDIN.getc
     when '['   # CSI
-      case $stdin.getc
+      case STDIN.getc
       when 'A' then chr = "UP"
       when 'B' then chr = "DOWN"
       when 'C' then chr = "RIGHT"
@@ -138,8 +156,8 @@ def getchr # PROCESS KEY PRESSES
       when '7' then chr = "HOME"   ; chr = "C-HOME"   if STDIN.getc == "^"
       when '8' then chr = "END"    ; chr = "C-END"    if STDIN.getc == "^"
       end
-    when 'O'
-      case $stdin.getc
+    when 'O'   # Set Ctrl+ArrowKey equal to ArrowKey; May be used for other purposes in the future
+      case STDIN.getc
       when 'a' then chr = "C-UP"
       when 'b' then chr = "C-DOWN"
       when 'c' then chr = "C-RIGHT"
@@ -147,12 +165,22 @@ def getchr # PROCESS KEY PRESSES
       end
     end
   when "", "" then chr = "BACK"
+  when "" then chr = "C-C"
+  when "" then chr = "C-D"
+  when "" then chr = "C-E"
+  when "" then chr = "C-G"
+  when "" then chr = "C-K"
+  when "" then chr = "C-L"
+  when "" then chr = "C-N"
+  when "" then chr = "C-O"
+  when "" then chr = "C-P"
+  when "" then chr = "C-T"
+  when "" then chr = "C-Y"
   when "" then chr = "WBACK"
   when "" then chr = "LDEL"
-  when "" then chr = "C-T"
   when "\r" then chr = "ENTER"
   when "\t" then chr = "TAB"
-  when /./  then chr = c
+  when /[[:print:]]/  then chr = c
   end
   return chr
 end
@@ -183,6 +211,9 @@ def main_getkey # GET KEY FROM USER
   when 'q' # Exit 
     exit 0
   end
+  while STDIN.ready?
+    chr = STDIN.getc
+  end
 end
 
 # TOP WINDOW FUNCTIONS 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses-extension
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: '1.3'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -35,13 +35,14 @@ description: 'The Ruby curses library is sorely lacking some important features.
   terminal curses applications in Ruby. See the Github page for information on what
   properties and functions are included: https://github.com/isene/Ruby-Curses-Class-Extension.
   The curses_template.rb is also installed in the lib directory and serves as the
-  basis for my own curses applications. New in 1.1.4: In the template, also catch
-  Control+Key sequence'
+  basis for my own curses applications. New in 1.3: Included :index as Class accessor
+  and other improvements'
 email: g@isene.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/README.md
 - lib/curses-extension.rb
 - lib/curses-template.rb
 homepage: https://isene.com/
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Extending the Ruby Curses module with some obvious functionality