robust_excel_ole 0.3.3 → 0.3.4

data/README.rdoc

@@ -1,13 +1,15 @@
 = RobustExcelOle
 
-robust_excel_ole implements methods for accessing Excel files using win32ole.  
-It provides convenient methods for opening, modifying, saving and closing Excel files.
-Furthermore all VBA methods are deligated to Excel.
-
-robust_excel_ole can manage Excel workbooks that are open in several Excel instances.
-It allows to automatically perform Excel operations while the user can operate with Excel manually.
-
+robust_excel_ole helps to automate modifying and reading Excel files.
+This is done by sending VBA methods via Win32OLE.
+Moreover, robust_excel_ole implements a management system of Excel files and Excel instances and keeps track of all workbooks.
 
+Goals:
+- support both fully automated operations as well as simultaneous user interactions during the automation
+- be able to cope with all cases of Excel (and user) behaviour, encapsulate errors
+- provide convenient methods for frequent (common) tasks
+- support the use of simultaneously running Excel instances
+- allow the presence of referenced libraries and provide some support for that
 
 This is work in progress.
 
@@ -38,7 +40,6 @@ The semantics is similar to, e.g.,  +File.open+.
 Options are 
   
   +:default_excel+, +:force_excel+, +:if_absent+, +:if_unsaved+, +:if_obstructed+, 
-
   +:read_only+, +:visible+, +:displayalerts+. 
 
 Here are a few examples:
@@ -72,7 +73,7 @@ Closing the workbook and saving it before if it has unsaved changes.
 
 === Reopening workbooks.
 
-A special feature of robust_excel_ole is that it allows to reopen books after closing them.
+A special feature of robust_excel_ole is that it allows tog reopen books after closing them.
 
   book = Book.open('workbook.xls')
   book.close
@@ -442,7 +443,7 @@ The book is modified, but its status is unchanged.
 
 === More Details
 
-For more details about usage: see link:Readme_detail.rdoc
+For more details about usage: see link:https://github.com/Thomas008/robust_excel_ole/blob/master/README_detail.rdoc
 
 === Development
 

data/README_detail.rdoc

@@ -1,11 +1,15 @@
 = RobustExcelOle
 
-robust_excel_ole implements methods for accessing Excel files using win32ole.  
-It provides convenient methods for opening, modifying, saving and closing Excel files.
-Furthermore all VBA methods are deligated to Excel.
-
-robust_excel_ole can manage Excel workbooks that are open in several Excel instances.
-It allows to automatically perform Excel operations while the user can operate with Excel manually.
+robust_excel_ole helps to automate modifying and reading Excel files.
+This is done by sending VBA methods via Win32OLE.
+Moreover, robust_excel_ole implements a management system of Excel files and Excel instances and keeps track of all workbooks.
+
+Goals:
+- support both fully automated operations as well as simultaneous user interactions during the automation
+- be able to cope with all cases of Excel (and user) behaviour, encapsulate errors
+- provide convenient methods for frequent (common) tasks
+- support the use of simultaneously running Excel instances
+- allow the presence of referenced libraries and provide some support for that
 
 This is work in progress.
 

data/examples/edit_sheets/example_concating.rb

@@ -0,0 +1,33 @@
+# example_concatening.rb: 
+# 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 'rubygems'
+require 'robust_excel_ole'
+require "fileutils"
+
+include RobustExcelOle
+
+begin
+  Excel.close_all
+  dir = "C:/data"
+  workbook_name = 'workbook_named.xls'
+  base_name = workbook_name[0,workbook_name.rindex('.')]
+  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  file_name = dir + "/" + workbook_name
+  extended_file_name = dir + "/" + base_name + "_concat" + "." + suffix
+  book_orig = Book.open(file_name)
+  book_orig.save_as(extended_file_name, :if_exists => :overwrite) 
+  book_orig.close
+  Book.unobtrusively(extended_file_name) do |book|
+    book.each do |sheet|
+      sheet.each do |cell_orig|
+        name = cell_orig.Name.Name rescue nil
+        if name
+          sheet[cell_orig.Row-1, cell_orig.Column-1].Value = cell_orig.Value.to_s + cell_orig.Offset(0,1).Value.to_s
+          sheet.Names.Add("Name" => name, "RefersTo" => "=" + cell_orig.Address) 
+        end
+      end
+    end
+  end
+end

data/examples/edit_sheets/example_expanding.rb

@@ -0,0 +1,57 @@
+# example_expanding.rb:  
+# create a workbook which is named like the old one, expect that the suffix "_expanded" is appended to the base name
+# for each (global or local) Excel name of the workbook that refers to a range in a single sheet
+# this sheet is to be copied into the new workbook
+# 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 'rubygems'
+require 'robust_excel_ole'
+require "fileutils"
+
+include RobustExcelOle
+
+begin
+  Excel.close_all
+  dir = "C:/data"
+  workbook_name = 'workbook_named_concat.xls'
+  base_name = workbook_name[0,workbook_name.rindex('.')]
+  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  file_name = dir + "/" + workbook_name
+  extended_file_name = dir + "/" + base_name + "_expanded" + "." + suffix
+  book_orig = Book.open(file_name)
+  book_orig.save_as(extended_file_name, :if_exists => :overwrite) 
+  book_orig.close
+  sheet_names = []
+  Book.unobtrusively(extended_file_name) do |book|     
+    book.each do |sheet|
+      sheet_names << sheet.name
+    end
+    book.Names.each do |excel_name|
+      full_name = excel_name.Name
+      sheet_name, short_name = full_name.split("!")
+      sheet = excel_name.RefersToRange.Worksheet
+      sheet_name = short_name ? short_name : full_name
+      begin
+        sheet_new = book.add_sheet(sheet, :as => sheet_name)
+      rescue ExcelErrorSheet => msg
+        if msg.message == "sheet name already exists" 
+          sheet_new = book.add_sheet(sheet, :as => (sheet_name+sheet.name))
+        else 
+          puts msg.message
+        end
+      end
+      sheet_new.Names.Add("Name" => "name", "RefersTo" => "=" + "$B$2")
+      sheet_new[1,1].Value = sheet_name
+      begin
+        sheet_new.name = sheet_name
+      rescue
+        sheet_new.name = (sheet_name+sheet.name)
+      end
+    end
+    sheet_names.each do |sheet_name|
+      book[sheet_name].Delete()
+    end
+  end
+  Excel.close_all
+end

data/examples/edit_sheets/example_naming.rb

@@ -0,0 +1,33 @@
+# example_naming.rb: 
+# each cell is named with the name equaling its value unless it is empty or not a string
+# the contents of each cell is copied
+# the new workbook's name is extended by the suffix "_named"
+
+require 'rubygems'
+require 'robust_excel_ole'
+require "fileutils"
+
+include RobustExcelOle
+
+begin
+  Excel.close_all
+  dir = "C:/data"
+  workbook_name = 'workbook.xls'
+  base_name = workbook_name[0,workbook_name.rindex('.')]
+  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  file_name = dir + "/" + workbook_name
+  extended_file_name = dir + "/" + base_name + "_named" + "." + suffix
+  book_orig = Book.open(file_name)
+  book_orig.save_as(extended_file_name, :if_exists => :overwrite) 
+  book_orig.close
+  Book.unobtrusively(extended_file_name) do |book|     
+    book.each do |sheet|
+      sheet.each do |cell_orig|
+        contents = cell_orig.Value
+        if contents && contents.class == String
+          sheet.Names.Add("Name" => contents, "RefersTo" => "=" + cell_orig.Address) 
+        end
+      end
+    end
+  end
+end

data/examples/edit_sheets/example_saving.rb

@@ -0,0 +1,44 @@
+# example_saving.rb: 
+# save the sheets of a book as separate workbooks
+
+require 'rubygems'
+require 'robust_excel_ole'
+require "fileutils"
+
+include RobustExcelOle
+
+begin
+  Excel.close_all
+  dir = "C:/data"
+  workbook_name = 'workbook.xls'
+  base_name = workbook_name[0,workbook_name.rindex('.')]
+  suffix = workbook_name[workbook_name.rindex('.')+1,workbook_name.length]
+  file_name = dir + "/" + workbook_name
+  Book.unobtrusively(file_name) do |book_orig| 
+    book_orig.each do |sheet_orig|
+      file_sheet_name = dir + "/" + base_name + "_" + sheet_orig.name + "." + suffix
+      Excel.current.generate_workbook(file_sheet_name)
+    end
+  end
+  Book.unobtrusively(file_name) do |book_orig| 
+    book_orig.each do |sheet_orig|
+      file_sheet_name = dir + "/" + base_name + "_" + sheet_orig.name + "." + suffix
+      # delete all existing sheets, and add the sheet    
+      book = Book.open(file_sheet_name)
+      book.add_sheet sheet_orig
+      book.each do |sheet|
+        sheet.Delete() unless sheet.name == sheet_orig.name 
+      end
+      book.close(:if_unsaved => :save)
+      # alternative: delete all other sheets
+      #book = Book.open(file_sheet_name, :force_excel => :new, :visible => true)
+      #book.each do |sheet|
+      #  p "sheet.Name: #{sheet.Name}"
+      #  book[sheet.Name].Delete() unless sheet.Name == sheet_orig.Name
+      #end
+      #sleep 3
+      #book.save_as(file_sheet_name, :if_exists => :overwrite)
+      #book.close
+    end
+  end
+end

data/lib/robust_excel_ole/book.rb

@@ -34,10 +34,10 @@ module RobustExcelOle
       #                                        excluding the hidden Excel instance, if it exists,
       #                                       otherwise open in a new Excel instance.
       #                   :new             -> open in a new Excel instance
-      #                   <instance>       -> open in the given Excel instance
+      #                   <excel-instance> -> open in the given Excel instance
       # :force_excel     no matter whether the book was already open
       #                   :new (default)   -> open in a new Excel
-      #                   <instance>       -> open in the given Excel instance
+      #                   <excel-instance> -> open in the given Excel instance
       # :if_unsaved     if an unsaved book with the same name is open, then
       #                  :raise (default)              -> raise an exception
       #                  :forget              -> close the unsaved book, open the new book             
@@ -51,11 +51,11 @@ module RobustExcelOle
       #                  :close_if_saved      -> close the old book and open the new book, if the old book is saved,
       #                                          otherwise raise an exception.
       #                  :new_excel           -> open the new book in a new Excel    
-      # :if_absent       :create              -> creates a new Excel file, if it does not exists  
+      # :if_absent       :create (default)    -> creates a new Excel file, if it does not exists  
       #                  :raise               -> raises an exception     , if the file does not exists
       # :read_only     open in read-only mode         (default: false) 
       # :displayalerts enable DisplayAlerts in Excel  (default: false)
-      # :visible       make visible in Excel           (default: false)
+      # :visible       make visible in Excel          (default: false)
       # if :default_excel is set, then DisplayAlerts and Visible are set only if these parameters are given
 
       def open(file, opts={ }, &block)
@@ -63,10 +63,12 @@ module RobustExcelOle
         book = nil
         if (not (current_options[:force_excel] == :new && (not current_options[:if_locked] == :take_writable)))
           # if readonly is true, then prefer a book that is given in force_excel if this option is set
-          book = book_store.fetch(file, :prefer_writable => (not current_options[:read_only]), 
-                                        :prefer_excel    => (current_options[:read_only] ? current_options[:force_excel] : nil)) rescue nil
+          book = book_store.fetch(file, 
+                  :prefer_writable => (not current_options[:read_only]), 
+                  :prefer_excel    => (current_options[:read_only] ? Book.excel(current_options[:force_excel]) : nil)) rescue nil
           if book
-            if (((not current_options[:force_excel]) || (current_options[:force_excel] == book.excel)) &&
+            #if (((not current_options[:force_excel]) || (current_options[:force_excel].excel == book.excel)) &&
+            if (((not current_options[:force_excel]) || (Book.excel(current_options[:force_excel]) == book.excel)) &&
                  (not (book.alive? && (not book.saved) && (not current_options[:if_unsaved] == :accept))))
               book.options = DEFAULT_OPEN_OPTS.merge(opts)
               book.get_excel unless book.excel.alive?
@@ -110,6 +112,7 @@ module RobustExcelOle
           @excel = Excel.new(@excel_options)
         else
           @excel = @options[:excel]
+          @excel = Book.excel(@options[:excel])
         end
       end
       # if :excel => :new or (:excel => :reuse but could not reuse)
@@ -130,7 +133,7 @@ module RobustExcelOle
         if obstructed_by_other_book then
           case @options[:if_obstructed]
           when :raise
-            raise ExcelErrorOpen, "blocked by a book with the same name in a different path"
+            raise ExcelErrorOpen, "blocked by a book with the same name in a different path: #{File.basename(@file)}"
           when :forget
             @workbook.Close
             @workbook = nil
@@ -142,7 +145,7 @@ module RobustExcelOle
             open_or_create_workbook
           when :close_if_saved
             if (not @workbook.Saved) then
-              raise ExcelErrorOpen, "book with the same name in a different path is unsaved"
+              raise ExcelErrorOpen, "book with the same name in a different path is unsaved: #{File.basename(@file)}"
             else 
               @workbook.Close
               @workbook = nil
@@ -154,7 +157,7 @@ module RobustExcelOle
             @excel = Excel.new(@excel_options)
             open_or_create_workbook
           else
-            raise ExcelErrorOpen, ":if_obstructed: invalid option"
+            raise ExcelErrorOpen, ":if_obstructed: invalid option: #{@options[:if_obstructed]}"
           end
         else
           # book open, not obstructed by an other book, but not saved and writable
@@ -178,7 +181,7 @@ module RobustExcelOle
               @excel = Excel.new(@excel_options)
               open_or_create_workbook
             else
-              raise ExcelErrorOpen, ":if_unsaved: invalid option"
+              raise ExcelErrorOpen, ":if_unsaved: invalid option: #{@options[:if_unsaved]}"
             end
           end
         end
@@ -191,7 +194,6 @@ module RobustExcelOle
     def open_or_create_workbook
       if (not File.exist?(@file))
         @workbook = Excel.current.generate_workbook(@file)
-        #@workbook = Excel.new(:reuse => true).generate_workbook(@file)
         return
       end
       if ((not @workbook) || (@options[:if_unsaved] == :alert) || @options[:if_obstructed]) then
@@ -199,7 +201,8 @@ module RobustExcelOle
           filename = RobustExcelOle::absolute_path(@file)
           workbooks = @excel.Workbooks
           workbooks.Open(filename,{ 'ReadOnly' => @options[:read_only] })
-        rescue WIN32OLERuntimeError => msg 
+        rescue WIN32OLERuntimeError => msg
+          puts "msg: #{msg}" 
           raise ExcelErrorOpen, "open: user canceled or open error" if msg.message =~ /OLE error code:800A03EC/
         end   
         begin
@@ -212,6 +215,20 @@ module RobustExcelOle
       end
     end
 
+  private
+  
+    # return an Excel.
+    # return the given instance if it is an Excel and alive. If the given instance is a Book then take the Excel of the Book
+    def self.excel(instance)
+      raise ExcelErrorOpen, "provided instance is neither an Excel nor a Book: #{instance}" \
+        unless instance.is_a?(Excel) || instance.is_a?(Book)
+      excel = instance.is_a?(Book) ? instance.excel : instance
+      raise ExcelErrorOpen, "provided Excel instance is not alive" unless excel.alive?
+      excel
+    end
+
+  public
+
     # closes the book, if it is alive
     #
     # options:
@@ -235,7 +252,7 @@ module RobustExcelOle
             close_workbook
           end
         else
-          raise ExcelErrorClose, ":if_unsaved: invalid option"
+          raise ExcelErrorClose, ":if_unsaved: invalid option: #{opts[:if_unsaved]}"
         end
       else
         close_workbook
@@ -274,7 +291,6 @@ module RobustExcelOle
       was_not_alive_or_nil = book.nil? || (not book.alive?)
       was_saved = was_not_alive_or_nil ? true : book.saved
       was_writable = book.writable unless was_not_alive_or_nil
-      old_visible = (book && book.excel.alive?) ? book.excel.visible : false
       begin 
         book = 
           if was_not_alive_or_nil 
@@ -284,7 +300,7 @@ module RobustExcelOle
             when :reuse
               open(file)
             else 
-              options[:if_closed].alive? ? open(file, :force_excel => options[:if_closed]) : open(file)
+              open(file, :force_excel => options[:if_closed])
             end
           else
             if was_writable || options[:read_only]
@@ -295,17 +311,33 @@ module RobustExcelOle
           end
         yield book
       ensure
-        book.save if (was_not_alive_or_nil || was_saved || ((not was_writable) && (not options[:read_only]))) && (not book.saved)
+        book.save if (was_not_alive_or_nil || was_saved || ((not was_writable) && (not options[:read_only]))) && (book && (not book.saved))
         # book was open, readonly and shoud be modified
         if (not was_not_alive_or_nil) && (not options[:read_only]) && (not was_writable) && options[:use_readonly_excel]
           open(file, :force_excel => book.excel, :if_obstructed => :new_excel, :read_only => true)
         end
-        book.excel.visible = old_visible
-        book.close if (was_not_alive_or_nil && (not opts[:keep_open]))
+        book.close if (was_not_alive_or_nil && (not opts[:keep_open]) && book)
       end
     end
 
-    # returns the contents of a range or cell with given name
+    # rename a range
+    def rename_range(name,new_name)
+      begin
+        p "name: #{name}"
+        p "new_name: #{new_name}"
+        item = self.Names.Item(name)
+        p "nil" if item.nil?
+      rescue WIN32OLERuntimeError
+        raise ExcelErrorRename, "name #{name} not in #{File.basename(self.stored_filename)}"  
+      end
+      begin
+        item.Name = new_name
+      rescue WIN32OLERuntimeError
+        raise ExcelErrorRename, "name error in #{File.basename(self.stored_filename)}"      
+      end
+    end
+
+    # returns the contents of a range with given name
     def nvalue(name)
       begin
         item = self.Names.Item(name)
@@ -318,7 +350,26 @@ module RobustExcelOle
         raise ExcelErrorNValue, "range error in #{File.basename(self.stored_filename)}"      
       end
       begin
-        value = referstorange.Value
+        referstorange.Value
+      rescue WIN32OLERuntimeError
+        raise ExcelErrorNValue, "value error in #{File.basename(self.stored_filename)}" 
+      end
+    end
+
+    # set the contents of a range with given name
+    def set_nvalue(name,value) 
+      begin
+        item = self.Names.Item(name)
+      rescue WIN32OLERuntimeError
+        raise ExcelErrorNValue, "name #{name} not in #{File.basename(self.stored_filename)}"  
+      end
+      begin
+        referstorange = item.RefersToRange
+      rescue WIN32OLERuntimeError
+        raise ExcelErrorNValue, "range error in #{File.basename(self.stored_filename)}"      
+      end
+      begin
+        referstorange.Value = value
       rescue WIN32OLERuntimeError
         raise ExcelErrorNValue, "value error in #{File.basename(self.stored_filename)}" 
       end
@@ -361,7 +412,15 @@ module RobustExcelOle
     def save
       raise ExcelErrorSave, "Not opened for writing (opened with :read_only option)" if @options[:read_only]
       if @workbook then
-        @workbook.Save 
+        begin
+          @workbook.Save 
+        rescue WIN32OLERuntimeError => msg
+          if msg.message =~ /SaveAs/ and msg.message =~ /Workbook/ then
+            raise ExcelErrorSave, "workbook not saved"
+          else
+            raise ExcelErrorSaveUnknown, "unknown WIN32OELERuntimeError:\n#{msg.message}"
+          end       
+        end
         true
       else
         nil
@@ -395,7 +454,7 @@ module RobustExcelOle
         when :raise
           raise ExcelErrorSave, "book already exists: #{File.basename(file)}"
         else
-          raise ExcelErrorSave, ":if_exists: invalid option"
+          raise ExcelErrorSave, ":if_exists: invalid option: #{@opts[:if_exists]}"
         end
       else
         save_as_workbook(file)
@@ -451,7 +510,9 @@ module RobustExcelOle
 
       new_sheet_name = opts.delete(:as)
 
-      after_or_before, base_sheet = opts.to_a.first || [:after, RobustExcelOle::Sheet.new(@workbook.Worksheets.Item(@workbook.Worksheets.Count))]
+      ws = @workbook.Worksheets
+      after_or_before, base_sheet = opts.to_a.first || 
+                                    [:after, Sheet.new(ws.Item(ws.Count))]
       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.Activesheet)
@@ -465,6 +526,9 @@ module RobustExcelOle
       new_sheet
     end        
 
+    def add_name name
+    end
+
     def self.book_store
       @@bookstore ||= BookStore.new
     end
@@ -495,13 +559,13 @@ module RobustExcelOle
   
 public
 
-  class ExcelErrorNValue < WIN32OLERuntimeError # :nodoc: #
+  class ExcelError < RuntimeError    # :nodoc: #
   end
 
-  class ExcelUserCanceled < RuntimeError # :nodoc: #
+  class ExcelErrorOpen < ExcelError   # :nodoc: #
   end
 
-  class ExcelError < RuntimeError    # :nodoc: #
+  class ExcelErrorClose < ExcelError    # :nodoc: #
   end
 
   class ExcelErrorSave < ExcelError   # :nodoc: #
@@ -513,12 +577,15 @@ public
   class ExcelErrorSaveUnknown < ExcelErrorSave  # :nodoc: #
   end
 
-  class ExcelErrorOpen < ExcelError   # :nodoc: #
+  class ExcelErrorRename < WIN32OLERuntimeError # :nodoc: #
   end
 
-  class ExcelErrorClose < ExcelError    # :nodoc: #
+  class ExcelErrorNValue < WIN32OLERuntimeError # :nodoc: #
   end
 
+  class ExcelUserCanceled < RuntimeError # :nodoc: #
+  end
+  
   class ExcelErrorSheet < ExcelError    # :nodoc: #
   end
 

data/lib/robust_excel_ole/excel.rb

@@ -62,15 +62,26 @@ module RobustExcelOle
       result
     end
 
-    def initialize(options= {}) # :nodoc:
+    def initialize(options= {}) # :nodoc: #
     end
 
     # generate, save and close an empty workbook
     def generate_workbook file_name                  
       self.Workbooks.Add                           
-      empty_workbook = self.Workbooks.Item(1)          
-      filename = RobustExcelOle::absolute_path(file_name)
-      empty_workbook.SaveAs(filename.gsub("/","\\"))  
+      empty_workbook = self.Workbooks.Item(self.Workbooks.Count)          
+      filename = RobustExcelOle::absolute_path(file_name).gsub("/","\\")
+      unless File.exists?(filename)
+        begin
+          empty_workbook.SaveAs(filename) 
+        rescue WIN32OLERuntimeError => msg
+          if msg.message =~ /SaveAs/ and msg.message =~ /Workbook/ then
+            raise ExcelErrorSave, "could not save workbook with filename #{file_name}"
+          else
+            # todo some time: find out when this occurs : 
+            raise ExcelErrorSaveUnknown, "unknown WIN32OELERuntimeError with filename #{file_name}: \n#{msg.message}"
+          end
+        end      
+      end
       empty_workbook                               
     end
 
@@ -230,8 +241,4 @@ module RobustExcelOle
     end
 
   end  
-
-
-
-
 end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/spec/book_spec.rb

@@ -16,7 +16,6 @@ describe Book do
     Excel.close_all
   end
 
-
   before do
     @dir = create_tmpdir
     @simple_file = @dir + '/workbook.xls'
@@ -24,6 +23,7 @@ describe Book do
     @different_file = @dir + '/different_workbook.xls'
     @simple_file_other_path = @dir + '/more_data/workbook.xls'
     @more_simple_file = @dir + '/more_workbook.xls'
+    @connected_file = @dir + '/workbook.xlsx'
   end
 
   after do
@@ -31,7 +31,6 @@ describe Book do
     rm_tmp(@dir)
   end
 
-
   describe "create file" do
     context "with standard" do
       it "open an existing file" do
@@ -46,6 +45,13 @@ describe Book do
   
   describe "open" do
 
+    context "with connected workbook" do
+      it "should open connected workbook" do
+        book = Book.open(@connected_file, :visible => true)
+        book.close
+      end
+    end
+
     context "standard use cases" do
 
       it "should read in a seperate excel instance" do
@@ -238,12 +244,20 @@ describe Book do
         book4.Readonly.should == true
         book4.should_not == book2 
         book4.close
+        book5 = Book.open(@simple_file, :force_excel => book2)
+        book5.should be_alive
+        book5.should be_a Book
+        book5.excel.should == book2.excel
+        book5.Readonly.should == true
+        book5.should_not == book2 
+        book5.close
         book3.close
       end
 
       it "should open in a given Excel, provide identity transparency, because book can be readonly, such that the old and the new book are readonly" do
         book2 = Book.open(@simple_file, :force_excel => :new)
         book2.excel.should_not == @book.excel
+        p "book2.excel: #{book2.excel}"
         book3 = Book.open(@simple_file, :force_excel => :new)
         book3.excel.should_not == book2.excel
         book3.excel.should_not == @book.excel
@@ -257,9 +271,30 @@ describe Book do
         book4.ReadOnly.should be_true
         book4.should == book2
         book4.close
+        book5 = Book.open(@simple_file, :force_excel => book2, :read_only => true)
+        book5.should be_alive
+        book5.should be_a Book
+        book5.excel.should == book2.excel
+        book5.ReadOnly.should be_true
+        book5.should == book2
+        book5.close
         book3.close
       end
 
+      it "should open in a given Excel, provide identity transparency, because book can be readonly, such that the old and the new book are readonly" do
+        book2 = Book.open(@simple_file, :force_excel => :new)
+        book2.excel.should_not == @book.excel
+        book2.close
+        @book.close
+        book4 = Book.open(@simple_file, :force_excel => book2, :read_only => true)
+        book4.should be_alive
+        book4.should be_a Book
+        book4.excel.should == book2.excel
+        book4.ReadOnly.should be_true
+        book4.should == book2
+        book4.close
+      end
+
       it "should do force_excel even if both force_ and default_excel is given" do
         book2 = Book.open(@simple_file, :default_excel => @book.excel, :force_excel => :new)
         book2.should be_alive
@@ -390,6 +425,17 @@ describe Book do
         book2.close
       end
 
+      it "should open a given excel, if the book cannot be reopened" do
+        @book.close
+        new_excel = Excel.new(:reuse => false)
+        book2 = Book.open(@different_file, :default_excel => @book)
+        book2.should be_alive
+        book2.should be_a Book
+        book2.excel.should_not == new_excel
+        book2.excel.should == @book.excel
+        book2.close
+      end
+
       it "should reuse an open book by default" do
         book2 = Book.open(@simple_file)
         book2.excel.should == @book.excel
@@ -482,7 +528,7 @@ describe Book do
       it "should raise an error, if :if_unsaved is invalid option" do
         expect {
           @new_book = Book.open(@simple_file, :if_unsaved => :invalid_option)
-        }.to raise_error(ExcelErrorOpen, ":if_unsaved: invalid option")
+        }.to raise_error(ExcelErrorOpen, ":if_unsaved: invalid option: invalid_option")
       end
     end
 
@@ -511,7 +557,7 @@ describe Book do
           it "should raise an error, if :if_obstructed is :raise" do
             expect {
               @new_book = Book.open(@simple_file, :if_obstructed => :raise)
-            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path")
+            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path: workbook.xls")
           end
 
           it "should close the other book and open the new book, if :if_obstructed is :forget" do
@@ -535,7 +581,7 @@ describe Book do
               if :if_obstructed is :close_if_saved" do
             expect{
               @new_book = Book.open(@simple_file, :if_obstructed => :close_if_saved)
-            }.to raise_error(ExcelErrorOpen, "book with the same name in a different path is unsaved")
+            }.to raise_error(ExcelErrorOpen, "book with the same name in a different path is unsaved: workbook.xls")
             @book.save
             @new_book = Book.open(@simple_file, :if_obstructed => :close_if_saved)
             @book.should_not be_alive
@@ -557,13 +603,13 @@ describe Book do
           it "should raise an error, if :if_obstructed is default" do
             expect {
               @new_book = Book.open(@simple_file)
-            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path")
+            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path: workbook.xls")
           end         
 
           it "should raise an error, if :if_obstructed is invalid option" do
             expect {
               @new_book = Book.open(@simple_file, :if_obstructed => :invalid_option)
-            }.to raise_error(ExcelErrorOpen, ":if_obstructed: invalid option")
+            }.to raise_error(ExcelErrorOpen, ":if_obstructed: invalid option: invalid_option")
           end
         end
       end
@@ -620,7 +666,7 @@ describe Book do
 
       it "should create a workbook by default" do
         File.delete @simple_save_file rescue nil
-        book = Book.open(@simple_save_file, :if_absent => :create)
+        book = Book.open(@simple_save_file)
         book.should be_a Book
         book.close
         File.exist?(@simple_save_file).should be_true
@@ -822,6 +868,13 @@ describe Book do
 
     context "with no open book" do
 
+      it "should open unobtrusively if no Excel is open" do
+        Excel.close_all
+        Book.unobtrusively(@simple_file, :if_closed => :reuse) do |book|
+          book.should be_a Book
+        end
+      end
+
       it "should open unobtrusively in a new Excel" do
         expect{ unobtrusively_ok? }.to_not raise_error
       end
@@ -855,9 +908,38 @@ describe Book do
           book.should be_a Book
           book.should be_alive
           book.excel.should_not == excel
+          book.excel.should == new_excel
+        end
+      end
+
+      it "should open unobtrusively in a given Excel via a book" do
+        book1 = Book.open(@different_file)
+        book2 = Book.open(@more_simple_file, :force_excel => :new)
+        Book.unobtrusively(@simple_file, :if_closed => book2) do |book|
+          book.should be_a Book
+          book.should be_alive
+          book.excel.should_not == book1.excel
+          book.excel.should == book2.excel
         end
       end
 
+      it "should raise an error if the excel instance is not alive" do
+        excel = Excel.new(:reuse => false)
+        new_excel = Excel.new(:reuse => false)
+        Excel.close_all
+        expect{
+          Book.unobtrusively(@simple_file, :if_closed => new_excel) do |book|
+          end
+        }.to raise_error(ExcelErrorOpen, "provided Excel instance is not alive")
+      end
+
+      it "should raise an error if the option is invalid" do
+        expect{
+          Book.unobtrusively(@simple_file, :if_closed => :invalid_option) do |book|
+          end
+        }.to raise_error(ExcelErrorOpen, "provided instance is neither an Excel nor a Book: invalid_option")
+      end
+
     end
 
     context "with an open book" do
@@ -1038,33 +1120,8 @@ describe Book do
           book.excel.should == new_excel
         end
       end
-
-      it "should use not the given excel if the Excels are closed" do
-        excel = Excel.new(:reuse => false)
-        sheet = @book[0]
-        old_cell_value = sheet[0,0].value
-        old_excel = @book.excel
-        @book.close
-        @book.should_not be_alive
-        Excel.close_all
-        Book.unobtrusively(@simple_file, :if_closed => excel, :keep_open => true) do |book|
-          book.should be_a Book
-          book.excel.should_not == old_excel
-          book.excel.should == @book.excel
-          book.excel.should_not == excel
-          sheet = book[0]
-          cell = sheet[0,0]
-          sheet[0,0] = cell.value == "simple" ? "complex" : "simple"
-          book.Saved.should be_false
-        end
-        @book.should be_alive
-        new_book = Book.open(@simple_file)
-        sheet = new_book[0]
-        sheet[0,0].value.should_not == old_cell_value
-      end
     end
 
-
     context "with a read_only book" do
 
       before do
@@ -1405,24 +1462,6 @@ describe Book do
         @book1.excel.Visible.should be_true
       end
 
-      it "should open the book unobtrusively visible" do
-        @book1 = Book.open(@simple_file)
-        @book1.excel.Visible.should be_false
-        Book.unobtrusively(@simple_file, :visible => true) do |book| 
-          book.excel.Visible.should be_true
-        end
-        @book1.excel.Visible.should be_false
-      end
-
-      it "should open the book unobtrusively invisible" do
-        @book1 = Book.open(@simple_file, :visible => true)
-        @book1.excel.Visible.should be_true
-        Book.unobtrusively(@simple_file, :visible => false) do |book| 
-          book.excel.Visible.should be_false
-        end
-        @book1.excel.Visible.should be_true
-      end
-
     end
 
     context "with several Excel instances" do
@@ -1576,8 +1615,10 @@ describe Book do
     end
   end
 
-  describe "nvalue" do
-    context "with standard" do
+  describe "nvalue, set_nvalue, rename_range" do
+    
+    context "nvalue" do
+    
       before do
         @book1 = Book.open(@more_simple_file)
       end
@@ -1606,6 +1647,42 @@ describe Book do
         }.to raise_error(ExcelErrorNValue, "range error in more_workbook.xls")
       end
     end
+
+    context "set_nvalue" do
+    
+      before do
+        @book1 = Book.open(@more_simple_file)
+      end
+
+      after do
+        @book1.close(:if_unsaved => :forget)
+      end   
+
+      it "should set value of a range" do
+        @book1.nvalue("new").should == "foo"
+        @book1.set_nvalue("new","bar")
+        @book1.nvalue("new").should == "bar"
+      end
+    end
+
+    context "rename_range" do
+    
+      before do
+        @book1 = Book.open(@more_simple_file)
+      end
+
+      after do
+        @book1.close(:if_unsaved => :forget)
+      end
+
+      it "should rename a range" do
+        @book1.rename_range("four","five")
+        @book1.nvalue("five").should == [[1,2],[3,4]]
+        expect {
+          @book1.rename_range("four","five")
+        }.to raise_error(ExcelErrorRename, "name four not in more_workbook.xls")
+      end
+    end
   end
 
   describe "close" do
@@ -1683,6 +1760,13 @@ describe Book do
         end
       end
 
+      it "should raise an error for invalid option" do
+        expect {
+          @book.close(:if_unsaved => :invalid_option)
+        }.to raise_error(ExcelErrorClose, ":if_unsaved: invalid option: invalid_option") 
+      end
+
+
       it "should save the book before close with option :save" do
         ole_workbook = @book.workbook
         excel = @book.excel
@@ -1749,6 +1833,7 @@ describe Book do
   describe "save" do
 
     context "with simple save" do
+      
       it "should save for a file opened without :read_only" do
         @book = Book.open(@simple_file)
         @book.add_sheet(@sheet, :as => 'a_name')
@@ -1767,6 +1852,7 @@ describe Book do
         }.to raise_error(ExcelErrorSave, "Not opened for writing (opened with :read_only option)")
         @book.close
       end
+
     end
 
     context "with open with read only" do
@@ -1959,7 +2045,7 @@ describe Book do
           @book.save_as(@simple_save_file)
           expect {
             @book.save_as(@simple_save_file, :if_exists => :invalid_option)
-            }.to raise_error(ExcelErrorSave, ':if_exists: invalid option')
+            }.to raise_error(ExcelErrorSave, ':if_exists: invalid option: invalid_option')
         end
       end
     end

data/spec/cell_spec.rb

@@ -20,7 +20,7 @@ describe RobustExcelOle::Cell do
 
   context "open simple.xls" do
     before do
-      @book = RobustExcelOle::Book.open(@dir + '/simple.xls', :read_only => true)
+      @book = RobustExcelOle::Book.open(@dir + '/workbook.xls', :read_only => true)
       @sheet = @book[1]
       @cell = @sheet[0, 0]
     end

data/spec/excel_spec.rb

@@ -15,6 +15,7 @@ module RobustExcelOle
     before do
       @dir = create_tmpdir
       @simple_file = @dir + '/simple.xls'
+      @invalid_name_file = 'b/simple.xls'
     end
 
     after do
@@ -56,23 +57,17 @@ module RobustExcelOle
 
       it "should create different excel" do
         excel2 = Excel.create
-        #puts "@excel1 #{@excel1.Hwnd}"
-        #puts "excel2  #{excel2.Hwnd}"
         excel2.Hwnd.should_not == @excel1.Hwnd
       end
 
       it "should reuse existing excel" do
         excel2 = Excel.current
-        #puts "@excel1 #{@excel1.Hwnd}"
-        #puts "excel2  #{excel2.Hwnd}"
         excel2.Hwnd.should == @excel1.Hwnd
       end
 
       it "should reuse existing excel with default options for 'new'" do
         excel2 = Excel.new
         excel2.should be_a Excel
-        #puts "@excel1 #{@excel1.Hwnd}"
-        #puts "excel2  #{excel2.Hwnd}"
         excel2.Hwnd.should == @excel1.Hwnd
       end
 
@@ -173,7 +168,6 @@ module RobustExcelOle
 
     end
 
-
     context "with displayalerts" do
       before do
         @excel1 = Excel.new(:displayalerts => true)
@@ -248,21 +242,56 @@ module RobustExcelOle
         
         before do
           @excel1 = Excel.create
+          @file_name = @dir + '/bar.xls'
         end
 
         it "should generate a workbook" do
-          excel = Excel.create
-          workbook = excel.generate_workbook(@simple_file)
-          p "workbook: #{workbook}"
+          workbook = @excel1.generate_workbook(@file_name)
+          workbook.should be_a WIN32OLE
+          workbook.Name.should == File.basename(@file_name)
+          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
+          workbook.Saved.should be_true
+          workbook.ReadOnly.should be_false
+          workbook.Sheets.Count.should == 3
+          workbooks = @excel1.Workbooks
+          workbooks.Count.should == 1
+        end
+
+        it "should generate the same workbook twice" do
+          workbook = @excel1.generate_workbook(@file_name)
           workbook.should be_a WIN32OLE
-          workbook.Name.should == File.basename(@simple_file)
-          workbook.FullName.should == RobustExcelOle::absolute_path(@simple_file)
+          workbook.Name.should == File.basename(@file_name)
+          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
           workbook.Saved.should be_true
           workbook.ReadOnly.should be_false
-          workbook.Sheets.Count == 1
-          workbooks = excel.Workbooks
+          workbook.Sheets.Count.should == 3
+          workbooks = @excel1.Workbooks
           workbooks.Count.should == 1
+          workbook2 = @excel1.generate_workbook(@file_name)
+          workbook2.should be_a WIN32OLE
+          workbooks = @excel1.Workbooks
+          workbooks.Count.should == 2
         end
+
+        it "should generate a workbook if one is already existing" do
+          book = Book.open(@simple_file)
+          workbook = @excel1.generate_workbook(@file_name)
+          workbook.should be_a WIN32OLE
+          workbook.Name.should == File.basename(@file_name)
+          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
+          workbook.Saved.should be_true
+          workbook.ReadOnly.should be_false
+          workbook.Sheets.Count.should == 3
+          workbooks = @excel1.Workbooks
+          workbooks.Count.should == 2
+        end
+
+        it "should raise error when book cannot be saved" do
+          expect{
+            workbook = @excel1.generate_workbook(@invalid_name_file)
+          }.to raise_error(ExcelErrorSaveUnknown)
+        end
+
       end
     end
   end
@@ -284,5 +313,5 @@ module RobustExcelOle
   end
 end
 
-class TestError < RuntimeError
+class TestError < RuntimeError  # :nodoc: #
 end

data/spec/range_spec.rb

@@ -12,7 +12,7 @@ describe RobustExcelOle::Range do
 
   before do
     @dir = create_tmpdir
-    @book = RobustExcelOle::Book.open(@dir + '/simple.xls')
+    @book = RobustExcelOle::Book.open(@dir + '/workbook.xls')
     @sheet = @book[1]
     @range = RobustExcelOle::Range.new(@sheet.sheet.UsedRange.Rows(1))
   end

data/spec/sheet_spec.rb

@@ -7,7 +7,7 @@ describe RobustExcelOle::Sheet do
   
   before do
     @dir = create_tmpdir
-    @book = RobustExcelOle::Book.open(@dir + '/simple.xls', :read_only => true)
+    @book = RobustExcelOle::Book.open(@dir + '/workbook.xls', :read_only => true)
     @sheet = @book[0]
   end
 
@@ -351,7 +351,7 @@ describe RobustExcelOle::Sheet do
     describe "nvalue" do
       context "with standard" do
         before do
-          @book1 = RobustExcelOle::Book.open(@dir + '/more_simple.xls', :read_only => true)
+          @book1 = RobustExcelOle::Book.open(@dir + '/more_workbook.xls', :read_only => true)
           @sheet1 = @book1[0]
         end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: robust_excel_ole
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - traths
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-06-10 00:00:00 +02:00
+date: 2015-07-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,11 @@ files:
 - TodoList.md
 - examples/edit_sheets/example_access_sheets_and_cells.rb
 - examples/edit_sheets/example_adding_sheets.rb
+- examples/edit_sheets/example_concating.rb
+- examples/edit_sheets/example_expanding.rb
+- examples/edit_sheets/example_naming.rb
 - examples/edit_sheets/example_ranges.rb
+- examples/edit_sheets/example_saving.rb
 - examples/open_save_close/example_control_to_excel.rb
 - examples/open_save_close/example_default_excel.rb
 - examples/open_save_close/example_force_excel.rb
@@ -70,7 +74,6 @@ files:
 - examples/open_save_close/example_reuse.rb
 - examples/open_save_close/example_simple.rb
 - examples/open_save_close/example_unobtrusively.rb
-- examples/save_sheets/example_save_sheets.rb
 - lib/robust_excel_ole.rb
 - lib/robust_excel_ole/book.rb
 - lib/robust_excel_ole/book_store.rb
@@ -91,12 +94,14 @@ files:
 - spec/data/book_with_blank.xls
 - spec/data/different_workbook.xls
 - spec/data/merge_cells.xls
-- spec/data/more_data/simple.xls
+- spec/data/more_data/workbook.xls
 - spec/data/more_workbook.xls
 - spec/data/protected_sheet.xls
 - spec/data/workbook.xls
 - spec/data/workbook.xlsm
 - spec/data/workbook.xlsx
+- spec/data/workbook_connected.xlsm
+- spec/data/workbook_connected_sub.xlsm
 - spec/excel_spec.rb
 - spec/helpers/create_temporary_dir.rb
 - spec/helpers/key_sender.rb

data/examples/save_sheets/example_save_sheets.rb

@@ -1,34 +0,0 @@
-# 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
-
-Excel.close_all
-begin
-  dir = create_tmpdir
-  suffix = '.xls'
-  book_name = dir + 'book_with_blank' 
-  book = Book.open(book_name + suffix)                   # open a book with several sheets
-  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.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
-    sheet_book.close                                            # close it
-  end
-  
- ensure                                                              
-  Excel.close_all                              # close workbooks, quit Excel application
-  rm_tmp(dir)
- end
-