robust_excel_ole 0.2.1 → 0.2.2.1

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -2,15 +2,17 @@
 # open with :if_unsaved => :forget, :new_app, 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')
+require "fileutils"
 
 include RobustExcelOle
 
-ExcelApp.close_all
+Excel.close_all
 begin
-  dir = 'C:/'
+  dir = create_tmpdir
   file_name = dir + 'simple.xls' 
   book = Book.open(file_name)                      # open a book
-  ExcelApp.reuse.Visible = true        # make Excel visible 
+  Excel.current.Visible = true        # make Excel visible 
   sleep 1
   sheet = book[0]                                            # access a sheet
   first_cell = sheet[0,0].value
@@ -30,5 +32,6 @@ begin
   new_book.close(:if_unsaved => :forget )                                
   another_book.close
 ensure
-	  ExcelApp.close_all                                    # close all workbooks, quit Excel application
+	  Excel.close_all                                    # close all workbooks, quit Excel application
+    rm_tmp(dir)
 end

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -0,0 +1,38 @@
+# example_ifunsaved_forget_more.rb:
+# open with :if_unsaved => :forget, :new_app, 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')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  file_name = dir + 'simple.xls' 
+  book = Book.open(file_name)                      # open a book
+  Excel.current.Visible = true        # make 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
+  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
+  end
+  sleep 1
+  sheet_new_book[0,0] = sheet_new_book[0,0].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 = Book.open(file_name, :if_unsaved => :forget, :visible => true)  
+  sleep 1
+  sheet_another_book = another_book[0]
+  sheet_another_book[0,0] = sheet_another_book[0,0].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
+	  Excel.close_all                                    # close all workbooks, quit Excel application
+    rm_tmp(dir)
+end

data/examples/open_save_close/example_read_only.rb

@@ -1,17 +1,18 @@
 # example_read_only: open with read_only mode. save, 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
 
-ExcelApp.close_all
+Excel.close_all
 begin
-  dir = 'C:/'
+  dir = create_tmpdir
   file_name = dir + 'simple.xls'
   other_file_name = dir + 'different_simple.xls'
-  # open a book with read_only and make Excel visible
-  book = Book.open(file_name, :read_only => true, :visible => true) 
-  sheet = book[0]                                     			   # access a sheet
+  book = Book.open(file_name, :read_only => true, :visible => true) # open a book with read_only and make Excel visible
+  sheet = book[0]                                     			        # access a sheet
   sleep 1     
   sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple" # change a cell
   sleep 1
@@ -22,6 +23,7 @@ begin
   end
   book.close                                          # close the book without saving it 
 ensure
-  ExcelApp.close_all                                  # close workbooks, quit Excel application
+  Excel.close_all                                     # close workbooks, quit Excel application
+  rm_tmp(dir)
 end
 

data/examples/open_save_close/example_reuse.rb

@@ -1,18 +1,20 @@
 # example_reuse.rb: open a book in a running Excel application and in a new one. make visible
 
 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
 
-ExcelApp.close_all
+Excel.close_all
 begin
-  dir = 'C:/'
+  dir = create_tmpdir
   file_name1 = dir + 'simple.xls'
   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
-  ExcelApp.reuse.Visible = true # make Excel visible
+  Excel.current.Visible = true              # make Excel visible
   sleep 2
   book2 = Book.open(file_name2)             # open a new book in the same Excel application
   sleep 2                                   # (by default:  :reuse => true)
@@ -25,7 +27,8 @@ begin
   book3.close
   book4.close                                         
 ensure
-  ExcelApp.close_all                       # close all workbooks, quit Excel application
+  Excel.close_all                       # close all workbooks, quit Excel application
+  rm_tmp(dir)
 end
 
 

data/examples/open_save_close/example_simple.rb

@@ -1,16 +1,19 @@
-# example_simple.rb: open a book, simple save, save_as, close
+# 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
 
-ExcelApp.close_all
+Excel.close_all
 begin
-  dir = 'C:/'
+  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
-  ExcelApp.reuse.Visible = true                  # make Excel visible
+  Excel.current.Visible = true                  # make Excel visible
   sheet = book[0]                                            # access a sheet
   sleep 1     
   sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"  # change a cell
@@ -25,6 +28,7 @@ begin
   puts "save_as: saved successfully with option :if_exists => :overwrite"
   book.close                                                 # close the book
 ensure
-	  ExcelApp.close_all                                         # close workbooks, quit Excel application
+	  Excel.close_all                                         # close workbooks, quit Excel application
+    rm_tmp(dir)
 end		
 

data/examples/save_sheets/example_save_sheets.rb

@@ -1,30 +1,38 @@
-# example 11: save the sheets of a book as separate books
+# example_save_sheets.rb: 
+# save the sheets of a book as separate books
 
 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
 
-ExcelApp.close_all
+Excel.close_all
 begin
-  dir = 'C:/'
-  file_name = dir + 'book_with_blank.xls'
-  book = Book.open(file_name)                   # open a book
-  ExcelApp.reuse.Visible = true     # make Excel visible 
-  # 1. Bücher erstmal speichern, um sie öffnen zu können
+  dir = create_tmpdir
+  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 
   i = 0
   book.each do |sheet|
     i = i + 1
     puts "#{i}. sheet:"
-    file_name_sheet = file_name + "_sheet#{i}.xls"
-    puts "file_name_sheet: #{file_name_sheet}"
-    book.save_as(file_name_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
+    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
+    sheet_book.close                                            # close it
   end
-  # generate empty book
-  # book_sheet = ExcelApp.Workbooks.Add
   
  ensure                                                              
-  ExcelApp.close_all                              # close workbooks, quit Excel application
+  Excel.close_all                              # close workbooks, quit Excel application
+  rm_tmp(dir)
  end
 

data/lib/robust_excel_ole.rb

@@ -1,5 +1,5 @@
 require "win32ole"
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel_app')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
 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')

data/lib/robust_excel_ole/book.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 require 'weakref'
 
 module RobustExcelOle
@@ -8,7 +9,7 @@ module RobustExcelOle
 
 
     class << self
-
+      
       # opens a book.
       # 
       # options: 
@@ -17,7 +18,7 @@ module RobustExcelOle
       #                 :raise   -> raise an exception (default)
       #                 :forget  -> close the unsaved book, open the new book             
       #                 :accept  -> let the unsaved book open                  
-      #                 :excel   -> give control to excel
+      #                 :alert   -> give control to excel
       #                 :new_app -> open the new book in a new excel application
       #  :if_obstructed   if a book with the same name in a different path is open, then
       #                  :raise          -> raise an exception (default)             
@@ -27,7 +28,7 @@ module RobustExcelOle
       #                                       raise an exception otherwise
       #                  :new_app        -> open the new book in a new excel application
       #  :reuse         use a running Excel-application (default: true)
-      #  :excel_app     an Excel application            (default: nil) 
+      #  :excel         an Excel application            (default: nil) 
       #  :displayalerts allow display alerts in Excel   (default: false)
       #  :visible       make visibe in Excel            (default: false)
       def open(file, options={ :reuse => true}, &block)
@@ -39,22 +40,22 @@ module RobustExcelOle
     def initialize(file, opts={ }, &block)
       @options = {
         :reuse => true,
-        :excel_app => nil,
+        :excel => nil,
         :read_only => false,
         :if_unsaved => :raise,
         :if_obstructed => :raise
       }.merge(opts)
-      excel_app_options = {:reuse => true}.merge(opts).delete_if{|k,v| 
+      excel_options = {:reuse => true}.merge(opts).delete_if{|k,v| 
         k== :read_only || k== :if_unsaved || k == :if_obstructed}
       if not File.exist?(file)
         raise ExcelErrorOpen, "file #{file} not found"
       end
-      @excel_app = @options[:excel_app] ? @options[:excel_app] : ExcelApp.new(excel_app_options)  
-      workbooks = @excel_app.Workbooks
+      @excel = @options[:excel] ? excel_options[:excel] : Excel.new(excel_options)  
+      workbooks = @excel.Workbooks
       @workbook = workbooks.Item(File.basename(file)) rescue nil
       if @workbook then
         obstructed_by_other_book = (File.basename(file) == File.basename(@workbook.Fullname)) && 
-                                   (not (absolute_path(file) == @workbook.Fullname))
+                                   (not (RobustExcelOle::absolute_path(file) == @workbook.Fullname))
         if obstructed_by_other_book then
           # @workbook is not the desired workbook
           case @options[:if_obstructed]
@@ -72,8 +73,8 @@ module RobustExcelOle
               @workbook.Close
             end
           when :new_app
-            excel_app_options[:reuse] = false
-            @excel_app = ExcelApp.new(excel_app_options)
+            excel_options[:reuse] = false
+            @excel = Excel.new(excel_options)
             @workbook = nil
           else
             raise ExcelErrorOpen, ":if_obstructed: invalid option"
@@ -89,12 +90,12 @@ module RobustExcelOle
               @workbook.Close
             when :accept
               #nothing
-            when :excel
-              old_displayalerts = @excel_app.DisplayAlerts  # :nodoc:
-              @excel_app.DisplayAlerts = true  # :nodoc:
+            when :alert
+              old_displayalerts = @excel.DisplayAlerts  # :nodoc:
+              @excel.DisplayAlerts = true  # :nodoc:
             when :new_app
-              excel_app_options[:reuse] = false
-              @excel_app = ExcelApp.new(excel_app_options)
+              excel_options[:reuse] = false
+              @excel = Excel.new(excel_options)
               @workbook = nil
             else
               raise ExcelErrorOpen, ":if_unsaved: invalid option"
@@ -104,17 +105,17 @@ module RobustExcelOle
       end
       begin
         # if book not open (was not open,was closed with option :forget or shall be opened in new application)
-        #    or :if_unsaved => :excel
-        if ((not alive?) || (@options[:if_unsaved] == :excel)) then
+        #    or :if_unsaved => :alert
+        if ((not alive?) || (@options[:if_unsaved] == :alert)) then
           begin
-            @workbook = @excel_app.Workbooks.Open(absolute_path(file),{ 'ReadOnly' => @options[:read_only] })
+            @workbook = @excel.Workbooks.Open(RobustExcelOle::absolute_path(file),{ 'ReadOnly' => @options[:read_only] })
           rescue WIN32OLERuntimeError
             raise ExcelUserCanceled, "open: canceled by user"
           end
         end
       ensure
-        if @options[:if_unsaved] == :excel then
-          @excel_app.DisplayAlerts = old_displayalerts  # :nodoc:
+        if @options[:if_unsaved] == :alert then
+          @excel.DisplayAlerts = old_displayalerts  # :nodoc:
         end
       end
       if block
@@ -134,7 +135,7 @@ module RobustExcelOle
     #                      :raise   -> raise an exception       (default)             
     #                      :save    -> save the book before it is closed                  
     #                      :forget  -> close the book 
-    #                      :excel   -> give control to excel
+    #                      :alert   -> give control to excel
     def close(opts = {:if_unsaved => :raise})
       if ((alive?) && (not @workbook.Saved) && (not @options[:read_only])) then
         case opts[:if_unsaved]
@@ -144,9 +145,9 @@ module RobustExcelOle
           save
         when :forget
           #nothing
-        when :excel
-          old_displayalerts = @excel_app.DisplayAlerts  # :nodoc:
-          @excel_app.DisplayAlerts = true  # :nodoc:
+        when :alert
+          old_displayalerts = @excel.DisplayAlerts  # :nodoc:
+          @excel.DisplayAlerts = true  # :nodoc:
         else
           raise ExcelErrorClose, ":if_unsaved: invalid option"
         end
@@ -154,14 +155,14 @@ module RobustExcelOle
       begin
         @workbook.Close if alive?
         @workbook = nil unless alive?
-        raise ExcelUserCanceled, "close: canceled by user" if alive? && opts[:if_unsaved] == :excel && (not @workbook.Saved)
+        raise ExcelUserCanceled, "close: canceled by user" if alive? && opts[:if_unsaved] == :alert && (not @workbook.Saved)
       ensure
-        if opts[:if_unsaved] == :excel then
-          @excel_app.DisplayAlerts = old_displayalerts  # :nodoc:  
+        if opts[:if_unsaved] == :alert then
+          @excel.DisplayAlerts = old_displayalerts  # :nodoc:  
         end
       end
-      #@excel_app.Workbooks.Close
-      #@excel_app.Quit
+      #@excel.Workbooks.Close
+      #@excel.Quit
     end
 
     # returns true, if the work book is alive, false otherwise
@@ -184,12 +185,12 @@ module RobustExcelOle
     # returns true, if the full book names and excel appications are identical, false, otherwise  
     def == other_book
       other_book.is_a?(Book) &&
-      @excel_app == other_book.excel_app &&
+      @excel == other_book.excel &&
       self.filename == other_book.filename  
     end
 
 
-    attr_reader :excel_app
+    attr_reader :excel
 
     # saves a book.
     # returns true, if successfully saved, nil otherwise
@@ -209,7 +210,7 @@ module RobustExcelOle
     #  :if_exists   if a file with the same name exists, then  
     #               :raise     -> raise an exception, dont't write the file  (default)
     #               :overwrite -> write the file, delete the old file
-    #               :excel     -> give control to Excel
+    #               :alert     -> give control to Excel
     # returns true, if successfully saved, nil otherwise
     def save_as(file = nil, opts = {:if_exists => :raise} )
       raise IOError, "Not opened for writing(open with :read_only option)" if @options[:read_only]
@@ -223,23 +224,14 @@ module RobustExcelOle
       if File.exist?(file) then
         case opts[:if_exists]
         when :overwrite
-          # if a book is open with the name of file, then raise error
-          # bräuchte alle Excel-Applikationen.
-          # mit ExcelApp.reuse bzw. running_app bzw. connect bekomme ich nur die 1. Excel-Applikation
-          #open_workbook = ExcelApp.reuse.Workbooks(basename) rescue nil
           begin
             File.delete(file) 
-          rescue 
+          rescue Errno::EACCES
             raise ExcelErrorSave, "book is open and used in Excel"
           end
-          #if open_workbook == nil then
-          #  File.delete(file) 
-          #else
-          #  raise ExcelErrorSave, "book is open and used in Excel"
-          #end
-        when :excel 
-          old_displayalerts = @excel_app.DisplayAlerts  # :nodoc:
-          @excel_app.DisplayAlerts = true  # :nodoc:
+        when :alert 
+          old_displayalerts = @excel.DisplayAlerts  # :nodoc:
+          @excel.DisplayAlerts = true  # :nodoc:
         when :raise
           raise ExcelErrorSave, "book already exists: #{basename}"
         else
@@ -247,10 +239,10 @@ module RobustExcelOle
         end
       end
       begin
-        @workbook.SaveAs(absolute_path(File.join(dirname, basename)), file_format)
+        @workbook.SaveAs(RobustExcelOle::absolute_path(File.join(dirname, basename)), file_format)
       rescue WIN32OLERuntimeError => msg
         if msg.message =~ /SaveAs/ and msg.message =~ /Workbook/ then
-          if opts[:if_exists] == :excel then 
+          if opts[:if_exists] == :alert then 
             raise ExcelErrorSave, "not saved or canceled by user"
           else
             return nil
@@ -260,8 +252,8 @@ module RobustExcelOle
           raise ExcelErrorSaveUnknown, "unknown WIN32OELERuntimeError:\n#{msg.message}"
         end       
       ensure
-        if opts[:if_exists] == :excel then
-          @excel_app.DisplayAlerts = old_displayalerts  # :nodoc:
+        if opts[:if_exists] == :alert then
+          @excel.DisplayAlerts = old_displayalerts  # :nodoc:
         end
       end
       true
@@ -291,16 +283,11 @@ module RobustExcelOle
       base_sheet = base_sheet.sheet
       sheet ? sheet.Copy({ after_or_before.to_s => base_sheet }) : @workbook.WorkSheets.Add({ after_or_before.to_s => base_sheet })
 
-      new_sheet = RobustExcelOle::Sheet.new(@excel_app.Activesheet)
+      new_sheet = RobustExcelOle::Sheet.new(@excel.Activesheet)
       new_sheet.name = new_sheet_name if new_sheet_name
       new_sheet
     end        
 
-    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
   end
 
 end