robust_excel_ole 1.15 → 1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c75264c3aa717667b2c38799b6fad4043f45a307d9d434b8e3d4a00ca0eff35
-  data.tar.gz: dbb9ba06291ab9f9efdb616d5b0f34d9f425166fc5a90accba4efed3b0afb99e
+  metadata.gz: 87f0b689fc32747c5adbeaeff32f823b2153dc613a2dc27ae6b3a52060241ca0
+  data.tar.gz: 2d89ef58db655b2a84b95b9dc3622fe1daae6bfafc37c1f03f9de1984cf7958e
 SHA512:
-  metadata.gz: e171843b4c4fa899a2db7ee69f21656dfc005396cd3f372977a9e520ff47b019642ddb188af41870bf79216508195609389743ffdb100c8c7975450d4334da1b
-  data.tar.gz: 5cb5bfe60497f110077d27746e90d15ad455e94a2a289762372407361f26cc7163e2ea211720782c99e4b00abb48be954a2507ae855faf0b0cc069408b1e73f6
+  metadata.gz: 2a0074c2f763882481cdc43bb9a99b0c3b62d8ed2bfea646fc5d6d581719f01df7bb8a223c0d3629d698695b56629f1813b26f363a962707df91c42b51bebee0
+  data.tar.gz: 863b6380c04612c239bec9ce6998be0e9ed59ec884e2f57107aa2833f11b0ba4bca7258621bc48e818591a6c6d973fe961a5ca591b2dc85cd5a15fa13dbf1ed6

data/Changelog

@@ -1,6 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.16]
+
+### Added
+   - RangeOwners#set_namevalue, set_namevalue_glob, Worksheet#set_cellval: 
+     optional parameter for color 
+   
+### Changed   
+   - Workbook#color_if_modified removed   
+
 ## [1.15]
 
 ### Added

data/README.rdoc

@@ -17,7 +17,7 @@ Therefore, it runs on Windows only.
 
 == Requirements
 
-  Ruby 2.1 or higher. Most functions run on Ruby 1.8.6, too.
+  Ruby 2.1 or higher.
 
 == Installation
 

data/docs/README_open.rdoc

@@ -142,9 +142,9 @@ A special feature of RobustExcelOle is that it allows to reopen workbooks after
 
 The closed workbook is now alive again, i.e. is open and responds to Excel methods.
 
-=== Promoting WIN32OLE objects to RobustExcelOle objects
+=== Type-lifting WIN32OLE objects to RobustExcelOle objects
 
-Promoting means here: enriching a given object of a certain class by properties and methods of another class. 
+Type-lifting means here: enriching a given object of a certain class by properties and methods of another class. 
 The method +General.to_reo+ enables type-lifting WIN32OLE objects to RobustExcelOle objects, in the sense that the attributes and methods of RobustExcelOle can be applied to these objects. For example, assume we have a WIN32OLE workbook +win32ole_workbook+:
 
   win32ole_workbook.to_class
@@ -173,6 +173,18 @@ A RobustExcelOle Workbook object is a proxy of an Excel WIN32OLE workbook. A Wor
 
 Similarly, each Excel, Worksheet and a Range object in RobustExcelOle is a proxy of a corresponding Excel, Worksheet and a Range object in WIN32OLE. For these objects identity transperence holds as well.
 
+=== Opening workbooks given a network path and a hostname share path ===
+
+RobustExcelOle allows opening workbooks via a network path starting with a drive letter different from the default drive (mostly 'C'), e.g. 
+
+  workbook = Workbook.open('N:/data workbook.xls')
+
+Likewise the corresponding hostname share path can be used, starting with '//', e.g.
+
+  workbook = Workbook.open("//DESKTOP-A5D5GJ5/spec/data/workbook.xls")
+
+where 'DESKTOP-A5D5GJ5' shall be the hostname, and 'data' be the share.
+
 === Unobtrusively modifying a workbook
 
 The method +unobtrusively+ enables the user to read or modify a workbook, no matter if it is open in some Excel instance, if it is saved or unsaved, and if it is writable or not. When opening a workbook unobtrusively, its status remains unchanged. This status includes, whether the workbook is opened or closed, saved or unsaved, readonly or writable, visible or invisible, calculation mode is automatic or manual, and checking compatibility is turned on or off. 

data/docs/README_ranges.rdoc

@@ -306,9 +306,12 @@ or
 
   workbook.set_namevalue_glob("name", "new_value")
 
-The method []= colors the written cell, if you have specified the color of the changed range via the method Workbook#color before, e.g.
+You can color the range when setting the contents of a range.
+
+  workbook.set_namevalue_glob("name", "new_value", :color => 4)
+
+The method []= sets the contents of a range and colors the range via some default color.
 
-  workbook.color_if_modified = 4
   workbook["name"] = "new_value"
 
 Similarly, the contents of a named range can be read and modified in a worksheet

data/lib/robust_excel_ole/bookstore.rb

@@ -29,11 +29,9 @@ module RobustExcelOle
     #                             otherwise proceeds according to prefer_writable
     def fetch(filename, options = { :prefer_writable => true })
       return nil unless filename
-
       filename = General.absolute_path(filename)
       filename_key = General.canonize(filename)
-      weakref_books = @filename2books[filename_key]      
-      weakref_books = consider_networkpaths(filename_key) if weakref_books.empty? || weakref_books.nil?
+      weakref_books = @filename2books[filename_key]
       return nil if weakref_books.nil? || weakref_books.empty?
 
       result = open_book = closed_book = nil
@@ -67,68 +65,6 @@ module RobustExcelOle
       result
     end
 
-    # @private
-    def consider_networkpaths(filename)      
-      network = WIN32OLE.new('WScript.Network')
-      drives = network.enumnetworkdrives
-      drive_letter, filename_after_drive_letter = filename.split(':')   
-      found_filename = nil
-      # if filename starts with a drive letter not c and this drive exists,
-      # then if there is the corresponding host_share_path in the bookstore, 
-      # then take the corresponding workbooks      
-      if drive_letter != 'c' && drive_letter != filename    
-        for i in 0 .. drives.Count-1
-          next if i % 2 == 1
-          if drives.Item(i).gsub(':','').downcase == drive_letter
-            hostname_share = drives.Item(i+1).gsub('\\','/').gsub('//','').downcase
-            break
-          end
-        end        
-        @filename2books.each do |stored_filename,_|
-          if hostname_share && stored_filename
-            if stored_filename[0] == '/'
-              index_hostname = stored_filename[1,stored_filename.length].index('/')+2
-              index_hostname_share = stored_filename[index_hostname,stored_filename.length].index('/')
-              hostname_share_in_stored_filename = stored_filename[1,index_hostname+index_hostname_share-1] 
-              if hostname_share_in_stored_filename == hostname_share
-                found_filename = stored_filename
-                break
-              end
-            end
-          end
-        end
-      elsif filename[0] == '/'
-        # if filename starts with a host name and share, and this is an existing host name share path,
-        # then if there are workbooks with the corresponding drive letter,
-        # then take these workbooks,
-        index_hostname = filename[1,filename.length].index('/')+2
-        index_hostname_share = filename[index_hostname,filename.length].index('/')
-        hostname_share_in_filename = filename[1,index_hostname+index_hostname_share-1] 
-        filename_after_hostname_share = filename[index_hostname+index_hostname_share+1, filename.length]
-        require 'socket'
-        hostname = Socket.gethostname
-        if hostname_share_in_filename[0,hostname_share_in_filename.index('/')] == hostname.downcase
-          for i in 0 .. drives.Count-1
-            next if i % 2 == 1
-            hostname_share = drives.Item(i+1).gsub('\\','/').gsub('//','').downcase
-            if hostname_share == hostname_share_in_filename
-              drive_letter = drives.Item(i).gsub(':','').downcase
-              break
-            end
-          end
-          @filename2books.each do |stored_filename,_|
-            if stored_filename
-              if drive_letter && stored_filename.start_with?(drive_letter.downcase) && stored_filename.end_with?(filename_after_hostname_share)
-                found_filename = stored_filename
-                break
-              end
-            end
-          end
-        end
-      end
-      @filename2books[found_filename]
-    end
-
     # stores a workbook
     # @param [Workbook] book a given book
     def store(book)
@@ -138,8 +74,7 @@ module RobustExcelOle
         # deletes the weak reference to the book
         @filename2books[old_filename_key].delete(book)
       end
-      @filename2books[filename_key] |= [WeakRef.new(book)]
-      book.stored_filename = book.filename
+      @filename2books[filename_key] |= [WeakRef.new(book)]      
     end
 
     # creates and returns a separate Excel instance with Visible and DisplayAlerts equal false
@@ -177,24 +112,26 @@ module RobustExcelOle
 
     # prints the book store
     # @private
-    def print
-      # trace "@filename2books:"
+    def print_filename2books
+      #puts "@filename2books:"
       if @filename2books
-        @filename2books.each do |_filename,books|
-          # trace " filename: #{filename}"
-          # trace " books:"
+        @filename2books.each do |filename,books|
+          #puts " filename: #{filename}"
+          #puts " books:"
           if books.empty?
-            # trace " []"
+            #puts " []"
           else
             books.each do |book|
               if book.weakref_alive?
-                # trace "#{book}"
+                #puts "book.filename: #{book.filename}"
               else # this should never happen
-                # trace "weakref not alive"
+                #puts "weakref not alive"
               end
             end
           end
         end
+      else
+        #puts "nil"
       end
     end
   end

data/lib/robust_excel_ole/cell.rb

@@ -19,7 +19,7 @@ module RobustExcelOle
     # @private
     def method_missing(name, *args) 
       #if name.to_s[0,1] =~ /[A-Z]/
-      if ::JRUBY_BUG_ERRORMESSAGE
+      if ::ERRORMESSAGE_JRUBY_BUG
         begin
           @cell.send(name, *args)
         rescue Java::OrgRacobCom::ComFailException 

data/lib/robust_excel_ole/excel.rb

@@ -17,7 +17,7 @@ module RobustExcelOle
   # See https://docs.microsoft.com/en-us/office/vba/api/excel.application(object)#methods
 
   class Excel < RangeOwners
-    attr_accessor :ole_excel
+    attr_reader :ole_excel
     attr_reader :properties
 
     alias ole_object ole_excel
@@ -111,10 +111,8 @@ module RobustExcelOle
     # @return [Excel] an Excel instance
     def recreate(opts = {})
       unless alive?
-        opts = {
-          :visible => @properties[:visible] || false,
-          :displayalerts => @properties[:displayalerts] || :if_visible
-        }.merge(opts)
+        opts = {:visible => false, :displayalerts => :if_visible}.merge(
+               {:visible => @properties[:visible], :displayalerts => @properties[:displayalerts]}).merge(opts)        
         @ole_excel = WIN32OLE.new('Excel.Application')
         set_options(opts)
         if opts[:reopen_workbooks]
@@ -391,7 +389,7 @@ module RobustExcelOle
     # if this Excel instance is being closed, then Excel creates a new Excel instance
     # @private
     def self.current_ole_excel   
-      if ::JRUBY_BUG_CONNECT
+      if ::CONNECT_EXCEL_JRUBY_BUG
         result = known_excel_instance
         if result.nil?
           if excels_number > 0
@@ -694,10 +692,7 @@ module RobustExcelOle
     # @param [String]  name  the name of the range
     # @param [Variant] value the contents of the range
     def []=(name, value)
-      old_color_if_modified = workbook.color_if_modified
-      workbook.color_if_modified = 42  unless workbook.nil? # aqua-marin
-      set_namevalue_glob(name,value)
-      workbook.color_if_modified = old_color_if_modified
+      set_namevalue_glob(name, value, :color => 42)
     end
 
     # @private
@@ -740,7 +735,7 @@ module RobustExcelOle
     def method_missing(name, *args) 
       if name.to_s[0,1] =~ /[A-Z]/
         raise ObjectNotAlive, 'method missing: Excel not alive' unless alive?
-        if ::JRUBY_BUG_ERRORMESSAGE
+        if ::ERRORMESSAGE_JRUBY_BUG
           begin
             @ole_excel.send(name, *args)
           rescue Java::OrgRacobCom::ComFailException => msg

data/lib/robust_excel_ole/general.rb

@@ -3,24 +3,47 @@
 module General
 
   IS_JRUBY_PLATFORM = (RUBY_PLATFORM =~ /java/)
-  ::JRUBY_BUG_CONNECT      = IS_JRUBY_PLATFORM && true
-  ::JRUBY_BUG_COPYSHEETS   = IS_JRUBY_PLATFORM && true
-  ::JRUBY_BUG_ERRORMESSAGE = IS_JRUBY_PLATFORM && true
-  ::JRUBY_BUG_CONNECTEXCEL = IS_JRUBY_PLATFORM && true
-  ::JRUBY_BUG_RANGES       = IS_JRUBY_PLATFORM && true
-
+  ::EXPANDPATH_JRUBY_BUG   = IS_JRUBY_PLATFORM && true
+  ::CONNECT_JRUBY_BUG      = IS_JRUBY_PLATFORM && true
+  ::COPYSHEETS_JRUBY_BUG   = IS_JRUBY_PLATFORM && true
+  ::ERRORMESSAGE_JRUBY_BUG = IS_JRUBY_PLATFORM && true
+  ::CONNECT_EXCEL_JRUBY_BUG      = IS_JRUBY_PLATFORM && true
+  ::RANGES_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
+
+  @private
+  def network2hostnamesharepath(filename)
+    network = WIN32OLE.new('WScript.Network')
+    drives = network.enumnetworkdrives
+    drive_letter, filename_after_drive_letter = filename.split(':') 
+    # if filename starts with a drive letter not c and this drive exists,
+    # then determine the corresponding host_share_path
+    default_drive = File.absolute_path(".")[0]
+    if drive_letter != default_drive && drive_letter != filename  
+      for i in 0 .. drives.Count-1
+        next if i % 2 == 1
+        if drives.Item(i).gsub(':','') == drive_letter
+          hostname_share = drives.Item(i+1)  #.gsub('\\','/').gsub('//','')
+          break
+        end
+      end
+      hostname_share + filename_after_drive_letter if hostname_share
+    else
+      return filename
+    end
+  end
 
   # @private
-  def absolute_path(file) 
+  def absolute_path(file)     
+    file[0,2] = './' if ::EXPANDPATH_JRUBY_BUG && file  =~ /[A-Z]:[^\/]/
     file = File.expand_path(file)
     file = RobustExcelOle::Cygwin.cygpath('-w', file) if RUBY_PLATFORM =~ /cygwin/
     WIN32OLE.new('Scripting.FileSystemObject').GetAbsolutePathName(file).tr('/','\\')
   end
 
   # @private
-  def canonize(filename)   
+  def canonize(filename)
     raise TypeREOError, "No string given to canonize, but #{filename.inspect}" unless filename.is_a?(String)
-
+    filename = network2hostnamesharepath(filename)
     normalize(filename).downcase
   end
 

data/lib/robust_excel_ole/range.rb

@@ -27,7 +27,7 @@ module RobustExcelOle
     # @returns [Array] the values
     def values(range = nil)
       #result = map { |x| x.Value }.flatten
-      result_unflatten = if !::JRUBY_BUG_RANGES
+      result_unflatten = if !::RANGES_JRUBY_BUG
         map { |x| x.v }
       else
         self.v
@@ -44,7 +44,7 @@ module RobustExcelOle
 
     def v
       begin
-        if !::JRUBY_BUG_RANGES
+        if !::RANGES_JRUBY_BUG
           self.Value
         else
           address_r1c1 = self.AddressLocal(true,true,XlR1C1)
@@ -65,7 +65,7 @@ module RobustExcelOle
 
     def v=(value)
       begin
-        if !::JRUBY_BUG_RANGES
+        if !::RANGES_JRUBY_BUG
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
@@ -240,7 +240,7 @@ module RobustExcelOle
     # @private
     def method_missing(name, *args) 
       if name.to_s[0,1] =~ /[A-Z]/
-        if ::JRUBY_BUG_ERRORMESSAGE
+        if ::ERRORMESSAGE_JRUBY_BUG
           begin
             @ole_range.send(name, *args)
           rescue Java::OrgRacobCom::ComFailException 

data/lib/robust_excel_ole/range_owners.rb

@@ -24,7 +24,7 @@ module RobustExcelOle
       ole_range = name_obj.RefersToRange
       value = begin
         #name_obj.RefersToRange.Value
-        if !::JRUBY_BUG_RANGES       
+        if !::RANGES_JRUBY_BUG       
           ole_range.Value
         else
           values = RobustExcelOle::Range.new(ole_range).v
@@ -39,7 +39,7 @@ module RobustExcelOle
           #sheet.Evaluate(name_obj.Name).Value
           # does it result in a range?
           ole_range = sheet.Evaluate(name_obj.Name)
-          if !::JRUBY_BUG_RANGES
+          if !::RANGES_JRUBY_BUG
             ole_range.Value
           else
             values = RobustExcelOle::Range.new(ole_range).v
@@ -61,7 +61,8 @@ module RobustExcelOle
     # sets the contents of a range
     # @param [String]  name  the name of a range
     # @param [Variant] value the contents of the range
-    def set_namevalue_glob(name, value, opts = { })  # opts is deprecated
+    # @option opts [Symbol] :color the color of the cell when set
+    def set_namevalue_glob(name, value, opts = { }) 
       begin
         name_obj = begin
           name_object(name)
@@ -69,9 +70,8 @@ module RobustExcelOle
           raise
         end        
         ole_range = name_object(name).RefersToRange
-        workbook.color_if_modified = opts[:color] unless opts[:color].nil?
-        ole_range.Interior.ColorIndex = workbook.color_if_modified unless workbook.color_if_modified.nil?
-        if !::JRUBY_BUG_RANGES
+        ole_range.Interior.ColorIndex = opts[:color] unless opts[:color].nil?
+        if !::RANGES_JRUBY_BUG
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
@@ -106,7 +106,7 @@ module RobustExcelOle
       end
       begin
         #value = ole_range.Value
-        value = if !::JRUBY_BUG_RANGES
+        value = if !::RANGES_JRUBY_BUG
           ole_range.Value
         else
           values = RobustExcelOle::Range.new(ole_range).v
@@ -127,17 +127,17 @@ module RobustExcelOle
     # assigns a value to a range given a locally defined name
     # @param [String]  name   the name of a range
     # @param [Variant] value  the assigned value   
-    def set_namevalue(name, value, opts = { })  # opts is deprecated
+    # @option opts [Symbol] :color the color of the cell when set
+    def set_namevalue(name, value, opts = { })  
       begin
-        return set_namevalue_glob(name, value, opts) if self.is_a?(Workbook)  # opts deprecated
+        return set_namevalue_glob(name, value, opts) if self.is_a?(Workbook) 
         ole_range = self.Range(name)
-      rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
+      rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException, VBAMethodMissingError
         raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
       end
       begin
-        workbook.color_if_modified = opts[:color] unless opts[:color].nil?
-        ole_range.Interior.ColorIndex = workbook.color_if_modified unless workbook.color_if_modified.nil?
-        if !::JRUBY_BUG_RANGES
+        ole_range.Interior.ColorIndex = opts[:color] unless opts[:color].nil?
+        if !::RANGES_JRUBY_BUG
           ole_range.Value = value
         else
           address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
@@ -263,7 +263,7 @@ module RobustExcelOle
 
     def name_object(name)
       self.Names.Item(name)
-    rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
+    rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException, VBAMethodMissingError
       begin
         self.Parent.Names.Item(name)
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException