robust_excel_ole 0.3.4 → 0.3.5

data/lib/robust_excel_ole/version.rb

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

data/reo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+irb -r lib/robust_excel_ole 

data/spec/book_close_spec.rb

@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+
+
+$VERBOSE = nil
+
+include RobustExcelOle
+
+describe Book do
+
+  before(:all) 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
+  end
+
+  before do
+    @dir = create_tmpdir
+    @simple_file = @dir + '/workbook.xls'
+    @simple_save_file = @dir + '/workbook_save.xls'
+    @different_file = @dir + '/different_workbook.xls'
+    @simple_file_other_path = @dir + '/more_data/workbook.xls'
+    @another_simple_file = @dir + '/another_workbook.xls'
+    @linked_file = @dir + '/workbook_linked.xlsm'
+    @simple_file_xlsm = @dir + '/workbook.xls'
+    @simple_file_xlsx = @dir + '/workbook.xlsx'
+  end
+
+  after do
+    Excel.close_all
+    rm_tmp(@dir)
+  end
+
+  describe "close" do
+
+    context "with saved book" do
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      it "should close book" do
+        expect{
+          @book.close
+        }.to_not raise_error
+        @book.should_not be_alive
+      end
+    end
+
+    context "with unsaved read_only book" do
+      before do
+        @book = Book.open(@simple_file, :read_only => true)
+        @sheet_count = @book.workbook.Worksheets.Count
+        @book.add_sheet(@sheet, :as => 'a_name')
+      end
+
+      it "should close the unsaved book without error and without saving" do
+        expect{
+          @book.close
+          }.to_not raise_error
+        new_book = Book.open(@simple_file)
+        new_book.workbook.Worksheets.Count.should ==  @sheet_count
+        new_book.close
+      end
+    end
+
+    context "with unsaved book" do
+      before do
+        @book = Book.open(@simple_file)
+        @sheet_count = @book.workbook.Worksheets.Count
+        @book.add_sheet(@sheet, :as => 'a_name')
+        @sheet = @book[0]
+      end
+
+      after do
+        @book.close(:if_unsaved => :forget) rescue nil
+      end
+
+      it "should raise error with option :raise" do
+        expect{
+          @book.close(:if_unsaved => :raise)
+        }.to raise_error(ExcelErrorClose, "book is unsaved (#{File.basename(@simple_file)})")
+      end
+
+      it "should raise error by default" do
+        expect{
+          @book.close(:if_unsaved => :raise)
+        }.to raise_error(ExcelErrorClose, "book is unsaved (#{File.basename(@simple_file)})")
+      end
+
+      it "should close the book and leave its file untouched with option :forget" do
+        ole_workbook = @book.workbook
+        excel = @book.excel
+        expect {
+          @book.close(:if_unsaved => :forget)
+        }.to change {excel.Workbooks.Count }.by(-1)
+        @book.workbook.should == nil
+        @book.should_not be_alive
+        expect{
+          ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
+        new_book = Book.open(@simple_file)
+        begin
+          new_book.workbook.Worksheets.Count.should ==  @sheet_count
+        ensure
+          new_book.close
+        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
+        expect {
+          @book.close(:if_unsaved => :save)
+        }.to change {excel.Workbooks.Count }.by(-1)
+        @book.workbook.should == nil
+        @book.should_not be_alive
+        expect{
+          ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)
+        new_book = Book.open(@simple_file)
+        begin
+          new_book.workbook.Worksheets.Count.should == @sheet_count + 1
+        ensure
+          new_book.close
+        end
+      end
+
+      context "with :if_unsaved => :alert" 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.workbook
+            excel = @book.excel
+            displayalert_value = @book.excel.DisplayAlerts
+            if answer == :cancel then
+              expect {
+              @book.close(:if_unsaved => :alert)
+              }.to raise_error(ExcelUserCanceled, "close: canceled by user")
+              @book.workbook.Saved.should be_false
+              @book.workbook.should_not == nil
+              @book.should be_alive
+            else
+              expect {
+                @book.close(:if_unsaved => :alert)
+              }.to change {@book.excel.Workbooks.Count }.by(-1)
+              @book.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.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_misc_spec.rb

@@ -0,0 +1,365 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+
+
+$VERBOSE = nil
+
+include RobustExcelOle
+
+describe Book do
+
+  before(:all) 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
+  end
+
+  before do
+    @dir = create_tmpdir
+    @simple_file = @dir + '/workbook.xls'
+    @simple_save_file = @dir + '/workbook_save.xls'
+    @different_file = @dir + '/different_workbook.xls'
+    @simple_file_other_path = @dir + '/more_data/workbook.xls'
+    @another_simple_file = @dir + '/another_workbook.xls'
+    @linked_file = @dir + '/workbook_linked.xlsm'
+    @simple_file_xlsm = @dir + '/workbook.xls'
+    @simple_file_xlsx = @dir + '/workbook.xlsx'
+  end
+
+  after do
+    Excel.close_all
+    rm_tmp(@dir)
+  end
+
+  describe "create file" do
+    context "with standard" do
+      it "open an existing file" do
+        expect {
+          @book = Book.new(@simple_file)
+        }.to_not raise_error
+        @book.should be_a Book
+        @book.close
+      end
+    end
+  end
+
+  describe "send methods to workbook" do
+
+    context "with standard" do
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should send Saved to workbook" do
+        @book.Saved.should be_true
+      end
+
+      it "should send Fullname to workbook" do
+        @book.Fullname.tr('\\','/').should == @simple_file
+      end
+    end
+  end
+
+  describe "hidden_excel" do
+    
+    context "with some open book" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should create and use a hidden Excel instance" do
+        book2 = Book.open(@simple_file, :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.close 
+      end
+    end
+  end
+
+  describe "nvalue, set_nvalue, rename_range" do
+    
+    context "nvalue, book[<name>]" 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(ExcelErrorNValue, "name foo not in another_workbook.xls")
+        expect {
+          @book1["foo"]
+        }.to raise_error(ExcelErrorNValue, "name foo not in another_workbook.xls")
+      end
+
+      it "should raise an error if name was defined but contents is calcuated" do
+        expect {
+          @book1.nvalue("named_formula")
+        }.to raise_error(ExcelErrorNValue, "RefersToRange error of name named_formula in another_workbook.xls")
+        expect {
+          @book1["named_formula"]
+        }.to raise_error(ExcelErrorNValue, "RefersToRange error of name named_formula in another_workbook.xls")
+      end
+
+      it "should return default value if name not defined" do
+        @book1.nvalue("foo", :default => 2).should == 2
+        @book1.nvalue("named_formula", :default => 4).should == 4
+      end
+    end
+
+    context "set_nvalue, book[<name>]=" do
+    
+      before do
+        @book1 = Book.open(@another_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
+
+      it "should raise an error if name not defined" do
+        expect {
+          @book1.set_nvalue("foo","bar")
+        }.to raise_error(ExcelErrorNValue, "name foo not in another_workbook.xls")
+        expect {
+          @book1["foo"] = "bar"
+        }.to raise_error(ExcelErrorNValue, "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(ExcelErrorNValue, "RefersToRange error of name named_formula in another_workbook.xls")
+        expect {
+          @book1["named_formula"] = "bar"
+        }.to raise_error(ExcelErrorNValue, "RefersToRange error of name named_formula in another_workbook.xls")
+      end
+
+      it "should set value of a range" do
+        @book1.nvalue("new").should == "foo"
+        @book1["new"] = "bar"
+        @book1.nvalue("new").should == "bar"
+      end
+    end
+
+    context "rename_range" do
+    
+      before do
+        @book1 = Book.open(@another_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(ExcelError, "name four not in another_workbook.xls")
+      end
+    end
+  end
+
+  describe "alive?, filename, ==, visible, displayalerts, activate, saved" do
+
+    context "with alive?" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should return true, if book is alive" do
+        @book.should be_alive
+      end
+
+      it "should return false, if book is dead" do
+        @book.close
+        @book.should_not be_alive
+      end
+
+    end
+
+    context "with filename" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should return full file name" do
+        @book.filename.should == @simple_file
+      end
+
+      it "should return nil for dead book" do
+        @book.close
+        @book.filename.should == nil
+      end
+
+    end
+
+    context "with ==" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+        @new_book.close rescue nil
+      end
+
+      it "should be true with two identical books" do
+        @new_book = Book.open(@simple_file)
+        @new_book.should == @book
+      end
+
+      it "should be false with two different books" do
+        @new_book = Book.new(@different_file)
+        @new_book.should_not == @book
+      end
+
+      it "should be false with same book names but different paths" do       
+        @new_book = Book.new(@simple_file_other_path, :excel => :new)
+        @new_book.should_not == @book
+      end
+
+      it "should be false with same book names but different excel instances" do
+        @new_book = Book.new(@simple_file, :excel => :new)
+        @new_book.should_not == @book
+      end
+
+      it "should be false with non-Books" do
+        @book.should_not == "hallo"
+        @book.should_not == 7
+        @book.should_not == nil
+      end
+    end
+
+    context "with saved" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close(:if_unsaved => :forget)
+      end
+
+      it "should yield true for a saved book" do
+        @book.saved.should be_true
+      end
+
+      it "should yield false for an unsaved book" do
+        sheet = @book[0]
+        sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
+        @book.saved.should be_false
+      end
+    end
+
+    context "with visible and displayalerts" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should make Excel visible" do
+        @book.excel.visible = false
+        @book.excel.visible.should be_false
+        @book.excel.visible = true
+        @book.excel.visible.should be_true
+      end
+
+      it "should enable DisplayAlerts in Excel" do
+        @book.excel.displayalerts = false
+        @book.excel.displayalerts.should be_false
+        @book.excel.displayalerts = true
+        @book.excel.displayalerts.should be_true
+      end
+    end
+
+    context "with activate" 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)
+        @book2 = Book.open(@another_simple_file, :force_excel => :new, :visible => true)
+      end
+
+      after do
+        @book.close(:if_unsaved => :forget)
+        @book2.close(:if_unsaved => :forget)
+        @key_sender.close
+      end
+
+      it "should activate a book" do
+        sheet = @book[1]
+        sheet.Activate
+        sheet[2,3].Activate
+        sheet2 = @book2[2]
+        sheet2.Activate
+        sheet2[3,2].Activate
+        Excel.current.should == @book.excel
+        @book2.activate
+        @key_sender.puts "{a}{enter}"
+        sleep 1
+        sheet2[3,2].Value.should == "a"
+        #Excel.current.should == @book2.excel
+        @book.activate
+        @key_sender.puts "{a}{enter}"
+        sleep 1
+        sheet[2,3].Value.should == "a"
+        Excel.current.should == @book.excel
+      end
+    end
+  end
+end