viewworkbook 0.1.3 → 0.3

data/lib/file_checking.rb

@@ -1,25 +1,21 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2011-2013 Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   ©2011-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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 'filemagic'
+
 =begin
 A module to facilitate frequently occuring checks on
 file-system objects
@@ -39,6 +35,10 @@ module File_Checking
     :directory => "is not a directory!",
     :file? => "is not a file!",
     :file => "is not a file!",
+    :type => "is not of the sought file-type (not '%s', but '%s')!",
+    :type? => "is not of the sought file-type (not '%s', but '%s')!",
+    :mime => "does not have the sought mime-type (not '%s', but '%s')!",
+    :mime? => "does not have the sought mime-type (not '%s', but '%s')!",
   }
 
   # Checks if the file with the name from the first
@@ -76,12 +76,37 @@ module File_Checking
     end
     msg
   end
-end
+   
+  def self.mime_check(file, mime_type)
+    fm = FileMagic.mime
+    fd = fm.fd(File.new(file) ).split(';')[0]
+    if fd != mime_type.strip  
+             return file.dup << ' ' << (@@text_messages[:mime] %[mime_type, fd])
+    end
+    return nil
+  end
+
+  def self.magic_check(file, magic)
+    fm = FileMagic.fm
+    fd = fm.fd(File.new(file) ).split(';')[0]
+    if fd != magic.strip  
+             return file.dup << ' ' << (@@text_messages[:type] %[magic, fd])
+    end
+    return nil
+  end
+
+end # module
 
 =begin
 # example
 
 include File_Checking
 msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
+# same as 
+# msg = file_check('some_file.txt', [:exist, :readable, 'writable?'])
+
+msg ||= magic_check('some_file.txt', [:type?], 'OpenDocument Text'
+msg ||= mime_check('some_file.txt', [:mime?], 'application/vnd.oasis.opendocument.text'
 puts msg if msg
 =end
+# E O F

data/lib/menu.rb

@@ -1,41 +1,30 @@
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   Copyright © 2014-2017, Michael Uplawski <michael.uplawski@uplawski.eu>*
+ *   ©2014-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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 'io/wait'
 require 'io/console'
 require_relative 'action'
-require_relative 'logging'
+require_relative 'basic_logging'
 require_relative 'user_input'
 
 # Shows options that the user can choose from.
 # Options may be associated with sub-menus.
-
 class Menu 
-  # include Logging
-  self.extend(Logging)
-  @@log = self.init_logger(STDOUT)
+  include BasicLogging
 
-  attr_accessor :key, :name
 
   class MenuError < StandardError
   end
@@ -43,8 +32,8 @@ class Menu
   @@global_elements = []
   @@hidden_elements = []
 
+  # create the menu
   def initialize(options = {})
-    @log = @@log
     @elements = [] 
     if(options && !options.respond_to?(:to_hash) )
       raise MenuError.new('Arguments to menu.new must be hash-pairs')
@@ -53,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)
@@ -77,8 +68,8 @@ class Menu
     end
   end
 
-
   private
+  # display menu and react to user input.
   def show()
     @elements.each do |ele|
       name = ele.name.downcase
@@ -89,11 +80,6 @@ class Menu
     ele = nil
     until ele
       key = "%c" %wait_for_user	
-=begin
-      if "\e" == key
-        break
-      end
-=end
       ele = @elements.detect{ |e| key == e.key  }
       ele ||= @@global_elements.detect{ |e| key == e.key  }
     end
@@ -101,6 +87,7 @@ class Menu
   end
 
   public
+  attr_accessor :key, :name
   alias :add_action :add
   alias :add_sub_menu :add
   alias :add_menu :add

data/lib/row.rb

@@ -1,41 +1,34 @@
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   Copyright ©2016-2016, Michael Uplawski <michael.uplawski@uplawski.eu> *
+ *   ©2016-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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 'cell'
-require_relative 'logging'
+require_relative 'basic_logging'
 
 #  Objects of this class represent rows in a spreadsheet table
 class Row
   @@DEF_HEIGHT=2
-  self.extend(Logging)
-  @@log = self.init_logger(STDOUT)
+  include BasicLogging
+
   def initialize(number = nil)
-    @log = @@log
     @number = number
     @cells = Array.new
     @height = 1
   end
 
+  # add a cell to the row
   def add(cell)
     n_cell = nil
     if cell.respond_to?(:to_cell)
@@ -44,7 +37,7 @@ class Row
       n_cell = Cell.new(@number, cell) 
     else
       msg = 'For a new cell, a colum-number must be specified'
-      @log.error(red(msg))
+      error(red(msg))
       raise StandardError(msg)
     end
     @cells.insert(n_cell.col, n_cell) 
@@ -52,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 )
@@ -70,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/scrollable.rb

@@ -1,30 +1,23 @@
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   Copyright ©2017-2017, Michael Uplawski <michael.uplawski@uplawski.eu> *
+ *   ©2017-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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
 if __FILE__ == $0
   require_relative 'user_input'
 end
 
-require_relative 'logging'
+require_relative 'basic_logging'
 require_relative 'color_output'
 
 class ScrollException < StandardError
@@ -38,13 +31,12 @@ end
 # You can have a box around the scrollable "window" by setting the attribute
 # 'box' to true and, -as I do not care to be asked for my opinion-, you should.
 module Scrollable
-  self.extend(Logging)
+  include BasicLogging
   # may not be needed at all, but when it is..,
   # you want it on class level.
   @@box = %w~┌ ┐ └ ┘ ─ │~
 
   # dto. and how so!
-  @@log = self.init_logger(STDOUT)
 
   # pfffft. As you please.
   @@def_step_x = 1
@@ -227,7 +219,6 @@ module Scrollable
 
   # sets a few values, needed for the rest of the module to function.
   def defaults()
-    @log = @@log
     if(self.respond_to?(:to_s) )
       # @view = self
       @view = self.gsub(/\e\[\d+m/, '')
@@ -251,11 +242,11 @@ module Scrollable
       @have_defaults = true 
     elsif !view
       msg = 'Need to know, what to scroll! (argument "view" missing)'
-      @log.error(yellow(msg))
+      error(yellow(msg))
       raise ScrollException.new(msg)
     else
       msg = 'The "view" to scroll must have a method "to_s()"'
-      @log.error(yellow(msg))
+      error(yellow(msg))
       raise ScrollException.new(msg)
     end
   end

data/lib/sheetdata.rb

@@ -1,96 +1,83 @@
 #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.               *
- *****************************************************************************/
+/***************************************************************************
+ *   ©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                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
+ *   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.                  *
+ *                                                                         *
+ ***************************************************************************/
 =end
 
+require 'filemagic'
 require 'roo'
 require 'roo-xls'
-require 'filemagic'
 
-require_relative 'logging'
+require_relative 'basic_logging'
 
-# Transforms a file into a Roo spreadsheet instance.
 
-ODS_Magic = "OpenDocument Spreadsheet"
-XLS_Magic = "Composite Document File V2 Document"
+ODS_Magic  = "OpenDocument Spreadsheet"
+XLS_Magic  = "Composite Document File V2 Document"
 XLSX_Magic = "Microsoft OOXML"
+# SoftMaker Office
+PMDX_Magic = "Microsoft Excel 2007+"
 
-ODS_MIME = "application/vnd.oasis.opendocument.spreadsheet"
-XLS_MIME = "application/vnd.ms-excel"
-XLSX_MIME = "application/octet-stream"
-CSV_MIME = "text/plain"
+ODS_MIME  = "application/vnd.oasis.opendocument.spreadsheet"
+XLS_MIME  = "application/vnd.ms-excel"
+XLSX_MIME = "application/zip"
+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
-  self::extend(Logging)
-  @@log = init_logger(STDOUT, Logger::INFO)
+  # logs on class level
+  self.extend BasicLogging
 
   @@file = nil		
   @@workbook = nil
 
+  # returns a new workbook
   def self::workbook(file)
     @@file = file
     if !@@workbook
       begin
-        magic, mime = file_type
-        @@workbook = case mime
+        fm = FileMagic.mime
+        mtype = fm.fd(File.new(file) ).split(';')[0]
+        fm = FileMagic.fm
+        magic = fm.fd(File.new(file) ).split(';')[0]
+        @@workbook = case mtype
                      when ODS_MIME 
-                       if magic.match ODS_Magic
-                         @@log.debug('ODS')
-                         Roo::Spreadsheet::open(@@file, extension: :ods ) 
-                       end
-                     when XLS_MIME 
-                       if magic.match XLS_Magic
-                         @@log.debug('XLS')
-                         Roo::Spreadsheet::open(@@file, extension: :xls ) 
-                       end
-                     when XLSX_MIME 
-                       if magic.match XLSX_Magic
-                         @@log.debug('XLSX')
-                         Roo::Spreadsheet::open(@@file, extension: :xlsx ) 
-                       end
+                       debug('ODS')
+                       Roo::Spreadsheet::open(@@file, extension: :ods ) 
+                     when (XLS_MIME) 
+                       debug('XLS')
+                       Roo::Spreadsheet::open(@@file, extension: :xls ) 
+                     when XLSX_MIME, PMDX_MIME
+                       debug('XLSX')
+                       Roo::Spreadsheet::open(@@file, extension: :xlsx ) 
                      when CSV_MIME
                        raise IOError.new('CSV is not yet supported, sorry')
                      else
-                       raise IOError.new('Mime-Type is ' << mime << ' and Magic sais: ' << magic << ". Is this supposed to be a spreadsheet?")
+                       raise IOError.new('Mime-Type is ' << mtype << ' and Magic sais: ' << magic << ". Is this supposed to be a spreadsheet?")
                      end
       rescue Exception => ex
         msg = 'ERROR! File %s is not supported: %s' %[@@file, ex.message]  
         puts msg
-        @log.error yellow(msg)
+        error yellow(msg)
         exit false
       end			
 
       return @@workbook
     end
   end
- 
-  private
-  # derive the mime-type from the file
-  def self::file_type
-    fm = FileMagic.fm
-    file_magic = fm.file(@@file)
-    fm.flags = [:mime_type]
-    file_mime = fm.file(@@file)	
-    @log.debug('File type is ' << file_magic << ', Mime-type is ' << file_mime)
-    return file_magic, file_mime
-  end
 end
 

data/lib/sheetinterface.rb

@@ -2,22 +2,16 @@
 
 =begin
 /***************************************************************************
- *   Copyright © 2014 - 2017, Michael Uplawski <michael.uplawski@uplawski.eu>     *
+ *   ©2014-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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
 
@@ -25,7 +19,7 @@ require 'roo'
 require 'io/wait'
 require 'io/console'
 
-require_relative 'logging'
+require_relative 'basic_logging'
 require_relative 'scrollable'
 require_relative 'row'
 require_relative 'cell'
@@ -45,7 +39,7 @@ require_relative 'translating'
 #TODO: provide conversion for column designators to int vv, also for AA to ZZ !
 
 class SheetInterface
-  include Logging
+  include BasicLogging
   include Translating
 
   class Status 
@@ -59,7 +53,6 @@ class SheetInterface
   end
 
   def initialize(wb, num)
-    init_logger(STDOUT, Logger::INFO)
     @workbook = wb.sheet(num)
     @menu = nil
     @status = Status.new
@@ -75,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
@@ -197,8 +190,8 @@ class SheetInterface
     end
 
     if sn && !sn.to_s.empty?
-      @log.debug('calling workbook.sheet with ' << sn.to_s)
-      @log.debug('@workbook is of type ' << @workbook.class.name)
+      debug('calling workbook.sheet with ' << sn.to_s)
+      debug('@workbook is of type ' << @workbook.class.name)
       set_sheet(sn)
     end
     construct
@@ -230,7 +223,7 @@ class SheetInterface
         begin
           File::open(file, 'w+') do |out| 
             @workbook.sheets.each do |s|
-              @log.debug('writing sheet ' << s)
+              debug('writing sheet ' << s)
               set_sheet(s)
               construct(false)
               draw(out) 
@@ -385,13 +378,7 @@ class SheetInterface
         end
 
       end
-=begin
-    table_width = hline.length 
-    tw = terminal_size[0]
-    if(on_screen && table_width > tw)
-      @status.message = red("ATTN! Terminal is to narrow to display the whole table (#{tw} characters for #{table_width}). Diminish column-width!")
-    end
-=end
+
       return table_view
     else
       return nil
@@ -436,7 +423,6 @@ class SheetInterface
         end
       end
     end
-
     bi.stop("\n")
     if(on_screen)
       @table_view = draw()

data/lib/translating.rb

@@ -1,23 +1,17 @@
 #encoding: UTF-8
+
 =begin
 /***************************************************************************
- *   ©2011-2014, Michael Uplawski				           * 
- *   <michael.uplawski@uplawski.eu>  					   *
+ *   ©2011-2024, 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.                                   *
- *                                                                         * 
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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
 

data/lib/user_input.rb

@@ -1,23 +1,16 @@
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   Copyright © 2014-2017, Michael Uplawski <michael.uplawski@uplawski.eu>*
+ *   ©2014-2024, 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.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   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.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   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