robust_excel_ole 1.16 → 1.18.3

data/benchmarking/spreadsheet_example.rb

@@ -0,0 +1,36 @@
+
+require 'spreadsheet'
+
+start_time = Time.now 
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+# Note: spreadsheet only supports .xls files (not .xlsx)
+workbook = Spreadsheet.open './sample_excel_files/xls_500_rows.xls'
+
+worksheets = workbook.worksheets
+puts "Found #{worksheets.count} worksheets"
+
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row.to_a.map{ |v| v.methods.include?(:value) ? v.value : v }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+
+puts 'Done'

data/bin/jreo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+jirb -f -r ../lib/robust_excel_ole -r ../lib/jreo_console.rb

data/bin/reo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+irb -f -r ../lib/robust_excel_ole -r ../lib/reo_console.rb

data/docs/README_excel.rdoc

@@ -124,6 +124,12 @@ or, with a block,
 
   excel.each_workbook(:visible => true) {|w| puts w}
 
+=== Accessing the active workbook
+
+You can operate on the active workbook with help of the method Workbook#active_workbook, e.g.
+
+  workbook = excel.active_workbook
+
 === Bringing an Excel instance to the foreground
 
   excel1.focus

data/docs/README_open.rdoc

@@ -153,6 +153,7 @@ The method +General.to_reo+ enables type-lifting WIN32OLE objects to RobustExcel
 This object can be type-lifted to a RobustExcelOle workbook.
 
   workbook = win32ole_workbook.to_reo
+
   workbook.to_class
   => RobustExcelOle::Workbook
 
@@ -166,6 +167,9 @@ You can supply options, e.g. +:visible+.
 
    workbook = Workbook.new(win32ole_workbook, :visible => true) 
 
+You can also supply a workbook and options, e.g.
+
+   new_workbook = Workbook.new(workbook, :visible => true)
 
 === Identity transperence ===
 

data/docs/README_ranges.rdoc

@@ -394,11 +394,26 @@ The methods Worksheet#each, Worksheet#each_row and Worksheet#each_column enable
     # do something with column
   end
 
+The method Worksheet#values yields all cell values of the used range of the worksheet into a 2-dimensional array. For example:
+
+  worksheet.values
+  => [["foo", "workbook", "sheet1"], ["foo", nil, "foobaaa"], ["matz", "is", "nice"]]
+
+The method Worksheet#each_rowvalue provides enable to access the values of each row.
+
+  worksheet.each_rowvalue do |row_values|
+    # do something with the row_values
+  end
+
 You access a range of a row by giving the number of the row, and optionally, the range of the cell numbers.
 
   worksheet.row_range(1)  # => first row
   worksheet.row_range(1, 1..3 )  # => first three cells of the first row  
 
+Reading the values is enabled with help of #values:
+
+  worksheet.row_range(1).values  
+
 Simarly you can access a range of a column.
 
   worksheet.col_range(3)  # => third column

data/examples/example_ruby_library.rb

@@ -0,0 +1,27 @@
+#require 'robust_excel_ole'
+
+#workbook = Workbook.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+require_relative '../lib/robust_excel_ole'
+
+include RobustExcelOle
+
+workbook = Workbook.open './../spec/data/workbook.xls'
+
+puts "Found #{workbook.worksheets_count} worksheets"
+
+workbook.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.each do |row|
+    row_cells = row.map{ |cell| cell.value }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'

data/lib/robust_excel_ole.rb

@@ -3,10 +3,11 @@ if RUBY_PLATFORM =~ /java/
 else
   require 'win32ole'
 end
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/reo_common')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/range_owners')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/address')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/base')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/general')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/vba_objects')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/range_owners')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/address_tool')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/bookstore')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/workbook')

data/lib/robust_excel_ole/{address.rb → address_tool.rb}

@@ -2,37 +2,38 @@
 
 module RobustExcelOle
 
-  class Address < REOCommon
+  class AddressTool < Base
 
-    def self.new(r1c1_letters)
-      @@row_letter = r1c1_letters[0..0]
-      @@col_letter = r1c1_letters[1..1]
+    def initialize(address_string)
+      r1c1_letters = address_string.gsub(/[0-9]/,'')
+      @row_letter = r1c1_letters[0..0]
+      @col_letter = r1c1_letters[1..1]
     end
 
     # address formats that are valid:
     #   r1c1-format: e.g. "Z3S1", "Z3S1:Z5S2", "Z[3]S1", "Z3S[-1]:Z[5]S1", "Z[3]", "S[-2]"
     #                      infinite ranges are not possible, e.g. "Z3:Z5", "S2:S5", "Z2", "S3", "Z[2]" 
-    #   int_range: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 
-    #                   [3..4, nil], [nil, 2..4], [2,nil], [nil,4]
+    #   integer_ranges-fromat: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 
+    #                               [3..4, nil], [nil, 2..4], [2,nil], [nil,4]
     #   a1-format: e.g. "A3", "A3:B5", "A:B", "3:5", "A", "3"
 
-    def self.r1c1(address)
+    def as_r1c1(address)
       transform_address(address,:r1c1)
     end
 
-    def self.a1(address)
+    def as_a1(address)
       transform_address(address,:a1)
     end
 
     # valid address formats: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 
     #                             [3..4, nil], [nil, 2..4], [2,nil], [nil,4]
-    def self.int_range(address)
+    def as_integer_ranges(address)
       transform_address(address,:int_range)
     end
 
   private
 
-    def self.transform_address(address, format)
+    def transform_address(address, format)
       address = address.is_a?(Array) ? address : [address]
       raise AddressInvalid, "address #{address.inspect} has more than two components" if address.size > 2
       begin
@@ -70,8 +71,8 @@ module RobustExcelOle
         raise AddressInvalid, "address (#{address.inspect}) format not correct"
       end
       if format==:r1c1
-        r1c1_string(@@row_letter,rows,:min) + r1c1_string(@@col_letter,columns,:min) + ":" + 
-        r1c1_string(@@row_letter,rows,:max) + r1c1_string(@@col_letter,columns,:max)
+        r1c1_string(@row_letter,rows,:min) + r1c1_string(@col_letter,columns,:min) + ":" + 
+        r1c1_string(@row_letter,rows,:max) + r1c1_string(@col_letter,columns,:max)
       elsif format==:int_range
         [rows,columns]
       else
@@ -79,8 +80,7 @@ module RobustExcelOle
       end
     end  
 
-    # @private
-    def self.r1c1_string(letter,int_range,type)
+    def r1c1_string(letter,int_range,type)
       return "" if int_range.nil? || int_range.begin.nil?
       parameter = type == :min ? int_range.begin : int_range.end
       is_relative = parameter.is_a?(Array)
@@ -88,27 +88,28 @@ module RobustExcelOle
       letter + (is_relative ? "(" : "") + parameter.to_s + (is_relative ? ")" : "")       
     end 
 
-    # @private
-    def self.analyze(comp,format)
+    def analyze(comp,format)
       row_comp, col_comp = if format==:a1 
         [comp.gsub(/[A-Z]/,''), comp.gsub(/[0-9]/,'')]
       else
-        a,b = comp.split(@@row_letter)
-        c,d = b.split(@@col_letter)
+        a,b = comp.split(@row_letter)
+        c,d = b.split(@col_letter)
         b.nil? ? ["",b] : (d.nil? ? [c,""] : [c,d])  
       end
-      def self.s2n(s)
+      def s2n(s)
         s!="" ? (s[0] == "[" ? [s.gsub(/\[|\]/,'').to_i] : (s.to_i!=0 ? s.to_i : s)) : nil
       end
       [s2n(row_comp), s2n(col_comp)]
     end
 
-
-    # @private
-    def self.str2num(str)
+    def str2num(str)
       str.tr("A-Z","0-9A-P").to_i(26) + (26**str.size-1)/25
     end
 
   end
 
+  # @private
+  class AddressInvalid < REOError                  
+  end
+
 end

data/lib/robust_excel_ole/{reo_common.rb → base.rb}

@@ -50,94 +50,10 @@ module RobustExcelOle
   class MiscREOError < REOError                    
   end
 
-  # @private
-  class ExcelDamaged < ExcelREOError               
-  end
-
-  # @private
-  class UnsavedWorkbooks < ExcelREOError           
-  end
-
-  # @private
-  class WorkbookBlocked < WorkbookREOError         
-  end
-
-  # @private
-  class WorkbookNotSaved < WorkbookREOError        
-  end
-
-  # @private
-  class WorkbookReadOnly < WorkbookREOError        
-  end
-
-  # @private
-  class WorkbookBeingUsed < WorkbookREOError       
-  end
-
-  # @private
-  class WorkbookConnectingUnsavedError < WorkbookREOError        
-  end
-
-  # @private
-  class WorkbookConnectingBlockingError < WorkbookREOError       
-  end
-
-  # @private
-  class WorkbookConnectingUnknownError < WorkbookREOError       
-  end
-
-  # @private
-  class FileNotFound < FileREOError                
-  end
-
-  # @private
-  class FileNameNotGiven < FileREOError            
-  end
-
-  # @private
-  class FileAlreadyExists < FileREOError           
-  end
-
-  # @private
-  class NameNotFound < NamesREOError               
-  end
-
-  # @private
-  class NameAlreadyExists < NamesREOError          
-  end
-
-  # @private
-  class RangeNotEvaluatable < MiscREOError         
-  end
-
-  # @private
-  class RangeNotCreated < MiscREOError             
-  end
-
-  # @private
-  class RangeNotCopied < MiscREOError              
-  end
-
-  # @private
-  class OptionInvalid < MiscREOError               
-  end
-
-  # @private
-  class ObjectNotAlive < MiscREOError              
-  end
-
   # @private
   class TypeREOError < REOError                    
   end
 
-  # @private
-  class TimeOut < REOError                         
-  end
-
-  # @private
-  class AddressInvalid < REOError                  
-  end
-
   # @private
   class UnexpectedREOError < REOError              
   end
@@ -145,13 +61,9 @@ module RobustExcelOle
   # @private
   class NotImplementedREOError < REOError          
   end
+    
 
-  class REOCommon
-
-    # @private
-    def excel
-      raise TypeREOError, 'receiver instance is neither an Excel nor a Workbook'
-    end
+  class Base
 
     # @private
     def own_methods

data/lib/robust_excel_ole/bookstore.rb

@@ -2,7 +2,8 @@
 
 module RobustExcelOle
 
-  class Bookstore < REOCommon
+  class Bookstore < Base
+    
     def initialize
       @filename2books ||= Hash.new { |hash, key| hash[key] = [] }
       @hidden_excel_instance = nil
@@ -103,7 +104,6 @@ module RobustExcelOle
 
   private
 
-    # @private
     def try_hidden_excel 
       @hidden_excel_instance.__getobj__ if @hidden_excel_instance && @hidden_excel_instance.weakref_alive? && @hidden_excel_instance.__getobj__.alive?
     end

data/lib/robust_excel_ole/cell.rb

@@ -1,11 +1,15 @@
 # -*- coding: utf-8 -*-
 
+require File.join(File.dirname(__FILE__), './range')
+
 module RobustExcelOle
-  class Cell < REOCommon
-    attr_reader :cell
 
-    def initialize(win32_cell)
-      @cell = win32_cell.MergeCells ? win32_cell.MergeArea.Item(1,1) : win32_cell
+  class Cell < Range
+    #attr_reader :ole_cell    
+
+    def initialize(win32_cell, worksheet)      
+      super
+      ole_cell
     end
 
     def v
@@ -16,25 +20,33 @@ module RobustExcelOle
       self.Value = value
     end
 
+    def ole_cell
+      @ole_range = @ole_range.MergeArea.Item(1,1) if @ole_range.MergeCells
+    end
+
+  private
+
     # @private
     def method_missing(name, *args) 
-      #if name.to_s[0,1] =~ /[A-Z]/
-      if ::ERRORMESSAGE_JRUBY_BUG
-        begin
-          @cell.send(name, *args)
-        rescue Java::OrgRacobCom::ComFailException 
-          raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+      if name.to_s[0,1] =~ /[A-Z]/
+        if ::ERRORMESSAGE_JRUBY_BUG
+          begin
+            #@ole_cell.send(name, *args)
+            @ole_range.send(name, *args)
+          rescue Java::OrgRacobCom::ComFailException 
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          end
+        else
+          begin
+            #@ole_cell.send(name, *args)
+            @ole_range.send(name, *args)
+          rescue NoMethodError 
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          end
         end
       else
-        begin
-          @cell.send(name, *args)
-        rescue NoMethodError 
-          raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
-        end
+        super
       end
-     # else
-     #   super
-     # end
     end
   end
 end