RubyGems - viewworkbook - Versions diffs - 0.2 → 0.3 - Mend

viewworkbook 0.2 → 0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +4 -4
data/doc/html/viewworkbook.html +98 -388
data/doc/man/viewworkbook.1.gz +0 -0
data/doc/rst/viewworkbook.rst +59 -51
data/lib/action.rb +4 -2
data/lib/cell.rb +13 -1
data/lib/column.rb +8 -1
data/lib/menu.rb +4 -1
data/lib/row.rb +5 -0
data/lib/sheetdata.rb +5 -2
data/lib/sheetinterface.rb +1 -1
data/viewworkbook.gemspec +10 -4
metadata +27 -9

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea17c22ed36a2ee8c245622927a8aaa61b9f3b728ad8187d1ba7b12f9ee96ce
-  data.tar.gz: ed2fed97be3c121166774666db444c4f5012e1c669087e22bb45e656c3d7f5dc
+  metadata.gz: a4943afe2b6aa8ae15fbe68bd2fa19a7414db859dbaf929bba1a1edcbea1ebf6
+  data.tar.gz: ce9062cfe21a227155394e571061a346ca789c9412dd4da9e6e20d78a0aac150
 SHA512:
-  metadata.gz: a5a5120bd2585eda4981751ca381250eba81efac51e8238da37fb0c60820c3c466da5af6fc97d8d65a9f249647f64c53c1d18727cef93fa778dc50683ea496c7
-  data.tar.gz: ad2f49b95c35e2d05e3ee5fa1f4954de464286abcefc213ce04c59d910b333ebe66be6e1ddf6cbf518ab0fc5a58a0d6ac2fd25fe1fba35875d130b15b0a31676
+  metadata.gz: 7a09911027db613cbf2b9e2a5d411164a9e45a2197d4420558e3ff646f41f14c78f07b054d1789efebb3ea3fc51c1930857c584bf8ab4bf6de23605d4c713335
+  data.tar.gz: 1ca1daf23662c17da9824a8751a5b47e7687f51bbdcc2d2df7ff3a3beb33a4a4d602b372117e34379e590f1ff8c727ae6086d88bb26672e0c2770249e41c9979

data/doc/html/viewworkbook.html CHANGED Viewed

@@ -1,361 +1,64 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
 <title>Viewworkbook</title>
 <style type="text/css">
 /*
-:Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
-:Copyright: This stylesheet has been placed in the public domain.
+:Author: Michael Uplawski
+:Contact: michael.uplawski@uplawski.eu
+:License: WTFPL 2.0, see http://www.wtfpl.net/about/
-Default cascading style sheet for the HTML output of Docutils.
-See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
-customize this style sheet.
-*/
-/* used to remove borders from tables and images */
-.borderless, table.borderless td, table.borderless th {
-  border: 0 }
-table.borderless td, table.borderless th {
-  /* Override padding for "table.docutils td" with "! important".
-     The right padding separates the table cells. */
-  padding: 0 0.5em 0 0 ! important }
-.first {
-  /* Override more specific margin styles with "! important". */
-  margin-top: 0 ! important }
-.last, .with-subtitle {
-  margin-bottom: 0 ! important }
-.hidden {
-  display: none }
-.subscript {
-  vertical-align: sub;
-  font-size: smaller }
-.superscript {
-  vertical-align: super;
-  font-size: smaller }
-a.toc-backref {
-  text-decoration: none ;
-  color: black }
-blockquote.epigraph {
-  margin: 2em 5em ; }
-dl.docutils dd {
-  margin-bottom: 0.5em }
-object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
-  overflow: hidden;
-}
-/* Uncomment (and remove this text!) to get bold-faced definition list terms
-dl.docutils dt {
-  font-weight: bold }
-*/
-div.abstract {
-  margin: 2em 5em }
-div.abstract p.topic-title {
-  font-weight: bold ;
-  text-align: center }
-div.admonition, div.attention, div.caution, div.danger, div.error,
-div.hint, div.important, div.note, div.tip, div.warning {
-  margin: 2em ;
-  border: medium outset ;
-  padding: 1em }
-div.admonition p.admonition-title, div.hint p.admonition-title,
-div.important p.admonition-title, div.note p.admonition-title,
-div.tip p.admonition-title {
-  font-weight: bold ;
-  font-family: sans-serif }
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title, .code .error {
-  color: red ;
-  font-weight: bold ;
-  font-family: sans-serif }
-/* Uncomment (and remove this text!) to get reduced vertical space in
-   compound paragraphs.
-div.compound .compound-first, div.compound .compound-middle {
-  margin-bottom: 0.5em }
-div.compound .compound-last, div.compound .compound-middle {
-  margin-top: 0.5em }
+Stylesheet for use with Docutils.
 */
-div.dedication {
-  margin: 2em 5em ;
-  text-align: center ;
-  font-style: italic }
-div.dedication p.topic-title {
-  font-weight: bold ;
-  font-style: normal }
-div.figure {
-  margin-left: 2em ;
-  margin-right: 2em }
-div.footer, div.header {
-  clear: both;
-  font-size: smaller }
-div.line-block {
-  display: block ;
-  margin-top: 1em ;
-  margin-bottom: 1em }
-div.line-block div.line-block {
-  margin-top: 0 ;
-  margin-bottom: 0 ;
-  margin-left: 1.5em }
-div.sidebar {
-  margin: 0 0 0.5em 1em ;
-  border: medium outset ;
-  padding: 1em ;
-  background-color: #ffffee ;
-  width: 40% ;
-  float: right ;
-  clear: right }
-div.sidebar p.rubric {
-  font-family: sans-serif ;
-  font-size: medium }
-div.system-messages {
-  margin: 5em }
-div.system-messages h1 {
-  color: red }
+/* The defaults for docutils */
+@import url(html4css1.css);
-div.system-message {
-  border: medium outset ;
-  padding: 1em }
-div.system-message p.system-message-title {
-  color: red ;
-  font-weight: bold }
-div.topic {
-  margin: 2em }
-h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
-h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
-  margin-top: 0.4em }
-h1.title {
-  text-align: center }
-h2.subtitle {
-  text-align: center }
-hr.docutils {
-  width: 75% }
-img.align-left, .figure.align-left, object.align-left, table.align-left {
-  clear: left ;
-  float: left ;
-  margin-right: 1em }
-img.align-right, .figure.align-right, object.align-right, table.align-right {
-  clear: right ;
-  float: right ;
-  margin-left: 1em }
-img.align-center, .figure.align-center, object.align-center {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
+body {
+  background-color:#300020;
+  font-family: Verdana,Helvetica,Univers;
+  color:#f0f0f0;
+  color:#f0f0f0;
 }
-table.align-center {
-  margin-left: auto;
-  margin-right: auto;
+h1 {color:cyan;font-size:1.5em;}
+h1.title {color:#a0a0f0;font-size:2em;}
+h2 {color:#ffffa0;}
+p, ul.simple, ol.simple, dt {margin-left:2em;}
+p.first {font-weight:bold;}
+dd {margin-left:4em;}
+td {color:#f0f080;}
+/* correct left margin of nested block tags*/
+dd {}
+dd p, li p {margin-left:0;}
+dd * ul {margin-left:0 ! important; }
+dd ul {margin-left:0 ! important; }
+dd dl dt, dd dl dd {margin-left:0 ! important;}
+dt {font-weight:bold;}
+dt, dd {color:#f0f0f0}
+tt.docutils {color:#000080;
+  background-color:#a080a0;
+  padding-left:3px;
+  padding-right:3px;
+  white-space:nowrap;
 }
-.align-left {
-  text-align: left }
-.align-center {
-  clear: both ;
-  text-align: center }
+a.external {color:#ff90ff;}
-.align-right {
-  text-align: right }
-/* reset inner alignment in figures */
-div.align-right {
-  text-align: inherit }
-/* div.align-center * { */
-/*   text-align: left } */
-.align-top    {
-  vertical-align: top }
-.align-middle {
-  vertical-align: middle }
-.align-bottom {
-  vertical-align: bottom }
-ol.simple, ul.simple {
-  margin-bottom: 1em }
-ol.arabic {
-  list-style: decimal }
-ol.loweralpha {
-  list-style: lower-alpha }
-ol.upperalpha {
-  list-style: upper-alpha }
-ol.lowerroman {
-  list-style: lower-roman }
-ol.upperroman {
-  list-style: upper-roman }
-p.attribution {
-  text-align: right ;
-  margin-left: 50% }
-p.caption {
-  font-style: italic }
-p.credits {
-  font-style: italic ;
-  font-size: smaller }
-p.label {
-  white-space: nowrap }
-p.rubric {
-  font-weight: bold ;
-  font-size: larger ;
-  color: maroon ;
-  text-align: center }
-p.sidebar-title {
-  font-family: sans-serif ;
-  font-weight: bold ;
-  font-size: larger }
-p.sidebar-subtitle {
-  font-family: sans-serif ;
-  font-weight: bold }
-p.topic-title {
-  font-weight: bold }
-pre.address {
-  margin-bottom: 0 ;
-  margin-top: 0 ;
-  font: inherit }
-pre.literal-block, pre.doctest-block, pre.math, pre.code {
-  margin-left: 2em ;
-  margin-right: 2em }
-pre.code .ln { color: grey; } /* line numbers */
-pre.code, code { background-color: #eeeeee }
-pre.code .comment, code .comment { color: #5C6576 }
-pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
-pre.code .literal.string, code .literal.string { color: #0C5404 }
-pre.code .name.builtin, code .name.builtin { color: #352B84 }
-pre.code .deleted, code .deleted { background-color: #DEB0A1}
-pre.code .inserted, code .inserted { background-color: #A3D289}
-span.classifier {
-  font-family: sans-serif ;
-  font-style: oblique }
-span.classifier-delimiter {
-  font-family: sans-serif ;
-  font-weight: bold }
-span.interpreted {
-  font-family: sans-serif }
-span.option {
-  white-space: nowrap }
-span.pre {
-  white-space: pre }
-span.problematic {
-  color: red }
-span.section-subtitle {
-  /* font-size relative to parent (h1..h6 element) */
-  font-size: 80% }
-table.citation {
-  border-left: solid 1px gray;
-  margin-left: 1px }
-table.docinfo {
-  margin: 2em 4em }
-table.docutils {
-  margin-top: 0.5em ;
-  margin-bottom: 0.5em }
-table.footnote {
-  border-left: solid 1px black;
-  margin-left: 1px }
-table.docutils td, table.docutils th,
-table.docinfo td, table.docinfo th {
-  padding-left: 0.5em ;
-  padding-right: 0.5em ;
-  vertical-align: top }
-table.docutils th.field-name, table.docinfo th.docinfo-name {
-  font-weight: bold ;
-  text-align: left ;
-  white-space: nowrap ;
-  padding-left: 0 }
-/* "booktabs" style (no vertical lines) */
-table.docutils.booktabs {
-  border: 0px;
-  border-top: 2px solid;
-  border-bottom: 2px solid;
-  border-collapse: collapse;
+blockquote {background-color:#400020;
+  padding:0.5em;
+  border-radius:1em;
+  border-style:dotted;
+  border-width:0.5pt;
 }
-table.docutils.booktabs * {
-  border: 0px;
-}
-table.docutils.booktabs th {
-  border-bottom: thin solid;
-  text-align: left;
-}
-h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
-h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
-  font-size: 100% }
-ul.auto-toc {
-  list-style-type: none }
 </style>
 </head>
@@ -370,26 +73,32 @@ ul.auto-toc {
 </div>
 <div class="section" id="description">
 <h1>DESCRIPTION</h1>
-<p>Viewworkbook lets you read spreadsheet-files in text-mode, in a terminal
-window. It reproduces the tables which are contained in a spreadsheet file and
+<p>ViewWorkbook allows you to read spreadsheet files in text mode in a terminal
+window. It reproduces the tables contained in a spreadsheet file and It also
 lets you navigate through the sheets. The visible part of a sheet is limited
-laterally and horizontally by the terminal-size but can be scrolled. You can
-adapt the width of table-columns, to render the table more readable and
-finally, if you wish, save tables to a text-file.  To the author of the
-program, the utility serves to take a quick glance at spreadsheets that are
-received via email, in the Mutt mail-client, which is itself a terminal
+laterally and horizontally by the size of the terminal, but you can scroll
+through it. You can adapt the width of table columns to make the table more
+readable.  Finally, you can save tables to a text file if you wish.  For the
+author of the program, the utility serves to quickly glance at spreadsheets
+that are received via email in the Mutt mail client, which is a terminal
 application.</p>
-<p>The supported spreadsheet formats are those which are handled by the Ruby-gem
-&quot;<strong>roo</strong>&quot; (February 2017):</p>
+<p>Supported spreadsheet formats are those handled by the Ruby gem &quot;<strong>roo</strong>&quot;
+(2024, roo 2.10.1):</p>
+<ul class="simple">
+<li>Microsoft™  Excel 2007 - 2013 formats (<strong>xlsx</strong>, <strong>xlsm</strong>)</li>
+<li>LibreOffice / OpenOffice.org formats (<strong>ods</strong>)</li>
+<li>CSV</li>
+<li>Microsoft™ Excel 97, Excel 2002 XML, and Excel 2003 XML formats (<strong>xls</strong>,
+<strong>xml</strong>)</li>
+</ul>
+<p>Additionally also</p>
 <ul class="simple">
-<li>Microsoft™'s <strong>xls</strong> and <strong>xlsx</strong>,</li>
-<li>the OpenDocument spreadsheet <strong>ods</strong></li>
-<li>and the SoftMaker™ spreadsheet formats <strong>pmd</strong> and <strong>pmdx</strong>.</li>
+<li>The SoftMaker™ spreadsheet formats <strong>pmd</strong> and <strong>pmdx</strong>.</li>
 </ul>
 </div>
 <div class="section" id="options">
 <h1>Options</h1>
-<p>Other than the path to the spreadsheet file, viewworkbook does currently not
+<p>Other than the path to the spreadsheet file, viewworkbook does not currently
 interpret any command line arguments.</p>
 <div class="section" id="menu-commands">
 <h2>Menu commands</h2>
@@ -448,40 +157,41 @@ below the current table:</p>
 </tbody>
 </table>
 <p><strong>value (v) * save to file (f) * sheet (s) * column (c) * up(i) * down(k) * left(j) * right(l) * quit (q) *</strong></p>
-<p>When you enter one of the hotkeys, a command can be executed directly (like &quot;q&quot;
-to terminate the program), a sub-menu may be shown (like with &quot;c&quot; which shall
-give you control on column properties) or you are confronted with an input
-invitation (like with &quot;v&quot;, where you have to enter a cell-reference).  Read on
-for an explanation of each menu command.</p>
+<p>When you press one of the hotkeys, you can execute a command directly (like &quot;q&quot;
+to terminate the program) or a submenu may appear (like with &quot;c&quot; which gives
+you control over column properties) or you may be prompted for input (like with
+&quot;v&quot;, where you have to enter a cell reference).  Read on for an explanation of
+each menu command.</p>
 <blockquote>
 <dl class="docutils">
 <dt>value (v)</dt>
 <dd>display the value from a cell. This is useful, when columns are not wide
-enough to show complete values.  After entering &quot;<strong>v</strong>&quot;, you are
+enough to show the full value.  After entering &quot;<strong>v</strong>&quot;, you are
 immediately invited to enter a cell reference.  Cells are referenced in
-the format &quot;Column:Row&quot;, e.g. D:12 for the cell in column &quot;D&quot; and row
+the format &quot;column:row&quot;, e.g. D:12 for the cell in column &quot;D&quot; and row
 &quot;12&quot;.</dd>
 <dt>save to file (f)</dt>
-<dd>Save the current or all tables to a text file. The command does initially
-show two alternative sub-commands:</dd>
+<dd>Save the current table or all tables to a text file. Initially, the command
+shows two alternative sub-commands:</dd>
 <dt>Current sheet (c) * all sheets (a)</dt>
-<dd>Independently of your choice, in the next step you will have to enter the
-path to the output file.  You will be warned, if the file already exists
-and may choose to either overwrite the existing file or name a different
-one.</dd>
+<dd>Regardless of your choice, you will be prompted to enter the output file
+path in the next step. You will receive a warning, if the file already
+exists at which point you can choose to either overwrite the existing file
+or give it a different name.</dd>
 <dt>sheet (s)</dt>
-<dd>Navigate to a different sheet in the current workbook. You may choose
-between a sheet-number and the name of a sheet. If you want to indicate
-the next sheet <strong>by name</strong>, the list of all available names is first
-shown. You just type right away the one that you want.</dd>
+<dd>Navigate to a different sheet whthin the current workbook. You can choose
+a sheet by its number or by its name. If you want to select the next sheet
+<strong>by name</strong>, a list of available names will first be shown. You just type
+the name you want.</dd>
 <dt>column (c)</dt>
-<dd>Alter the properties of the table-columns.  At the time of this writing
-(February 2017) the only property that can be changed, is the width of all
-columns.  When you enter &quot;<strong>c</strong>&quot; the subcommand column width (w) is shown.
-After entering &quot;<strong>w</strong>&quot; you can enter the desired width in characters.</dd>
+<dd>Alter the properties of the table columns. As of February 2017 the only
+property that can be changed, is the width of all columns.  When you enter
+&quot;<strong>c</strong>&quot; the subcommand column width (w) is shown.  After entering &quot;<strong>w</strong>&quot;
+you can enter the desired width in characters.</dd>
 <dt>Arrows(i, j, k, l)</dt>
-<dd>Navigate in a sheet that is too big to be displayed entirely at once.
-These hotkeys correspond to the default navigation keys in the vi editor.</dd>
+<dd>Use these hotkeys to navigate a sheet that is too big to be displayed
+entirely at once. These hotkeys correspond to the default navigation keys
+in the Vi editor.</dd>
 <dt>quit (q)</dt>
 <dd>Enter &quot;<strong>q</strong>&quot; to quit the program at any moment except when an input
 invitation is shown.</dd>
@@ -489,9 +199,9 @@ invitation is shown.</dd>
 </blockquote>
 </div>
 <div class="section" id="hidden-menu-commands">
-<h2>Hidden (menu-)commands</h2>
-<p>There is currently only one such command available:
-The <strong>Escape-key</strong> will interrupt an unfinished action and refresh the display.</p>
+<h2>Hidden menu commands</h2>
+<p>Currently, there is only one such command available. Pressing the <strong>Escape
+key</strong> will interrupt an unfinished action and refresh the display.</p>
 </div>
 </div>
 <div class="section" id="other-information">
@@ -499,18 +209,18 @@ The <strong>Escape-key</strong> will interrupt an unfinished action and refresh
 <blockquote>
 <dl class="docutils">
 <dt>Development and source code</dt>
-<dd>Viewworkbook has been written in Ruby. As Ruby is an interpreted programming
-language, the executable file and all those that it may refer to at one
-point in time, are themselves the source-files of the current
-program-version. You can open them in any text-editor to scrutinize the
-source-code. If you have received the program as a Ruby-gem, you can also
-decompress a copy of the gem-file with <strong>tar -x</strong>, then <strong>tar -xzf</strong>.</dd>
+<dd>Viewworkbook has been written in Ruby. Since Ruby is an interpreted programming
+language, the executable file and all files to which it refers at any given time
+are the source files of the current program version. You can open these
+files in any text editor to examine the source code. If you have received
+the program as a Ruby-gem, you can also decompress a copy of the gem-file
+with <strong>tar -x</strong>, then <strong>tar -xzf</strong>.</dd>
 <dt>Bugs</dt>
-<dd>Negative values are not always displayed, when very long (like 15 ciphers).
-Enlarging the column-width further does not have an effect.</dd>
+<dd>Negative values are not always displayed, when they are very long (like 15
+ciphers). Increasing the column width further does not help.</dd>
 <dt>License</dt>
-<dd>Viewworkbook is distributed under the conditions of the GNU General Public
-License, version 3.</dd>
+<dd>Viewworkbook is distributed under the conditions of the WTFPL 2.0 or later,
+see <a class="reference external" href="http://www.wtfpl.net/about/">http://www.wtfpl.net/about/</a> for details</dd>
 <dt>Author</dt>
 <dd>Viewworkbook has been developed by Michael Uplawski
 &lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</dd>

data/doc/man/viewworkbook.1.gz CHANGED Viewed

Binary file

data/doc/rst/viewworkbook.rst CHANGED Viewed

@@ -11,28 +11,35 @@ viewworkbook <spreadsheet>
 DESCRIPTION
 =============
-Viewworkbook lets you read spreadsheet-files in text-mode, in a terminal
-window. It reproduces the tables which are contained in a spreadsheet file and
+ViewWorkbook allows you to read spreadsheet files in text mode in a terminal
+window. It reproduces the tables contained in a spreadsheet file and It also
 lets you navigate through the sheets. The visible part of a sheet is limited
-laterally and horizontally by the terminal-size but can be scrolled. You can
-adapt the width of table-columns, to render the table more readable and
-finally, if you wish, save tables to a text-file.  To the author of the
-program, the utility serves to take a quick glance at spreadsheets that are
-received via email, in the Mutt mail-client, which is itself a terminal
+laterally and horizontally by the size of the terminal, but you can scroll
+through it. You can adapt the width of table columns to make the table more
+readable.  Finally, you can save tables to a text file if you wish.  For the
+author of the program, the utility serves to quickly glance at spreadsheets
+that are received via email in the Mutt mail client, which is a terminal
 application.
-The supported spreadsheet formats are those which are handled by the Ruby-gem
-"**roo**" (February 2017):
+Supported spreadsheet formats are those handled by the Ruby gem "**roo**"
+(2024, roo 2.10.1):
-- Microsoft™'s **xls** and **xlsx**,
+- Microsoft™  Excel 2007 - 2013 formats (**xlsx**, **xlsm**)
-- the OpenDocument spreadsheet **ods**
+- LibreOffice / OpenOffice.org formats (**ods**)
-- and the SoftMaker™ spreadsheet formats **pmd** and **pmdx**.
+- CSV
+- Microsoft™ Excel 97, Excel 2002 XML, and Excel 2003 XML formats (**xls**,
+  **xml**)
+Additionally also
+- The SoftMaker™ spreadsheet formats **pmd** and **pmdx**.
 Options
 =============
-Other than the path to the spreadsheet file, viewworkbook does currently not
+Other than the path to the spreadsheet file, viewworkbook does not currently
 interpret any command line arguments.
 Menu commands
@@ -52,72 +59,73 @@ below the current table:
 **value (v) * save to file (f) * sheet (s) * column (c) * up(i) * down(k) * left(j) * right(l) * quit (q) ***
-When you enter one of the hotkeys, a command can be executed directly (like "q"
-to terminate the program), a sub-menu may be shown (like with "c" which shall
-give you control on column properties) or you are confronted with an input
-invitation (like with "v", where you have to enter a cell-reference).  Read on
-for an explanation of each menu command.
+When you press one of the hotkeys, you can execute a command directly (like "q"
+to terminate the program) or a submenu may appear (like with "c" which gives
+you control over column properties) or you may be prompted for input (like with
+"v", where you have to enter a cell reference).  Read on for an explanation of
+each menu command.
   value (v)
      display the value from a cell. This is useful, when columns are not wide
-     enough to show complete values.  After entering "**v**", you are
+     enough to show the full value.  After entering "**v**", you are
      immediately invited to enter a cell reference.  Cells are referenced in
-     the format "Column:Row", e.g. D:12 for the cell in column "D" and row
+     the format "column:row", e.g. D:12 for the cell in column "D" and row
      "12".
   save to file (f)
-     Save the current or all tables to a text file. The command does initially
-     show two alternative sub-commands:
+     Save the current table or all tables to a text file. Initially, the command
+     shows two alternative sub-commands:
   Current sheet (c) * all sheets (a)
-     Independently of your choice, in the next step you will have to enter the
-     path to the output file.  You will be warned, if the file already exists
-     and may choose to either overwrite the existing file or name a different
-     one.
+     Regardless of your choice, you will be prompted to enter the output file
+     path in the next step. You will receive a warning, if the file already
+     exists at which point you can choose to either overwrite the existing file
+     or give it a different name.
   sheet (s)
-     Navigate to a different sheet in the current workbook. You may choose
-     between a sheet-number and the name of a sheet. If you want to indicate
-     the next sheet **by name**, the list of all available names is first
-     shown. You just type right away the one that you want.
+     Navigate to a different sheet whthin the current workbook. You can choose
+     a sheet by its number or by its name. If you want to select the next sheet
+     **by name**, a list of available names will first be shown. You just type
+     the name you want.
   column (c)
-     Alter the properties of the table-columns.  At the time of this writing
-     (February 2017) the only property that can be changed, is the width of all
-     columns.  When you enter "**c**" the subcommand column width (w) is shown.
-     After entering "**w**" you can enter the desired width in characters.
+     Alter the properties of the table columns. As of February 2017 the only
+     property that can be changed, is the width of all columns.  When you enter
+     "**c**" the subcommand column width (w) is shown.  After entering "**w**"
+     you can enter the desired width in characters.
   Arrows(i, j, k, l)
-     Navigate in a sheet that is too big to be displayed entirely at once.
-     These hotkeys correspond to the default navigation keys in the vi editor.
+     Use these hotkeys to navigate a sheet that is too big to be displayed
+     entirely at once. These hotkeys correspond to the default navigation keys
+     in the Vi editor.
   quit (q)
      Enter "**q**" to quit the program at any moment except when an input
      invitation is shown.
-Hidden (menu-)commands
-------------------------
-There is currently only one such command available:
-The **Escape-key** will interrupt an unfinished action and refresh the display.
+Hidden menu commands
+---------------------
+Currently, there is only one such command available. Pressing the **Escape
+key** will interrupt an unfinished action and refresh the display.
 Other Information
 =================
   Development and source code
-   Viewworkbook has been written in Ruby. As Ruby is an interpreted programming
-   language, the executable file and all those that it may refer to at one
-   point in time, are themselves the source-files of the current
-   program-version. You can open them in any text-editor to scrutinize the
-   source-code. If you have received the program as a Ruby-gem, you can also
-   decompress a copy of the gem-file with **tar -x**, then **tar -xzf**.
+   Viewworkbook has been written in Ruby. Since Ruby is an interpreted programming
+   language, the executable file and all files to which it refers at any given time
+   are the source files of the current program version. You can open these
+   files in any text editor to examine the source code. If you have received
+   the program as a Ruby-gem, you can also decompress a copy of the gem-file
+   with **tar -x**, then **tar -xzf**.
   Bugs
-    Negative values are not always displayed, when very long (like 15 ciphers).
-    Enlarging the column-width further does not have an effect.
+    Negative values are not always displayed, when they are very long (like 15
+    ciphers). Increasing the column width further does not help.
   License
-    Viewworkbook is distributed under the conditions of the GNU General Public
-    License, version 3.
+    Viewworkbook is distributed under the conditions of the WTFPL 2.0 or later,
+    see http://www.wtfpl.net/about/ for details
   Author
     Viewworkbook has been developed by Michael Uplawski

data/lib/action.rb CHANGED Viewed

@@ -26,13 +26,13 @@ class Action
   attr_accessor :name, :key, :proc, :global, :hidden
+  # return a string representation of the action
   def to_s
     "[#<" << classname << ':' << hash << '@name="' << name << '", @key="' << key << '">'
   end
+  # create an action
   def initialize(options = {}, &b)
     @name = options[:name]
     @key = options[:key]
     @proc = b if b
@@ -40,6 +40,7 @@ class Action
     @hidden = options[:hidden]
   end
+  # execute te action
   def call(*args)
     unless @proc
       raise ActionError.new((@name ? '' : 'Unnamed ') << 'action' << (@name ? (' ' << @name) : '') << ' called before a command was defined')
@@ -47,3 +48,4 @@ class Action
     @proc.call(*args)
   end
 end
+# Ω

data/lib/cell.rb CHANGED Viewed

@@ -26,6 +26,7 @@ class Cell
   include BasicLogging
+  # create a cell in co:row and enter a value
   def initialize(row = nil, col = nil, value = nil)
     @row = row if row
     @col = col if col
@@ -38,18 +39,22 @@ class Cell
     debug(@debinfo << "cell.initialize, lines is #{@lines}, value is #{value}, ideal_width is #{@ideal_width}")
   end
+  # returns self
   def to_cell()
     self
   end
+  # return a line from the cell
   def line(num = nil)
     num && num < @lines.length ? @lines[num].to_s : ' ' if @lines && !@lines.empty?
   end
+  # returns a string representation of the cell
   def to_s
     object_id.to_s << "{" << @row.number.to_s << ":" << @col.number.to_s << ", " << @lines.to_s << ", " << @ideal_height.to_s << ", " << @ideal_width.to_s << " }"
   end
+  # resizes the cell to its ideal value.
   def resize
     @@split_pattern = nil
     split_value
@@ -57,6 +62,7 @@ class Cell
     @row.resize
   end
+  # set the value of the cell
   def value=(value)
     @@split_pattern = nil
     @value = value
@@ -64,10 +70,12 @@ class Cell
     debug(@debinfo << 'after split_value, lines is ' <<  @lines.to_s)
   end
+  # returns the column number of the cell
   def col
     @col.number
   end
+  # returns the row number of the cell
   def row
     @row.number
   end
@@ -76,6 +84,9 @@ class Cell
   private
+  # handle long values in a way to make part of them
+  # visible, hide the remainder, if the cell ist too
+  # small.
   def split_value()
     # The regex may be used in many cells. Define on class-level.
     # And...
@@ -100,6 +111,7 @@ class Cell
     @row.resize
   end
+  # Determines the ideal height and width of the cell
   def set_limits
     if @lines && !@lines.empty?
       @ideal_height = @lines.length

data/lib/column.rb CHANGED Viewed

@@ -31,7 +31,8 @@ class Column
     @width = @@col_width
     @@columns << self
   end
+  # add a cell to the column
   def add(cell)
     n_cell = nil
     if cell.respond_to?(:to_cell)
@@ -48,16 +49,19 @@ class Column
     set_limits
   end
+  #  execute the block for each cell in the column
   def each(&b)
     @cells.each do |c|
       yield(c)
     end
   end
+  # return the width of the column
   def self::col_width
     @@col_width
   end
+  # set the column width to w
   def self::col_width=(w)
     @@col_width = w
     debug(@number.to_s << ' ' <<"self::col_width=(#{w}), calling resize")
@@ -65,12 +69,14 @@ class Column
     @@columns.each {|col| col.resize(w)}
   end
+  # resize the column to width
   def resize(width)
     @width = width
     debug(@number.to_s << ' ' <<'calling resize')
     @cells.each {|cell| cell.resize}
   end
+  # returns a string representation of the column
   def to_s
     '<' << self.class.name.dup << ':' << object_id.to_s << "{number=%s width=%s cells.length=}>" %[@number, @cells.length]
   end
@@ -80,6 +86,7 @@ class Column
   private
+  # determine ideal width of the column
   def set_limits
     @ideal_width = @cells.max{|c1, c2| c1.ideal_width <=> c2.ideal_width}.ideal_width
     @ideal_width ||= @@DEF_WIDTH

data/lib/menu.rb CHANGED Viewed

@@ -22,7 +22,6 @@ require_relative 'user_input'
 # Shows options that the user can choose from.
 # Options may be associated with sub-menus.
 class Menu
   include BasicLogging
@@ -33,6 +32,7 @@ class Menu
   @@global_elements = []
   @@hidden_elements = []
+  # create the menu
   def initialize(options = {})
     @elements = []
     if(options && !options.respond_to?(:to_hash) )
@@ -42,10 +42,12 @@ class Menu
     @key = options[:key] if options[:key]
   end
+  # display menu
   def call(*args)
     show()
   end
+  # add an action or sub menu to the menu
   def add(element, pos = nil)
     if(element.respond_to?(:call))
       if(pos)
@@ -67,6 +69,7 @@ class Menu
   end
   private
+  # display menu and react to user input.
   def show()
     @elements.each do |ele|
       name = ele.name.downcase

data/lib/row.rb CHANGED Viewed

@@ -28,6 +28,7 @@ class Row
     @height = 1
   end
+  # add a cell to the row
   def add(cell)
     n_cell = nil
     if cell.respond_to?(:to_cell)
@@ -44,12 +45,15 @@ class Row
     resize()
   end
+  # execute block on each cell in the row
   def each(&b)
     @cells.each do |c|
       yield(c)
     end
   end
+  # adapt the height of the row to the ideal height of the
+  # highest cell
   def resize()
     if(@cells && ! @cells.empty? )
       if(@cells.length == 1 )
@@ -62,6 +66,7 @@ class Row
     @height ||= @@DEF_HEIGHT
   end
+  # returns a string representation of the row
   def to_s
     '#<' << self.class.name << ':' << object_id.to_s << "{number=%s height=%s cells.length=%s}" %[@number.to_s, @height.to_s, @cells.length.to_s]
   end

data/lib/sheetdata.rb CHANGED Viewed

@@ -2,7 +2,7 @@
 =begin
 /***************************************************************************
- *   ©2016-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *   ©2016-2025, Michael Uplawski <michael.uplawski@uplawski.eu>           *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the WTFPL 2.0 or later, see                     *
@@ -21,7 +21,6 @@ require 'roo-xls'
 require_relative 'basic_logging'
-# Transforms a file into a Roo spreadsheet instance.
 ODS_Magic  = "OpenDocument Spreadsheet"
 XLS_Magic  = "Composite Document File V2 Document"
@@ -36,6 +35,9 @@ CSV_MIME  = "text/plain"
 # SoftMaker Office
 PMDX_MIME = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+=begin
+Transforms a file into a Roo spreadsheet instance.
+=end
 class SheetData
   # logs on class level
   self.extend BasicLogging
@@ -43,6 +45,7 @@ class SheetData
   @@file = nil
   @@workbook = nil
+  # returns a new workbook
   def self::workbook(file)
     @@file = file
     if !@@workbook

data/lib/sheetinterface.rb CHANGED Viewed

@@ -68,7 +68,7 @@ class SheetInterface
     size = `stty size`.split.map { |x| x.to_i }.reverse
     return size
   end
-  # Asks the user to enter a number, then verifies ageinst eventual
+  # Asks the user to enter a number, then verifies against eventual
   # constraints.
   def ask_number(question, &constraint)
     num = nil

data/viewworkbook.gemspec CHANGED Viewed

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'viewworkbook'
-  s.version     = '0.2'
-  s.date        = '2024-01-03'
-  s.summary     = "New logging module, new License, runtime-dependencies corrected."
-  s.summary << "Better support for SoftMaker's PMDX format"
+  s.version     = '0.3'
+  s.date        = '2025-08-29'
+  s.summary     = "Documentation text improved, "
+  s.summary << "List of dependencies completed."
   s.description = "View spreadsheet files in a text-console."
   s.authors     = ["Michael Uplawski"]
   s.email       = 'michael.uplawski@uplawski.eu'
@@ -13,8 +13,14 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://rubygems.org/gems/viewworkbook'
   s.requirements = 'roo, roo-xls, ruby-filemagic'
   s.add_runtime_dependency 'roo', '~> 2.4', '>= 2.4.0'
+  s.add_runtime_dependency 'roo-xls', '~> 1.2', '>= 1.2.0'
   s.add_runtime_dependency 'ruby-filemagic', '~> 0.3', '>= 0.3.2'
   s.executables = 'viewworkbook'
   s.license     = 'Nonstandard'
   s.required_ruby_version = '>= 3.0'
+  s.metadata = {
+    "homepage_uri" => 'https://www.uplawski.eu/software/viewworkbook/',
+    "documentation_uri" => 'https://www.uplawski.eu/software/viewworkbook/viewworkbook.html'
+  }
 end

metadata CHANGED Viewed

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: viewworkbook
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Michael Uplawski
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2025-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roo
@@ -30,6 +29,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: roo-xls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
@@ -84,8 +103,9 @@ files:
 homepage: http://rubygems.org/gems/viewworkbook
 licenses:
 - Nonstandard
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://www.uplawski.eu/software/viewworkbook/
+  documentation_uri: https://www.uplawski.eu/software/viewworkbook/viewworkbook.html
 rdoc_options: []
 require_paths:
 - lib
@@ -101,9 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - roo, roo-xls, ruby-filemagic
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: New logging module, new License, runtime-dependencies corrected.Better support
-  for SoftMaker's PMDX format
+summary: Documentation text improved,List of dependencies completed.
 test_files: []