robust_excel_ole 1.3 → 1.4

data/examples/{edit_sheets → modifying_sheets}/example_concating.rb

@@ -24,7 +24,7 @@ begin
         name = cell.Name.Name rescue nil
         if name
           cell.Value = cell.Value.to_s + cell.Offset(0,1).Value.to_s
-          sheet.add_name(name, cell.Row, cell.Column)
+          sheet.add_name(name, [cell.Row, cell.Column])
         end
       end
     end

data/examples/{edit_sheets → modifying_sheets}/example_copying.rb

@@ -33,7 +33,7 @@ begin
           cell_name = short_name ? short_name : sheet_name
           contains_named_cells = true
           new_sheet[cell.Row, cell.Column].Value = cell.Value
-          new_sheet.add_name(cell_name, cell.Row,cell.Column)
+          new_sheet.add_name(cell_name, [cell.Row,cell.Column])
         end
       end
       new_sheet.Delete() unless contains_named_cells

data/examples/{edit_sheets → modifying_sheets}/example_expanding.rb

@@ -36,7 +36,7 @@ begin
       rescue REOError => msg
         sheet_new.name = sheet_name + sheet.name if msg.message == "sheet name already exists" 
       end
-      sheet_new.add_name("name",2,2)
+      sheet_new.add_name("name",[2,2])
       sheet_new["name"] = sheet_name   
     end
     

data/examples/{edit_sheets → modifying_sheets}/example_naming.rb

@@ -29,7 +29,7 @@ begin
     book.each do |sheet|
       sheet.each do |cell_orig|
         contents = cell_orig.Value
-        sheet.add_name(contents, cell_orig.Row, cell_orig.Column) if contents && contents.is_a?(String)
+        sheet.add_name(contents, [cell_orig.Row, cell_orig.Column]) if contents && contents.is_a?(String)
       end
     end
   end

data/examples/{edit_sheets → modifying_sheets}/example_ranges.rb

@@ -13,7 +13,7 @@ begin
   simple_file = dir + 'workbook.xls'
   simple_save_file = dir + 'workbook_save.xls'
   File.delete simple_save_file rescue nil
-  book = Book.open(simple_file)      # open a book
+  book = Workbook.open(simple_file)      # open a book
   sheet = book.sheet('Sheet1')             # access a sheet via the name
   row_r = sheet.row_range(1)         # access the whole range of the first row
   col_r = sheet.col_range(1, 1..2)   # access the first two cells of the range of the first column

data/examples/{edit_sheets → modifying_sheets}/example_saving.rb

@@ -16,7 +16,7 @@ begin
   suffix = ws.last  
   file_name = dir + "/" + workbook_name
 
-  Book.unobtrusively(file_name) do |book_orig| 
+  Workbook.unobtrusively(file_name) do |book_orig| 
     book_orig.each do |sheet_orig|
       file_sheet_name = dir + "/" + base_name + "_" + sheet_orig.name + "." + suffix
       Excel.current.generate_workbook(file_sheet_name)

data/examples/open_save_close/example_control_to_excel.rb

@@ -11,14 +11,14 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
-  book = Book.open(file_name)          # open a book
+  book = Workbook.open(file_name)          # open a book
   book.excel.visible = true                   # make current Excel visible 
   sleep 1
   sheet = book.sheet(1)                                                        # access a sheet
   sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"       # change a cell
   sleep 1
   begin
-    new_book = Book.open(file_name, :if_unsaved => :alert) # open another book with the same file name 
+    new_book = Workbook.open(file_name, :if_unsaved => :alert) # open another book with the same file name 
   rescue WorkbookREOError => msg                          # if the user chooses not open the book,
   	puts "#{msg.message}"                                  #   an exeptions is raised
   end

data/examples/open_save_close/example_if_obstructed_save.rb

@@ -15,7 +15,7 @@ begin
   book = Workbook.open(file_name, :visible => true)  # open a book, make Excel visible
   sleep 1
   sheet = book.sheet(1)
-  first_cell = sheet[1,1].value                                   # access a sheet
+  first_cell = sheet[1,1].Value                                   # access a sheet
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple"      # change a cell
   sleep 1
   new_book = Workbook.open(other_file_name, :if_obstructed => :save)  # open a book with the same file name in a different path
@@ -23,7 +23,7 @@ begin
   old_book = Workbook.open(file_name, :if_obstructed => :forget ,:visible => true) # open the old book    
   sleep 1
   old_sheet = old_book.sheet(1)
-  old_first_cell = old_sheet[1,1].value
+  old_first_cell = old_sheet[1,1].Value
   puts "the old book was saved" unless old_first_cell == first_cell 
   new_book.close                                 # close the books                      
   old_book.close

data/examples/open_save_close/example_if_unsaved_accept.rb

@@ -13,7 +13,7 @@ begin
   file_name = dir + 'workbook.xls' 
   book = Workbook.open(file_name)                      # open a book 
   sheet = book.sheet(1)                                                  # access a sheet
-  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple" # change a cell
+  sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple" # change a cell
   begin
     new_book = Workbook.open(file_name)                # open another book with the same file name
   rescue WorkbookNotSaved => msg                     # by default: raises an exception:

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -16,7 +16,7 @@ begin
   #book.excel.visible = true                        # make current Excel visible 
   sleep 1
   sheet = book.sheet(1)                                            # access a sheet
-  first_cell = sheet[1,1].value
+  first_cell = sheet[1,1].Value
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   puts "new_book: before"
@@ -25,11 +25,11 @@ begin
                                                           # and close the unsaved book without saving it
   puts "new_book: after"
   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 book 
     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
+  sheet_new_book[1,1] = sheet_new_book[1,1].Value == "simple" ? "complex" : "simple" # change a cell
   # open another book in a new Excel application, and make Excel visible, leaving the unsaved book open
   another_book = Workbook.open(file_name, :if_unsaved => :new_excel, :visible => true)  
   sleep 3                                                                  # leaving the unsaved book open  

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -14,21 +14,21 @@ begin
   book = Workbook.open(file_name)                      # open a book
   #book.excel.visible = true                        # make current Excel visible 
   sheet = book.sheet(1)                                            # access a sheet
-  first_cell = sheet[1,1].value
+  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
   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 book 
     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
+  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
   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                                                                   
+  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
 ensure

data/examples/open_save_close/example_read_only.rb

@@ -14,7 +14,7 @@ begin
   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
   sleep 1     
-  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple" # change a cell
+  sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   begin
     book.save                                         # simple save. 

data/examples/open_save_close/example_rename_cells.rb

@@ -17,7 +17,7 @@ begin
   workbook = book.ole_workbook
   fullname = workbook.Fullname
   puts "fullname: #{fullname}"  
-  sheet.add_name("a_name",1,1)   # rename cell A1 to "a_name"
+  sheet.add_name("a_name",[1,1])   # rename cell A1 to "a_name"
   number = workbook.Names.Count
   puts "number of name objects :#{number}"
   name_object = workbook.Names("a_name")

data/examples/open_save_close/example_simple.rb

@@ -20,7 +20,7 @@ begin
   book.excel.visible = true                                  # make current Excel visible
   sheet = book.sheet(1)                                            # access a sheet
   sleep 1     
-  sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple"  # change a cell
+  sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"  # change a cell
   sleep 1
   book.save                                                  # simple save
   begin

data/examples/open_save_close/example_unobtrusively.rb

@@ -12,14 +12,14 @@ begin
   simple_file = dir + 'workbook.xls'
   book = Workbook.open(simple_file, :visible => true)  # open a book, make Excel visible
   old_sheet = book.sheet(1)
-  p "1st cell: #{old_sheet[1,1].value}"
+  p "1st cell: #{old_sheet[1,1].Value}"
   sleep 2
   Workbook.unobtrusively(simple_file) do |book|   # modify the book and keep its status unchanged
     sheet = book.sheet(1)
-    sheet[1,1] = sheet[1,1].value == "simple" ? "complex" : "simple"
+    sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"
   end
   new_sheet = book.sheet(1)
-  p "1st cell: #{new_sheet[1,1].value}"
+  p "1st cell: #{new_sheet[1,1].Value}"
   p "book saved" if book.Saved
   book.close                                 # close the book                      
 ensure

data/lib/robust_excel_ole.rb

@@ -3,8 +3,8 @@ require File.join(File.dirname(__FILE__), 'robust_excel_ole/reo_common')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/general')
 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/book')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/sheet')
+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/cygwin') if RUBY_PLATFORM =~ /cygwin/

data/lib/robust_excel_ole/bookstore.rb

@@ -59,7 +59,7 @@ module RobustExcelOle
     end
 
     # stores a workbook
-    # @param [Book] book a given book
+    # @param [Workbook] book a given book
     def store(book)
       filename_key = General::canonize(book.filename)      
       if book.stored_filename

data/lib/robust_excel_ole/cell.rb

@@ -12,8 +12,21 @@ module RobustExcelOle
       end
     end
 
-    def method_missing(id, *args)   # :nodoc: #
-      @cell.send(id, *args)
+    def method_missing(name, *args)    # :nodoc: #
+      if name.to_s[0,1] =~ /[A-Z]/ 
+        begin
+          @cell.send(name, *args)
+        rescue WIN32OLERuntimeError => msg
+          if msg.message =~ /unknown property or method/
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          else 
+            raise msg
+          end
+        end
+      else  
+        super 
+      end
     end
+
   end
 end

data/lib/robust_excel_ole/excel.rb

@@ -10,6 +10,8 @@ end
 
 module RobustExcelOle      
 
+  # see https://docs.microsoft.com/en-us/office/vba/api/excel.application(object)#methods
+
   class Excel < RangeOwners   
 
     attr_accessor :ole_excel
@@ -124,7 +126,7 @@ module RobustExcelOle
         self.displayalerts = opts[:displayalerts]        
         self.calculation = opts[:calculation]
         if opts[:reopen_workbooks]
-          books = book_class.books
+          books = workbook_class.books
           books.each do |book|
             book.reopen if ((not book.alive?) && book.excel.alive? && book.excel == self)
           end        
@@ -224,7 +226,7 @@ module RobustExcelOle
      end
 
     # closes all Excel instances
-    # @return [Fixnum,Fixnum] number of closed Excel instances, number of errors
+    # @return [Integer,Integer] number of closed Excel instances, number of errors
     # remark: the returned number of closed Excel instances is valid only for known Excel instances
     # if there are unknown Excel instances (opened not via this class), then they are counted as 1
     # @param [Hash] options the options
@@ -359,7 +361,7 @@ module RobustExcelOle
     end    
 
     # kill all Excel instances
-    # @return [Fixnum] number of killed Excel processes
+    # @return [Integer] number of killed Excel processes
     def self.kill_all
       number = 0
       WIN32OLE.connect("winmgmts:\\\\.").InstancesOf("win32_process").each do |p|
@@ -528,7 +530,7 @@ module RobustExcelOle
     def calculation= calculation_mode
       return if calculation_mode.nil?
       @calculation = calculation_mode
-      calc_mode_changable = @ole_excel.Workbooks.Count > 0 &&  @ole_excel.Calculation.is_a?(Fixnum)
+      calc_mode_changable = @ole_excel.Workbooks.Count > 0 &&  @ole_excel.Calculation.is_a?(Integer)
       if calc_mode_changable
         if calculation_mode == :manual then
           saved = []
@@ -562,7 +564,7 @@ module RobustExcelOle
         self.calculation = calculation_mode
         yield self
       ensure
-        @ole_excel.Calculation = old_calculation_mode if @ole_excel.Calculation.is_a?(Fixnum)
+        @ole_excel.Calculation = old_calculation_mode if @ole_excel.Calculation.is_a?(Integer)
       end
     end
 
@@ -587,7 +589,7 @@ module RobustExcelOle
         end 
       end
       ole_workbooks.each do |ole_workbook|
-        book_class.open(ole_workbook).for_this_workbook(options)
+        workbook_class.open(ole_workbook).for_this_workbook(options)
       end
     end
 
@@ -622,17 +624,17 @@ module RobustExcelOle
       self.to_s
     end
 
-    def self.book_class   # :nodoc: #
-      @book_class ||= begin
+    def self.workbook_class   # :nodoc: #
+      @workbook_class ||= begin
         module_name = self.parent_name
-        "#{module_name}::Book".constantize
+        "#{module_name}::Workbook".constantize
       rescue NameError => e
-        book
+        Workbook
       end
     end
 
-    def book_class        # :nodoc: #
-      self.class.book_class
+    def workbook_class        # :nodoc: #
+      self.class.workbook_class
     end
 
     include MethodHelpers

data/lib/robust_excel_ole/general.rb

@@ -29,6 +29,18 @@ module General
 end
 
 class WIN32OLE
+
+  # promoting WIN32OLE objects to RobustExcelOle objects
+  def to_reo
+    case self.ole_type.name
+    when "Range" then RobustExcelOle::Range.new(self)
+    when "_Worksheet" then Worksheet.new(self)
+    when "_Workbook" then Workbook.new(self)
+    when "_Application" then Excel.new(self)
+    else
+      self
+    end
+  end
 end
 
 class ::String    # :nodoc: #

data/lib/robust_excel_ole/range.rb

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 module RobustExcelOle
   
+  # see https://docs.microsoft.com/en-us/office/vba/api/excel.worksheet#methods
+
   class Range < REOCommon
     include Enumerable
     attr_reader :ole_range
@@ -8,7 +10,7 @@ module RobustExcelOle
 
     def initialize(win32_range)
       @ole_range = win32_range
-      @worksheet = sheet_class.new(self.Parent)
+      @worksheet = worksheet_class.new(self.Parent)
     end
 
     def each
@@ -21,7 +23,7 @@ module RobustExcelOle
     # @params [Range] a range
     # @returns [Array] the values
     def values(range = nil)
-      result = self.map{|x| x.value}.flatten
+      result = self.map{|x| x.Value}.flatten
       if range 
         relevant_result = []
         result.each_with_index{ |row_or_column, i| relevant_result << row_or_column if range.include?(i) }
@@ -37,44 +39,59 @@ module RobustExcelOle
     end
 
     # copies a range
-    # @params [Fixnum,Range] row or range of the rows 
-    # @params [Fixnum,Range] column or range of columns 
-    # @options [Sheet] the worksheet in which to copy      
-    def copy(int_range1, int_range2, sheet = :__not_provided)
-      int_range1 = int_range1 .. int_range1 if int_range1.is_a?(Fixnum)
-      int_range2 = int_range2 .. int_range2 if int_range2.is_a?(Fixnum)
+    # @params [Address] address of a range
+    # @options [Worksheet] the worksheet in which to copy      
+    def copy(address, sheet = :__not_provided, third_argument_deprecated = :__not_provided)
+      if third_argument_deprecated != :__not_provided
+        address = [address,sheet]
+        sheet = third_argument_deprecated
+      end
+      address = Address.new(address)
       sheet = @worksheet if sheet == :__not_provided
+      destination_range = sheet.range([address.rows.min..address.rows.max,
+                                       address.columns.min..address.columns.max]).ole_range
       if sheet.workbook.excel == @worksheet.workbook.excel 
         begin
-          self.Copy(:destination => sheet.range(int_range1.min..int_range1.max,
-                                                int_range2.min..int_range2.max).ole_range)
+          self.Copy(:destination => destination_range)
         rescue WIN32OLERuntimeError
           raise RangeNotCopied, "cannot copy range"
         end
       else
         self.Select
         self.Copy
-        sheet.Paste(sheet.range(int_range1.min..int_range1.max,int_range2.min..int_range2.max).ole_range)
+        sheet.Paste(destination_range)
       end
     end
 
-    def self.sheet_class    # :nodoc: #
-      @sheet_class ||= begin
+    def self.worksheet_class    # :nodoc: #
+      @worksheet_class ||= begin
         module_name = self.parent_name
-        "#{module_name}::Sheet".constantize
+        "#{module_name}::Worksheet".constantize
       rescue NameError => e
-        Sheet
+        Worksheet
       end
     end
 
-    def sheet_class        # :nodoc: #
-      self.class.sheet_class
+    def worksheet_class        # :nodoc: #
+      self.class.worksheet_class
     end
 
   private
-
-    def method_missing(id, *args)  # :nodoc: #
-      @ole_range.send(id, *args)
+    def method_missing(name, *args)    # :nodoc: #
+      if name.to_s[0,1] =~ /[A-Z]/ 
+        begin
+          @ole_range.send(name, *args)
+        rescue WIN32OLERuntimeError => msg
+          if msg.message =~ /unknown property or method/
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          else 
+            raise msg
+          end
+        end
+      else  
+        super 
+      end
     end
+
   end
 end