robust_excel_ole 1.8 → 1.9

data/reo.bat

@@ -1,3 +1,3 @@
 @echo off
 
-irb -f -r ../robust_excel_ole/lib/robust_excel_ole -r ../robust_excel_ole/lib/reo_console.rb
+irb -f -r ./lib/robust_excel_ole -r ./lib/reo_console.rb

data/spec/address_spec.rb

@@ -0,0 +1,174 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+require File.expand_path( '../../lib/robust_excel_ole/reo_common', __FILE__)
+
+$VERBOSE = nil
+
+include General
+include RobustExcelOle
+
+module RobustExcelOle
+
+  describe Address 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
+      @dir = create_tmpdir
+      @simple_file = @dir + '/workbook.xls'
+      @book = Workbook.open(@simple_file)
+    end
+
+    after(:all) do
+      @book.close
+    end
+
+    it "should transform relative r1c1-reference into r1c1-format" do
+      Address.r1c1("Z1S[2]:Z[-1]S4").should == "Z1S(2):Z(-1)S4"
+      Address.r1c1("Z[1]S2:Z3S[4]").should == "Z(1)S2:Z3S(4)"
+      Address.r1c1("Z1S[2]").should == "Z1S(2)"
+      Address.r1c1("Z[-1]S4").should == "Z(-1)S4"
+      Address.r1c1("Z[3]").should == "Z(3)"
+      Address.r1c1("S[-2]").should == "S(-2)"
+    end
+
+    # test for 1.8.6
+    it "should transform relative int_range-reference into r1c1-format" do
+      Address.r1c1([1..2,[3]..4]).should == "Z1S(3):Z2S4"
+      Address.r1c1([[1]..2,3..4]).should == "Z(1)S3:Z2S4"
+      Address.r1c1([[1]..2,nil]).should == "Z(1):Z2"
+      Address.r1c1([nil,[1]..2]).should == "S(1):S2"
+      Address.r1c1([nil,[1]]).should == "S(1):S(1)"
+    end
+
+    it "should transform relative int_range-reference into r1c1-format" do
+      Address.r1c1([1..[-2],[3]..4]).should == "Z1S(3):Z(-2)S4"
+      Address.r1c1([[1]..2,3..[4]]).should == "Z(1)S3:Z2S(4)"
+      Address.r1c1([1..[-2],nil]).should == "Z1:Z(-2)"
+      Address.r1c1([nil,[-1]..2]).should == "S(-1):S2"
+      Address.r1c1([[3]..[3],nil]).should == "Z(3):Z(3)"
+      Address.r1c1([nil,[-2]..[-2]]).should == "S(-2):S(-2)"
+      Address.r1c1([[3],nil]).should == "Z(3):Z(3)"
+    end
+
+    it "should transform relative r1c1-reference into r1c1-format" do
+      Address.int_range("Z1S[2]:Z[3]S4").should == [1..[3],[2]..4]
+      Address.int_range("Z[1]S2:Z3S[4]").should == [[1]..3,2..[4]]
+      Address.int_range("Z1S[2]").should == [1..1,[2]..[2]]
+      Address.int_range("Z[3]S4").should == [[3]..[3],4..4]
+    end
+
+    it "should transform a1-format" do
+      Address.a1("A2").should == "A2"
+      Address.r1c1("A2").should == "Z2S1:Z2S1"
+      Address.int_range("A2").should == [2..2,1..1]
+    end
+
+    it "should transform several-letter-a1-format" do
+      Address.a1("ABO15").should == "ABO15"
+      Address.r1c1("ABO15").should == "Z15S743:Z15S743"
+      Address.int_range("ABO15").should == [15..15,743..743]
+    end
+
+    it "should transform complex a1-format" do
+      Address.a1("A2:B3").should == "A2:B3"
+      Address.r1c1("A2:B3").should == "Z2S1:Z3S2"
+      Address.int_range("A2:B3").should == [2..3,1..2]
+      Address.a1("S1:DP2").should == "S1:DP2"
+      Address.r1c1("S1:DP2").should == "Z1S19:Z2S120"
+      Address.int_range("S1:DP2").should == [1..2,19..120]
+    end
+
+    it "should transform infinite a1-format" do
+      Address.a1("A:B").should == "A:B"
+      Address.r1c1("A:B").should == "S1:S2"
+      Address.int_range("A:B").should == [nil,1..2]
+      Address.a1("1:3").should == "1:3"
+      Address.r1c1("1:3").should == "Z1:Z3"
+      Address.int_range("1:3").should == [1..3,nil]
+      Address.a1("B").should == "B"
+      Address.r1c1("B").should == "S2:S2"
+      Address.int_range("B").should == [nil,2..2]
+      Address.a1("3").should == "3"
+      Address.r1c1("3").should == "Z3:Z3"
+      Address.int_range("3").should == [3..3,nil]
+    end
+
+    it "should transform r1c1-format" do
+      Address.r1c1("Z2S1").should == "Z2S1"
+      Address.int_range("Z2S1").should == [2..2,1..1]
+      expect{
+        Address.a1("Z2S1")
+      }.to raise_error(NotImplementedREOError)
+    end
+
+    it "should transform complex r1c1-format" do
+      Address.r1c1("Z2S1:Z3S2").should == "Z2S1:Z3S2"
+      Address.int_range("Z2S1:Z3S2").should == [2..3,1..2]
+    end
+
+    it "should transform int_range format" do
+      Address.int_range([2..2,1..1]).should == [2..2,1..1]
+      Address.r1c1([2..2,1..1]).should == "Z2S1:Z2S1"
+      expect{
+        Address.a1([2..2,1..1])
+      }.to raise_error(NotImplementedREOError)
+    end
+
+    it "should transform simple int_range format" do
+      Address.int_range([2,1]).should == [2..2,1..1]
+      Address.r1c1([2,1]).should == "Z2S1:Z2S1"
+    end
+
+    it "should transform complex int_range format" do
+      Address.int_range([2,"A"]).should == [2..2,1..1]
+      Address.r1c1([2,"A"]).should == "Z2S1:Z2S1"
+      Address.int_range([2,"A".."B"]).should == [2..2,1..2]
+      Address.r1c1([2,"A".."B"]).should == "Z2S1:Z2S2"
+      Address.int_range([1..2,"C"]).should == [1..2,3..3]
+      Address.r1c1([1..2,"C"]).should == "Z1S3:Z2S3"
+      Address.int_range([1..2,"C".."E"]).should == [1..2,3..5]
+      Address.r1c1([1..2,"C".."E"]).should == "Z1S3:Z2S5"
+      Address.int_range([2,3..5]).should == [2..2,3..5]
+      Address.r1c1([2,3..5]).should == "Z2S3:Z2S5"
+      Address.int_range([1..2,3..5]).should == [1..2,3..5]
+      Address.r1c1([1..2,3..5]).should == "Z1S3:Z2S5"
+    end
+
+    it "should transform infinite int_range format" do
+      Address.int_range([nil,1..2]).should == [nil,1..2]
+      Address.r1c1([nil,1..2]).should == "S1:S2"
+      Address.int_range([1..3,nil]).should == [1..3,nil]
+      Address.r1c1([1..3,nil]).should == "Z1:Z3"
+      Address.int_range([nil,2]).should == [nil,2..2]
+      Address.r1c1([nil,2]).should == "S2:S2"
+      Address.int_range([3,nil]).should == [3..3,nil]
+      Address.r1c1([3,nil]).should == "Z3:Z3"
+    end
+  
+    it "should raise an error" do
+      expect{
+        Address.a1("1A")
+      }.to raise_error(AddressInvalid, /format not correct/)
+      expect{
+        Address.r1c1("A1B")
+      }.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  Address.int_range(["A".."B","C".."D"])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  Address.int_range(["A".."B",1..2])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      #expect{
+      #  Address.int_range(["A".."B",nil])
+      #}.to raise_error(AddressInvalid, /format not correct/)
+      expect{
+        Address.int_range(["A",1,2])
+      }.to raise_error(AddressInvalid, /more than two components/)
+    end
+
+  end
+end

data/spec/excel_spec.rb

@@ -538,7 +538,9 @@ module RobustExcelOle
           it "should close the first Excel without unsaved workbooks and then raise an error" do
             expect{
               Excel.close_all(:if_unsaved => :raise)
-            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+              "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
             sleep 0.2
             @excel1.should_not be_alive
             @excel2.should be_alive
@@ -551,7 +553,9 @@ module RobustExcelOle
           it "should close the first Excel without unsaved workbooks and then raise an error" do
             expect{
               Excel.close_all
-            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+              "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
             sleep 0.2
             @excel1.should_not be_alive
             @excel2.should be_alive
@@ -588,7 +592,8 @@ module RobustExcelOle
           it "should raise an error for invalid option" do
             expect {
               Excel.close_all(:if_unsaved => :invalid_option)
-            }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option") 
+            }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option" +
+              "\nHint: Valid values are :raise, :forget, :save and :alert") 
           end
         end
 
@@ -605,7 +610,9 @@ module RobustExcelOle
           it "should close the 1st and 3rd Excel instances that have saved workbooks" do  
             expect{
               Excel.close_all(:if_unsaved => :raise)
-            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+              "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
             sleep 0.2
             @book1.excel.should_not be_alive
             @book2.excel.should be_alive
@@ -630,7 +637,9 @@ module RobustExcelOle
           it "should close three Excel instances that have saved workbooks" do  
             expect{
               Excel.close_all(:if_unsaved => :raise)
-            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+            }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+              "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
             sleep 0.2
             expect{
               @ole_xl.Name
@@ -708,13 +717,17 @@ module RobustExcelOle
         it "should raise an error" do
           expect{
             @excel.close(:if_unsaved => :raise)
-          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+            "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
         end        
 
         it "should raise an error per default" do
           expect{
             @excel.close(:if_unsaved => :raise)
-          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+            "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
         end        
 
         it "should close the Excel without saving the workbook" do
@@ -757,7 +770,8 @@ module RobustExcelOle
         it "should raise an error for invalid option" do
           expect {
             @excel.close(:if_unsaved => :invalid_option)
-          }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option") 
+          }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option" +
+            "\nHint: Valid values are :raise, :forget, :save and :alert") 
         end
       end
 
@@ -843,13 +857,18 @@ module RobustExcelOle
         it "should raise error" do
           expect{
             @excel.close_workbooks(:if_unsaved => :raise)
-          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+          "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively" )
+
         end
 
         it "should raise error per default" do
           expect{
             @excel.close_workbooks
-          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks")
+          }.to raise_error(UnsavedWorkbooks, "Excel contains unsaved workbooks" +
+            "\nHint: Use option :if_unsaved with values :forget and :save to close the 
+           Excel instance without or with saving the unsaved workbooks before, respectively")
         end
 
         it "should close the workbook with forgetting the workbook" do
@@ -877,11 +896,13 @@ module RobustExcelOle
         it "should raise an error for invalid option" do
           expect {
             @excel.close_workbooks(:if_unsaved => :invalid_option)
-          }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option") 
+          }.to raise_error(OptionInvalid, ":if_unsaved: invalid option: :invalid_option" +
+            "\nHint: Valid values are :raise, :forget, :save and :alert") 
         end
       end
     end
 
+=begin
     describe "retain_saved_workbooks" do
 
       before do
@@ -909,6 +930,8 @@ module RobustExcelOle
       end
     end
 
+=end
+
     describe "unsaved_workbooks" do
 
       context "with standard" do
@@ -938,6 +961,62 @@ module RobustExcelOle
       end
     end
 
+    describe "workbooks, each, each_with_index" do
+
+      before do
+        @excel = Excel.create
+        @book1 = Workbook.open(@simple_file)
+        @book2 = Workbook.open(@different_file)
+      end
+
+      it "should list workbooks" do
+        workbooks = @excel.workbooks
+        workbooks.should == [@book1,@book2]
+      end
+
+      it "should each_workbook" do
+        i = 0
+        @excel.each_workbook do |workbook|
+          workbook.should be_alive
+          workbook.should be_a Workbook
+          workbook.filename.should == @simple_file if i == 0
+          workbook.filename.should == @different_file if i == 1
+          i += 1
+        end
+      end
+
+      it "should each_workbook_with_index" do
+        @excel.each_workbook_with_index do |workbook,i|
+          workbook.should be_alive
+          workbook.should be_a Workbook
+          workbook.filename.should == @simple_file if i == 0
+          workbook.filename.should == @different_file if i == 1
+        end
+      end
+
+      it "should each_workbook with options" do
+        i = 0
+        @excel.each_workbook(:visible => true) do |workbook|
+          workbook.should be_alive
+          workbook.should be_a Workbook
+          workbook.visible.should be true
+          workbook.filename.should == @simple_file if i == 0
+          workbook.filename.should == @different_file if i == 1
+          i += 1
+        end
+      end
+
+      it "should set options" do
+        @excel.each_workbook(:visible => true)
+        [1,2].each do |i|
+          ole_workbook = @excel.Workbooks.Item(i) 
+          ole_workbook.Windows(ole_workbook.Name).Visible.should be true
+        end
+      end
+
+
+    end
+
     describe "unsaved_known_workbooks" do
 
       it "should return empty list" do
@@ -1492,6 +1571,29 @@ module RobustExcelOle
         @excel1.CalculateBeforeSave.should == old_calculatebeforesave
       end
 
+      context "with no visible workbook" do
+        
+        it "should set calculation mode (change from automatic to manual)" do
+          excel1 = Excel.create(:calculation => :automatic)
+          book1 = Workbook.open(@simple_file1, :visible => false)
+          expect( book1.Windows(1).Visible ).to be false
+          expect {       excel1.calculation = :manual 
+            }.to change{ excel1.calculation 
+          }.from(        :automatic
+          ).to(          :manual )
+        end
+
+        it "should set calculation mode (change from manual to automatic)" do
+          excel1 = Excel.create(:calculation => :manual)
+          book1 = Workbook.open(@simple_file1, :visible => false)
+          expect( book1.Windows(1).Visible ).to be false
+          expect {       excel1.calculation = :automatic 
+            }.to change{ excel1.calculation 
+          }.from(        :manual
+          ).to(          :automatic )
+        end
+      end
+
       it "should do with_calculation with workbook" do
         @excel1 = Excel.new
         book = Workbook.open(@simple_file, :visible => true)
@@ -1517,6 +1619,7 @@ module RobustExcelOle
       it "should set calculation mode to manual with workbook" do
         @excel1 = Excel.new
         book = Workbook.open(@simple_file, :visible => true)
+        book.Saved.should be true
         book.Windows(book.Name).Visible = true
         @excel1.calculation = :manual
         @excel1.calculation.should == :manual
@@ -1528,6 +1631,32 @@ module RobustExcelOle
       it "should set calculation mode to automatic with workbook" do
         @excel1 = Excel.new
         book = Workbook.open(@simple_file, :visible => true)
+        book.Saved.should be true
+        @excel1.calculation = :automatic
+        @excel1.calculation.should == :automatic
+        @excel1.Calculation.should == XlCalculationAutomatic
+        @excel1.CalculateBeforeSave.should be false
+        book.Saved.should be true
+      end
+
+      it "should set calculation mode to manual with unsaved workbook" do
+        @excel1 = Excel.new
+        book = Workbook.open(@simple_file, :visible => true)
+        book.sheet(1)[1,1] = "foo"
+        book.Saved.should be false
+        book.Windows(book.Name).Visible = true
+        @excel1.calculation = :manual
+        @excel1.calculation.should == :manual
+        @excel1.Calculation.should == XlCalculationManual
+        @excel1.CalculateBeforeSave.should be false
+        book.Saved.should be false
+      end
+
+      it "should set calculation mode to automatic with unsaved workbook" do
+        @excel1 = Excel.new
+        book = Workbook.open(@simple_file, :visible => true)
+        book.sheet(1)[1,1] = "foo"
+        book.Saved.should be false
         @excel1.calculation = :automatic
         @excel1.calculation.should == :automatic
         @excel1.Calculation.should == XlCalculationAutomatic
@@ -1742,7 +1871,7 @@ module RobustExcelOle
 
         it "should generate a workbook" do
           workbook = @excel1.generate_workbook(@file_name)
-          workbook.should be_a WIN32OLE
+          workbook.should be_a Workbook
           workbook.Name.should == File.basename(@file_name)
           workbook.FullName.should == General::absolute_path(@file_name)
           workbook.Saved.should be true
@@ -1752,26 +1881,11 @@ module RobustExcelOle
           workbooks.Count.should == 1
         end
 
-        it "should generate the same workbook twice" do
-          workbook = @excel1.generate_workbook(@file_name)
-          workbook.should be_a WIN32OLE
-          workbook.Name.should == File.basename(@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
-          workbooks = @excel1.Workbooks
-          workbooks.Count.should == 1
-          workbook2 = @excel1.generate_workbook(@file_name)
-          workbook2.should be_a WIN32OLE
-          workbooks = @excel1.Workbooks
-          workbooks.Count.should == 2
-        end
-
+       
         it "should generate a workbook if one is already existing" do
           book = Workbook.open(@simple_file)
           workbook = @excel1.generate_workbook(@file_name)
-          workbook.should be_a WIN32OLE
+          workbook.should be_a Workbook
           workbook.Name.should == File.basename(@file_name)
           workbook.FullName.should == General::absolute_path(@file_name)
           workbook.Saved.should be true
@@ -1850,6 +1964,31 @@ module RobustExcelOle
         @excel1["foo"].should == [["foo", "workbook", "sheet1", nil], ["foo", 1.0, 2.0, 4.0], ["matz", 3.0, 4.0, 4.0]] 
       end
 
+      it "should add a name of an infinite row range" do
+        @excel1.add_name("foo",[1..3, nil])
+        @excel1.Names.Item("foo").Value.should == "=Sheet1!$1:$3"
+      end
+
+      it "should add a name of an infinite column range" do
+        @excel1.add_name("foo",[nil, "A".."C"])
+        @excel1.Names.Item("foo").Value.should == "=Sheet1!$A:$C"
+      end
+
+      it "should add a name of an infinite row range" do
+        @excel1.add_name("foo",[nil, 1..3])
+        @excel1.Names.Item("foo").Value.should == "=Sheet1!$A:$C"
+      end
+
+      it "should add a name of an infinite column range" do
+        @excel1.add_name("foo",["A:C"])
+        @excel1.Names.Item("foo").Value.should == "=Sheet1!$A:$C"
+      end
+
+      it "should add a name of an infinite column range" do
+        @excel1.add_name("foo",["1:2"])
+        @excel1.Names.Item("foo").Value.should == "=Sheet1!$1:$2"
+      end
+
     end