robust_excel_ole 1.16 → 1.18.3

data/lib/robust_excel_ole/excel.rb

@@ -3,8 +3,6 @@
 require 'weakref'
 require 'Win32API'
 
-
-
 def ka
   Excel.kill_all
 end
@@ -16,9 +14,10 @@ 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
+  class Excel < VbaObjects
     attr_reader :ole_excel
     attr_reader :properties
+    attr_reader :address_tool
 
     alias ole_object ole_excel
 
@@ -125,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
@@ -138,7 +145,6 @@ module RobustExcelOle
       end
     end
 
-    # @private
     def ole_workbooks
       ole_workbooks = begin
         @ole_excel.Workbooks
@@ -153,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
@@ -175,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?
 
@@ -382,12 +391,11 @@ 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 ::CONNECT_EXCEL_JRUBY_BUG
         result = known_excel_instance
@@ -430,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 = {}
@@ -464,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
@@ -698,9 +707,10 @@ module RobustExcelOle
     # @private
     # returns active workbook
     def workbook
-      return @workbook unless @workbook.nil?
-      @workbook = workbook_class.new(@ole_excel.ActiveWorkbook)
-    end
+      @workbook ||= workbook_class.new(@ole_excel.ActiveWorkbook) if @ole_excel.Workbooks.Count > 0
+    end    
+
+    alias_method :active_workbook, :workbook
 
     # @private
     def to_s            
@@ -727,11 +737,26 @@ 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?
@@ -754,7 +779,16 @@ module RobustExcelOle
     end
   end
 
-  public
+public
+
+  # @private
+  class ExcelDamaged < ExcelREOError               
+  end
+
+  # @private
+  class UnsavedWorkbooks < ExcelREOError           
+  end
+
 
   Application = Excel
 
@@ -763,3 +797,4 @@ end
 class WIN32OLE
   include Enumerable
 end
+

data/lib/robust_excel_ole/general.rb

@@ -95,26 +95,28 @@ end
 
 # @private
 class WIN32OLE
-
-  include RobustExcelOle
   
   # type-lifting WIN32OLE objects to RobustExcelOle objects
   def to_reo
-    class2method = [{Excel => :Hwnd}, {Workbook => :FullName}, {Worksheet => :Copy}, {Range => :Address}]
+    class2method = [{Excel => :Hwnd}, {Workbook => :FullName}, {Worksheet => :Copy}, {RobustExcelOle::Range => :Row}]
     class2method.each do |element|
       classname = element.first.first
       method = element.first.last
       begin
         self.send(method)
-        return classname.new(self)
+        if classname == RobustExcelOle::Range && self.Rows.Count == 1 && self.Columns.Count == 1
+          return Cell.new(self)
+        else
+          return classname.new(self)
+        end
       rescue
         next
       end
     end
+    raise TypeREOError, "given object cannot be type-lifted to a RobustExcelOle object"
   end
 end
 
-
 # @private
 class ::String 
   def / path_part

data/lib/robust_excel_ole/range.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module RobustExcelOle
 
   # This class essentially wraps a Win32Ole Range object. 
@@ -6,22 +7,38 @@ module RobustExcelOle
   # that you would apply for a Range object. 
   # See https://docs.microsoft.com/en-us/office/vba/api/excel.worksheet#methods
 
-  class Range < REOCommon
+  class Range < VbaObjects
     include Enumerable
     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
@@ -48,7 +65,7 @@ module RobustExcelOle
           self.Value
         else
           address_r1c1 = self.AddressLocal(true,true,XlR1C1)
-          row, col = Address.int_range(address_r1c1)
+          row, col = address_tool.as_integer_ranges(address_r1c1)
           values = []
           row.each do |r|
             values_col = []
@@ -69,7 +86,7 @@ module RobustExcelOle
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
-          row, col = Address.int_range(address_r1c1)
+          row, col = address_tool.as_integer_ranges(address_r1c1)
           row.each_with_index do |r,i|
             col.each_with_index do |c,j|
               ole_range.Cells(i+1,j+1).Value = (value.respond_to?(:first) ? value[i][j] : value)
@@ -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
@@ -115,8 +130,7 @@ module RobustExcelOle
           { }
         end
       end
-      rows, columns = Address.int_range(dest_address)
-      #dest_sheet = @worksheet if dest_sheet == :__not_provided
+      rows, columns = address_tool.as_integer_ranges(dest_address)
       dest_address_is_position = (rows.min == rows.max && columns.min == columns.max)
       dest_range_address = if (not dest_address_is_position) 
           [rows.min..rows.max,columns.min..columns.max]
@@ -168,7 +182,7 @@ module RobustExcelOle
     # @options [Worksheet] the destination worksheet
     # @options [Hash] options: :transpose, :values_only
     def copy_special(dest_address, dest_sheet = :__not_provided, options = { })
-      rows, columns = Address.int_range(dest_address)
+      rows, columns = address_tool.as_integer_ranges(dest_address)
       dest_sheet = @worksheet if dest_sheet == :__not_provided
       dest_address_is_position = (rows.min == rows.max && columns.min == columns.max)
       dest_range_address = if (not dest_address_is_position) 
@@ -220,6 +234,11 @@ module RobustExcelOle
         self.Address == other_range.Address 
     end
 
+    # @private
+    def excel
+      @worksheet.workbook.excel
+    end
+
     # @private
     def self.worksheet_class   
       @worksheet_class ||= begin
@@ -237,7 +256,6 @@ module RobustExcelOle
 
   private
 
-    # @private
     def method_missing(name, *args) 
       if name.to_s[0,1] =~ /[A-Z]/
         if ::ERRORMESSAGE_JRUBY_BUG
@@ -258,4 +276,9 @@ module RobustExcelOle
       end
     end
   end
+
+  # @private
+  class RangeNotCopied < MiscREOError              
+  end
+
 end

data/lib/robust_excel_ole/range_owners.rb

@@ -2,7 +2,7 @@
 
 module RobustExcelOle
 
-  class RangeOwners < REOCommon
+  class RangeOwners < VbaObjects
 
     # returns the contents of a range with given name
     # if the name could not be found or the value could not be determined,
@@ -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 
@@ -75,7 +76,7 @@ module RobustExcelOle
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
-          row, col = Address.int_range(address_r1c1)
+          row, col = address_tool.as_integer_ranges(address_r1c1)
           row.each_with_index do |r,i|
             col.each_with_index do |c,j|
               ole_range.Cells(i+1,j+1).Value = (value.respond_to?(:first) ? value[i][j] : value )
@@ -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 
@@ -141,7 +143,7 @@ module RobustExcelOle
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
-          row, col = Address.int_range(address_r1c1)
+          row, col = address_tool.as_integer_ranges(address_r1c1)
           row.each_with_index do |r,i|
             col.each_with_index do |c,j|
               ole_range.Cells(i+1,j+1).Value = (value.respond_to?(:first) ? value[i][j] : value)
@@ -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
@@ -192,8 +195,8 @@ module RobustExcelOle
         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('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + Address.r1c1(address))          
-          range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange)
+          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, worksheet)
           self.Names.Item('__dummy001').Delete
           workbook = self.is_a?(Workbook) ? self : self.workbook
           workbook.save
@@ -216,7 +219,7 @@ module RobustExcelOle
     def add_name(name, addr, addr_deprecated = :__not_provided)
       addr = [addr,addr_deprecated] unless addr_deprecated == :__not_provided
       begin       
-        self.Names.Add(name, nil, true, nil, nil, nil, nil, nil, nil, '=' + Address.r1c1(addr))
+        self.Names.Add(name, nil, true, nil, nil, nil, nil, nil, nil, '=' + address_tool.as_r1c1(addr))
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
         raise RangeNotEvaluatable, "cannot add name #{name.inspect} to range #{addr.inspect}"
       end
@@ -257,7 +260,7 @@ module RobustExcelOle
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
         raise UnexpectedREOError, "name error in #{File.basename(self.stored_filename).inspect}"
       end
-    end
+    end   
 
   private
 
@@ -273,4 +276,16 @@ module RobustExcelOle
 
   end
 
+  # @private
+  class NameNotFound < NamesREOError               
+  end
+
+  # @private
+  class NameAlreadyExists < NamesREOError          
+  end
+
+  # @private
+  class RangeNotCreated < MiscREOError             
+  end  
+
 end