curses-extension 2.1 → 2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a272233095a365552a978ea26953df75a91f985ca30a9765f7191338ffc5468
-  data.tar.gz: 6b807771cb90a3bc5bdbec098f01ec31414f55bfdb982cdf88cf3b0b62f33ca2
+  metadata.gz: 42000c1ac48e5ea98e193df0c18c8874146f26e53f671cf84f6338a7dda7cce6
+  data.tar.gz: ec6dad6abda95da23ecbbabc23be1019860f9da2929f6a0f3962baaede26df7c
 SHA512:
-  metadata.gz: 5fa593f92f9cdbb0774350fb4fa2c956f9be7435021c52559770fe2c3c35bb7753d25f35b69e7b192818f3ae795be7705374c3c02e1714f14573d75c1b079ae9
-  data.tar.gz: 445fcf7a916887d489d16835044513c8ad76664bfa9ed7163663a9edb12ca307806b671b7e76f4d847da53613f27e1563fdda69ff62e25d772ea2cde5436463f
+  metadata.gz: 2ab8dbfc99e8d9a93c030b5c1a24390abb8b747911cd3bed0a4495ec4fe67d91ee79d8a0415b08ca42f09a624d92fd2644c8bb6cc8fcd67e075ff3ae5807a92a
+  data.tar.gz: ae787aa46b4e57d114714577ae000992bf7a55c40f90eb6a6ca9982c937a05a7294a9f7f99081f5f4617ce576c0ce473ce9a6c448e8bac1cb5685f3809d88b6e

data/lib/README.md

@@ -1,6 +1,8 @@
 # Ruby-Curses-Class-Extension
 Extending the Ruby Curses module with some obvious needed functionality.
 
+No more fiddling with color pairs. No more manual filling lines or framing.
+
 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
@@ -13,8 +15,18 @@ default foreground, background and attribute for a window (e.g. `win.fg =
 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.
+the text in bold green on a gray background. 
+
+There is also the handy method `nl` that fills the rest of the line with
+spaces and (optional) background color, making it an effective newline.
 
+And then there is the convenient `frame`method that adds a... frame to the
+window.
+
+The `curses-template.rb` contains code that helps you understand how you can
+easily create curses applications in Ruby. It is a fully runnable app that
+doesn't do much - but you can fiddle around with the code and test
+functionality for yourself. 
 
 ## Attributes
 Attribute           | Description
@@ -26,18 +38,22 @@ 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.)
 
 ## Functions
+Parameters in square are optional.
+
 Function							| Description
 ------------------------------------|--------------------------------------------------------
-clr									| Clears window without flicker (win.clear flickers)
-clr_to_cur_line						| Clears the window up to the current line
-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
-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
-format(text)						| Format text so that it linebreaks neatly inside window
+clr							| Clears window without flicker (win.clear flickers)
+clr_to_cur_line				| Clears the window up to the current line
+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
+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). `fg`, `bg` and `attr` are optional parameters
+pclr(text)					| As `p(text)` but also clears the rest of the window
+nl([bg])                    | Newline. Puts spaces with (optional) background colors until the end of the line
+frame([fg],[bg])			| Frame the 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

@@ -75,10 +75,21 @@ class Curses::Window # CLASS EXTENSION
     self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
+  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 frame(fg = self.fg, bg = self.bg)
+    self.setpos(0,0)
+    self.p("┌" + "─"*(self.maxx-2) + "┐")
+    (self.maxy-2).times {self.p("│" + " "*(self.maxx-2) + "│")}
+    self.p("└" + "─"*(self.maxx-2) + "┘")
+  end
   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

data/lib/curses-template.rb

@@ -103,20 +103,32 @@ class Curses::Window # CLASS EXTENSION
     fg   = 255 if fg   == nil
     bg   = 0   if bg   == nil
     attr = 0   if attr == nil
-    cp = Curses::Window.pair(fg, bg)
+    cp   = Curses::Window.pair(fg, bg)
     self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
+  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 frame(fg = self.fg, bg = self.bg)
+    self.setpos(0,0)
+    self.p("┌" + "─"*(self.maxx-2) + "┐")
+    (self.maxy-2).times {self.p("│" + " "*(self.maxx-2) + "│")}
+    self.p("└" + "─"*(self.maxx-2) + "┘")
+  end
   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
 
+# GENERAL FUNCTIONS 
 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
@@ -165,27 +177,51 @@ def getchr # Process key presses
   end
   return chr
 end
-
 def main_getkey # GET KEY FROM USER
   chr = getchr
   case chr
-  when '?' # Show helptext in right window 
-    # Add code to show help text here
-  when 'UP' # Examples of moving up and down in a window
-    @index = @index <= @min_index ? @max_index : @index - 1
+  when '?' # Show helptext in right window - add code to show help text here
+  @w_t.clr
+  @w_t.p("Try pressing 'w'")
+  @w_t.nl
+  @w_t.update = false
+  # Examples of moving up and down in a window
+  # You must set @min_index and @max_index in the main loop of the program 
+  when 'UP' 
+    @w_l.index = @w_l.index <= @min_index ? @max_index : @w_l.index - 1
   when 'DOWN'
-    @index = @index >= @max_index ? @min_index : @index + 1
+    @w_l.index = @w_l.index >= @max_index ? @min_index : @w_l.index + 1
   when 'PgUP'
-    @index -= @w_l.maxy - 2
-    @index = @min_index if @index < @min_index
+    @w_l.index -= @w_l.maxy - 2
+    @w_l.index = @min_index if @w_l.index < @min_index
   when 'PgDOWN'
-    @index += @w_l.maxy - 2
-    @index = @max_index if @index > @max_index
+    @w_l.index += @w_l.maxy - 2
+    @w_l.index = @max_index if @w_l.index > @max_index
   when 'HOME'
-    @index = @min_index
+    @w_l.index = @min_index
   when 'END'
-    @index = @max_index
-  when 'l'
+    @w_l.index = @max_index
+  when 'w' # Shows how you can add a window and get input from there and then close the window
+    maxx = Curses.cols
+    maxy = Curses.lines
+    # Curses::Window.new     (     h,      w,        y,         x)
+    @w_w = Curses::Window.new(     6,     20, maxy/2-3, maxx/2-10)
+    @w_w.fg, @w_w.bg, @w_w.attr = 255, 233, Curses::A_BOLD
+    @w_w.frame
+    @w_w.setpos(4, 7) 
+    @w_w.p(255,130," y/n? ")
+    chrw = getchr
+    case chrw
+    when 'y'
+      @w_w.setpos(4, 7) 
+      @w_w.p(255,22," YES! ")
+    when 'n'
+      @w_w.setpos(4, 7) 
+      @w_w.p(255,52," NO!! ")
+    end
+    chrw = getchr
+    @w_w.close
+  when 'a'
     # ...etc
   when 'r'
     @break = true
@@ -305,13 +341,15 @@ loop do # OUTER LOOP - (catching refreshes via 'r')
     @w_b.fg, @w_b.bg, @w_b.attr = 231, 238, 0
     @w_l.fg, @w_l.bg, @w_l.attr =  46, 234, 0
     @w_r.fg, @w_r.bg, @w_r.attr = 202, 235, 0
+    @w_t.fill
     loop do # INNER, CORE LOOP 
-      @w_t.fill; @w_b.fill; @w_l.fill; @w_r.fill
-
+      @w_b.fill; @w_l.fill; @w_r.fill
       # Example code to write to the panes in various ways
-      @w_t.p("Top window")
-      @w_b.p("Bottom window")
+      @w_t.p("Top window") unless @w_t.update == false
+      @w_b.p("Bottom window - try pressing '?'")
+      @w_l.setpos(@w_l.maxy/2, @w_l.maxx/2-6)
       @w_l.p(196,182,Curses::A_BOLD,"Left window")
+      @w_r.setpos(@w_r.maxy/2, @w_r.maxx/2-7)
       @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.1'
+  version: '2.3'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-07-10 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.1: Simplified'
+  basis for my own curses applications. New in 2.2: Added the method `frame` and made
+  the curses-template.rb more informative and sexy'
 email: g@isene.com
 executables: []
 extensions: []