robust_excel_ole 1.29 → 1.30

data/spec/general_spec.rb

@@ -9,6 +9,9 @@ include RobustExcelOle
 
 module RobustExcelOle
 
+  using StringRefinement
+  using ToReoRefinement
+
   describe General do
 
     before(:all) do

data/spec/workbook_spec.rb

@@ -1103,12 +1103,12 @@ describe Workbook do
     end   
 
     it "should return value of a range" do
-      @book1.namevalue_glob("new").should == "foo"
-      @book1.namevalue_glob("one").should == 1
-      @book1.namevalue_glob("firstrow").should == [[1,2]]        
-      @book1.namevalue_glob("four").should == [[1,2],[3,4]]
-      @book1.namevalue_glob("firstrow").should_not == "12"
-      @book1.namevalue_glob("firstcell").should == "foo"        
+      @book1.namevalue_global("new").should == "foo"
+      @book1.namevalue_global("one").should == 1
+      @book1.namevalue_global("firstrow").should == [[1,2]]        
+      @book1.namevalue_global("four").should == [[1,2],[3,4]]
+      @book1.namevalue_global("firstrow").should_not == "12"
+      @book1.namevalue_global("firstcell").should == "foo"        
     end
 
     it "should return value of a range via []" do
@@ -1121,17 +1121,17 @@ describe Workbook do
     end
 
     it "should set value of a range" do
-      @book1.set_namevalue_glob("new", "bar")
-      @book1.namevalue_glob("new").should == "bar"
+      @book1.set_namevalue_global("new", "bar")
+      @book1.namevalue_global("new").should == "bar"
     end
 
     it "should set value of a range via []=" do
       @book1["new"] = "bar"
-      @book1.namevalue_glob("new").should == "bar"
+      @book1.namevalue_global("new").should == "bar"
     end
 
     #it "should evaluate a formula" do
-    #  @book1.namevalue_glob("named_formula").should == 4      
+    #  @book1.namevalue_global("named_formula").should == 4      
     #end
 
     #it "should evaluate a formula via []" do
@@ -1139,7 +1139,7 @@ describe Workbook do
     #end
 
     #it "should return default value if name not defined" do
-    #  @book1.namevalue_glob("foo", :default => 2).should == 2
+    #  @book1.namevalue_global("foo", :default => 2).should == 2
     #end
 
   end

data/spec/workbook_specs/workbook_misc_spec.rb

@@ -669,7 +669,7 @@ describe Workbook do
     end
   end
 
-  describe "namevalue_glob, set_namevalue_glob, [], []=" do
+  describe "namevalue_global, set_namevalue_global, [], []=" do
   
     before do
       @book1 = Workbook.open(@another_simple_file)
@@ -680,12 +680,12 @@ describe Workbook do
     end   
 
     it "should return value of a range" do
-      @book1.namevalue_glob("new").should == "foo"
-      @book1.namevalue_glob("one").should == 1
-      @book1.namevalue_glob("firstrow").should == [[1,2]]        
-      @book1.namevalue_glob("four").should == [[1,2],[3,4]]
-      @book1.namevalue_glob("firstrow").should_not == "12"
-      @book1.namevalue_glob("firstcell").should == "foo"        
+      @book1.namevalue_global("new").should == "foo"
+      @book1.namevalue_global("one").should == 1
+      @book1.namevalue_global("firstrow").should == [[1,2]]        
+      @book1.namevalue_global("four").should == [[1,2],[3,4]]
+      @book1.namevalue_global("firstrow").should_not == "12"
+      @book1.namevalue_global("firstcell").should == "foo"        
     end
 
     it "should return value of a range via []" do
@@ -698,17 +698,17 @@ describe Workbook do
     end
 
     it "should set value of a range" do
-      @book1.set_namevalue_glob("new", "bar")
-      @book1.namevalue_glob("new").should == "bar"
+      @book1.set_namevalue_global("new", "bar")
+      @book1.namevalue_global("new").should == "bar"
     end
 
     it "should set value of a range via []=" do
       @book1["new"] = "bar"
-      @book1.namevalue_glob("new").should == "bar"
+      @book1.namevalue_global("new").should == "bar"
     end
 
     #it "should evaluate a formula" do
-    #  @book1.namevalue_glob("named_formula").should == 4      
+    #  @book1.namevalue_global("named_formula").should == 4      
     #end
 
     #it "should evaluate a formula via []" do
@@ -717,28 +717,28 @@ describe Workbook do
 
     it "should raise an error if name not defined and default value is not provided" do
       expect {
-        @book1.namevalue_glob("foo", :default => nil)
+        @book1.namevalue_global("foo", :default => nil)
       }.to_not raise_error
       expect {
-        @book1.namevalue_glob("foo", :default => :__not_provided)
+        @book1.namevalue_global("foo", :default => :__not_provided)
       }.to raise_error(NameNotFound, /name "foo" not in #<Workbook: another_workbook/)
       expect {
-        @book1.namevalue_glob("foo")
+        @book1.namevalue_global("foo")
       }.to raise_error(NameNotFound, /name "foo" not in #<Workbook: another_workbook/)
-      @book1.namevalue_glob("foo", :default => nil).should be_nil
-      @book1.namevalue_glob("foo", :default => 1).should == 1
+      @book1.namevalue_global("foo", :default => nil).should be_nil
+      @book1.namevalue_global("foo", :default => 1).should == 1
       expect {
-          @book1.set_namevalue_glob("foo","bar")
+          @book1.set_namevalue_global("foo","bar")
       }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "foo"/)
       expect {
           @book1["foo"] = "bar"
       }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "foo"/)
-      @book1.namevalue_glob("empty", :default => 1).should be_nil
+      @book1.namevalue_global("empty", :default => 1).should be_nil
     end    
 
     it "should raise an error if name was defined but contents is calcuated" do
       expect {
-        @book1.set_namevalue_glob("named_formula","bar")
+        @book1.set_namevalue_global("named_formula","bar")
       }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "named_formula" in #<Workbook: another_workbook/)
       expect {
         @book1["named_formula"] = "bar"
@@ -747,19 +747,19 @@ describe Workbook do
 
     # Excel Bug: for local names without uqifier: takes the first sheet as default even if another sheet is activated
     it "should take the first sheet as default even if the second sheet is activated" do
-      @book1.namevalue_glob("Sheet1!localname").should == "bar"
-      @book1.namevalue_glob("Sheet2!localname").should == "simple"
-      @book1.namevalue_glob("localname").should == "bar"
+      @book1.namevalue_global("Sheet1!localname").should == "bar"
+      @book1.namevalue_global("Sheet2!localname").should == "simple"
+      @book1.namevalue_global("localname").should == "bar"
       @book1.Worksheets.Item(2).Activate
-      @book1.namevalue_glob("localname").should == "bar"
+      @book1.namevalue_global("localname").should == "bar"
       @book1.Worksheets.Item(1).Delete
-      @book1.namevalue_glob("localname").should == "simple"
+      @book1.namevalue_global("localname").should == "simple"
     end
 
     it "should color the cell (deprecated)" do
-      @book1.set_namevalue_glob("new", "bar")
+      @book1.set_namevalue_global("new", "bar")
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == -4142
-      @book1.set_namevalue_glob("new", "bar", :color => 4)
+      @book1.set_namevalue_global("new", "bar", :color => 4)
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1["new"].should == "bar"
       @book1["new"] = "bar"
@@ -771,9 +771,9 @@ describe Workbook do
     end
 
     it "should color the cell" do
-      @book1.set_namevalue_glob("new", "bar")
+      @book1.set_namevalue_global("new", "bar")
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == -4142
-      @book1.set_namevalue_glob("new", "bar", :color => 4)
+      @book1.set_namevalue_global("new", "bar", :color => 4)
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1["new"].should == "bar"
       @book1["new"] = "bar"
@@ -796,7 +796,7 @@ describe Workbook do
 
     it "should rename a range" do
       @book1.rename_range("four","five")
-      @book1.namevalue_glob("five").should == [[1,2],[3,4]]
+      @book1.namevalue_global("five").should == [[1,2],[3,4]]
       expect {
         @book1.rename_range("four","five")
       }.to raise_error(NameNotFound, /name "four" not in "another_workbook.xls"/)
@@ -1165,7 +1165,7 @@ describe Workbook do
         @book1.add_name("foo",[1,1])
         @book1.delete_name("foo")
         expect{
-          @book1.namevalue_glob("foo")
+          @book1.namevalue_global("foo")
         }.to raise_error(NameNotFound, /name "foo"/)
       end
 

data/spec/workbook_specs/workbook_open_spec.rb

@@ -273,6 +273,17 @@ describe Workbook do
       bookstore = Bookstore.new
     end
 
+    it "should fetch a network path file given a not via Reo opened hostname share file" do
+      ole_e1 = WIN32OLE.new('Excel.Application')
+      ws = ole_e1.Workbooks
+      abs_filename = General.absolute_path(@simple_file_hostname_share_path)
+      @ole_wb = ws.Open(abs_filename)
+      book2 = Workbook.open(@simple_file_network_path)
+      #book2.should === @ole_wb.to_reo
+      book2.Fullname.should == @ole_wb.Fullname
+      book2.excel.Workbooks.Count.should == 1
+    end
+
     it "should fetch a network path file given a hostname share file" do
       book1 = Workbook.open(@simple_file_hostname_share_path)
       book2 = Workbook.open(@simple_file_network_path)

data/spec/workbook_specs/workbook_unobtr_spec.rb

@@ -25,6 +25,7 @@ describe Workbook do
     @simple_file_other_path = @dir + '/more_data/workbook.xls'
     @another_simple_file = @dir + '/another_workbook.xls'
     @linked_file = @dir + '/workbook_linked.xlsm'
+    @linked_sub_file = @dir + '/workbook_linked_sub.xlsm'
     @simple_file_xlsm = @dir + '/workbook.xlsm'
     @simple_file_xlsx = @dir + '/workbook.xlsx'
     @simple_file1 = @simple_file
@@ -35,9 +36,237 @@ describe Workbook do
     rm_tmp(@dir)
   end
 
-  describe "Workbook#for_reading, #for_modifying" do
+  describe "writable" do
+
+    context "with no book" do
+
+      it "should open in read-only mode" do
+        Workbook.unobtrusively(@simple_file1, :writable => false) do |book|            
+          book.ReadOnly.should be true
+        end
+      end
+
+      it "should open in writable mode" do
+        Workbook.unobtrusively(@simple_file1, :writable => true) do |book|            
+          book.ReadOnly.should be false
+        end
+      end
+
+    end
+
+    context "with open writable book" do
+
+      before do
+        @book = Workbook.open(@simple_file1)
+      end
+
+      it "should keep the read-only mode" do
+        Workbook.unobtrusively(@simple_file1, :writable => false) do |book|            
+          book.ReadOnly.should be false
+        end
+      end
+
+    end
+
+    context "with open read-only book" do
+
+      before do
+        @book = Workbook.open(@simple_file1, :read_only => true)
+      end
+
+      it "should keep the read-only mode" do
+        Workbook.unobtrusively(@simple_file1, :writable => true) do |book|            
+          book.ReadOnly.should be true
+        end
+      end
+
+    end
+
+  end
+
+  describe "for_reading, for_modifying" do
+
+    context "with no workbook" do
+
+      it "should open with read-only" do
+        Workbook.for_reading(@simple_file1) do |book|
+          book.should be_a Workbook
+          book.should be_alive
+          book.ReadOnly.should be true
+          book.Saved.should be true  
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          @new_cell_value = sheet[1,1].Value
+          book.Saved.should be false
+        end
+        Excel.kill_all
+        new_book = Workbook.open(@simple_file1)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should_not == @new_cell_value
+      end
+
+      it "should change the value" do
+        Workbook.for_modifying(@simple_file1) do |book|
+          book.should be_a Workbook
+          book.should be_alive
+          book.ReadOnly.should be false
+          book.Saved.should be true  
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          @new_cell_value = sheet[1,1].Value
+          book.Saved.should be false
+        end
+        Excel.kill_all
+        new_book = Workbook.open(@simple_file1)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should == @new_cell_value
+      end
+
+    end
+
+    context "with closed writable workbook" do
+
+      before do
+        @book = Workbook.open(@simple_file1)
+        sheet = @book.sheet(1)
+        @old_cell_value = sheet[1,1].Value
+        @book.close
+      end
+
+      it "should not change the value" do
+        Workbook.for_reading(@simple_file1) do |book|
+          book.should be_a Workbook
+          book.should be_alive
+          book.ReadOnly.should be true
+          book.Saved.should be true  
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.Saved.should be false
+          book.excel.should == @book.excel
+        end
+        Excel.kill_all
+        new_book = Workbook.open(@simple_file1)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should == @old_cell_value
+      end
+
+      it "should not change the value and use a given Excel" do
+        new_excel = Excel.new(:reuse => false)
+        another_excel = Excel.new(:reuse => false)
+        Workbook.for_reading(@simple_file1, :if_closed => another_excel) do |book|
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.excel.should == another_excel
+        end
+        Excel.kill_all
+        new_book = Workbook.open(@simple_file1)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should == @old_cell_value
+      end
+
+      it "should not change the value and use the new Excel instance" do
+        new_excel = Excel.new(:reuse => false)
+        Workbook.for_reading(@simple_file1, :if_closed => :new) do |book|
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.excel.should_not == @book.excel
+          book.excel.should_not == new_excel
+          book.excel.properties[:visible].should be false
+          book.excel.properties[:displayalerts].should == :if_visible
+        end
+        Excel.kill_all
+        new_book = Workbook.open(@simple_file1)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should == @old_cell_value
+      end
+
+      it "should change the value" do
+        Workbook.for_modifying(@simple_file1) do |book|
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.excel.should == @book.excel
+        end
+        new_book = Workbook.open(@simple_file, :visible => true)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should_not == @old_cell_value
+      end
+
+      it "should change the value and use a given Excel" do
+        @book.close
+        new_excel = Excel.new(:reuse => false)
+        another_excel = Excel.new(:reuse => false)
+        Workbook.for_modifying(@simple_file1, :if_closed => another_excel) do |book|
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.excel.should == another_excel
+        end
+        new_book = Workbook.open(@simple_file1, :visible => true)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should_not == @old_cell_value
+      end
+
+      it "should change the value and use the new Excel instance" do
+        new_excel = Excel.new(:reuse => false)
+        Workbook.for_modifying(@simple_file1, :if_closed => :new) do |book|
+          sheet = book.sheet(1)
+          cell = sheet[1,1]
+          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
+          book.excel.should_not == @book.excel
+          book.excel.should_not == new_excel
+          book.excel.properties[:visible].should be false
+          book.excel.properties[:displayalerts].should == :if_visible
+        end
+        new_book = Workbook.open(@simple_file1, :visible => true)
+        sheet = new_book.sheet(1)
+        sheet[1,1].Value.should_not == @old_cell_value
+      end
+    end
+  end
+
+  describe "Workbook.for_reading, for_modifying" do
+
+  
+
     
-    context "with standard" do
+      
+        
+        
+      
+      
+        
+      
+          
+        
+        
+      
+        
+      
+
+      
+        
+
+      
+    
+      
+      
+          
+      
+        
+      
+  
+  
+      
+
+    
+    
+    context "with open writable book" do
 
       before do
         @book = Workbook.open(@simple_file1)
@@ -52,6 +281,7 @@ describe Workbook do
         @book.for_reading do |book|
           book.should be_a Workbook
           book.should be_alive
+          book.ReadOnly.should be false
           book.Saved.should be true  
           book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
           book.Saved.should be false
@@ -106,6 +336,60 @@ describe Workbook do
  
   end
 
+  describe "with referenced book" do
+
+    context "with no books" do
+
+      it "should open in read-only" do
+        Workbook.unobtrusively(@linked_sub_file, :writable => false) do |book|            
+          book.ReadOnly.should be true
+          book.filename.should == @linked_sub_file
+        end
+      end
+
+      it "should raise error when trying to change" do
+
+        expect{
+          Workbook.unobtrusively(@linked_sub_file, :writable => false) do |book|            
+            book.ReadOnly.should be true
+            book.filename.should == @linked_sub_file
+            book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo" 
+          end
+        }.to raise_error(WorkbookReadOnly)
+
+      end
+    end
+
+    context "with open books" do
+
+      before do
+        @book_main = Workbook.open(@linked_file)
+        @book_sub = Workbook.open(@linked_sub_file)
+      end
+
+      it "should leave the read-only mode" do
+        Workbook.unobtrusively(@linked_sub_file, :read_only_default => true) do |book|            
+          book.ReadOnly.should be false
+          book.should == @book_sub
+          book.filename.should == @book_sub.filename
+          book.excel.should == @book_sub.excel
+        end
+      end
+      
+      it "should force to read-only" do
+        expect{
+          Workbook.unobtrusively(@linked_sub_file, :if_unsaved => :forget, :read_only => true) do |book|            
+            book.ReadOnly.should be true
+            book.should == @book_sub
+            book.filename.should == @book_sub.filename
+            book.excel.should == @book_sub.excel
+            book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo" 
+          end
+          }.to raise_error(WorkbookReadOnly)
+      end
+    end
+  end
+
   describe "Workbook#unobtrusively" do
 
     context "with a writable saved workbook" do
@@ -778,7 +1062,7 @@ describe Workbook do
           b1.sheet(1)[1,1].Value.should_not == @old_value
         end
 
-        it "should open as read-write" do
+        it "should open as read-write but not save changes" do
           Workbook.unobtrusively(@simple_file, :read_only => false, :writable => false) do |book|
             book.ReadOnly.should be false
             @old_value = book.sheet(1)[1,1].Value
@@ -838,9 +1122,9 @@ describe Workbook do
           b1.sheet(1)[1,1].Value.should == @old_value
         end
 
-        it "should open not writable" do
+        it "should open not writable and read-only" do
           Workbook.unobtrusively(@simple_file, :writable => false) do |book|
-            #
+            book.ReadOnly.should be true
             @old_value = book.sheet(1)[1,1].Value
             book.sheet(1)[1,1] = book.sheet(1)[1,1].Value == "foo" ? "bar" : "foo"
             book.Saved.should be false            
@@ -2336,108 +2620,4 @@ describe Workbook do
 
   end
 
-  describe "for_reading, for_modifying" do
-
-    context "open unobtrusively for reading and modifying" do
-
-      before do
-        @book = Workbook.open(@simple_file1)
-        sheet = @book.sheet(1)
-        @old_cell_value = sheet[1,1].Value
-        @book.close
-      end
-
-      it "should not change the value" do
-        Workbook.for_reading(@simple_file1) do |book|
-          book.should be_a Workbook
-          book.should be_alive
-          book.Saved.should be true  
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.Saved.should be false
-          book.excel.should == @book.excel
-        end
-        Excel.kill_all
-        new_book = Workbook.open(@simple_file1)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should == @old_cell_value
-      end
-
-      it "should not change the value and use a given Excel" do
-        new_excel = Excel.new(:reuse => false)
-        another_excel = Excel.new(:reuse => false)
-        Workbook.for_reading(@simple_file1, :if_closed => another_excel) do |book|
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.excel.should == another_excel
-        end
-        Excel.kill_all
-        new_book = Workbook.open(@simple_file1)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should == @old_cell_value
-      end
-
-      it "should not change the value and use the new Excel instance" do
-        new_excel = Excel.new(:reuse => false)
-        Workbook.for_reading(@simple_file1, :if_closed => :new) do |book|
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.excel.should_not == @book.excel
-          book.excel.should_not == new_excel
-          book.excel.properties[:visible].should be false
-          book.excel.properties[:displayalerts].should == :if_visible
-        end
-        Excel.kill_all
-        new_book = Workbook.open(@simple_file1)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should == @old_cell_value
-      end
-
-      it "should change the value" do
-        Workbook.for_modifying(@simple_file1) do |book|
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.excel.should == @book.excel
-        end
-        new_book = Workbook.open(@simple_file, :visible => true)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should_not == @old_cell_value
-      end
-
-      it "should change the value and use a given Excel" do
-        new_excel = Excel.new(:reuse => false)
-        another_excel = Excel.new(:reuse => false)
-        Workbook.for_modifying(@simple_file1, :if_closed => another_excel) do |book|
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.excel.should == another_excel
-        end
-        new_book = Workbook.open(@simple_file1, :visible => true)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should_not == @old_cell_value
-      end
-
-      it "should change the value and use the new Excel instance" do
-        new_excel = Excel.new(:reuse => false)
-        Workbook.for_modifying(@simple_file1, :if_closed => :new) do |book|
-          sheet = book.sheet(1)
-          cell = sheet[1,1]
-          sheet[1,1] = cell.Value == "foo" ? "bar" : "foo"
-          book.excel.should_not == @book.excel
-          book.excel.should_not == new_excel
-          book.excel.properties[:visible].should be false
-          book.excel.properties[:displayalerts].should == :if_visible
-        end
-        new_book = Workbook.open(@simple_file1, :visible => true)
-        sheet = new_book.sheet(1)
-        sheet[1,1].Value.should_not == @old_cell_value
-      end
-    end
-  end
-  
 end