mrdialog 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e725ccd9925f5c32dcaac2b37b2b4ee972467cf
-  data.tar.gz: 8bf881b6b328ca8985cf75515a4b10c407c82eb1
+SHA256:
+  metadata.gz: 4abf284e5f7c5aa297345dbd4506bce9997aae61093f05cb4dab1190f0c40346
+  data.tar.gz: f667bcca5f8556c139a4ee4d38e210df6f6c9163e3dfab588dfecfa8fa4766e2
 SHA512:
-  metadata.gz: e39db23a82f21465dfb4f6de48a2bd1e4ef9de501f17abcc9e93885c91b4fa01d2c5ea01dc851de34a781ca7c9955413057663b132a79efa03cdda4f41a411c4
-  data.tar.gz: ceae617cc022f8806a168cc7a079fa60ce7a5868e58c79c65a3f227dc43cac2a1d5ff0335743d65c7fba564f9c89ab8c9b4d6514031dda2694dbb1dd017ddc26
+  metadata.gz: f79b47813388ebcf37ae95d3cb3373b792cd6e929c3f83a53fa6818a39fb6909e5096c9b493c89de8ae7f4b9233a4442b0844dd2db067bc7a3f885f88f7a3ffc
+  data.tar.gz: 89ac7a47299c65fc5fef30fbfd6acaba29e9f80ae20b0fc8d57ce8a65e57cec177f3adfdc6168406882cefe1970a9e776abc04b90ff16fb398b557bfd5decdfe

data/ChangeLog.md

@@ -1,8 +1,52 @@
+## 1.0.4
+* Previously only the OK/Yes button read input from forms, menus and lists.
+If an extra button is used, it was treated the same as the Cancel/No 
+button, and no output from the form/menu/list was returned to the caller.
+
+This PR changes the various user input dialogs to treat the Extra button 
+the same way as the OK/Yes button, and to return the dialog's input to the 
+caller.
+
+Thanks to https://github.com/OtherJohnGray for pull request.
+
+(Jun-22-2022)
+
+
+## 1.0.3
+* Added accessor `rc_file`. It specifies the DIALOGRC file to use.  Default is $HOME/.dialogrc
+* Added accessor `cancel_label`. It specifies the label to use for the 'Cancel' button. 
+* Added accessor `yes_label`. It specifies the label to use for the 'Yes' button.
+* Added accessor `no_label`. It specifies the label to use for the 'No' button.
+* Added accessor `help_button`. It specifies that a help button should be added to the dialog.
+* Added accessor `help_label`. It specifies the label to use for the 'Help' button.
+* Added accessor `extra_button`. It specifies that an extra button should be added to the dialog. 
+* Added accessor `extra_label`. It specifies the label to use for the 'Extra' button.
+* Fully implemented @exit_code. The @exit_code variable wasn't being set on all dialog styles.
+
+## 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 accessor `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.
+* Juwelier support for making the gem.
+
+Implemented methods for: 
 
-* Implemented methods for: 
 *  'buildlist' (--buildlist)
 *  'editbox' (--editbox)
 *  'form' (--form)
@@ -21,27 +65,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/Gemfile

@@ -8,7 +8,8 @@ source "http://rubygems.org"
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
+  gem "bundler", ">= 2.0"
+  gem "juwelier", "~> 2.1.0"
   gem "simplecov", ">= 0"
+  gem "test-unit"
 end

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) 2016, 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,196 @@
+### 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.  
+
+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.4. 
+Please look at the [ChangeLog.md](ChangeLog.md) file for details. Please look at he [screenshots](screenshots/) to see how the widgets look like.
+
+### 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. 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. 
+
+    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|
+|rc_file|```dialog.rc_file = "/path/to/rc/file"``` | Use the specified rc file.| "$HOME/.dialogrc"|
+|yes_label|```dialog.yes_label = "Sure"``` | Use the specified label on the "Yes" button.| "Yes"|
+|no_label|```dialog.no_label = "Nope"``` | Use the specified label on the "No" button.| "No"|
+|cancel_label|```dialog.cancel_label = "Forget"``` | Use the specified label on the "Cancel" button.| "Cancel"|
+|help_button|```dialog.help_button = true``` | Include a "Help" button on the dialog.| false|
+|help_label|```dialog.help_label = "What?"``` | Use the specified label on the "Help" button.| "Help"|
+|extra_button|```dialog.extra_button = true``` | Include an "Extra" button on the dialog.| false|
+|extra_label|```dialog.extra_label = "More"``` | Use the specified label on the "Extra" button.| "Extra"|
+|dialog_options|`dialog.dialog_options="any valid dialog option"` e.g. `dialog.dialog_options="--no-tags"` for checklist|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|N/A|
+
+#### 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
+Note: Pre-built mrdialog-1.0.4.gem is in the pkg directory
+
+If you need to build the gem yourself:
+
+Install bundler first:
+
+    $ gem install bundler
+    $ bundle install
+
+- 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.4.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.4.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/Rakefile

@@ -11,8 +11,8 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "mrdialog"
   gem.homepage = "http://github.com/muquit/mrdialog"
@@ -34,7 +34,7 @@ Jeweler::Tasks.new do |gem|
   gem.files.include 'ChangeLog.md'
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new
+Juwelier::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.4