robust_excel_ole 1.14 → 1.18.1

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

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

data/lib/robust_excel_ole/excel.rb

@@ -14,21 +14,17 @@ module RobustExcelOle
   # that you would apply for an Application object. 
   # See https://docs.microsoft.com/en-us/office/vba/api/excel.application(object)#methods
 
-  class Excel < RangeOwners
-    attr_accessor :ole_excel
-    #attr_accessor :created
-    attr_accessor :workbook
-
-    # setter methods are implemented below
-    attr_reader :visible
-    attr_reader :displayalerts
-    attr_reader :calculation
-    attr_reader :screenupdating
+  class Excel < VbaObjects
+    attr_reader :ole_excel
+    attr_reader :properties
+    attr_reader :address_tool
 
     alias ole_object ole_excel
 
     @@hwnd2excel = {}
 
+    PROPERTIES = [:visible, :displayalerts, :calculation, :screenupdating]
+
     # creates a new Excel instance
     # @param [Hash] options the options
     # @option options [Variant] :displayalerts
@@ -96,10 +92,7 @@ module RobustExcelOle
         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?
+        result.set_options(options)        
       end
       result
     end    
@@ -117,14 +110,10 @@ module RobustExcelOle
     # @return [Excel] an Excel instance
     def recreate(opts = {})
       unless alive?
-        opts = {
-          :visible => @visible || false,
-          :displayalerts => @displayalerts || :if_visible
-        }.merge(opts)
+        opts = {:visible => false, :displayalerts => :if_visible}.merge(
+               {:visible => @properties[:visible], :displayalerts => @properties[:displayalerts]}).merge(opts)        
         @ole_excel = WIN32OLE.new('Excel.Application')
-        self.visible = opts[:visible]
-        self.displayalerts = opts[:displayalerts]
-        self.calculation = opts[:calculation]
+        set_options(opts)
         if opts[:reopen_workbooks]
           books = workbook_class.books
           books.each do |book|
@@ -135,10 +124,18 @@ module RobustExcelOle
       self
     end
 
+    # @private
+    def address_tool
+      raise(ExcelREOError, "Excel contains no workbook") unless @ole_excel.Workbooks.Count > 0
+      @address_tool ||= begin
+        address_string = @ole_excel.Workbooks.Item(1).Worksheets.Item(1).Cells.Item(1,1).Address(true,true,XlR1C1)
+        address_tool_class.new(address_string)
+      end
+    end
+
   private
 
     # retain the saved status of all workbooks
-    # @private
     def retain_saved_workbooks
       saved_stati = @ole_excel.Workbooks.map { |w| w.Saved }
       begin
@@ -148,7 +145,6 @@ module RobustExcelOle
       end
     end
 
-    # @private
     def ole_workbooks
       ole_workbooks = begin
         @ole_excel.Workbooks
@@ -163,11 +159,13 @@ module RobustExcelOle
 
   public
 
+    # @private
     def self.contains_unsaved_workbooks?
       !Excel.current.unsaved_workbooks.empty?
     end
 
     # returns unsaved workbooks (win32ole objects)
+    # @private
     def unsaved_workbooks
       unsaved_workbooks = []
       begin
@@ -185,6 +183,7 @@ module RobustExcelOle
     #                      :forget          -> closes the Excel instance without saving the workbooks
     #                      :save            -> saves the workbooks before closing
     #                      :alert           -> let Excel do it
+    # @private
     def close_workbooks(options = { :if_unsaved => :raise })
       return unless alive?
 
@@ -392,14 +391,13 @@ module RobustExcelOle
       @@hwnd2excel.size
     end
 
-  #private
+  private
 
     # returns a Win32OLE object that represents a Excel instance to which Excel connects
     # connects to the first opened Excel instance
     # if this Excel instance is being closed, then Excel creates a new Excel instance
-    # @private
     def self.current_ole_excel   
-      if JRUBY_BUG_CONNECT
+      if ::CONNECT_EXCEL_JRUBY_BUG
         result = known_excel_instance
         if result.nil?
           if excels_number > 0
@@ -440,6 +438,25 @@ module RobustExcelOle
       nil
     end
 
+    def self.hwnd2excel(hwnd)
+      excel_weakref = @@hwnd2excel[hwnd]
+      if excel_weakref
+        if excel_weakref.weakref_alive?
+          excel_weakref.__getobj__
+        else
+          trace 'dead reference to an Excel'
+          begin
+            @@hwnd2excel.delete(hwnd)
+            nil
+          rescue
+            trace "Warning: deleting dead reference failed! (hwnd: #{hwnd.inspect})"
+          end
+        end
+      end
+    end
+
+  public
+
     # returns all Excel objects for all Excel instances opened with RobustExcelOle
     def self.known_excel_instances
       pid2excel = {}
@@ -474,24 +491,6 @@ module RobustExcelOle
       self
     end
 
-    # @private
-    def self.hwnd2excel(hwnd)
-      excel_weakref = @@hwnd2excel[hwnd]
-      if excel_weakref
-        if excel_weakref.weakref_alive?
-          excel_weakref.__getobj__
-        else
-          trace 'dead reference to an Excel'
-          begin
-            @@hwnd2excel.delete(hwnd)
-            nil
-          rescue
-            trace "Warning: deleting dead reference failed! (hwnd: #{hwnd.inspect})"
-          end
-        end
-      end
-    end
-
     # @private
     def hwnd 
       self.Hwnd
@@ -545,7 +544,7 @@ module RobustExcelOle
 
     # sets DisplayAlerts in a block
     def with_displayalerts displayalerts_value
-      old_displayalerts = displayalerts
+      old_displayalerts = @properties[:displayalerts]
       self.displayalerts = displayalerts_value
       begin
         yield self
@@ -556,26 +555,29 @@ module RobustExcelOle
 
     # makes the current Excel instance visible or invisible
     def visible= visible_value
-      @ole_excel.Visible = @visible = visible_value
-      @ole_excel.DisplayAlerts = @visible if @displayalerts == :if_visible
+      return if visible_value.nil?
+      @ole_excel.Visible = @properties[:visible] = visible_value
+      @ole_excel.DisplayAlerts = @properties[:visible] if @properties[:displayalerts] == :if_visible
     end
 
     # enables DisplayAlerts in the current Excel instance
     def displayalerts= displayalerts_value
-      @displayalerts = displayalerts_value
-      @ole_excel.DisplayAlerts = @displayalerts == :if_visible ? @ole_excel.Visible : displayalerts_value
+      return if displayalerts_value.nil?
+      @properties[:displayalerts] = displayalerts_value
+      @ole_excel.DisplayAlerts = @properties[:displayalerts] == :if_visible ? @ole_excel.Visible : displayalerts_value
     end
 
     # sets ScreenUpdating
     def screenupdating= screenupdating_value
-      @ole_excel.ScreenUpdating = @screenupdating = screenupdating_value
+      return if screenupdating_value.nil?
+      @ole_excel.ScreenUpdating = @properties[:screenupdating] = screenupdating_value
     end
 
     # sets calculation mode
     # retains the saved-status of the workbooks when set to manual
     def calculation= calculation_mode
       return if calculation_mode.nil?
-      @calculation = calculation_mode
+      @properties[:calculation] = calculation_mode
       calc_mode_changable = @ole_excel.Workbooks.Count > 0 && @ole_excel.Calculation.is_a?(Integer)
       if calc_mode_changable
         retain_saved_workbooks do
@@ -615,9 +617,9 @@ module RobustExcelOle
     def Calculation= calculation_vba_mode
       case calculation_vba_mode
       when XlCalculationManual
-        @calculation = :manual
+        @properties[:calculation] = :manual
       when XlCalculationAutomatic
-        @calculation = :automatic
+        @properties[:calculation] = :automatic
       end
       @ole_excel.Calculation = calculation_vba_mode
     end
@@ -637,13 +639,22 @@ module RobustExcelOle
 
     # set options in this Excel instance
     def for_this_instance(options)
-      self.class.new(@ole_excel, options)
+      set_options(options)
+      #self.class.new(@ole_excel, options)
     end
 
-    def set_options(options)
-      for_this_instance(options)
-    end    
+    #def set_options(options)
+    #  for_this_instance(options)
+    #end  
 
+    def set_options(options)      
+      @properties ||= { }
+      PROPERTIES.each do |property|
+        method = (property.to_s + '=').to_sym
+        self.send(method, options[property]) 
+      end
+    end
+  
     # set options in all workbooks
     def for_all_workbooks(options)
       each_workbook(options)
@@ -690,12 +701,17 @@ module RobustExcelOle
     # @param [String]  name  the name of the range
     # @param [Variant] value the contents of the range
     def []=(name, value)
-      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
+      set_namevalue_glob(name, value, :color => 42)
     end
 
+    # @private
+    # returns active workbook
+    def workbook
+      @workbook ||= workbook_class.new(@ole_excel.ActiveWorkbook) if @ole_excel.Workbooks.Count > 0
+    end    
+
+    alias_method :active_workbook, :workbook
+
     # @private
     def to_s            
       '#<Excel: ' + hwnd.to_s + ('not alive' unless alive?).to_s + '>'
@@ -721,15 +737,30 @@ module RobustExcelOle
       self.class.workbook_class
     end
 
+    # @private
+    def self.address_tool_class  
+      @address_tool_class ||= begin
+        module_name = parent_name
+        "#{module_name}::AddressTool".constantize
+      rescue NameError => e
+        AddressTool
+      end
+    end
+
+    # @private
+    def address_tool_class       
+      self.class.address_tool_class
+    end
+
+
     include MethodHelpers
 
   private
 
-    # @private
     def method_missing(name, *args) 
       if name.to_s[0,1] =~ /[A-Z]/
         raise ObjectNotAlive, 'method missing: Excel not alive' unless alive?
-        if JRUBY_BUG_ERRORMESSAGE
+        if ::ERRORMESSAGE_JRUBY_BUG
           begin
             @ole_excel.send(name, *args)
           rescue Java::OrgRacobCom::ComFailException => msg
@@ -748,7 +779,16 @@ module RobustExcelOle
     end
   end
 
-  public
+public
+
+  # @private
+  class ExcelDamaged < ExcelREOError               
+  end
+
+  # @private
+  class UnsavedWorkbooks < ExcelREOError           
+  end
+
 
   Application = Excel
 
@@ -757,3 +797,4 @@ end
 class WIN32OLE
   include Enumerable
 end
+