robust_excel_ole 1.11 → 1.12

data/examples/modifying_sheets/example_concating.rb

@@ -2,8 +2,8 @@
 # each named cell gets the value of cell right to it appended to its own value
 # the new workbook's name is extended by the suffix "_concat"
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle

data/examples/modifying_sheets/example_copying.rb

@@ -1,10 +1,10 @@
 # example_copying.rb:
-# each named cell is to be copied into another sheet
+# each named cell is to be copied into another worksheet
 # unnamed cells shall not be copied
 # if a sheet does not contain any named cell, then the sheet shall not be copied
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle

data/examples/modifying_sheets/example_expanding.rb

@@ -5,8 +5,8 @@
 # the sheet's name shall be the name of the Excel name
 # in addition to that, the cell B2 shall be named "name" and get the sheet name as its value 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle

data/examples/modifying_sheets/example_naming.rb

@@ -3,8 +3,8 @@
 # the contents of each cell is copied
 # the new workbook's name is extended by the suffix "_named"
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle

data/examples/modifying_sheets/example_ranges.rb

@@ -1,8 +1,8 @@
 # example_ranges.rb: 
 # access row and column ranges of a sheet. 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -13,8 +13,8 @@ begin
   simple_file = dir + 'workbook.xls'
   simple_save_file = dir + 'workbook_save.xls'
   File.delete simple_save_file rescue nil
-  book = Workbook.open(simple_file)      # open a book
-  sheet = book.sheet('Sheet1')             # access a sheet via the name
+  book = Workbook.open(simple_file, :visible => true)      # open a workbook
+  sheet = book.sheet('Sheet1')             # access a worksheet 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
   cell = col_r[0]                    # access the first cell of these cells 

data/examples/modifying_sheets/example_saving.rb

@@ -1,8 +1,8 @@
 # example_saving.rb: 
 # save the sheets of a book as separate workbooks
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -27,7 +27,7 @@ begin
         sheet.Delete unless sheet.name == sheet_orig.name 
       end
       book.close(:if_unsaved => :save)
-      # alternative: delete all other sheets
+      # alternative: delete all other worksheets
       #book = Workbook.open(file_sheet_name, :force => {:excel => :new}, :visible => true)
       #book.each do |sheet|
       #  book.sheet(sheet.Name).Delete() unless sheet.Name == sheet_orig.Name

data/examples/open_save_close/example_control_to_excel.rb

@@ -1,8 +1,8 @@
 # example_give_control_to_excel.rb: 
 # open, close, save  with giving control to Excel 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,32 +11,31 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
-  book = Workbook.open(file_name)          # open a book
-  book.excel.visible = true                   # make current Excel visible 
+  book = Workbook.open(file_name, :visible => true)          # open a book
   sleep 1
-  sheet = book.sheet(1)                                                        # access a sheet
+  sheet = book.sheet(1)                                                        # access a worksheet
   sheet[1,1] = sheet[1,1].Value == "simple" ? "complex" : "simple"       # change a cell
   sleep 1
   begin
-    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,
+    new_book = Workbook.open(file_name, :visible => true, :if_unsaved => :alert) # open another workbook with the same file name 
+  rescue WorkbookREOError => msg                          # if the user chooses not open the workbook,
   	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 => :alert)                      # close the unsaved book. 
-  rescue WorkbookREOError => msg                          # user is asked whether the unsaved book shall be saved
+  	book.close(:if_unsaved => :alert)                      # close the unsaved workbook. 
+  rescue WorkbookREOError => msg                          # user is asked whether the unsaved workbook 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 => :alert)    # save the new book, if it was opened
+  	  new_book.save_as(file_name, :if_exists => :alert)    # save the new workbook, if it was opened
   	rescue WorkbookREOError => 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 
 
-  	new_book.close                                         # close the new book, if the user chose to open it
+  	new_book.close                                         # close the new workbook, if the user chose to open it
   end
 ensure                                                              
   Excel.kill_all                                       # close ALL workbooks, quit Excel application

data/examples/open_save_close/example_default_excel.rb

@@ -1,8 +1,8 @@
 # example_default_excel.rb: 
 # reopening books using :default_excel
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -14,30 +14,29 @@ begin
   file_name2 = dir + 'different_workbook.xls'
   file_name3 = dir + 'book_with_blank.xls'
   file_name4 = dir + 'merge_cells.xls'
-  book1 = Workbook.open(file_name1)            # open a book in a new Excel instance since no Excel is open
-  book1.excel.visible = true               # make current Excel visible
+  book1 = Workbook.open(file_name1, :visible => true)   # open a workbook in a new Excel instance since no Excel is open
   sleep 2
-  book1.close                               # close the book
+  book1.close                               # close the workbook
   sleep 2
-  book2 = Workbook.open(file_name1)            # reopen the book                            
+  book2 = Workbook.open(file_name1, :visible => true)            # reopen the workbook                            
   p "book1 == book2" if book2 == book1      # the books are identical
   sleep 2   
   new_excel = Excel.new(:reuse => false)    # create a new Excel    
   book3 = Workbook.open(file_name2, :default => {:excel => :current}, :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 => :current} the book is opened
+  if book3.excel == book2.excel then     # since this workbook cannot be reopened, the option :default => {:excel} applies:
+    p "book3 opened in the first Excel"  # according to :default => {:excel => :current} the workbook is opened
   end                                    # in the Excel instance the was created first
   sleep 2                                          
   new_excel = Excel.new(:reuse => false)         
-  book4 = Workbook.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
+  book4 = Workbook.open(file_name3, :default => {:excel => new_excel}, :visible => true)  # open another workbook
+  if book4.excel == new_excel then       # since this workbook cannot be reopened, the option :default_excel applies: 
+    p "book4 opened in the second Excel" # according to :default_excel => new_excel the workbook is opened
   end                                    # in the given Excel, namely the second Excel instance new_excel 
   sleep 2   
-  book5 = Workbook.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, 
+  book5 = Workbook.open(file_name4, :default => {:excel => :new}, :visible => true)  # open another workbook
+  if ((not book5.excel == book1.excel) && (not book5.excel == new_excel)) then  # since this workbook 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
+  end                                 # the workbook is opened in a new Excel
   sleep 2  
   book5.close
   book4.close

data/examples/open_save_close/example_force_excel.rb

@@ -1,8 +1,8 @@
 # example_force_excel.rb: 
 # opening books in new or given Excel instances using :force_excel
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,20 +11,19 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   simple_file = dir + 'workbook.xls'
-  book1 = Workbook.open(simple_file)            # open a book in a new Excel instance since no Excel is open
-  book1.excel.visible = true                # make current Excel visible
+  book1 = Workbook.open(simple_file, :visible => true)  # open a workbook in a new Excel instance since no Excel is open
   sleep 2
-  book2 = Workbook.open(simple_file)             # open a new book in the same Excel instance                            
-  p "book1 == book2" if book2 == book1      # the books are identical
+  book2 = Workbook.open(simple_file)             # open a new workbook in the same Excel instance                            
+  p "book1 == book2" if book2 == book1      # the workbooks are identical
   sleep 2       
-  book3 = Workbook.open(simple_file, :force => {:excel => :new, :visible => true}) # open another book in a new Excel instance,   
-  p "book3 != book1" if (not (book3 == book1))   # the books are not identical 
+  book3 = Workbook.open(simple_file, :force => {:excel => :new, :visible => true}) # open another workbook in a new Excel instance,   
+  p "book3 != book1" if (not (book3 == book1))   # the workbooks are not identical 
   sleep 2   
   new_excel = Excel.new(:reuse => false)        # create a third Excel instance
-  book4 = Workbook.open(simple_file, :force => {:excel => new_excel, :visible => true})  # open another book in the new Excel instance
+  book4 = Workbook.open(simple_file, :force => {:excel => new_excel, :visible => true})  # open another workbook 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
+  book4.close                                 # close the workbooks
   book3.close                                             
   book2.close
   book1.close                                         

data/examples/open_save_close/example_if_obstructed_closeifsaved.rb

@@ -1,8 +1,8 @@
 # example_if_obstructed_close_if_saved.rb:
 # open with :if_obstructed: :close_if_saved
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -12,10 +12,10 @@ begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
   other_file_name = dir + 'more_data/workbook.xls'
-  book = Workbook.open(file_name, :visible => true)  # open a book, make Excel visible
+  book = Workbook.open(file_name, :visible => true)  # open a workbook, 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 worksheet
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple"      # change a cell
   sleep 1
   begin
@@ -23,13 +23,13 @@ begin
   rescue WorkbookBlocked => msg                                             
     puts "error: open: #{msg.message}"
   end                                                        
-  book.save                                                           # save the unsaved book
-  new_book = Workbook.open(file_name, :if_obstructed => :close_if_saved)  # open the new book, close the saved book    
+  book.save                                                           # save the unsaved workbook
+  new_book = Workbook.open(file_name, :if_obstructed => :close_if_saved)  # open the new workbook, close the saved workbook    
   sleep 1
   new_sheet = new_book.sheet(1)
   new_first_cell = new_sheet[1,1].Value
   puts "the old book was saved" unless new_first_cell == first_cell 
-  new_book.close                                 # close the books                  
+  new_book.close                                 # close the workbook                  
 ensure
   Excel.kill_all                         # close all workbooks, quit Excel application
   #rm_tmp(dir)

data/examples/open_save_close/example_if_obstructed_forget.rb

@@ -1,8 +1,8 @@
 # example_if_obstructed_forget.rb: 
 # open with :if_obstructed: :forget, :new_excel
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -12,10 +12,10 @@ begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
   other_file_name = dir + 'more_data/workbook.xls'
-  book = Workbook.open(file_name, :visible => true)  # open a book, make Excel application visible
+  book = Workbook.open(file_name, :visible => true)  # open a workbook, make Excel application visible
   sleep 3 
   begin
-    new_book = Workbook.open(other_file_name)        # open a book with the same file name in a different path
+    new_book = Workbook.open(other_file_name)        # open a workbook with the same file name in a different path
   rescue WorkbookBlocked => msg                   # by default: raises an exception 
   	puts "error: open: #{msg.message}"
   end
@@ -25,7 +25,7 @@ begin
   # open another book with the same file name in a different path. Use a new Excel application
   another_book = Workbook.open(file_name, :if_obstructed => :new_excel, :visible => true)                                         
   sleep 3
-  new_book.close                                 # close the books                      
+  new_book.close                                 # close the workbooks                      
   another_book.close
 ensure
   Excel.kill_all                         # close all workbooks, quit Excel application

data/examples/open_save_close/example_if_obstructed_save.rb

@@ -1,8 +1,8 @@
 # example_if_obstructed_save.rb:
 # open with :if_obstructed: :save
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -12,20 +12,20 @@ begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
   other_file_name = dir + 'more_data/workbook.xls'
-  book = Workbook.open(file_name, :visible => true)  # open a book, make Excel visible
+  book = Workbook.open(file_name, :visible => true)  # open a workbook, 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 worksheet
   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
-  sleep 1                                                         #save the old book, close it, before
+  new_book = Workbook.open(other_file_name, :if_obstructed => :save)  # open a workbook with the same file name in a different path
+  sleep 1                                                         #save the old workbook, close it, before
   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
   puts "the old book was saved" unless old_first_cell == first_cell 
-  new_book.close                                 # close the books                      
+  new_book.close                                 # close the workbooks                      
   old_book.close
 ensure
   Excel.kill_all                         # close all workbooks, quit Excel application

data/examples/open_save_close/example_if_unsaved_accept.rb

@@ -1,8 +1,8 @@
 # example_ifunsaved_accept.rb: 
 # open with :if_unsaved => :accept, close with :if_unsaved => :save 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,30 +11,30 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
-  book = Workbook.open(file_name)                      # open a book 
-  sheet = book.sheet(1)                                                  # access a sheet
+  book = Workbook.open(file_name, :visible => true)                      # open a workbook 
+  sheet = book.sheet(1)                                                  # access a worksheet
   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:
-    puts "error: open: #{msg.message}"              # a book with the same name is already open and unsaved 
+    new_book = Workbook.open(file_name)             # open another workbook with the same file name
+  rescue WorkbookNotSaved => msg                    # by default: raises an exception:
+    puts "error: open: #{msg.message}"              # a workbook with the same name is already open and unsaved 
   end
-  new_book = Workbook.open(file_name, :if_unsaved => :accept) # open another book with the same file name 
-                                                          # and let the unsaved book open
+  new_book = Workbook.open(file_name, :if_unsaved => :accept) # open another workbook with the same file name 
+                                                          # and let the unsaved workbook open
   if book.alive? && new_book.alive? then                  # check whether the referenced workbooks
   	puts "open with :if_unsaved => :accept : the two books are alive." # respond to methods
   end
-  if book == new_book then                                # check whether the book are equal
+  if book == new_book then                                # check whether the workbook are equal
   	puts "both books are equal"
   end
   begin                                                                   
-  	book.close                                          # close the book. by default: raises an exception:
-  rescue WorkbookNotSaved => msg                         #   book is unsaved
+  	book.close                                          # close the workbook. by default: raises an exception:
+  rescue WorkbookNotSaved => msg                         #   workbook is unsaved
   	puts "close error: #{msg.message}"
   end
   book.close(:if_unsaved => :save)                      # save the book before closing it 
   puts "closed the book successfully with option :if_unsaved => :save"
-  new_book.close                                        # close the other book. It is already saved.
+  new_book.close                                        # close the other workbook. It is already saved.
 ensure
 	  Excel.kill_all                                    # close workbooks, quit Excel application
     rm_tmp(dir)

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -1,8 +1,8 @@
 # example_if_unsaved_forget.rb:
 # open with :if_unsaved => :forget, :new_excel, close with :if_unsaved => :save 
 
-require File.expand_path('../../lib/robust_excel_ole', File.dirname(__FILE__))
-require File.join(File.dirname(File.expand_path(__FILE__)), '../../spec/helpers/create_temporary_dir')
+require_relative '../../lib/robust_excel_ole'
+require_relative '../../spec/helpers/create_temporary_dir'
 require "fileutils"
 
 include RobustExcelOle
@@ -11,28 +11,27 @@ Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
-  book = Workbook.open(file_name)                      # open a book
+  book = Workbook.open(file_name, :visible => true)   # open a workbook
   puts "file_name: #{file_name}"
-  #book.excel.visible = true                        # make current Excel visible 
   sleep 1
-  sheet = book.sheet(1)                                            # access a sheet
+  sheet = book.sheet(1)                                      # access a worksheet
   first_cell = sheet[1,1].Value
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell
   sleep 1
   puts "new_book: before"
   puts "file_name: #{file_name}"
-  new_book = Workbook.open(file_name, :if_unsaved => :forget) # open another book with the same file name 
-                                                          # and close the unsaved book without saving it
+  new_book = Workbook.open(file_name, :if_unsaved => :forget) # open another workbook with the same file name 
+                                                          # and close the unsaved workbook 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 workbook 
     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
-  # open another book in a new Excel application, and make Excel visible, leaving the unsaved book open
+  # open another workbook in a new Excel application, and make Excel visible, leaving the unsaved workbook open
   another_book = Workbook.open(file_name, :if_unsaved => :new_excel, :visible => true)  
-  sleep 3                                                                  # leaving the unsaved book open  
+  sleep 3                                                                  # leaving the unsaved workbook open  
   new_book.close(:if_unsaved => :forget )                                
   another_book.close
 ensure