robust_excel_ole 1.17 → 1.18.4

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_25000_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

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

data/bin/reo

@@ -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_ranges.rdoc

@@ -377,37 +377,7 @@ or
 
   worksheet.set_cellval(1,1,"new_value")
 
-=== Accessing rows and columns
 
-The methods Worksheet#each, Worksheet#each_row and Worksheet#each_column enable to access each cell, row and column, respectively.
-
-  worksheet.each do |cell|
-    # do something with cell
-    # read every row, every column
-  end
-
-  worksheet.each_row do |row|
-    # do something with row
-  end
-
-  worksheet.each_column do |column|
-    # do something with column
-  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  
-
-Simarly you can access a range of a column.
-
-  worksheet.col_range(3)  # => third column
-  worksheet.col_range(3, 1..2)  # => first two cells of the third column
-
-Within a row or column range you can access a certain cell.
-
-  row_range[1]  # => first cell in row_range
-  column_range[2] # => second cell in column_range
 
 == Code
 

data/docs/README_sheet.rdoc

@@ -75,6 +75,78 @@ If you want to copy a worksheet, if a worksheet +sheet+ is given, and add an emp
 
 Note, that running in jruby, due to some restrictions of jruby, there is a workaround when adding or copy a worksheet at the end (appending): the last worksheet is being copied and deleted afterwards, in order to serve as a dummy worksheet. This may cause a different behaviour.
 
+=== Accessing rows and columns
+
+The methods Worksheet#each, Worksheet#each_row and Worksheet#each_column enable to access each cell, row and column, respectively.
+
+  worksheet.each do |cell|
+    # do something with cell
+    # read every row, every column
+  end
+
+  worksheet.each_row do |row|
+    # do something with row
+  end
+
+  worksheet.each_column do |column|
+    # 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
+  worksheet.col_range(3, 1..2)  # => first two cells of the third column
+
+Within a row or column range you can access a certain cell.
+
+  row_range[1]  # => first cell in row_range
+  column_range[2] # => second cell in column_range
+
+=== Deleting and inserting rows and columns
+
+As mentioned above, VBA methods can be applied to the RobustExcelOle objects, e.g. when deleting or inserting rows and columns.
+
+  row1 = worksheet.row_range(1)
+  row1.Delete
+
+  row1.Insert(XlShiftDown,XlFormatFromLeftOrAbove)
+
+  col1 = worksheet.col_range(1)
+  col1.Insert
+
+=== Getting and setting row height and column width
+
+  row_hight = row1.RowHight
+  row1.RowHeight = row_hight * 2
+
+  col_width = col1.ColumnWidth
+  col1.ColumnWidth = col_width * 2
+
+=== Vertical and horizontal alignment of contents of rows
+
+  row1.VerticalAlignment = XlVAlignCenter
+  row1.HorizontalAlignment = XlHAlignLeft
+
 == Code
 
 worksheet.rb[https://github.com/Thomas008/robust_excel_ole/blob/master/lib/robust_excel_ole/worksheet.rb]

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

@@ -12,8 +12,8 @@ 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')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/worksheet')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/range')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/cell')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/range')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/cygwin') if RUBY_PLATFORM =~ /cygwin/
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
 

data/lib/robust_excel_ole/cell.rb

@@ -1,13 +1,15 @@
 # -*- coding: utf-8 -*-
 
+require File.join(File.dirname(__FILE__), './range')
+
 module RobustExcelOle
 
   class Cell < Range
-    attr_reader :ole_cell    
+    #attr_reader :ole_cell    
 
-    def initialize(win32_cell)
-      @ole_cell = win32_cell.MergeCells ? win32_cell.MergeArea.Item(1,1) : win32_cell
+    def initialize(win32_cell, worksheet)      
       super
+      ole_cell
     end
 
     def v
@@ -18,6 +20,10 @@ module RobustExcelOle
       self.Value = value
     end
 
+    def ole_cell
+      @ole_range = @ole_range.MergeArea.Item(1,1) if @ole_range.MergeCells
+    end
+
   private
 
     # @private
@@ -25,13 +31,15 @@ module RobustExcelOle
       if name.to_s[0,1] =~ /[A-Z]/
         if ::ERRORMESSAGE_JRUBY_BUG
           begin
-            @ole_cell.send(name, *args)
+            #@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_cell.send(name, *args)
+            @ole_range.send(name, *args)
           rescue NoMethodError 
             raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
           end

data/lib/robust_excel_ole/excel.rb

@@ -3,8 +3,6 @@
 require 'weakref'
 require 'Win32API'
 
-
-
 def ka
   Excel.kill_all
 end
@@ -709,8 +707,7 @@ module RobustExcelOle
     # @private
     # returns active workbook
     def workbook
-      return @workbook unless @workbook.nil?
-      @workbook = workbook_class.new(@ole_excel.ActiveWorkbook)
+      @workbook ||= workbook_class.new(@ole_excel.ActiveWorkbook) if @ole_excel.Workbooks.Count > 0
     end    
 
     alias_method :active_workbook, :workbook

data/lib/robust_excel_ole/range.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module RobustExcelOle
 
   # This class essentially wraps a Win32Ole Range object. 
@@ -11,17 +12,33 @@ module RobustExcelOle
     attr_reader :ole_range
     attr_reader :worksheet
 
-    def initialize(win32_range)
+    def initialize(win32_range, worksheet = nil)
       @ole_range = win32_range
-      @worksheet = worksheet_class.new(self.Parent)
+      @worksheet = worksheet ? worksheet : worksheet_class.new(self.Parent)
+      #@worksheet = worksheet_class.new(self.Parent)
     end
 
     def each
-      @ole_range.each do |row_or_column|
-        yield RobustExcelOle::Cell.new(row_or_column)
+      @ole_range.each_with_index do |ole_cell, index|
+        yield cell(index){ole_cell}
       end
     end
 
+    def [] index
+      cell(index) {
+        @ole_range.Cells.Item(index + 1)
+      }
+    end
+
+  private
+
+    def cell(index)
+      @cells ||= []
+      @cells[index + 1] ||= RobustExcelOle::Cell.new(yield,@worksheet)
+    end
+
+  public
+
     # returns flat array of the values of a given range
     # @params [Range] a range
     # @returns [Array] the values
@@ -82,10 +99,8 @@ module RobustExcelOle
       end
     end
 
-    def [] index
-      @cells = []
-      @cells[index + 1] = RobustExcelOle::Cell.new(@ole_range.Cells.Item(index + 1))
-    end
+    alias_method :value, :v
+    alias_method :value=, :v=
 
     # copies a range
     # @params [Address or Address-Array] address or upper left position of the destination range

data/lib/robust_excel_ole/range_owners.rb

@@ -22,12 +22,13 @@ module RobustExcelOle
         raise
       end
       ole_range = name_obj.RefersToRange
+      worksheet = self if self.is_a?(Worksheet)
       value = begin
         #name_obj.RefersToRange.Value
         if !::RANGES_JRUBY_BUG       
           ole_range.Value
         else
-          values = RobustExcelOle::Range.new(ole_range).v
+          values = RobustExcelOle::Range.new(ole_range, worksheet).v
           (values.size==1 && values.first.size==1) ? values.first.first : values
         end
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException 
@@ -42,7 +43,7 @@ module RobustExcelOle
           if !::RANGES_JRUBY_BUG
             ole_range.Value
           else
-            values = RobustExcelOle::Range.new(ole_range).v
+            values = RobustExcelOle::Range.new(ole_range, worksheet).v
             (values.size==1 && values.first.size==1) ? values.first.first : values
           end
         rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException 
@@ -105,11 +106,12 @@ module RobustExcelOle
         raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
       end
       begin
+        worksheet = self if self.is_a?(Worksheet)
         #value = ole_range.Value
         value = if !::RANGES_JRUBY_BUG
           ole_range.Value
         else
-          values = RobustExcelOle::Range.new(ole_range).v
+          values = RobustExcelOle::Range.new(ole_range, worksheet).v
           (values.size==1 && values.first.size==1) ? values.first.first : values
         end
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException 
@@ -180,10 +182,11 @@ module RobustExcelOle
     # @return [Range] a range
     def range(name_or_address, address2 = :__not_provided)
       begin
+        worksheet = self if self.is_a?(Worksheet)
         if address2 == :__not_provided
           range = if name_or_address.is_a?(String)
             begin
-              RobustExcelOle::Range.new(name_object(name_or_address).RefersToRange) 
+              RobustExcelOle::Range.new(name_object(name_or_address).RefersToRange, worksheet) 
             rescue NameNotFound
               nil
             end
@@ -193,7 +196,7 @@ module RobustExcelOle
           address = name_or_address
           address = [name_or_address,address2] unless address2 == :__not_provided         
           self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
-          range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange)
+          range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange, worksheet)
           self.Names.Item('__dummy001').Delete
           workbook = self.is_a?(Workbook) ? self : self.workbook
           workbook.save

data/lib/robust_excel_ole/vba_objects.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  class VbaObjects < Base
+
+    def to_reo
+      self
+    end
+
+    # @private
+    def address_tool
+      excel.address_tool
+    end
+
+  end
+
+  # @private
+  class RangeNotEvaluatable < MiscREOError         
+  end
+
+  # @private
+  class OptionInvalid < MiscREOError               
+  end
+
+  # @private
+  class ObjectNotAlive < MiscREOError              
+  end
+
+end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.17"
+  VERSION = "1.18.4"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -783,12 +783,22 @@ module RobustExcelOle
       raise NameNotFound, "could not return a sheet with name #{name.inspect}"
     end
 
+    def worksheets_count
+      @ole_workbook.Worksheets.Count
+    end
+
     def each
       @ole_workbook.Worksheets.each do |sheet|
         yield worksheet_class.new(sheet)
       end
     end
 
+    def worksheets
+      result = []
+      each { |worksheet| result << worksheet }   
+      result
+    end
+
     def each_with_index(offset = 0)
       i = offset
       @ole_workbook.Worksheets.each do |sheet|
@@ -813,24 +823,18 @@ module RobustExcelOle
       new_sheet_name = opts.delete(:as)
       last_sheet_local = last_sheet
       after_or_before, base_sheet = opts.to_a.first || [:after, last_sheet_local]
+      base_sheet_ole = base_sheet.ole_worksheet
       begin
         if !::COPYSHEETS_JRUBY_BUG          
-          #if sheet
-          #  sheet.Copy({ after_or_before.to_s => base_sheet.ole_worksheet })
-          #else
-          #  ole_workbook.Worksheets.Add({ after_or_before.to_s => base_sheet.ole_worksheet })
-          #end
-          add_or_copy_sheet_simple(sheet, { after_or_before.to_s => base_sheet.ole_worksheet })
+          add_or_copy_sheet_simple(sheet, { after_or_before.to_s => base_sheet_ole })
         else
           if after_or_before == :before 
-            #add_or_copy_sheet_simple(sheet,base_sheet)
-            add_or_copy_sheet_simple(sheet, base_sheet.ole_worksheet)
+            add_or_copy_sheet_simple(sheet, base_sheet_ole)
           else
             if base_sheet.name != last_sheet_local.name
               add_or_copy_sheet_simple(sheet, base_sheet.Next)
             else
-              #add_or_copy_sheet_simple(sheet,base_sheet)
-              add_or_copy_sheet_simple(sheet, base_sheet.ole_worksheet)
+              add_or_copy_sheet_simple(sheet, base_sheet_ole)
               base_sheet.Move(ole_workbook.Worksheets.Item(ole_workbook.Worksheets.Count-1))
               ole_workbook.Worksheets.Item(ole_workbook.Worksheets.Count).Activate
             end
@@ -846,19 +850,11 @@ module RobustExcelOle
 
   private
   
-    #def add_or_copy_sheet_simple(sheet, base_sheet)
-    #  if sheet
-    #    sheet.Copy(base_sheet.ole_worksheet)  
-    #  else
-    #    ole_workbook.Worksheets.Add(base_sheet.ole_worksheet) 
-    #  end
-    #end  
-
-    def add_or_copy_sheet_simple(sheet, base_ole_worksheet)
+    def add_or_copy_sheet_simple(sheet, base_sheet_ole_or_hash)
       if sheet
-        sheet.Copy(base_ole_worksheet)  
+        sheet.Copy(base_sheet_ole_or_hash)  
       else
-        ole_workbook.Worksheets.Add(base_ole_worksheet) 
+        ole_workbook.Worksheets.Add(base_sheet_ole_or_hash) 
       end
     end