rcurses 0.2 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c653bbbd37d3eb63b73b4b31610e5c3aa38026fbefab2fe286037597af3edaa
-  data.tar.gz: 3b8114bd0899f50dae09e1deeb107b45293b5fe55c24ff92f07cb9b536288cb1
+  metadata.gz: a0411fe63ee57de3eec47170eb8367708f18ea848fd88ecbe14cca62ae11e40e
+  data.tar.gz: 9b500a1a7df79b63cb7ef0d8a8775ff9ea32dce7354842c6ccbed0623c9566ee
 SHA512:
-  metadata.gz: 75d19d87bdd770831b22f1c507ead604231cf0607ac51932d485411d84e9ff0b02405541c23ccb370e88534384fd67c1220461fd00dfe9179b5266cbbe91118d
-  data.tar.gz: 14872c98ff9edcc649998066d0f817ec306b5caa06e59329ecfad84b0a42c970fa0f2061dfbe5259ed5be9e8d35027b97b0ebf14a1cdb98af00494eb25e318b4
+  metadata.gz: a56c0c656ca11e0e6b5fc4823c6ad427a28bf75b1fc51df12d29ea0cd60b214d2581b8df3354a4d034f0af56b2c0a3ed6c7ba00a914e9aab3bef4645912a4fbf
+  data.tar.gz: 62467880b4c9b8e56ed68070e6d5bc8bd8e0cc3d2050a51f225c22ad6a64aacb3a2e5d64835b377d7269ee428ae612e17e358e1789a343d0d5be80f482e07c24

data/README.md

@@ -1,6 +1,6 @@
 # rcurses - An alternative curses library written in pure Ruby
 
-![Ruby](https://img.shields.io/badge/language-Ruby-red) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
+![Ruby](https://img.shields.io/badge/language-Ruby-red) [![Gem Version](https://badge.fury.io/rb/rcurses.svg)](https://badge.fury.io/rb/rcurses) ![Unlicense](https://img.shields.io/badge/license-Unlicense-green) ![Stay Amazing](https://img.shields.io/badge/Stay-Amazing-important)
 
 <img src="img/rcurses-logo.png" width="150" height="150">
 
@@ -12,9 +12,7 @@ Having struggled with the venerable curses library and the ruby interface to it
 Simple. One file. No external requirements.
 
 # Installation
-Clone this repo and drop `lib/rcurses.rb` into `/usr/lib/ruby/vendor_ruby/`
-
-Or simply run `gem install rcurses`.
+Simply run `gem install rcurses`.
 
 To use this library do:
 ```
@@ -33,18 +31,18 @@ require 'rcurses'
 * The class `Pane` to create and manilpulate panes/boxes
 * Extensions to the class String to print text in various degrees of fancy and also strip any fanciness
 * A module `Cursor` to give you cursor movements around the terminal
-* A top level function `getchr` to capture a single character input from the user (much better than any Ruby built-ins)
+* A module `Rinput` providing the function `getchr` to capture a single character input from the user (much better than any Ruby built-ins)
 
 # class Pane
 To create a pane do something like this:
 ```
-mypane = Pane.new(80, 30, 30, 10, 19, 229)
+mypane = Rcurses::Pane.new(80, 30, 30, 10, 19, 229)
 ```
 This will create a pane/box starting at terminal column/x 80 and row/y 30 with the width of 30 characters and a hight of 10 characters and with the foreground color 19 and background color 229 (from the 256 choices available)
 
 The format for creating a pane is:
 ```
-Pane.new(startx, starty, width, height, foregroundcolor, backgroundcolor)
+Rcurses::Pane.new(startx, starty, width, height, foregroundcolor, backgroundcolor)
 ```
 You can drop the last two 256-color codes to create a pane with the defaults for your terminal. Also, you can add anything as `startx`, `starty`, `width` or `height` as those values will be run through a Ruby eval and stored in readable variables `x`, `y`, `w` and `h` respectively. So, a hight value of "@maxrow/2" is valid to create a pane with the height of half the terminal height (the integer corresponding to half the terminal height will then be accessible as the variable `h`). Use the variables @maxrow for terminal height and @maxcol for terminal width.
 
@@ -95,6 +93,8 @@ r              | Set text to be printed in reverse colors (example: `"TEST".r`)
 c(code)        | Use coded format like "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45 (the format is `.c("fg,bg,biulr"))
 pure           | Strip text of any "dressing" (example: with `text = "TEST".b`, you will have bold text in the variable `text`, then with `text.pure` it will show "uncoded" or pure text)
 
+PS: Blink does not work in conjunction with setting a background color in urxvt. It does work in gnome-terminal. But the overall performance in urxvt as orders of magnitude better than gnome-terminal.
+
 # module Cursor
 Create a new cursor object with `mycursor = Cursor`. Then you can apply the following methods to `mycursor`:
 
@@ -121,10 +121,14 @@ scroll_up         | Scroll display up one line
 scroll_down       | Scroll display down one line
 clear_screen_down | Clear screen down from current row
 
-# function getchr
+# Rinput::getchr
 rcurses provides a vital extension to Ruby in reading characters entered by the user. This is especially needed for curses applications where readline inputs are required.
 
-Simply use `chr = getchr` in a program to read any character input by the user. The returning code (the content of `chr` in this example could be any of the following:
+To include this into your curses program, first:
+```
+include Rinput
+```
+Then simply use `chr = getchr` in a program to read any character input by the user. The returning code (the content of `chr` in this example could be any of the following:
 
 Key pressed     | string returned
 ----------------|----------------------------------------------------------
@@ -190,6 +194,19 @@ while $stdin.ready?
 end
 ```
 
+# Example
+
+Try this in `irb`:
+```
+require 'rcurses'
+mypane = Pane.new("@maxcol/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
+mypane.edit
+```
+... and then try to add some bold text by enclosing it in '*' and italics by enclosing text in '/'. Then press 'ctrl-s' to save your edited text - and then type `mypane.refresh` to see the result.
+
 # Not yet implemented
 Let me know what other features you like to see.
 

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.4'
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies: []
-description: Create panes (with the colors and(or border), manipulate the panes and
+description: 'Create panes (with the colors and(or border), manipulate the panes and
   add content. Dress 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.
+  center align text in panes. Cursor movement around the terminal. New in 0.4: Code-reorganization
+  and bugfix.'
 email: g@isene.com
 executables: []
 extensions: