robust_excel_ole 1.11 → 1.12

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -1,8 +1,8 @@
 # example_ifunsaved_forget_more.rb:
 # open with :if_unsaved => :forget, :new_excel, close with :if_unsaved => :save 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,26 +11,25 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
-  book = Workbook.open(file_name)                      # open a book
-  #book.excel.visible = true                        # make current Excel visible 
-  sheet = book.sheet(1)                                            # access a sheet
+  book = Workbook.open(file_name, :visible => true)  # open a workbook
+  sheet = book.sheet(1)                                            # access a worksheet
   first_cell = sheet[1,1].Value
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
-  new_book = Workbook.open(file_name, :if_unsaved => :new_excel, :visible => true) # open another book with the same file name in a new Excel
+  new_book = Workbook.open(file_name, :if_unsaved => :new_excel, :visible => true) # open another workbook with the same file name in a new Excel
   sheet_new_book = new_book.sheet(1)
-  if (not book.alive?) && new_book.alive? && sheet_new_book[1,1].Value == first_cell then # check whether the unsaved book 
+  if (not book.alive?) && new_book.alive? && sheet_new_book[1,1].Value == first_cell then # check whether the unsaved workbook 
     puts "open with :if_unsaved => :forget : the unsaved book is closed and not saved."     # is closed and was not saved
   end
   sleep 1
   sheet_new_book[1,1] = sheet_new_book[1,1].Value == "simple" ? "complex" : "simple" # change a cell
-  # open another book in the running Excel application, and make Excel visible, closing the unsaved book
+  # open another workbook in the running Excel application, and make Excel visible, closing the unsaved workbook
   another_book = Workbook.open(file_name, :if_unsaved => :forget, :visible => true)  
   sleep 1
   sheet_another_book = another_book.sheet(1)
   sheet_another_book[1,1] = sheet_another_book[1,1].Value == "simple" ? "complex" : "simple" # change a cell                                                                   
-  another_book.close(:if_unsaved => :forget )           # close the last book without saving it.                      
-  book.close(:if_unsaved => :save)                      # close the first book and save it before
+  another_book.close(:if_unsaved => :forget )           # close the last workbook without saving it.                      
+  book.close(:if_unsaved => :save)                      # close the first workbook and save it before
 ensure
 	  Excel.kill_all                                    # close all workbooks, quit Excel application
     rm_tmp(dir)

data/examples/open_save_close/example_read_only.rb

@@ -1,7 +1,7 @@
 # example_read_only: open with read_only mode. save, close 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,17 +11,17 @@ begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
   other_file_name = dir + 'different_workbook.xls'
-  book = Workbook.open(file_name, :read_only => true, :visible => true) # open a book with read_only and make Excel visible
-  sheet = book.sheet(1)                                     			        # access a sheet
+  book = Workbook.open(file_name, :read_only => true, :visible => true) # open a workbook with read_only and make Excel visible
+  sheet = book.sheet(1)                                     			        # access a worksheet
   sleep 1     
   sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   begin
     book.save                                         # simple save. 
-  rescue WorkbookReadOnly => msg                        # raises an exception because book is opened in read_only mode
+  rescue WorkbookReadOnly => msg                        # raises an exception because workbook is opened in read_only mode
     puts "error: save_as: #{msg.message}"
   end
-  book.close                                          # close the book without saving it 
+  book.close                                          # close the workbook without saving it 
 ensure
   Excel.kill_all                                     # close workbooks, quit Excel application
   rm_tmp(dir)

data/examples/open_save_close/example_rename_cells.rb

@@ -1,8 +1,8 @@
 # example_simple.rb: 
 # open a book, simple save, save_as, close
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,8 +11,7 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
-  book = Workbook.open(file_name)                                # open a book.  default:  :read_only => false
-  book.excel.visible = true                                          # make current Excel visible
+  book = Workbook.open(file_name, :visible => true)       # open a workbook.  default:  :read_only => false
   sheet = book.sheet(1)
   workbook = book.ole_workbook
   fullname = workbook.Fullname
@@ -48,7 +47,7 @@ begin
   sleep 2
   new_name_object.Delete
   sleep 2
-  book.close(:if_unsaved => :forget)                        # close the book
+  book.close(:if_unsaved => :forget)                        # close the workbook
 
 ensure
 	  Excel.kill_all                                         # close workbooks, quit Excel application

data/examples/open_save_close/example_reuse.rb

@@ -1,7 +1,7 @@
 # example_reuse.rb: open a book in a new Excel and a running Excel instance. make visible
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -13,16 +13,16 @@ begin
   file_name2 = dir + 'different_workbook.xls'
   file_name3 = dir + 'different_workbook.xls'
   file_name4 = dir + 'book_with_blank.xls'
-  book1 = Workbook.open(file_name1)         # open a book in a new Excel instance since no Excel is open
+  book1 = Workbook.open(file_name1)         # open a workbook in a new Excel instance since no Excel is open
   book1.excel.visible = true                # make current Excel visible
   sleep 2
   book2 = Workbook.open(file_name2)             # open a new book in the same Excel instance
   sleep 2                                   
-  book3 = Workbook.open(file_name3, :force_excel => :new, :visible => true) # open another book in a new Excel instance, 
+  book3 = Workbook.open(file_name3, :force_excel => :new, :visible => true) # open another workbook in a new Excel instance, 
   sleep 2                                                          # make Excel visible
-  book4 = Workbook.open(file_name4, :visible => true)  # open anther book, and use a running Excel application
+  book4 = Workbook.open(file_name4, :visible => true)  # open another workbook, and use a running Excel application
   sleep 2                                          # (Excel chooses the first Excel application)        
-  book1.close                               # close the books
+  book1.close                               # close the workbooks
   book2.close                                             
   book3.close
   book4.close                                         

data/examples/open_save_close/example_simple.rb

@@ -5,8 +5,8 @@ LOG_TO_STDOUT = false
 REO_LOG_FILE = "reo2.log"
 REO_LOG_DIR = "C:/"
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -16,9 +16,9 @@ begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
   other_file_name = dir + 'different_workbook.xls'
-  book = Workbook.open(file_name)                                # open a book.  default:  :read_only => false
+  book = Workbook.open(file_name, :visible => true)          # open a workbook.  default:  :read_only => false
   book.excel.visible = true                                  # make current Excel visible
-  sheet = book.sheet(1)                                            # access a sheet
+  sheet = book.sheet(1)                                      # access a worksheet
   sleep 1     
   sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"  # change a cell
   sleep 1
@@ -30,7 +30,7 @@ begin
   end
   book.save_as(other_file_name, :if_exists => :overwrite)    # save_as with :if_exists => :overwrite
   puts "save_as: saved successfully with option :if_exists => :overwrite"
-  book.close                                                 # close the book
+  book.close                                                 # close the workbook
 ensure
 	  Excel.kill_all                                         # close workbooks, quit Excel application
     #rm_tmp(dir)

data/examples/open_save_close/example_unobtrusively.rb

@@ -1,7 +1,7 @@
 # example_unobtrusively.rb:
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -10,7 +10,7 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   simple_file = dir + 'workbook.xls'
-  book = Workbook.open(simple_file, :visible => true)  # open a book, make Excel visible
+  book = Workbook.open(simple_file, :visible => true)  # open a workbook, make Excel visible
   old_sheet = book.sheet(1)
   p "1st cell: #{old_sheet[1,1].Value}"
   sleep 2
@@ -21,7 +21,7 @@ begin
   new_sheet = book.sheet(1)
   p "1st cell: #{new_sheet[1,1].Value}"
   p "book saved" if book.Saved
-  book.close                                 # close the book                      
+  book.close                                 # close the workbook                      
 ensure
   Excel.kill_all                            # close all workbooks, quit Excel application
   rm_tmp(dir)

data/lib/robust_excel_ole/address.rb

@@ -4,10 +4,6 @@ module RobustExcelOle
 
   class Address < REOCommon
 
-    # hack
-    #@@row_letter = "Z"
-    #@@col_letter = "S"
-
     def self.new(r1c1_letters)
       @@row_letter = r1c1_letters[0..0]
       @@col_letter = r1c1_letters[1..1]

data/lib/robust_excel_ole/bookstore.rb

@@ -67,15 +67,15 @@ 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
-      # otherwise (there is an usual file path) find in the bookstore the workbooks of which filenames 
-      # ends with the latter part of the given filename (after the drive letter)
+      # then take the corresponding workbooks      
       if drive_letter != 'c' && drive_letter != filename    
         for i in 0 .. drives.Count-1
           next if i % 2 == 1
@@ -83,8 +83,7 @@ module RobustExcelOle
             hostname_share = drives.Item(i+1).gsub('\\','/').gsub('//','').downcase
             break
           end
-        end
-        found_filename = nil
+        end        
         @filename2books.each do |stored_filename,_|
           if hostname_share && stored_filename
             if stored_filename[0] == '/'
@@ -95,8 +94,6 @@ module RobustExcelOle
                 found_filename = stored_filename
                 break
               end
-            elsif found_filename.nil? && stored_filename.end_with?(filename_after_drive_letter)
-              found_filename = stored_filename
             end
           end
         end
@@ -104,8 +101,6 @@ module RobustExcelOle
         # 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,
-        # otherwise (there is an usual file path) find in the bookstore the workbooks of which filenames
-        # ends with the latter part of the given filename (after the drive letter)
         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] 
@@ -126,29 +121,10 @@ module RobustExcelOle
               if drive_letter && stored_filename.start_with?(drive_letter.downcase) && stored_filename.end_with?(filename_after_hostname_share)
                 found_filename = stored_filename
                 break
-              elsif found_filename.nil? && stored_filename.end_with?(filename_after_hostname_share)
-                found_filename = stored_filename
               end
             end
           end
         end
-      else
-        # if filename is an usual file path,
-        # then find in the bookstore a workbook of which filename starts with
-        # a drive letter or a host name
-        @filename2books.each do |stored_filename,_|
-          drive_letter, _ = stored_filename.split(':')   
-          stored_filename_end = if drive_letter != stored_filename && drive_letter != 'c'
-            stored_filename[stored_filename.index(':')+1,stored_filename.length]
-          elsif stored_filename[0] == '/'
-            index_after_hostname = stored_filename[1,stored_filename.length].index('/')
-            stored_filename[index_after_hostname+1, stored_filename.length]
-          end
-          if stored_filename_end && filename.end_with?(stored_filename_end)
-            found_filename = stored_filename
-            break
-          end
-        end
       end
       @filename2books[found_filename]
     end

data/lib/robust_excel_ole/excel.rb

@@ -16,7 +16,7 @@ module RobustExcelOle
 
   class Excel < RangeOwners
     attr_accessor :ole_excel
-    attr_accessor :created
+    #attr_accessor :created
     attr_accessor :workbook
 
     # setter methods are implemented below
@@ -78,13 +78,13 @@ module RobustExcelOle
       #ole_xl = current_excel if options[:reuse] == true
       if options[:reuse] == true && ole_xl.nil?
         ole_xl = if RUBY_PLATFORM =~ /java/         
-          excel_instance = known_excel_instance if excel_instance.nil?
+          excel_instance = known_excel_instance 
           excel_instance.ole_excel unless excel_instance.nil?
         else
           current_excel
         end
       end
-      connected = (not ole_xl.nil?)
+      connected = (not ole_xl.nil?) && win32ole_excel.nil?
       ole_xl ||= WIN32OLE.new('Excel.Application')
       hwnd = ole_xl.HWnd
       stored = hwnd2excel(hwnd)
@@ -97,18 +97,15 @@ module RobustExcelOle
         @@hwnd2excel[hwnd] = WeakRef.new(result)
       end
 
-      unless options.is_a? WIN32OLE
-        begin
-          reused = options[:reuse] && stored && stored.alive? 
-          if (not reused) && (not connected)
-            options = { :displayalerts => :if_visible, :visible => false, :screenupdating => true }.merge(options)
-          end
-          result.visible = options[:visible] unless options[:visible].nil? 
-          result.displayalerts = options[:displayalerts] unless options[:displayalerts].nil?
-          result.calculation = options[:calculation] unless options[:calculation].nil?
-          result.screenupdating = options[:screenupdating] unless options[:screenupdating].nil?
-          result.created = !reused
+      begin
+        reused = options[:reuse] && stored && stored.alive? 
+        unless reused || connected
+          options = { :displayalerts => :if_visible, :visible => false, :screenupdating => true }.merge(options)
         end
+        result.visible = options[:visible] unless options[:visible].nil? 
+        result.displayalerts = options[:displayalerts] unless options[:displayalerts].nil?
+        result.calculation = options[:calculation] unless options[:calculation].nil?
+        result.screenupdating = options[:screenupdating] unless options[:screenupdating].nil?
       end
       result
     end    
@@ -246,8 +243,8 @@ module RobustExcelOle
       end
       begin
         @ole_excel.Workbooks.Close
-      rescue WIN32OLERuntimeError => msg
-        if msg.message =~ /800A03EC/
+      rescue
+        if $!.message =~ /kann nicht zugeordnet werden/ or $!.message =~ /800A03EC/
           raise ExcelREOError, 'user canceled or runtime error'
         else
           raise UnexpectedREOError, "unknown WIN32OLERuntimeError: #{msg.message}"
@@ -658,11 +655,6 @@ module RobustExcelOle
       ole_workbooks.each do |ow|
         wb = workbook_class.new(ow, opts)
         block_given? ? (yield wb) : wb
-        #if block_given? 
-        #  yield workbook_class.new(ow, opts)
-        #else
-        #  workbook_class.new(ow, opts)
-        #end
       end
     end
 
@@ -694,7 +686,10 @@ module RobustExcelOle
     # @param [String]  name  the name of the range
     # @param [Variant] value the contents of the range
     def []=(name, value)
-      set_namevalue_glob(name,value, :color => 42) # 42 - aqua-marin, 7-green
+      old_color_if_modified = workbook.color_if_modified
+      workbook.color_if_modified = 42  unless workbook.nil? # aqua-marin
+      set_namevalue_glob(name,value)
+      workbook.color_if_modified = old_color_if_modified
     end
 
     # @private

data/lib/robust_excel_ole/general.rb

@@ -6,7 +6,7 @@ module General
   def absolute_path(file) 
     file = File.expand_path(file)
     file = RobustExcelOle::Cygwin.cygpath('-w', file) if RUBY_PLATFORM =~ /cygwin/
-    WIN32OLE.new('Scripting.FileSystemObject').GetAbsolutePathName(file)
+    WIN32OLE.new('Scripting.FileSystemObject').GetAbsolutePathName(file).tr('/','\\')
   end
 
   # @private
@@ -64,33 +64,26 @@ end
 
 # @private
 class WIN32OLE
+
+  include RobustExcelOle
   
   # promoting WIN32OLE objects to RobustExcelOle objects
   def to_reo
-    begin
-      self.Hwnd
-      RobustExcelOle::Excel.new(self)
-    rescue
+    class2method = [{Excel => :Hwnd}, {Workbook => :FullName}, {Worksheet => :Copy}, {Range => :Address}]
+    class2method.each do |element|
+      classname = element.first.first
+      method = element.first.last
       begin
-        self.FullName
-        RobustExcelOle::Workbook.new(self)
+        self.send(method)
+        return classname.new(self)
       rescue
-        begin
-          self.Copy
-          RobustExcelOle::Worksheet.new(self)
-        rescue          
-          begin
-            self.Address
-            RobustExcelOle::Range.new(self)        
-          rescue
-            self
-          end
-        end
+        next
       end
     end
   end
 end
 
+
 # @private
 class ::String 
   def / path_part

data/lib/robust_excel_ole/range_owners.rb

@@ -61,18 +61,16 @@ module RobustExcelOle
     # sets the contents of a range
     # @param [String]  name  the name of a range
     # @param [Variant] value the contents of the range
-    # @param [FixNum]  color the color when setting a value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_namevalue_glob(name, value, opts = { :color => 0 })
+    def set_namevalue_glob(name, value, opts = { })  # opts is deprecated
       begin
         name_obj = begin
           name_object(name)
         rescue NameNotFound => msg
           raise
-        end
+        end        
         ole_range = name_object(name).RefersToRange
-        ole_range.Interior.ColorIndex = opts[:color]
-        workbook.modified_cells << ole_range if workbook # unless cell_modified?(cell)
+        workbook.color_if_modified = opts[:color] unless opts[:color].nil?
+        ole_range.Interior.ColorIndex = workbook.color_if_modified unless workbook.color_if_modified.nil?
         if RUBY_PLATFORM !~ /java/
           ole_range.Value = value
         else
@@ -128,19 +126,17 @@ module RobustExcelOle
 
     # assigns a value to a range given a locally defined name
     # @param [String]  name   the name of a range
-    # @param [Variant] value  the assigned value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_namevalue(name, value, opts = { :color => 0 })
+    # @param [Variant] value  the assigned value   
+    def set_namevalue(name, value, opts = { })  # opts is deprecated
       begin
-        return set_namevalue_glob(name, value, opts) if self.is_a?(Workbook)
+        return set_namevalue_glob(name, value, opts) if self.is_a?(Workbook)  # opts deprecated
         ole_range = self.Range(name)
       rescue # WIN32OLERuntimeError
         raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
       end
       begin
-        ole_range.Interior.ColorIndex = opts[:color]
-        workbook.modified_cells << ole_range if workbook # unless cell_modified?(range)
-        #range.Value = value
+        workbook.color_if_modified = opts[:color] unless opts[:color].nil?
+        ole_range.Interior.ColorIndex = workbook.color_if_modified unless workbook.color_if_modified.nil?
         if RUBY_PLATFORM !~ /java/
           ole_range.Value = value
         else
@@ -164,8 +160,8 @@ module RobustExcelOle
     end
 
     # @private
-    def set_nameval(name, value, opts = { :color => 0 })        # :deprecated: #
-      set_namevalue_glob(name, value, opts)
+    def set_nameval(name, value)        # :deprecated: #
+      set_namevalue_glob(name, value)
     end
 
     # @private
@@ -174,8 +170,8 @@ module RobustExcelOle
     end
 
     # @private
-    def set_rangeval(name, value, opts = { :color => 0 })       # :deprecated: #
-      set_namevalue(name, value, opts)
+    def set_rangeval(name, value)       # :deprecated: #
+      set_namevalue(name, value)
     end
 
     # creates a range from a given defined name or address
@@ -195,10 +191,7 @@ module RobustExcelOle
         end
         if self.is_a?(Worksheet) && (range.nil? || (address2 != :__not_provided))
           address = name_or_address
-          address = [name_or_address,address2] unless address2 == :__not_provided
-          #self.Names.Add('Name' => '__dummy001', 'RefersToR1C1' => '=' + Address.r1c1(address))
-          #not_given = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_NULL)
-          #self.Names.Add('__dummy001',not_given,true,not_given,not_given,not_given,not_given,not_given,not_given,'=' + Address.r1c1(address))          
+          address = [name_or_address,address2] unless address2 == :__not_provided         
           self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + Address.r1c1(address))          
           range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange)
           self.Names.Item('__dummy001').Delete
@@ -222,10 +215,7 @@ module RobustExcelOle
     # @params [Address] address of the range
     def add_name(name, addr, addr_deprecated = :__not_provided)
       addr = [addr,addr_deprecated] unless addr_deprecated == :__not_provided
-      begin
-        #self.Names.Add('Name' => name, 'RefersToR1C1' => '=' + Address.r1c1(addr))
-        #not_given = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_NULL)
-        #self.Names.Add(name, not_given, true, not_given, not_given, not_given, not_given, not_given, not_given, '=' + Address.r1c1(addr))
+      begin       
         self.Names.Add(name, nil, true, nil, nil, nil, nil, nil, nil, '=' + Address.r1c1(addr))
       rescue # WIN32OLERuntimeError => msg
         raise RangeNotEvaluatable, "cannot add name #{name.inspect} to range #{addr.inspect}"
@@ -243,12 +233,12 @@ module RobustExcelOle
     def rename_range(name, new_name)
       begin
         item = self.Names.Item(name)
-      rescue WIN32OLERuntimeError
+      rescue # WIN32OLERuntimeError
         raise NameNotFound, "name #{name.inspect} not in #{File.basename(self.stored_filename).inspect}"
       end
       begin
         item.Name = new_name
-      rescue WIN32OLERuntimeError
+      rescue # WIN32OLERuntimeError
         raise UnexpectedREOError, "name error in #{File.basename(self.stored_filename).inspect}"
       end
     end