mrdialog 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e725ccd9925f5c32dcaac2b37b2b4ee972467cf
-  data.tar.gz: 8bf881b6b328ca8985cf75515a4b10c407c82eb1
+  metadata.gz: e2788351bad6662f93bed6be806fda9d5ff752ef
+  data.tar.gz: 2e580a2f427e441cfee6478b7fbf7f52cc691ae1
 SHA512:
-  metadata.gz: e39db23a82f21465dfb4f6de48a2bd1e4ef9de501f17abcc9e93885c91b4fa01d2c5ea01dc851de34a781ca7c9955413057663b132a79efa03cdda4f41a411c4
-  data.tar.gz: ceae617cc022f8806a168cc7a079fa60ce7a5868e58c79c65a3f227dc43cac2a1d5ff0335743d65c7fba564f9c89ab8c9b4d6514031dda2694dbb1dd017ddc26
+  metadata.gz: d033481974440dc36978a2ae3db69f0f1e37057c5eb5dd8bc7ef1ebc90af7004b72364a71f950bd6f50f487d59d5deb27122952c7646f3c3ed1620d84d26e762
+  data.tar.gz: a2453d6a80bace7d54defe1dc5e06568857715be1bf38c182fcb8c0f2d8f4847fb915e18f3d4081f25b8e00cfd9f92b8ea608b9f360899e426fd957921a55f49

data/ChangeLog.md

@@ -1,8 +1,27 @@
+## 1.0.2
+
+* Added accessor `notags`. It can be used with checklist for example. The default value is false.
+
+ ```
+ dialog = MRDialog.new()
+ dialog.notags = true
+ ```
+* Added accesor `dialog_options`. It can be used to pass any valid dialog option. `man dialog` and look at the **OPTIONS** section. It is the caller's responsibily to specify correct options, no validation will be done. Example:
+
+```
+dialog = MRDialog.new()
+dialog.dialog_options = "--no-tags"
+```
+This ia exactly same as `dialog.notags = true`
+
+(Apr-16-2016 )
+
 ## 1.0.1
 
 * Jeweler support for making the gem.
 
-* Implemented methods for: 
+Implemented methods for: 
+
 *  'buildlist' (--buildlist)
 *  'editbox' (--editbox)
 *  'form' (--form)
@@ -21,27 +40,28 @@
     dialog_ok, dialog_cancel, dialog_help, dialog_extra,
     dialog_item_help, dialog_esc
 
-* Implemented examples for:
-** buildlist
-** calendar
-** checklist
-** editbox
-** form
-** fselect
-** gauge
-** infobox
-** inputbox
-** menu
-** msgbox
-** passwordbox
-** pause
-** prgbox
-** progressbox
-** programbox
-** radiolist
-** timebox
-** treeview
-** yesno
+Implemented examples for:
+
+* buildlist
+* calendar
+* checklist
+* editbox
+* form
+* fselect
+* gauge
+* infobox
+* inputbox
+* menu
+* msgbox
+* passwordbox
+* pause
+* prgbox
+* progressbox
+* programbox
+* radiolist
+* timebox
+* treeview
+* yesno
 
 Note: The examples use Struct class, making the examples clean and 
 easy to understand. 

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) Aleks Clarks, http://rdialog.rubyforge.org/
-Copyright (c) 2014, Muhammad Muquit, http://ww.muquit.com/
+Copyright (c) 2014, Muhammad Muquit, http://www.muquit.com/
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,181 @@
+### MRDialog
+
+mrdialog is a pure 
+[ruby](https://www.ruby-lang.org/) library for the ncurses 
+[dialog](http://invisible-island.net/dialog/dialog.html) program. 
+[dialog](http://invisible-island.net/dialog/dialog.html) is
+a command line tool that can present questions, messages, forms using 
+dialog boxes from a shell script. If you compiled linux kernel and typed 'make
+menuconfig, configured Linux from command line with various configuration
+managers, you have used 'dialog' like programs.
+
+However, it is painful to program dialog from shell scripts due to lack of 
+data structure. You constantly have to watch if the correct number of 
+items are specified, if the arguments are in correct order for example. It is
+a lot of fun to program dialog from an object oriented scripting language like 
+[ruby](https://www.ruby-lang.org/). Compare the sample shell scripts of dialog program with
+the sample ruby scripts of mrdialog in the [samples](samples/) directory, I think you will
+agree.
+
+MRDialog is based on the rdialog ruby gem http://rdialog.rubyforge.org/ by
+Aleks Clark.
+
+I did the following:
+
+* Added features and support for all of the missing widgets.
+* Fixed the bugs I found.
+* Implemented the examples for all the widgets.  
+* I am in the process of documenting the APIs here.
+
+Please look at the [ChangeLog.md](ChangeLog.md) file for details. Please look at he [screenshots](screenshots/) to see how the widgets look like.
+
+If you have bug reports, questions, requests or  suggestions, please enter it in the [Issues](https://github.com/muquit/mrdialog/issues) with an appropriate label.
+
+### Latest Version
+The latest version is 1.0.2.
+
+### Screenshots
+Please look at the [screenshots](screenshots/) directory. There are individual screenshots for each of the widgets. Also the animated GIF file [all.gif](screenshots/all.gif) contains screenshot of  all the widgets. 
+
+
+### Requirements
+The [dialog](http://invisible-island.net/dialog/dialog.html) program must be installed. d Note: the dialog program that is available in ubuntu is little old. Check the dialog version by typing ```dialog --version```
+
+I tested with ```dialog Version: 1.2-20130928```
+
+dialog HOME: http://invisible-island.net/dialog/dialog.html.
+
+### To install
+
+```# gem install mrdialog```
+or
+```$ sudo gem install mrdialog```
+### To uninstall
+```# gem uninstall mrdialog``` or ```$ sudo gem uninstall mrdialog```
+   
+### Run the sample apps
+Find out where the mrdialog gem is installed. Example:
+
+    $ gem which mrdialog
+    /Library/Ruby/Gems/2.0.0/gems/mrdialog-1.0.1/lib/mrdialog.rb
+
+```cd``` to the ```samples``` directory and run the apps.
+Example:
+
+    $ cd /Library/Ruby/Gems/2.0.0/gems/mrdialog-1.0.1/samples
+    $ ./msgbox.rb
+
+
+### How to use the API
+For now, please look at the apps in [samples](samples/) directory to see how the API works. I will document the APIs here as time permits.
+
+    require 'mrdialog'
+    dialog = MRDialog.new
+
+#### Properties
+The various properties of the dialog (shadow, title etc.) can be set by calling the appropriate setters. The supported propertes are shown below:
+
+|Property|Example|Description|Default|
+|--------|-------|-----------|-------|
+|shadow|```dialog.shadow = false``` | Draw a shadow to the right and bottom of each dialog box.| true|
+|title|```dialog.title = 'foo'```|Specifies a title string to be displayed at the top of the  dialog box|N/A|
+|logger|```dialog.logger = Logger.new("dialog.log")```|Debug messages will be logged to the specified ruby Logger|N/A|
+|clear|```dialog.clear = true```|Clears the widget screen, keeping only the screen_color background.|false|
+|insecure|```dialog.insecure = true```|Makes the password widget friendlier but less secure, by echoing asterisks for each character.|false|
+|ascii_lines|```dialog.ascii_lines = true```|Rather than draw graphics lines around boxes, draw ASCII "+" and "-" in the same place.  See also "--no-lines".|false|
+|...|...|...|...|
+
+#### Widgets
+The following dialog widgets are supported:
+
+* buildlist
+* calendar
+* checklist
+* editbox
+* form
+* fselect
+* gauge
+* infobox
+* inputbox
+* menu
+* msgbox
+* passwordbox
+* passwordform
+* pause
+* prgbox
+* progressbox
+* programbox
+* radiolist
+* timebox
+* treeview
+* yesno
+    
+##### buildlist
+A  buildlist  dialog displays two lists, side-by-side.  The list on the left shows unselected items.  The list on the right shows selected  items.  As items are selected or unselected, they move between the lists. The SPACE bar is used to
+select or unselect an item.
+
+Use a carriage return or the "OK" button to accept  the  current value  in the selected-window and exit.  The results are written using the order displayed in the selected-window. The caller is responsible to create the items properly. Please look at [buildlist.rb](samples/buildlist.rb) for an example.
+
+returns an array of selected tags
+
+    result_array = dialog.buildlist(text="Text Goes Here", items, height=0, width=0, listheight=0)
+   
+#### calendar
+Please look at [calendar.rb](samples/calendar.rb) for an example.
+#### checklist
+Please look at [checklist.rb](samples/checklist.rb) for an example.
+#### editbox
+Please look at [editbox.rb](samples/editbox.rb) for an example.
+#### form
+Please look at 
+[form1.rb](samples/form1.rb), [form2.rb](samples/form2.rb), [form3.rb](samples/form3.rb) 
+for examples.
+#### fselect
+Please look at [fselect.rb](samples/fselect.rb) for an example.
+#### gauge
+Please look at [gauge.rb](samples/gauge.rb) for an example.
+#### infobox
+Please look at [infobox.rb](samples/infobox.rb) for an example.
+#### inputbox
+Please look at [inputbox.rb](samples/inputbox.rb) for an example.
+#### menu
+Please look at [menubox.rb](samples/menubox.rb) for an example.
+#### msgbox
+Please look at [msgbox.rb](samples/msgbox.rb) for an example.
+#### passwordbox
+Please look at [password.rb](samples/password.rb), [password2.rb](samples/password2.rb)
+for examples.
+#### passwordform
+Please look at [passwordform.rb](samples/passwordform.rb) for an example.
+#### pause
+Please look at [pause.rb](samples/pause.rb) for an example.
+#### prgbox
+Please look at [prgbox.rb](samples/prgbox.rb) for an example.
+#### progressbox
+Please look at [progressbox.rb](samples/progressbox.rb) for an example.
+#### programbox
+Please look at [programbox.rb](samples/programbox.rb) for an example.
+#### radiolist
+Please look at [radiolist.rb](samples/radiolist.rb) for an example.
+#### timebox
+Please look at [timebox.rb](samples/timebox.rb) for an example.
+#### treeview
+Please look at [treeview.rb](samples/treeview.rb) for an example.
+#### yesno
+Please look at [yesno.rb](samples/yesno.rb) for an example.
+
+### For Developers
+- To build: ```$ rake build```
+
+Will create the gem inside the pkg directory
+
+- To install the built gem: ```$ sudo gem install --local pkg/mrdialog-1.0.2.gem```
+
+- To install using rake: ```$ sudo rake install```
+
+- To install the gem to a specific directory: ```$ GEM_HOME=/tmp gem install --local pkg/mrdialog-1.0.2.gem```
+
+The gem will be installed in /tmp/gems directory
+
+### Copyright
+Lincense is MIT. Please look at the [LICENSE.txt](LICENSE.txt) file for details.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/mrdialog/mrdialog.rb

@@ -94,6 +94,9 @@ class MRDialog
     # 
     attr_accessor :shadow
 
+    # MMM
+    attr_accessor :notags
+
     #
     # Sleep (delay) for the given integer of seconds after processing 
     # a dialog box.
@@ -129,9 +132,12 @@ class MRDialog
   attr_accessor :dialog_ok
   attr_accessor :dialog_cancel
   attr_accessor :dialog_help
-  attr_accessor :dialog_extra
   attr_accessor :dialog_item_help
   attr_accessor :dialog_esc
+  attr_accessor :dialog_extra
+
+  # pass dialog's option exactly
+  attr_accessor :dialog_options
 
   #
   # ruby logger
@@ -166,6 +172,7 @@ class MRDialog
         # muquit@muquit.com mod starts--
         $stdout.sync = true
         $stderr.sync = true
+#        @tags = true
         @dialog_ok = DIALOG_OK
         @dialog_cancel = DIALOG_CANCEL
         @dialog_help = DIALOG_HELP
@@ -1189,6 +1196,16 @@ class MRDialog
           end
         end
 
+        unless @notags == nil
+          if @notags == true
+            ostring += "--no-tags "
+          end
+        end
+
+        if @dialog_options
+          ostring += " #{@dialog_options} "
+        end
+
         if @sleep
           ostring += "--sleep " + @sleep.to_s + " "
         end

data/samples/buildlist.rb

@@ -5,6 +5,12 @@ require 'pp'
 
 begin
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
     text = <<EOF
 This example is taken from dialog/samples/menulist
 shell script.
@@ -12,7 +18,7 @@ shell script.
 Hi, this is a buildlist dialog. The list on the left
 shows the unselected items. The list on the right shows
 the selected  items.  Use SPACE bar to select/unselect 
-items.
+items. Shadow is set to false.
 
 EOF
     items = []
@@ -56,6 +62,8 @@ EOF
 
     dialog = MRDialog.new
     dialog.clear = true
+    dialog.shadow = false
+    dialog.title = "BUILDLIST"
     dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
 
     height = 0

data/samples/calendar.rb

@@ -10,6 +10,13 @@ require 'date'
 
 begin
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
+
     text = "Please choose a date..."
 
     height = 0

data/samples/checklist.rb

@@ -5,6 +5,13 @@ require 'pp'
 
 begin
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
+
     text = <<EOF
 This example is taken from dialog/samples/radiolist
 shell script.
@@ -15,7 +22,8 @@ off. If there are more items than can fit on the
 screen, the list will be scrolled. You can use the
 UP/DOWN arrow keys, the first letter of the choice as a
 hot key, or the number keys 1-9 to choose an option.
-Press SPACE to toggle an option on/off.
+Press SPACE to toggle an option on/off. Set the option
+notags to true if you don't want to diaplay the tags.
 
   Which of the following are fruits?
 
@@ -48,16 +56,21 @@ EOF
     items.push(data.to_a)
 
     dialog = MRDialog.new
+#    dialog.notags = false
+#    dialog.dialog_options = "--no-tags"
     dialog.clear = true
+    dialog.title = "CHECKLIST"
     dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
 
     selected_items = dialog.checklist(text, items)
     exit_code = dialog.exit_code
     puts selected_items.class
     puts "Exit code: #{exit_code}"
-    puts "Selected Items:"
-    selected_items.each do |item|
-      puts "  '#{item}'"
+    if selected_items
+      puts "Selected Items:"
+      selected_items.each do |item|
+        puts "  '#{item}'"
+      end
     end
 
 rescue => e

data/samples/editbox.rb

@@ -6,6 +6,12 @@ require 'tempfile'
 
 begin
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
 
     tmp = Tempfile.new('editbox')
     tmp.puts <<-EOF
@@ -45,6 +51,7 @@ EOF
     dialog = MRDialog.new
     dialog.clear = true
     dialog.shadow = false
+    dialog.title = "EDITBOX"
     dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
 
     output = dialog.editbox(tmp.path, height, width)

data/samples/form1.rb

@@ -6,8 +6,13 @@ require 'pp'
 
 begin
     ME = File.basename($0)
-    # uid=1000(muquit) gid=1000(muquit)
-    # groups=1000(muquit),4(adm),24(cdrom),27(sudo),30(dip),46(plugdev),107(lpadmin),125(sambashare)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
+
     user = ''
     uid = ''
     gid = ''
@@ -74,6 +79,7 @@ EOF
     data.ilen = 0
     items.push(data.to_a)
 
+    dialog.title = "FORM"
     result_hash = dialog.form(text, items, 20, 50, 0)
     if result_hash
         puts "Resulting data:"

data/samples/form2.rb

@@ -9,6 +9,12 @@ require [File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'mrdialog'].join
 
 class TestForm2
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
     def initialize
         @hsh = {}
     end
@@ -135,6 +141,7 @@ EOF
             data.ilen = 0
             items.push(data.to_a)
 
+            dialog.title = "FORM"
             @hsh = dialog.form(text, items, 20, 60, 0)
             exit_code = dialog.exit_code
                 @hsh.each do |key, val|

data/samples/form3.rb

@@ -7,9 +7,15 @@ require [File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'mrdialog'].join
 require 'pp'
 
 class TestForm
-           ME = File.basename($0)
+      ME = File.basename($0)
       HIDDEN  = 1 
     READ_ONLY = 2
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
   def initialize
     @a = []
     @h = {}

data/samples/fselect.rb

@@ -6,6 +6,13 @@ require 'pp'
 
 begin
     ME = File.basename($0)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
+
     text = <<EOF
 Please set the time...
 EOF

data/samples/gauge.rb

@@ -7,6 +7,13 @@ require [File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'mrdialog'].join
 
 class TestGauge
   ME = File.basename($0)    
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   def initialize
   end
 

data/samples/infobox.rb

@@ -6,6 +6,13 @@ require 'pp'
 
 class TestInfobox
   ME = File.basename($0)    
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   def initialize
   end
 

data/samples/inputbox.rb

@@ -6,6 +6,13 @@ require 'pp'
 
 begin
   ME = File.basename($0)
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   text = <<EOF
 Hi, this is an input dialog box. You can use
 this to ask questions that require the user

data/samples/menubox.rb

@@ -4,6 +4,13 @@
 require [File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'mrdialog'].join('/')
 begin
   ME = File.basename($0)
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   dialog = MRDialog.new
   dialog.logger = Logger.new(ENV["HOME"] + "/dialog_" + ME + ".log")
   dialog.clear = true

data/samples/mixedform1.rb

@@ -6,8 +6,12 @@ require 'pp'
 
 begin
   ME = File.basename($0)
-  # uid=1000(muquit) gid=1000(muquit)
-  # groups=1000(muquit),4(adm),24(cdrom),27(sudo),30(dip),46(plugdev),107(lpadmin),125(sambashare)
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
   user = ''
   uid = ''
   gid = ''
@@ -100,6 +104,7 @@ EOF
 
   dialog.title = "mixedform"
   dialog.insecure = true
+  dialog.title = "MIXEDFORM"
   height = 20
   width = 70
   result_hash = dialog.mixedform(text, items, height, width, 0)

data/samples/msgbox.rb

@@ -6,6 +6,13 @@ require 'pp'
 
 class TestMsgbox
   ME = File.basename($0)    
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   def initialize
   end
 

data/samples/password.rb

@@ -5,6 +5,13 @@ require 'pp'
 
 begin
   ME = File.basename($0)
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   text = <<EOF
 Hi, this is an password dialog box. You can use
 this to ask questions that require the user

data/samples/password2.rb

@@ -10,6 +10,13 @@ require 'pp'
 
 begin
   ME = File.basename($0)
+  if ENV['CHANGE_TITLE']
+    if ME =~ /(.+)\.rb$/
+      base = $1
+      puts "\033]0;mrdialog - #{base}\007"
+    end
+  end
+
   text = <<EOF
 Hi, this is an password dialog box. You can use
 this to ask questions that require the user

data/samples/passwordform.rb

@@ -6,8 +6,13 @@ require 'pp'
 
 begin
     ME = File.basename($0)
-    # uid=1000(muquit) gid=1000(muquit)
-    # groups=1000(muquit),4(adm),24(cdrom),27(sudo),30(dip),46(plugdev),107(lpadmin),125(sambashare)
+    if ENV['CHANGE_TITLE']
+      if ME =~ /(.+)\.rb$/
+        base = $1
+        puts "\033]0;mrdialog - #{base}\007"
+      end
+    end
+
     user = ''
     uid = ''
     gid = ''
@@ -75,6 +80,7 @@ EOF
     items.push(data.to_a)
 
     dialog.insecure = true
+    dialog.title = "PASSWORDFORM"
     result_hash = dialog.passwordform(text, items, 20, 50, 0)
     if result_hash
         puts "Resulting data:"