viewworkbook 0.1.3

data/lib/sheetdata.rb

@@ -0,0 +1,96 @@
+#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 'roo'
+require 'roo-xls'
+require 'filemagic'
+
+require_relative 'logging'
+
+# Transforms a file into a Roo spreadsheet instance.
+
+ODS_Magic = "OpenDocument Spreadsheet"
+XLS_Magic = "Composite Document File V2 Document"
+XLSX_Magic = "Microsoft OOXML"
+
+ODS_MIME = "application/vnd.oasis.opendocument.spreadsheet"
+XLS_MIME = "application/vnd.ms-excel"
+XLSX_MIME = "application/octet-stream"
+CSV_MIME = "text/plain"
+
+class SheetData
+  self::extend(Logging)
+  @@log = init_logger(STDOUT, Logger::INFO)
+
+  @@file = nil		
+  @@workbook = nil
+
+  def self::workbook(file)
+    @@file = file
+    if !@@workbook
+      begin
+        magic, mime = file_type
+        @@workbook = case mime
+                     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
+                     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?")
+                     end
+      rescue Exception => ex
+        msg = 'ERROR! File %s is not supported: %s' %[@@file, ex.message]  
+        puts msg
+        @log.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

@@ -0,0 +1,464 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   Copyright © 2014 - 2017, 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 'roo'
+require 'io/wait'
+require 'io/console'
+
+require_relative 'logging'
+require_relative 'scrollable'
+require_relative 'row'
+require_relative 'cell'
+require_relative 'column'
+require_relative 'color_output'
+require_relative 'busy_indicator/busy_indicator'
+require_relative 'user_input'
+require_relative 'menu'
+require_relative 'action'
+require_relative 'translating'
+
+# So this draws a table complete with the content of the cells from the 
+# currently selected spreadsheet.
+# The really ingenuous stuff was provided by a helpful user on a newsgroup.
+# Really... Usenet! Like in ... 2014! 
+
+#TODO: provide conversion for column designators to int vv, also for AA to ZZ !
+
+class SheetInterface
+  include Logging
+  include Translating
+
+  class Status 
+    def show
+      if(@message)
+        puts @message
+        @message.clear
+      end
+    end
+    attr_writer :message
+  end
+
+  def initialize(wb, num)
+    init_logger(STDOUT, Logger::INFO)
+    @workbook = wb.sheet(num)
+    @menu = nil
+    @status = Status.new
+    construct
+  end
+
+  private
+=begin
+        returns [width, height] in columns and lines of the current
+        terminal-window. 
+=end
+  def terminal_size
+    size = `stty size`.split.map { |x| x.to_i }.reverse
+    return size
+  end 
+  # Asks the user to enter a number, then verifies ageinst eventual
+  # constraints.
+  def ask_number(question, &constraint)
+    num = nil
+    3.times do
+      print  question.dup << " "
+      begin
+        num = STDIN.gets() 
+      rescue Interrupt 
+        return nil
+      end
+      num = num.to_i
+      if (constraint && !yield(num))
+        num = nil
+      end
+      return num if num
+    end
+    if !num
+      @status.message = "Inacceptable value, doing nothing."
+      return nil
+    end
+  end
+
+  # Shortcutting from “user inputs bull” to “program interrupts”
+  # without the need for the program to actually run havoc, first.
+  def ask_string(question, &constraint)
+    str = nil
+    until str
+      print  question.dup << " "
+      begin
+        str = STDIN.gets().chomp!
+      rescue Interrupt
+        return nil
+      end
+      if("" == str || "\e" == str)
+        return nil
+      end
+      if(constraint && !yield(str))
+        str = nil
+      end
+    end
+    if !str
+      @status.message = "Inacceptable value, doing nothing."
+    end
+    return str
+  end
+
+  # Write content to a new file
+  def new_file()
+    file = nil
+    until file
+      print 'file path:' << ' '
+      begin
+        file = STDIN.gets().chomp!
+      rescue Interrupt
+        return nil
+      end
+      if(file && File::exist?(file) )
+        if(File::writable?(file) )
+          print "File #{file} exists! Do you want to overwrite its content, now (j/N)? "
+          answer = "%c" %wait_for_user	
+          if('j' != answer.downcase)
+            file = nil
+          else
+            puts
+          end
+        else
+          puts "File #{file} is not writable! Please name a different file path"
+          file = nil
+
+        end
+      end
+    end
+    return file
+  end
+
+  def ask_cell_coord()
+    coord = nil
+    until coord
+      print 'Which cell (col:row)? '
+      begin
+        coord = STDIN.gets().chomp!
+      rescue Interrupt
+        return nil
+      end
+      if('' == coord || !coord.include?(':') || "\e" == coord)
+        return nil
+      else
+        col, row = coord.split(':')
+        row = row.to_i
+        col = col.strip
+      end
+      return [col, row]
+    end
+  end
+
+  def set_sheet(sheet)
+    current_sheet = @workbook.default_sheet
+    @workbook = @workbook.sheet(sheet)
+    columns = @workbook.last_column
+    if columns && columns > 0
+      @rows = nil
+      @columns = nil
+    else
+      @workbook = @workbook.sheet(current_sheet)
+      @status.message = red("Sheet #{sheet} contains no data!")
+    end
+  end
+
+  def open_sheet(designator = :number)
+    sn = nil
+    if designator == :number
+      sn = ask_number("Sheet number (max #{@workbook.sheets.size() - 1})?") do |num|
+        num < @workbook.sheets.size
+      end 
+    else
+      sn = ask_string("Sheet name (#{@workbook.sheets.join(', ')})?") do |name|
+        @workbook.sheets.include?(name)
+      end
+    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)
+      set_sheet(sn)
+    end
+    construct
+  end
+
+  # Adds concrete actions to the menu. 
+  # Note the calls to ask_number and ask_string with constraints.
+  def define_actions(menu)
+    sm_Menu = Menu.new(:name => 'sheet', :key => 's')
+    sm_Menu.add_action(Action.new(:name => 'sheet number', :key => '#') {open_sheet(:number)})
+    sm_Menu.add_action(Action.new(:name => 'sheet name', :key => 'n') {open_sheet(:name)})
+
+    save_Menu = Menu.new(:name => 'save to file', :key => 'f')
+    save_Menu.add_action(Action.new(:name => 'current sheet', :key => 'c') do 
+      file = new_file()
+      if(file)
+        File::open(file, 'w+') {|out| draw(out) }
+        @status.message = green('... done')
+      end
+      construct
+    end)	
+
+    save_Menu.add_action(Action.new(:name => 'all sheets', :key => 'a') do 
+      current_sheet = @workbook.default_sheet
+      @status.message = "\nATTN! If saving takes a long time, your spreadsheet may contain useless data or many empty cells. Check the visible width and height of your tables.\n"
+      file = new_file()
+      if(file)
+        bi = BusyIndicator.new(true)
+        begin
+          File::open(file, 'w+') do |out| 
+            @workbook.sheets.each do |s|
+              @log.debug('writing sheet ' << s)
+              set_sheet(s)
+              construct(false)
+              draw(out) 
+            end
+          end
+        rescue Interrupt
+          puts bold(red("Interrupted by user. Bye!"))
+          exit true
+        end
+        bi.stop('... done')
+      end
+      set_sheet(current_sheet)
+      construct
+    end)	
+
+    col_Menu = Menu.new(:name=>'column', :key => 'c')
+    col_Menu.add_action(Action.new(:name => 'column width', :key => 'w') do |num| 
+      num = ask_number('column width (min. 4) ?'){|w| w > 3}
+      Column::col_width = num if num
+      construct 
+    end)
+
+    menu.add_action(Action.new(:name => 'value', :key => 'v') do 
+      cell_coord = ask_cell_coord
+      if(cell_coord && cell_coord.length == 2)
+        row = cell_coord[1] - 1
+        col = cell_coord[0].upcase.bytes[0] - 65
+        cell = nil
+        if(@rows[row] && @columns[col])
+          cell = @rows[row].cells.detect {|c| c.col == col} 
+          if(cell)
+            @status.message = "#{cell_coord[0].upcase}:#{cell_coord[1]} is \"" << cell.value.to_s << "\" (%d)" %cell.value.to_s.length
+          else
+            @status.message = red('invalid cell')
+          end
+        else
+          @status.message = red(cell_coord.join(':')  << ': out of range')
+        end
+      elsif(cell_coord && cell_coord.length > 0)
+        @status.message = red('invalid input')
+      end
+      construct
+    end)
+
+    menu.add_menu(save_Menu)
+    menu.add_menu(sm_Menu)
+    menu.add_menu(col_Menu)
+    menu.add_action(Action.new(:name => "⇧", :key => "i") {@table_view.up; refresh()})
+    menu.add_action(Action.new(:name => "⇩", :key => "k") {@table_view.down; refresh()})
+    menu.add_action(Action.new(:name => "⇦", :key => "j") {@table_view.left; refresh()})
+    menu.add_action(Action.new(:name => "⇨", :key => "l") {@table_view.right; refresh()})
+    menu.add_action(Action.new(:global => true, :hidden => true, :name => '', :key => "\e") {refresh})
+    menu.add_action(Action.new(:global => true, :name => 'quit', :key => 'q') {puts 'Bye ';exit 0})
+  end
+  # This is hard to describe. 
+  # The function basically draws a table on screen. 
+  def draw(out = STDOUT)
+    if(@rows && !@rows.empty?)
+      # Welcome to hell.
+      on_screen = STDOUT == out
+      col_w = Column::col_width
+      num_c = @rows[0].cells.length()
+      num_r = @rows.length
+      ch = nil
+      hline = nil
+      #-----
+      table_view = ''
+      #-----
+
+      table_view << @workbook.default_sheet << "\n"
+      #out.puts @workbook.default_sheet
+      table_view << ('┌' << '─' * num_r.to_s.length << '┬' << (('─' * col_w) << '┬' ) * (num_c -1) ) << (('─' * col_w) << '┐' ) << "\n"
+      # out.puts ('┌' << '─' * num_r.to_s.length << '┬' << (('─' * col_w) << '┬' ) * (num_c -1) ) << (('─' * col_w) << '┐' )
+      lh = 0
+      @rows.each do |row|
+
+        if(row == @rows.first)
+          ch = 'A'
+          table_view << "│%#{num_r.to_s.length}s" %" " 
+          #out.print "│%#{num_r.to_s.length}s" %" " 
+          table_view << '│'
+          # out.print '│'
+          row.each do |c|
+            head = "%#{col_w}s" %ch 
+            head = bold(head) if(on_screen)
+            # out.print(head << "|")
+            table_view << (head << "│")
+            ch = ch.next
+          end
+          # out.puts
+          table_view << "\n"
+          hline = ('├' << ('─' * (num_r.to_s.length) ) <<'┼' << (('─' * col_w) << '┼' ) * (num_c - 1) ) <<  (('─' * col_w) << '┤')if !hline
+          table_view << hline << "\n"
+          # out.puts hline
+        end
+        lh += 1
+        table_view << "│" 
+        # out.print "│" 
+        line_head = "%#{num_r.to_s.length}s" %lh.to_s
+        line_head = bold(line_head) if on_screen 
+        table_view << line_head
+        # out.print line_head
+
+        #      out.print "│" << bold("%#{num_r.to_s.length}s" %line_head)
+
+        row.height.times do |li|
+          table_view << "│%#{num_r.to_s.length}s" %" " if li > 0
+          # out.print "│%#{num_r.to_s.length}s" %" " if li > 0
+          table_view << '│'
+          # out.print '│'
+          row.each do |cell|
+            line = cell.line(li)
+            content = "%#{col_w}s│" %line 
+            if(on_screen && line && line.end_with?('...'))
+              content = red(content)
+            end
+            table_view << content
+            # out.print content
+          end
+          table_view << "\n"
+          # out.puts
+        end
+        hlline = ('│' << (('─' * col_w) << '│' ) * num_c  ) if !hline
+
+        table_view << hline << "\n"
+        # out.puts hline
+
+        # Some of the following code may go to a function as it repeats the
+        # procedure from the beginning of the table.  I am currently unwilling to
+        # do it, because all the rest must stay so verbose that another
+        # function-call at this position cannot contribute to a better
+        # understanding of this ... table-generating MESS!!
+        if(row == @rows.last)
+          ch = 'A'
+          table_view << "│%#{num_r.to_s.length}s" %" " 
+          # out.print "│%#{num_r.to_s.length}s" %" " 
+          table_view << '│'
+          # out.print '│'
+          row.each do |c|
+            head = "%#{col_w}s" %ch
+            head = bold(head) if on_screen
+            table_view << ( head << '│')
+            # out.print( head << '│')
+            ch = ch.next
+          end
+          table_view << "\n"
+          # out.puts
+          hline = ('└' << ('─' * (num_r.to_s.length) ) << '┴' << (('─' * col_w) << '┴' ) * (num_c - 1) ) << (('─' * col_w) << '┘' )
+
+          table_view << hline << "\n"
+          # out.puts hline
+        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
+    end
+  end
+
+  # The function which is called to recreate the view.
+  # It prepares the table-generation by transforming the Roo-instance to
+  # objects of the classes Cell, Row and Column, then calls draw(), above and
+  # adds the status- and menu-lines. The menu waits for user input (blocking)
+  # before construct() returns, no other thread or “event-loop” involved there.
+  def construct(on_screen = true)
+    puts "... reading spreadsheet data (%s), PSE wait" %[@workbook.default_sheet]
+    bi = BusyIndicator.new()
+    if(!@rows || !@columns)
+
+      @rows = Array.new if !@rows
+      @columns = Array.new if !@columns
+      # create for each column
+      num_columns = @workbook.last_column
+      if(num_columns && num_columns > 0)
+        num_columns.times do |column|
+          # ... a column, then 
+          @columns[column] = Column.new(column) if !@columns[column]
+          cur_col = @columns[column]
+
+          # ... create for each row in each column
+          (@workbook.last_row).times do |row|
+            # ... a row then
+            @rows[row] = Row.new(row) if !@rows[row]
+            cur_row = @rows[row]
+            # ... create for each cell in each row
+            cur_cell = cur_row.cells.detect {|cell| column == cell.col }
+            if !cur_cell
+              # ... a cell
+              cell = @workbook.cell(row + 1, column + 1)
+              cur_cell = Cell.new(cur_row, cur_col, cell.to_s)
+              cur_row << cur_cell
+              cur_col << cur_cell
+            end
+          end
+        end
+      end
+    end
+
+    bi.stop("\n")
+    if(on_screen)
+      @table_view = draw()
+      if @table_view
+        @table_view.extend(Scrollable)
+        @table_view.fixed_rows = 4
+        @table_view.fixed_cols = 4
+        refresh()
+      end
+    end
+  end
+
+  def refresh()
+    @table_view.width=terminal_size[0] - 1
+    @table_view.height=terminal_size[1] 
+    # @table_view.box = true
+    @table_view.show
+    @status.show
+    if !@menu
+      @menu = Menu.new(:name => 'main')
+      define_actions(@menu)
+    end
+    @menu.call
+  end
+end