rndk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8f9ad279e8103fa755fa296a6ce77f841d44447
-  data.tar.gz: 645cac649bc64fc804541c71868800aa28b172e4
+  metadata.gz: 658d93a038f41e69767bd1f8a24f0ed69ab21d61
+  data.tar.gz: 085b8d4cf88241e7ed481736a8356be356341628
 SHA512:
-  metadata.gz: 66e6a0f5bdda584d982e13ecb89643c09f0acc07061c9de05912ecdaff70abf22163d87eba05fd4405d5fbff2672e75188cf07d37a7a22d121a65386612f5a12
-  data.tar.gz: 6ab7a46f6aa062a58d3b79a7620665eae38e1b0f6bfbeff64eaa4fd31a78d5dd700b5c9845789b12fda15c7ca77a27e8e8a2976338e1ebf1ee6f3d319b46f457
+  metadata.gz: f632241c52b6accf9e017d3e2d8e26e7836d46fcbcbfcd14a3dfa8b092da98fd69500be4921a8744f87d8ecaef19bb1aacfb6cfd0e599deb227b1612242e35e1
+  data.tar.gz: 4b18178e17b1ab81820caaf5a79fc0ab0bf66f31dfb2bf92f47c1b517fe2ced0a8c594dfb50573a391117b2b0197ace571d152257bdd05a0024c0e1710cb88c7

data/.gitignore

@@ -21,3 +21,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/README.md

@@ -1,4 +1,5 @@
 # Ruby Ncurses Development Kit (RNDK)
+[![Gem Version](https://badge.fury.io/rb/rndk.png)](http://badge.fury.io/rb/rndk)
 
 `rndk` aims to be a powerful, well-documented and easy-to-use
 Ncurses Development Kit in Ruby. Besides abstracting away Ncurses'
@@ -10,51 +11,50 @@ applications, easily creating nice apps for the console.
 `RNDK` is a fork from `tawny-cdk`, a [Chris Sauro Ruby port][tawny]
 of [Thomas Dickey's Curses Development Kit][cdk] (in C).
 
-Currently implemented widgets:
-
- * Alphalist
- * Button
- * Buttonbox
- * Calendar
- * Dialog
- * Entry
- * File Selector
- * Graph
- * Histogram
- * Item List
- * Label
- * Matrix
- * Marquee
- * Menu
- * Multiple Line Entry
- * Radio List
- * Scale
- * Scrolling List
- * Scrolling Window
- * Selection List
- * Slider
- * Template
- * Viewer
+Here's the list of currently implemented widgets:
+
+| Widget                | Description                                     | Has examples? |
+| --------------------- | ----------------------------------------------- | ------------- |
+| Alphalist             | Scrolling list of alphabetically sorted words   | not yet       |
+| Button                | Message attached to a callback                  | not yet       |
+| Buttonbox             | Labeled set of buttons                          | not yet       |
+| Calendar              | Pop-up traversable calendar                     | yes!          |
+| Dialog                | Dialog box with a message and some buttons      | not yet       |
+| Entry                 | Text-entry box with a label                     | yes!          |
+| File Selector         | Interact graphically with the file system       | not yet       |
+| Graph                 | Plots a graph with x/y coordinates              | not yet       |
+| Histogram             | Vertical/horizontal histogram                   | not yet       |
+| Item List             | Select from a preset item list                  | not yet       |
+| Label                 | Pop-up label window                             | yes!          |
+| Matrix                | Matrix widget                                   | not yet       |
+| Marquee               | Movable text                                    | not yet       |
+| Menu                  | Pull-down menu list                             | not yet       |
+| Multiple Line Entry   | Multiple-line entry box with a label            | not yet       |
+| Radio List            | Radio item list                                 | not yet       |
+| Scale                 | Draggable scale box with a label                | not yet       |
+| Scrolling List        | Scrolling item list                             | yes!          |
+| Scrolling Window      | Display scrollable long messages                | not yet       |
+| Selection List        | Selection list widget                           | not yet       |
+| Slider                | Visual slider box                               | yes!          |
+| Template              | Insert info on a field with a pre-set format    | not yet       |
+| Viewer                | View contents of a file on a scrollable box     | not yet       |
+
+The ones with examples (on the root `examples` directory) are ready to use.
+The others are kinda unstable, since the API is being completely rewritten.
+Also, [click here for screenshots][widgets]!
 
 ## WARNING
 
-This is a very unstable Work-in-Progress library.
+This is a very unstable Work-in-Progress library. I'm currently reviewing
+`tawny-cdk`'s API, so a lot of things are changing real fast.
 
-I'm currently reviewing `tawny-cdk`'s API, so a lot of things are
-changing real fast.
+Be sure to know that whenever I remove this notice, things will be nicer. For
+now, I recommend you to **not** use `rndk` for production programs!
 
-Be sure to know that whenever I remove this notice, things will be
-nicer.
-
-For now, I recommend you to **not** use `rndk` for production
-programs!
-
-## Requirements
+## Installation
 
 `rndk` requires the gem `ffi-ncurses`.
 
-## Installation
-
 Add this line to your application's Gemfile:
 
     gem 'rndk'
@@ -69,26 +69,34 @@ Or install it yourself as:
 
 ## Usage
 
+[Take a look at the Wiki][wiki]! There's some tutorials and
+resources there.
+
 The `examples` directory contains lots of sample usages for every
 widget available. To execute them, go to the `rndk` root folder
 and run:
 
     ruby -Ilib examples/YOUR_EXAMPLE_HERE
 
-There's also some more comples demo applications under the `demos`
+There's also some more complex demo applications under the `demos`
 directory. Do the same:
 
     ruby -Ilib demos/YOUR_DEMO_HERE
 
 ## Contributing
 
+Any help would be largely appreciated! For a list of things
+to do, see the `TODO` file.
+
 Currently `rndk` has a C-like API, since it was directly taken
-from `cdk`. The top priority is to make it more rubyish (maybe
-studying [rbcurse]?).
+from `cdk`. The top priority is to make it more rubyish.
+
+I'm getting inspiration from [rbcurse] and some non-ruby Widget
+sets.
 
-Also, see the `TODO` file.
+Step-by-step guide to contribute:
 
-1. Fork it
+1. Fork this repository
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -97,4 +105,15 @@ Also, see the `TODO` file.
 [tawny]:https://github.com/masterzora/tawny-cdk
 [cdk]:http://invisible-island.net/cdk/
 [rbcurse]:https://github.com/rkumar/rbcurse
+[wiki]:https://github.com/alexdantas/rndk/wiki
+[widgets]:https://github.com/alexdantas/rndk/wiki/widgets
+
+## Contact
+
+Hi, I'm Alexandre Dantas! Thanks for having interest in this project. Please
+take the time to visit any of the links below.
+
+* `rndk` homepage: http://www.alexdantas.net/projects/rndk
+* Contact: `eu @ alexdantas.net`
+* My homepage: http://www.alexdantas.net
 

data/demos/appointment.rb

@@ -175,7 +175,7 @@ class Appointment
       marker = Appointment::GPAppointmentAttributes[selection]
 
       # Create the entry field for the description.
-      entry = RNDK::ENTRY.new(calendar.screen,
+      entry = RNDK::Entry.new(calendar.screen,
                               RNDK::CENTER,
                               RNDK::CENTER,
                               '<C>Enter a description of the appointment.',
@@ -292,7 +292,7 @@ class Appointment
       end
 
       # Create the label widget
-      label = RNDK::LABEL.new(calendar.screen, RNDK::CENTER, RNDK::CENTER, mesg, true, false)
+      label = RNDK::Label.new(calendar.screen, RNDK::CENTER, RNDK::CENTER, mesg, true, false)
       label.draw(label.box)
       label.wait(' ')
       label.destroy

data/demos/clock.rb

@@ -18,7 +18,7 @@ begin
   mesg = ['</1/B>HH:MM:SS']
 
   # Declare the labels.
-  label = RNDK::LABEL.new(rndkscreen, RNDK::CENTER, RNDK::CENTER, mesg, true, true)
+  label = RNDK::Label.new(rndkscreen, RNDK::CENTER, RNDK::CENTER, mesg, true, true)
 
   # Woops, something bad happened
   if label.nil?

data/examples/01-hello-world.rb

@@ -24,7 +24,7 @@ begin
          ]
 
   # Declare the labels.
-  label = RNDK::LABEL.new(rndkscreen,   # screen
+  label = RNDK::Label.new(rndkscreen,   # screen
                           RNDK::CENTER, # x
                           RNDK::CENTER, # y
                           mesg,         # message

data/examples/02-colors.rb

@@ -40,7 +40,7 @@ begin
                            RNDK::Color[:red],        # highlight
                            true,                     # has box?
                            false)                    # has shadow?
-  cal.activate []
+  cal.activate
 
   RNDK::Screen.end_rndk
 

data/examples/03-markup.rb

@@ -4,9 +4,10 @@
 # Also, how to use RNDK's color markup on strings.
 #
 # Colors on text are achieved by foreground/background
-# color pairs. Run the example now.
+# color pairs.
+# Stop reading, run the example now.
 #
-# As you just say, they go from 1 to 80, going on the
+# As you just saw, they go from 1 to 80, going on the
 # following order in sets of 8 and from background to
 # foreground:
 #
@@ -39,6 +40,7 @@ begin
   # * To start a color, do `</XX>`, where XX is a color pair
   #   from 1 to 80.
   # * To stop it, do `<!XX>`, where XX is the same as above.
+  # * To center the text, do `<C>`.
 
   msg = []
   msg << "</1>Pair01<!1> </2>Pair02<!2> </3>Pair03<!3> </4>Pair04<!4> </5>Pair05<!5> </6>Pair06<!6> </7>Pair07<!7> </8>Pair08<!8>"
@@ -55,10 +57,10 @@ begin
   msg << "<C>All RNDK color pairs (press 'q' to quit)"
 
   # Show label with that huge message.
-  label = RNDK::LABEL.new(screen,
+  label = RNDK::Label.new(screen,
                           RNDK::CENTER, # x
                           1,            # y
-                          msg,
+                          msg,          # message
                           true,         # has box?
                           true)         # has shadow?
 

data/examples/04-quick-widgets.rb

@@ -4,6 +4,7 @@
 # temporary pre-made Widgets with a single action.
 #
 # They're automatically included within `require 'rndk'`.
+#
 require 'rndk'
 
 begin

data/examples/05-position-widget.rb

@@ -43,7 +43,7 @@ begin
   RNDK::Color.init
 
   # Create the entry field widget.
-  entry = RNDK::ENTRY.new(rndkscreen,
+  entry = RNDK::Entry.new(rndkscreen,
                           RNDK::CENTER, # x
                           RNDK::CENTER, # y
                           '',

data/examples/entry.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+#
+# Shows off the Entry widget by asking you to
+# type anything.
+# Then it tells you what you sent to it.
+#
+require 'rndk/entry'
+
+begin
+  # Startup RNDK and Colors
+  rndkscreen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Watch out for that markup
+  # See example 'markup.rb' for details
+  title = "<C></77>Tell me something"
+  label = "</U/5>Oh yeah<!U!5>:"
+
+  # Create the entry field widget.
+  entry = RNDK::Entry.new(rndkscreen,
+                          RNDK::CENTER,
+                          RNDK::CENTER,
+                          title,
+                          label,
+                          Ncurses::A_NORMAL,
+                          '.',
+                          :MIXED,   # behavior
+                          40,
+                          0,
+                          256,
+                          true,
+                          false)
+
+  # Is the widget nil?
+  if entry.nil?
+    RNDK::Screen.end_rndk
+
+    puts "Cannot create the entry box. Is the window too small?"
+    exit 1
+  end
+
+  # Draw the screen.
+  rndkscreen.refresh
+
+  # Activate the entry field.
+  info = entry.activate
+
+  mesg = []
+  # Tell them what they typed.
+  if entry.exit_type == :ESCAPE_HIT
+    mesg = ["<C>You hit escape. No information passed back.",
+            "<C>Press any key to continue."]
+
+  elsif entry.exit_type == :NORMAL
+    mesg = ["<C>You typed in the following",
+            "<C>(#{info})",
+            "",
+            "<C>Press any key to continue."]
+  end
+
+  # Quick widget - see example 'quick-widgets.rb' for details
+  rndkscreen.popup_label mesg
+
+  # Quitting
+  RNDK::Screen.end_rndk
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
+end
+

data/examples/label.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+#
+# Shows some colored lines within
+# a Label widget.
+require 'rndk/label'
+
+begin
+  # Starting things up
+  rndkscreen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Set the labels with some nice markup
+  mesg = [
+          "</29/B>This line should have a yellow foreground and a blue background.",
+          "</5/B>This line should have a white  foreground and a blue background.",
+          "</26/B>This line should have a yellow foreground and a red  background.",
+          "<C>This line should be set to whatever the screen default is."
+         ]
+
+  label = RNDK::Label.new(rndkscreen,
+                          RNDK::CENTER,
+                          RNDK::CENTER,
+                          mesg,
+                          true,
+                          true)
+
+  if label.nil?
+    RNDK::Screen.end_rndk
+
+    puts 'Cannot create the label. Is the window too small?'
+    exit 1
+  end
+
+  # Draw the RNDK screen and waits for
+  # space to be pressed.
+  rndkscreen.refresh
+  label.wait(' ')
+
+  # Clean up
+  RNDK::Screen.end_rndk
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
+end
+

data/examples/scroll.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Displays a Scroll list with the current
-# directory's files.
+# Displays a Scroll list with the current directory's files.
 #
 # You can also modify it at runtime with the keys:
 #
@@ -9,41 +8,48 @@
 # * 'i' inserts item
 # * 'd' deletes item
 #
-require 'rndk/scroll'
-
-# It creates new labels to add to the Scroll List.
+# After selecting an item, we pop-up the user with it's name.
 #
-# Ignore this for now, read the rest first.
-$count = 0
-def new_label(prefix)
-  result = "%s%d" % [prefix, $count]
-  $count += 1
-  return result
-end
+require 'rndk/scroll'
 
 begin
   # Set up RNDK and colors
   rndkscreen = RNDK::Screen.new
-  RNDK::Draw.initRNDKColor
+  RNDK::Color.init
+
+  # Turning off the blinking cursor
+  Ncurses.curs_set 0
 
   # Use the current directory list to fill the radio list
-  item  = []
-  count = RNDK.getDirectoryContents(".", item)
+  item = RNDK.get_directory_contents '.'
+
+  # Pay attention to the markup:
+  # * <C> centers the text,
+  # * </XX> is a color pair
+  # See example 'markup.rb' for more details.
+  title = <<END
+<C></77>Pick a file
+</77>Press 'a' to append an item
+</77>Press 'i' to insert an item
+</77>Press 'd' to delete current item
+</77>(don't worry, won't delete your files)
+</77>Press 'enter' or 'tab' to select item
+------------------------------------------------
+END
 
   # Create the scrolling list.
-  scroll_list = RNDK::SCROLL.new(rndkscreen,
-                                 RNDK::CENTER, # x
-                                 RNDK::CENTER, # y
-                                 RNDK::RIGHT,  # scrollbar position
-                                 10,           # height
-                                 50,           # width
-                                 "<C></5>Pick a file", # title
-                                 item,
-                                 count,
-                                 true,
-                                 Ncurses::A_REVERSE,
-                                 true,         # box
-                                 false)        # shadow
+  scroll_list = RNDK::Scroll.new(rndkscreen,
+                                 RNDK::CENTER,      # x
+                                 RNDK::CENTER,      # y
+                                 RNDK::RIGHT,       # scrollbar position
+                                 50,                # width
+                                 24,                # height
+                                 title,             # title
+                                 item,              # items on the list
+                                 true,              # show numbers
+                                 RNDK::Color[:red], # highlight color
+                                 true,              # box
+                                 false)             # shadow
 
   if scroll_list.nil?
     RNDK::Screen.end_rndk
@@ -54,21 +60,30 @@ begin
 
   # These are the functions that will modify the
   # Scroll List at runtime.
+  #
+  # The arguments to the block are provided by
+  # default, you can ignore them right now.
+  #
+  # The only thing you need to know is that `widget` is
+  # the scroll - widget that we attach the callback to.
+  $counter = 0
 
-  addItemCB = lambda do |type, widget, client_data, input|
-    widget.addItem(ScrollExample.newLabel("add"))
+  add_item_callback = lambda do |type, widget, client_data, input|
+    widget.addItem "add_#{$counter}"
+    $counter += 1
     widget.screen.refresh
     return true
   end
 
-  insItemCB = lambda do |type, widget, client_data, input|
-    widget.insertItem(ScrollExample.newLabel("insert"))
+  insert_item_callback = lambda do |type, widget, client_data, input|
+    widget.insertItem "insert_#{$counter}"
+    $counter += 1
     widget.screen.refresh
     return true
   end
 
-  delItemCB = lambda do |type, widget, client_data, input|
-    widget.deleteItem(widget.getCurrentItem)
+  delete_item_callback = lambda do |type, widget, client_data, input|
+    widget.deleteItem widget.getCurrentItem
     widget.screen.refresh
     return true
   end
@@ -77,30 +92,41 @@ begin
   #
   # It only accepts lambdas.
 
-  scroll_list.bind(:SCROLL, 'a', addItemCB, nil)
-  scroll_list.bind(:SCROLL, 'i', insItemCB, nil);
-  scroll_list.bind(:SCROLL, 'd', delItemCB, nil);
+  scroll_list.bind(:scroll, 'a', add_item_callback, nil)
+  scroll_list.bind(:scroll, 'i', insert_item_callback, nil)
+  scroll_list.bind(:scroll, 'd', delete_item_callback, nil)
 
   # Activate the scrolling list.
-  selection = scroll_list.activate('')
+  selection = scroll_list.activate
+
+  # Now, we'll determine how the widget was exited
+  # and pop-up the user with it's choice
 
-  # Determine how the widget was exited
   msg = []
   if scroll_list.exit_type == :ESCAPE_HIT
     msg = ['<C>You hit escape. No file selected',
-           '',
            '<C>Press any key to continue.']
 
   elsif scroll_list.exit_type == :NORMAL
     the_item = RNDK.chtype2Char scroll_list.item[selection]
 
     msg = ['<C>You selected the following file',
-           "<C>%.*s" % [236, the_item],  # FIXME magic number
+           "<C></77>#{the_item}",
            "<C>Press any key to continue."]
   end
+
+  # A quick widget - see example 'quick-widgets.rb'
   rndkscreen.popup_label msg
 
-  # Exit
   RNDK::Screen.end_rndk
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
 end
 

data/examples/slider.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+#
+# Shows a slider bar that goes from 1 to 100.
+
+require 'rndk/slider'
+
+begin
+  # Markup-happy labels
+  title = '<C></U>Enter a value'
+  label = '</B>Current Value:'
+
+  # Set up RNDK
+  rndkscreen = RNDK::Screen.new
+  RNDK::Color.init
+
+  # Create the widget
+  widget = RNDK::Slider.new(rndkscreen,
+                            RNDK::CENTER,
+                            RNDK::CENTER,
+                            title,
+                            label,
+                            Ncurses::A_REVERSE | RNDK::Color[:white_blue] | ' '.ord,
+                            50,
+                            1,
+                            1,
+                            100,
+                            1,
+                            2,
+                            true,
+                            false)
+
+  if widget.nil?
+    RNDK::Screen.end_rndk
+
+    puts "Cannot make the widget. Is the window too small?"
+    exit 1
+  end
+
+  # Activate the widget.
+  selection = widget.activate
+
+  # Check the exit value of the widget.
+  mesg = []
+
+  if widget.exit_type == :ESCAPE_HIT
+    mesg = ["<C>You hit escape. No value selected.",
+            "<C>Press any key to continue."]
+
+  elsif widget.exit_type == :NORMAL
+    mesg = ["<C>You selected #{selection}",
+            "<C>Press any key to continue."]
+  end
+
+  # A quick popup widget! Check out the
+  # example file 'quick-widgets.rb'
+  rndkscreen.popup_label mesg
+
+  # Clean up
+  RNDK::Screen.end_rndk
+
+# Just in case something bad happens.
+rescue Exception => e
+  RNDK::Screen.end_rndk
+
+  puts e
+  puts e.inspect
+  puts e.backtrace
+  exit 1
+end
+