robust_excel_ole 0.6.1 → 0.6.2

data/Changelog

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 
 
+## [0.6.2] - 2016-04-11
+
+### Changed
+- Excel#focus (was Excel#activate)
+- Book#focus (was Book#activate)
+
+### Added
+
 ## [0.6.1] - 2016-04-09
 
 ### Changed

data/README.rdoc

@@ -184,12 +184,11 @@ or
 
   book.set_nameval("name") = "value"
 
-=== Activating a workbook.
+=== Bringing a workbook to the focus.
 
-Bring the window of a workbook to the foreground, make it available for keyboard inputs, and make the Excel instance visible.
-
-  book.activate
+Make the Excel instance and the workbook visible and make it available for keyboard inputs.
 
+  book.focus
 
 === Making the window of the workbook visible
 
@@ -419,6 +418,10 @@ Making all workbooks invisible.
 
   excel1.workbooks_visible false   
 
+=== Bringing an Excel instance to the focus
+
+Set the window of an Excel instance to the foreground.
+
 === Closing an Excel
 
   excel = Excel.current

data/README_detail.rdoc

@@ -268,11 +268,11 @@ or
 
   book.set_nameval("name") = "value"
 
-=== Activating a workbook.
+=== Bringing a workbook to the focus.
 
-Bring the focus to a workbook. Make it available for keyboard inputs and make the Excel instance visible.
+Make the Excel instance and the workbook visible and make it available for keyboard inputs.
 
-  book.activate
+  book.focus
 
 ===  Make the window of the workbook visible.
 
@@ -496,6 +496,10 @@ Enabling DisplayAlerts whenever the Excel instance is visible.
 
   excel3 = Excel.current(:reuse => true, :displayalerts => :if_visible)
 
+=== Bringing an Excel instance to the focus
+
+Set the window of an Excel instance to the foreground.
+
 === Closing an Excel
 
   excel = Excel.current

data/lib/reo_console.rb

@@ -1,6 +1,6 @@
 #require 'lib/robust_excel_ole'
 include REO
-include RobustExcelOle
+#include RobustExcelOle
 include General
 
 require 'irb/completion'

data/lib/robust_excel_ole.rb

@@ -10,3 +10,4 @@ require File.join(File.dirname(__FILE__), 'robust_excel_ole/range')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/cygwin') if RUBY_PLATFORM =~ /cygwin/
 #+#require "robust_excel_ole/version"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
+#

data/lib/robust_excel_ole/book.rb

@@ -20,7 +20,7 @@ module RobustExcelOle
         :if_obstructed => :raise,
         :if_absent     => :raise,
         :read_only => false,
-        :check_compatibility => true,
+        :check_compatibility => false,
         :update_links => :never
       }
 
@@ -92,7 +92,8 @@ module RobustExcelOle
               book.close if (book.alive? && (not book.writable) && (not options[:read_only]))
               # reopens the book
               book.ensure_workbook(file,options) unless book.alive?
-              book.visible = options[:visible] unless options[:visible].nil?
+              book.visible = options[:visible].nil? ? book.excel.visible : options[:visible]
+              #book.visible = options[:visible] unless options[:visible].nil?
               return book
             end
           end
@@ -113,7 +114,8 @@ module RobustExcelOle
         if filename
           book = bookstore.fetch(filename)
           if book && book.alive?
-            book.visible = opts[:visible] unless opts[:visible].nil?
+            #book.visible = opts[:visible] unless opts[:visible].nil?
+            book.visible = opts[:visible].nil? ? book.excel.visible : opts[:visible]
             return book 
           end
         end
@@ -183,7 +185,8 @@ module RobustExcelOle
       filename = General::absolute_path(file)
       ole_workbook = WIN32OLE.connect(filename)
       workbook = Book.new(ole_workbook)
-      workbook.visible = options[:visible] unless options[:visible].nil?
+      #workbook.visible = options[:visible] unless options[:visible].nil?
+      workbook.visible = options[:visible].nil? ? workbook.excel.visible : options[:visible]
       update_links_opt =
             case options[:update_links]
             when :alert; RobustExcelOle::XlUpdateLinksUserSetting
@@ -212,7 +215,7 @@ module RobustExcelOle
         if options[:if_absent] == :create
           @ole_workbook = excel_class.current.generate_workbook(file)
         else 
-          raise FileNotFound, "file #{file.inspect} not found"
+          raise FileNotFound, "file #{General::absolute_path(file).inspect} not found"
         end
       end
       @ole_workbook = @excel.Workbooks.Item(File.basename(file)) rescue nil
@@ -295,13 +298,13 @@ module RobustExcelOle
               raise UnexpectedError, "unknown RuntimeError"
             end
           rescue WeakRef::RefError => msg
-            raise ExcelWeakRef, "#{msg.message}"
+            raise WeakRef::RefError, "#{msg.message}"
           end
           # workaround for linked workbooks for Excel 2007: 
           # opening and closing a dummy workbook if Excel has no workbooks.
           # delay: with visible: 0.2 sec, without visible almost none
           count = workbooks.Count
-          if @excel.Version == "12.0" && count == 0
+          if @excel.Version.split(".").first.to_i >= 12 && count == 0
             workbooks.Add 
             #@excel.set_calculation(:automatic)
           end
@@ -318,7 +321,7 @@ module RobustExcelOle
           @excel.with_displayalerts(update_links_opt == :alert ? true : @excel.displayalerts) do
             workbooks.Open(filename, { 'ReadOnly' => options[:read_only] , 'UpdateLinks' => update_links_opt } )
           end
-          workbooks.Item(1).Close if @excel.Version == "12.0" && count == 0                   
+          workbooks.Item(1).Close if @excel.Version.split(".").first.to_i >= 12 && count == 0                
         rescue WIN32OLERuntimeError => msg
           # trace "WIN32OLERuntimeError: #{msg.message}" 
           if msg.message =~ /800A03EC/
@@ -330,7 +333,8 @@ module RobustExcelOle
         begin
           # workaround for bug in Excel 2010: workbook.Open does not always return the workbook with given file name
           @ole_workbook = workbooks.Item(File.basename(filename))       
-          self.visible = options[:visible] unless options[:visible].nil?
+          self.visible = options[:visible].nil? ? @excel.visible : options[:visible]
+          #self.visible = options[:visible] unless options[:visible].nil?
           #@ole_workbook.UpdateLinks = update_links_opt
           @ole_workbook.CheckCompatibility = options[:check_compatibility]
         rescue WIN32OLERuntimeError
@@ -434,7 +438,7 @@ module RobustExcelOle
         :read_only => false,
         :readonly_excel => false,
         :keep_open => false,
-        :check_compatibility => true
+        :check_compatibility => false
       }.merge(opts)
       book = bookstore.fetch(file, :prefer_writable => (not options[:read_only]))
       was_not_alive_or_nil = book.nil? || (not book.alive?)
@@ -467,7 +471,8 @@ module RobustExcelOle
                                          open(file, :force_excel => :new, :read_only => options[:read_only])
             end
           end
-        book.excel.visible = options[:visible] unless options[:visible].nil?
+        #book.excel.visible = options[:visible] unless options[:visible].nil?
+        book.visible = options[:visible].nil? ? book.excel.visible : options[:visible]
         old_check_compatibility = book.CheckCompatibility
         book.CheckCompatibility = options[:check_compatibility]
         yield book
@@ -525,7 +530,7 @@ module RobustExcelOle
     # @return [Book], the book itself, if successfully saved, raises an exception otherwise
     def save_as(file, opts = { } )
       raise FileNameNotGiven, "filename is nil" if file.nil?
-      raise ObjectNotAlive, "workbook is not alive" if (not alive?)
+      raise ObjectNotAlive, "workbook is not alive" unless alive?
       raise WorkbookReadOnly, "Not opened for writing (opened with :read_only option)" if @ole_workbook.ReadOnly
       options = {
         :if_exists => :raise,
@@ -777,15 +782,10 @@ module RobustExcelOle
     end
 
     # brings workbook to foreground, makes it available for heyboard inputs, makes the Excel instance visible
-    def activate      
-      @excel.visible = true
-      begin
-        Win32API.new("user32","SetForegroundWindow","I","I").call    # Excel  2010
-        SetForegroundWindow.call(@excel.Hwnd)
-        @ole_workbook.Activate   # Excel 2007
-      rescue WIN32OLERuntimeError => msg
-        raise UnexpectedError, "cannot activate: #{message.msg}"
-      end
+    def focus
+      self.visible = true
+      @excel.focus
+      @ole_workbook.Activate
     end
 
     # returns true, if the workbook is visible, false otherwise 
@@ -798,7 +798,11 @@ module RobustExcelOle
     def visible= visible_value
       saved = @ole_workbook.Saved
       @excel.visible = true if visible_value
-      @ole_workbook.Windows(@ole_workbook.Name).Visible = visible_value if @excel.Visible
+      if @excel.Visible
+        if @ole_workbook.Windows.Count > 0
+          @ole_workbook.Windows(@ole_workbook.Name).Visible = visible_value
+        end
+      end
       @ole_workbook.Saved = saved
     end
 

data/lib/robust_excel_ole/excel.rb

@@ -65,6 +65,8 @@ module RobustExcelOle
       if stored 
         result = stored
       else 
+        options[:visible] = options[:visible].nil? ? ole_xl.Visible : options[:visible]
+        options[:displayalerts] = options[:displayalerts].nil? ? :if_visible : options[:displayalerts]
         result = super(options)
         result.instance_variable_set(:@ole_excel, ole_xl)        
         WIN32OLE.const_load(ole_xl, RobustExcelOle) unless RobustExcelOle.const_defined?(:CONSTANTS)
@@ -72,16 +74,19 @@ module RobustExcelOle
       end
       
       unless options.is_a? WIN32OLE
-        reused = options[:reuse] && (not stored.nil?)
-        options = { :displayalerts => :if_visible, :visible => false}.merge(options) unless reused
-        result.visible = result.Visible
-        result.DisplayAlerts = result.DisplayAlerts
-        visible_value = (reused && options[:visible].nil?) ? result.visible : options[:visible]
-        displayalerts_value = (reused && options[:displayalerts].nil?) ? 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)
+        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)
+        rescue WIN32OLERuntimeError
+          raise ExcelError, "cannot access Excel"
+        end
       end
       result
     end
@@ -156,6 +161,7 @@ module RobustExcelOle
     end
 
     # closes Excel instances opened via RobustExcelOle
+    # @return [Fixnum] number of closed Excel instances
     # @param [Hash] options the options
     # @option options [Symbol]  :if_unsaved :raise, :save, :forget, or :alert
     # @option options [Boolean] :hard
@@ -175,15 +181,21 @@ module RobustExcelOle
         :kill_if_timeout => false
       }.merge(options)           
       timeout = false
-      number = excels_number
+      number = @@hwnd2excel.size
+      unsaved_workbooks = false
       begin
         status = Timeout::timeout(60) {
           @@hwnd2excel.each do |hwnd, wr_excel|
             excel = wr_excel.__getobj__
-            excel.close(options)
+            begin
+              excel.close(options)
+            rescue UnsavedWorkbooks
+              unsaved_workbooks = true
+            end
+            sleep 0.2
           end
-          sleep 0.2          
-          free_all_ole_objects if excels_number > 0
+          raise UnsavedWorkbooks, "Excel contains unsaved workbooks" if unsaved_workbooks
+          free_all_ole_objects if excels_number > 0 #&& (not unsaved_workbooks)
           # close also interactively opened Excels, but for unsaved workbooks: hangs as soon sending a VBA method
           #while (n = excels_number) > 0 do
           #  ole_xl = current_excel    
@@ -416,11 +428,12 @@ module RobustExcelOle
     end
 
     def print_workbooks
-      self.Workbooks.each {|w| puts "#{w.Name} #{w}"}
+      self.Workbooks.each {|w| trace "#{w.Name} #{w}"}
     end
 
     # generates, saves, and closes empty workbook
-    def generate_workbook file_name                  
+    def generate_workbook file_name  
+      raise FileNameNotGiven, "filename is nil" if file_name.nil?                
       self.Workbooks.Add                           
       empty_workbook = self.Workbooks.Item(self.Workbooks.Count)          
       filename = General::absolute_path(file_name).gsub("/","\\")
@@ -429,7 +442,7 @@ module RobustExcelOle
           empty_workbook.SaveAs(filename) 
         rescue WIN32OLERuntimeError => msg
           if msg.message =~ /SaveAs/ and msg.message =~ /Workbook/ then
-            raise WIN32OLERuntimeError, "could not save workbook with filename #{file_name.inspect}"
+            raise FileNotFound, "could not save workbook with filename #{file_name.inspect}"
           else
             # todo some time: find out when this occurs : 
             raise UnexpectedError, "unknown WIN32OELERuntimeError with filename #{file_name.inspect}: \n#{msg.message}"
@@ -475,10 +488,13 @@ module RobustExcelOle
       end
     end
 
-
-    def foremost_window
+    def focus
       self.visible = true
-      #Win32API.new("user32","SetForegroundWindow","I","I").call(@ole_excel.Hwnd)
+      #if not Windows10 then 
+      Win32API.new("user32","SetForegroundWindow","I","I").call(@ole_excel.Hwnd)
+      #else
+      #Win32API.new("user32","SetForegroundWindow","","I").call
+      #end
     end
 
     # sets calculation mode in a block
@@ -587,10 +603,11 @@ 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
       value
     end
 
-    # assigns a value to a range given a defined loval name
+    # assigns a value to a range given a defined local name
     # @param [String]  name   the range name
     # @param [Variant] value  the assigned value
     def set_rangeval(name,value)

data/lib/robust_excel_ole/general.rb

@@ -118,4 +118,5 @@ module MethodHelpers
 
 end
 
-REO = General
+#REO = General
+REO = RobustExcelOle

data/lib/robust_excel_ole/reo_common.rb

@@ -63,9 +63,6 @@ module RobustExcelOle
   class ExcelDamaged < ExcelError               # :nodoc: #
   end
 
-  class ExcelWeakRef < ExcelError                # :nodoc: #
-  end
-
   class UnsavedWorkbooks < ExcelError           # :nodoc: #
   end
 

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/book_spec.rb

@@ -33,7 +33,7 @@ describe Book do
 
   after do
     Excel.kill_all
-    rm_tmp(@dir)
+    #rm_tmp(@dir)
   end
 
   describe "create file" do
@@ -381,7 +381,7 @@ describe Book do
               if :if_obstructed is :close_if_saved" do
             expect{
               @new_book = Book.open(@simple_file1, :if_obstructed => :close_if_saved)
-            }.to raise_error(WorkbookNotSaved, /workbook with the same name in a different path is unsaved/)
+            }.to raise_error(WorkbookBlocked, /workbook with the same name in a different path is unsaved/)
             @book.save
             @new_book = Book.open(@simple_file1, :if_obstructed => :close_if_saved)
             @book.should_not be_alive
@@ -409,7 +409,7 @@ describe Book do
         File.delete @simple_save_file rescue nil
         expect {
           Book.open(@simple_save_file)
-        }.to raise_error(NameNotFound, /file "#{@simple_save_file}" not found/)
+        }.to raise_error(FileNotFound, "file #{General::absolute_path(@simple_save_file).gsub("/","\\").inspect} not found")
       end
     end
 
@@ -901,7 +901,7 @@ describe Book do
           book.excel.should_not == @book.excel
           book.excel.should_not == new_excel
           book.excel.visible.should be_false
-          book.excel.displayalerts.should be_false
+          book.excel.displayalerts.should == :if_visible
         end
         new_book = Book.open(@simple_file1, :visible => true)
         sheet = new_book.sheet(1)
@@ -1077,7 +1077,7 @@ describe Book do
     end
   end
 
-  describe "alive?, filename, ==, activate, saved" do
+  describe "alive?, filename, ==, focus, saved" do
 
     context "with alive?" do
 
@@ -1133,12 +1133,12 @@ describe Book do
       end
     end
 
-    context "with activate" do
+    context "with focus" do
 
       before do
         @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)
+        @book2 = Book.open(@another_simple_file, :visible => true)
       end
 
       after do
@@ -1147,22 +1147,22 @@ describe Book do
         @key_sender.close
       end
 
-      it "should activate a book" do
+      it "should bring a book to focus" do
         sheet = @book.sheet(2)
         sheet.Activate
         sheet[2,3].Activate
         sheet2 = @book2.sheet(2)
         sheet2.Activate
         sheet2[3,2].Activate
-        Excel.current.should == @book.excel
-        @book2.activate
+        @book2.focus
         @key_sender.puts "{a}{enter}"
-        sleep 1
+        sleep 0.2
         sheet2[3,2].Value.should == "a"
-        #Excel.current.should == @book2.excel
-        @book.activate
+        @book.focus
+        @book.Windows(1).Visible.should be_true
+        @book.Windows(@book.Name).Visible.should be_true
         @key_sender.puts "{a}{enter}"
-        sleep 1
+        sleep 0.2
         sheet[2,3].Value.should == "a"
         Excel.current.should == @book.excel
       end
@@ -1198,7 +1198,8 @@ describe Book do
 
       context "with second argument is {:before => @book.sheet(3), :after => @sheet}" do
         it "should arguments in the first is given priority" do
-          @book.add_sheet(@sheet, :before => @book.sheet(3), :after => @sheet).name.should eq @book.sheet(3).name
+          @book.add_sheet(@sheet, :before => @book.sheet(3), :after => @sheet)
+          @book.Worksheets.Count.should == 4
         end
       end
     end