robust_excel_ole 1.16 → 1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87f0b689fc32747c5adbeaeff32f823b2153dc613a2dc27ae6b3a52060241ca0
-  data.tar.gz: 2d89ef58db655b2a84b95b9dc3622fe1daae6bfafc37c1f03f9de1984cf7958e
+  metadata.gz: c268eff75271d48aae54af54c03c138e8a965a6c6965b6fc9b5fd330a346888d
+  data.tar.gz: '0921d96d9d20546523acb5ea5e419d8e2351307c23d25abe8b8d96010364b643'
 SHA512:
-  metadata.gz: 2a0074c2f763882481cdc43bb9a99b0c3b62d8ed2bfea646fc5d6d581719f01df7bb8a223c0d3629d698695b56629f1813b26f363a962707df91c42b51bebee0
-  data.tar.gz: 863b6380c04612c239bec9ce6998be0e9ed59ec884e2f57107aa2833f11b0ba4bca7258621bc48e818591a6c6d973fe961a5ca591b2dc85cd5a15fa13dbf1ed6
+  metadata.gz: c98669d651a2ff192bab0767ea16085a08cab8e0c656c3123b684080b96b62899967f3c4998637002dddf72eb1dbbd635f2ef102153d53842977adeba11d32c6
+  data.tar.gz: 1ac22fd73f4dae16142c1dc1d81bd9d9f8eeb5fbf95f85b4bcf26d99293b474c544aae863af4d40cc64052535ab40541956b69db8301274aade5afcacea37534

data/docs/README_open.rdoc

@@ -153,6 +153,7 @@ The method +General.to_reo+ enables type-lifting WIN32OLE objects to RobustExcel
 This object can be type-lifted to a RobustExcelOle workbook.
 
   workbook = win32ole_workbook.to_reo
+
   workbook.to_class
   => RobustExcelOle::Workbook
 
@@ -166,6 +167,9 @@ You can supply options, e.g. +:visible+.
 
    workbook = Workbook.new(win32ole_workbook, :visible => true) 
 
+You can also supply a workbook and options, e.g.
+
+   new_workbook = Workbook.new(workbook, :visible => true)
 
 === Identity transperence ===
 

data/lib/robust_excel_ole.rb

@@ -3,16 +3,17 @@ 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')
 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/cell')
 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/{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

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

data/lib/robust_excel_ole/cell.rb

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
 
 module RobustExcelOle
-  class Cell < REOCommon
-    attr_reader :cell
+
+  class Cell < Range
+    attr_reader :ole_cell    
 
     def initialize(win32_cell)
-      @cell = win32_cell.MergeCells ? win32_cell.MergeArea.Item(1,1) : win32_cell
+      @ole_cell = win32_cell.MergeCells ? win32_cell.MergeArea.Item(1,1) : win32_cell
+      super
     end
 
     def v
@@ -16,25 +18,27 @@ module RobustExcelOle
       self.Value = value
     end
 
+  private
+
     # @private
     def method_missing(name, *args) 
-      #if name.to_s[0,1] =~ /[A-Z]/
-      if ::ERRORMESSAGE_JRUBY_BUG
-        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)
+          rescue Java::OrgRacobCom::ComFailException 
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          end
+        else
+          begin
+            @ole_cell.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

@@ -16,9 +16,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 +126,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 +147,6 @@ module RobustExcelOle
       end
     end
 
-    # @private
     def ole_workbooks
       ole_workbooks = begin
         @ole_excel.Workbooks
@@ -153,11 +161,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 +185,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 +393,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 +440,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 +493,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
@@ -700,7 +711,9 @@ module RobustExcelOle
     def workbook
       return @workbook unless @workbook.nil?
       @workbook = workbook_class.new(@ole_excel.ActiveWorkbook)
-    end
+    end    
+
+    alias_method :active_workbook, :workbook
 
     # @private
     def to_s            
@@ -727,11 +740,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 +782,16 @@ module RobustExcelOle
     end
   end
 
-  public
+public
+
+  # @private
+  class ExcelDamaged < ExcelREOError               
+  end
+
+  # @private
+  class UnsavedWorkbooks < ExcelREOError           
+  end
+
 
   Application = Excel
 
@@ -763,3 +800,4 @@ end
 class WIN32OLE
   include Enumerable
 end
+