rndk 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658d93a038f41e69767bd1f8a24f0ed69ab21d61
-  data.tar.gz: 085b8d4cf88241e7ed481736a8356be356341628
+  metadata.gz: 5fbd239767ebd76e2ead3ac2be92d8324061ddef
+  data.tar.gz: 4c0bd5d00c3968a50922c5765522e61d9cc58539
 SHA512:
-  metadata.gz: f632241c52b6accf9e017d3e2d8e26e7836d46fcbcbfcd14a3dfa8b092da98fd69500be4921a8744f87d8ecaef19bb1aacfb6cfd0e599deb227b1612242e35e1
-  data.tar.gz: 4b18178e17b1ab81820caaf5a79fc0ab0bf66f31dfb2bf92f47c1b517fe2ced0a8c594dfb50573a391117b2b0197ace571d152257bdd05a0024c0e1710cb88c7
+  metadata.gz: c8047b49f43a88ce3aee7bcb65b513b6e67429879655f657658f19ddcb6f04f5c059b7c9e0de15f56c613c120b23a0cb651b9e3aeb0dcc77b0a2042c1d9bdee8
+  data.tar.gz: 8e455a72a17868aedca98d472252e3b92ff7531f7be2d0f39270ce66cadd316965d188b7b00fc8c5efc269b16dabb756d5692ab9f1dc516e14f6990ed8f69f32

data/README.md

@@ -7,6 +7,7 @@ details, it provides some widgets for rapid console app development.
 
 It means that you'll be able to master the dark arts of text-based
 applications, easily creating nice apps for the console.
+Not convinced? [Here's some screenshots][screens]!
 
 `RNDK` is a fork from `tawny-cdk`, a [Chris Sauro Ruby port][tawny]
 of [Thomas Dickey's Curses Development Kit][cdk] (in C).
@@ -53,8 +54,6 @@ now, I recommend you to **not** use `rndk` for production programs!
 
 ## Installation
 
-`rndk` requires the gem `ffi-ncurses`.
-
 Add this line to your application's Gemfile:
 
     gem 'rndk'
@@ -67,14 +66,22 @@ Or install it yourself as:
 
     $ gem install rndk
 
+## Requirements
+
+`rndk` requires the following gems:
+
+* [ffi-ncurses][ffi]
+
+They'll get installed automatically if you're using `bundle` or `gem install`.
+
 ## 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:
+widget available. If you've not installed `rndk` yet, go to the
+root folder and run:
 
     ruby -Ilib examples/YOUR_EXAMPLE_HERE
 
@@ -107,6 +114,8 @@ Step-by-step guide to contribute:
 [rbcurse]:https://github.com/rkumar/rbcurse
 [wiki]:https://github.com/alexdantas/rndk/wiki
 [widgets]:https://github.com/alexdantas/rndk/wiki/widgets
+[ffi]:http://rubygems.org/gems/ffi-ncurses
+[screens]:https://github.com/alexdantas/rndk/wiki/screenshots
 
 ## Contact
 

data/TODO

@@ -1,5 +1,25 @@
 RNDK TODO List
-(forked from Tawny-Cdk's TODO List)
+
+The main things we must do are:
+
+* Turn general api less C-like and more Ruby-ish.
+  - easy: Convert all methods from 'CamelCase' to 'under_scores'.
+  - hard: Reflect over the general API
+  - hard: Create a nice config system for widgets.
+          Mine is so messed up...
+
+* Document stuff.
+  - easy: Copy relevant parts from CDK's documentation into
+          class headers, method docs and such.
+  - medium: Explain stuff on modules and classes.
+            Argument lists, config, signals, stuff.
+
+
+
+
+Now those items were forked from Tawny-Cdk's TODO List.
+Don't take them too seriously.
+
 ------------------------------------------------------------------------------
 
 Now that Tawny CDK is basically a complete copy of Thomas Dickey version of

data/demos/appointment.rb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
 #
-# Note: This is not for beginners! Check out the examples/
-#       before adventuring into the demos/ realm!
+# Warning: This is not for beginners! Check out the examples/
+#          before adventuring into the demos/ realm!
+#
+# Warning2: This is not well-written! Handle with care.
 #
 # Shows a book where you can create appointments of different
 # kinds, save and restore them on a file.
@@ -15,344 +17,322 @@
 #
 # It automatically creates file `/tmp/appointments.dat` on the
 # current directory
+#
 require 'ostruct'
 require 'rndk/calendar'
 require 'rndk/itemlist'
 require 'rndk/entry'
 
-class Appointment
-  MAX_MARKERS = 2000
-  GPAppointmentAttributes = [
-    Ncurses::A_BLINK,
-    Ncurses::A_BOLD,
-    Ncurses::A_REVERSE,
-    Ncurses::A_UNDERLINE,
-  ]
-
-  AppointmentType = [
-    :BIRTHDAY,
-    :ANNIVERSARY,
-    :APPOINTMENT,
-    :OTHER,
-  ]
-
-  # This reads a given appointment file.
-  def Appointment.readAppointmentFile(filename, app_info)
-    appointments = 0
-    segments = 0
-    lines = []
-
-    # Read the appointment file.
-    lines_read = RNDK.read_file(filename, lines)
-    if lines_read == nil
-      app_info.count = 0
-      return
-    end
+# I really doubt you're gonna put
+# that many markers
+MAX_MARKERS = 2000
+
+AppointmentAttributes = [
+                           RNDK::Color[:blink],
+                           RNDK::Color[:bold],
+                           RNDK::Color[:reverse],
+                           RNDK::Color[:underline],
+                          ]
+
+AppointmentType = [
+                   :BIRTHDAY,
+                   :ANNIVERSARY,
+                   :APPOINTMENT,
+                   :OTHER,
+                  ]
+
+# This reads a given appointment file into `app_info`.
+def readAppointmentFile(filename, app_info)
+  appointments = 0
+  segments = 0
+
+  # Read the appointment file.
+  lines = RNDK.read_file filename
+
+  if lines.nil?
+    app_info.count = 0
+    return
+  end
 
-    # Split each line up and create an appointment.
-    (0...lines_read).each do |x|
-      temp = lines[x].split(RNDK.CTRL('V').chr)
-      segments =  temp.size
-
-      # A valid line has 5 elements:
-      #          Day, Month, Year, Type, Description.
-      if segments == 5
-        app_info.appointment << OpenStruct.new
-        e_type = Appointment::AppointmentType[temp[3].to_i]
-
-        app_info.appointment[appointments].day = temp[0].to_i
-        app_info.appointment[appointments].month = temp[1].to_i
-        app_info.appointment[appointments].year = temp[2].to_i
-        app_info.appointment[appointments].type = e_type
-        app_info.appointment[appointments].description = temp[4]
-        appointments += 1
-      end
+  # Split each line up and create an appointment.
+  (0...lines.size).each do |x|
+    temp = lines[x].split(RNDK.CTRL('V').chr)
+    segments =  temp.size
+
+    # A valid line has 5 elements:
+    #          Day, Month, Year, Type, Description.
+    if segments == 5
+      app_info.appointment << OpenStruct.new
+      e_type = AppointmentType[temp[3].to_i]
+
+      app_info.appointment[appointments].day = temp[0].to_i
+      app_info.appointment[appointments].month = temp[1].to_i
+      app_info.appointment[appointments].year = temp[2].to_i
+      app_info.appointment[appointments].type = e_type
+      app_info.appointment[appointments].description = temp[4]
+      appointments += 1
     end
-
-    # Keep the amount of appointments read.
-    app_info.count = appointments
   end
 
-  # This saves a given appointment file.
-  def Appointment.saveAppointmentFile(filename, app_info)
-    # TODO: error handling
-    fd = File.new(filename, 'w')
-
-    # Start writing.
-    app_info.appointment.each do |appointment|
-      if appointment.description != ''
-        fd.puts '%d%c%d%c%d%c%d%c%s' % [
-            appointment.day, RNDK.CTRL('V').chr,
-            appointment.month, RNDK.CTRL('V').chr,
-            appointment.year, RNDK.CTRL('V').chr,
-            Appointment::AppointmentType.index(appointment.type),
-            RNDK.CTRL('V').chr, appointment.description]
-      end
+  # Keep the amount of appointments read.
+  app_info.count = appointments
+end
+
+# This saves a given appointment file.
+def saveAppointmentFile(filename, app_info)
+  # TODO: error handling
+  fd = File.new(filename, 'w')
+
+  # Start writing.
+  app_info.appointment.each do |appointment|
+    if appointment.description != ''
+      fd.puts '%d%c%d%c%d%c%d%c%s' % [
+                                      appointment.day, RNDK.CTRL('V').chr,
+                                      appointment.month, RNDK.CTRL('V').chr,
+                                      appointment.year, RNDK.CTRL('V').chr,
+                                      AppointmentType.index(appointment.type),
+                                      RNDK.CTRL('V').chr, appointment.description]
     end
-    fd.close
   end
+  fd.close
+end
 
-  # This program demonstrates the Rndk calendar widget.
-  def Appointment.main
+# This adds a marker to the calendar.
+def create_calendar_mark(calendar, info)
+
+  items = [
+           'Birthday',
+           'Anniversary',
+           'Appointment',
+           'Other',
+          ]
+
+  # Create the itemlist widget.
+  itemlist = RNDK::Itemlist.new(calendar.screen, {
+                                  :x => RNDK::CENTER,
+                                  :y => RNDK::CENTER,
+                                  :title => '',
+                                  :label => 'Select Appointment Type: ',
+                                  :items => items
+                                })
+
+  # Get the appointment type from the user.
+  selection = itemlist.activate
+
+  # They hit escape, kill the itemlist widget and leave.
+  if selection == -1
+    itemlist.destroy
+    calendar.draw
+    return false
+  end
 
-    # Get the current dates and set the default values for
-    # the day/month/year values for the calendar.
-    date_info = Time.now.gmtime
-    day = date_info.day
-    month = date_info.mon
-    year = date_info.year
+  # Destroy the itemlist and set the marker.
+  itemlist.destroy
+  calendar.draw
+  marker = AppointmentAttributes[selection]
+
+  # Create the entry field for the description.
+  entry = RNDK::Entry.new(calendar.screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::CENTER,
+                            :title => '<C>Enter a description of the appointment.',
+                            :label => 'Description: ',
+                            :field_width => 40,
+                          })
+  # Get the description.
+  description = entry.activate
+  if description == 0
+    entry.destroy
+    calendar.draw
+    return false
+  end
 
-    title = "<C></U>RNDK Appointment Book\nPress 'h' for help\n<C><#HL(30)>\n"
+  # Destroy the entry and set the marker.
+  description = entry.info
+  entry.destroy
+  calendar.draw
 
-    filename = ''
+  # Set the marker.
+  calendar.set_marker(calendar.day, calendar.month, calendar.year, marker)
 
-    # Create the appointment book filename.
-    filename = "/tmp/appointments.dat"
+  # Keep the marker.
+  info.appointment << OpenStruct.new
+  current = info.count
 
-    appointment_info = OpenStruct.new
-    appointment_info.count = 0
-    appointment_info.appointment = []
+  info.appointment[current].day = calendar.day
+  info.appointment[current].month = calendar.month
+  info.appointment[current].year = calendar.year
+  info.appointment[current].type = AppointmentType[selection]
+  info.appointment[current].description = description
+  info.count += 1
 
-    # Read the appointment book information.
-    readAppointmentFile(filename, appointment_info)
+  # Redraw the calendar.
+  calendar.draw
+  return false
+end
 
-    # Set up RNDK
-    rndkscreen = RNDK::Screen.new
+  # This removes a marker from the calendar.
+def remove_calendar_mark(calendar, info)
 
-    # Set up RNDK colors
-    RNDK::Color.init
+  info.appointment.each do |appointment|
+    if appointment.day == calendar.day &&
+        appointment.month == calendar.month &&
+        appointment.year == calendar.year
+      appointment.description = ''
+      break
+    end
+  end
 
-    # Create the calendar widget.
-    calendar = RNDK::Calendar.new(rndkscreen,
-                                  RNDK::CENTER,
-                                  RNDK::CENTER,
-                                  title, day, month, year,
-                                  Ncurses::A_NORMAL, Ncurses::A_NORMAL, Ncurses::A_NORMAL, Ncurses::A_REVERSE,
-                                  true, false)
+  # Remove the marker from the calendar.
+  calendar.removeMarker(calendar.day, calendar.month, calendar.year)
 
-    # Is the widget nil?
-    if calendar.nil?
-      RNDK::Screen.end_rndk
+  # Redraw the calendar.
+  calendar.draw
+  return false
+end
 
-      puts "Cannot create the calendar. Is the window too small?"
-      exit 1
+# This displays the marker(s) on the given day.
+def display_calendar_mark(calendar, info)
+  found = 0
+  type = ''
+  mesg = []
+
+  # Look for the marker in the list.
+  info.appointment.each do |appointment|
+    # Get the day month year.
+    day = appointment.day
+    month = appointment.month
+    year = appointment.year
+
+    # Determine the appointment type.
+    if appointment.type == :BIRTHDAY
+      type = 'Birthday'
+    elsif appointment.type == :ANNIVERSARY
+      type = 'Anniversary'
+    elsif appointment.type == :APPOINTMENT
+      type = 'Appointment'
+    else
+      type = 'Other'
     end
 
-    # This adds a marker to the calendar.
-    create_calendar_mark_cb = lambda do |object_type, calendar, info, key|
-      items = [
-          'Birthday',
-          'Anniversary',
-          'Appointment',
-          'Other',
-      ]
-
-      # Create the itemlist widget.
-      itemlist = RNDK::ITEMLIST.new(calendar.screen,
-                                    RNDK::CENTER,
-                                    RNDK::CENTER,
-                                    '',
-                                    'Select Appointment Type: ',
-                                    items,
-                                    items.size,
-                                    0,
-                                    true,
-                                    false)
-
-      # Get the appointment type from the user.
-      selection = itemlist.activate([])
-
-      # They hit escape, kill the itemlist widget and leave.
-      if selection == -1
-        itemlist.destroy
-        calendar.draw(calendar.box)
-        return false
-      end
-
-      # Destroy the itemlist and set the marker.
-      itemlist.destroy
-      calendar.draw(calendar.box)
-      marker = Appointment::GPAppointmentAttributes[selection]
-
-      # Create the entry field for the description.
-      entry = RNDK::Entry.new(calendar.screen,
-                              RNDK::CENTER,
-                              RNDK::CENTER,
-                              '<C>Enter a description of the appointment.',
-                              'Description: ',
-                              Ncurses::A_NORMAL,
-                              '.'.ord,
-                              :MIXED,
-                              40,
-                              1,
-                              512,
-                              true,
-                              false)
-
-      # Get the description.
-      description = entry.activate([])
-      if description == 0
-        entry.destroy
-        calendar.draw(calendar.box)
-        return false
-      end
-
-      # Destroy the entry and set the marker.
-      description = entry.info
-      entry.destroy
-      calendar.draw(calendar.box)
-
-      # Set the marker.
-      calendar.setMarker(calendar.day, calendar.month, calendar.year, marker)
-
-      # Keep the marker.
-      info.appointment << OpenStruct.new
-      current = info.count
-
-      info.appointment[current].day = calendar.day
-      info.appointment[current].month = calendar.month
-      info.appointment[current].year = calendar.year
-      info.appointment[current].type = Appointment::AppointmentType[selection]
-      info.appointment[current].description = description
-      info.count += 1
-
-      # Redraw the calendar.
-      calendar.draw(calendar.box)
-      return false
+    # Find the marker by the day/month/year.
+    if day == calendar.day && month == calendar.month &&
+        year == calendar.year && appointment.description != ''
+      # Create the message for the label widget.
+      mesg << '<C>Appointment Date: %02d/%02d/%d' % [
+                                                     day, month, year]
+      mesg << ' '
+      mesg << '<C><#HL(35)>'
+      mesg << ' Appointment Type: %s' % [type]
+      mesg << ' Description     :'
+      mesg << '    %s' % [appointment.description]
+      mesg << '<C><#HL(35)>'
+      mesg << ' '
+      mesg << '<C>Press space to continue.'
+
+      found = 1
+      break
     end
+  end
 
-    # This removes a marker from the calendar.
-    remove_calendar_mark_cb = lambda do |object_type, calendar, info, key|
-      info.appointment.each do |appointment|
-        if appointment.day == calendar.day &&
-            appointment.month == calendar.month &&
-            appointment.year == calendar.year
-          appointment.description = ''
-          break
-        end
-      end
-
-      # Remove the marker from the calendar.
-      calendar.removeMarker(calendar.day, calendar.month, calendar.year)
-
-      # Redraw the calendar.
-      calendar.draw(calendar.box)
-      return false
-    end
+  # If we didn't find the marker, create a different message.
+  if found == 0
+    mesg << '<C>There is no appointment for %02d/%02d/%d' % [calendar.day, calendar.month, calendar.year]
+    mesg << '<C><#HL(30)>'
+    mesg << '<C>Press space to continue.'
+  end
 
-    # This displays the marker(s) on the given day.
-    display_calendar_mark_cb = lambda do |object_type, calendar, info, key|
-      found = 0
-      type = ''
-      mesg = []
-
-      # Look for the marker in the list.
-      info.appointment.each do |appointment|
-        # Get the day month year.
-        day = appointment.day
-        month = appointment.month
-        year = appointment.year
-
-        # Determine the appointment type.
-        if appointment.type == :BIRTHDAY
-          type = 'Birthday'
-        elsif appointment.type == :ANNIVERSARY
-          type = 'Anniversary'
-        elsif appointment.type == :APPOINTMENT
-          type = 'Appointment'
-        else
-          type = 'Other'
-        end
-
-        # Find the marker by the day/month/year.
-        if day == calendar.day && month == calendar.month &&
-            year == calendar.year && appointment.description != ''
-          # Create the message for the label widget.
-          mesg << '<C>Appointment Date: %02d/%02d/%d' % [
-              day, month, year]
-          mesg << ' '
-          mesg << '<C><#HL(35)>'
-          mesg << ' Appointment Type: %s' % [type]
-          mesg << ' Description     :'
-          mesg << '    %s' % [appointment.description]
-          mesg << '<C><#HL(35)>'
-          mesg << ' '
-          mesg << '<C>Press space to continue.'
-
-          found = 1
-          break
-        end
-      end
-
-      # If we didn't find the marker, create a different message.
-      if found == 0
-        mesg << '<C>There is no appointment for %02d/%02d/%d' % [calendar.day, calendar.month, calendar.year]
-        mesg << '<C><#HL(30)>'
-        mesg << '<C>Press space to continue.'
-      end
-
-      # Create the label widget
-      label = RNDK::Label.new(calendar.screen, RNDK::CENTER, RNDK::CENTER, mesg, true, false)
-      label.draw(label.box)
-      label.wait(' ')
-      label.destroy
-
-      # Redraw the calendar
-      calendar.draw(calendar.box)
-      return false
-    end
+  # Create the label widget
+  label = RNDK::Label.new(calendar.screen, {
+                            :x => RNDK::CENTER,
+                            :y => RNDK::CENTER,
+                            :text => mesg
+                          })
+  label.draw
+  label.wait(' ')
+  label.destroy
+
+  # Redraw the calendar
+  calendar.draw
+  return false
+end
 
-    # Shows a help popup with keybindings.
-    show_help = lambda do |object_type, calendar, info, key|
-      msg = ["Keybindings:",
-             " 'm' create appointment at selected day",
-             " 'r' remove appointment at selected day",
-             " '?' displays appointment for selected day",
-             " 'enter' or 'tab' quits"]
+# Shows a help popup with keybindings.
+def show_help(screen)
+  msg = ["Keybindings:",
+         " 'm' create appointment at selected day",
+         " 'r' remove appointment at selected day",
+         " '?' displays appointment for selected day",
+         " 'enter' or 'tab' quits"]
 
-      rndkscreen.popup_label msg
-    end
+  screen.popup_label msg
+end
 
-    # Now we bind actions to the calendar.
-    # Create a key binding to mark days on the calendar.
-    calendar.bind(:calendar, 'm', create_calendar_mark_cb, appointment_info)
-    calendar.bind(:calendar, 'M', create_calendar_mark_cb, appointment_info)
-    calendar.bind(:calendar, 'r', remove_calendar_mark_cb, appointment_info)
-    calendar.bind(:calendar, 'R', remove_calendar_mark_cb, appointment_info)
-    calendar.bind(:calendar, '?', display_calendar_mark_cb, appointment_info)
-    calendar.bind(:calendar, 'h', show_help, nil)
-
-    # Set all the appointments read from the file.
-    appointment_info.appointment.each do |appointment|
-      marker = Appointment::GPAppointmentAttributes[Appointment::AppointmentType.index(appointment.type)]
-
-      calendar.setMarker(appointment.day,
-                         appointment.month,
-                         appointment.year,
-                         marker)
-    end
+begin
+  # Set up RNDK and colors
+  screen = RNDK::Screen.new
+  RNDK::Color.init
+
+  title = "<C></U>RNDK Appointment Book\nPress 'h' for help\n<C><#HL(30)>\n"
+  filename = "/tmp/appointments.dat"
 
-    # Draw the calendar widget.
-    calendar.draw calendar.box
+  appointment_info = OpenStruct.new
+  appointment_info.count = 0
+  appointment_info.appointment = []
 
-    # Let the user play with the widget.
-    calendar.activate
+  readAppointmentFile(filename, appointment_info)
 
-    # Save the appointment information.
-    Appointment.saveAppointmentFile(filename, appointment_info)
+  # Create the calendar widget.
+  calendar = RNDK::Calendar.new(screen, {
+                                  :x => RNDK::CENTER,
+                                  :y => RNDK::CENTER,
+                                  :title => title
+                                })
 
-    # Clean up.
-    RNDK::Screen.end_rndk
+  if calendar.nil?
+    RNDK::Screen.finish
+
+    puts "Cannot create the calendar. Is the window too small?"
+    exit 1
   end
-end
 
+  # Now we bind actions to the calendar.
+  # Create a key binding to mark days on the calendar.
+  calendar.bind_key('m') do
+    create_calendar_mark(calendar, appointment_info)
+  end
 
-begin
-  Appointment.main
+  calendar.bind_key('r') do
+    remove_calendar_mark(calendar, appointment_info)
+  end
+
+  calendar.bind_key('?') do
+    display_calendar_mark(calendar, appointment_info)
+  end
+
+  calendar.bind_key('h') { show_help screen }
+
+  # Set all the appointments read from the file.
+  appointment_info.appointment.each do |appointment|
+    marker = AppointmentAttributes[AppointmentType.index(appointment.type)]
+
+    calendar.set_marker(appointment.day,
+                        appointment.month,
+                        appointment.year,
+                        marker)
+  end
+
+  calendar.draw
+  calendar.activate
+
+  # Save the appointment information.
+  Appointment.saveAppointmentFile(filename, appointment_info)
+
+  RNDK::Screen.finish
 
 # In case something goes wrong
 rescue Exception => e
-  RNDK::Screen.end_rndk
+  RNDK::Screen.finish
 
   puts e
   puts e.inspect