robust_excel_ole 1.0 → 1.0.1

data/lib/robust_excel_ole/excel.rb

@@ -12,8 +12,13 @@ module RobustExcelOle
   class Excel < REOCommon    
 
     attr_accessor :ole_excel
-    attr_accessor :visible
-    attr_accessor :displayalerts
+    attr_accessor :created
+    
+    # setter methods are implemented below
+    attr_reader :visible
+    attr_reader :displayalerts
+    attr_reader :calculation
+    attr_reader :screenupdating
 
     alias ole_object ole_excel
 
@@ -22,16 +27,20 @@ module RobustExcelOle
     # creates a new Excel instance
     # @param [Hash] options the options
     # @option options [Variant] :displayalerts 
-    # @option options [Boolean] :visible 
+    # @option options [Boolean] :visible
+    # @option options [Symbol]  :calculation
+    # @option options [Boolean] :screenupdating
     # @return [Excel] a new Excel instance
     def self.create(options = {})
       new(options.merge({:reuse => false}))
     end
 
-    # returns (connects to) the current (first opened) Excel instance, if such a running Excel instance exists    
+    # connects to the current (first opened) Excel instance, if such a running Excel instance exists    
     # returns a new Excel instance, otherwise
     # @option options [Variant] :displayalerts 
     # @option options [Boolean] :visible 
+    # @option options [Symbol] :calculation
+    # @option options [Boolean] :screenupdating
     # @return [Excel] an Excel instance
     def self.current(options = {})
       new(options.merge({:reuse => true}))
@@ -42,33 +51,31 @@ module RobustExcelOle
     # @param [Hash] options the options
     # @option options [Boolean] :reuse      
     # @option options [Boolean] :visible
-    # @option options [Variant] :displayalerts  
+    # @option options [Variant] :displayalerts 
+    # @option options [Boolean] :screenupdating 
+    # @option options [Symbol]  :calculation
     # options: 
-    #  :reuse          connects to an already running Excel instance (true) or
-    #                  creates a new Excel instance (false)  (default: true)
-    #  :visible        makes the Excel visible               (default: false)
-    #  :displayalerts  enables or disables DisplayAlerts     (true, false, :if_visible (default))   
+    #  :reuse            connects to an already running Excel instance (true) or
+    #                    creates a new Excel instance (false)  (default: true)
+    #  :visible          makes the Excel visible               (default: false)
+    #  :displayalerts    enables or disables DisplayAlerts     (true, false, :if_visible (default))   
+    #  :calculation      calculation mode is being forced to be manual (:manual) or automatic (:automtic)
+    #                    or is not being forced (default: nil)
+    #  :screenupdating  turns on or off screen updating (default: true)
     # @return [Excel] an Excel instance
     def self.new(options = {})
       if options.is_a? WIN32OLE
         ole_xl = options
       else
         options = {:reuse => true}.merge(options)
-        if options[:reuse] == true then
-          ole_xl = current_excel
-        end
+        ole_xl = current_excel if options[:reuse] == true
       end
-      ole_xl = WIN32OLE.new('Excel.Application') unless ole_xl
-
+      ole_xl ||= WIN32OLE.new('Excel.Application')
       hwnd = ole_xl.HWnd
       stored = hwnd2excel(hwnd)
       if stored and stored.alive?
         result = stored
       else 
-        unless options.is_a? WIN32OLE
-          options[:visible] = options[:visible].nil? ? ole_xl.Visible : options[:visible]
-          options[:displayalerts] = options[:displayalerts].nil? ? :if_visible : options[:displayalerts]
-        end
         result = super(options)
         result.instance_variable_set(:@ole_excel, ole_xl)        
         WIN32OLE.const_load(ole_xl, RobustExcelOle) unless RobustExcelOle.const_defined?(:CONSTANTS)
@@ -77,15 +84,15 @@ module RobustExcelOle
       
       unless options.is_a? WIN32OLE
         begin
-          reused = options[:reuse] && (not stored.nil?)
-          options = { :displayalerts => :if_visible, :visible => false}.merge(options) unless reused
-          visible_value = (reused && options[:visible].nil?) ? result.Visible : options[:visible]
-          displayalerts_value = (reused && options[:displayalerts].nil?) ? 
-            ((result.displayalerts == :if_visible) ? :if_visible : result.DisplayAlerts) : options[:displayalerts]
-          ole_xl.Visible = visible_value
-          ole_xl.DisplayAlerts = (displayalerts_value == :if_visible) ? visible_value : displayalerts_value
-          result.instance_variable_set(:@visible, visible_value)
-          result.instance_variable_set(:@displayalerts, displayalerts_value)
+          reused = options[:reuse] && stored && stored.alive?
+          unless reused
+            options = {:displayalerts => :if_visible, :visible => false, :screenupdating => true}.merge(options)
+          end
+          result.visible = options[:visible] unless options[:visible].nil?
+          result.displayalerts = options[:displayalerts] unless options[:displayalerts].nil?
+          result.calculation = options[:calculation] unless options[:calculation].nil?
+          result.screenupdating = options[:screenupdating] unless options[:screenupdating].nil?
+          result.created = !reused
         rescue WIN32OLERuntimeError
           raise ExcelError, "cannot access Excel"
         end
@@ -94,7 +101,10 @@ module RobustExcelOle
     end
 
     def initialize(options= {}) # :nodoc: #
-      @excel = self
+    end
+
+    def excel
+      self
     end
 
     # reopens a closed Excel instance
@@ -102,8 +112,9 @@ module RobustExcelOle
     # @option opts [Boolean] :reopen_workbooks
     # @option opts [Boolean] :displayalerts
     # @option opts [Boolean] :visible
+    # @option opts [Boolean] :calculation
     # options: reopen_workbooks (default: false): reopen the workbooks in the Excel instances
-    #          :visible (default: false), :displayalerts (default: :if_visible)
+    # :visible (default: false), :displayalerts (default: :if_visible), :calculation (default: false)
     # @return [Excel] an Excel instance
     def recreate(opts = {})      
       unless self.alive?
@@ -114,6 +125,7 @@ module RobustExcelOle
         @ole_excel = WIN32OLE.new('Excel.Application')
         self.visible = opts[:visible]
         self.displayalerts = opts[:displayalerts]        
+        self.calculation = opts[:calculation]
         if opts[:reopen_workbooks]
           books = book_class.books
           books.each do |book|
@@ -176,15 +188,15 @@ module RobustExcelOle
       weak_wkbks = @ole_excel.Workbooks
       if not unsaved_workbooks.empty? then
         case options[:if_unsaved]
-        when Proc then
+        when Proc
           options[:if_unsaved].call(self, unsaved_workbooks)
-        when :raise then
+        when :raise
           raise UnsavedWorkbooks, "Excel contains unsaved workbooks"
-        when :alert then
+        when :alert
           #nothing
-        when :forget then
+        when :forget
           unsaved_workbooks.each {|m| m.Saved = true}
-        when :save then
+        when :save
           unsaved_workbooks.each {|m| m.Save}
         else
           raise OptionInvalid, ":if_unsaved: invalid option: #{options[:if_unsaved].inspect}"
@@ -193,11 +205,10 @@ module RobustExcelOle
       begin
         @ole_excel.Workbooks.Close
       rescue WIN32OLERuntimeError => msg
-        # trace "WIN32OLERuntimeError: #{msg.message}" 
         if msg.message =~ /800A03EC/
           raise ExcelError, "user canceled or runtime error"
         else 
-          raise UnexpectedError, "unknown WIN32OLERuntimeError"
+          raise UnexpectedError, "unknown WIN32OLERuntimeError: #{msg.message}"
         end
       end   
       weak_wkbks = nil
@@ -403,6 +414,7 @@ module RobustExcelOle
           trace "dead reference to an Excel"
           begin 
             @@hwnd2excel.delete(hwnd)
+            nil
           rescue
             trace "Warning: deleting dead reference failed! (hwnd: #{hwnd.inspect})"
           end
@@ -483,17 +495,57 @@ module RobustExcelOle
       end
     end    
 
+    # makes the current Excel instance visible or invisible
+    def visible= visible_value
+      @ole_excel.Visible = @visible = visible_value
+      @ole_excel.DisplayAlerts = @visible if @displayalerts == :if_visible
+    end   
+
     # enables DisplayAlerts in the current Excel instance
     def displayalerts= displayalerts_value
       @displayalerts = displayalerts_value
       @ole_excel.DisplayAlerts = (@displayalerts == :if_visible) ? @ole_excel.Visible : displayalerts_value
     end
 
-    # makes the current Excel instance visible or invisible
-    def visible= visible_value
-      @ole_excel.Visible = @visible = visible_value
-      @ole_excel.DisplayAlerts = @visible if @displayalerts == :if_visible
-    end   
+    # sets ScreenUpdating
+    def screenupdating= screenupdating_value
+      @ole_excel.ScreenUpdating = @screenupdating = screenupdating_value
+    end
+
+    # sets calculation mode
+    def calculation= calculation_mode
+      return if calculation_mode.nil?
+      @calculation = calculation_mode
+      calc_mode_changable = @ole_excel.Workbooks.Count > 0 &&  @ole_excel.Calculation.is_a?(Fixnum)
+      if calc_mode_changable
+        @ole_excel.CalculateBeforeSave = false
+        @ole_excel.Calculation = 
+          (calculation_mode == :automatic) ? XlCalculationAutomatic : XlCalculationManual 
+      end    
+    end
+
+    # VBA method overwritten
+    def Calculation= calculation_vba_mode
+      case calculation_vba_mode
+      when XlCalculationManual
+        @calculation = :manual
+      when XlCalculationAutomatic
+        @calculation = :automatic
+      end
+      @ole_excel.Calculation = calculation_vba_mode
+    end
+
+    # sets calculation mode in a block
+    def with_calculation(calculation_mode)
+      return unless calculation_mode
+      old_calculation_mode = @ole_excel.Calculation
+      begin
+        self.calculation = calculation_mode
+        yield self
+      ensure
+        @ole_excel.Calculation = old_calculation_mode if @ole_excel.Calculation.is_a?(Fixnum)
+      end
+    end
 
     # make all workbooks visible or invisible
     def workbooks_visible= visible_value
@@ -517,30 +569,6 @@ module RobustExcelOle
       #end
     end
 
-    # sets calculation mode in a block
-    def with_calculation(calculation_mode = :automatic)
-      if @ole_excel.Workbooks.Count > 0
-        old_calculation_mode = @ole_excel.Calculation
-        old_calculation_before_save_mode = @ole_excel.CalculateBeforeSave
-        @ole_excel.Calculation = calculation_mode == :automatic ? XlCalculationAutomatic : XlCalculationManual
-        @ole_excel.CalculateBeforeSave = (calculation_mode == :automatic)
-        begin
-          yield self
-        ensure
-          @ole_excel.Calculation = old_calculation_mode if alive?
-          @ole_excel.CalculateBeforeSave = old_calculation_before_save_mode if alive?
-        end
-      end
-    end
-
-    # sets calculation mode
-    def set_calculation(calculation_mode = :automatic)
-      if @ole_excel.Workbooks.Count > 0
-        @ole_excel.Calculation = calculation_mode == :automatic ? XlCalculationAutomatic : XlCalculationManual
-        @ole_excel.CalculateBeforeSave = (calculation_mode == :automatic)
-      end
-    end
-
     # returns the value of a range
     # @param [String] name the name of a range
     # @returns [Variant] the value of the range
@@ -560,7 +588,7 @@ module RobustExcelOle
     # if no contents could be returned, then return default value, if provided, raise error otherwise
     # @param [String] name  the range name
     # @param [Hash]   opts  the options
-    # @option opts [Variant] :default default value (default: nil)
+    # @option opts [Variant] :default value (default: nil)
     def nameval(name, opts = {:default => nil})
       begin
         name_obj = self.Names.Item(name)
@@ -578,7 +606,7 @@ module RobustExcelOle
           raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}"
         end
       end
-      if value == -2146826259
+      if value.is_a?(Bignum)
         return opts[:default] if opts[:default]
         raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}"
       end 
@@ -623,7 +651,7 @@ module RobustExcelOle
         raise RangeNotEvaluatable, "cannot determine value of range named #{name.inspect}"
       end
       return opts[:default] if (value.nil? && opts[:default])
-      raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}" if value == -2146826259
+      raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}" if value.is_a?(Bignum)
       value
     end
 

data/lib/robust_excel_ole/reo_common.rb

@@ -1,4 +1,4 @@
-LOG_TO_STDOUT = false     unless Object.const_defined?(:LOG_TO_STDOUT)
+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)
   
@@ -38,6 +38,24 @@ class REOCommon
       end
     end
   end
+
+  def puts_hash(hash)
+    self.class.puts_hash(hash)
+  end
+
+  def self.puts_hash(hash)
+    hash.each do |e|
+      if e[1].is_a?(Hash)
+        puts "#{e[0]} =>"
+        e[1].each do |f|
+          puts "  #{f[0]} => #{f[1]}"
+        end
+      else
+        puts "#{e[0]} => #{e[1]}"
+      end
+    end
+  end
+
 end
 
 module RobustExcelOle

data/lib/robust_excel_ole/sheet.rb

@@ -36,8 +36,7 @@ module RobustExcelOle
         if msg.message =~ /800A03EC/ 
           raise NameAlreadyExists, "sheet name #{new_name.inspect} already exists"
         else
-          trace "#{msg.message}"
-          raise UnexpectedError
+          raise UnexpectedError, "unexpected WIN32OLERuntimeError: #{msg.message}"
         end
       end
     end
@@ -153,7 +152,7 @@ module RobustExcelOle
           raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self.Name}"
         end
       end
-      if value == RobustExcelOle::XlErrName  # -2146826259
+      if value.is_a?(Bignum)  # RobustExcelOle::XlErrName 
         return opts[:default] if opts[:default]
         raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self.Name}"
       end 

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/robust_excel_ole.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/Thomas008/robust_excel_ole"
   
   s.summary     = "RobustExcelOle automates processing Excel files in Windows by using the win32ole library."
-  s.description = "RobustExcelOle automates modifying, reading and writing Excel files.
+  s.description = "RobustExcelOle automates modifying, reading and writing Excel files in Windows by using the win32ole library.
                    It supports simultaneously running Excel instances and user interactions.
                    RobustExcelOle deals with various cases of Excel (and user) behaviour,
-                   supplies workarounds for some Excel bugs, and supports referenced libraries"                 
+                   supplies workarounds for some Excel bugs, and supports referenced libraries."                 
 
   s. licenses = ['MIT']
   s.rubyforge_project = "robust_excel_ole"

data/spec/book_spec.rb

@@ -70,7 +70,7 @@ describe Book do
       end
 
       it "should open in a new Excel" do
-        book2 = Workbook.open(@simple_file, :force_excel => :new)
+        book2 = Workbook.open(@simple_file, :force => {:excel => :new})
         book2.should be_alive
         book2.should be_a Book
         book2.excel.should_not == @book.excel 
@@ -148,7 +148,7 @@ describe Book do
         old_excel = @book.excel
         @book.close
         @book.should_not be_alive
-        book2 = Book.open(@simple_file, :force_excel => :new)
+        book2 = Book.open(@simple_file, :force => {:excel => :new})
         book2.should_not === @book
         book2.should be_alive
         book2.excel.should_not == old_excel
@@ -167,7 +167,7 @@ describe Book do
       end
 
       it "should open in a new Excel" do
-        book2 = Book.open(@simple_file, :force_excel => :new)
+        book2 = Book.open(@simple_file, :force => {:excel => :new})
         book2.should be_alive
         book2.should be_a Book
         book2.excel.should_not == @book.excel 
@@ -178,22 +178,22 @@ describe Book do
       end
 
       it "should open in a given Excel, provide identity transparency, because book can be readonly, such that the old and the new book are readonly" do
-        book2 = Book.open(@simple_file1, :force_excel => :new)
+        book2 = Book.open(@simple_file1, :force => {:excel => :new})
         book2.excel.should_not == @book.excel
-        book3 = Book.open(@simple_file1, :force_excel => :new)
+        book3 = Book.open(@simple_file1, :force => {:excel => :new})
         book3.excel.should_not == book2.excel
         book3.excel.should_not == @book.excel
         book2.close
         book3.close
         @book.close
-        book4 = Book.open(@simple_file1, :force_excel => book2.excel, :read_only => true)
+        book4 = Book.open(@simple_file1, :force => {:excel => book2.excel}, :read_only => true)
         book4.should be_alive
         book4.should be_a Book
         book4.excel.should == book2.excel
         book4.ReadOnly.should be_true
         book4.should == book2
         book4.close
-        book5 = Book.open(@simple_file1, :force_excel => book2, :read_only => true)
+        book5 = Book.open(@simple_file1, :force => {:excel => book2}, :read_only => true)
         book5.should be_alive
         book5.should be_a Book
         book5.excel.should == book2.excel
@@ -232,7 +232,7 @@ describe Book do
       it "should open a new excel, if the book cannot be reopened" do
         @book.close
         new_excel = Excel.new(:reuse => false)
-        book2 = Book.open(@different_file, :default_excel => :new)
+        book2 = Book.open(@different_file, :default => {:excel => :new})
         book2.should be_alive
         book2.should be_a Book
         book2.excel.should_not == new_excel
@@ -243,17 +243,17 @@ describe Book do
       it "should open in a given Excel provided as Excel, Book, or WIN32OLE representing an Excel or Workbook" do
         book2 = Book.open(@another_simple_file)
         different_file1 = @different_file
-        book3 = Book.open(different_file1, :default_excel => book2.excel)
+        book3 = Book.open(different_file1, :default => {:excel => book2.excel})
         book3.excel.should === book2.excel
         book3.close
-        book4 = Book.open(different_file1, :default_excel => book2) 
+        book4 = Book.open(different_file1, :default => {:excel => book2}) 
         book4.excel.should === book2.excel
         book4.close
         book5 = Book.open(different_file1, :default_excel => book2.ole_workbook)
         book5.excel.should ===  book2.excel
         book5.close
         win32ole_excel1 = WIN32OLE.connect(book2.ole_workbook.Fullname).Application
-        book6 = Book.open(different_file1, :default_excel => win32ole_excel1)
+        book6 = Book.open(different_file1, :default => {:excel => win32ole_excel1})
         book6.excel.should === book2.excel
         book6.close
       end
@@ -506,14 +506,14 @@ describe Book do
 
     it "should preserve :visible if they are not set" do
       excel1 = Excel.create(:visible => true)
-      book1 = Book.open(@different_file, :default_excel => :new)
+      book1 = Book.open(@different_file, :default => {:excel => :new})
       book1.excel.Visible.should be_false
     end
 
     it "should preserve :visible if they are not set" do
       excel1 = Excel.create(:visible => true)
       excel2 = Excel.create(:visible => true)
-      book1 = Book.open(@different_file, :force_excel => excel2)
+      book1 = Book.open(@different_file, :force => {:excel => excel2})
       book1.excel.Visible.should be_true
       book1.close
     end
@@ -605,7 +605,7 @@ describe Book do
       end
 
       it "should let an open Book open if two books have been opened and one has been closed and opened again" do
-        book2 = Book.open(@different_file, :force_excel => :new)
+        book2 = Book.open(@different_file, :force => {:excel => :new})
         @book.close
         book2.close
         @book.reopen
@@ -726,7 +726,7 @@ describe Book do
       end
 
       it "should open unobtrusively the book in a new Excel such that the book is writable" do
-        book2 = Book.open(@simple_file1, :force_excel => :new, :read_only => true)
+        book2 = Book.open(@simple_file1, :force => {:excel => :new}, :read_only => true)
         @book.ReadOnly.should be_true
         book2.Readonly.should be_true
         sheet = @book.sheet(1)
@@ -796,7 +796,7 @@ describe Book do
 
       before do
         @book1 = Book.open(@simple_file1)
-        @book2 = Book.open(@simple_file1, :force_excel => :new)
+        @book2 = Book.open(@simple_file1, :force => {:excel => :new})
         @book1.Readonly.should == false
         @book2.Readonly.should == true
         old_sheet = @book1.sheet(1)
@@ -1260,6 +1260,61 @@ describe Book do
       end
     end
 
+    describe "with retain_saved" do
+
+      before do
+        @book = Book.open(@simple_file)
+      end
+
+      after do
+        @book.close(:if_unsaved => :forget)
+      end
+
+      it "should keep the save state 'unsaved'" do
+        sheet = @book.sheet(1)
+        sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
+        @book.Saved.should be_false
+        @book.retain_saved do
+          sheet = @book.sheet(1)
+          a = sheet[1,1]
+          b = @book.visible
+        end
+        @book.Saved.should be_false
+      end
+
+      it "should keep the save state 'unsaved' even when the workbook was saved before" do
+        sheet = @book.sheet(1)
+        sheet[1,1] = sheet[1,1].value == "foo" ? "bar" : "foo"
+        @book.Saved.should be_false
+        @book.retain_saved do
+          @book.save
+          @book.Saved.should be_true
+        end
+        @book.Saved.should be_false
+      end
+    end
+
+=begin    
+    context "with test what happens with save-status when setting calculation status" do
+
+      it "should keep the save status" do
+        book1 = Book.open(@simple_file, :visible => true)
+        book1.Saved.should be_true
+        book2 = Book.open(@another_simple_file, :visible => true)
+        book1.Saved.should be_true
+        book2.Saved.should be_true
+        sheet2 = book2.sheet(1)
+        sheet2[1,1] = sheet2[1,1].value == "foo" ? "bar" : "foo"
+        book1.Saved.should be_true
+        book2.Saved.should be_false
+        book3 = Book.open(@different_file, :visible => true)
+        book1.Saved.should be_true
+        book2.Saved.should be_false
+        book3.Saved.should be_true
+      end
+    end
+=end
+
     context 'open with block' do
       it {
         Book.open(@simple_file) do |book|