robust_excel_ole 0.2.3 → 0.3.0

data/spec/book_store_spec.rb

@@ -0,0 +1,306 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :should
+  end
+end
+
+
+$VERBOSE = nil
+
+include RobustExcelOle
+module RobustExcelOle
+  class MockBookstore
+    def fetch(filename, options = { })
+      nil
+    end
+    def store(book)
+    end
+    def print
+      puts "MockBookstore is always empty"
+    end
+  end
+end
+
+
+$mock_bookstore = MockBookstore.new
+
+class Book
+  @@bookstore = $mock_bookstore
+end
+
+
+describe BookStore 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
+    @bookstore = BookStore.new
+    @dir = create_tmpdir
+    @simple_file = @dir + '/simple.xls'
+    @simple_save_file = @dir + '/simple_save.xls'
+    @different_file = @dir + '/different_simple.xls'
+    @simple_file_other_path = @dir + '/more_data/simple.xls'
+  end
+
+  after do
+    Excel.close_all
+    rm_tmp(@dir)
+  end
+
+  describe "create bookstore" do
+    context "with standard" do
+      it "should create book store" do
+        expect {
+          @book_store = BookStore.new
+        }.to_not raise_error
+        @book_store.should be_a BookStore
+      end
+    end
+  end
+
+  describe "Mock-Test" do
+    it "should never store any book" do
+      b1 = Book.open(@simple_file)
+      b2 = Book.open(@simple_file)
+      b2.object_id.should_not == b1.object_id
+    end
+  end
+
+
+  describe "fetch" do
+    
+    context "with one open book" do
+      
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should do simple store and fetch" do        
+        @bookstore.store(@book)
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should be_a Book
+        new_book.should be_alive
+        new_book.should == @book
+        new_book.close
+      end
+
+      it "should fetch one book several times" do        
+        @bookstore.store(@book)
+        book1 = @bookstore.fetch(@simple_file)
+        book2 = @bookstore.fetch(@simple_file)
+        expect(book1).to be_a Book
+        book1.should be_alive
+        book1.should == @book
+        book2.should be_a Book
+        book2.should be_alive
+        book2.should == @book
+        book1.should == book2
+        book1.close
+        book2.close
+      end
+
+      it "should fetch nothing without stóring before" do
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == nil
+      end
+
+      it "should fetch nothing when fetching a different book" do
+        @bookstore.store(@book)
+        new_book = @bookstore.fetch(@different_file)
+        new_book.should == nil
+      end
+
+      it "should fetch nothing when fetching a non-existing book" do
+        @bookstore.store(@book)
+        new_book = @bookstore.fetch("foo")
+        new_book.should == nil
+      end
+
+    end
+
+    context "with several books" do
+
+      before do
+        @book = Book.open(@simple_file)
+        @bookstore.store(@book)
+      end
+
+      after do
+        @book.close
+        @book2.close(:if_unsaved => :forget)
+      end
+
+      it "should store and open two different books" do
+        @book2 = Book.open(@different_file)
+        @bookstore.store(@book2)
+        new_book = @bookstore.fetch(@simple_file)
+        new_book2 = @bookstore.fetch(@different_file)
+        new_book.should be_a Book
+        new_book.should be_alive
+        new_book.should == @book
+        new_book2.should be_a Book
+        new_book2.should be_alive
+        new_book2.should == @book2
+        new_book.should_not == new_book2
+        new_book.close
+        new_book2.close
+      end
+
+      it "should fetch the first, writable book" do
+        @book2 = Book.open(@simple_file, :force_excel => :new)
+        @bookstore.store(@book2)
+        @book.ReadOnly.should be_false
+        @book2.ReadOnly.should be_true
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book
+        new_book.should_not == @book2
+        new_book.close
+      end
+
+      it "should fetch the writable book even if the readonly book has unsaved changes" do
+        @book2 = Book.open(@simple_file, :force_excel => :new)
+        sheet = @book2[0]
+        @bookstore.store(@book2)
+        sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"
+        @book.ReadOnly.should be_false
+        @book2.ReadOnly.should be_true
+        @book2.Saved. should be_false
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book
+        new_book.should_not == @book2
+        new_book.close
+      end
+
+    end
+
+    context "with readonly book" do
+
+      before do
+        @book = Book.open(@simple_file, :read_only => true)
+        @bookstore.store(@book)
+      end
+
+      after do
+        @book.close
+        @book2.close(:if_unsaved => :forget)
+      end
+
+      it "should fetch the second, writable book" do
+        @book2 = Book.open(@simple_file, :force_excel => :new)
+        @bookstore.store(@book2)
+        @book.ReadOnly.should be_true
+        @book2.ReadOnly.should be_false
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book2
+        new_book.should_not == @book
+        new_book.close
+      end
+
+      it "should fetch the recent readonly book when there are only readonly books" do
+        @book2 = Book.open(@simple_file, :force_excel => :new, :read_only => true)
+        @bookstore.store(@book2)
+        @book.ReadOnly.should be_true
+        @book2.ReadOnly.should be_true
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book2
+        new_book.should_not == @book
+        new_book.close
+      end
+
+      it "should fetch the second readonly book with unsaved changes" do
+        @book2 = Book.open(@simple_file, :force_excel => :new, :read_only => true)
+        sheet = @book2[0]
+        @bookstore.store(@book2)
+        sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"
+        @book.ReadOnly.should be_true
+        @book2.ReadOnly.should be_true
+        @book2.Saved.should be_false
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book2
+        new_book.should_not == @book        
+        new_book.close
+      end
+
+      it "should fetch the second, writable book, if a writable, a readonly and an unsaved readonly book exist" do
+        @book2 = Book.open(@simple_file, :force_excel => :new)
+        @book3 = Book.open(@simple_file, :force_excel => :new)
+        @bookstore.store(@book2)
+        @bookstore.store(@book3)
+        sheet = @book3[0]
+        sheet[0,0] = sheet[0,0].value == "simple" ? "complex" : "simple"
+        @book.ReadOnly.should be_true
+        @book2.ReadOnly.should be_false
+        @book3.ReadOnly.should be_true
+        @book3.Saved.should be_false
+        new_book = @bookstore.fetch(@simple_file)
+        new_book.should == @book2
+        new_book.should_not == @book        
+        new_book.should_not == @book3  
+        new_book.close
+      end
+    end
+   
+    context "with changing file name" do
+
+      before do
+        @book = Book.open(@simple_file)
+        @book.save_as(@simple_save_file, :if_exists => :overwrite)      
+        @bookstore = @book.book_store
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should return only book with correct file name" do
+        book1 = @bookstore.fetch(@simple_save_file)
+        book1.should == @book
+      end
+
+      it "should return only book with correct file name" do
+        book1 = @bookstore.fetch(@simple_file)
+        book1.should == nil
+      end
+    end
+
+    context "with given excel instance and fetching readonly" do
+      
+      before do
+        @book = Book.open(@simple_file)
+        @bookstore.store(@book)
+        @book2 = Book.open(@simple_file, :force_excel => :new)
+        @bookstore.store(@book2)        
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should fetch the book in the given excel instance" do
+        @book.ReadOnly.should be_false
+        @book2.ReadOnly.should be_true
+        book_new = @bookstore.fetch(@simple_file, :excel => @book2.excel)
+        book_new.should be_a Book
+        book_new.should be_alive
+        book_new.should == @book2
+      end
+
+    end
+
+
+  end
+end

data/spec/excel_spec.rb

@@ -8,65 +8,61 @@ module RobustExcelOle
 
   describe Excel do
 
-    context "app creation" do
-      after do
-        Excel.close_all
-      end
+    before do
+      Excel.close_all
+    end
 
+    context "excel creation" do
+      
       def creation_ok? # :nodoc: #
-        @app.alive?.should == true
-        @app.Visible.should == false
-        @app.DisplayAlerts.should == false
-        @app.Name.should == "Microsoft Excel"
+        @excel.alive?.should be_true
+        @excel.Visible.should be_false
+        @excel.DisplayAlerts.should be_false
+        @excel.Name.should == "Microsoft Excel"
       end
 
       it "should work with 'new' " do
-        @app = Excel.new
+        @excel = Excel.new
         creation_ok?
       end
 
       it "should work with 'new' " do
-        @app = Excel.new(:reuse => false)
+        @excel = Excel.new(:reuse => false)
         creation_ok?
       end
 
       it "should work with 'create' " do
-        @app = Excel.create
+        @excel = Excel.create
         creation_ok?
       end
 
     end
 
-    context "with existing app" do
+    context "with existing excel" do
 
       before do
-        Excel.close_all
-        @app1 = Excel.create
+        @excel1 = Excel.create
       end
 
-      after do
-        Excel.close_all
+      it "should create different excel" do
+        excel2 = Excel.create
+        #puts "@excel1 #{@excel1.Hwnd}"
+        #puts "excel2  #{excel2.Hwnd}"
+        excel2.Hwnd.should_not == @excel1.Hwnd
       end
 
-      it "should create different app" do
-        app2 = Excel.create
-        #puts "@app1 #{@app1.Hwnd}"
-        #puts "app2  #{app2.Hwnd}"
-        app2.Hwnd.should_not == @app1.Hwnd
+      it "should reuse existing excel" do
+        excel2 = Excel.current
+        #puts "@excel1 #{@excel1.Hwnd}"
+        #puts "excel2  #{excel2.Hwnd}"
+        excel2.Hwnd.should == @excel1.Hwnd
       end
 
-      it "should reuse existing app" do
-        app2 = Excel.current
-        #puts "@app1 #{@app1.Hwnd}"
-        #puts "app2  #{app2.Hwnd}"
-        app2.Hwnd.should == @app1.Hwnd
-      end
-
-      it "should reuse existing app with default options for 'new'" do
-        app2 = Excel.new
-        #puts "@app1 #{@app1.Hwnd}"
-        #puts "app2  #{app2.Hwnd}"
-        app2.Hwnd.should == @app1.Hwnd
+      it "should reuse existing excel with default options for 'new'" do
+        excel2 = Excel.new
+        #puts "@excel1 #{@excel1.Hwnd}"
+        #puts "excel2  #{excel2.Hwnd}"
+        excel2.Hwnd.should == @excel1.Hwnd
       end
 
     end
@@ -75,17 +71,17 @@ module RobustExcelOle
       def direct_excel_creation_helper  # :nodoc: #
         expect { WIN32OLE.connect("Excel.Application") }.to raise_error
         sleep 0.1
-        exl1 = WIN32OLE.new("Excel.Application")
-        exl1.Workbooks.Add
-        exl2 = WIN32OLE.new("Excel.Application")
-        exl2.Workbooks.Add
+        excel1 = WIN32OLE.new("Excel.Application")
+        excel1.Workbooks.Add
+        excel2 = WIN32OLE.new("Excel.Application")
+        excel2.Workbooks.Add
         expect { WIN32OLE.connect("Excel.Application") }.to_not raise_error
       end
 
       it "simple file with default" do
-        RobustExcelOle::Excel.close_all
+        Excel.close_all
         direct_excel_creation_helper
-        RobustExcelOle::Excel.close_all
+        Excel.close_all
         sleep 0.1
         expect { WIN32OLE.connect("Excel.Application") }.to raise_error
       end
@@ -93,89 +89,145 @@ module RobustExcelOle
 
     describe "==" do
       before do
-        Excel.close_all
-        @app1 = Excel.create
-      end
-
-      after do
-        Excel.close_all
+        @excel1 = Excel.create
       end
 
-      it "should be true with two identical excel applications" do
-        app2 = Excel.current
-        app2.should == @app1
+      it "should be true with two identical excel instances" do
+        excel2 = Excel.current
+        excel2.should == @excel1
       end
 
-      it "should be false with two different excel applications" do
-        app2 = Excel.create
-        app2.should_not == @app1
+      it "should be false with two different excel instances" do
+        excel2 = Excel.create
+        excel2.should_not == @excel1
       end
 
       it "should be false with non-Excel objects" do
-        @app1.should_not == "hallo"
-        @app1.should_not == 7
-        @app1.should_not == nil
+        @excel1.should_not == "hallo"
+        @excel1.should_not == 7
+        @excel1.should_not == nil
       end
 
     end
 
+    context "with Visible and DisplayAlerts" do
 
-    context "with :excel" do
-
-      before do
-        Excel.close_all
+      it "should create Excel visible" do
+        excel = Excel.new(:visible => true)
+        excel.Visible.should be_true
+        excel.visible.should be_true
+        excel.DisplayAlerts.should be_false
+        excel.displayalerts.should be_false
+        excel.visible = false
+        excel.Visible.should be_false
+        excel.visible.should be_false
+      end
+
+      it "should create Excel with DispayAlerts enabled" do        
+        excel = Excel.new(:displayalerts => true)
+        excel.DisplayAlerts.should be_true
+        excel.displayalerts.should be_true
+        excel.Visible.should be_false
+        excel.visible.should be_false
+        excel.displayalerts = false
+        excel.DisplayAlerts.should be_false
+        excel.displayalerts.should be_false
+      end
+
+      it "should keep visible and displayalerts values when reusing Excel" do
+        excel = Excel.new(:visible => true)
+        excel.visible.should be_true
+        excel.displayalerts.should be_false
+        excel2 = Excel.new(:displayalerts => true)
+        excel2.should == excel
+        excel.visible.should be_true
+        excel.displayalerts.should be_true        
+      end
+
+      it "should keep displayalerts and visible values when reusing Excel" do
+        excel = Excel.new(:displayalerts => true)
+        excel.visible.should be_false
+        excel.displayalerts.should be_true
+        excel2 = Excel.new(:visible => true)
+        excel2.should == excel
+        excel.visible.should be_true
+        excel.displayalerts.should be_true        
       end
 
-      after (:each) do
-        Excel.close_all
-      end
+    end
 
-      it "should reuse in given excel app" do
-        app1 = Excel.new(:reuse => false)
-        app2 = Excel.new(:reuse => false)
-        app3 = Excel.new(:excel => app1)
-        app4 = Excel.new(:excel => app2)
-        app3.should == app1
-        app4.should == app2
+
+    context "with displayalerts" do
+      before do
+        @excel1 = Excel.new(:displayalerts => true)
+        @excel2 = Excel.new(:displayalerts => false, :reuse => false)
+      end
+
+      it "should turn off displayalerts" do
+        @excel1.DisplayAlerts.should be_true
+        begin
+          @excel1.with_displayalerts false do
+            @excel1.DisplayAlerts.should be_false
+            raise TestError, "any_error"
+          end
+        rescue TestError
+          @excel1.DisplayAlerts.should be_true
+        end
+      end
+    
+      it "should turn on displayalerts" do
+        @excel2.DisplayAlerts.should be_false
+        begin
+          @excel1.with_displayalerts true do
+            @excel1.DisplayAlerts.should be_true
+            raise TestError, "any_error"
+          end
+        rescue TestError
+          @excel2.DisplayAlerts.should be_false
+        end
       end
 
     end
 
-    context "with Visible and DisplayAlerts" do
-
+    context "method delegation for capitalized methods" do
       before do
-        Excel.close_all
+        @excel1 = Excel.new
       end
 
-      after (:each) do
-        Excel.close_all
+      it "should raise WIN32OLERuntimeError" do
+        expect{ @excel1.NonexistingMethod }.to raise_error(VBAMethodMissingError)
       end
 
-      it "should be visible" do
-        app = Excel.new(:visible => true)
-        app.Visible.should == true
-        app.DisplayAlerts.should == false
+      it "should raise NoMethodError for uncapitalized methods" do
+        expect{ @excel1.nonexisting_method }.to raise_error(NoMethodError)
       end
+    end
 
-      it "should displayalerts" do        
-        app = Excel.new(:displayalerts => true)
-        app.DisplayAlerts.should == true
-        app.Visible.should == false
+    context "with hwnd and hwnd2excel" do
+      
+      before do
+        @excel1 = Excel.new
+        @excel2 = Excel.new(:reuse => false)
       end
 
-      it "should visible and displayalerts" do
-        app = Excel.new(:visible => true)
-        app.Visible.should == true
-        app.DisplayAlerts.should == false
-        app2 = Excel.new(:displayalerts => true)
-        app2.Visible.should == true
-        app2.DisplayAlerts.should == true
+      it "should yield the correct hwnd" do
+        @excel1.Hwnd.should == @excel1.hwnd
+        @excel2.Hwnd.should == @excel2.hwnd
       end
 
+      it "should provide the same excel instances" do
+        @excel1.should_not == @excel2
+        excel3 = Excel.hwnd2excel(@excel1.hwnd)
+        excel4 = Excel.hwnd2excel(@excel2.hwnd)
+        @excel1.should == excel3
+        @excel2.should == excel4
+        excel3.should_not == excel4 
+      end
     end
-
   end
 
+
+
   describe "RobustExcelOle" do
     context "#absolute_path" do
       it "should work" do
@@ -185,7 +237,7 @@ module RobustExcelOle
         RobustExcelOle::absolute_path("C:abc").should == File.expand_path("abc").gsub("/","\\")
       end
 
-      it "should return right absoute path name" do
+      it "should return right absolute path name" do
         @filename = 'C:/Dokumente und Einstellungen/Zauberthomas/Eigene Dateien/robust_excel_ole/spec/book_spec.rb'
         RobustExcelOle::absolute_path(@filename).gsub("\\","/").should == @filename
       end
@@ -194,3 +246,6 @@ module RobustExcelOle
   end
 
 end
+
+class TestError < RuntimeError
+end