robust_excel_ole 1.1.3 → 1.1.4

data/lib/robust_excel_ole/general.rb

@@ -9,7 +9,7 @@ module General
   end
 
   def canonize(filename)    # :nodoc: #
-    raise TypeErrorREO, "No string given to canonize, but #{filename.inspect}" unless filename.is_a?(String)  
+    raise TypeREOError, "No string given to canonize, but #{filename.inspect}" unless filename.is_a?(String)  
     normalize(filename).downcase
   end
 

data/lib/robust_excel_ole/reo_common.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-LOG_TO_STDOUT = true     unless Object.const_defined?(:LOG_TO_STDOUT)
-REO_LOG_DIR   = "" unless Object.const_defined?(:REO_LOG_DIR)
+LOG_TO_STDOUT = true      unless Object.const_defined?(:LOG_TO_STDOUT)
+REO_LOG_DIR   = ""        unless Object.const_defined?(:REO_LOG_DIR)
 REO_LOG_FILE  = "reo.log" unless Object.const_defined?(:REO_LOG_FILE)
   
 File.delete REO_LOG_FILE rescue nil
@@ -11,76 +11,76 @@ module RobustExcelOle
   class REOError < RuntimeError                 # :nodoc: #
   end                 
 
-  class ExcelError < REOError                   # :nodoc: #
+  class ExcelREOError < REOError                   # :nodoc: #
   end
 
-  class WorkbookError < REOError                # :nodoc: #
+  class WorkbookREOError < REOError                # :nodoc: #
   end
 
-  class FileError < REOError                    # :nodoc: #
+  class FileREOError < REOError                    # :nodoc: #
   end
 
-  class NamesError < REOError                   # :nodoc: #
+  class NamesREOError < REOError                   # :nodoc: #
   end
 
-  class MiscError < REOError                    # :nodoc: #
+  class MiscREOError < REOError                    # :nodoc: #
   end
 
-  class ExcelDamaged < ExcelError               # :nodoc: #
+  class ExcelDamaged < ExcelREOError               # :nodoc: #
   end
 
-  class UnsavedWorkbooks < ExcelError           # :nodoc: #
+  class UnsavedWorkbooks < ExcelREOError           # :nodoc: #
   end
 
-  class WorkbookBlocked < WorkbookError         # :nodoc: #
+  class WorkbookBlocked < WorkbookREOError         # :nodoc: #
   end
 
-  class WorkbookNotSaved < WorkbookError        # :nodoc: #
+  class WorkbookNotSaved < WorkbookREOError        # :nodoc: #
   end
 
-  class WorkbookReadOnly < WorkbookError        # :nodoc: #
+  class WorkbookReadOnly < WorkbookREOError        # :nodoc: #
   end
 
-  class WorkbookBeingUsed < WorkbookError       # :nodoc: #
+  class WorkbookBeingUsed < WorkbookREOError       # :nodoc: #
   end
 
-  class FileNotFound < FileError                # :nodoc: #
+  class FileNotFound < FileREOError                # :nodoc: #
   end
 
-  class FileNameNotGiven < FileError            # :nodoc: #
+  class FileNameNotGiven < FileREOError            # :nodoc: #
   end
 
-  class FileAlreadyExists < FileError           # :nodoc: #
+  class FileAlreadyExists < FileREOError           # :nodoc: #
   end
 
-  class NameNotFound < NamesError               # :nodoc: #
+  class NameNotFound < NamesREOError               # :nodoc: #
   end
 
-  class NameAlreadyExists < NamesError          # :nodoc: #
+  class NameAlreadyExists < NamesREOError          # :nodoc: #
   end
 
-  class RangeNotEvaluatable < MiscError         # :nodoc: #
+  class RangeNotEvaluatable < MiscREOError         # :nodoc: #
   end
 
-  class OptionInvalid < MiscError               # :nodoc: #
+  class OptionInvalid < MiscREOError               # :nodoc: #
   end
 
-  class ObjectNotAlive < MiscError              # :nodoc: #
+  class ObjectNotAlive < MiscREOError              # :nodoc: #
   end
 
-  class TypeErrorREO < REOError                 # :nodoc: #
+  class TypeREOError < REOError                    # :nodoc: #
   end   
 
-  class TimeOut < REOError                      # :nodoc: #
+  class TimeOut < REOError                         # :nodoc: #
   end  
 
-  class UnexpectedError < REOError              # :nodoc: #
+  class UnexpectedREOError < REOError              # :nodoc: #
   end
 
   class REOCommon
 
     def excel
-      raise TypeErrorREO, "receiver instance is neither an Excel nor a Book"
+      raise TypeREOError, "receiver instance is neither an Excel nor a Book"
     end
 
     def own_methods
@@ -126,31 +126,41 @@ module RobustExcelOle
   class RangeOwners < REOCommon
 
     # returns the contents of a range with given name
-    # evaluates formula contents of the range is a formula
-    # if no contents could be returned, then return default value, if provided, raise error otherwise
-    # Excel Bug: if a local name without a qualifier is given, then by default Excel takes the first worksheet,
-    #            even if a different worksheet is active
+    # if the name could not be found or the value could not be determined,
+    #   then return default value, if provided, raise error otherwise
+    # Excel Bug: if a local name without a qualifier is given, 
+    #   then by default Excel takes the first worksheet,
+    #   even if a different worksheet is active
     # @param  [String]      name      the name of the range
     # @param  [Hash]        opts      the options
     # @option opts [Symbol] :default  the default value that is provided if no contents could be returned
     # @return [Variant] the contents of a range with given name
-    def nameval(name, opts = {:default => nil})
-      name_obj = name_object(name)
+    def nameval(name, opts = {:default => :__not_provided})
+      name_obj = begin
+        name_object(name)
+      rescue NameNotFound => msg
+        return opts[:default] unless opts[:default] == :__not_provided
+        raise
+      end
       value = begin
         name_obj.RefersToRange.Value
-      rescue  WIN32OLERuntimeError
-        #begin
-        #  self.sheet(1).Evaluate(name_obj.Name)
-        #rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self}"
-        #end
+      rescue WIN32OLERuntimeError
+        sheet = if self.is_a?(Sheet) then self
+        elsif self.is_a?(Book) then self.sheet(1)
+        elsif self.is_a?(Excel) then self.workbook.sheet(1)
+        end
+        begin
+          sheet.Evaluate(name_obj.Name).Value
+        rescue # WIN32OLERuntimeError
+          return opts[:default] unless opts[:default] == :__not_provided
+          raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self}"
+        end
       end
-      if value.is_a?(Bignum)  #RobustExcelOle::XlErrName  
-        return opts[:default] if opts[:default]
+      if value == -2146828288 + RobustExcelOle::XlErrName  
+        return opts[:default] unless opts[:default] == __not_provided
         raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{File.basename(workbook.stored_filename).inspect rescue nil}"
       end 
-      return opts[:default] if opts[:default] && value.nil?
+      return opts[:default] unless opts[:default] == :__not_provided or value.nil?
       value      
     end
 
@@ -172,27 +182,33 @@ module RobustExcelOle
 
     # returns the contents of a range with a locally defined name
     # evaluates the formula if the contents is a formula
-    # if no contents could be returned, then return default value, if provided, raise error otherwise
+    # if the name could not be found or the range or value could not be determined,
+    # then return default value, if provided, raise error otherwise
     # @param  [String]      name      the name of a range
     # @param  [Hash]        opts      the options
     # @option opts [Symbol] :default  the default value that is provided if no contents could be returned
     # @return [Variant] the contents of a range with given name   
-    def rangeval(name, opts = {:default => nil})
+    def rangeval(name, opts = {:default => :__not_provided})
       begin
         range = self.Range(name)
       rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
+        return opts[:default] unless opts[:default] == :__not_provided
         raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
       end
       begin
         value = range.Value
       rescue  WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
+        return opts[:default] unless opts[:default] == :__not_provided
         raise RangeNotEvaluatable, "cannot determine value of range named #{name.inspect} in #{self.inspect}"
       end
-      return opts[:default] if (value.nil? && opts[:default])
-      raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}" if value.is_a?(Bignum)
-      value
+      if value == -2146828288 + RobustExcelOle::XlErrName  
+        return opts[:default] unless opts[:default] == __not_provided
+        raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{File.basename(workbook.stored_filename).inspect rescue nil}"
+      end 
+      return opts[:default] unless opts[:default] == :__not_provided or value.nil?
+      value      
+      #return opts[:default] unless opts[:default] == :__not_provided
+      #raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}" if value == -2146828288 + RobustExcelOle::XlErrName
     end
 
     # assigns a value to a range given a locally defined name
@@ -228,7 +244,7 @@ module RobustExcelOle
         end
       end
     end
-
+     
     def cell_modified?(cell)
       workbook.modified_cells.each{|c| return true if c.Name.Value == cell.Name.Value}    
       false

data/lib/robust_excel_ole/sheet.rb

@@ -35,7 +35,7 @@ module RobustExcelOle
         if msg.message =~ /800A03EC/ 
           raise NameAlreadyExists, "sheet name #{new_name.inspect} already exists"
         else
-          raise UnexpectedError, "unexpected WIN32OLERuntimeError: #{msg.message}"
+          raise UnexpectedREOError, "unexpected WIN32OLERuntimeError: #{msg.message}"
         end
       end
     end
@@ -57,11 +57,7 @@ module RobustExcelOle
         begin
           nameval(name) 
         rescue REOError
-          begin
-            book_class.new(self.Parent).nameval(name)
-          rescue REOError
-            rangeval(name)
-          end
+          rangeval(name)
         end
       end
     end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

data/spec/book_spec.rb

@@ -41,7 +41,7 @@ describe Book do
     context "with standard" do
       it "open an existing file" do
         expect {
-          @book = Book.new(@simple_file)
+          @book = Book.open(@simple_file)
         }.to_not raise_error
         @book.should be_a Book
         @book.close
@@ -400,7 +400,7 @@ describe Book do
           @key_sender.puts "{right}{enter}"
           #expect{
           #  Book.open(@simple_file, :if_unsaved => :alert)
-          #  }.to raise_error(ExcelError, /user canceled or runtime error/)
+          #  }.to raise_error(ExcelREOError, /user canceled or runtime error/)
           @book.should be_alive
         end
 
@@ -422,7 +422,7 @@ describe Book do
           @key_sender.puts "{right}{enter}"
           #expect{
           #  Book.open(@simple_file, :if_unsaved => :excel)
-          #  }.to raise_error(ExcelError, /user canceled or runtime error/)
+          #  }.to raise_error(ExcelREOError, /user canceled or runtime error/)
           @book.should be_alive
         end
 
@@ -653,8 +653,8 @@ describe Book do
         begin
           @excel1.close
           @excel2.close 
-        rescue ExcelError => msg
-          # puts "ExcelError: #{msg.message}" if msg.message =~ /Excel instance not alive or damaged/
+        rescue ExcelREOError => msg
+          # puts "ExcelREOError: #{msg.message}" if msg.message =~ /Excel instance not alive or damaged/
         end
       end
 

data/spec/book_specs/book_misc_spec.rb

@@ -47,6 +47,65 @@ describe Book do
     end
   end
 
+  describe "for_this_workbook" do
+
+    before do
+      @book = Book.open(@simple_file)
+    end
+
+    it "should set options" do
+      @book.for_this_workbook(:visible => true)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_true
+      @book.visible.should be_true
+      @book.ReadOnly.should be_false
+      @book.CheckCompatibility.should be_false
+      @book.for_this_workbook(:visible => false)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_false
+      @book.visible.should be_false
+      @book.ReadOnly.should be_false
+      @book.CheckCompatibility.should be_false
+      @book.for_this_workbook(:read_only => true)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_false
+      @book.visible.should be_false
+      @book.ReadOnly.should be_true
+      @book.CheckCompatibility.should be_false
+      @book.for_this_workbook(:visible => true)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_true
+      @book.visible.should be_true
+      @book.ReadOnly.should be_true
+      @book.CheckCompatibility.should be_false
+      @book.for_this_workbook(:check_compatibility => true)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_true
+      @book.visible.should be_true
+      @book.ReadOnly.should be_true
+      @book.CheckCompatibility.should be_true
+      @book.for_this_workbook(:visible => false, :check_compatibility => false)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_false
+      @book.visible.should be_false
+      @book.ReadOnly.should be_true
+      @book.CheckCompatibility.should be_false
+      @book.for_this_workbook(:calculation => true)
+      @book.excel.Visible.should be_true
+      @book.Windows(@book.Name).Visible.should be_false
+      @book.visible.should be_false
+      @book.ReadOnly.should be_true
+      @book.CheckCompatibility.should be_false
+      @book.excel.calculation.should be_true    
+    end
+
+    it "should set options" do
+      @book.for_this_workbook(:read_only => true, :check_compatibility => true)
+      @book.CheckCompatibility.should be_true
+    end
+
+  end
+
   describe "excel_of" do
 
     before do
@@ -654,16 +713,25 @@ describe Book do
     #  @book1["named_formula"].should == 4      
     #end
 
-    it "should raise an error if name not defined" do
+    it "should raise an error if name not defined and default value is not provided" do
+      expect {
+        @book1.nameval("foo", :default => nil)
+      }.to_not raise_error
+      expect {
+        @book1.nameval("foo", :default => :__not_provided)
+      }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
       expect {
         @book1.nameval("foo")
       }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
+      @book1.nameval("foo", :default => nil).should be_nil
+      @book1.nameval("foo", :default => 1).should == 1
       expect {
           @book1.set_nameval("foo","bar")
       }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
       expect {
           @book1["foo"] = "bar"
       }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
+      @book1.nameval("empty", :default => 1).should be_nil
     end    
 
     it "should raise an error if name was defined but contents is calcuated" do

data/spec/book_specs/book_open_spec.rb

@@ -379,7 +379,7 @@ describe Book do
       it "should raise an error if no Excel or Book is given" do
         expect{
           Book.open(@simple_file1, :force => {:excel => :b})
-          }.to raise_error(TypeErrorREO, "given object is neither an Excel, a Workbook, nor a Win32ole")
+          }.to raise_error(TypeREOError, "given object is neither an Excel, a Workbook, nor a Win32ole")
       end
 
       it "should do force_excel even if both force_ and default_excel is given" do
@@ -537,7 +537,7 @@ describe Book do
       it "should raise an error if no Excel or Book is given" do
         expect{
           Book.open(@simple_file1, :force_excel => :b)
-          }.to raise_error(TypeErrorREO, "given object is neither an Excel, a Workbook, nor a Win32ole")
+          }.to raise_error(TypeREOError, "given object is neither an Excel, a Workbook, nor a Win32ole")
       end
 
       it "should do force_excel even if both force_ and default_excel is given" do
@@ -766,7 +766,7 @@ describe Book do
       it "should raise an error if no Excel or Book is given" do
         expect{
           Book.open(@different_file, :default => {:excel => :a})
-          }.to raise_error(TypeErrorREO, "given object is neither an Excel, a Workbook, nor a Win32ole")
+          }.to raise_error(TypeREOError, "given object is neither an Excel, a Workbook, nor a Win32ole")
       end
       
     end
@@ -948,7 +948,7 @@ describe Book do
       it "should raise an error if no Excel or Book is given" do
         expect{
           Book.open(@different_file, :default_excel => :a)
-          }.to raise_error(TypeErrorREO, "given object is neither an Excel, a Workbook, nor a Win32ole")
+          }.to raise_error(TypeREOError, "given object is neither an Excel, a Workbook, nor a Win32ole")
       end
       
     end
@@ -1240,7 +1240,7 @@ describe Book do
           @key_sender.puts "{right}{enter}"
           expect{
             Book.open(@simple_file1, :if_unsaved => :alert)
-            }.to raise_error(ExcelError, "user canceled or runtime error")
+            }.to raise_error(ExcelREOError, "user canceled or runtime error")
           @book.should be_alive
         end
     
@@ -1274,7 +1274,7 @@ describe Book do
           @key_sender.puts "{right}{enter}"
           expect{
             Book.open(@simple_file1, :if_unsaved => :excel)
-            }.to raise_error(ExcelError, "user canceled or runtime error")
+            }.to raise_error(ExcelREOError, "user canceled or runtime error")
           @book.should be_alive
         end
 =end        
@@ -1407,7 +1407,7 @@ describe Book do
         context "with :if_unsaved => #{options_value} and in the same and different path" do
           before do
             @new_book = Book.open(@simple_file1, :reuse => true, :if_unsaved => options_value)
-            @different_book = Book.new(@different_file, :reuse => true, :if_unsaved => options_value)
+            @different_book = Book.open(@different_file, :reuse => true, :if_unsaved => options_value)
           end
           after do
             @new_book.close
@@ -1537,8 +1537,8 @@ describe Book do
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false
         new_book = Book.open(@simple_file1, :read_only => true, :if_unsaved => :accept)
-        new_book.ReadOnly.should be_false
-        new_book.Saved.should be_false
+        new_book.ReadOnly.should be_true
+        new_book.Saved.should be_true
         new_book.should == book
       end
 
@@ -1569,8 +1569,8 @@ describe Book do
         sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
         book.Saved.should be_false
         new_book = Book.open(@simple_file1, :force => {:excel => book.excel}, :read_only => true, :if_unsaved => :accept)
-        new_book.ReadOnly.should be_false
-        new_book.Saved.should be_false
+        new_book.ReadOnly.should be_true
+        new_book.Saved.should be_true
         new_book.should == book
       end
 
@@ -1636,12 +1636,6 @@ describe Book do
           book.should be_a Book
         end
       end
-      it 'block parameter should be instance of Book for new' do
-        Book.new(@simple_file) do |book|
-          book.should be_a Book
-        end
-      end
-
     end
 
     context "with WIN32OLE#GetAbsolutePathName" do