robust_excel_ole 0.5.1 → 0.6

data/spec/book_specs/book_close_spec.rb

@@ -14,7 +14,7 @@ describe Book do
     excel = Excel.new(:reuse => true)
     open_books = excel == nil ? 0 : excel.Workbooks.Count
     puts "*** open books *** : #{open_books}" if open_books > 0
-    Excel.close_all
+    Excel.kill_all
   end
 
   before do
@@ -27,6 +27,7 @@ describe Book do
     @linked_file = @dir + '/workbook_linked.xlsm'
     @simple_file_xlsm = @dir + '/workbook.xls'
     @simple_file_xlsx = @dir + '/workbook.xlsx'
+    @simple_file1 = @simple_file
   end
 
   after do
@@ -51,7 +52,7 @@ describe Book do
 
     context "with unsaved read_only book" do
       before do
-        @book = Book.open(@simple_file, :read_only => true)
+        @book = Book.open(@simple_file1, :read_only => true)
         @sheet_count = @book.ole_workbook.Worksheets.Count
         @book.add_sheet(@sheet, :as => 'a_name')
       end
@@ -60,7 +61,7 @@ describe Book do
         expect{
           @book.close
           }.to_not raise_error
-        new_book = Book.open(@simple_file)
+        new_book = Book.open(@simple_file1)
         new_book.ole_workbook.Worksheets.Count.should ==  @sheet_count
         new_book.close
       end
@@ -68,7 +69,7 @@ describe Book do
 
     context "with unsaved book" do
       before do
-        @book = Book.open(@simple_file)
+        @book = Book.open(@simple_file1)
         @sheet_count = @book.ole_workbook.Worksheets.Count
         @book.add_sheet(@sheet, :as => 'a_name')
         @sheet = @book.sheet(1)
@@ -109,7 +110,7 @@ describe Book do
         @book.should_not be_alive
         expect{
           ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
-        new_book = Book.open(@simple_file)
+        new_book = Book.open(@simple_file1)
         begin
           new_book.ole_workbook.Worksheets.Count.should ==  @sheet_count
         ensure
@@ -134,7 +135,7 @@ describe Book do
         @book.should_not be_alive
         expect{
           ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
-        new_book = Book.open(@simple_file)
+        new_book = Book.open(@simple_file1)
         begin
           new_book.ole_workbook.Worksheets.Count.should == @sheet_count + 1
         ensure
@@ -174,7 +175,7 @@ describe Book do
               @book.should_not be_alive
               expect{ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
             end
-            new_book = Book.open(@simple_file, :if_unsaved => :forget)
+            new_book = Book.open(@simple_file1, :if_unsaved => :forget)
             begin
               new_book.ole_workbook.Worksheets.Count.should == @sheet_count + (answer==:yes ? 1 : 0)
               new_book.excel.DisplayAlerts.should == displayalert_value
@@ -217,7 +218,7 @@ describe Book do
               @book.should_not be_alive
               expect{ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
             end
-            new_book = Book.open(@simple_file, :if_unsaved => :forget)
+            new_book = Book.open(@simple_file1, :if_unsaved => :forget)
             begin
               new_book.ole_workbook.Worksheets.Count.should == @sheet_count + (answer==:yes ? 1 : 0)
               new_book.excel.DisplayAlerts.should == displayalert_value

data/spec/book_specs/book_misc_spec.rb

@@ -14,7 +14,7 @@ describe Book do
     excel = Excel.new(:reuse => true)
     open_books = excel == nil ? 0 : excel.Workbooks.Count
     puts "*** open books *** : #{open_books}" if open_books > 0
-    Excel.close_all
+    Excel.kill_all
   end
 
   before do
@@ -27,6 +27,7 @@ describe Book do
     @linked_file = @dir + '/workbook_linked.xlsm'
     @simple_file_xlsm = @dir + '/workbook.xls'
     @simple_file_xlsx = @dir + '/workbook.xlsx'
+    @simple_file1 = @simple_file
   end
 
   after do
@@ -46,6 +47,221 @@ describe Book do
     end
   end
 
+  describe "with visible" do
+
+    it "should preserve :visible if it is not set" do
+      book1 = Book.open(@simple_file)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should set :visible to false" do
+      book1 = Book.open(@simple_file, :visible => false)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should set :visible to true" do
+      book1 = Book.open(@simple_file, :visible => true)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should preserve :visible if they are set to visible" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@simple_file)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should preserve :visible if it is set to false" do
+      excel1 = Excel.create
+      book1 = Book.open(@simple_file, :visible => false)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should preserve :visible if it is not set" do
+      excel1 = Excel.create
+      book1 = Book.open(@simple_file)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should overwrite :visible to false" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@simple_file, :visible => false)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_false
+      book1.visible.should be_false
+    end
+
+    it "should overwrite :visible to true" do
+      excel1 = Excel.create(:visible => false)
+      book1 = Book.open(@simple_file, :visible => true)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should preserve :visible if it is not set with default_excel" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@simple_file)
+      book2 = Book.open(@different_file, :default_excel => :new)
+      book2.excel.Visible.should be_false
+      book2.Windows(book2.Name).Visible.should be_true
+      book2.visible.should be_false
+    end
+
+    it "should set :visible to true with default_excel" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@simple_file)
+      book2 = Book.open(@different_file, :default_excel => :new, :visible => true)
+      book2.excel.Visible.should be_true
+      book2.Windows(book2.Name).Visible.should be_true
+      book2.visible.should be_true
+    end
+
+    it "should set :visible to false with default_excel" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@simple_file)
+      book2 = Book.open(@different_file, :default_excel => :new, :visible => false)
+      book2.excel.Visible.should be_false
+      book2.Windows(book2.Name).Visible.should be_true
+      book2.visible.should be_false
+    end
+
+    it "should preserve :visible if it is set to true with default_excel" do
+      excel1 = Excel.create(:visible => true)
+      excel2 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :default_excel => excel2)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should overwrite :visible to false with default_excel" do
+      excel1 = Excel.create(:visible => true)
+      excel2 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :default_excel => excel2, :visible => false)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_false
+      book1.visible.should be_false
+    end
+
+    it "should preserve :visible if it is not set with force_excel => new" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => :new)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should set :visible to true with force_excel" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => :new, :visible => true)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should preserve :visible if it is not set with force_excel => excel" do
+      excel1 = Excel.create(:visible => true)
+      excel2 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => excel2)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should set visible to false with force_excel => excel" do
+      excel1 = Excel.create(:visible => true)
+      excel2 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => excel2, :visible => false)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_false
+      book1.visible.should be_false
+    end
+
+    it "should set visible to true with force_excel => excel" do
+      excel1 = Excel.create(:visible => true)
+      excel2 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => excel2, :visible => true)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should preserve :visible if it is set to true with force_excel => current" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => :current)      
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should set :visible to false with force_excel => current" do
+      excel1 = Excel.create(:visible => true)
+      book1 = Book.open(@different_file, :force_excel => :current, :visible => false)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_false
+      book1.visible.should be_false
+    end
+
+    it "should preserve :visible if it is set to false with force_excel => current" do
+      excel1 = Excel.create(:visible => false)
+      book1 = Book.open(@simple_file, :force_excel => :current)
+      book1.excel.Visible.should be_false
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+    end
+
+    it "should set :visible to false with force_excel => current" do
+      excel1 = Excel.create(:visible => false)
+      book1 = Book.open(@simple_file, :force_excel => :current, :visible => true)
+      book1.excel.Visible.should be_true
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_true
+    end
+
+    it "should let an open Book open" do
+      @book = Book.open(@simple_file1, :visible => true)
+      Book.unobtrusively(@simple_file1) do |book|
+        book.should be_a Book
+        book.should be_alive
+        book.excel.should == @book.excel
+        book.excel.Visible.should be_true
+      end        
+      @book.should be_alive
+      @book.should be_a Book
+      @book.excel.Visible.should be_true
+      @book.close(:if_unsaved => :forget)
+      @book2.close(:if_unsaved => :forget) rescue nil
+    end
+
+    it "should set visible and displayalerts if displayalerts => :if_visible" do
+      book1 = Book.open(@simple_file)
+      book1.excel.Visible.should be_false
+      book1.excel.displayalerts = :if_visible
+      book1.excel.displayalerts.should == :if_visible
+      book1.Windows(book1.Name).Visible.should be_true
+      book1.visible.should be_false
+      book2 = Book.open(@different_file, :visible => true)
+      book2.excel.Visible.should be_true
+      book2.Windows(book2.Name).Visible.should be_true
+      book2.visible.should be_true
+      book2.excel.visible.should be_true
+      book2.excel.displayalerts.should be_true
+      book2.excel.DisplayAlerts.should be_true
+    end
+  end
+
   describe "send methods to workbook" do
 
     context "with standard" do
@@ -84,7 +300,7 @@ describe Book do
     context "with some open book" do
 
       before do
-        @book = Book.open(@simple_file)
+        @book = Book.open(@simple_file1)
       end
 
       after do
@@ -92,10 +308,10 @@ describe Book do
       end
 
       it "should create and use a hidden Excel instance" do
-        book2 = Book.open(@simple_file, :force_excel => @book.bookstore.hidden_excel)
+        book2 = Book.open(@simple_file1, :force_excel => @book.bookstore.hidden_excel)
         book2.excel.should_not == @book.excel
         book2.excel.visible.should be_false
-        book2.excel.displayalerts.should be_false
+        book2.excel.displayalerts.should == :if_visible
         book2.close 
       end
     end
@@ -147,7 +363,6 @@ describe Book do
       @book1["named_formula"].should == 4      
     end
 
-
     it "should return default value if name not defined" do
       @book1.nameval("foo", :default => 2).should == 2
     end
@@ -172,6 +387,17 @@ describe Book do
         @book1["named_formula"] = "bar"
       }.to raise_error(ExcelError, /cannot assign value to range named "named_formula" in "another_workbook.xls"/)
     end
+
+    # Excel Bug: for local names without uqifier: takes the first sheet as default even if another sheet is activated
+    it "should take the first sheet as default even if the second sheet is activated" do
+      @book1.nameval("Sheet1!localname").should == "bar"
+      @book1.nameval("Sheet2!localname").should == "simple"
+      @book1.nameval("localname").should == "bar"
+      @book1.Worksheets.Item(2).Activate
+      @book1.nameval("localname").should == "bar"
+      @book1.Worksheets.Item(1).Delete
+      @book1.nameval("localname").should == "simple"
+    end
   end
 
   describe "rename_range" do
@@ -193,7 +419,7 @@ describe Book do
     end
   end
 
-  describe "alive?, filename, ==, visible, displayalerts, activate, saved, check_compatibility" do
+  describe "alive?, filename, ==, visible, activate, saved, check_compatibility" do
 
     context "with alive?" do
 
@@ -240,7 +466,7 @@ describe Book do
     context "with ==" do
 
       before do
-        @book = Book.open(@simple_file)
+        @book = Book.open(@simple_file1)
       end
 
       after do
@@ -249,7 +475,7 @@ describe Book do
       end
 
       it "should be true with two identical books" do
-        @new_book = Book.open(@simple_file)
+        @new_book = Book.open(@simple_file1)
         @new_book.should == @book
       end
 
@@ -296,29 +522,142 @@ describe Book do
       end
     end
 
-    context "with visible" do
 
-      before do
-        @book = Book.open(@simple_file)
+    context "with :visible => " do
+
+      it "should leave the excel invisible when opening with default option" do
+        excel1 = Excel.new(:reuse => false, :visible => false)
+        book1 = Book.open(@simple_file)
+        excel1.Visible.should be_false
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_false
+      end
+
+      it "should leave the excel invisible when opening with :visible => false" do
+        excel1 = Excel.new(:reuse => false, :visible => false)
+        book1 = Book.open(@simple_file, :visible => false)
+        excel1.Visible.should be_false
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_false
+      end
+
+      it "should leave the excel visible" do
+        excel1 = Excel.new(:reuse => false, :visible => false)
+        book1 = Book.open(@simple_file, :visible => true)
+        excel1.Visible.should be_true
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_true
+        book2 = Book.open(@another_simple_file)
+        excel1.Visible.should be_true
+        book2.Windows(book2.Name).Visible.should be_true
+        book2.visible.should be_true
+        book3 = Book.open(@different_file, :visible => false)
+        excel1.Visible.should be_true
+        book3.Windows(book3.Name).Visible.should be_false
+        book3.visible.should be_false
+      end
+
+      it "should leave the excel visible when opening with default option" do
+        excel1 = Excel.new(:reuse => false, :visible => true)
+        book1 = Book.open(@simple_file)
+        excel1.Visible.should be_true
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_true
+      end
+
+      it "should leave the excel visible when opening with :visible => false" do
+        excel1 = Excel.new(:reuse => false, :visible => true)
+        book1 = Book.open(@simple_file, :visible => false)
+        excel1.Visible.should be_true
+        book1.Windows(book1.Name).Visible.should be_false
+        book1.visible.should be_false
+        book2 = Book.open(@another_simple_file)
+        excel1.Visible.should be_true
+        book2.Windows(book2.Name).Visible.should be_true
+        book2.visible.should be_true
+      end
+
+      it "should leave the excel visible" do
+        excel1 = Excel.new(:reuse => false, :visible => true)
+        book1 = Book.open(@simple_file, :visible => true)
+        excel1.Visible.should be_true
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_true
+        book2 = Book.open(@different_file, :visible => false)
+        excel1.Visible.should be_true
+        book2.Windows(book2.Name).Visible.should be_false
+        book2.visible.should be_false
+      end
+
+      it "should leave the visibility of Excel" do
+        excel1 = Excel.new(:reuse => false, :visible => false)
+        book1 = Book.open(@simple_file, :visible => true)
+        excel1.Visible.should be_true
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_true
+        excel1.visible = false
+        book2 = Book.open(@different_file)
+        excel1.Visible.should be_false
+        book2.Windows(book2.Name).Visible.should be_true
+        book2.visible.should be_false
+      end
+
+      it "should leave the visibility of Excel" do
+        excel1 = Excel.new(:reuse => false, :visible => false)
+        book1 = Book.open(@simple_file, :visible => false)
+        excel1.Visible.should be_false
+        book1.Windows(book1.Name).Visible.should be_true
+        book1.visible.should be_false
+        excel1.visible = true
+        book2 = Book.open(@different_file)
+        excel1.Visible.should be_true
+        book2.Windows(book2.Name).Visible.should be_true
+        book2.visible.should be_true
       end
+    end
 
-      after do
-        @book.close
+    context "with visible, visible=" do
+
+      before do
+        @book1 = Book.open(@simple_file)
+        @book2 = Book.open(@different_file, :force_excel => :new, :visible => true)
       end
 
-      it "should make the workbook visible" do
-        @book.excel.visible = true
-        @book.excel.visible.should be_true
-        @book.visible.should be_true
-        @book.excel.Windows(@book.ole_workbook.Name).Visible.should be_true
-        @book.visible = false
-        @book.excel.visible.should be_true
-        @book.visible.should be_false
-        @book.excel.Windows(@book.ole_workbook.Name).Visible.should be_false
-        @book.visible = true
-        @book.excel.visible.should be_true
-        @book.visible.should be_true
-        @book.excel.Windows(@book.ole_workbook.Name).Visible.should be_true
+      after do
+        @book1.close
+        @book2.close
+      end
+
+      it "should make the invisible workbook visible and invisible" do
+        @book1.excel.Visible.should be_false
+        @book1.Windows(@book1.Name).Visible.should be_true
+        @book1.visible.should be_false
+        @book1.visible = true
+        @book1.Saved.should be_true
+        @book1.excel.Visible.should be_true
+        @book1.Windows(@book1.Name).Visible.should be_true
+        @book1.visible.should be_true
+        @book1.visible = false
+        @book1.Saved.should be_true
+        @book1.excel.should be_true
+        @book1.Windows(@book1.Name).Visible.should be_false
+        @book1.visible.should be_false
+        @book2.excel.Visible.should be_true
+      end
+
+      it "should make the visible workbook and the invisible workbook invisible" do
+        @book2.Windows(@book2.Name).Visible.should be_true
+        @book2.visible.should be_true
+        @book2.visible = true
+        @book2.Saved.should be_true
+        @book2.excel.Visible.should be_true
+        @book2.Windows(@book2.Name).Visible.should be_true
+        @book2.excel.visible = false
+        @book2.visible = false
+        @book2.Saved.should be_true
+        @book2.excel.Visible.should be_false
+        @book2.Windows(@book2.Name).Visible.should be_true
+        @book2.visible.should be_false
       end
 
     end
@@ -328,7 +667,9 @@ describe Book do
       before do
         @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Office Excel" '  , "w"        
         @book = Book.open(@simple_file, :visible => true)
+        @book.excel.displayalerts = false
         @book2 = Book.open(@another_simple_file, :force_excel => :new, :visible => true)
+        @book2.excel.displayalerts = false
       end
 
       after do