robust_excel_ole 0.2.0.7 → 0.2.0.8

data/README.rdoc

@@ -47,7 +47,7 @@ Options are the following:
 [:displayalerts] boolean (default: false). allow display alerts in Excel   
 [:visible]       boolean (default: false). make visibe in Excel                  
 [:if_unsaved]    :raise (default), :accept, :forget, :new_app, :excel
-[:if_blocked_other_book]  :raise (default), :save, :forget, :new_app
+[:if_blocking_other]  :raise (default), :forget, :save_and_close, :close_or_raise, :new_app
                          
 
 The option :if_unsaved  : 
@@ -60,12 +60,13 @@ If an unsaved book with the same name is open, then
 [:new_app] Open the new book in a new Excel application
 [:excel]   Give control to Excel.
 
-The option :if_blocked_other_book :
-
+The option :if_blocking_other :
 If a book with same name in a different path is open, then
                  
 [:raise]   Raise an exception. Don't open the book.
 [:forget]  Close the old book, open the new book.
+[:save_and_close]  Save the old book, close it, open the new book
+[:close_or_raise] Close the old book and open the new book, if the old book is saved, raise an exception otherwise
 [:new_app] Open the new book in a new Excel application.
 
 
@@ -111,7 +112,8 @@ The option :if_exists :
 If a book with the file name already exists, then
 
 [:raise]     Raise an exeption. Don't write the file.
-[:overwrite] Delete the existing file and write the file. If the book is open in an Excel application, then raise an exeption.
+[:overwrite] Delete the existing file and write the file. 
+             If the book is open in an Excel application, then raise an exeption.
 [:excel]     Give the control to Excel.
 
 

data/examples/example1.rb

@@ -6,8 +6,11 @@ module RobustExcelOle
 
 	ExcelApp.close_all
 	begin
-	  filename = '../spec/data/simple.xls'
-	  book = RobustExcelOle::Book.open(filename)
+	  simple_file = '../spec/data/simple.xls'
+	  simple_save_file = '../spec/data/simple_save.xls'
+	  File.delete @simple_save_file rescue nil
+      #FileUtils.copy simple_file, simple_save_file
+	  book = RobustExcelOle::Book.open(simple_save_file)
 	  sheet = book[0]
 	  cell = sheet[0,0]
 	  i = 0

data/examples/example6.rb

@@ -0,0 +1,34 @@
+# example 6: open with :if_unsaved => :forget, :new_app, close with :if_unsaved => :save 
+
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+module RobustExcelOle
+
+    ExcelApp.close_all
+    begin
+	  file_name = '../spec/data/simple.xls' 
+	  book = RobustExcelOle::Book.open(file_name)                      # open a book
+	  ExcelApp.reuse_if_possible.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 = RobustExcelOle::Book.open(file_name, :if_unsaved => :forget) # open another book with the same file name 
+	                                                                          # and close the unsaved book without saving it
+	  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 a new Excel application, and make Excel visible
+	  another_book = RobustExcelOle::Book.open(file_name, :if_unsaved => :new_app, :visible => true)  
+	  sleep 3                                                                  # leaving the unsaved book open  
+	  new_book.close(:if_unsaved => :forget )                                  # close the unsaved book without saving it
+	  another_book.close
+	ensure
+  	  ExcelApp.close_all                                    # close workbooks, quit Excel application
+	end
+
+end

data/examples/example7.rb

@@ -0,0 +1,41 @@
+# example 7: open, close, save  with giving control to Excel 
+
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+module RobustExcelOle
+
+    ExcelApp.close_all
+    begin
+	  file_name = '../spec/data/simple.xls' 
+	  book = RobustExcelOle::Book.open(file_name, :visible => true)          # open a book
+	  ExcelApp.reuse_if_possible.Visible = true                              # make Excel visible 
+	  sleep 1
+	  sheet = book[0]                                                        # access a sheet
+	  sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"       # change a cell
+	  sleep 1
+	  begin
+	    new_book = RobustExcelOle::Book.open(file_name, :if_unsaved => :excel) # open another book with the same file name 
+	  rescue ExcelUserCanceled => msg                                          # if the user chooses not open the book,
+	  	puts "#{msg.message}"                                                  #   an exeptions is raised
+	  end
+	  puts "new book has opened" if new_book
+	  ExcelApp.reuse_if_possible.Visible = true
+	  begin
+	  	book.close(:if_unsaved => :excel)                              # close the unsaved book. 
+	  rescue ExcelUserCanceled => msg                                  # user is asked whether the unsaved book shall be saved
+	  	puts "#{msg.message}"                                          # if the user chooses to cancel, then an expeption is raised
+	  end
+	  if new_book then
+	  	begin
+	  	  new_book.save_as(file_name, :if_exists => :excel)            # save the new book, if it was opened
+	  	rescue ExcelErrorSave => msg                                    # user is asked, whether the existing file shall be overwritten
+	  	  puts "save_as: #{msg.message}"                               # if the user chooses "no" or "cancel", an exception is raised
+	  	end 
+
+	  	new_book.close                                         # close the new book, if the user chose to open it
+	  end
+	ensure                                                              
+  	  ExcelApp.close_all                                    # close workbooks, quit Excel application
+	end
+
+end

data/examples/example8.rb

@@ -0,0 +1,32 @@
+# example 8: open with :if_blocking_other:
+
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+module RobustExcelOle
+
+    ExcelApp.close_all
+    begin
+      dir = '../spec/data/'
+	  file_name = dir + 'simple.xls'
+	  other_dir = '../spec/data/more_data/'
+	  other_file_name = other_dir + 'simple.xls'
+	  book = RobustExcelOle::Book.open(file_name, :visible => true)     # open a book, make Excel application visible
+	  sleep 3 
+	  begin
+	    new_book = RobustExcelOle::Book.open(other_file_name)   # open a book with the same file name in a different path
+      rescue ExcelErrorOpen => msg                            # by default: raises an exception 
+      	puts "open: #{msg.message}"
+      end
+      # open a new book with the same file name in a different path. close the old book before.
+      new_book = RobustExcelOle::Book.open(other_file_name, :if_blocking_other => :forget) 
+      # open another book with the same file name in a different path. Use a new Excel application
+      sleep 3
+      another_book = RobustExcelOle::Book.open(file_name, :if_blocking_other => :new_app, :visible => true)                                         
+	  sleep 3
+	  new_book.close                                        # close the books                      
+	  another_book.close
+	ensure
+  	  ExcelApp.close_all                                    # close workbooks, quit Excel application
+	end
+
+end

data/examples/example9.rb

@@ -0,0 +1,13 @@
+# example 9: save the sheets of a book as separate books
+
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+module RobustExcelOle
+
+    ExcelApp.close_all
+    begin
+	ensure                                                              
+  	  ExcelApp.close_all                                    # close workbooks, quit Excel application
+	end
+
+end

data/lib/robust_excel_ole/book.rb

@@ -17,14 +17,17 @@ module RobustExcelOle
       #  :displayalerts (boolean)  allow display alerts in Excel         (default: false)
       #  :visible       (boolean)  make visibe in Excel                  (default: false)
       #  :if_unsaved    if an unsaved book with the same name is open, then
-      #                 :raise   -> raise an exception                   (default)             
+      #                 :raise   -> raise an exception                   (default)
+      #                 :forget  -> close the unsaved book, open the new book             
       #                 :accept  -> let the unsaved book open                  
-      #                 :forget  -> close the unsaved book, open the new book
       #                 :excel   -> give control to excel
       #                 :new_app -> open the new book in a new excel application
-      #  :if_blocked_other_book   if a book with the same name in a different path is open, then
+      #  :if_blocking_other   if a book with the same name in a different path is open, then
       #                  :raise   -> raise an exception                  (default)             
-      #                  :forget  -> close the unsaved book, open the new book
+      #                  :forget  -> close the old book, open the new book
+      #                  :save_and_close -> save the old book, close it, open the new book
+      #                  :close_or_raise -> close the old book and open the new book, if the old book is saved
+      #                                     raise an exception otherwise
       #                  :new_app -> open the new book in a new excel application
       def open(file, options={ :reuse => true}, &block)
         new(file, options, &block)
@@ -37,10 +40,10 @@ module RobustExcelOle
         :reuse => true,
         :read_only => false,
         :if_unsaved => :raise,
-        :if_blocked_other_book => :raise
+        :if_blocking_other => :raise
       }.merge(opts)
       excel_app_options = {:reuse => true}.merge(opts).delete_if{|k,v| 
-        k== :read_only || k== :if_unsaved || k == :if_blocked_other_book}
+        k== :read_only || k== :if_unsaved || k == :if_blocking_other}
       if not File.exist?(file)
         raise ExcelErrorOpen, "file #{file} not found"
       end
@@ -51,17 +54,26 @@ module RobustExcelOle
         blocked_by_other_book = (File.basename(file) == File.basename(@workbook.Fullname)) && 
                                 (not (absolute_path(file) == @workbook.Fullname))
         if blocked_by_other_book then
-          case @options[:if_blocked_other_book]
+          case @options[:if_blocking_other]
           when :raise
-            raise ExcelErrorOpen, "blocked by an unsaved book with the same name in a different path"
+            raise ExcelErrorOpen, "blocked by a book with the same name in a different path"
           when :forget
             @workbook.Close
+          when :save_and_close
+            save unless @workbook.Saved
+            @workbook.Close
+          when :close_or_raise
+            if (not @workbook.Saved) then
+              raise ExcelErrorOpen, "book with the same name in a different path is unsaved"
+            else 
+              @workbook.Close
+            end
           when :new_app
             excel_app_options[:reuse] = false
             @excel_app = ExcelApp.new(excel_app_options)
             @workbook = nil
           else
-            raise ExcelErrorOpen, ":if_blocked_other_book: invalid option"
+            raise ExcelErrorOpen, ":if_blocking_other: invalid option"
           end
         else
           # book open, not saved, not blocked by other book
@@ -70,10 +82,10 @@ module RobustExcelOle
             case @options[:if_unsaved]
             when :raise
               raise ExcelErrorOpen, "book is already open but not saved (#{File.basename(file)})"
-            when :accept
-              #nothing
             when :forget
               @workbook.Close
+            when :accept
+              #nothing
             when :excel
               old_displayalerts = @excel_app.DisplayAlerts  # :nodoc:
               @excel_app.DisplayAlerts = true  # :nodoc:

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.2.0.7"
+  VERSION = "0.2.0.8"
 end

data/spec/book_spec.rb

@@ -255,8 +255,11 @@ describe RobustExcelOle::Book do
     context "with a book in a different path" do
 
       before do
-        simple_file_other_path = @dir + '/more_data/simple.xls'
-        @book = RobustExcelOle::Book.open(simple_file_other_path)
+        @simple_file_other_path = @dir + '/more_data/simple.xls'
+        @book = RobustExcelOle::Book.open(@simple_file_other_path)
+        @sheet_count = @book.workbook.Worksheets.Count
+        @sheet = @book[0]
+        @book.add_sheet(@sheet, :as => 'a_name')
       end
 
       after do
@@ -264,38 +267,62 @@ describe RobustExcelOle::Book do
         @new_book.close rescue nil
       end
 
-      it "should raise an error, if :if_blocked_other_book is :raise" do
+      it "should raise an error, if :if_blocking_other is :raise" do
         expect {
-          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocked_other_book => :raise)
-        }.to raise_error(ExcelErrorOpen, "blocked by an unsaved book with the same name in a different path")
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :raise)
+        }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path")
+      end
+
+      it "should close the other book and open the new book, if :if_blocking_other is :forget" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :forget)
+        @book.should_not be_alive
+        @new_book.should be_alive
+        @new_book.filename.downcase.should == @simple_file.downcase
+      end
+
+      it "should save the old book, close it, and open the new book, if :if_blocking_other is :save_and_close" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :save_and_close)
+        @book.should_not be_alive
+        @new_book.should be_alive
+        @new_book.filename.downcase.should == @simple_file.downcase
+        new_book = RobustExcelOle::Book.open(@simple_file)
+        new_book.workbook.Worksheets.Count.should ==  @sheet_count
+        new_book.close
       end
 
-      it "should close the other book and open the new book, if :if_blocked_other_book is :forget" do
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocked_other_book => :forget)
+      it "should raise an error, if the old book is unsaved, and close the old book and open the new book, 
+          if :if_blocking_other is :close_or_raise" do
+        expect{
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :close_or_raise)
+        }.to raise_error(ExcelErrorOpen, "book with the same name in a different path is unsaved")
+        @book.save
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :close_or_raise)
         @book.should_not be_alive
         @new_book.should be_alive
         @new_book.filename.downcase.should == @simple_file.downcase
+        new_book = RobustExcelOle::Book.open(@simple_file_other_path, :if_blocking_other => :forget)
+        new_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
+        new_book.close
       end
 
-      it "should open the book in a new excel application, if :if_blocked_other_book is :new_app" do
-        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocked_other_book => :new_app)
+      it "should open the book in a new excel application, if :if_blocking_other is :new_app" do
+        @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :new_app)
         @book.should be_alive
         @new_book.should be_alive
         @new_book.filename.should_not == @book.filename
         @new_book.excel_app.should_not == @book.excel_app
-        @new_book.close
       end
 
-      it "should raise an error, if :if_blocked_other_book is default" do
+      it "should raise an error, if :if_blocking_other is default" do
         expect {
           @new_book = RobustExcelOle::Book.open(@simple_file)
-        }.to raise_error(ExcelErrorOpen, "blocked by an unsaved 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")
       end
 
-      it "should raise an error, if :if_blocked_other_book is invalid option" do
+      it "should raise an error, if :if_blocking_other is invalid option" do
         expect {
-          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocked_other_book => :invalid_option)
-        }.to raise_error(ExcelErrorOpen, ":if_blocked_other_book: invalid option")
+          @new_book = RobustExcelOle::Book.open(@simple_file, :if_blocking_other => :invalid_option)
+        }.to raise_error(ExcelErrorOpen, ":if_blocking_other: invalid option")
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: robust_excel_ole
 version: !ruby/object:Gem::Version 
-  hash: 81
+  hash: 79
   prerelease: false
   segments: 
   - 0
   - 2
   - 0
-  - 7
-  version: 0.2.0.7
+  - 8
+  version: 0.2.0.8
 platform: ruby
 authors: 
 - traths
@@ -137,6 +137,10 @@ files:
 - examples/example3.rb
 - examples/example4.rb
 - examples/example5.rb
+- examples/example6.rb
+- examples/example7.rb
+- examples/example8.rb
+- examples/example9.rb
 - lib/robust_excel_ole.rb
 - lib/robust_excel_ole/book.rb
 - lib/robust_excel_ole/cell.rb