robust_excel_ole 1.1.4 → 1.1.5

data/examples/open_save_close/example_default_excel.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name1 = dir + 'workbook.xls'
@@ -44,6 +44,6 @@ begin
   book3.close
   book2.close
 ensure
-  Excel.close_all                            # close all workbooks, quit Excel instances
+  Excel.kill_all                            # close all workbooks, quit Excel instances
   rm_tmp(dir)
 end

data/examples/open_save_close/example_force_excel.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   simple_file = dir + 'workbook.xls'
@@ -29,6 +29,6 @@ begin
   book2.close
   book1.close                                         
 ensure
-  Excel.close_all                            # close all workbooks, quit Excel instances
+  Excel.kill_all                            # close all workbooks, quit Excel instances
   rm_tmp(dir)
 end

data/examples/open_save_close/example_if_obstructed_closeifsaved.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
@@ -31,6 +31,6 @@ begin
   puts "the old book was saved" unless new_first_cell == first_cell 
   new_book.close                                 # close the books                  
 ensure
-  Excel.close_all                         # close all workbooks, quit Excel application
+  Excel.kill_all                         # close all workbooks, quit Excel application
   rm_tmp(dir)
 end

data/examples/open_save_close/example_if_obstructed_forget.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
@@ -28,6 +28,6 @@ begin
   new_book.close                                 # close the books                      
   another_book.close
 ensure
-  Excel.close_all                         # close all workbooks, quit Excel application
+  Excel.kill_all                         # close all workbooks, quit Excel application
   rm_tmp(dir)
 end

data/examples/open_save_close/example_if_obstructed_save.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
@@ -28,6 +28,6 @@ begin
   new_book.close                                 # close the books                      
   old_book.close
 ensure
-  Excel.close_all                         # close all workbooks, quit Excel application
+  Excel.kill_all                         # close all workbooks, quit Excel application
   rm_tmp(dir)
 end

data/examples/open_save_close/example_if_unsaved_accept.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls' 
@@ -16,7 +16,7 @@ begin
   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 WorkbookBeingUsed => msg                     # by default: raises an exception:
+  rescue WorkbookNotSaved => msg                     # by default: raises an exception:
     puts "error: open: #{msg.message}"              # a book 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 
@@ -36,6 +36,6 @@ begin
   puts "closed the book successfully with option :if_unsaved => :save"
   new_book.close                                        # close the other book. It is already saved.
 ensure
-	  Excel.close_all                                    # close workbooks, quit Excel application
+	  Excel.kill_all                                    # close workbooks, quit Excel application
     rm_tmp(dir)
 end

data/examples/open_save_close/example_if_unsaved_forget.rb

@@ -7,19 +7,23 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+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 
+  puts "file_name: #{file_name}"
+  #book.excel.visible = true                        # make current Excel visible 
   sleep 1
   sheet = book.sheet(1)                                            # access a sheet
   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
+  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 
     puts "open with :if_unsaved => :forget : the unsaved book is closed and not saved."     # is closed and was not saved
@@ -32,6 +36,6 @@ begin
   new_book.close(:if_unsaved => :forget )                                
   another_book.close
 ensure
-	  Excel.close_all                                    # close all workbooks, quit Excel application
+	  Excel.kill_all                                    # close all workbooks, quit Excel application
     rm_tmp(dir)
 end

data/examples/open_save_close/example_if_unsaved_forget_more.rb

@@ -12,7 +12,7 @@ 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.excel.visible = true                        # make current Excel visible 
   sheet = book.sheet(1)                                            # access a sheet
   first_cell = sheet[1,1].value
   sheet[1,1] = first_cell == "simple" ? "complex" : "simple" # change a cell

data/examples/open_save_close/example_read_only.rb

@@ -6,7 +6,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
@@ -23,7 +23,7 @@ begin
   end
   book.close                                          # close the book without saving it 
 ensure
-  Excel.close_all                                     # close workbooks, quit Excel application
+  Excel.kill_all                                     # close workbooks, quit Excel application
   rm_tmp(dir)
 end
 

data/examples/open_save_close/example_rename_cells.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name = dir + 'workbook.xls'
@@ -51,7 +51,7 @@ begin
   book.close(:if_unsaved => :forget)                        # close the book
 
 ensure
-	  Excel.close_all                                         # close workbooks, quit Excel application
+	  Excel.kill_all                                         # close workbooks, quit Excel application
     rm_tmp(dir)
 end		
 

data/examples/open_save_close/example_reuse.rb

@@ -6,7 +6,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   file_name1 = dir + 'workbook.xls'
@@ -27,7 +27,7 @@ begin
   book3.close
   book4.close                                         
 ensure
-  Excel.close_all                       # close all workbooks, quit Excel application
+  Excel.kill_all                       # close all workbooks, quit Excel application
   rm_tmp(dir)
 end
 

data/examples/open_save_close/example_simple.rb

@@ -32,7 +32,7 @@ begin
   puts "save_as: saved successfully with option :if_exists => :overwrite"
   book.close                                                 # close the book
 ensure
-	  Excel.close_all                                         # close workbooks, quit Excel application
+	  Excel.kill_all                                         # close workbooks, quit Excel application
     #rm_tmp(dir)
 end		
 

data/examples/open_save_close/example_unobtrusively.rb

@@ -6,7 +6,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   simple_file = dir + 'workbook.xls'
@@ -23,6 +23,6 @@ begin
   p "book saved" if book.Saved
   book.close                                 # close the book                      
 ensure
-  Excel.close_all                            # close all workbooks, quit Excel application
+  Excel.kill_all                            # close all workbooks, quit Excel application
   rm_tmp(dir)
 end

data/lib/robust_excel_ole/book.rb

@@ -73,9 +73,9 @@ module RobustExcelOle
       # :visible              true -> makes the workbook visible
       # :check_compatibility  true -> check compatibility when saving
       # :update_links         true -> user is being asked how to update links, false -> links are never updated
-      # @return [Book] a workbook
+      # @return [Book] a representation of a workbook
       def open(file, opts={ }, &block)
-        options = process_options(opts)
+        options = @options = process_options(opts)
         book = nil
         if (not (options[:force][:excel] == :new))
           # if readonly is true, then prefer a book that is given in force_excel if this option is set
@@ -86,16 +86,20 @@ module RobustExcelOle
                   :prefer_writable => (not options[:read_only]), 
                   :prefer_excel    => (options[:read_only] ? forced_excel : nil)) rescue nil
           if book
+            #if forced_excel != book.excel && 
+            #  (not (book.alive? && (not book.saved) && (not options[:if_unsaved] == :accept)))
             if (((not options[:force][:excel]) || (forced_excel == book.excel)) &&
-                 (not (book.alive? && (not book.saved) && (not options[:if_unsaved] == :accept))))
+                (not (book.alive? && (not book.saved) && (not options[:if_unsaved] == :accept))))
               book.options = options
               book.ensure_excel(options) # unless book.excel.alive?
-              # if the ReadOnly status shall be changed, then save, close and reopen it
-              book.close(:if_unsaved => :save) if (book.alive? && 
-                (((not book.writable) and (not options[:read_only])) or
-                  (book.writable and options[:read_only]))) 
-              # reopens the book
-              book.ensure_workbook(file,options) unless book.alive?
+              # if the ReadOnly status shall be changed, save, close and reopen it
+              if book.alive? and (((not book.writable) and (not options[:read_only])) or
+                 (book.writable and options[:read_only]))
+                book.save if book.writable && (not book.saved)
+                book.close(:if_unsaved => :forget)
+              end           
+              # reopens the book if it was closed     
+              book.ensure_workbook(file,options) unless book.alive? 
               book.visible = options[:force][:visible] unless options[:force][:visible].nil?
               book.CheckCompatibility = options[:check_compatibility] unless options[:check_compatibility].nil?
               book.excel.calculation = options[:calculation] unless options[:calculation].nil?
@@ -107,6 +111,24 @@ module RobustExcelOle
       end
     end    
 
+# here is what is different and works 
+=begin
+           if book
+             if (((not options[:force][:excel]) || (forced_excel == book.excel)) &&
+                  (not (book.alive? && (not book.saved) && (not options[:if_unsaved] == :accept))))
+               book.options = options
+               book.ensure_excel(options) # unless book.excel.alive?
+               # if the ReadOnly status shall be changed, close and reopen it; save before, if it is writable
+               if book.alive? and (((not book.writable) and (not options[:read_only])) or
+                   (book.writable and options[:read_only]))
+                 book.save if book.writable  
+                 book.close(:if_unsaved => :forget)
+               end                
+               # reopens the book
+               book.ensure_workbook(file,options) unless book.alive?
+=end
+
+
     # creates a Book object by opening an Excel file given its filename workbook or 
     # by lifting a Win32OLE object representing an Excel file
     # @param [WIN32OLE] workbook a workbook
@@ -114,14 +136,13 @@ module RobustExcelOle
     # @option opts [Symbol] see above
     # @return [Book] a workbook
     def self.new(workbook, opts={ }, &block)
+      opts = process_options(opts)
       if workbook && (workbook.is_a? WIN32OLE)
-        opts = process_options(opts)
         filename = workbook.Fullname.tr('\\','/') rescue nil
         if filename
           book = bookstore.fetch(filename)
           if book && book.alive?
-            book.visible = opts[:force][:visible] unless opts[:force][:visible].nil?
-            #book.excel.calculation = opts[:calculation].nil? ? book.excel.calculation : opts[:calculation]
+            book.visible = opts[:force][:visible] unless opts[:force].nil? or opts[:force][:visible].nil?
             book.excel.calculation = opts[:calculation] unless opts[:calculation].nil?
             return book 
           end
@@ -139,7 +160,7 @@ module RobustExcelOle
     # @return [Book] a workbook
     #def initialize(file_or_workbook, opts={ }, &block)
     def initialize(file_or_workbook, options={ }, &block)
-      #options = self.class.process_options(opts)
+      #options = @options = self.class.process_options(options) if options.empty?
       if file_or_workbook.is_a? WIN32OLE        
         workbook = file_or_workbook
         @ole_workbook = workbook        
@@ -152,7 +173,7 @@ module RobustExcelOle
       else
         file = file_or_workbook
         ensure_excel(options)
-        ensure_workbook(file, options)        
+        ensure_workbook(file, options)
       end
       bookstore.store(self)
       @modified_cells = []
@@ -179,7 +200,7 @@ module RobustExcelOle
             erg[new_key] = {}
             value.each do |k,v|
               new_k = k
-              ABBREVIATIONS.each{|long,short| new_k = long if k == short}
+              ABBREVIATIONS.each{|l,s| new_k = l if k == s}
               erg[new_key][new_k] = v
             end
           else
@@ -228,40 +249,17 @@ module RobustExcelOle
 
   public
 
-=begin
-    # work in progress#
-    def self.open_in_current_excel(file, opts = { }) # :nodoc: # 
-      options = DEFAULT_OPEN_OPTS.merge(opts)
-      filename = General::absolute_path(file)
-      ole_workbook = WIN32OLE.connect(filename)
-      workbook = Book.new(ole_workbook)
-      workbook.visible = options[:force][:visible] unless options[:force][:visible].nil?
-      update_links_opt =
-            case options[:update_links]
-            when :alert; RobustExcelOle::XlUpdateLinksUserSetting
-            when :never; RobustExcelOle::XlUpdateLinksNever
-            when :always; RobustExcelOle::XlUpdateLinksAlways
-            else RobustExcelOle::XlUpdateLinksNever
-          end
-      workbook.UpdateLinks = update_links_opt
-      workbook.CheckCompatibility = options[:check_compatibility]
-      workbook
-    end
-=end
-
     def ensure_excel(options)   # :nodoc: #
-      if @excel && @excel.alive?
+      #if (excel && @excel.alive? && (options[:force].nil? or options[:force][:excel].nil? or 
+      #             options[:force][:excel]==@excel))
+      if excel && @excel.alive?  
         @excel.created = false
         return
       end
       excel_option = (options[:force].nil? or options[:force][:excel].nil?) ? options[:default][:excel] : options[:force][:excel]
       @excel = self.class.excel_of(excel_option) unless (excel_option == :current || excel_option == :new)
       @excel = excel_class.new(:reuse => (excel_option == :current)) unless (@excel && @excel.alive?)
-
-      #options[:excel] = options[:force_excel] ? options[:force_excel] : options[:default_excel]
-      #options[:excel] = :current if (options[:excel] == :reuse || options[:excel] == :active)
-      #@excel = self.class.excel_of(options[:excel]) unless (options[:excel] == :current || options[:excel] == :new)
-      #@excel = excel_class.new(:reuse => (options[:excel] == :current)) unless (@excel && @excel.alive?)
+      @excel
     end    
 
     def ensure_workbook(file, options)     # :nodoc: #
@@ -474,7 +472,7 @@ module RobustExcelOle
     def self.for_reading(*args, &block)
       args = args.dup
       opts = args.last.is_a?(Hash) ? args.pop : {}
-      opts = {:read_only => true}.merge(opts)
+      opts = {:writable => false}.merge(opts)
       args.push opts
       unobtrusively(*args, &block)
     end
@@ -482,7 +480,7 @@ module RobustExcelOle
     def self.for_modifying(*args, &block)
       args = args.dup
       opts = args.last.is_a?(Hash) ? args.pop : {}
-      opts = {:read_only => false}.merge(opts)
+      opts = {:writable => true}.merge(opts)
       args.push opts
       unobtrusively(*args, &block)
     end
@@ -492,21 +490,22 @@ module RobustExcelOle
     # @param [String] file        the file name
     # @param [Hash]   opts        the options
     # @option opts [Variant] :if_closed  :current (default), :new or an Excel instance
-    # @option opts [Boolean] :read_only whether the workbook is opened for read-only
-    # @option opts [Boolean] :readonly_excel behaviour when workbook is opened read-only and shall be modified
-    #               true:  closes it and open it as writable in the Excel instance where it was open so far
-    #               false (default)  opens it as writable in another running excel instance, if it exists,
-    #                                otherwise open in a new Excel instance.
+    # @option opts [Boolean] :read_only true/false, open the workbook in read-only/read-write modus (save changes)
+    # @option opts [Boolean] :writable  true/false changes of the workbook shall be saved/not saved                                  
+    # @option opts [Boolean] :rw_change_excel Excel instance in which the workbook with the new
+    #                         write permissions shall be opened  :current (default), :new or an Excel instance                   
     # @option opts [Boolean] :keep_open whether the workbook shall be kept open after unobtrusively opening 
     # @return [Book] a workbook
-
     # state = [:open, :saved, :writable, :visible, :calculation, :check_compatibility]
     def self.unobtrusively(file, opts = { }, &block) 
-      options = {:if_closed => :current, 
-                 :read_only => false,
-                 :readonly_excel => false,
-                 :keep_open => false}.merge(opts)
-      book = bookstore.fetch(file, :prefer_writable => (not options[:read_only]))
+      opts = {:if_closed => :current,
+              :rw_change_excel => :current,
+              :keep_open => false}.merge(opts)
+      raise OptionInvalid, "contradicting options" if (opts[:writable] && opts[:read_only])
+      prefer_writable = (((not opts[:read_only]) || opts[:writable]==true) && 
+                         (not (opts[:read_only].nil?) && opts[:writable]==false))
+      do_not_write = (opts[:read_only] or (opts[:read_only].nil? && opts[:writable]==false))
+      book = bookstore.fetch(file, :prefer_writable => prefer_writable)
       was_open = book && book.alive?
       if was_open
         was_saved = book.saved
@@ -514,37 +513,39 @@ module RobustExcelOle
         was_visible = book.visible
         was_calculation = book.calculation
         was_check_compatibility = book.check_compatibility
-      end     
-      begin 
+        if ((opts[:writable] && (not was_writable) && (not was_saved)) ||
+            (opts[:read_only] && was_writable && (not was_saved))) 
+          raise NotImplementedREOError, "unsaved read-only workbook shall be written"
+        end
+        opts[:rw_change_excel] = book.excel if opts[:rw_change_excel]==:current        
+      end           
+      change_rw_mode = ((opts[:read_only] && was_writable) or (opts[:writable] && (not was_writable)))      
+      begin
         book = 
           if was_open 
-            if (not was_writable) && (not options[:read_only])
-              open(file, :force => {:excel => (options[:readonly_excel] ? book.excel : :new)}, :read_only => false)
+            if change_rw_mode               
+              open(file, :force => {:excel => opts[:rw_change_excel]}, :read_only => do_not_write)
             else
               book
             end
           else
-            open(file, :force => {:excel => options[:if_closed]}, :read_only => false)
+            open(file, :force => {:excel => opts[:if_closed]}, :read_only => do_not_write)
           end
         yield book
       ensure
         if book && book.alive?
-          unless book.saved
-            book.save unless options[:read_only]
-            book.Saved = true if (was_saved || (not was_open)) && options[:read_only]
-            book.Saved = false if (not was_saved) && (not options[:read_only]) && was_open
-          end
+          book.save unless book.saved || do_not_write || book.ReadOnly
           if was_open
-            if (not was_writable) && (not options[:read_only]) && options[:readonly_excel]
+            if opts[:rw_change_excel]==book.excel && change_rw_mode
               book.close
-              open(file, :force => {:excel => book.excel}, :if_obstructed => :new_excel, :read_only => true)
-            end         
+              book = open(file, :force => {:excel => opts[:rw_change_excel]}, :read_only => (not was_writable))
+            end    
             book.excel.calculation = was_calculation
             book.CheckCompatibility = was_check_compatibility
             #book.visible = was_visible  # not necessary
-          end          
-          
-          book.close unless was_open || options[:keep_open]
+          end
+          book.Saved = (was_saved || (not was_open))
+          book.close unless was_open || opts[:keep_open]
         end
       end
     end
@@ -552,7 +553,9 @@ module RobustExcelOle
     # reopens a closed workbook
     # @options options 
     def reopen(options = { })
-      self.class.open(@stored_filename, options)
+      book = self.class.open(@stored_filename, options)
+      raise WorkbookREOError("cannot reopen book") unless book && book.alive?
+      book
     end
 
     # simple save of a workbook.
@@ -825,10 +828,6 @@ module RobustExcelOle
       unless opts[:read_only].nil?
         # if the ReadOnly status shall be changed, then close and reopen it
         if ((not writable) and (not opts[:read_only])) or (writable and opts[:read_only])          
-          #opts[:check_compatibility] = opts[:check_compatibility].nil? ? check_compatibility :
-          #                             DEFAULT_OPEN_OPTS[:check_compatibility] 
-          #opts[:check_compatibility] = opts[:check_compatibility].nil? ? check_compatibility :
-          #                             opts[:check_compatibility]
           opts[:check_compatibility] = check_compatibility if opts[:check_compatibility].nil?                                         
           close(:if_unsaved => true)      
           open_or_create_workbook(@stored_filename, opts)