mrdialog 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c194aa6f9499029c4c08c29396a683a363ae97f799e6b3f1999ba05b96680aa
-  data.tar.gz: 51f8454617486d49b17b09c48483a548c8afc0cff9dd3f57c8de25554393b7c3
+  metadata.gz: dc47a088312c9388ffd5a9e244e8671cf1cbe64bdd426654d96a8ba8acce2802
+  data.tar.gz: 69bcc7ab22b75d3fd95235f7306765040501ef889d8fbcedc1a6f2da2f2b47a3
 SHA512:
-  metadata.gz: c94e1854275425eca30ae0e3586c16b577c8f31f1a79e2df1a2c856fb4c7581572a84d8f22abf5e0a2703b00e3e1981f8eb2360a6a481c67ecf9c5547f7f9ad0
-  data.tar.gz: ee323a123ebec50e080238c0d98a4fb12588ecab8bd2d9c55acc0cfdbc6d9cd6e9af2723ae6048d0677acbc48ad534ed1bc95147e3f8be62d69698441522dfad
+  metadata.gz: 9f79425d6e6aba5eca88f8e3e9d53309b969562b4f25a4460f0fa667bd88256d85d9bd5b47abd58f7bd316bed068c0abbd7cbe01e43d6e2f52e2f9399676f554
+  data.tar.gz: b9c548304b94be40b060f9677e4f1687ec4741b8d48b58b74cb843dd846f33131679bfe31fd18c308b2eefa3f5a92f363f5dc224ce485856c573975f3588b1e9

data/ChangeLog.md

@@ -1,3 +1,34 @@
+## Table Of Contents
+  - [1.0.7](#107)
+  - [1.0.6](#106)
+  - [1.0.5](#105)
+  - [1.0.4](#104)
+  - [1.0.3](#103)
+  - [1.0.2](#102)
+  - [1.0.1](#101)
+  - [bug fixes](#bug-fixes)
+  - [0.5.0](#050)
+
+## 1.0.7
+* If any text had single quote in it e.g. "don't", "It's", the dialog 
+command was failing with syntax error. In previsous version, the dialog 
+command was wrapped with single quotes but now shell escape the values. 
+Note: this is a parsing bug fix, not a security issue. Thanks to Carl for 
+finding this bug.
+
+(Oct-18-2025)
+
+* If no item was selected in a checklist, an EOF exception was thrown. Now
+return false in that case.
+
+* Update checklist example to get selected item in an array. Before the items
+were in an array with 1 element.
+
+(Jan-23-2024)
+
+## 1.0.6
+* Ruby 3.2.0 removed File.exists? method. Change to File.exist?
+
 ## 1.0.5
 * Wrap values inside single quotes indead of double quotes. If saved values
 are reloaded in a form, special shell characters could get expanded and
@@ -98,7 +129,7 @@ Note: The examples use Struct class, making the examples clean and
 easy to understand. 
 
 
-# bug fixes:
+## bug fixes
 
 * raise exception if 'dialog' program is not found.
 * title in the option string was not quoted

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
@@ -7,9 +7,9 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 2.0"
-  gem "juwelier", "~> 2.1.0"
+  gem "rdoc", "~> 6.1.2.1"
+  gem "bundler", "~> 2.1.0"
+  gem "juwelier", ">= 2.4.9"
   gem "simplecov", ">= 0"
   gem "test-unit"
 end

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) Aleks Clarks, http://rdialog.rubyforge.org/
-Copyright (c) 2016-2023, Muhammad Muquit, https://www.muquit.com/
+Copyright (c) 2016-2025, Muhammad Muquit, https://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/Makefile

@@ -0,0 +1,29 @@
+# Created Oct-18-2025 
+VERSION := $(shell cat VERSION)
+
+all: build doc
+
+build:
+	rm -rf pkg/*
+	rake clean
+	rake gemspec
+	rake build
+	cd pkg && sha256sum mrdialog-$(VERSION).gem > sha256sum.txt
+	/bin/ls -lt ./pkg
+
+# https://github.com/muquit/markdown-toc-go
+doc:
+	markdown-toc-go -i docs/README.md -o README.md -f
+	markdown-toc-go -i docs/ChangeLog.md -o ChangeLog.md -f -no-credit
+
+release: build
+	gem push pkg/mrdialog-$(VERSION).gem
+
+install: build
+	gem install --local pkg/mrdialog-$(VERSION).gem
+
+test-install: build
+	gem install --local pkg/mrdialog-$(VERSION).gem
+	ruby -e "require 'mrdialog'; puts 'mrdialog $(VERSION) installed successfully!'"
+
+.PHONY: all build doc release install test-install

data/Notes.txt

@@ -0,0 +1,24 @@
+Notes for myself
+
+* Update VERSION if needed
+
+* If anything changed, build the gem by running
+  rake clean
+  rake gemspec
+  rake build
+  cd pkg
+
+* To look at the content of the local gem, run 
+    gem unpack file.gem
+* remove old version
+* git add <new version>
+* update md5.txt
+* commit
+* push
+
+* To publish to rubygems.org
+    gem push mrdialog-1.0.6.gem
+    Pushing gem to https://rubygems.org...
+    You have enabled multi-factor authentication. Please enter OTP code.
+    Code:   XXXXXX
+    Successfully registered gem: mrdialog (1.0.7)

data/README.md

@@ -1,13 +1,52 @@
-### MRDialog
-
-mrdialog is a pure
+## Table Of Contents
+  - [Introduction](#introduction)
+  - [Latest Version (1.0.7 - Oct-19-2025)](#latest-version-107-oct-19-2025)
+  - [To install](#to-install)
+  - [To uninstall](#to-uninstall)
+  - [Screenshots](#screenshots)
+  - [Requirements](#requirements)
+  - [Run the sample apps](#run-the-sample-apps)
+  - [How to use the API](#how-to-use-the-api)
+  - [Properties](#properties)
+  - [Widgets](#widgets)
+    - [buildlist](#buildlist)
+    - [calendar](#calendar)
+    - [checklist](#checklist)
+    - [editbox](#editbox)
+    - [form](#form)
+    - [fselect](#fselect)
+    - [gauge](#gauge)
+    - [infobox](#infobox)
+    - [textbox](#textbox)
+    - [inputbox](#inputbox)
+    - [menu](#menu)
+    - [msgbox](#msgbox)
+    - [passwordbox](#passwordbox)
+    - [passwordform](#passwordform)
+    - [pause](#pause)
+    - [prgbox](#prgbox)
+    - [progressbox](#progressbox)
+    - [programbox](#programbox)
+    - [radiolist](#radiolist)
+    - [timebox](#timebox)
+    - [treeview](#treeview)
+    - [yesno](#yesno)
+  - [Dependencies](#dependencies)
+  - [For Developers](#for-developers)
+  - [License](#license)
+
+## Introduction
+
+`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.
+dialog boxes from a shell script on terminal. If you compiled linux kernel and typed 
+`make menuconfig`, configured Linux from command line with various 
+configuration managers, you have used 'dialog' like programs. Please
+have a lookt at the [screenshots](screenshots/) on the dialogs look 
+like.
 
 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
@@ -17,7 +56,7 @@ a lot of fun to program dialog from an object oriented scripting language like
 the sample ruby scripts of mrdialog in the [samples](samples/) directory, I think you will agree. Look at [samples/extra_button/](samples/extra_button/) directory for samples on using an extra button on various input dialogs.
 
 MRDialog is based on the rdialog ruby gem http://rdialog.rubyforge.org/ by
-Aleks Clark.
+Aleks Clark (Does not seem to exist anymore).
 
 I did the following:
 
@@ -27,57 +66,73 @@ I did the following:
 
 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
+## Latest Version (1.0.7 - Oct-19-2025)
 
-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.
+The latest version is 1.0.7
 
-### Screenshots
+**Important fix in 1.0.7**: Fixed a parsing bug where dialog commands 
+would fail if any text contained apostrophes (single quotes). All special 
+characters in user input are now properly handled.
 
-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.
+Please look at the [ChangeLog.md](ChangeLog.md) file for details. Please look at the [screenshots](screenshots/) to see how the widgets look like.
 
-### Requirements
+## To install
 
-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`
+```bash
+gem install mrdialog
+or
+sudo gem install mrdialog
+```
 
-I tested with `dialog Version: 1.2-20130928`
+## To uninstall
 
-dialog HOME: http://invisible-island.net/dialog/dialog.html.
+```bash
+gem uninstall mrdialog
+or
+sudo gem uninstall mrdialog
+```
 
-### To install
 
-`# gem install mrdialog`
-or
-`$ sudo gem install mrdialog`
+## Screenshots
 
-### To uninstall
+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.
 
-`# gem uninstall mrdialog` or `$ sudo gem uninstall mrdialog`
+## Requirements
 
-### Run the sample apps
+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 `Version: 1.3-20250116`
+
+dialog HOME: http://invisible-island.net/dialog/dialog.html.
+
+
+## Run the sample apps
 
 Find out where the mrdialog gem is installed. Example:
+```bash
+gem which mrdialog
+/Users/muquit/.rvm/gems/ruby-3.2.2/gems/mrdialog-1.0.7/lib/mrdialog.rb
+```
 
-    $ gem which mrdialog
-    /Users/muquit/.rvm/gems/ruby-3.0.0/gems/mrdialog-1.0.4/lib/mrdialog.rb
 
 `cd` to the `samples` directory and run the apps.
 Example:
-
-    $ cd /Users/muquit/.rvm/gems/ruby-3.0.0/gems/mrdialog-1.0.4/samples
-    $ ./msgbox.rb
+```bash
+cd /Users/muquit/.rvm/gems/ruby-3.2.2/gems/mrdialog-1.0.7/samples
+./msgbox.rb
+```
 
 Look at samples/extra_button/ on how to use an extra button on various input
 dialogs.
 
-### How to use the API
+## 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
+## Properties
 
 The various properties of the dialog (shadow, title etc.) can be set by calling the appropriate setters. The supported properties are shown below:
 
@@ -99,7 +154,7 @@ The various properties of the dialog (shadow, title etc.) can be set by calling
 | 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 responsibility to specify correct options, no validation will be done | N/A               |
 
-#### Widgets
+## Widgets
 
 The following dialog widgets are supported:
 
@@ -111,6 +166,7 @@ The following dialog widgets are supported:
 - fselect
 - gauge
 - infobox
+- textbox
 - inputbox
 - menu
 - msgbox
@@ -125,129 +181,154 @@ The following dialog widgets are supported:
 - treeview
 - yesno
 
-##### buildlist
+### 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.
+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.
 
 returns an array of selected tags
+```bash
+result_array = dialog.buildlist(text="Text Goes Here", items, height=0, width=0, listheight=0)
+```
+- Please look at [buildlist.rb](samples/buildlist.rb) for an example.
 
-    result_array = dialog.buildlist(text="Text Goes Here", items, height=0, width=0, listheight=0)
-
-#### calendar
+### calendar
 
-Please look at [calendar.rb](samples/calendar.rb) for an example.
+- Please look at [calendar.rb](samples/calendar.rb) for an example.
 
-#### checklist
+### checklist
 
-Please look at [checklist.rb](samples/checklist.rb) for an example.
+- Please look at [checklist.rb](samples/checklist.rb) for an example.
 
-#### editbox
+### editbox
 
-Please look at [editbox.rb](samples/editbox.rb) for an example.
+- Please look at [editbox.rb](samples/editbox.rb) for an example.
 
-#### form
+### form
 
-Please look at
+- Please look at
 [form1.rb](samples/form1.rb), [form2.rb](samples/form2.rb), [form3.rb](samples/form3.rb)
 for examples.
 
-#### fselect
+### fselect
 
-Please look at [fselect.rb](samples/fselect.rb) for an example.
+- Please look at [fselect.rb](samples/fselect.rb) for an example.
 
-#### gauge
+### gauge
 
-Please look at [gauge.rb](samples/gauge.rb) for an example.
+- Please look at [gauge.rb](samples/gauge.rb) for an example.
 
-#### infobox
+### infobox
 
-Please look at [infobox.rb](samples/infobox.rb) for an example.
+- Please look at [infobox.rb](samples/infobox.rb) for an example.
 
-#### inputbox
+### textbox
+- Please look at [textbox.rb](samples/textbox.rb) for an example.
 
-Please look at [inputbox.rb](samples/inputbox.rb) for an example.
+### inputbox
 
-#### menu
+- Please look at [inputbox.rb](samples/inputbox.rb) for an example.
 
-Please look at [menubox.rb](samples/menubox.rb) for an example.
+### menu
 
-#### msgbox
+- Please look at [menubox.rb](samples/menubox.rb) for an example.
 
-Please look at [msgbox.rb](samples/msgbox.rb) for an example.
+### msgbox
 
-#### passwordbox
+- Please look at [msgbox.rb](samples/msgbox.rb) for an example.
 
-Please look at [password.rb](samples/password.rb), [password2.rb](samples/password2.rb)
+### passwordbox
+
+- Please look at [password.rb](samples/password.rb), [password2.rb](samples/password2.rb)
 for examples.
 
-#### passwordform
+### passwordform
 
-Please look at [passwordform.rb](samples/passwordform.rb) for an example.
+- Please look at [passwordform.rb](samples/passwordform.rb) for an example.
 
-#### pause
+### pause
 
-Please look at [pause.rb](samples/pause.rb) for an example.
+- Please look at [pause.rb](samples/pause.rb) for an example.
 
-#### prgbox
+### prgbox
 
-Please look at [prgbox.rb](samples/prgbox.rb) for an example.
+- Please look at [prgbox.rb](samples/prgbox.rb) for an example.
 
-#### progressbox
+### progressbox
 
-Please look at [progressbox.rb](samples/progressbox.rb) for an example.
+- Please look at [progressbox.rb](samples/progressbox.rb) for an example.
 
-#### programbox
+### programbox
 
-Please look at [programbox.rb](samples/programbox.rb) for an example.
+- Please look at [programbox.rb](samples/programbox.rb) for an example.
 
-#### radiolist
+### radiolist
 
-Please look at [radiolist.rb](samples/radiolist.rb) for an example.
+- Please look at [radiolist.rb](samples/radiolist.rb) for an example.
 
-#### timebox
+### timebox
 
-Please look at [timebox.rb](samples/timebox.rb) for an example.
+- Please look at [timebox.rb](samples/timebox.rb) for an example.
 
-#### treeview
+### treeview
 
-Please look at [treeview.rb](samples/treeview.rb) for an example.
+- Please look at [treeview.rb](samples/treeview.rb) for an example.
 
-#### yesno
+### yesno
 
-Please look at [yesno.rb](samples/yesno.rb) for an example.
+- Please look at [yesno.rb](samples/yesno.rb) for an example.
 
-### Dependencies
+## Dependencies
 
 Mrdialog does not have dependencies on any other gems. The gems in Gemfile are
 for development for building the gem.
 
 
-### For Developers
+## For Developers
 
-Note: Pre-built mrdialog-1.0.5.gem is in the pkg directory
+Note: Pre-built `mrdialog-1.0.7.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`
+```bash
+gem install bundler
+bundle install
+```
+
+- To build: 
+```bash
+  rake clean
+  rake gemspec
+  rake build
+```
 
 Will create the gem inside the pkg directory
 
-- To install the built gem: `$ sudo gem install --local pkg/mrdialog-1.0.5.gem`
+- To install the built gem: 
+```bash
+sudo gem install --local pkg/mrdialog-1.0.7.gem
+```
 
-- To install using rake: `$ sudo rake install`
+- To install using rake: 
+```bash
+sudo rake install
+```
 
-- To install the gem to a specific directory: `$ GEM_HOME=/tmp gem install --local pkg/mrdialog-1.0.5.gem`
+- To install the gem to a specific directory: 
+```bash
+    GEM_HOME=/tmp gem install --local pkg/mrdialog-1.0.7.gem`
+```
 
-The gem will be installed in /tmp/gems directory
+The gem will be installed in `/tmp/gems` directory
 
-### Copyright
+Please see the [Makefile](Makefile) for build and release commands
+
+## License
 
 License is MIT. Please look at the [LICENSE.txt](LICENSE.txt) file for details.
+
+---
+<sub>TOC is created by https://github.com/muquit/markdown-toc-go on Oct-19-2025</sub>

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.7

data/docs/ChangeLog.md

@@ -0,0 +1,132 @@
+## 1.0.7
+* If any text had single quote in it e.g. "don't", "It's", the dialog 
+command was failing with syntax error. In previsous version, the dialog 
+command was wrapped with single quotes but now shell escape the values. 
+Note: this is a parsing bug fix, not a security issue. Thanks to Carl for 
+finding this bug.
+
+(Oct-18-2025)
+
+* If no item was selected in a checklist, an EOF exception was thrown. Now
+return false in that case.
+
+* Update checklist example to get selected item in an array. Before the items
+were in an array with 1 element.
+
+(Jan-23-2024)
+
+## 1.0.6
+* Ruby 3.2.0 removed File.exists? method. Change to File.exist?
+
+## 1.0.5
+* Wrap values inside single quotes indead of double quotes. If saved values
+are reloaded in a form, special shell characters could get expanded and
+corrupt data.  Please update to v1.0.5.
+(Mar-15-2023)
+
+## 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
+
+* Juwelier support for making the gem.
+
+Implemented methods for: 
+
+*  'buildlist' (--buildlist)
+*  'editbox' (--editbox)
+*  'form' (--form)
+*  'gauge' (--gauge). Thanks to Mike Morgan.
+*  'mixedform' (--mixedform)
+*  'passwordform' (--mixedform)
+*  'pause' (--pasue)
+*  'prgbox' (--prgbox)
+*  'progressbox' (--progressbox)
+*  'progambox' (--programbox)
+*  'treeview' (--treeview)
+
+* Added accessors:
+    "logger", "clear", "ok_label <label>", "insecure", "ascii_lines"
+* Added methods to check dialog's exit code
+    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
+
+Note: The examples use Struct class, making the examples clean and 
+easy to understand. 
+
+
+## bug fixes
+
+* raise exception if 'dialog' program is not found.
+* title in the option string was not quoted
+* timebox syntax is different now.
+etc..
+
+-- muquit@muquit.com , Apr-05-2014, first cut
+
+## 0.5.0
+
+* original base code