viewworkbook 0.1.3

data/doc/rst/viewworkbook.rst

@@ -0,0 +1,126 @@
+========================
+Viewworkbook
+========================
+------------------------------------------------
+ view spreadsheet files in a terminal window
+------------------------------------------------
+
+SYNOPSIS
+=============
+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
+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
+application.
+
+The supported spreadsheet formats are those which are handled by the Ruby-gem
+"**roo**" (February 2017):
+  
+- Microsoft™'s **xls** and **xlsx**, 
+
+- the OpenDocument spreadsheet **ods**
+
+- and the SoftMaker™ spreadsheet formats **pmd** and **pmdx**.
+
+Options
+=============
+Other than the path to the spreadsheet file, viewworkbook does currently not
+interpret any command line arguments.
+
+Menu commands
+-------------------
+A list of commands and their associated hotkeys (in parenthesis) is shown
+below the current table:
+
++--+--------+--------+--------+--------+--------+--------+--------+
+|11| 12.2   |  July  |  34000 | 5%     | prior  | 1957   | true   |
++--+--------+--------+--------+--------+--------+--------+--------+
+|12|  2.33  |  July  |   1234 | 12.2%  | prior  | 1966   | true   |
++--+--------+--------+--------+--------+--------+--------+--------+
+|13| 50.0   | August | 334566 | 12%    | in     | 1966   | false  |
++==+========+========+========+========+========+========+========+
+|  |       A|       B|       C|       D|       E|       F|       G|
++--+--------+--------+--------+--------+--------+--------+--------+
+
+**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.  
+
+  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
+     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
+     "12".
+
+  save to file (f)
+     Save the current or all tables to a text file. The command does initially
+     show 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.
+
+  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.
+
+  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.
+
+  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.
+
+  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.
+  
+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**. 
+
+  Bugs 
+    Negative values are not always displayed, when very long (like 15 ciphers).
+    Enlarging the column-width further does not have an effect.
+
+  License 
+    Viewworkbook is distributed under the conditions of the GNU General Public
+    License, version 3.
+
+  Author 
+    Viewworkbook has been developed by Michael Uplawski
+    <michael.uplawski@uplawski.eu>
+
+**Ω**

data/lib/action.rb

@@ -0,0 +1,57 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   Copyright © 2014, Michael Uplawski <michael.uplawski@uplawski.eu>     *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+require_relative 'logging'
+
+# An Action is executed on a user's request.
+# It has a name, an associated closure and hotkey.
+class Action
+  include Logging
+
+  class ActionError < StandardError
+  end
+
+  attr_accessor :name, :key, :proc, :global, :hidden
+
+  def to_s
+    "[#<" << classname << ':' << hash << '@name="' << name << '", @key="' << key << '">'
+  end
+
+
+  def initialize(options = {}, &b)
+    init_logger(STDOUT, Logger::INFO)
+
+    @name = options[:name]
+    @key = options[:key]
+    @proc = b if b
+    @global = options[:global]
+    @hidden = options[:hidden]
+  end
+
+  def call(*args)
+    unless @proc
+      raise ActionError.new((@name ? '' : 'Unnamed ') << 'action' << (@name ? (' ' << @name) : '') << ' called before a command was defined')
+    end
+    @proc.call(*args) 
+  end
+end

data/lib/busy_indicator/busy_function_test.rb

@@ -0,0 +1,56 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright (c) 2011, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+ A test and demo for the BusyIndicator.
+ This does not use the final BusyIndicator but directly creates
+ a Thread.
+=end
+require './color_output'
+
+def clean_busy_indicator(thr, width, comment)
+  thr.terminate
+  thr.join
+  print ("\b" * width)
+  print ("%+#{width}s\n" %comment)
+end
+
+def busy_indicator(width)
+  tobj = Thread.new() do
+    loop do 
+      %w"OOO ooo ___ ooo".each do |s|
+        print "%+#{width}s" %s
+        sleep 0.1
+        print ("\b" * width)
+      end
+    end
+  end
+end
+# =======================
+if($0 == __FILE__)
+  width = 20
+  2.times do
+    puts "I am busy, pse wait..."
+    thr = busy_indicator(width)
+    sleep 3
+    clean_busy_indicator(thr, width, "Okay")
+  end
+end
+

data/lib/busy_indicator/busy_indicator.rb

@@ -0,0 +1,95 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   Copyright (c) 2011, Michael Uplawski <michael.uplawski@uplawski.eu>   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+=end
+require_relative '../color_output'
+
+#The BusyIndicator will show an "Animation" for the time of its execution.
+#The main program will continue to run in its own thread and should stop
+#the BusyIndicator, once that a process of longer duration has terminated. 
+class BusyIndicator
+	attr_writer :width
+	# Defines a busy_indicator of a width of 'width' characters.
+	# If 'start' is true, the text-animation is run immediately.
+	def initialize(start = true, width = nil)
+		@width = width && width >= 3 ? width : 3
+		@thr = busy_indicator(@width) if start
+	end
+	
+	# Starts the text-animation, returns the thread.
+	def run() 
+		@thr = busy_indicator(@width)
+	end
+
+	# Stops the text-animation, terminates the thread.
+	# If comment is not null, it will be displayed in the end.
+	def stop(comment)
+		@thr.terminate
+		@thr.join
+		print ("\b" * @width)
+		print ("%+#{@width}s\n" %comment)
+	end
+	private
+	def busy_indicator(width)
+		tobj = Thread.new() do
+			print "working ... "
+			loop do 
+				# %w"OOO ooo ___ ooo".each do |s|
+				# %w"000 OOO UUU VVV YYY TTT 777 >>> === --- ooo".each do |s|
+				%w"0OU OUV UVY VYT YT7 T7> 7>= >=- =-o -o0 o0O".each do |s|
+					print "%+#{width}s" %s
+					sleep 0.1
+					print ("\b" * width)
+				end
+			end
+		end
+	end
+end
+# =======================
+# Example
+# You can run this file directly from a command-line, 
+# like this
+# user@mchine$: ruby busy_indicator.rb
+#
+# The program below will then start four (4) 
+# BusyIndicators and stop them again, one by one.  
+# The width of the "animation" is variated.
+# In the loop, the BusyIndicator is started upon
+# its creation, the other two instances are first
+# created then 'run'.
+if($0 == __FILE__)
+	width = 20
+	2.times do
+		puts "I am busy, pse wait..."
+		thr = BusyIndicator.new(true, width)
+		sleep 3
+		thr.stop("Okay")
+	end
+        bi = BusyIndicator.new(false)
+	bi.run
+	sleep 3
+	bi.stop("Stopped")
+	bi.width = 8
+	bi.run
+	sleep 3
+	bi.stop("stopped again")
+end
+

data/lib/cell.rb

@@ -0,0 +1,122 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   Copyright ©2016-2016, Michael Uplawski <michael.uplawski@uplawski.eu> *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+
+require_relative 'logging'
+require_relative 'row'
+require_relative 'column'
+
+# Objects of this class represent cells in a spreadsheet table
+
+class Cell 
+  @@DEF_HEIGHT=1
+  @@DEF_TYPE=Integer
+  @@split_pattern = nil
+
+  self.extend(Logging)
+  @@log = self.init_logger
+
+  def initialize(row = nil, col = nil, value = nil)
+    @log = @@log
+    @row = row if row
+    @col = col if col
+    @type_class = @@DEF_TYPE
+    @value = value
+    split_value
+    set_limits
+    @row.resize
+    @log.debug("cell.initialize, lines is #{@lines}, value is #{value}, ideal_width is #{@ideal_width}")
+  end
+
+  def to_cell()
+    self
+  end
+
+  def line(num = nil)
+    num && num < @lines.length ? @lines[num].to_s : ' ' if @lines && !@lines.empty?
+  end
+
+  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
+
+  def resize
+    @@split_pattern = nil
+    split_value
+    set_limits
+    @row.resize
+  end
+
+  def value=(value)
+    @@split_pattern = nil
+    @value = value
+    split_value
+    @log.debug('after split_value, lines is ' <<  @lines.to_s)
+  end
+
+  def col
+    @col.number
+  end
+
+  def row
+    @row.number
+  end
+
+  attr_reader :ideal_height, :ideal_width, :value
+
+  private
+
+  def split_value()
+    # The regex may be used in many cells. Define on class-level.
+    # And...
+    # This looks complicated because it is.
+    #
+    # until 18 february 2017 
+    # @@split_pattern = Regexp.new('[\p{P}\p{M}]?\b.{1,%i}\b[\p{P}\p{M}]?' %(@col.width)) if !@@split_pattern
+    # since 18 february 2017
+    @@split_pattern = Regexp.new('\b(?:.{1,%i}(?:[\b\s\p{P}]?))' %(@col.width - 1)) if !@@split_pattern
+
+    @lines = @value.to_s.scan(@@split_pattern) # .collect {|match| match.strip}
+    @lines.reject! {|l| l.empty?}
+    set_limits
+    if @value.to_s.strip.length > @lines.join.strip.length
+      # @lines.insert(0, '...' )
+      if(! @lines.empty?)
+        @lines[@lines.length - 1] = '...'  
+      else
+        @lines.insert(0, '...' )
+      end
+    end
+    @row.resize
+  end
+
+  def set_limits
+    if @lines && !@lines.empty?
+      @ideal_height = @lines.length
+      @ideal_width = @lines.max {|l1, l2 | l1.length <=> l2.length}.length if @lines && !@lines.empty?
+    else
+      @ideal_width ||= @col.width 
+      @ideal_height ||= @@DEF_HEIGHT
+      @height ||= @ideal_height
+    end
+  end
+end