rdialogy 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-04-30
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,47 @@
+History.txt
+Manifest.txt
+Rakefile
+README.txt
+examples/calendar.rb
+examples/checklist.rb
+examples/dselect.rb
+examples/form.rb
+examples/gauge.rb
+examples/inputmenu.rb
+examples/menu.rb
+examples/message_box.rb
+examples/mixedgauge.rb
+examples/passwordbox.rb
+lib/rdialogy/base.rb
+lib/rdialogy/calendar.rb
+lib/rdialogy/checklist.rb
+lib/rdialogy/dselect.rb
+lib/rdialogy/editbox.rb
+lib/rdialogy/filepath_widget.rb
+lib/rdialogy/form_field.rb
+lib/rdialogy/form.rb
+lib/rdialogy/fselect.rb
+lib/rdialogy/gauge.rb
+lib/rdialogy/infobox.rb
+lib/rdialogy/inputbox.rb
+lib/rdialogy/inputmenu.rb
+lib/rdialogy/menu_item.rb
+lib/rdialogy/menu.rb
+lib/rdialogy/message_box.rb
+lib/rdialogy/mixedgauge.rb
+lib/rdialogy/passwordbox.rb
+lib/rdialogy.rb
+spec/base_spec.rb
+spec/calendar_spec.rb
+spec/checklist_spec.rb
+spec/dselect_spec.rb
+spec/form_spec.rb
+spec/fselect_spec.rb
+spec/infobox_spec.rb
+spec/inputbox_spec.rb
+spec/inputmenu_spec.rb
+spec/menu_spec.rb
+spec/message_box_spec.rb
+spec/mixedgauge_spec.rb
+spec/passwordbox_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,60 @@
+= rdialogy
+
+* http://rdialogy.rubyforge.com
+
+== DESCRIPTION:
+
+A wrapper for dialog
+
+== FEATURES/PROBLEMS:
+
+* Missing a bunch of stuff
+
+== SYNOPSIS:
+
+ MessageBox.run(:text => "Hello World!")
+ Calendar.run(:text => "Choose a date!", :month => 11, :day => 17)
+ Checklist.run(:text => "Select some stuff!", :items => %w(grapes lemons tomatos).map{|e| MenuItem.new(e, e)}).inspect
+ DSelect.run(:path => Dir.pwd)
+
+== REQUIREMENTS:
+
+* dialog
+
+== INSTALL:
+
+* gem install rdialogy
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'rdialogy' do
+  developer('Ross Paine', 'paine@bur.st')
+
+  # self.rubyforge_name = 'rdialogyx' # if different than 'rdialogy'
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples', '-p']
+end
+
+# vim: syntax=ruby

data/examples/calendar.rb

@@ -0,0 +1,5 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts Calendar.run(:text => "Choose a date!", :month => 11, :day => 17)

data/examples/checklist.rb

@@ -0,0 +1,8 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts Checklist.run(
+  :text => "Select some stuff!",
+  :items => %w(grapes lemons tomatos).map{|e| MenuItem.new(e, e)}
+).inspect

data/examples/dselect.rb

@@ -0,0 +1,5 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts DSelect.run(:path => Dir.pwd)

data/examples/form.rb

@@ -0,0 +1,11 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts Form.run(:text => "Enter some details", 
+  :items => 
+    [
+      FormField.new('name', 1, 1, '', 1, 5, 10, 10),
+      FormField.new('age', 2, 1, '', 2, 5, 10, 10)
+    ]
+).inspect

data/examples/gauge.rb

@@ -0,0 +1,17 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+Gauge.run(:text => "Hi!", :width => 90) do |progress|
+  0.upto(50).each do |p|
+    progress.update p
+    sleep 0.01
+  end
+  
+  progress.set_prompt(51, "Updating some other thing..")
+
+  51.upto(100).each do |p|
+    progress.update p
+    sleep 0.02
+  end
+end

data/examples/inputmenu.rb

@@ -0,0 +1,9 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts InputMenu.run(
+  :text => "Select some stuff!",
+  :items => %w(grapes lemons tomatos).map{|e| MenuItem.new(e, e)}
+).inspect
+

data/examples/menu.rb

@@ -0,0 +1,9 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts Menu.run(
+  :text => "Select a thing",
+  :items => %w(grapes lemons tomatos).map{|e| MenuItem.new(e, e)}
+).inspect
+

data/examples/message_box.rb

@@ -0,0 +1,5 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+puts MessageBox.run(:text => "Hello World!")

data/examples/mixedgauge.rb

@@ -0,0 +1,21 @@
+require [File.dirname(__FILE__), '..', 'lib', 'rdialogy'].join('/')
+
+include RDialogy
+
+
+@p = 0
+@all_tasks = [
+  'Updating the master baffle record',
+  'Inverting the Ukraine tupple',
+  'Restoring the donkey\'s fire mode'
+]
+
+@processed = []
+ 
+@all_tasks.each do |tag|
+  this_item = MenuItem.new(tag, 'OK')
+  @processed << this_item
+  progress = (@processed.count / @all_tasks.count.to_f) * 100
+  MixedGauge.run(:text => "Working", :percent => progress, :items => @processed)
+  sleep 1
+end

data/lib/rdialogy/base.rb

@@ -0,0 +1,67 @@
+require 'tempfile'
+
+module RDialogy
+  class Base
+
+# assembles the arguments for dialog and executes them,
+# if std_err is true STDERR is captured and returned, optionally formatted
+# by supplied block.
+
+    def self.run(options={}, std_err = false)
+      cmd = dialog_string options
+
+      if std_err
+        begin
+          tmp = Tempfile.new('tmp')
+          cmd += ' 2> ' + tmp.path
+        
+          system cmd
+
+          output = String.new
+          while true
+            output += tmp.readline
+          end
+        rescue EOFError
+          if block_given?
+            return yield output
+          else
+            return output
+          end
+        ensure
+          tmp.close
+        end
+      else
+        system cmd
+      end
+    end
+
+    private
+# Template method to be overloaded in child classes
+
+    def self.command
+      raise "Template method called, must overload command in child class"
+    end
+
+# expands the options out into the full dialog command string
+
+    def self.dialog_string(options={})
+      (['dialog', '--' + command] + add_quotes(args(options))).join ' '
+    end
+# Returns a correctly ordered list from the input hash,
+# also provides defaults for elements that are not supplied
+
+    def self.args(options={})
+      options[:text] ||= 'default title'
+      options[:height] ||= 0
+      options[:width] ||=0
+
+      [:text, :height, :width].map { |e| options[e] }
+    end
+
+# Adds single quotes around all of the elements in the array returned by _args_
+
+    def self.add_quotes(args)
+      args.map{|e| "'#{e.to_s.gsub(/'/, "'\\\\''")}'"}
+    end
+  end
+end

data/lib/rdialogy/calendar.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class Calendar < Base
+
+#    Valid options are:
+# *   :text - Title of widget
+# *   :width
+# *   :height
+# *   :year
+# *   :month
+# *   :day
+#
+#    From the dialog man page:
+#    A calendar box displays month, day and year in separately adjustable windows.  If the values for day, month
+#    or  year  are  missing or negative, the current date's corresponding values are used.  You can increment or
+#    decrement any of those using the left-, up-, right- and down-arrows.  Use vi-style h, j, k and l for moving
+#    around  the array of days in a month.  Use tab or backtab to move between windows.  If the year is given as
+#    zero, the current date is used as an initial value.
+#    On exit, the date is printed in the form day/month/year.
+
+
+    def self.run(options={})
+      super options, true do |input|
+        Time.mktime *input.chomp.split('/').reverse
+      end
+    end
+
+    private
+
+    def self.args(options={})
+      options[:year] ||= -1
+      options[:month] ||= -1
+      options[:day] ||= -1
+
+      super + [:day, :month, :year].map{|e| options[e]}
+    end
+
+# Maps to the appropriate dialog argument
+
+    def self.command
+      'calendar'
+    end
+
+  end
+end

data/lib/rdialogy/checklist.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/menu_item'
+
+module RDialogy
+  class Checklist < Base
+
+# Valid options are:
+# * :text - Title of the widget
+# * :width
+# * :height
+# * :list_height - Number of items to display in the list
+# * :items - Array of MenuItem
+#
+# Returns <b>Array</b>
+#
+# From the man page:
+#
+#    A checklist box is similar to a menu box; there are multiple entries presented  in  the  form  of  a  menu.
+#    Instead  of choosing one entry among the entries, each entry can be turned on or off by the user.  The initial
+#    on/off state of each entry is specified by status.
+
+
+    def self.run(options={})
+      super options, true do |input|
+        items = input.split(' ')
+        items.map{|e| e.scan(/^"(.*)"$/).flatten.first }
+      end
+    end
+
+    private
+
+# Formats the hash into an ordered list, valid options are:
+# * :text - Title of the widget
+# * :width
+# * :height
+# * :list_height - Number of items to display in the list
+# * :items - Array of MenuItem
+
+    def self.args(options={})
+      options[:items] ||= []
+      options[:list_height] ||= options[:items].count
+
+      options[:items].map! do |item|
+        [item.tag, item.item, item.status ? 'on' : 'off']
+      end
+
+      super + [options[:list_height]] + options[:items].flatten
+    end
+
+# Maps to the appropriate dialog argument
+    def self.command
+      'checklist'
+    end
+
+  end
+end

data/lib/rdialogy/dselect.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/filepath_widget'
+
+module RDialogy
+  class DSelect < FilePathWidget
+
+# Valid options are:
+# * :path - Initial directory to display
+# * :width
+# * :height
+# From the man page:
+#
+#    The directory-selection dialog displays a text-entry window in which you can type a  directory,  and  above
+#    that a windows with directory names.
+#
+#    Here  filepath  can  be a filepath in which case the directory window will display the contents of the path
+#    and the text-entry window will contain the preselected directory.
+#
+#    Use tab or arrow keys to move between the windows.  Within the directory window, use the up/down arrow keys
+#    to  scroll the current selection.  Use the space-bar to copy the current selection into the text-entry window.
+#
+#    Typing any printable characters switches focus to the text-entry window, entering that character as well as
+#    scrolling the directory window to the closest match.
+#
+#    Use a carriage return or the "OK" button to accept the current value in the text-entry window and exit.
+
+    
+    def self.run(options={})
+      super options
+    end
+
+    private
+
+# Maps to the appropriate dialog argument
+
+    def self.command
+      'dselect'
+    end
+  end
+end

data/lib/rdialogy/editbox.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/filepath_widget'
+
+module RDialogy
+  class Editbox < FilePathWidget
+
+# Valid options are:
+# * :path - Path to file to display
+# * :width
+# * :height
+#
+#  From the man page:
+#
+#  The  edit-box  dialog  displays a copy of the file.  You may edit it using the backspace, delete and cursor
+#  keys to correct typing errors.  It also recognizes pageup/pagedown.  Unlike the --inputbox, you must tab to
+#  the  "OK"  or "Cancel" buttons to close the dialog.  Pressing the "Enter" key within the box will split the
+#  corresponding line.
+
+    def self.run(options={})
+      super options
+    end
+
+    private
+
+# Maps to the dialog argument
+
+    def self.command
+      'editbox'
+    end
+  end
+end
+

data/lib/rdialogy/filepath_widget.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class FilePathWidget < Base
+# Valid options are:
+# * :path - Initial directory to display
+# * :width
+# * :height
+
+    def self.run(options={})
+      super options, true
+    end
+
+    private
+
+# Maps the options hash to an ordered list, valid options are:
+# * :path
+# * :width
+# * :height
+
+    def self.args(options={})
+      options[:path] ||= Dir.pwd
+      options[:width] ||= 0
+      options[:height] ||= 0
+
+      [:path, :height, :width].map{|e| options[e]}
+    end
+  end
+end
+

data/lib/rdialogy/form.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/form_field'
+
+module RDialogy
+  class Form < Base
+# Valid options are:
+# * :text - Title of the widget
+# * :width
+# * :height
+# * :form_height - Number of items to display in the list
+# * :items - Array of FormField
+#
+# Returns <b>Hash</b>
+#
+# From the man page
+#
+#  The form dialog displays a form consisting of labels and fields, which are positioned on a scrollable  window 
+#  by  coordinates  given  in  the script.  The field length flen and input-length ilen tell how long the
+#  field can be.  The former defines the length shown for a selected field, while the latter defines the  per‐
+#  missible length of the data entered in the field.
+#
+#  -  If flen is zero, the corresponding field cannot be altered.  and the contents of the field determine the
+#     displayed-length.
+#
+#  -  If flen is negative, the corresponding field cannot be altered, and the negated value of flen is used as
+#     the displayed-length.
+#
+#  -  If ilen is zero, it is set to flen.
+#
+#  Use up/down arrows (or control/N, control/P) to move between fields.  Use tab to move between windows.
+
+    def self.run(options={})
+        keys = options[:items].map(&:label_text)
+      super options, true do |input|
+        result = Hash.new
+        input.split("\n").each do |item|
+          result[keys.shift] = item
+        end
+        result
+      end
+    end
+
+    private
+    
+    def self.args(options={})
+      options[:items] ||= []
+      options[:form_height] ||= options[:items].count
+      options[:items].map! do |item|
+        [
+          :label_text, :label_x, :label_y,
+          :item_text, :item_x, :item_y,
+          :label_length, :item_length
+        ].map do |m|
+          item.send(m)
+        end
+      end
+
+      super + [options[:form_height]] + options[:items].flatten
+    end
+     
+
+# Maps to the appropriate dialog argument
+    def self.command
+      'form'
+    end
+  end
+end

data/lib/rdialogy/form_field.rb

@@ -0,0 +1,8 @@
+args = [
+  :label_text, :label_x, :label_y,
+  :item_text, :item_x, :item_y,
+  :label_length, :item_length
+]
+
+class FormField < Struct.new(*args)
+end

data/lib/rdialogy/fselect.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/filepath_widget'
+
+module RDialogy
+  class FSelect < FilePathWidget
+
+#    From the man page:
+#
+#    The fselect (file-selection) dialog displays a text-entry window in which  you  can  type  a  filename  (or
+#    directory), and above that two windows with directory names and filenames.
+#
+#    Here  filepath  can be a filepath in which case the file and directory windows will display the contents of
+#    the path and the text-entry window will contain the preselected filename.
+#
+#    Use tab or arrow keys to move between the windows.  Within the  directory  or  filename  windows,  use  the
+#    up/down  arrow  keys to scroll the current selection.  Use the space-bar to copy the current selection into
+#    the text-entry window.
+#
+#    Typing any printable characters switches focus to the text-entry window, entering that character as well as
+#    scrolling the directory and filename windows to the closest match.
+#
+#    Typing the space character forces dialog to complete the current name (up to the point where there may be a
+#    match against more than one entry).
+#
+#    Use a carriage return or the "OK" button to accept the current value in the text-entry window and exit.
+
+    def self.run(options={}); super options; end
+
+    private
+
+    def self.command
+      'fselect'
+    end
+  end
+end
+

data/lib/rdialogy/gauge.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class Gauge < Base
+# Valid options are:
+# * :text
+# * :width
+# * :height
+# * :percent - initial percentage, default 0
+#
+# From the man page:
+#    A  gauge  box displays a meter along the bottom of the box.  The
+#    meter indicates the percentage.
+# New percentages are  read by calling
+# .update(new percentage) inside the block supplied to run().
+# Calling .set_prompt(percentage, new_prompt) inside the block sets
+# a new prompt on the progress bar.
+
+    def self.run(options={})
+      begin
+        fifo = "/tmp/dialog_gauge.#{$$}"
+        system "mkfifo #{fifo}"
+        system "( #{dialog_string options} < #{fifo} ) &"
+        @@fifo = File.open fifo, 'w'
+        yield self
+      ensure
+        @@fifo.close
+        @@fifo = nil
+        system "rm #{fifo}"
+      end
+    end
+
+    def self.command
+      'gauge'
+    end
+
+# sends the new percentage to the running gauge
+
+    def self.update(percentage)
+      raise "Can't update gauge as it is not running." if @@fifo.nil?
+      @@fifo.puts percentage.to_i
+      @@fifo.flush
+    end
+
+# sends the percentage to the running gauge and sets a new prompt
+
+    def self.set_prompt(percentage, new_prompt)
+      raise "Can't update gauge as it is not running." if @@fifo.nil?
+      @@fifo.puts "XXX"
+      @@fifo.puts percentage.to_i
+      @@fifo.puts new_prompt
+      @@fifo.puts "XXX"
+      @@fifo.flush
+    end
+  end
+end