curses-extension 2.0 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a1e832808f3f3ffbf4d39755719168b08fbc0c644a7a48840839844b3fca3a4
-  data.tar.gz: 23e73a5413638273336b211d3274a48bdeb21963b7600f0c731968e2269bb343
+  metadata.gz: '04280f3b09961bca34f139e055228c7206b28dcae370c22ae0417dca8fbb5fc2'
+  data.tar.gz: 063e86ad7733dd4c5ee83664a59a3a3dbf59e45bdfda09a8efc1bc4e09cfd392
 SHA512:
-  metadata.gz: 34e132b85309f493f6b31efb216edd963b32c13dea3b62b3ca56df56d50c6eb89dcc8783f3a33aa9f8dea5f951c82c9d966623ccee8f75ccc0cc9197a3826338
-  data.tar.gz: 8237d8b29d71c83a1e13d5a4d679ea3fc55cc80cb2d2f635bba070dd29b8ca4bd06039c79b98eaa6df026bdadcb0a4ce87d3a375c125d782ba9c9531ea075e5f
+  metadata.gz: 65c963c468c4b9101e59f9208815b58bb4d9f7bb07c34298aa1628a3f783de61cf9de186bed60f6b0246bd1f20be7eb9d4bfbb7cede62e7952e33fa17aa6f1bf
+  data.tar.gz: c80f69f856b9a4faacdabf5a3bc8b8f69293b463f1b6f9b308319b98146d7ba6a0516387bb2e65cec4a121bfc96d2b06682851b1fb2b84ef293994e49e170198

data/lib/README.md

@@ -1,13 +1,27 @@
 # Ruby-Curses-Class-Extension
 Extending the Ruby Curses module with some obvious needed functionality.
 
+With this extension, you don't need to initiate any color pairs or add text to
+windows with odd syntax. Use any foreground and backround color you see fit
+and let this extension take care of the weird need to pair colors and initiate
+the color pairs. You also get a bunch of extra methods to manipulate curses
+windows.
+
+With this extension writing text to windows becomes a breeze. You can set
+default foreground, background and attribute for a window (e.g. `win.fg =
+124`, `win.bg = 234` and `win.attr = Curses::A_BOLD`) - and you can write text
+to a window with `win.p("Hello World")` where the defaults will be applied.
+You can override the defaults with e.g. `win.p(124, "Hello World")` to write
+the text in red or `win.p(76, 240, Curses::A_BOLD, "Hello World")` to write
+the text in bold green on a gray background.
+
+
 ## Attributes
 Attribute           | Description
 --------------------|--------------------------------------------------------
 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)
-text				| Holds the text to be written with the `write`method
 update				| Whether to update the window on the next refresh
 index				| Used to track an index for each window (used to display lists such as the content of a directory, etc.)
 
@@ -20,12 +34,10 @@ clr_from_cur_line					| 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
-write								| Write what is already stored in window.text with the set values for fg, bg and attr
-p(text) or puts(test)				| Write text to window with fg/bg and attributes (will handle the exceptions if no colors are set)
+p(fg, bg, attr, text)				| Write text to window with fg/bg and attributes (will handle the exceptions if no colors are set).
+									  You can use `puts` instead of `p` (it's an alias)
 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, fg=255, bg=0, attr=0)	| As `pa(text)` but also clears the rest of the window
-format_text(text)					| Format text so that it linebreaks neatly inside window
+format(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. It is a runnable curses application that does nothing.

data/lib/curses-extension.rb

@@ -8,7 +8,7 @@ class Curses::Window # CLASS EXTENSION
   # self.attr is set for text attributes like Curses::A_BOLD
   # self.update can be used to indicate if a window should be updated (true/false)
   # self.index can be used to keep track of the current list item in a window
-  attr_accessor :fg, :bg, :attr, :text, :update, :index
+  attr_accessor :fg, :bg, :attr, :update, :index
   def self.pair(fg, bg)
     @p = [[]] if @p == nil
     fg = fg.to_i; bg = bg.to_i
@@ -67,38 +67,27 @@ class Curses::Window # CLASS EXTENSION
     self.refresh
     self.setpos(y, x)
   end
-  def write
-    self.attr = 0 if self.attr == nil
-    self.bg = 0 if self.bg   == nil
-    self.fg = 255 if self.fg == nil
-    cp = Curses::Window.pair(self.fg, self.bg)
-    self.attron(color_pair(cp) | self.attr) { self << self.text }
-    self.refresh
-  end
-  def p(text) # Puts text to window
-    self.attr = 0 if self.attr == nil
-    self.bg = 0 if self.bg   == nil
-    self.fg = 255 if self.fg == nil
-    cp = Curses::Window.pair(self.fg, self.bg)
-    self.attron(color_pair(cp) | attr) { self << text }
-    self.refresh
-  end
-  def pclr(text) # Puts text to window and clears the rest of the window
-    self.p(text)
-    self.clr_from_cur_line
-  end
-  def pa(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
+  def p(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
+    fg   = 255 if fg   == nil
+    bg   = 0   if bg   == nil
+    attr = 0   if attr == nil
     cp = Curses::Window.pair(fg, bg)
     self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
-  def paclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
-    self.pa(fg, bg, attr, text)
+  def nl(bg = self.bg)
+    bg = 232 if bg == nil
+    f  = " " * (self.maxx - self.curx)
+    self.p(self.fg, bg, self.attr, f)
+  end
+  def pclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
+    self.p(fg, bg, attr, text)
     self.clr_from_cur_line
   end
-  def format_text(text) # Format text so that it linebreaks neatly inside window
+  def format(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
   alias :puts :p
 end
 
+# vim: set sw=2 sts=2 et fdm=syntax fdn=2 fcs=fold\:\ :

data/lib/curses-template.rb

@@ -40,7 +40,7 @@ class Curses::Window # CLASS EXTENSION
   # self.attr is set for text attributes like Curses::A_BOLD
   # self.update can be used to indicate if a window should be updated (true/false)
   # self.index can be used to keep track of the current list item in a window
-  attr_accessor :fg, :bg, :attr, :text, :update, :index
+  attr_accessor :fg, :bg, :attr, :update, :index
   def self.pair(fg, bg)
     @p = [[]] if @p == nil
     fg = fg.to_i; bg = bg.to_i
@@ -99,36 +99,24 @@ class Curses::Window # CLASS EXTENSION
     self.refresh
     self.setpos(y, x)
   end
-  def write
-    self.attr = 0 if self.attr == nil
-    self.bg = 0 if self.bg   == nil
-    self.fg = 255 if self.fg == nil
-    cp = Curses::Window.pair(self.fg, self.bg)
-    self.attron(color_pair(cp) | self.attr) { self << self.text }
-    self.refresh
-  end
-  def p(text) # Puts text to window
-    self.attr = 0 if self.attr == nil
-    self.bg = 0 if self.bg   == nil
-    self.fg = 255 if self.fg == nil
-    cp = Curses::Window.pair(self.fg, self.bg)
+  def p(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
+    fg   = 255 if fg   == nil
+    bg   = 0   if bg   == nil
+    attr = 0   if attr == nil
+    cp   = Curses::Window.pair(fg, bg)
     self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
-  def pclr(text) # Puts text to window and clears the rest of the window
-    self.p(text)
-    self.clr_from_cur_line
-  end
-  def pa(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
-    cp = Curses::Window.pair(fg, bg)
-    self.attron(color_pair(cp) | attr) { self << text }
-    self.refresh
+  def nl(bg = self.bg)
+    bg = 232 if bg == nil
+    f  = " " * (self.maxx - self.curx)
+    self.p(self.fg, bg, self.attr, f)
   end
-  def paclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
-    self.pa(fg, bg, attr, text)
+  def pclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
+    self.p(fg, bg, attr, text)
     self.clr_from_cur_line
   end
-  def format_text(text) # Format text so that it linebreaks neatly inside window
+  def format(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
   alias :puts :p
@@ -224,9 +212,8 @@ def main_getkey # GET KEY FROM USER
     @w_r.update = false
     cmd = w_b_getstr("◆ ", "")
     begin
-      @w_r.text = eval(cmd)
-      #@w_r.fill
-      @w_r.write
+      @w_r.fill
+      @w_r.p(eval(cmd))
     rescue StandardError => e
       w_b("Error: #{e.inspect}")
     end
@@ -245,8 +232,7 @@ def w_b(info) # SHOW INFO IN @W_B
   info      = "Choose window: i=IMDB list (+/- to add/remove from My list), g=Genres (+/- to add/remove), m=My list. " if info == nil
   info      = info[1..(@w_b.maxx - 3)] + "…" if info.length + 3 > @w_b.maxx 
   info     += " " * (@w_b.maxx - info.length) if info.length < @w_b.maxx
-  @w_b.text = info
-  @w_b.write
+  @w_b.p(info)
   @w_b.update = false
 end
 def w_b_getstr(pretext, text) # A SIMPLE READLINE-LIKE ROUTINE
@@ -257,9 +243,9 @@ def w_b_getstr(pretext, text) # A SIMPLE READLINE-LIKE ROUTINE
   chr = ""
   while chr != "ENTER"
     @w_b.setpos(0,0)
-    @w_b.text = pretext + text
-    @w_b.text += " " * (@w_b.maxx - text.length) if text.length < @w_b.maxx
-    @w_b.write
+    text = pretext + text
+    text += " " * (@w_b.maxx - text.length) if text.length < @w_b.maxx
+    @w_b.p(text)
     @w_b.setpos(0,pretext.length + pos)
     @w_b.refresh
     chr = getchr
@@ -301,8 +287,7 @@ def w_r_info(info) # SHOW INFO IN THE RIGHT WINDOW
   begin
     @w_r.clr
     @w_r.refresh
-    @w_r.text   = info
-    @w_r.write
+    @w_r.p(info)
     @w_r.update = false
   rescue
   end
@@ -329,12 +314,10 @@ loop do # OUTER LOOP - (catching refreshes via 'r')
       @w_t.fill; @w_b.fill; @w_l.fill; @w_r.fill
 
       # Example code to write to the panes in various ways
-      @w_t.text = "Top window"
-      @w_t.write
-      @w_b.pa("Bottom window")
-      @w_l.pa(196,182,Curses::A_BOLD,"Left window")
-      @w_r.text = "Right window"
-      @w_r.write
+      @w_t.p("Top window")
+      @w_b.p("Bottom window")
+      @w_l.p(196,182,Curses::A_BOLD,"Left window")
+      @w_r.p("Right window")
       
       # Top window (info line) 
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses-extension
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.2'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -35,7 +35,8 @@ 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 2.0: Full rewrite/upgrade'
+  basis for my own curses applications. New in 2.2: "Added the method `nl`, an effective
+  newline"'
 email: g@isene.com
 executables: []
 extensions: []