robust_excel_ole 1.8 → 1.9

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.8"
+  VERSION = "1.9"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -85,14 +85,12 @@ module RobustExcelOle
         if (options[:force][:excel] != :new) && (options[:force][:excel] != :reserved_new)
           # if readonly is true, then prefer a book that is given in force_excel if this option is set
           forced_excel = if options[:force][:excel]
-                           options[:force][:excel] == :current ? excel_class.new(:reuse => true) : excel_of(options[:force][:excel])
+            options[:force][:excel] == :current ? excel_class.new(:reuse => true) : excel_of(options[:force][:excel])
           end
           book = bookstore.fetch(file,
                   :prefer_writable => !(options[:read_only]),
                   :prefer_excel    => (options[:read_only] ? forced_excel : nil)) rescue nil
           if book
-            # if forced_excel != book.excel &&
-            #  (not (book.alive? && (not book.saved) && (not options[:if_unsaved] == :accept)))
             if (!(options[:force][:excel]) || (forced_excel == book.excel)) &&
                !(book.alive? && !book.saved && (options[:if_unsaved] != :accept))
               book.options = options
@@ -116,24 +114,26 @@ module RobustExcelOle
       end
     end
 
-    # creates a Workbook object by opening an Excel file given its filename workbook
+    # creates a Workbook object by opening an Excel file given its filename
     # or by promoting a Win32OLE object representing an Excel file
-    # @param [WIN32OLE] workbook a workbook
-    # @param [Hash] opts the options
-    # @option opts [Symbol] see above
+    # @param [WIN32OLE] workbook a Win32Ole-workbook
+    # @param [Hash] opts the options as in Workbook::open
+    # @option opts [Symbol] see Workbook::open
     # @return [Workbook] a workbook
-    def self.new(workbook, opts = { }, &block)
+    def self.new(ole_workbook, opts = { }, &block)
       opts = process_options(opts)
-      if workbook && (workbook.is_a? WIN32OLE)
-        filename = workbook.Fullname.tr('\\','/') rescue nil
+      if ole_workbook && (ole_workbook.is_a? WIN32OLE)
+        filename = ole_workbook.Fullname.tr('\\','/') rescue nil
         if filename
           book = bookstore.fetch(filename)
           if book && book.alive?
-            book.visible = opts[:force][:visible] unless opts[:force].nil? || opts[:force][:visible].nil?
-            book.excel.calculation = opts[:calculation] unless opts[:calculation].nil?
+            open(filename, opts)
+            #book.visible = opts[:force][:visible] unless opts[:force].nil? || opts[:force][:visible].nil?
+            #book.excel.calculation = opts[:calculation] unless opts[:calculation].nil?
+            #book.excel.displayalerts = opts[:calculation] unless opts[:calculation].nil?
             return book
           else
-            super
+            super(filename,opts)
           end
         end
       else
@@ -144,7 +144,7 @@ module RobustExcelOle
     # creates a new Workbook object, if a file name is given
     # Promotes the win32ole workbook to a Workbook object, if a win32ole-workbook is given
     # @param [Variant] file_or_workbook  file name or workbook
-    # @param [Hash]    opts              the options
+    # @param [Hash]    opts              the options as in Workbook::open
     # @option opts [Symbol] see above
     # @return [Workbook] a workbook
     def initialize(file_or_workbook, options = { }, &block)
@@ -166,6 +166,8 @@ module RobustExcelOle
       bookstore.store(self)
       @modified_cells = []
       @workbook = @excel.workbook = self
+      r1c1_letters = @ole_workbook.Worksheets.Item(1).Cells.Item(1,1).Address('ReferenceStyle' => XlR1C1).gsub(/[0-9]/,'')
+      address_class.new(r1c1_letters)
       if block
         begin
           yield self
@@ -240,7 +242,7 @@ module RobustExcelOle
 
     # @private
     def ensure_excel(options)  
-      if excel && @excel.alive?
+      if @excel && @excel.alive?
         @excel.created = false
         return
       end
@@ -251,85 +253,133 @@ module RobustExcelOle
       @excel
     end
 
+
     # @private
-    def ensure_workbook(file, options)    
-      file = @stored_filename ? @stored_filename : file
-      raise(FileNameNotGiven, 'filename is nil') if file.nil?
-      raise(FileNotFound, "file #{General.absolute_path(file).inspect} is a directory") if File.directory?(file)
-      unless File.exist?(file)
-        if options[:if_absent] == :create
-          @ole_workbook = excel_class.current.generate_workbook(file)
-        else
-          raise FileNotFound, "file #{General.absolute_path(file).inspect} not found"
+    def ensure_workbook(filename, options)    
+      filename = @stored_filename ? @stored_filename : filename
+      raise(FileNameNotGiven, 'filename is nil') if filename.nil?
+      if File.directory?(filename)
+        raise(FileNotFound, "file #{General.absolute_path(filename).inspect} is a directory")
+      end  
+      manage_nonexisting_file(filename,options)
+      workbooks = @excel.Workbooks
+      @ole_workbook = workbooks.Item(File.basename(filename)) rescue nil if @ole_workbook.nil?
+      if @ole_workbook
+        manage_blocking_or_unsaved_workbook(filename,options)
+      else
+        open_or_create_workbook(filename, options)
+      end
+    end
+
+  private
+
+    # @private
+    def manage_nonexisting_file(filename,options)
+      return if File.exist?(filename)
+      if options[:if_absent] == :create
+        excel.Workbooks.Add
+        empty_ole_workbook = excel.Workbooks.Item(excel.Workbooks.Count)
+        abs_filename = General.absolute_path(filename).tr('/','\\')
+        begin
+          empty_ole_workbook.SaveAs(abs_filename)
+        rescue WIN32OLERuntimeError => msg
+          raise FileNotFound, "could not save workbook with filename #{filename.inspect}"
         end
+      else
+        raise FileNotFound, "file #{abs_filename.inspect} not found" +
+          "\nHint: If you want to create a new file, use option :if_absent => :create or Workbook::create"
       end
-      @ole_workbook = @excel.Workbooks.Item(File.basename(file)) rescue nil
-      if @ole_workbook
-        obstructed_by_other_book = (File.basename(file) == File.basename(@ole_workbook.Fullname)) &&
-                                   (General.absolute_path(file) != @ole_workbook.Fullname)
-        # if workbook is obstructed by a workbook with same name and different path
-        if obstructed_by_other_book
-          case options[:if_obstructed]
-          when :raise
-            raise WorkbookBlocked, "blocked by a workbook with the same name in a different path: #{@ole_workbook.Fullname.tr('\\','/')}"
-          when :forget
-            @ole_workbook.Close
-            @ole_workbook = nil
-            open_or_create_workbook(file, options)
-          when :save
-            save unless @ole_workbook.Saved
-            @ole_workbook.Close
-            @ole_workbook = nil
-            open_or_create_workbook(file, options)
-          when :close_if_saved
-            if !@ole_workbook.Saved
-              raise WorkbookBlocked, "workbook with the same name in a different path is unsaved: #{@ole_workbook.Fullname.tr('\\','/')}"
-            else
-              @ole_workbook.Close
-              @ole_workbook = nil
-              open_or_create_workbook(file, options)
-            end
-          when :new_excel
-            @excel = excel_class.new(:reuse => false)
-            open_or_create_workbook(file, options)
-          else
-            raise OptionInvalid, ":if_obstructed: invalid option: #{options[:if_obstructed].inspect}"
-          end
+    end
+
+    # @private
+    def manage_blocking_or_unsaved_workbook(filename,options)
+      obstructed_by_other_book = if (File.basename(filename) == File.basename(@ole_workbook.Fullname)) 
+        p1 = General.absolute_path(filename) 
+        p2 = @ole_workbook.Fullname
+        is_same_path = if p1[1..1] == ":" and p2[0..1] == '\\\\' # normal path starting with the drive letter and a path in network notation (starting with 2 backslashes)
+          # this is a Workaround for Excel2010 on WinXP: Network drives won't get translated to drive letters. So we'll do it manually:
+          p1_pure_path = p1[2..-1]
+          p2.end_with?(p1_pure_path)  and p2[0, p2.rindex(p1_pure_path)] =~ /^\\\\[\w\d_]+(\\[\w\d_]+)*$/  # e.g. "\\\\server\\folder\\subfolder"
         else
-          # book open, not obstructed by an other book, but not saved and writable
-          unless @ole_workbook.Saved
-            case options[:if_unsaved]
-            when :raise
-              raise WorkbookNotSaved, "workbook is already open but not saved: #{File.basename(file).inspect}"
-            when :forget
-              @ole_workbook.Close
-              @ole_workbook = nil
-              open_or_create_workbook(file, options)
-            when :accept
-              # do nothing
-            when :alert, :excel
-              @excel.with_displayalerts(true) { open_or_create_workbook(file,options) }
-            when :new_excel
-              @excel = excel_class.new(:reuse => false)
-              open_or_create_workbook(file, options)
-            else
-              raise OptionInvalid, ":if_unsaved: invalid option: #{options[:if_unsaved].inspect}"
-            end
-          end
+          p1 == p2
         end
+        not is_same_path
+      end      
+      if obstructed_by_other_book
+        # workbook is being obstructed by a workbook with same name and different path
+        manage_blocking_workbook(filename,options)        
       else
-        # open a new workbook
-        open_or_create_workbook(file, options)
+        unless @ole_workbook.Saved
+        # workbook open and writable, not obstructed by another workbook, but not saved
+          manage_unsaved_workbook(filename,options)
+        end
+      end        
+    end
+
+    # @private
+    def manage_blocking_workbook(filename,options)
+      case options[:if_obstructed]
+      when :raise
+        raise WorkbookBlocked, "blocked by a workbook with the same name in a different path: #{@ole_workbook.Fullname.tr('\\','/')}" +
+        "\nHint: Use the option :if_obstructed with values :forget or :save,
+         to close the old workbook, without or with saving before, respectively,
+         and to open the new workbook"
+      when :forget
+        @ole_workbook.Close
+        @ole_workbook = nil
+        open_or_create_workbook(filename, options)
+      when :save
+        save unless @ole_workbook.Saved
+        @ole_workbook.Close
+        @ole_workbook = nil
+        open_or_create_workbook(filename, options)
+      when :close_if_saved
+        if !@ole_workbook.Saved
+          raise WorkbookBlocked, "workbook with the same name in a different path is unsaved: #{@ole_workbook.Fullname.tr('\\','/')}"
+        else
+          @ole_workbook.Close
+          @ole_workbook = nil
+          open_or_create_workbook(filename, options)
+        end
+      when :new_excel
+        @excel = excel_class.new(:reuse => false)
+        open_or_create_workbook(filename, options)
+      else
+        raise OptionInvalid, ":if_obstructed: invalid option: #{options[:if_obstructed].inspect}" +
+        "\nHint: Valid values are :raise, :forget, :save, :close_if_saved, :new_excel"
+      end
+    end
+
+    def manage_unsaved_workbook(filename,options)
+      case options[:if_unsaved]
+      when :raise
+        raise WorkbookNotSaved, "workbook is already open but not saved: #{File.basename(filename).inspect}" +
+        "\nHint: Save the workbook or open the workbook using option :if_unsaved with values :forget and :accept to
+         close the unsaved workbook and reopen it, or to let the unsaved workbook open, respectively"
+      when :forget
+        @ole_workbook.Close
+        @ole_workbook = nil
+        open_or_create_workbook(filename, options)
+      when :accept
+        # do nothing
+      when :alert, :excel
+        @excel.with_displayalerts(true) { open_or_create_workbook(filename,options) }
+      when :new_excel
+        @excel = excel_class.new(:reuse => false)
+        open_or_create_workbook(filename, options)
+      else
+        raise OptionInvalid, ":if_unsaved: invalid option: #{options[:if_unsaved].inspect}" +
+        "\nHint: Valid values are :raise, :forget, :accept, :alert, :excel, :new_excel"
       end
     end
 
   private
 
     # @private
-    def open_or_create_workbook(file, options)  
+    def open_or_create_workbook(filename, options)  
       if !@ole_workbook || (options[:if_unsaved] == :alert) || options[:if_obstructed]
         begin
-          filename = General.absolute_path(file)
+          abs_filename = General.absolute_path(filename)
           begin
             workbooks = @excel.Workbooks
           rescue WIN32OLERuntimeError => msg
@@ -337,8 +387,8 @@ module RobustExcelOle
           end
           begin
             with_workaround_linked_workbooks_excel2007(options) do
-              workbooks.Open(filename, { 'ReadOnly' => options[:read_only],
-                                         'UpdateLinks' => updatelinks_vba(options[:update_links]) })
+              workbooks.Open(abs_filename, { 'ReadOnly' => options[:read_only] })
+              #                           'UpdateLinks' => updatelinks_vba(options[:update_links]) })
             end
           rescue WIN32OLERuntimeError => msg
             # for Excel2007: for option :if_unsaved => :alert and user cancels: this error appears?
@@ -405,6 +455,13 @@ module RobustExcelOle
 
   public
 
+    # creates, i.e., opens a new, empty workbook, and saves it under a given filename
+    # @param [String] filename the filename under which the new workbook should be saved
+    # @param [Hash] opts the options as in Workbook::open
+    def self.create(filename, opts = { })
+      open(filename, :if_absent => :create)
+    end
+
     # closes the workbook, if it is alive
     # @param [Hash] opts the options
     # @option opts [Symbol] :if_unsaved :raise (default), :save, :forget, :keep_open, or :alert
@@ -421,7 +478,8 @@ module RobustExcelOle
       if alive? && !@ole_workbook.Saved && writable
         case opts[:if_unsaved]
         when :raise
-          raise WorkbookNotSaved, "workbook is unsaved: #{File.basename(self.stored_filename).inspect}"
+          raise WorkbookNotSaved, "workbook is unsaved: #{File.basename(self.stored_filename).inspect}" +
+          "\nHint: Use option :save or :forget to close the workbook with or without saving"
         when :save
           save
           close_workbook
@@ -432,7 +490,8 @@ module RobustExcelOle
         when :alert, :excel
           @excel.with_displayalerts(true) { close_workbook }
         else
-          raise OptionInvalid, ":if_unsaved: invalid option: #{opts[:if_unsaved].inspect}"
+          raise OptionInvalid, ":if_unsaved: invalid option: #{opts[:if_unsaved].inspect}" +
+          "\nHint: Valid values are :raise, :save, :keep_open, :alert, :excel"
         end
       else
         close_workbook
@@ -554,7 +613,11 @@ module RobustExcelOle
     # @return [Boolean] true, if successfully saved, nil otherwise
     def save(opts = {:discoloring => false})
       raise ObjectNotAlive, 'workbook is not alive' unless alive?
-      raise WorkbookReadOnly, 'Not opened for writing (opened with :read_only option)' if @ole_workbook.ReadOnly
+      raise WorkbookReadOnly, 'Not opened for writing (opened with :read_only option)' if @ole_workbook.ReadOnly   
+      # if you have open the workbook with :read_only => true,
+      # then you could close the workbook and open it again with option :read_only => false
+      # otherwise the workbook may already be open writable in an another Excel instance
+      # then you could use this workbook or close the workbook there
       begin
         discoloring if opts[:discoloring]
         @modified_cells = []
@@ -605,7 +668,7 @@ module RobustExcelOle
             begin
               File.delete(file)
             rescue Errno::EACCES
-              raise WorkbookBeingUsed, 'workbook is open and used in Excel'
+              raise WorkbookBeingUsed, 'workbook is open and being used in an Excel instance'
             end
           end
         when :alert, :excel
@@ -614,24 +677,32 @@ module RobustExcelOle
           end
           return self
         when :raise
-          raise FileAlreadyExists, "file already exists: #{File.basename(file).inspect}"
+          raise FileAlreadyExists, "file already exists: #{File.basename(file).inspect}" +
+          "\nHint: Use option :if_exists => :overwrite, if you want to overwrite the file" 
         else
-          raise OptionInvalid, ":if_exists: invalid option: #{options[:if_exists].inspect}"
+          raise OptionInvalid, ":if_exists: invalid option: #{options[:if_exists].inspect}" +
+          "\nHint: Valid values are :raise, :overwrite, :alert, :excel"
         end
       end
       other_workbook = @excel.Workbooks.Item(File.basename(file)) rescue nil
       if other_workbook && self.filename != other_workbook.Fullname.tr('\\','/')
         case options[:if_obstructed]
         when :raise
-          raise WorkbookBlocked, "blocked by another workbook: #{other_workbook.Fullname.tr('\\','/')}"
+          raise WorkbookBlocked, "blocked by another workbook: #{other_workbook.Fullname.tr('\\','/')}" +
+          "\nHint: Use the option :if_obstructed with values :forget or :save to
+           close or save and close the blocking workbook"
         when :forget
           # nothing
         when :save
           other_workbook.Save
         when :close_if_saved
-          raise WorkbookBlocked, "blocking workbook is unsaved: #{File.basename(file).inspect}" unless other_workbook.Saved
+          unless other_workbook.Saved
+            raise WorkbookBlocked, "blocking workbook is unsaved: #{File.basename(file).inspect}" +
+            "\nHint: Use option :if_obstructed => :save to save the blocking workbooks"
+          end
         else
-          raise OptionInvalid, ":if_obstructed: invalid option: #{options[:if_obstructed].inspect}"
+          raise OptionInvalid, ":if_obstructed: invalid option: #{options[:if_obstructed].inspect}" +
+          "\nHint: Valid values are :raise, :forget, :save, :close_if_saved"
         end
         other_workbook.Close
       end
@@ -928,6 +999,16 @@ module RobustExcelOle
       end
     end
 
+    # @private
+    def self.address_class    
+      @address_class ||= begin
+        module_name = self.parent_name
+        "#{module_name}::Address".constantize
+      rescue NameError => e
+        Address
+      end
+    end
+
     # @private
     def excel_class        
       self.class.excel_class
@@ -938,6 +1019,11 @@ module RobustExcelOle
       self.class.worksheet_class
     end
 
+    # @private
+    def address_class        
+      self.class.address_class
+    end
+
     include MethodHelpers
 
   private

data/lib/robust_excel_ole/worksheet.rb

@@ -12,7 +12,6 @@ module RobustExcelOle
   class Worksheet < RangeOwners
 
     attr_reader :ole_worksheet
-    attr_reader :workbook
 
     def initialize(win32_worksheet)
       @ole_worksheet = win32_worksheet
@@ -25,7 +24,15 @@ module RobustExcelOle
         @end_row = last_row
         @end_column = last_column
       end
-      @workbook = workbook_class.new(self.Parent)
+    end
+
+    def workbook
+      ole_workbook = self.Parent
+      saved_status = ole_workbook.Saved
+      ole_workbook.Saved = true unless saved_status
+      workbook = workbook_class.new(ole_workbook)
+      ole_workbook.Saved = saved_status
+      workbook
     end
 
     # sheet name
@@ -33,7 +40,7 @@ module RobustExcelOle
     def name
       @ole_worksheet.Name
     rescue
-      raise SheetREOError, "name #{name.inspect} could not be determined"
+      raise WorksheetREOError, "name #{name.inspect} could not be determined"
     end
 
     # sets sheet name
@@ -190,7 +197,8 @@ module RobustExcelOle
 
     # @private
     def to_s    
-      '#<Worksheet: ' + ('not alive ' unless @workbook.alive?).to_s + name.to_s + " #{File.basename(@workbook.stored_filename)} >"
+      '#<Worksheet: ' + name.to_s + ">"
+      #'#<Worksheet: ' + ('not alive ' unless workbook.alive?).to_s + name.to_s + " #{File.basename(workbook.stored_filename)} >"
     end
 
     # @private