robust_excel_ole 1.13 → 1.18

data/docs/README_sheet.rdoc

@@ -6,30 +6,30 @@ Worksheets are represented by Worksheet objects.
 
 Assume you have opened a workbook
 
-  book = Workbook.open('spec/data/workbook.xls', :visible => true)
+  workbook = Workbook.open('spec/data/workbook.xls', :visible => true)
 
 === Accessing a worksheet.
 
 You can access a worksheet by giving the number
 
-  sheet = book.sheet(1)
+  worksheet = book.sheet(1)
 
 or its name
 
-  sheet = book.sheet('Sheet1')
+  worksheet = book.sheet('Sheet1')
 
 You can get the first and last worksheet with
 
-  sheet = book.first_sheet  
+  worksheet = book.first_sheet  
 
 and
 
-  sheet = book.last_sheet  
+  worksheet = book.last_sheet  
 
-You can access all Sheet objects by using the methods Workbook#each.
+You can access all Worksheet objects by using the methods Workbook#each.
 
-  book.each do |sheet|               
-    # do something with sheet
+  workbook.each do |worksheet|               
+    # do something with worksheet
   end
 
 Once you have got a Sheet object (in RobustExcelOle), you can apply all VBA methods that you would apply to a VBA Worksheet object
@@ -40,38 +40,38 @@ For some common and complex tasks you can apply methods of RobustExcelOle.
 
 You can read and change the worksheet name.
 
-  sheet1.name
+  worksheet1.name
   # => "Sheet1"
 
-  sheet1.name = "new_sheet"
+  worksheet1.name = "new_sheet"
 
 === Adding and copying a worksheet.
 
 You can add (append) an empty worksheet using
 
-  book.add_empty_sheet
+  workbook.add_empty_sheet
 
 Additionally you can name it.
 
-  book.add_empty_sheet(:as => 'sheet_name')
+  workbook.add_empty_sheet(:as => 'sheet_name')
 
 You can specify the position of the added empty worksheet.
 
-  book.add_empty_sheet(:as => 'new_name', :before => another_sheet)
+  workbook.add_empty_sheet(:as => 'new_name', :before => another_sheet)
 
 You can copy a worksheet and add it.
 
-  book.copy_sheet sheet
+  workbook.copy_sheet sheet
 
 Additionally you can specify a name and a position.
 
-  book.copy_sheet(sheet, :as => 'new_name', :after => another_sheet)
+  workbook.copy_sheet(sheet, :as => 'new_name', :after => another_sheet)
 
 If you want to copy a worksheet, if a worksheet +sheet+ is given, and add an empty worksheet, if no worksheet is given, then use
 
-  book.add_or_copy_sheet
+  workbook.add_or_copy_sheet
 
-  book.add_or_copy_sheet(sheet, :as => 'new_name', :after => another_sheet)  
+  workbook.add_or_copy_sheet(sheet, :as => 'new_name', :after => another_sheet)  
 
 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.
 

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/extconf.rb

@@ -0,0 +1,7 @@
+dummy_make_content = "make:\n" \
+                     "\t:\n" \
+                     "install:\n" \
+                     "\t:\n" \
+                     "clean:\n" \
+                     "\t:\n"
+File.write('Makefile', dummy_make_content)

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')
@@ -14,5 +15,7 @@ require File.join(File.dirname(__FILE__), 'robust_excel_ole/worksheet')
 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 "robust_excel_ole/version"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
+
+include RobustExcelOle
+include General

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
@@ -173,8 +85,7 @@ module RobustExcelOle
           home = homes.find { |h| !ENV[h].nil? }
           reo_log_dir = ENV[home]
         else
-          #reo_log_dir = REO_LOG_DIR
-          reo_log_dir = "C:/Users/User"
+          reo_log_dir = REO_LOG_DIR
         end
         File.open(reo_log_dir + '/' + REO_LOG_FILE,'a') do |file|
           file.puts text

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
@@ -29,11 +30,9 @@ module RobustExcelOle
     #                             otherwise proceeds according to prefer_writable
     def fetch(filename, options = { :prefer_writable => true })
       return nil unless filename
-
       filename = General.absolute_path(filename)
       filename_key = General.canonize(filename)
-      weakref_books = @filename2books[filename_key]      
-      weakref_books = consider_networkpaths(filename_key) if weakref_books.empty? || weakref_books.nil?
+      weakref_books = @filename2books[filename_key]
       return nil if weakref_books.nil? || weakref_books.empty?
 
       result = open_book = closed_book = nil
@@ -67,68 +66,6 @@ module RobustExcelOle
       result
     end
 
-    # @private
-    def consider_networkpaths(filename)      
-      network = WIN32OLE.new('WScript.Network')
-      drives = network.enumnetworkdrives
-      drive_letter, filename_after_drive_letter = filename.split(':')   
-      found_filename = nil
-      # if filename starts with a drive letter not c and this drive exists,
-      # then if there is the corresponding host_share_path in the bookstore, 
-      # then take the corresponding workbooks      
-      if drive_letter != 'c' && drive_letter != filename    
-        for i in 0 .. drives.Count-1
-          next if i % 2 == 1
-          if drives.Item(i).gsub(':','').downcase == drive_letter
-            hostname_share = drives.Item(i+1).gsub('\\','/').gsub('//','').downcase
-            break
-          end
-        end        
-        @filename2books.each do |stored_filename,_|
-          if hostname_share && stored_filename
-            if stored_filename[0] == '/'
-              index_hostname = stored_filename[1,stored_filename.length].index('/')+2
-              index_hostname_share = stored_filename[index_hostname,stored_filename.length].index('/')
-              hostname_share_in_stored_filename = stored_filename[1,index_hostname+index_hostname_share-1] 
-              if hostname_share_in_stored_filename == hostname_share
-                found_filename = stored_filename
-                break
-              end
-            end
-          end
-        end
-      elsif filename[0] == '/'
-        # if filename starts with a host name and share, and this is an existing host name share path,
-        # then if there are workbooks with the corresponding drive letter,
-        # then take these workbooks,
-        index_hostname = filename[1,filename.length].index('/')+2
-        index_hostname_share = filename[index_hostname,filename.length].index('/')
-        hostname_share_in_filename = filename[1,index_hostname+index_hostname_share-1] 
-        filename_after_hostname_share = filename[index_hostname+index_hostname_share+1, filename.length]
-        require 'socket'
-        hostname = Socket.gethostname
-        if hostname_share_in_filename[0,hostname_share_in_filename.index('/')] == hostname.downcase
-          for i in 0 .. drives.Count-1
-            next if i % 2 == 1
-            hostname_share = drives.Item(i+1).gsub('\\','/').gsub('//','').downcase
-            if hostname_share == hostname_share_in_filename
-              drive_letter = drives.Item(i).gsub(':','').downcase
-              break
-            end
-          end
-          @filename2books.each do |stored_filename,_|
-            if stored_filename
-              if drive_letter && stored_filename.start_with?(drive_letter.downcase) && stored_filename.end_with?(filename_after_hostname_share)
-                found_filename = stored_filename
-                break
-              end
-            end
-          end
-        end
-      end
-      @filename2books[found_filename]
-    end
-
     # stores a workbook
     # @param [Workbook] book a given book
     def store(book)
@@ -138,8 +75,7 @@ module RobustExcelOle
         # deletes the weak reference to the book
         @filename2books[old_filename_key].delete(book)
       end
-      @filename2books[filename_key] |= [WeakRef.new(book)]
-      book.stored_filename = book.filename
+      @filename2books[filename_key] |= [WeakRef.new(book)]      
     end
 
     # creates and returns a separate Excel instance with Visible and DisplayAlerts equal false
@@ -168,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
@@ -177,24 +112,26 @@ module RobustExcelOle
 
     # prints the book store
     # @private
-    def print
-      # trace "@filename2books:"
+    def print_filename2books
+      #puts "@filename2books:"
       if @filename2books
-        @filename2books.each do |_filename,books|
-          # trace " filename: #{filename}"
-          # trace " books:"
+        @filename2books.each do |filename,books|
+          #puts " filename: #{filename}"
+          #puts " books:"
           if books.empty?
-            # trace " []"
+            #puts " []"
           else
             books.each do |book|
               if book.weakref_alive?
-                # trace "#{book}"
+                #puts "book.filename: #{book.filename}"
               else # this should never happen
-                # trace "weakref not alive"
+                #puts "weakref not alive"
               end
             end
           end
         end
+      else
+        #puts "nil"
       end
     end
   end