robust_excel_ole 1.11 → 1.12

data/spec/workbook_specs/workbook_save_spec.rb

@@ -154,6 +154,23 @@ describe Workbook do
 
     end
 
+    context "with saving with the same name in another directory" do
+
+      before do
+        @book = Workbook.open(@simple_file1)
+      end
+
+      it "should save with the same name in another directory" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        File.exist?(@simple_file_other_path1).should be true
+        @book.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :forget)
+      end
+
+    end
+
     context "with blocked by another file" do
 
       before do
@@ -166,6 +183,156 @@ describe Workbook do
         @book2.close(:if_unsaved => :forget)
       end
 
+      it "should raise an error with :obstructed => :raise" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        File.exist?(@simple_file_other_path1).should be true
+        expect{
+          @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :raise)
+        }.to raise_error(WorkbookBlocked, /blocked by another workbook/)
+      end
+
+      it "should close the blocking workbook without saving, and save the current workbook with :if_blocked => :forget" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :forget)
+        @book.should_not be_alive
+        File.exist?(@simple_file_other_path1).should be true
+        new_book = Workbook.open(@simple_file_other_path1)
+        new_book.should be_a Workbook
+        new_book.close
+      end
+
+      it "should close the blocking workbook without saving even if it is unsaved with :if_blocked => :forget" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        sheet = @book.sheet(1)
+        cell_value = sheet[1,1].Value
+        sheet[1,1] = sheet[1,1].Value == "foo" ? "bar" : "foo"
+        @book.Saved.should be false
+        @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :forget)
+        @book.should_not be_alive
+        @book2.should be_alive
+        File.exist?(@simple_file_other_path1).should be true
+        new_book = Workbook.open(@simple_file_other_path1)
+        new_book.should be_a Workbook
+        new_book.close
+        old_book = Workbook.open(@simple_file1)
+        old_sheet = old_book.sheet(1)
+        old_sheet[1,1].Value.should == cell_value
+        old_book.close
+      end
+
+      it "should save and close the blocking workbook, and save the current workbook with :if_obstructed => :save" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        sheet = @book.sheet(1)
+        cell_value = sheet[1,1].Value
+        sheet[1,1] = sheet[1,1].Value == "foo" ? "bar" : "foo"
+        @book.Saved.should be false
+        @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :save)
+        @book.should_not be_alive
+        @book2.should be_alive
+        File.exist?(@simple_file_other_path1).should be true
+        new_book = Workbook.open(@simple_file_other_path1)
+        new_book.should be_a Workbook
+        new_book.close
+        old_book = Workbook.open(@simple_file1)
+        old_sheet = old_book.sheet(1)
+        old_sheet[1,1].Value.should_not == cell_value
+        old_book.close
+      end
+
+      it "should close the blocking workbook if it was saved, and save the current workbook with :if_obstructed => :close_if_saved" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        @book.Saved.should be true
+        @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :close_if_saved)
+        @book.should_not be_alive
+        @book2.should be_alive
+        File.exist?(@simple_file_other_path1).should be true
+        new_book = Workbook.open(@simple_file_other_path1)
+        new_book.should be_a Workbook
+        new_book.close
+      end
+
+      it "should raise an error if the blocking workbook was unsaved with :if_blocked => :close_if_saved" do
+        sheet = @book.sheet(1)
+        cell_value = sheet[1,1].Value
+        sheet[1,1] = sheet[1,1].Value == "foo" ? "bar" : "foo"
+        @book.Saved.should be false      
+        expect{
+          @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :close_if_saved)
+        }.to raise_error(WorkbookBlocked, /blocking workbook is unsaved: "workbook.xls"/)
+      end
+
+      it "should raise an error with an invalid option" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        File.exist?(@simple_file_other_path1).should be true
+        expect{
+          @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :invalid)
+        }.to raise_error(OptionInvalid, /invalid option/)
+        # }.to raise_error(OptionInvalid, ":if_blocked: invalid option: :invalid" +
+        #  "\nHint: Valid values are :raise, :forget, :save, :if_closed_saveo")
+      end
+
+      it "should raise an error by default" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        File.exist?(@simple_file_other_path1).should be true
+        expect{
+          @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite)
+        }.to raise_error(WorkbookBlocked, /blocked by another workbook/)
+      end
+
+      it "should raise an error if the file does not exist and an workbook with the same name and other path exists" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.exist?(@simple_file_other_path1).should be false
+        expect{
+          @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_blocked => :raise)
+          }.to raise_error(WorkbookBlocked, /blocked by another workbook/)
+      end
+
+      it "should raise an error if the file exists and an workbook with the same name and other path exists" do
+        File.delete @simple_file_other_path1 rescue nil
+        File.open(@simple_file_other_path1,"w") do | file |
+          file.puts "garbage"
+        end
+        File.exist?(@simple_file_other_path1).should be true
+        expect{
+          @book.save_as(@simple_file_other_path1, :if_exists => :raise, :if_blocked => :raise)
+        }.to raise_error(FileAlreadyExists, /file already exists: "workbook.xls"/)
+      end
+
+    end
+
+    context "with obstructed by another file" do
+
+      before do
+        @book = Workbook.open(@simple_file1)
+        @book2 = Workbook.open(@another_simple_file)
+      end
+
+      after do
+        @book.close(:if_unsaved => :forget)
+        @book2.close(:if_unsaved => :forget)
+      end
+
       it "should raise an error with :obstructed => :raise" do
         File.delete @simple_file_other_path1 rescue nil
         File.open(@simple_file_other_path1,"w") do | file |
@@ -177,7 +344,7 @@ describe Workbook do
         }.to raise_error(WorkbookBlocked, /blocked by another workbook/)
       end
 
-      it "should close the blocking workbook without saving, and save the current workbook with :if_obstructed => :forget" do
+      it "should close the blocking workbook without saving, and save the current workbook with :if_blocked => :forget" do
         File.delete @simple_file_other_path1 rescue nil
         File.open(@simple_file_other_path1,"w") do | file |
           file.puts "garbage"
@@ -234,7 +401,7 @@ describe Workbook do
         old_book.close
       end
 
-      it "should close the blocking workbook if it was saved, and save the current workbook with :if_obstructed => :close_if_saved" do
+      it "should close the blocking workbook if it was saved, and save the current workbook with :if_blokced => :close_if_saved" do
         File.delete @simple_file_other_path1 rescue nil
         File.open(@simple_file_other_path1,"w") do | file |
           file.puts "garbage"
@@ -249,7 +416,7 @@ describe Workbook do
         new_book.close
       end
 
-      it "should raise an error if the blocking workbook was unsaved with :if_obstructed => :close_if_saved" do
+      it "should raise an error if the blocking workbook was unsaved with :if_blocked => :close_if_saved" do
         sheet = @book.sheet(1)
         cell_value = sheet[1,1].Value
         sheet[1,1] = sheet[1,1].Value == "foo" ? "bar" : "foo"
@@ -267,8 +434,9 @@ describe Workbook do
         File.exist?(@simple_file_other_path1).should be true
         expect{
           @book2.save_as(@simple_file_other_path1, :if_exists => :overwrite, :if_obstructed => :invalid)
-        }.to raise_error(OptionInvalid, ":if_obstructed: invalid option: :invalid" +
-          "\nHint: Valid values are :raise, :overwrite, :alert, :excel")
+        }.to raise_error(OptionInvalid, /invalid option/)
+        #}.to raise_error(OptionInvalid, ":if_blocked: invalid option: :invalid" +
+        #  "\nHint: Valid values are :raise, :forget, :save, :save_if_closed")
       end
 
       it "should raise an error by default" do

data/spec/workbook_specs/workbook_sheet_spec.rb

@@ -191,47 +191,11 @@ describe Workbook do
     end
   end
 
-  describe "add_empty_sheet" do
-    
-    before do
-      @book = Workbook.open(@simple_file)
-      @sheet = @book.sheet(1)
-    end
-
-    after do
-      @book.close(:if_unsaved => :forget)
-    end
-
-    it "should add empty sheet" do
-      @book.ole_workbook.Worksheets.Count.should == 3
-      @book.add_empty_sheet
-      @book.ole_workbook.Worksheets.Count.should == 4
-    end
-
-    it "should add an empty sheet and return this added sheet" do
-      sheet = @book.add_empty_sheet
-      copyed_sheet = @book.ole_workbook.Worksheets.Item(@book.ole_workbook.Worksheets.Count)
-      sheet.name.should eq copyed_sheet.name
-    end
-
-    it "should return new sheet" do
-      @book.add_empty_sheet(:as => 'new sheet').name.should eq 'new sheet'
-    end
-
-    it "should add the first sheet" do
-      @book.add_empty_sheet(:before => @sheet).name.should eq @book.sheet(1).name
-    end
-
-    it "should add the second sheet" do
-      @book.add_empty_sheet(:after => @sheet).name.should eq @book.sheet(2).name
-    end
-  end  
-
   describe "copy_sheet" do
 
     before do
-      #@book = Workbook.open(@simple_file)
-      @book = Workbook.open(@file_with_references)
+      @book = Workbook.open(@simple_file)
+      @book2 = Workbook.open(@file_with_references)
       @sheet = @book.sheet(1)
       @another_book = Workbook.open(@another_simple_file)
     end
@@ -242,10 +206,10 @@ describe Workbook do
     end
 
     it "should copy the second sheet, append it and leave the references so far" do
-      @book.add_sheet(@book.sheet(2), :after => @book.sheet(3))
-      @book.sheet(1)[2,1].Value.should == "x"
-      @book.sheet(1)[2,2].Value.should == "y"
-      @book.sheet(1)[2,3].Value.should == "z"
+      @book2.add_sheet(@book2.sheet(2), :after => @book2.sheet(3))
+      @book2.sheet(1)[2,1].Value.should == "x"
+      @book2.sheet(1)[2,2].Value.should == "y"
+      @book2.sheet(1)[2,3].Value.should == "z"
     end
 
     it "should copy and append a given sheet" do

data/spec/workbook_specs/workbook_unobtr_spec.rb

@@ -53,222 +53,6 @@ describe Workbook do
       expect{unobtrusively_ok?}.to_not raise_error
     end
 
-=begin
-    describe "with already open Excel instances and workbooks" do
-
-      before do
-        @ole_excel1 = WIN32OLE.new('Excel.Application')
-        @ole_excel2 = WIN32OLE.new('Excel.Application')
-      end
-
-      context "with open unsaved workbook" do
-
-        before do        
-          @book1 = Workbook.open(@simple_file1)
-          @book1.sheet(1)[1,1] = "foo"
-          #@ole_workbook1 = @ole_excel1.Workbooks.Open(@simple_file1, { 'ReadOnly' => false })
-          #@old_value = @ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value
-          #@ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value = 
-          #  @old_value == "foo" ? "bar" : "foo"
-        end
-
-        context "with writability" do
-
-          it "should open as read-write by default" do
-            Workbook.unobtrusively(@simple_file1) do |book|
-              book.Readonly.should be false
-              #book.filename.should == @ole_workbook1.Fullname.tr('\\','/')
-              #book.excel.ole_excel.Hwnd.should == @ole_excel1.Hwnd
-              book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
-            end
-            #@ole_workbook1.Saved.should be false
-            Excel.kill_all
-            sleep 1
-            book2 = Workbook.open(@simple_file1)
-            #book2.sheet(1)[1,1].Value.should == @old_value
-          end
-
-          it "should open not writable" do
-            Workbook.unobtrusively(@simple_file1, :writable => false) do |book|
-              book.ReadOnly.should be false
-              book.filename.should == @ole_workbook1.Fullname.tr('\\','/')
-              book.excel.ole_excel.Hwnd.should == @ole_excel1.Hwnd
-              book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
-            end
-            @book.Saved.should be false
-            @book.sheet(1)[1,1].Value.should_not == @old_value
-            Excel.kill_all
-            sleep 1
-            book2 = Workbook.open(@simple_file1)
-            book2.sheet(1)[1,1].Value.should_not == @old_value
-          end
-        end
-
-        context "further tests" do
-
-          it "should write in the outer and not in the inner block" do
-            Workbook.unobtrusively(@simple_file1) do |book|
-              @old_value = book.sheet(1)[1,1].Value
-              book.ReadOnly.should be false
-              book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo" 
-              book.Saved.should be false
-              book.sheet(1)[1,1].Value.should_not == @old_value
-              Workbook.unobtrusively(@simple_file1, :writable => false) do |book2|
-                book2.should == book
-                book2.ReadOnly.should be false
-                book2.Saved.should be false
-                book2.sheet(1)[1,1].Value.should_not == @old_value
-                book2.sheet(1)[1,1] = book2.sheet(1)[1,1].Value == "foo" ? "bar" : "foo" 
-                book2.sheet(1)[1,1].Value.should == @old_value
-              end
-              book.should be_alive
-              book.Saved.should be false
-              book.sheet(1)[1,1].Value.should == @old_value            
-            end
-            book = Workbook.open(@simple_file1)
-            book.sheet(1)[1,1].Value.should == @old_value
-          end
-
-          it "should use the excel of the book and keep open the book" do
-            @book = Workbook.open(@simple_file1)
-            excel = Excel.new(:reuse => false)
-            sheet = @book.sheet(1)
-            old_cell_value = sheet[1,1].Value
-            @book.close
-            @book.should_not be_alive
-            Workbook.unobtrusively(@simple_file, :keep_open => true) do |book|
-              book.should be_a Workbook
-              book.excel.should == @book.excel
-              book.excel.should_not == excel
-              sheet = book.sheet(1)
-              cell = sheet[1,1]
-              sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-              book.Saved.should be false
-            end
-            @book.should be_alive
-            @book.close
-            new_book = Workbook.open(@simple_file1)
-            sheet = new_book.sheet(1)
-            sheet[1,1].Value.should_not == old_cell_value
-          end
-
-          it "should use the excel of the book and keep open the book" do
-            @book = Workbook.open(@simple_file1)
-            excel = Excel.new(:reuse => false)
-            sheet = @book.sheet(1)
-            old_cell_value = sheet[1,1].Value
-            @book.close
-            @book.should_not be_alive
-            Workbook.unobtrusively(@simple_file, :if_closed => :new) do |book|
-              book.should be_a Workbook
-              book.should be_alive
-              book.excel.should_not == @book.excel
-              book.excel.should_not == excel
-              sheet = book.sheet(1)
-              cell = sheet[1,1]
-              sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-              book.Saved.should be false
-            end
-            @book.should_not be_alive
-            new_book = Workbook.open(@simple_file1)
-            sheet = new_book.sheet(1)
-            sheet[1,1].Value.should_not == old_cell_value
-          end
-
-          it "should use a given Excel" do
-            @book = Workbook.open(@simple_file1)
-            @book.close
-            new_excel = Excel.new(:reuse => false)
-            another_excel = Excel.new(:reuse => false)
-            Workbook.unobtrusively(@simple_file1, :if_closed => another_excel) do |book|
-              book.excel.should_not == @book.excel
-              book.excel.should_not == new_excel
-              book.excel.should == another_excel
-            end
-          end
-
-          it "should reuse Excel" do
-            new_excel = Excel.new(:reuse => false)
-            Workbook.unobtrusively(@simple_file1, :if_closed => :reuse) do |book|
-            book.excel.should == @book.excel
-            book.excel.should_not == new_excel
-          end
-
-          it "should open unobtrusively the closed book in the most recent Excel where it was open before" do      
-            @book1 = Workbook.open(@simple_file1)
-            @book2 = Workbook.open(@simple_file1, :force_excel => :new)
-            @book1.Readonly.should == false
-            @book2.Readonly.should == true
-            old_sheet = @book1.sheet(1)
-            @old_cell_value = old_sheet[1,1].Value
-            @book1.close
-            @book2.close
-            @book1.should_not be_alive
-            @book2.should_not be_alive
-            Workbook.unobtrusively(@simple_file1) do |book| 
-              book.excel.should_not == @book2.excel
-              book.excel.should == @book1.excel
-              book.ReadOnly.should == false
-              sheet = book.sheet(1)
-              cell = sheet[1,1]
-              sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-              book.Saved.should be false
-            end
-            new_book = Workbook.open(@simple_file1)
-            sheet = new_book.sheet(1)
-            sheet[1,1].Value.should_not == @old_cell_value
-          end
-        end
-      end
-
-      context "with open unsaved read-only workbook" do
-
-        before do        
-          @ole_workbook1 = @ole_excel1.Workbooks.Open(@simple_file1, { 'ReadOnly' => true })
-          @old_value = @ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value
-          @ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value = 
-            @old_value == "foo" ? "bar" : "foo"
-        end
-
-        context "with writability" do
-
-          it "should open as read-only by default" do
-            Workbook.unobtrusively(@simple_file1) do |book|
-              book.Readonly.should be true
-              book.filename.should == @ole_workbook1.Fullname.tr('\\','/')
-              book.excel.ole_excel.Hwnd.should == @ole_excel1.Hwnd
-              book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
-            end
-            @ole_workbook1.Saved.should be false
-            @ole_workbook1.ReadOnly.should be true          
-            @ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value.should_not == @old_value
-            Excel.kill_all
-            sleep 1
-            book2 = Workbook.open(@simple_file1)
-            book2.sheet(1)[1,1].Value.should_not == @old_value
-          end
-
-          it "should open not writable" do
-            Workbook.unobtrusively(@simple_file1, :writable => false) do |book|
-              book.ReadOnly.should be true
-              book.filename.should == @ole_workbook1.Fullname.tr('\\','/')
-              book.excel.ole_excel.Hwnd.should == @ole_excel1.Hwnd
-              book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
-            end
-            @ole_workbook1.Saved.should be false
-            @ole_workbook1.ReadOnly.should be true          
-            @ole_workbook1.Worksheets.Item(1).Cells.Item(1, 1).Value.should_not == @old_value
-            Excel.kill_all
-            sleep 1
-            book2 = Workbook.open(@simple_file1)
-            book2.sheet(1)[1,1].Value.should == @old_value
-          end
-        end
-      end
-    end
-  end
-=end
-
     describe "block transparency" do
 
       it "should return correct value of the block" do
@@ -314,28 +98,6 @@ describe Workbook do
 
     end
 
-    describe "connecting to unknown workbooks" do
-
-      context "with one unknown workbook" do
-
-        before do
-          ole_e1 = WIN32OLE.new('Excel.Application')
-          ws = ole_e1.Workbooks
-          abs_filename = General.absolute_path(@simple_file1).tr('/','\\')
-          @ole_wb = ws.Open(abs_filename)
-        end
-
-        it "should connect to an unknown workbook" do
-          Workbook.unobtrusively(@simple_file1) do |book|
-            book.filename.should == @simple_file1
-            book.excel.ole_excel.Hwnd.should == @ole_wb.Application.Hwnd
-          end
-        end
-
-      end
-
-    end
-
     describe "writability" do
 
       context "with no book" do
@@ -618,7 +380,7 @@ describe Workbook do
 
         it "should force to read-write" do
           Workbook.unobtrusively(@simple_file1, :writable => true) do |book|
-            book.Readonly.should be false
+            book.ReadOnly.should be false
             book.should == @book
             book.filename.should == @book.filename
             book.excel.should == @book.excel
@@ -1263,11 +1025,12 @@ describe Workbook do
       end
 
       it "should open in another Excel instance if the given Excel instance is not alive" do
-        Excel.kill_all
+        @excel1.close
         sleep 2
         expect{
           Workbook.unobtrusively(@simple_file, :if_closed => @excel2) do |book|
             book.should be_alive
+            book.excel.should == @excel2
           end
         }.to_not raise_error
       end
@@ -1555,18 +1318,18 @@ describe Workbook do
           book.excel.displayalerts.should == :if_visible
           @another_excel = book.excel
         end
-        Workbook.unobtrusively(@simple_file1, :if_closed => :reuse) do |book|
-          book.excel.should == @book.excel
+        Workbook.unobtrusively(@simple_file1, :if_closed => :current) do |book|
+          book.excel.should_not == @book.excel
           book.excel.should_not == new_excel
+          book.excel.should == @another_excel
           book.excel.visible.should be false
           book.excel.displayalerts.should == :if_visible
-          book.excel.should_not == @another_excel 
         end
       end
 
       it "should reuse Excel" do
         new_excel = Excel.new(:reuse => false)
-        Workbook.unobtrusively(@simple_file1, :if_closed => :reuse) do |book|
+        Workbook.unobtrusively(@simple_file1, :if_closed => :current) do |book|
           book.excel.should == @book.excel
           book.excel.should_not == new_excel
         end
@@ -1863,8 +1626,8 @@ describe Workbook do
 
       it "should open unobtrusively the closed book in the most recent Excel where it was open before" do      
         Workbook.unobtrusively(@simple_file1) do |book| 
-          book.excel.should_not == @book2.excel
-          book.excel.should == @book1.excel
+          book.excel.should == @book2.excel
+          book.excel.should_not == @book1.excel
           book.ReadOnly.should == false
           sheet = book.sheet(1)
           cell = sheet[1,1]