robust_excel_ole 0.2.3 → 0.3.0

data/TodoList.md

@@ -0,0 +1,33 @@
+
+### immediately
+
+--- 2015-04-09 unobtrusively: save book only if it saved: Test
+--- 2015-04-09 unobtrusively: return the block result: implementation and test
+--- 2015-04-09 unobtrusively: namval: return the contents of cells or region with a given name
+--- 2015-04-09 unobtrusively: visible, displayalerts
+--- 2015-04-17 unobtrusively: readonly
+
+
+### quick
+
+--- 2015-04-02 if_unlocked
+--- 2015-04-02 standard use cases
+--- 2015-04-02 set options: make it dry
+
+### rather quick
+
+### medium
+
+### slow
+
+### done
+
+--- 2015-04-01 examples for unobtrusively
+--- 2015-04-01 further tests for unobtrusively
+--- 2015-03-26 connnect: check test outputs
+--- 2015-01-26 simpler implementation of connect
+--- 2015-01-26 reopen with permenent storage
+--- 2015-01-26 tests for unobtrusively 
+--- 2015-01-26 unobtrusively 
+--- 2015-01-26 option keep_open
+--- 2015-01-26 separate class for book management 

data/examples/edit_sheets/example_adding_sheets.rb

@@ -53,6 +53,13 @@ begin
   @book.add_sheet(@book[3], :as => 'sheet_copy', :after => @book[6])
   show_sheets
 
+  puts"adding a copy of the 2nd sheet and name it again 'second_sheet_copy'"
+  begin
+    @book.add_sheet(sheet, :as => 'second_sheet_copy')
+  rescue ExcelErrorSheet => msg
+    puts "error: add_sheet: #{msg.message}"
+  end    
+
   @book.close(:if_unsaved => :forget)   # close the book without saving it
   
 ensure

data/examples/open_save_close/example_control_to_excel.rb

@@ -12,26 +12,26 @@ begin
   dir = create_tmpdir
   file_name = dir + 'simple.xls' 
   book = Book.open(file_name)          # open a book
-  Excel.current.Visible = true                              # make Excel visible 
+  book.visible = true                   # make current Excel visible 
   sleep 1
   sheet = book[0]                                                        # access a sheet
   sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"       # change a cell
   sleep 1
   begin
-    new_book = Book.open(file_name, :if_unsaved => :excel) # open another book with the same file name 
+    new_book = Book.open(file_name, :if_unsaved => :alert) # open another book with the same file name 
   rescue ExcelUserCanceled => msg                          # if the user chooses not open the book,
   	puts "#{msg.message}"                                  #   an exeptions is raised
   end
   puts "new book has opened" if new_book
   Excel.current.Visible = true
   begin
-  	book.close(:if_unsaved => :excel)                      # close the unsaved book. 
+  	book.close(:if_unsaved => :alert)                      # close the unsaved book. 
   rescue ExcelUserCanceled => msg                          # user is asked whether the unsaved book shall be saved
   	puts "#{msg.message}"                                  # if the user chooses to cancel, then an expeption is raised
   end
   if new_book then
   	begin
-  	  new_book.save_as(file_name, :if_exists => :excel)    # save the new book, if it was opened
+  	  new_book.save_as(file_name, :if_exists => :alert)    # save the new book, if it was opened
   	rescue ExcelErrorSave => msg                           # user is asked, whether the existing file shall be overwritten
   	  puts "save_as: #{msg.message}"                       # if the user chooses "no" or "cancel", an exception is raised
   	end 

data/examples/open_save_close/example_default_excel.rb

@@ -0,0 +1,49 @@
+# example_default_excel.rb: 
+# reopening books using :default_excel
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  file_name1 = dir + 'simple.xls'
+  file_name2 = dir + 'different_simple.xls'
+  file_name3 = dir + 'book_with_blank.xls'
+  file_name4 = dir + 'merge_cells.xls'
+  book1 = Book.open(file_name1)            # open a book in a new Excel instance since no Excel is open
+  book1.visible = true                      # make current Excel visible
+  sleep 2
+  book1.close                               # close the book
+  sleep 2
+  book2 = Book.open(file_name1)            # reopen the book                            
+  p "book1 == book2" if book2 == book1      # the books are identical
+  sleep 2   
+  new_excel = Excel.new(:reuse => false)    # create a new Excel    
+  book3 = Book.open(file_name2, :default_excel => :reuse, :visible => true) # open another book
+  if book3.excel == book2.excel then     # since this book cannot be reopened, the option :default_excel applies:
+    p "book3 opened in the first Excel"  # according to :default_excel => :reuse the book is opened
+  end                                    # in the Excel instance the was created first
+  sleep 2                                          
+  new_excel = Excel.new(:reuse => false)         
+  book4 = Book.open(file_name3, :default_excel => new_excel, :visible => true)  # open another book
+  if book4.excel == new_excel then       # since this book cannot be reopened, the option :default_excel applies: 
+    p "book4 opened in the second Excel" # according to :default_excel => new_excel the book is opened
+  end                                    # in the given Excel, namely the second Excel instance new_excel 
+  sleep 2   
+  book5 = Book.open(file_name4, :default_excel => :new, :visible => true)  # open another book
+  if ((not book5.excel == book1.excel) && (not book5.excel == new_excel)) then  # since this book cannot be reopened, 
+    p "book5 opened in a third Excel" # the option :default_excel applies. according to :default_excel => :new 
+  end                                 # the book is opened in a new Excel
+  sleep 2  
+  book5.close
+  book4.close
+  book3.close
+  book2.close
+ensure
+  Excel.close_all                            # close all workbooks, quit Excel instances
+  rm_tmp(dir)
+end

data/examples/open_save_close/example_force_excel.rb

@@ -0,0 +1,34 @@
+# example_force_excel.rb: 
+# opening books in new or given Excel instances using :force_excel
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  book1 = Book.open(simple_file)            # open a book in a new Excel instance since no Excel is open
+  book1.visible = true                      # make current Excel visible
+  sleep 2
+  book2 = Book.open(simple_file)             # open a new book in the same Excel instance                            
+  p "book1 == book2" if book2 == book1      # the books are identical
+  sleep 2       
+  book3 = Book.open(simple_file, :force_excel => :new, :visible => true) # open another book in a new Excel instance,                                                       # make Excel visible
+  p "book3 != book1" if (not (book3 == book1))   # the books are not identical 
+  sleep 2   
+  new_excel = Excel.new(:reuse => false)        # create a third Excel instance
+  book4 = Book.open(simple_file, :force_excel => new_excel, :visible => true)  # open another book in the new Excel instance
+  p "book4 != book3 && book4 != book1" if (not (book4 == book3) && (not (book4 == book1)))
+  sleep 2                                     # (Excel chooses the first Excel application)        
+  book4.close                                 # close the books
+  book3.close                                             
+  book2.close
+  book1.close                                         
+ensure
+  Excel.close_all                            # close all workbooks, quit Excel instances
+  rm_tmp(dir)
+end

data/examples/open_save_close/example_if_obstructed_closeifsaved.rb

@@ -21,7 +21,7 @@ begin
   begin
     new_book = Book.open(other_file_name, :if_obstructed => :close_if_saved) # raises an exception since the file is not saved
     rescue ExcelErrorOpen => msg                                             
-    puts "open: #{msg.message}"
+    puts "error: open: #{msg.message}"
   end                                                        
   book.save                                                           # save the unsaved book
   new_book = Book.open(file_name, :if_obstructed => :close_if_saved)  # open the new book, close the saved book    

data/examples/open_save_close/example_if_obstructed_forget.rb

@@ -1,5 +1,5 @@
 # example_if_obstructed_forget.rb: 
-# open with :if_obstructed: :forget, :new_app
+# open with :if_obstructed: :forget, :new_excel
 
 require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
@@ -17,13 +17,13 @@ begin
   begin
     new_book = Book.open(other_file_name)        # open a book with the same file name in a different path
   rescue ExcelErrorOpen => msg                   # by default: raises an exception 
-  	puts "open: #{msg.message}"
+  	puts "error: open: #{msg.message}"
   end
   # open a new book with the same file name in a different path. close the old book before.
   new_book = Book.open(other_file_name, :if_obstructed => :forget) 
   sleep 3
   # open another book with the same file name in a different path. Use a new Excel application
-  another_book = Book.open(file_name, :if_obstructed => :new_app, :visible => true)                                         
+  another_book = Book.open(file_name, :if_obstructed => :new_excel, :visible => true)                                         
   sleep 3
   new_book.close                                 # close the books                      
   another_book.close

data/examples/open_save_close/example_if_unsaved_accept.rb

@@ -17,7 +17,7 @@ begin
   begin
     new_book = Book.open(file_name)                # open another book with the same file name
   rescue ExcelErrorOpen => msg                     # by default: raises an exception:
-    puts "open error: #{msg.message}"              # a book with the same name is already open and unsaved 
+    puts "error: open: #{msg.message}"              # a book with the same name is already open and unsaved 
   end
   new_book = Book.open(file_name, :if_unsaved => :accept) # open another book with the same file name 
                                                           # and let the unsaved book open

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -1,5 +1,5 @@
 # example_ifunsaved_forget.rb:
-# open with :if_unsaved => :forget, :new_app, close with :if_unsaved => :save 
+# open with :if_unsaved => :forget, :new_excel, close with :if_unsaved => :save 
 
 require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
@@ -12,7 +12,7 @@ begin
   dir = create_tmpdir
   file_name = dir + 'simple.xls' 
   book = Book.open(file_name)                      # open a book
-  Excel.current.Visible = true        # make Excel visible 
+  book.visible = true                              # make current Excel visible 
   sleep 1
   sheet = book[0]                                            # access a sheet
   first_cell = sheet[0,0].value
@@ -27,7 +27,7 @@ begin
   sleep 1
   sheet_new_book[0,0] = sheet_new_book[0,0].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 = Book.open(file_name, :if_unsaved => :new_app, :visible => true)  
+  another_book = Book.open(file_name, :if_unsaved => :new_excel, :visible => true)  
   sleep 3                                                                  # leaving the unsaved book open  
   new_book.close(:if_unsaved => :forget )                                
   another_book.close

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -1,5 +1,5 @@
 # example_ifunsaved_forget_more.rb:
-# open with :if_unsaved => :forget, :new_app, close with :if_unsaved => :save 
+# open with :if_unsaved => :forget, :new_excel, close with :if_unsaved => :save 
 
 require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
@@ -12,13 +12,13 @@ begin
   dir = create_tmpdir
   file_name = dir + 'simple.xls' 
   book = Book.open(file_name)                      # open a book
-  Excel.current.Visible = true        # make Excel visible 
+  book.visible = true                              # make current Excel visible 
   sleep 1
   sheet = book[0]                                            # access a sheet
   first_cell = sheet[0,0].value
   sheet[0,0] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
-  new_book = Book.open(file_name, :if_unsaved => :new_app, :visible => true) # open another book with the same file name in a new Excel
+  new_book = Book.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[0]
   if (not book.alive?) && new_book.alive? && sheet_new_book[0,0].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

data/examples/open_save_close/example_read_only.rb

@@ -19,7 +19,7 @@ begin
   begin
     book.save                                         # simple save. 
   rescue ExcelErrorSave => msg                        # raises an exception because book is opened in read_only mode
-    puts "save_as error: #{msg.message}"
+    puts "error: save_as: #{msg.message}"
   end
   book.close                                          # close the book without saving it 
 ensure

data/examples/open_save_close/example_rename_cells.rb

@@ -0,0 +1,69 @@
+# example_simple.rb: 
+# open a book, simple save, save_as, close
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  file_name = dir + 'simple.xls'
+  book = Book.open(file_name)                                # open a book.  default:  :read_only => false
+  book.visible = true                                          # make current Excel visible
+  sheet = book[0]
+  #sheet.Names.Add("Wert","$A$1"
+
+  workbook = book.workbook
+  fullname = workbook.Fullname
+  puts "fullname: #{fullname}"  
+  workbook.Names.Add("a_name", "=$A$1")   # rename cell A1 to "a_name"
+  number = workbook.Names.Count
+  puts "number of name objects :#{number}"
+  name_object = workbook.Names("a_name")
+  name = name_object.Name 
+  puts "name: #{name}"
+  value = name_object.Value                   # definition of the cell
+  puts "definition: #{value}"
+  reference = name_object.RefersTo
+  puts "reference: #{reference}"
+  visible = name_object.Visible
+  puts "visible: #{visible}"
+  sleep 2
+  workbook.Names("a_name").Name = "new_name"
+  new_name_object = workbook.Names("new_name")
+  puts "name: #{new_name_object.Name}"
+  puts "definition: #{new_name_object.Value}"
+  puts "reference: #{new_name_object.RefersTo}"
+  puts "visible: #{new_name_object.Visible}"
+  sleep 2
+  new_name_object.RefersTo = "=$A$2"
+  puts "name: #{new_name_object.Name}"
+  puts "definition: #{new_name_object.Value}"
+  puts "reference: #{new_name_object.RefersTo}"
+  puts "visible: #{new_name_object.Visible}"
+  sleep 2
+  new_name_object.Visible = false
+  puts "visible: #{new_name_object.Visible}"
+  sleep 2
+
+  # to do:
+  # read, write contents of the cell (under the old name)
+  # read, write contents in the cell under the new name
+
+  #sheet.Cells
+  # sheet[0,0].value
+  # Worksheets("sheet1").Cells
+
+  new_name_object.Delete
+
+  sleep 2
+  book.close(:if_unsaved => :forget)                        # close the book
+
+ensure
+	  Excel.close_all                                         # close workbooks, quit Excel application
+    rm_tmp(dir)
+end		
+

data/examples/open_save_close/example_reuse.rb

@@ -1,4 +1,4 @@
-# example_reuse.rb: open a book in a running Excel application and in a new one. make visible
+# example_reuse.rb: open a book in a new Excel and a running Excel instance. make visible
 
 require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
 require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
@@ -13,15 +13,15 @@ begin
   file_name2 = dir + 'different_simple.xls'
   file_name3 = dir + 'different_simple.xls'
   file_name4 = dir + 'book_with_blank.xls'
-  book1 = Book.open(file_name1)             # open a book in a new Excel application since no Excel is open
-  Excel.current.Visible = true              # make Excel visible
+  book1 = Book.open(file_name1)             # open a book in a new Excel instance since no Excel is open
+  book1.visible = true                      # make current Excel visible
   sleep 2
-  book2 = Book.open(file_name2)             # open a new book in the same Excel application
-  sleep 2                                   # (by default:  :reuse => true)
-  book3 = Book.open(file_name3, :reuse => false, :visible => true) # open another book in a new Excel application, 
+  book2 = Book.open(file_name2)             # open a new book in the same Excel instance
+  sleep 2                                   
+  book3 = Book.open(file_name3, :force_excel => :new, :visible => true) # open another book in a new Excel instance, 
   sleep 2                                                          # make Excel visible
-  book4 = Book.open(file_name4, :reuse => true, :visible => true)  # open anther book, and use a running Excel application
-  sleep 2                                                          # (Excel chooses the first Excel application)        
+  book4 = Book.open(file_name4, :visible => true)  # open anther book, and use a running Excel application
+  sleep 2                                          # (Excel chooses the first Excel application)        
   book1.close                               # close the books
   book2.close                                             
   book3.close

data/examples/open_save_close/example_simple.rb

@@ -12,8 +12,8 @@ begin
   dir = create_tmpdir
   file_name = dir + 'simple.xls'
   other_file_name = dir + 'different_simple.xls'
-  book = Book.open(file_name)                # open a book.  default:  :read_only => false
-  Excel.current.Visible = true                  # make Excel visible
+  book = Book.open(file_name)                                # open a book.  default:  :read_only => false
+  book.visible = true                                        # make current Excel visible
   sheet = book[0]                                            # access a sheet
   sleep 1     
   sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"  # change a cell
@@ -22,7 +22,7 @@ begin
   begin
   	book.save_as(other_file_name)                            # save_as :  default :if_exists => :raise 
   rescue ExcelErrorSave => msg
-  	puts "save_as error: #{msg.message}"
+  	puts "error: save_as: #{msg.message}"
   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"

data/examples/open_save_close/example_unobtrusively.rb

@@ -0,0 +1,28 @@
+# example_unobtrusively.rb:
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  book = Book.open(simple_file, :visible => true)  # open a book, make Excel visible
+  old_sheet = book[0]
+  p "1st cell: #{old_sheet[0,0].value}"
+  sleep 2
+  Book.unobtrusively(simple_file) do |book|   # modify the book and keep its status unchanged
+    sheet = book[0]
+    sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"
+  end
+  new_sheet = book[0]
+  p "1st cell: #{new_sheet[0,0].value}"
+  p "book saved" if book.Saved
+  book.close                                 # close the book                      
+ensure
+  Excel.close_all                            # close all workbooks, quit Excel application
+  rm_tmp(dir)
+end

data/examples/save_sheets/example_save_sheets.rb

@@ -13,18 +13,14 @@ begin
   suffix = '.xls'
   book_name = dir + 'book_with_blank' 
   book = Book.open(book_name + suffix)                   # open a book with several sheets
-  Excel.current.Visible = true                           # make Excel visible 
+  book.visible = true                                      # make Excel visible 
   i = 0
   book.each do |sheet|
     i = i + 1
     puts "#{i}. sheet:"
     sheet_name = book_name + "_sheet#{i}"
     puts "sheet_name: #{sheet_name}"
-    excel = Excel.create                   
-    excel.Workbooks.Add                                          # generate an empty workbook
-    empty_workbook = excel.Workbooks.Item(1)                     # save it
-    empty_workbook.SaveAs(absolute_path(sheet_name), XlExcel8)   # close it
-    empty_workbook.Close
+    Excel.generate_workbook absolute_path(sheet_name)   # generate an empty workbook
     sheet_book = Book.open(absolute_path(sheet_name) + suffix)  # open the book
     sheet_book.add_sheet sheet                                  # add the sheet
     sheet_book.save                                             # save it

data/lib/robust_excel_ole.rb

@@ -1,5 +1,6 @@
 require "win32ole"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/book_store')
 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/cell')
@@ -10,4 +11,21 @@ require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
 
 module RobustExcelOle
 
+  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)
+  end
+
+  def canonize(filename)
+    raise "No string given to canonize, but #{filename.inspect}" unless filename.is_a?(String)
+    filename.downcase rescue nil
+  end
+
+  module_function :absolute_path, :canonize
+
+
+  class VBAMethodMissingError < RuntimeError  # :nodoc: #
+  end
+
 end