robust_excel_ole 0.3.8 → 0.3.9

data/spec/book_specs/book_all_spec.rb

@@ -5,7 +5,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 
 $VERBOSE = nil
 
-include RobustExcelOle
+include General
 
 unless Object.method_defined?(:require_relative)
   def require_relative path

data/spec/book_specs/book_close_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book 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)
-        @sheet_count = @book.workbook.Worksheets.Count
+        @sheet_count = @book.ole_workbook.Worksheets.Count
         @book.add_sheet(@sheet, :as => 'a_name')
       end
 
@@ -60,7 +61,7 @@ describe Book do
           @book.close
           }.to_not raise_error
         new_book = Book.open(@simple_file)
-        new_book.workbook.Worksheets.Count.should ==  @sheet_count
+        new_book.ole_workbook.Worksheets.Count.should ==  @sheet_count
         new_book.close
       end
     end
@@ -68,7 +69,7 @@ describe Book do
     context "with unsaved book" do
       before do
         @book = Book.open(@simple_file)
-        @sheet_count = @book.workbook.Worksheets.Count
+        @sheet_count = @book.ole_workbook.Worksheets.Count
         @book.add_sheet(@sheet, :as => 'a_name')
         @sheet = @book[0]
       end
@@ -90,7 +91,7 @@ describe Book do
       end
 
       it "should keep the book open" do
-        ole_workbook = @book.workbook
+        ole_workbook = @book.ole_workbook
         excel = @book.excel
         excel.Workbooks.Count.should == 1
         @book.close(:if_unsaved => :keep_open)
@@ -99,18 +100,18 @@ describe Book do
       end
 
       it "should close the book and leave its file untouched with option :forget" do
-        ole_workbook = @book.workbook
+        ole_workbook = @book.ole_workbook
         excel = @book.excel
         excel.Workbooks.Count.should == 1
         @book.close(:if_unsaved => :forget)
         excel.Workbooks.Count.should == 0
-        @book.workbook.should == nil
+        @book.ole_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
+          new_book.ole_workbook.Worksheets.Count.should ==  @sheet_count
         ensure
           new_book.close
         end
@@ -124,18 +125,18 @@ describe Book do
 
 
       it "should save the book before close with option :save" do
-        ole_workbook = @book.workbook
+        ole_workbook = @book.ole_workbook
         excel = @book.excel
         excel.Workbooks.Count.should == 1
         @book.close(:if_unsaved => :save)
         excel.Workbooks.Count.should == 0
-        @book.workbook.should == nil
+        @book.ole_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
+          new_book.ole_workbook.Worksheets.Count.should == @sheet_count + 1
         ensure
           new_book.close
         end
@@ -155,27 +156,27 @@ describe Book do
           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
+            ole_workbook = @book.ole_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.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 => :alert)
               @book.excel.Workbooks.Count.should == 0
-              @book.workbook.should == nil
+              @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.workbook.Worksheets.Count.should == @sheet_count + (answer==:yes ? 1 : 0)
+              new_book.ole_workbook.Worksheets.Count.should == @sheet_count + (answer==:yes ? 1 : 0)
               new_book.excel.DisplayAlerts.should == displayalert_value
             ensure
               new_book.close

data/spec/book_specs/book_misc_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book do
 
@@ -323,15 +324,15 @@ describe Book do
         @book.excel.visible = true
         @book.excel.visible.should be_true
         @book.visible.should be_true
-        @book.excel.Windows(@book.workbook.Name).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.workbook.Name).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.workbook.Name).Visible.should be_true
+        @book.excel.Windows(@book.ole_workbook.Name).Visible.should be_true
       end
 
     end

data/spec/book_specs/book_open_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book do
 
@@ -68,7 +69,7 @@ describe Book do
       end
 
       it "should fetch the workbook" do
-        workbook = @book.workbook
+        workbook = @book.ole_workbook
         new_book = Book.new(workbook)
         new_book.should be_a Book
         new_book.should be_alive
@@ -82,7 +83,7 @@ describe Book do
       end
 
       it "should fetch the workbook" do
-        workbook = @book.workbook
+        workbook = @book.ole_workbook
         new_book = Book.new(workbook, :visible => true)
         new_book.should be_a Book
         new_book.should be_alive
@@ -96,7 +97,7 @@ describe Book do
       end
 
       it "should yield an identical Book and set visible and displayalerts values" do
-        workbook = @book.workbook
+        workbook = @book.ole_workbook
         new_book = Book.new(workbook, :visible => true, :displayalerts => true)
         new_book.should be_a Book
         new_book.should be_alive
@@ -232,9 +233,9 @@ describe Book do
         book4.excel.should === @book.excel
         book3.close
         book4.close
-        book5 = Book.open(@simple_file, :force_excel => book2.workbook)
+        book5 = Book.open(@simple_file, :force_excel => book2.ole_workbook)
         book5.excel.should ===  book2.excel
-        win32ole_excel1 = WIN32OLE.connect(@book.workbook.Fullname).Application
+        win32ole_excel1 = WIN32OLE.connect(@book.ole_workbook.Fullname).Application
         book6 = Book.open(@simple_file, :force_excel => win32ole_excel1)
         book6.excel.should === @book.excel
       end
@@ -570,7 +571,7 @@ describe Book do
               book_before.close
             end
             @book = Book.open(@simple_file_other_path)
-            @sheet_count = @book.workbook.Worksheets.Count
+            @sheet_count = @book.ole_workbook.Worksheets.Count
             @sheet = @book[0]
             @book.add_sheet(@sheet, :as => 'a_name')
           end
@@ -599,7 +600,7 @@ describe Book do
             @new_book.should be_alive
             @new_book.filename.downcase.should == @simple_file.downcase
             old_book = Book.open(@simple_file_other_path, :if_obstructed => :forget)
-            old_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
+            old_book.ole_workbook.Worksheets.Count.should ==  @sheet_count + 1
             old_book.close
           end
 
@@ -614,7 +615,7 @@ describe Book do
             @new_book.should be_alive
             @new_book.filename.downcase.should == @simple_file.downcase
             old_book = Book.open(@simple_file_other_path, :if_obstructed => :forget)
-            old_book.workbook.Worksheets.Count.should ==  @sheet_count + 1
+            old_book.ole_workbook.Worksheets.Count.should ==  @sheet_count + 1
             old_book.close
           end
 
@@ -893,7 +894,7 @@ describe Book do
       end
 
       it "should uplift a workbook to a book with an open book" do
-        workbook = @book.workbook
+        workbook = @book.ole_workbook
         book1 = Book.new(workbook)
         book1.should be_a Book
         book1.should be_alive

data/spec/book_specs/book_save_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book do
 
@@ -40,11 +41,11 @@ describe Book do
       it "should save for a file opened without :read_only" do
         @book = Book.open(@simple_file)
         @book.add_sheet(@sheet, :as => 'a_name')
-        @new_sheet_count = @book.workbook.Worksheets.Count
+        @new_sheet_count = @book.ole_workbook.Worksheets.Count
         expect {
           @book.save
         }.to_not raise_error
-        @book.workbook.Worksheets.Count.should ==  @new_sheet_count
+        @book.ole_workbook.Worksheets.Count.should ==  @new_sheet_count
         @book.close
       end
 
@@ -378,7 +379,7 @@ describe Book do
 
           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.workbook.Close
+            @book.ole_workbook.Close
             expect{
               @book.save_as(@simple_save_file, :if_exists => :alert)
               }.to raise_error(ExcelErrorSave, "Workbook is not alive")

data/spec/book_specs/book_sheet_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book do
 
@@ -45,14 +46,14 @@ describe Book do
 
     context "only first argument" do
       it "should add worksheet" do
-        @book.workbook.Worksheets.Count == 3
+        @book.ole_workbook.Worksheets.Count == 3
         @book.add_sheet @sheet
-        @book.workbook.Worksheets.Count == 4
+        @book.ole_workbook.Worksheets.Count == 4
       end
 
       it "should return copyed sheet" do
         sheet = @book.add_sheet @sheet
-        copyed_sheet = @book.workbook.Worksheets.Item(@book.workbook.Worksheets.Count)
+        copyed_sheet = @book.ole_workbook.Worksheets.Item(@book.ole_workbook.Worksheets.Count)
         sheet.name.should eq copyed_sheet.name
       end
     end
@@ -106,14 +107,14 @@ describe Book do
 
     context "without argument" do
       it "should add empty sheet" do
-        @book.workbook.Worksheets.Count.should == 3
+        @book.ole_workbook.Worksheets.Count.should == 3
         @book.add_sheet
-        @book.workbook.Worksheets.Count.should == 4
+        @book.ole_workbook.Worksheets.Count.should == 4
       end
 
       it "should return copyed sheet" do
         sheet = @book.add_sheet
-        copyed_sheet = @book.workbook.Worksheets.Item(@book.workbook.Worksheets.Count)
+        copyed_sheet = @book.ole_workbook.Worksheets.Item(@book.ole_workbook.Worksheets.Count)
         sheet.name.should eq copyed_sheet.name
       end
     end

data/spec/book_specs/book_unobtr_spec.rb

@@ -6,6 +6,7 @@ require File.join(File.dirname(__FILE__), './../spec_helper')
 $VERBOSE = nil
 
 include RobustExcelOle
+include General
 
 describe Book do
 
@@ -301,7 +302,7 @@ describe Book do
         old_cell_value = sheet[1,1].value
         @book.close
         @book.should_not be_alive
-        Excel.close_all
+        Excel.kill_all
         Book.unobtrusively(@simple_file, :keep_open => true) do |book|
           book.should be_a Book
           book.excel.should == @book.excel

data/spec/excel_spec.rb

@@ -4,7 +4,7 @@ require File.join(File.dirname(__FILE__), './spec_helper')
 
 $VERBOSE = nil
 
-include RobustExcelOle
+include General
 
 module RobustExcelOle
 
@@ -16,7 +16,6 @@ module RobustExcelOle
 
     before do
       @dir = create_tmpdir
-      #print "tmpdir: "; p @dir
       @simple_file = @dir + '/workbook.xls'
       @another_simple_file = @dir + '/another_workbook.xls'
       @different_file = @dir + '/different_workbook.xls'
@@ -81,7 +80,7 @@ module RobustExcelOle
         end
 
         it "lifts an Excel instance given as WIN32Ole object" do    
-          win32ole_excel = WIN32OLE.connect(@book.workbook.Fullname).Application
+          win32ole_excel = WIN32OLE.connect(@book.ole_workbook.Fullname).Application
           excel = Excel.new(win32ole_excel)
           excel.should be_a Excel
           excel.should be_alive
@@ -91,7 +90,7 @@ module RobustExcelOle
         it "lifts an Excel instance given as WIN32Ole object with options" do    
           @excel.Visible = true
           @excel.DisplayAlerts = true
-          win32ole_excel = WIN32OLE.connect(@book.workbook.Fullname).Application
+          win32ole_excel = WIN32OLE.connect(@book.ole_workbook.Fullname).Application
           excel = Excel.new(win32ole_excel)
           excel.should be_a Excel
           excel.should be_alive
@@ -403,7 +402,6 @@ module RobustExcelOle
           @key_sender.close
         end
 
-
         it "should save if user answers 'yes'" do
           @key_sender.puts "{enter}"
           Excel.close_all(:if_unsaved => :alert)
@@ -807,7 +805,7 @@ module RobustExcelOle
           # unsaved_workbooks yields different WIN32OLE objects than book.workbook
           uw_names = []
           excel.unsaved_workbooks.each {|uw| uw_names << uw.Name}
-          uw_names.should == [@book.workbook.Name]
+          uw_names.should == [@book.ole_workbook.Name]
         end
 
         it "should list all unsaved workbooks" do
@@ -817,8 +815,8 @@ module RobustExcelOle
             unsaved_workbooks.each {|uw| uw_names << uw.Name}
             result << uw_names
           end
-          result.include?([@book.workbook.Name]).should be_true
-          result.include?([@book2.workbook.Name]).should be_true
+          result.include?([@book.ole_workbook.Name]).should be_true
+          result.include?([@book2.ole_workbook.Name]).should be_true
         end
 
       end
@@ -837,7 +835,7 @@ module RobustExcelOle
           workbook = @excel1.generate_workbook(@file_name)
           workbook.should be_a WIN32OLE
           workbook.Name.should == File.basename(@file_name)
-          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
+          workbook.FullName.should == General::absolute_path(@file_name)
           workbook.Saved.should be_true
           workbook.ReadOnly.should be_false
           workbook.Sheets.Count.should == 3
@@ -849,7 +847,7 @@ module RobustExcelOle
           workbook = @excel1.generate_workbook(@file_name)
           workbook.should be_a WIN32OLE
           workbook.Name.should == File.basename(@file_name)
-          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
+          workbook.FullName.should == General::absolute_path(@file_name)
           workbook.Saved.should be_true
           workbook.ReadOnly.should be_false
           workbook.Sheets.Count.should == 3
@@ -866,7 +864,7 @@ module RobustExcelOle
           workbook = @excel1.generate_workbook(@file_name)
           workbook.should be_a WIN32OLE
           workbook.Name.should == File.basename(@file_name)
-          workbook.FullName.should == RobustExcelOle::absolute_path(@file_name)
+          workbook.FullName.should == General::absolute_path(@file_name)
           workbook.Saved.should be_true
           workbook.ReadOnly.should be_false
           workbook.Sheets.Count.should == 3

data/spec/general_spec.rb

@@ -0,0 +1,193 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+
+$VERBOSE = nil
+
+include General
+include RobustExcelOle
+
+module RobustExcelOle
+
+  describe General 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.kill_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.kill_all
+      rm_tmp(@dir)
+    end
+
+    describe "methods, own_methods, respond_to?" do
+
+      before do
+        @book1 = Book.open(@simple_file)
+        @ole_workbook_methods = 
+          ["Activate", "ActiveSheet", "Application", "Close", "FullName", "HasPassword", "Name", "Names", 
+            "Password", "Protect", "ProtectSharing", "ProtectStructure", "Protect", "ReadOnly", "Save", 
+            "SaveAs", "Saved", "Sheets", "Unprotect"]
+        @book_methods = ["activate", "add_sheet", "alive?", "close", "filename", "nvalue", "ole_object", 
+                         "ole_workbook", "reopen", "save", "save_as", "saved", "set_nvalue"]
+        @ole_excel_methods = 
+          ["ActiveCell", "ActiveSheet", "ActiveWorkbook", "Application",  "Calculate", "Cells", "Columns",
+            "DisplayAlerts", "Evaluate", "Hwnd", "Name", "Names", "Quit", "Range", "Ready", "Save", 
+            "Sheets", "UserName", "Value", "Visible", "Workbooks", "Worksheets"]
+        @excel_methods = ["alive?", "book_class", "close", "displayalerts", "recreate", "visible", "with_displayalerts"] 
+      end
+
+      after do
+        @book1.close
+      end
+
+      it "should do methods for book" do
+        ((@ole_workbook_methods + @book_methods) - @book1.methods).should be_empty
+        (Object.instance_methods.select{|m| m =~ /^(?!\_)/} - @book1.methods).should be_empty
+      end
+
+      it "should do own_methods with popular ole_workbook and workbook methods" do
+        ((@ole_workbook_methods + @book_methods) - @book1.own_methods).should be_empty
+        (Object.instance_methods - @book1.own_methods).should == Object.instance_methods 
+      end
+
+      it "should respond to popular workbook methods" do
+        @book_methods.each{|m| @book1.respond_to?(m).should be_true}
+      end
+
+      it "should do methods for excel" do
+        ((@ole_excel_methods + @excel_methods) - @book1.excel.methods).should be_empty
+        (Object.instance_methods.select{|m| m =~ /^(?!\_)/}  - @book1.excel.methods).sort.should be_empty       
+      end
+
+      it "should do own_methods with popular ole_excel and excel methods" do
+        ((@ole_excel_methods + @excel_methods) - @book1.excel.own_methods).should be_empty
+         (Object.instance_methods - @book1.excel.own_methods).should == Object.instance_methods
+      end
+
+      it "should respond to popular excel methods" do
+        @excel_methods.each{|m| @book1.excel.respond_to?(m).should be_true}
+      end
+
+    end
+
+    describe "#absolute_path" do
+      
+      context "with standard" do
+        
+        before do
+          @previous_dir = Dir.getwd
+        end
+        
+        after do
+          Dir.chdir @previous_dir
+        end
+
+        it "should return the right absolute paths" do
+          absolute_path("C:/abc").should == "C:\\abc"
+          absolute_path("C:\\abc").should == "C:\\abc"
+          Dir.chdir "C:/windows"
+          absolute_path("C:abc").downcase.should == Dir.pwd.gsub("/","\\").downcase + "\\abc"
+          absolute_path("C:abc").upcase.should   == File.expand_path("abc").gsub("/","\\").upcase
+        end
+
+        it "should return right absolute path name" do
+          filename = 'C:/Dokumente und Einstellungen/Zauberthomas/Eigene Dateien/robust_excel_ole/spec/book_spec.rb'
+          absolute_path(filename).gsub("\\","/").should == filename
+        end
+      end
+    end
+
+    describe "canonize" do
+
+      context "with standard" do
+        
+        it "should reduce slash at the end" do
+          normalize("hallo/").should == "hallo"
+          normalize("/this/is/the/Path/").should == "/this/is/the/Path"
+        end
+
+        it "should save capital letters" do
+          normalize("HALLO/").should == "HALLO"
+          normalize("/This/IS/tHe/patH/").should == "/This/IS/tHe/patH"
+        end
+
+        it "should reduce multiple shlashes" do
+          normalize("/this/is//the/path").should == "/this/is/the/path"
+          normalize("///this/////////is//the/path/////").should == "/this/is/the/path"
+        end
+
+        it "should reduce dots in the paths" do
+          canonize("/this/is/./the/path").should == "/this/is/the/path"
+          canonize("this/.is/./the/pa.th/").should == "this/.is/the/pa.th"
+          canonize("this//.///.//.is/the/pa.th/").should == "this/.is/the/pa.th"
+        end
+
+        it "should change to the upper directory with two dots" do
+          canonize("/this/is/../the/path").should == "/this/the/path"
+          canonize("this../.i.s/.../..the/..../pa.th/").should == "this../.i.s/.../..the/..../pa.th"
+        end
+
+        it "should downcase" do
+          canonize("/This/IS/tHe/path").should == "/this/is/the/path"
+          canonize("///THIS/.///./////iS//the/../PatH/////").should == "/this/is/path"
+        end
+
+        it "should raise an error for no strings" do
+          expect{
+            canonize(1)
+          }.to raise_error(ExcelError, "No string given to canonize, but 1")
+        end
+
+      end
+    end
+
+    describe "Object methods" do
+
+      before do
+        @book = Book.open(@simple_file)
+        @sheet = @book[0]
+      end
+
+      before do
+        @book.close
+      end
+
+      it "should raise an error when asking excel of a sheet" do
+        expect{
+          @sheet.excel
+          }.to raise_error(ExcelError, "receiver instance is neither an Excel nor a Book")
+      end
+
+    end
+
+    describe "trace" do
+
+      it "should put some number" do
+        a = 4
+        trace "some text #{a}"
+      end
+
+      it "should put another text" do
+        a = 5
+        trace "another text #{a}"
+      end
+    end
+
+  end
+end