curses-extension 1.1.4 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ace1645f195ea2d92bbf0cb9b84955194bfc10d1eaee5f9d535a0dd8c18668
-  data.tar.gz: 9b2b5cc6e581753260fd16c9a474f0bdf19fc108a050d1e64671212009eb42f4
+  metadata.gz: a7498f40bb4872284aeb236f6a5d585e57ec07f221c932170b33a07c4dd356ae
+  data.tar.gz: b9cd6a36554a25fd3b8c2c7de39a48f74496b04700d017e90cfdc0c9833095d4
 SHA512:
-  metadata.gz: 49d8d315491a99d4c3cb343d10d2d0c8f1bdce3d988458e9fdea17a38b213822accc77e49ac5f517c329a987131e13fc8cb761d12f64259f7bed05e683a7dd6a
-  data.tar.gz: 2a1de1c02140013d55fd8ae130ab55267ba80a5ba3374727aac41ad1d9652031a1a853127a5d67fdea1799287237457b55217cac3891df3861747e67fe2d4aed
+  metadata.gz: 5e6222c8fe2dd03a9746693722cafa3a3faf875c76cf1acdaaad62d7d4d7d4601e60d8c6dc134bdfbdcb52e06d074923b3243c614306b2e258aecdbd7f183221
+  data.tar.gz: 8afba7364535e4f10b1a670908c45c5d94ae1b6ee025aa3b1ebc0c8947e23ce34343745378f7d3136b828d70b886ea87f747623e918770598a41f37447810b55

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

@@ -88,4 +88,18 @@ 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

data/lib/curses-template.rb

@@ -117,6 +117,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
 
 def getchr # PROCESS KEY PRESSES

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses-extension
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: '1.2'
 platform: ruby
 authors:
 - Geir Isene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2023-01-25 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.2: Added functions `print`, `puts`and
+  `format`.'
 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