robust_excel_ole 0.4 → 0.5

data/spec/book_specs/book_close_spec.rb

@@ -71,7 +71,7 @@ describe Book do
         @book = Book.open(@simple_file)
         @sheet_count = @book.ole_workbook.Worksheets.Count
         @book.add_sheet(@sheet, :as => 'a_name')
-        @sheet = @book[0]
+        @sheet = @book.sheet(1)
       end
 
       after do
@@ -184,6 +184,49 @@ describe Book do
           end
         end
       end
+
+      context "with :if_unsaved => :excel" do
+        before do
+          @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Excel" '  , "w"
+        end
+
+        after do
+          @key_sender.close
+        end
+
+        possible_answers = [:yes, :no, :cancel]
+        possible_answers.each_with_index do |answer, position|
+          it "should" + (answer == :yes ? "" : " not") + " the unsaved book and" + (answer == :cancel ? " not" : "") + " close it" + "if user answers '#{answer}'" do
+            # "Yes" is the  default. "No" is right of "Yes", "Cancel" is right of "No" --> language independent
+            @key_sender.puts  "{right}" * position + "{enter}"
+            ole_workbook = @book.ole_workbook
+            excel = @book.excel
+            displayalert_value = @book.excel.DisplayAlerts
+            if answer == :cancel then
+              expect {
+              @book.close(:if_unsaved => :excel)
+              }.to raise_error(ExcelUserCanceled, "close: canceled by user")
+              @book.ole_workbook.Saved.should be_false
+              @book.ole_workbook.should_not == nil
+              @book.should be_alive
+            else
+              @book.excel.Workbooks.Count.should == 1
+              @book.close(:if_unsaved => :excel)
+              @book.excel.Workbooks.Count.should == 0
+              @book.ole_workbook.should == nil
+              @book.should_not be_alive
+              expect{ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
+            end
+            new_book = Book.open(@simple_file, :if_unsaved => :forget)
+            begin
+              new_book.ole_workbook.Worksheets.Count.should == @sheet_count + (answer==:yes ? 1 : 0)
+              new_book.excel.DisplayAlerts.should == displayalert_value
+            ensure
+              new_book.close
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/book_specs/book_misc_spec.rb

@@ -31,7 +31,7 @@ describe Book do
 
   after do
     Excel.kill_all
-    rm_tmp(@dir)
+    #rm_tmp(@dir)
   end
 
   describe "create file" do
@@ -101,113 +101,99 @@ describe Book do
     end
   end
 
-  describe "nvalue, set_nvalue, rename_range" do
-    
-    context "nvalue, book[<name>]" do
-    
-      before do
-        @book1 = Book.open(@another_simple_file)
-      end
+  describe "nameval, set_nameval, [], []=" do
+  
+    before do
+      @book1 = Book.open(@another_simple_file)
+    end
 
-      after do
-        @book1.close(:if_unsaved => :forget)
-      end   
-
-      it "should return value of a range" do
-        @book1.nvalue("new").should == "foo"
-        @book1.nvalue("one").should == 1
-        @book1.nvalue("firstrow").should == [[1,2]]        
-        @book1.nvalue("four").should == [[1,2],[3,4]]
-        @book1.nvalue("firstrow").should_not == "12"
-        @book1.nvalue("firstcell").should == "foo"
-        @book1["new"].should == "foo"
-        @book1["one"].should == 1
-        @book1["firstrow"].should == [[1,2]]        
-        @book1["four"].should == [[1,2],[3,4]]        
-        @book1["firstcell"].should == "foo"
-      end
-
-      it "should raise an error if name not defined" do
-        expect {
-          @book1.nvalue("foo")
-        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
-        expect {
-          @book1["foo"]
-        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
-      end
+    after do
+      @book1.close(:if_unsaved => :forget)
+    end   
+
+    it "should return value of a range" do
+      @book1.nameval("new").should == "foo"
+      @book1.nameval("one").should == 1
+      @book1.nameval("firstrow").should == [[1,2]]        
+      @book1.nameval("four").should == [[1,2],[3,4]]
+      @book1.nameval("firstrow").should_not == "12"
+      @book1.nameval("firstcell").should == "foo"        
+    end
 
-      it "should evaluate a formula" do
-        @book1.nvalue("named_formula").should == 4
-        @book1["named_formula"].should == 4
-      end
+    it "should return value of a range via []" do
+      @book1["new"].should == "foo"
+      @book1["one"].should == 1
+      @book1["firstrow"] == [[1,2]]        
+      @book1["four"].should == [[1,2],[3,4]]
+      @book1["firstrow"].should_not == "12"
+      @book1["firstcell"].should == "foo"        
+    end
 
-      it "should return default value if name not defined" do
-        @book1.nvalue("foo", :default => 2).should == 2
-      end
+    it "should set value of a range" do
+      @book1.set_nameval("new", "bar")
+      @book1.nameval("new").should == "bar"
     end
 
-    context "set_nvalue, book[<name>]=" do
-    
-      before do
-        @book1 = Book.open(@another_simple_file)
-      end
+    it "should set value of a range via []=" do
+      @book1["new"] = "bar"
+      @book1.nameval("new").should == "bar"
+    end
 
-      after do
-        @book1.close(:if_unsaved => :forget)
-      end   
+    it "should evaluate a formula" do
+      @book1.nameval("named_formula").should == 4      
+    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
+    it "should evaluate a formula via []" do
+      @book1["named_formula"].should == 4      
+    end
 
-      it "should raise an error if name not defined" do
-        expect {
-          @book1.set_nvalue("foo","bar")
-        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
-        expect {
-          @book1["foo"] = "bar"
-        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
-      end
 
-      it "should raise an error if name was defined but contents is calcuated" do
-        expect {
-          @book1.set_nvalue("named_formula","bar")
-        }.to raise_error(ExcelError, /RefersToRange error of name "named_formula" in "another_workbook.xls"/)
-        expect {
-          @book1["named_formula"] = "bar"
-        }.to raise_error(ExcelError, /RefersToRange error of name "named_formula" in "another_workbook.xls"/)
-      end
+    it "should return default value if name not defined" do
+      @book1.nameval("foo", :default => 2).should == 2
+    end
 
-      it "should set value of a range" do
-        @book1.nvalue("new").should == "foo"
-        @book1["new"] = "bar"
-        @book1.nvalue("new").should == "bar"
-      end
+    it "should raise an error if name not defined" do
+      expect {
+        @book1.nameval("foo")
+      }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
+      expect {
+          @book1.set_nameval("foo","bar")
+      }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
+      expect {
+          @book1["foo"] = "bar"
+      }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
+    end    
+
+    it "should raise an error if name was defined but contents is calcuated" do
+      expect {
+        @book1.set_nameval("named_formula","bar")
+      }.to raise_error(ExcelError, /cannot assign value to range named "named_formula" in "another_workbook.xls"/)
+      expect {
+        @book1["named_formula"] = "bar"
+      }.to raise_error(ExcelError, /cannot assign value to range named "named_formula" in "another_workbook.xls"/)
     end
+  end
 
-    context "rename_range" do
+  describe "rename_range" do
     
-      before do
-        @book1 = Book.open(@another_simple_file)
-      end
+    before do
+      @book1 = Book.open(@another_simple_file)
+    end
 
-      after do
-        @book1.close(:if_unsaved => :forget)
-      end
+    after do
+      @book1.close(:if_unsaved => :forget)
+    end
 
-      it "should rename a range" do
+    it "should rename a range" do
+      @book1.rename_range("four","five")
+      @book1.nameval("five").should == [[1,2],[3,4]]
+      expect {
         @book1.rename_range("four","five")
-        @book1.nvalue("five").should == [[1,2],[3,4]]
-        expect {
-          @book1.rename_range("four","five")
-        }.to raise_error(ExcelError, /name "four" not in "another_workbook.xls"/)
-      end
+      }.to raise_error(ExcelError, /name "four" not in "another_workbook.xls"/)
     end
   end
 
-  describe "alive?, filename, ==, visible, displayalerts, activate, saved" do
+  describe "alive?, filename, ==, visible, displayalerts, activate, saved, check_compatibility" do
 
     context "with alive?" do
 
@@ -304,7 +290,7 @@ describe Book do
       end
 
       it "should yield false for an unsaved book" do
-        sheet = @book[0]
+        sheet = @book.sheet(1)
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         @book.saved.should be_false
       end
@@ -352,10 +338,10 @@ describe Book do
       end
 
       it "should activate a book" do
-        sheet = @book[1]
+        sheet = @book.sheet(2)
         sheet.Activate
         sheet[2,3].Activate
-        sheet2 = @book2[2]
+        sheet2 = @book2.sheet(2)
         sheet2.Activate
         sheet2[3,2].Activate
         Excel.current.should == @book.excel
@@ -371,5 +357,24 @@ describe Book do
         Excel.current.should == @book.excel
       end
     end
+
+    context "with compatibility" do      
+
+      it "should open and check compatibility" do
+        book = Book.open(@simple_file, :visible => true, :check_compatibility => false)
+        book.CheckCompatibility.should be_false
+        book.CheckCompatibility = true
+        book.CheckCompatibility.should be_true
+        Book.unobtrusively(@simple_file, :visible => true, :check_compatibility => false) do |book|
+          book.CheckCompatibility.should be_false
+        end
+        Book.unobtrusively(@simple_file, :visible => true, :check_compatibility => true) do |book|
+          book.CheckCompatibility.should be_true
+        end
+
+      end
+
+    end
+
   end
 end

data/spec/book_specs/book_open_spec.rb

@@ -474,7 +474,7 @@ describe Book do
 
       before do
         @book = Book.open(@simple_file)
-        @sheet = @book[0]
+        @sheet = @book.sheet(1)
         @book.add_sheet(@sheet, :as => 'a_name')
       end
 
@@ -537,6 +537,38 @@ describe Book do
         end
       end
 
+      context "with :if_unsaved => :excel" do
+        before do
+         @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Office Excel" '  , "w"
+        end
+
+        after do
+          @key_sender.close
+        end
+
+        it "should open the new book and close the unsaved book, if user answers 'yes'" do
+          # "Yes" is the  default. --> language independent
+          @key_sender.puts "{enter}"
+          @new_book = Book.open(@simple_file, :if_unsaved => :excel)
+          @new_book.should be_alive
+          @new_book.filename.downcase.should == @simple_file.downcase
+          @book.should_not be_alive
+        end
+
+        it "should not open the new book and not close the unsaved book, if user answers 'no'" do
+          # "No" is right to "Yes" (the  default). --> language independent
+          # strangely, in the "no" case, the question will sometimes be repeated three times
+          #@book.excel.Visible = true
+          @key_sender.puts "{right}{enter}"
+          @key_sender.puts "{right}{enter}"
+          @key_sender.puts "{right}{enter}"
+          expect{
+            Book.open(@simple_file, :if_unsaved => :excel)
+            }.to raise_error(ExcelErrorOpen, "open: user canceled or open error")
+          @book.should be_alive
+        end
+      end
+
       it "should open the book in a new excel instance, if :if_unsaved is :new_excel" do
         @new_book = Book.open(@simple_file, :if_unsaved => :new_excel)
         @book.should be_alive
@@ -572,7 +604,7 @@ describe Book do
             end
             @book = Book.open(@simple_file_other_path)
             @sheet_count = @book.ole_workbook.Worksheets.Count
-            @sheet = @book[0]
+            @sheet = @book.sheet(1)
             @book.add_sheet(@sheet, :as => 'a_name')
           end
 
@@ -721,7 +753,7 @@ describe Book do
         book = Book.open(@simple_file, :read_only => true)
         book.ReadOnly.should be_true
         book.should be_alive
-        sheet = book[0]
+        sheet = book.sheet(1)
         old_cell_value = sheet[1,1].value
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false
@@ -730,7 +762,7 @@ describe Book do
         new_book.should be_alive
         book.should be_alive   
         new_book.should == book 
-        new_sheet = new_book[0]
+        new_sheet = new_book.sheet(1)
         new_cell_value = new_sheet[1,1].value
         new_cell_value.should == old_cell_value
       end
@@ -739,7 +771,7 @@ describe Book do
         book = Book.open(@simple_file, :read_only => false)
         book.ReadOnly.should be_false
         book.should be_alive
-        sheet = book[0]
+        sheet = book.sheet(1)
         old_cell_value = sheet[1,1].value        
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false
@@ -753,7 +785,7 @@ describe Book do
         book = Book.open(@simple_file, :read_only => true)
         book.ReadOnly.should be_true
         book.should be_alive
-        sheet = book[0]
+        sheet = book.sheet(1)
         old_cell_value = sheet[1,1].value
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false
@@ -762,7 +794,7 @@ describe Book do
         new_book.should be_alive
         book.should be_alive   
         new_book.should == book 
-        new_sheet = new_book[0]
+        new_sheet = new_book.sheet(1)
         new_cell_value = new_sheet[1,1].value
         new_cell_value.should == old_cell_value
       end
@@ -771,7 +803,7 @@ describe Book do
         book = Book.open(@simple_file, :force_excel => :new, :read_only => false)
         book.ReadOnly.should be_false
         book.should be_alive
-        sheet = book[0]
+        sheet = book.sheet(1)
         old_cell_value = sheet[1,1].value        
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false

data/spec/book_specs/book_save_spec.rb

@@ -152,7 +152,7 @@ describe Book do
         File.open(@simple_file_other_path,"w") do | file |
           file.puts "garbage"
         end
-        sheet = @book[0]
+        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
@@ -164,7 +164,7 @@ describe Book do
         new_book.should be_a Book
         new_book.close
         old_book = Book.open(@simple_file)
-        old_sheet = old_book[0]
+        old_sheet = old_book.sheet(1)
         old_sheet[1,1].value.should == cell_value
         old_book.close
       end
@@ -174,7 +174,7 @@ describe Book do
         File.open(@simple_file_other_path,"w") do | file |
           file.puts "garbage"
         end
-        sheet = @book[0]
+        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
@@ -186,7 +186,7 @@ describe Book do
         new_book.should be_a Book
         new_book.close
         old_book = Book.open(@simple_file)
-        old_sheet = old_book[0]
+        old_sheet = old_book.sheet(1)
         old_sheet[1,1].value.should_not == cell_value
         old_book.close
       end
@@ -207,7 +207,7 @@ describe Book do
       end
 
       it "should raise an error if the blocking workbook was unsaved with :if_obstructed => :close_if_saved" do
-        sheet = @book[0]
+        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      
@@ -295,12 +295,12 @@ describe Book do
         end
 
         it "should simple save if file name is equal to the old one with :if_exists => :overwrite" do
-          sheet = @book[0]
+          sheet = @book.sheet(1)
           sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
           new_value = sheet[1,1].value
           @book.save_as(@simple_file, :if_exists => :overwrite)
           new_book = Book.open(@simple_file)
-          new_sheet = new_book[0]
+          new_sheet = new_book.sheet(1)
           new_sheet[1,1].value.should == new_value
           new_book.close
         end
@@ -390,6 +390,76 @@ describe Book do
 
         end
 
+        context "with :if_exists => :excel" do
+          before do
+            File.delete @simple_save_file rescue nil
+            File.open(@simple_save_file,"w") do | file |
+              file.puts "garbage"
+            end
+            @garbage_length = File.size?(@simple_save_file)
+            @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Excel" '  , "w"
+          end
+
+          after do
+            @key_sender.close
+          end
+
+          it "should save if user answers 'yes'" do
+            # "Yes" is to the left of "No", which is the  default. --> language independent
+            @key_sender.puts "{left}{enter}" #, :initial_wait => 0.2, :if_target_missing=>"Excel window not found")
+            @book.save_as(@simple_save_file, :if_exists => :excel)
+            File.exist?(@simple_save_file).should be_true
+            File.size?(@simple_save_file).should > @garbage_length
+            @book.excel.DisplayAlerts.should == displayalert_value
+            new_book = Book.open(@simple_save_file, :excel => :new)
+            new_book.should be_a Book
+            new_book.close
+            @book.excel.DisplayAlerts.should == displayalert_value
+          end
+
+          it "should not save if user answers 'no'" do
+            # Just give the "Enter" key, because "No" is the default. --> language independent
+            # strangely, in the "no" case, the question will sometimes be repeated three times
+            @key_sender.puts "{enter}"
+            @key_sender.puts "{enter}"
+            @key_sender.puts "{enter}"
+            #@key_sender.puts "%{n}" #, :initial_wait => 0.2, :if_target_missing=>"Excel window not found")
+            expect{
+              @book.save_as(@simple_save_file, :if_exists => :excel)
+              }.to raise_error(ExcelErrorSave, "not saved or canceled by user")
+            File.exist?(@simple_save_file).should be_true
+            File.size?(@simple_save_file).should == @garbage_length
+            @book.excel.DisplayAlerts.should == displayalert_value
+          end
+
+          it "should not save if user answers 'cancel'" do
+            # 'Cancel' is right from 'yes'
+            # strangely, in the "no" case, the question will sometimes be repeated three times
+            @key_sender.puts "{right}{enter}"
+            @key_sender.puts "{right}{enter}"
+            @key_sender.puts "{right}{enter}"
+            #@key_sender.puts "%{n}" #, :initial_wait => 0.2, :if_target_missing=>"Excel window not found")
+            expect{
+              @book.save_as(@simple_save_file, :if_exists => :excel)
+              }.to raise_error(ExcelErrorSave, "not saved or canceled by user")
+            File.exist?(@simple_save_file).should be_true
+            File.size?(@simple_save_file).should == @garbage_length
+            @book.excel.DisplayAlerts.should == displayalert_value
+          end
+
+          it "should report save errors and leave DisplayAlerts unchanged" do
+            #@key_sender.puts "{left}{enter}" #, :initial_wait => 0.2, :if_target_missing=>"Excel window not found")
+            @book.ole_workbook.Close
+            expect{
+              @book.save_as(@simple_save_file, :if_exists => :excel)
+              }.to raise_error(ExcelErrorSave, "Workbook is not alive")
+            File.exist?(@simple_save_file).should be_true
+            File.size?(@simple_save_file).should == @garbage_length
+            @book.excel.DisplayAlerts.should == displayalert_value
+          end
+
+        end
+
         it "should save to 'simple_save_file.xls' with :if_exists => nil" do
           dirname, basename = File.split(@simple_save_file)
           File.delete @simple_save_file rescue nil