robust_excel_ole 0.3.5 → 0.3.6

data/lib/robust_excel_ole/sheet.rb

@@ -2,7 +2,6 @@
 module RobustExcelOle
   class Sheet
     attr_reader :worksheet
-    include Enumerable
 
     def initialize(win32_worksheet)
       @worksheet = win32_worksheet
@@ -26,9 +25,9 @@ module RobustExcelOle
         @worksheet.Name = new_name
       rescue WIN32OLERuntimeError => msg
         if msg.message =~ /800A03EC/ 
-          raise ExcelErrorSheet, "sheet name already exists"
+          raise ExcelErrorSheet, "sheet name #{new_name.inspect} already exists"
         else
-          puts "#{msg.message}"
+          t "#{msg.message}"
           raise ExcelErrorSheetUnknown
         end
       end
@@ -109,17 +108,17 @@ module RobustExcelOle
     #                                raise an error, otherwise
     def nvalue(name, opts = {:default => nil})
       begin
-        item = self.Names.Item(name)
+        value = self.Evaluate(name)
+        value = value.Value if value.class == WIN32OLE
       rescue WIN32OLERuntimeError
         return opts[:default] if opts[:default]
-        raise SheetError, "name #{name} not in sheet"
+        raise SheetError, "cannot evaluate name #{name.inspect} in sheet"
       end
-      begin
-        value = item.RefersToRange.Value
-      rescue  WIN32OLERuntimeError
+      if value == -2146826259
         return opts[:default] if opts[:default]
-        raise SheetError, "RefersToRange of name #{name}"
+        raise SheetError, "cannot evaluate name #{name.inspect} in sheet"
       end
+      return opts[:default] if (value.nil? && opts[:default])
       value
     end
 
@@ -127,12 +126,12 @@ module RobustExcelOle
       begin
         item = self.Names.Item(name)
       rescue WIN32OLERuntimeError
-        raise SheetError, "name #{name} not in sheet"
+        raise SheetError, "name #{name.inspect} not in sheet"
       end
       begin
         item.RefersToRange.Value = value
       rescue  WIN32OLERuntimeError
-        raise SheetError, "RefersToRange of name #{name}"
+        raise SheetError, "RefersToRange of name #{name.inspect}"
       end
     end
 
@@ -147,16 +146,30 @@ module RobustExcelOle
           self.Names.Add("Name" => name, "RefersToR1C1" => "=" + address)
         end
       rescue WIN32OLERuntimeError => msg
-        puts "WIN32OLERuntimeError: #{msg.message}"
-        raise SheetError, "cannot add name #{name} to cell with row #{row} and column #{column}"
+        t "WIN32OLERuntimeError: #{msg.message}"
+        raise SheetError, "cannot add name #{name.inspect} to cell with row #{row.inspect} and column #{column.inspect}"
       end
     end
 
-    def method_missing(id, *args)  # :nodoc: #
-      @worksheet.send(id, *args)
+    private
+
+    def method_missing(name, *args) 
+    if name.to_s[0,1] =~ /[A-Z]/ 
+      begin
+        @worksheet.send(name, *args)
+      rescue WIN32OLERuntimeError => msg
+        if msg.message =~ /unknown property or method/
+          raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+        else 
+          raise msg
+        end
+      end
+    else  
+      super 
     end
+  end
+
 
-    private
     def last_row
       special_last_row = @worksheet.UsedRange.SpecialCells(RobustExcelOle::XlLastCell).Row
       used_last_row = @worksheet.UsedRange.Rows.Count

data/lib/robust_excel_ole/version.rb

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

data/lib/spec_helper.rb

@@ -4,7 +4,7 @@ require 'tmpdir'
 require "fileutils"
 require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
 
-module RobustExcelOle::SpecHelpers
+module RobustExcelOle::SpecHelpers   # :nodoc: #
   def create_tmpdir   # :nodoc: #
     tmpdir = Dir.mktmpdir
     FileUtils.cp_r(File.join(File.dirname(__FILE__), 'data'), tmpdir)

data/reo.bat

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

data/spec/book_specs/book_all_spec.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './../spec_helper')
+
+
+$VERBOSE = nil
+
+include RobustExcelOle
+
+unless Object.method_defined?(:require_relative)
+  def require_relative path
+    require File.expand_path(path, File.dirname(__FILE__))  
+  end
+end
+
+require_relative "book_open_spec"
+require_relative "book_close_spec"
+require_relative "book_save_spec"
+require_relative "book_misc_spec"
+require_relative "book_sheet_spec"
+require_relative "book_unobtr_spec"
+require_relative "book_subclass_spec"

data/spec/{book_close_spec.rb → book_specs/book_close_spec.rb}

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require File.join(File.dirname(__FILE__), './../spec_helper')
 
 
 $VERBOSE = nil
@@ -80,21 +80,21 @@ describe Book do
       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)})")
+        }.to raise_error(ExcelErrorClose, /workbook is unsaved: "workbook.xls"/)
       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)})")
+        }.to raise_error(ExcelErrorClose, /workbook is unsaved: "workbook.xls"/)
       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)
+        excel.Workbooks.Count.should == 1
+        @book.close(:if_unsaved => :forget)
+        excel.Workbooks.Count.should == 0
         @book.workbook.should == nil
         @book.should_not be_alive
         expect{
@@ -110,16 +110,16 @@ describe Book do
       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") 
+        }.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)
+        excel.Workbooks.Count.should == 1
+        @book.close(:if_unsaved => :save)
+        excel.Workbooks.Count.should == 0
         @book.workbook.should == nil
         @book.should_not be_alive
         expect{
@@ -134,7 +134,7 @@ describe Book do
 
       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"
+          @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Excel" '  , "w"
         end
 
         after do
@@ -157,9 +157,9 @@ describe Book do
               @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.excel.Workbooks.Count.should == 1
+              @book.close(:if_unsaved => :alert)
+              @book.excel.Workbooks.Count.should == 0
               @book.workbook.should == nil
               @book.should_not be_alive
               expect{ole_workbook.Name}.to raise_error(WIN32OLERuntimeError)

data/spec/{book_misc_spec.rb → book_specs/book_misc_spec.rb}

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require File.join(File.dirname(__FILE__), './../spec_helper')
 
 
 $VERBOSE = nil
@@ -63,7 +63,19 @@ describe Book do
       it "should send Fullname to workbook" do
         @book.Fullname.tr('\\','/').should == @simple_file
       end
+
+      it "should raise an error for unknown methods or properties" do
+        expect{
+          @book.Foo
+        }.to raise_error(VBAMethodMissingError, /unknown VBA property or method :Foo/)
+      end
+
+      it "should report that workbook is not alive" do
+        @book.close
+        expect{ @book.Nonexisting_method }.to raise_error(ExcelError, "method missing: workbook not alive")
+      end
     end
+
   end
 
   describe "hidden_excel" do
@@ -117,24 +129,19 @@ describe Book do
       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")
+        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
         expect {
           @book1["foo"]
-        }.to raise_error(ExcelErrorNValue, "name foo not in another_workbook.xls")
+        }.to raise_error(ExcelError, /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")
+      it "should evaluate a formula" do
+        @book1.nvalue("named_formula").should == 4
+        @book1["named_formula"].should == 4
       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
 
@@ -157,19 +164,19 @@ describe Book do
       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")
+        }.to raise_error(ExcelError, /name "foo" not in "another_workbook.xls"/)
         expect {
           @book1["foo"] = "bar"
-        }.to raise_error(ExcelErrorNValue, "name foo not in another_workbook.xls")
+        }.to raise_error(ExcelError, /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")
+        }.to raise_error(ExcelError, /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")
+        }.to raise_error(ExcelError, /RefersToRange error of name "named_formula" in "another_workbook.xls"/)
       end
 
       it "should set value of a range" do
@@ -194,7 +201,7 @@ describe Book do
         @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")
+        }.to raise_error(ExcelError, /name "four" not in "another_workbook.xls"/)
       end
     end
   end
@@ -265,12 +272,12 @@ describe Book do
       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 = Book.new(@simple_file_other_path, :force_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 = Book.new(@simple_file, :force_excel => :new)
         @new_book.should_not == @book
       end
 
@@ -302,7 +309,7 @@ describe Book do
       end
     end
 
-    context "with visible and displayalerts" do
+    context "with visible" do
 
       before do
         @book = Book.open(@simple_file)
@@ -312,25 +319,27 @@ describe Book do
         @book.close
       end
 
-      it "should make Excel visible" do
-        @book.excel.visible = false
-        @book.excel.visible.should be_false
+      it "should make the workbook visible" 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.visible = false
+        @book.excel.visible.should be_true
+        @book.visible.should be_false
+        @book.excel.Windows(@book.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
       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"        
+        @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

data/spec/{book_open_spec.rb → book_specs/book_open_spec.rb}

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require File.join(File.dirname(__FILE__), './../spec_helper')
 
 
 $VERBOSE = nil
@@ -13,7 +13,8 @@ describe Book 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
+    #Excel.close_all
+    Excel.kill_all
   end
 
   before do
@@ -29,7 +30,8 @@ describe Book do
   end
 
   after do
-    Excel.close_all
+    Excel.kill_all
+    #Excel.close_all
     rm_tmp(@dir)
   end
 
@@ -229,7 +231,7 @@ describe Book do
         @book.close
         expect{
           Book.open(@simple_file, :force_excel => :book)
-          }.to raise_error(ExcelErrorOpen, "provided instance is neither an Excel nor a Book")
+          }.to raise_error(ExcelError, "receiver instance is neither an Excel nor a Book")
       end
 
       it "should do force_excel even if both force_ and default_excel is given" do
@@ -396,7 +398,7 @@ describe Book do
       it "should raise an error, if :if_unsaved is :raise" do
         expect {
           @new_book = Book.open(@simple_file, :if_unsaved => :raise)
-        }.to raise_error(ExcelErrorOpen, "book is already open but not saved (#{File.basename(@simple_file)})")
+        }.to raise_error(ExcelErrorOpen, /workbook is already open but not saved: "workbook.xls"/)
       end
 
       it "should let the book open, if :if_unsaved is :accept" do
@@ -417,7 +419,7 @@ describe Book do
 
       context "with :if_unsaved => :alert" do
         before do
-         @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '/helpers/key_sender.rb') + '" "Microsoft Office Excel" '  , "w"
+         @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '../helpers/key_sender.rb') + '" "Microsoft Office Excel" '  , "w"
         end
 
         after do
@@ -459,13 +461,13 @@ describe Book do
       it "should raise an error, if :if_unsaved is default" do
         expect {
           @new_book = Book.open(@simple_file, :if_unsaved => :raise)
-        }.to raise_error(ExcelErrorOpen, "book is already open but not saved (#{File.basename(@simple_file)})")
+        }.to raise_error(ExcelErrorOpen, /workbook is already open but not saved: "workbook.xls"/)
       end
 
       it "should raise an error, if :if_unsaved is invalid option" do
         expect {
           @new_book = Book.open(@simple_file, :if_unsaved => :invalid_option)
-        }.to raise_error(ExcelErrorOpen, ":if_unsaved: invalid option: invalid_option")
+        }.to raise_error(ExcelErrorOpen, ":if_unsaved: invalid option: :invalid_option")
       end
     end
 
@@ -494,7 +496,7 @@ describe Book do
           it "should raise an error, if :if_obstructed is :raise" do
             expect {
               @new_book = Book.open(@simple_file, :if_obstructed => :raise)
-            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path: workbook.xls")
+            }.to raise_error(ExcelErrorOpen, /blocked by a book with the same name in a different path: "workbook.xls"/)
           end
 
           it "should close the other book and open the new book, if :if_obstructed is :forget" do
@@ -518,7 +520,7 @@ describe Book do
               if :if_obstructed is :close_if_saved" do
             expect{
               @new_book = Book.open(@simple_file, :if_obstructed => :close_if_saved)
-            }.to raise_error(ExcelErrorOpen, "book with the same name in a different path is unsaved: workbook.xls")
+            }.to raise_error(ExcelErrorOpen, /workbook with the same name in a different path is unsaved: "workbook.xls"/)
             @book.save
             @new_book = Book.open(@simple_file, :if_obstructed => :close_if_saved)
             @book.should_not be_alive
@@ -539,14 +541,14 @@ describe Book do
 
           it "should raise an error, if :if_obstructed is default" do
             expect {
-              @new_book = Book.open(@simple_file)
-            }.to raise_error(ExcelErrorOpen, "blocked by a book with the same name in a different path: workbook.xls")
+              @new_book = Book.open(@simple_file)              
+            }.to raise_error(ExcelErrorOpen, /blocked by a book with the same name in a different path: "workbook.xls"/)
           end         
 
           it "should raise an error, if :if_obstructed is invalid option" do
             expect {
               @new_book = Book.open(@simple_file, :if_obstructed => :invalid_option)
-            }.to raise_error(ExcelErrorOpen, ":if_obstructed: invalid option: invalid_option")
+            }.to raise_error(ExcelErrorOpen, ":if_obstructed: invalid option: :invalid_option")
           end
         end
       end
@@ -590,7 +592,7 @@ describe Book do
         File.delete @simple_save_file rescue nil
         expect {
           Book.open(@simple_save_file, :if_absent => :raise)
-        }.to raise_error(ExcelErrorOpen, "file #{@simple_save_file} not found")
+        }.to raise_error(ExcelErrorOpen, "file \"#{@simple_save_file}\" not found")
       end
 
       it "should create a workbook" do
@@ -605,7 +607,7 @@ describe Book do
         File.delete @simple_save_file rescue nil
         expect {
           Book.open(@simple_save_file)
-        }.to raise_error(ExcelErrorOpen, "file #{@simple_save_file} not found")
+        }.to raise_error(ExcelErrorOpen, "file \"#{@simple_save_file}\" not found")
       end
 
     end
@@ -761,7 +763,7 @@ describe Book do
         expected_path = Regexp.new(File.expand_path(path).gsub(/\//, "."))
         expect {
           Book.open(path)
-        }.to raise_error(ExcelErrorOpen, "file #{path} not found")
+        }.to raise_error(ExcelErrorOpen, "file \"#{path}\" not found")
       end
     end
   end
@@ -790,4 +792,26 @@ describe Book do
       end
     end
   end
+
+  describe "uplifting" do
+
+    context "with standard" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close
+      end
+
+      it "should uplift a workbook to a book with an open book" do
+        workbook = @book.workbook
+        book1 = Book.new(workbook)
+        book1.should be_a Book
+        book1.should be_alive
+        book1.should == @book
+      end
+    end
+  end
 end