robust_excel_ole 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e288f5c2c1de7a23b3f3d38bcefa7dc9fb78661b
-  data.tar.gz: 8c396bc079707bf0602ed3b6e6083d4f04569a0a
+  metadata.gz: 9bc4f05390e7e89a7d95a262e280e94dff090063
+  data.tar.gz: db6443cf724e5f58acbe8607ab427fc1734afa08
 SHA512:
-  metadata.gz: 195f2c061fdffdb4ae22bb19f245b059a5620f894998cb754a14685a25d31f1f8b227dac7c3c8f9e34d9598d3b9a9ead74a333795fe3c7ea49be609aef6111ae
-  data.tar.gz: e77b113d6b9791e4a3304bbc629f3ba067594c49f20a61d54e5f1d1b6cba12bcfd9322b2ed541ccfddca6914865fd6efb47ce7170db12f388bf9ae4e9a4db5e7
+  metadata.gz: f789655b7ae560eecf54132d0470e2441b04d902b95c72c3fb165987e02ef7395235e4f0e3723519928a5df86897b6f6f7340adebb0dde9f66e7aeda493588ad
+  data.tar.gz: 7b4110169af5c687a5be28535b8c0359f95f4c30217df5d8d90f26e5a5c54dc28153bf4b8e0bfa9411961a44cc064118cbc681df68b95061a337b61efd247e27

data/Changelog

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.1.3] - 2018-10-6
+
+## [1.1.2] - 2018-10-5
+
+### Added
+  - Excel, Sheet, Book #workbook
+
 ## [1.1.1] - 2018-20-4
 
 ### Added

data/README.rdoc

@@ -1,15 +1,13 @@
 = RobustExcelOle
 
-This ruby gem automates reading, modifying, and writing Excel files.
-It supports simultaneously running Excel instances and user interactions.
+This ruby gem automates reading, modifying, and writing Excel files. It is designed to support several kinds of concurrency of both simultaneously running Excel instances and simultanously happening user interactions.
 RobustExcelOle deals with various cases of Excel and user behaviour,
 and implements workarounds for some Excel bugs.
 The gem provides convenient methods for common tasks, and facilitates referenced libraries.
 It supports Excel 2010.
 
 RobustExcelOle works by sending VBA methods via Win32OLE.
-Moreover, it implements a management system and keeps track of Excel files and Excel instances.
-The tool is optimised with help of the rcov tool.
+It implements a management system and keeps track of Excel files and Excel instances.
 
 == Requirements
 
@@ -24,6 +22,10 @@ The tool is optimised with help of the rcov tool.
   require 'robust_excel_ole'
   include RobustExcelOle
 
+or call the console 
+
+  reo.bat
+
 == Description  
 
 In the following, some features of RobustExcelOle are depicted.
@@ -291,6 +293,10 @@ Hard terminating all Excel processes is done by
 
   Excel.kill_all
 
+=== Development
+
+The tests of RobustExcelOle are optimised with help of the rcov tool.  
+
 === More details
 
 {README_detail.rdoc}[https://github.com/Thomas008/robust_excel_ole/blob/master/README_detail.rdoc]

data/README_detail.rdoc

@@ -1,15 +1,13 @@
 = RobustExcelOle
 
-This ruby gem automates modifying, reading and writing Excel files.
-It supports simultaneously running Excel instances and user interactions.
+This ruby gem automates reading, modifying, and writing Excel files. It is designed to support several kinds of concurrency of both simultaneously running Excel instances and simultanously happening user interactions.
 RobustExcelOle deals with various cases of Excel and user behaviour,
 and implements workarounds for some Excel bugs.
 The gem provides convenient methods for common tasks, and facilitates referenced libraries.
 It supports Excel 2010.
 
 RobustExcelOle works by sending VBA methods via Win32OLE.
-Moreover, it implements a management system and keeps track of Excel files and Excel instances.
-The tool is optimised with help of rcov.
+It implements a management system and keeps track of Excel files and Excel instances.
 
 == Requirements
 
@@ -21,8 +19,13 @@ The tool is optimised with help of rcov.
 
 == Usage
 
+  require 'robust_excel_ole'
   include RobustExcelOle
 
+or call the console 
+
+  reo.bat
+
 === Opening a workbook.
 
 Example:

data/lib/robust_excel_ole/book.rb

@@ -4,12 +4,14 @@ require 'weakref'
 
 module RobustExcelOle
 
-  class Book < REOCommon
+  class Book < RangeOwners
 
     attr_accessor :excel
     attr_accessor :ole_workbook
     attr_accessor :stored_filename
     attr_accessor :options    
+    attr_accessor :modified_cells
+    attr_reader :workbook
 
     alias ole_object ole_workbook
 
@@ -154,6 +156,8 @@ module RobustExcelOle
         ensure_workbook(file, options)        
       end
       bookstore.store(self)
+      @modified_cells = []
+      @workbook = @excel.workbook = self
       if block
         begin
           yield self
@@ -548,6 +552,7 @@ module RobustExcelOle
       raise WorkbookReadOnly, "Not opened for writing (opened with :read_only option)" if @ole_workbook.ReadOnly
       begin
         discoloring if opts[:discoloring] 
+        @modified_cells = []
         @ole_workbook.Save 
       rescue WIN32OLERuntimeError => msg
         if msg.message =~ /SaveAs/ and msg.message =~ /Workbook/ then
@@ -632,7 +637,8 @@ module RobustExcelOle
   private
 
     def discoloring
-      self.each{|sheet| sheet.each{|cell| cell.Interior.ColorIndex = XlNone}}
+      # self.each{|sheet| sheet.UsedRange.each{|cell| cell.Interior.ColorIndex = XlNone}}
+      @modified_cells.each{|cell| cell.Interior.ColorIndex = XlNone}
     end
 
     def save_as_workbook(file, options)   # :nodoc: #
@@ -645,6 +651,7 @@ module RobustExcelOle
             when '.xlsm'; RobustExcelOle::XlOpenXMLWorkbookMacroEnabled
           end
         discoloring if options[:discoloring]  
+        @modified_cells = []
         @ole_workbook.SaveAs(General::absolute_path(file), file_format)
         bookstore.store(self)
       rescue WIN32OLERuntimeError => msg
@@ -661,15 +668,7 @@ module RobustExcelOle
 
     # closes a given file if it is open
     def self.close(file, opts = {:if_unsaved => :raise})
-      #puts "self.close:"
-      #puts "file: #{file}"
-      #begin
-      #  bookstore.fetch(file)
-      #rescue
-      #  puts "#{$!.message}"
-      #end
       book = bookstore.fetch(file) rescue nil
-      #puts "book after fetch: #{book.inspect}"
       book.close(opts) if book && book.alive?
     end
 
@@ -722,7 +721,7 @@ module RobustExcelOle
     def copy_sheet(sheet, opts = { })
       new_sheet_name = opts.delete(:as)
       after_or_before, base_sheet = opts.to_a.first || [:after, last_sheet]
-      sheet.Copy({ after_or_before.to_s => base_sheet.worksheet })
+      sheet.Copy({ after_or_before.to_s => base_sheet.ole_worksheet })
       new_sheet = sheet_class.new(@excel.Activesheet)
       new_sheet.name = new_sheet_name if new_sheet_name
       new_sheet
@@ -739,7 +738,7 @@ module RobustExcelOle
     def add_empty_sheet(opts = { })
       new_sheet_name = opts.delete(:as)
       after_or_before, base_sheet = opts.to_a.first || [:after, last_sheet]
-      @ole_workbook.Worksheets.Add({ after_or_before.to_s => base_sheet.worksheet })
+      @ole_workbook.Worksheets.Add({ after_or_before.to_s => base_sheet.ole_worksheet })
       new_sheet = sheet_class.new(@excel.Activesheet)
       new_sheet.name = new_sheet_name if new_sheet_name
       new_sheet
@@ -788,66 +787,6 @@ module RobustExcelOle
       set_nameval(name,value, :color => 42)   # 42 - aqua-marin, 4-green
     end
 
-    # 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
-    # @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)
-      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 #{File.basename(self.stored_filename).inspect}"
-        end
-      end
-      if value.is_a?(Bignum)  #RobustExcelOle::XlErrName  
-        return opts[:default] if opts[:default]
-        raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{File.basename(self.stored_filename).inspect}"
-      end 
-      return opts[:default] if opts[:default] && value.nil?
-      value      
-    end
-
-    # sets the contents of a range
-    # @param [String]  name  the name of a range
-    # @param [Variant] value the contents of the range
-    # @param [FixNum]  color the color when setting a value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_nameval(name, value, opts = {:color => 0})
-      begin
-        cell = name_object(name).RefersToRange
-        cell.Interior.ColorIndex = opts[:color] 
-        cell.Value = value
-      rescue WIN32OLERuntimeError
-        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{File.basename(self.stored_filename).inspect}"    
-      end
-    end
-
-  private        
-
-    def name_object(name)
-      begin
-        self.Parent.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        begin
-          self.Names.Item(name)
-        rescue WIN32OLERuntimeError
-          raise NameNotFound, "name #{name.inspect} not in #{File.basename(self.stored_filename).inspect}"  
-        end
-      end
-    end
-
-  public    
-
     # renames a range
     # @param [String] name     the previous range name
     # @param [String] new_name the new range name

data/lib/robust_excel_ole/excel.rb

@@ -10,17 +10,18 @@ end
 
 module RobustExcelOle      
 
-  class Excel < REOCommon    
+  class Excel < RangeOwners   
 
     attr_accessor :ole_excel
     attr_accessor :created
-    
+    attr_accessor :workbook
+
     # setter methods are implemented below
     attr_reader :visible
     attr_reader :displayalerts
     attr_reader :calculation
     attr_reader :screenupdating
-
+    
     alias ole_object ole_excel
 
     @@hwnd2excel = {}    
@@ -96,7 +97,7 @@ module RobustExcelOle
           result.screenupdating = options[:screenupdating] unless options[:screenupdating].nil?
           result.created = !reused
         end
-      end
+      end    
       result
     end
 
@@ -603,105 +604,6 @@ module RobustExcelOle
       set_nameval(name,value, :color => 42) # 42 - aqua-marin, 7-green
     end
 
-    # returns the contents of a range with given 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
-    # @param [String] name  the range name
-    # @param [Hash]   opts  the options
-    # @option opts [Variant] :default value (default: nil)
-    def nameval(name, opts = {:default => nil})
-      name_obj = name_object(name)
-      value = begin
-        name_obj.RefersToRange.Value
-      rescue  WIN32OLERuntimeError
-        begin
-          self.Evaluate(name_obj.Name)
-        rescue WIN32OLERuntimeError
-          return opts[:default] if opts[:default]
-          raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}"
-        end
-      end
-      if value.is_a?(Bignum)
-        return opts[:default] if opts[:default]
-        raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}"
-      end 
-      return opts[:default] if (value.nil? && opts[:default])
-      value      
-    end
-
-    # assigns a value to a range with given name
-    # @param [String]  name   the range name
-    # @param [Variant] value  the assigned value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_nameval(name,value, opts = {:color => 0})
-      begin
-        cell = name_object(name).RefersToRange
-        cell.Interior.ColorIndex = opts[:color]
-        cell.Value = value
-      rescue  WIN32OLERuntimeError
-        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect}"
-      end
-    end
-
-  private  
-
-    def name_object(name)
-      begin
-        self.Parent.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        begin
-          self.Names.Item(name)
-        rescue WIN32OLERuntimeError
-          raise NameNotFound, "name #{name.inspect}"
-        end
-      end
-    end  
-
-  public    
-
-    # 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
-    # @param  [String]      name      the range name
-    # @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})
-      begin
-        range = self.Range(name)
-      rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise NameNotFound, "cannot find name #{name.inspect}"
-      end
-      begin
-        value = range.Value
-      rescue  WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        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.is_a?(Bignum)
-      value
-    end
-
-    # assigns a value to a range given a locally defined name
-    # @param [String]  name   the range name
-    # @param [Variant] value  the assigned value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_rangeval(name,value, opts = {:color => 0})
-      begin
-        range = self.Range(name)
-      rescue WIN32OLERuntimeError
-        raise NameNotFound, "cannot find name #{name.inspect}"
-      end
-      begin
-        range.Interior.ColorIndex = opts[:color]
-        range.Value = value        
-      rescue  WIN32OLERuntimeError
-        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.name}"
-      end
-    end
-
     def to_s              # :nodoc: #
       "#<Excel: " + "#{hwnd}" + ("#{"not alive" unless self.alive?}") + ">"
     end

data/lib/robust_excel_ole/reo_common.rb

@@ -6,52 +6,6 @@ REO_LOG_FILE  = "reo.log" unless Object.const_defined?(:REO_LOG_FILE)
   
 File.delete REO_LOG_FILE rescue nil
 
-class REOCommon
-
-  def excel
-    raise TypeErrorREO, "receiver instance is neither an Excel nor a Book"
-  end
-
-  def own_methods
-    (self.methods - Object.methods).sort
-  end
-
-  def self.tr1(text)
-    puts :text
-  end
-
-  def self.trace(text)
-    if LOG_TO_STDOUT 
-      puts text
-    else
-      if REO_LOG_DIR.empty?
-        homes = ["HOME", "HOMEPATH"]
-        home = homes.find {|h| ENV[h] != nil}
-        reo_log_dir = ENV[home]
-      else
-        reo_log_dir = REO_LOG_DIR
-      end
-      File.open(reo_log_dir + "/" + REO_LOG_FILE,"a") do | file |
-        file.puts text
-      end
-    end
-  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
 
   class REOError < RuntimeError                 # :nodoc: #
@@ -123,5 +77,163 @@ module RobustExcelOle
   class UnexpectedError < REOError              # :nodoc: #
   end
 
-end
+  class REOCommon
+
+    def excel
+      raise TypeErrorREO, "receiver instance is neither an Excel nor a Book"
+    end
+
+    def own_methods
+      (self.methods - Object.methods).sort
+    end
+
+    def self.tr1(text)
+      puts :text
+    end
+
+    def self.trace(text)
+      if LOG_TO_STDOUT 
+        puts text
+      else
+        if REO_LOG_DIR.empty?
+          homes = ["HOME", "HOMEPATH"]
+          home = homes.find {|h| ENV[h] != nil}
+          reo_log_dir = ENV[home]
+        else
+          reo_log_dir = REO_LOG_DIR
+        end
+        File.open(reo_log_dir + "/" + REO_LOG_FILE,"a") do | file |
+          file.puts text
+        end
+      end
+    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
+
+  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
+    # @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)
+      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
+      end
+      if value.is_a?(Bignum)  #RobustExcelOle::XlErrName  
+        return opts[:default] if opts[:default]
+        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?
+      value      
+    end
+
+    # sets the contents of a range
+    # @param [String]  name  the name of a range
+    # @param [Variant] value the contents of the range
+    # @param [FixNum]  color the color when setting a value
+    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
+    def set_nameval(name, value, opts = {:color => 0})
+      begin
+        cell = name_object(name).RefersToRange
+        cell.Interior.ColorIndex = opts[:color] 
+        workbook.modified_cells << cell unless cell_modified?(cell) if workbook
+        cell.Value = value
+      rescue WIN32OLERuntimeError
+        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.inspect}" 
+      end
+    end
+
+    # 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
+    # @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})
+      begin
+        range = self.Range(name)
+      rescue WIN32OLERuntimeError
+        return opts[:default] if opts[:default]
+        raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
+      end
+      begin
+        value = range.Value
+      rescue  WIN32OLERuntimeError
+        return opts[:default] if opts[:default]
+        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
+    end
+
+    # 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
+    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
+    def set_rangeval(name,value, opts = {:color => 0})
+      begin
+        return set_nameval(name, value, opts) if self.is_a?(Book)
+        range = self.Range(name)
+      rescue WIN32OLERuntimeError
+        raise NameNotFound, "name #{name.inspect} not in #{self.inspect}"
+      end
+      begin
+        range.Interior.ColorIndex = opts[:color]
+        workbook.modified_cells << range unless cell_modified?(range) if workbook
+        range.Value = value
+      rescue  WIN32OLERuntimeError
+        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.inspect}"
+      end
+    end
+
+  private  
+
+    def name_object(name)
+      begin
+        self.Parent.Names.Item(name)
+      rescue WIN32OLERuntimeError
+        begin
+          self.Names.Item(name)
+        rescue WIN32OLERuntimeError
+          raise RobustExcelOle::NameNotFound, "name #{name.inspect} not in #{self.inspect}"  
+        end
+      end
+    end
+
+    def cell_modified?(cell)
+      workbook.modified_cells.each{|c| return true if c.Name.Value == cell.Name.Value}    
+      false
+    end
+
+  end
 
+end

data/lib/robust_excel_ole/sheet.rb

@@ -2,36 +2,35 @@
 
 module RobustExcelOle
 
-  class Sheet < REOCommon
-    attr_reader :worksheet
+  class Sheet < RangeOwners
+
+    attr_reader :ole_worksheet
+    attr_reader :workbook
 
     def initialize(win32_worksheet)
-      @worksheet = win32_worksheet
-      if @worksheet.ProtectContents
-        @worksheet.Unprotect
+      @ole_worksheet = win32_worksheet
+      if @ole_worksheet.ProtectContents
+        @ole_worksheet.Unprotect
         @end_row = last_row
         @end_column = last_column
-        @worksheet.Protect
+        @ole_worksheet.Protect
       else
         @end_row = last_row
         @end_column = last_column
       end
-    end
-
-    def workbook
-      book_class.new(self.Parent)
+      @workbook = book_class.new(self.Parent)
     end
 
     # returns name of the sheet
     def name
-      @worksheet.Name
+      @ole_worksheet.Name
     end
 
     # name the sheet
     # @param [String] new_name the new name of the sheet 
     def name= (new_name)
       begin
-        @worksheet.Name = new_name
+        @ole_worksheet.Name = new_name
       rescue WIN32OLERuntimeError => msg
         if msg.message =~ /800A03EC/ 
           raise NameAlreadyExists, "sheet name #{new_name.inspect} already exists"
@@ -49,7 +48,7 @@ module RobustExcelOle
         yx = "#{y}_#{x}"
         @cells = { }
         begin
-          @cells[yx] = RobustExcelOle::Cell.new(@worksheet.Cells.Item(y, x))
+          @cells[yx] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(y, x))
         rescue
           raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
         end
@@ -73,7 +72,7 @@ module RobustExcelOle
       if p3 != :__not_provided
         y, x, value = p1, p2, p3
         begin
-          cell = @worksheet.Cells.Item(y, x)
+          cell = @ole_worksheet.Cells.Item(y, x)
           cell.Value = value
           cell.Interior.ColorIndex = 42 # aqua-marin, 4-green
         rescue WIN32OLERuntimeError
@@ -92,104 +91,6 @@ module RobustExcelOle
         end
       end
     end
-
-    # returns the contents of a range
-    # evaluates the formula if the contents is a formula
-    # if no contents could be returned, then return default value, if provided, raise error otherwise
-    # @param [String] name  the name of a range
-    # @param [Hash]   opts  the options
-    # @option opts [Variant] :default default value (default: nil)
-    def nameval(name, opts = {:default => nil})
-      name_obj = name_object(name)
-      value = begin
-        name_obj.RefersToRange.Value
-      rescue WIN32OLERuntimeError
-        begin
-          self.Evaluate(name_obj.Name)
-        rescue WIN32OLERuntimeError
-          return opts[:default] if opts[:default]
-          raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self.Name}"
-        end
-      end
-      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 
-      return opts[:default] if (value.nil? && opts[:default])
-      value      
-    end
-    
-    # assigns a value to a range
-    # @param [String]  name   the name of a range
-    # @param [Variant] value  the assigned value
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_nameval(name,value, opts = {:color => 0})
-      begin
-        cell = name_object(name).RefersToRange        
-        cell.Interior.ColorIndex = opts[:color]
-        cell.Value = value
-      rescue  WIN32OLERuntimeError
-        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.name}"
-      end
-    end
-
-  private
-
-    def name_object(name)
-      begin
-        self.Parent.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        begin
-          self.Names.Item(name)
-        rescue WIN32OLERuntimeError
-          raise NameNotFound, "name #{name.inspect} not in #{self.name}"
-        end
-      end
-    end
-
-  public    
-
-    # 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
-    # @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})
-      begin
-        range = self.Range(name)
-      rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise NameNotFound, "name #{name.inspect} not in #{self.name}"
-      end
-      begin
-        value = range.Value
-      rescue  WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise RangeNotEvaluatable, "cannot determine value of range named #{name.inspect} in #{self.name}"
-      end
-      return opts[:default] if (value.nil? && opts[:default])
-      value
-    end
-
-    # 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
-    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
-    def set_rangeval(name,value, opts = {:color => 0})
-      begin
-        range = self.Range(name)
-      rescue WIN32OLERuntimeError
-        raise NameNotFound, "name #{name.inspect} not in #{self.name}"
-      end
-      begin
-        range.Interior.ColorIndex = opts[:color]
-        range.Value = value
-      rescue  WIN32OLERuntimeError
-        raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.name}"
-      end
-    end
     
     # assigns a name to a range (a cell) given by an address
     # @param [String] name   the range name
@@ -233,7 +134,7 @@ module RobustExcelOle
       offset += 1
       1.upto(@end_row) do |row|
         next if row < offset
-        yield RobustExcelOle::Range.new(@worksheet.Range(@worksheet.Cells(row, 1), @worksheet.Cells(row, @end_column)))
+        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, 1), @ole_worksheet.Cells(row, @end_column)))
       end
     end
 
@@ -247,7 +148,7 @@ module RobustExcelOle
       offset += 1
       1.upto(@end_column) do |column|
         next if column < offset
-        yield RobustExcelOle::Range.new(@worksheet.Range(@worksheet.Cells(1, column), @worksheet.Cells(@end_row, column)))
+        yield RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(1, column), @ole_worksheet.Cells(@end_row, column)))
       end
     end
 
@@ -259,12 +160,12 @@ module RobustExcelOle
 
     def row_range(row, range = nil)
       range ||= 1..@end_column
-      RobustExcelOle::Range.new(@worksheet.Range(@worksheet.Cells(row , range.min ), @worksheet.Cells(row , range.max )))
+      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row , range.min ), @ole_worksheet.Cells(row , range.max )))
     end
 
     def col_range(col, range = nil)
       range ||= 1..@end_row
-      RobustExcelOle::Range.new(@worksheet.Range(@worksheet.Cells(range.min , col ), @worksheet.Cells(range.max , col )))
+      RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(range.min , col ), @ole_worksheet.Cells(range.max , col )))
     end
 
 
@@ -281,12 +182,20 @@ module RobustExcelOle
       self.class.book_class
     end
 
-    private
+    def to_s    # :nodoc: #
+      "#<Sheet: " + "#{"not alive " unless @workbook.alive?}" + "#{name}" + " #{File.basename(@workbook.stored_filename)} >"
+    end
+
+    def inspect    # :nodoc: #
+      self.to_s
+    end
+
+  private
 
     def method_missing(name, *args)    # :nodoc: #
       if name.to_s[0,1] =~ /[A-Z]/ 
         begin
-          @worksheet.send(name, *args)
+          @ole_worksheet.send(name, *args)
         rescue WIN32OLERuntimeError => msg
           if msg.message =~ /unknown property or method/
             raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
@@ -299,22 +208,19 @@ module RobustExcelOle
       end
     end
 
-
     def last_row
-      special_last_row = @worksheet.UsedRange.SpecialCells(RobustExcelOle::XlLastCell).Row
-      used_last_row = @worksheet.UsedRange.Rows.Count
+      special_last_row = @ole_worksheet.UsedRange.SpecialCells(RobustExcelOle::XlLastCell).Row
+      used_last_row = @ole_worksheet.UsedRange.Rows.Count
 
       special_last_row >= used_last_row ? special_last_row : used_last_row
     end
 
     def last_column
-      special_last_column = @worksheet.UsedRange.SpecialCells(RobustExcelOle::XlLastCell).Column
-      used_last_column = @worksheet.UsedRange.Columns.Count
+      special_last_column = @ole_worksheet.UsedRange.SpecialCells(RobustExcelOle::XlLastCell).Column
+      used_last_column = @ole_worksheet.UsedRange.Columns.Count
 
       special_last_column >= used_last_column ? special_last_column : used_last_column
     end    
   end
-
-  public
   
 end

data/lib/robust_excel_ole/version.rb

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

data/robust_excel_ole.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |s|
   
   s.summary     = "RobustExcelOle automates processing Excel files in Windows by using the win32ole library."
   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.
+                   It is disigned to cope with several kinds of concurrency of both simultaneously running
+                   Excel instances and simultanously happening user interactions.
                    RobustExcelOle deals with various cases of Excel (and user) behaviour,
                    supplies workarounds for some Excel bugs, and supports referenced libraries."                 
 

data/spec/book_spec.rb

@@ -1064,17 +1064,17 @@ describe Book do
       @book1.nameval("new").should == "bar"
     end
 
-    it "should evaluate a formula" do
-      @book1.nameval("named_formula").should == 4      
-    end
+    #it "should evaluate a formula" do
+    #  @book1.nameval("named_formula").should == 4      
+    #end
 
-    it "should evaluate a formula via []" do
-      @book1["named_formula"].should == 4      
-    end
+    #it "should evaluate a formula via []" do
+    #  @book1["named_formula"].should == 4      
+    #end
 
-    it "should return default value if name not defined" do
-      @book1.nameval("foo", :default => 2).should == 2
-    end
+    #it "should return default value if name not defined" do
+    #  @book1.nameval("foo", :default => 2).should == 2
+    #end
 
   end
 

data/spec/book_specs/book_misc_spec.rb

@@ -646,33 +646,33 @@ describe Book do
       @book1.nameval("new").should == "bar"
     end
 
-    it "should evaluate a formula" do
-      @book1.nameval("named_formula").should == 4      
-    end
+    #it "should evaluate a formula" do
+    #  @book1.nameval("named_formula").should == 4      
+    #end
 
-    it "should evaluate a formula via []" do
-      @book1["named_formula"].should == 4      
-    end
+    #it "should evaluate a formula via []" do
+    #  @book1["named_formula"].should == 4      
+    #end
 
     it "should raise an error if name not defined" do
       expect {
         @book1.nameval("foo")
-      }.to raise_error(NameNotFound, /name "foo" not in "another_workbook.xls"/)
+      }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
       expect {
           @book1.set_nameval("foo","bar")
-      }.to raise_error(NameNotFound, /name "foo" not in "another_workbook.xls"/)
+      }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
       expect {
           @book1["foo"] = "bar"
-      }.to raise_error(NameNotFound, /name "foo" not in "another_workbook.xls"/)
+      }.to raise_error(NameNotFound, /name "foo" not in #<Book: another_workbook/)
     end    
 
     it "should raise an error if name was defined but contents is calcuated" do
       expect {
         @book1.set_nameval("named_formula","bar")
-      }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "named_formula" in "another_workbook.xls"/)
+      }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "named_formula" in #<Book: another_workbook/)
       expect {
         @book1["named_formula"] = "bar"
-      }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "named_formula" in "another_workbook.xls"/)
+      }.to raise_error(RangeNotEvaluatable, /cannot assign value to range named "named_formula" in #<Book: another_workbook/)
     end
 
     # Excel Bug: for local names without uqifier: takes the first sheet as default even if another sheet is activated

data/spec/excel_spec.rb

@@ -1722,10 +1722,10 @@ module RobustExcelOle
         @excel1["firstcell"].should == "foo"
       end        
 
-      it "should evaluate a formula" do
-        @excel1.nameval("named_formula").should == 4
-        @excel1["named_formula"].should == 4
-      end
+      #it "should evaluate a formula" do
+      #  @excel1.nameval("named_formula").should == 4
+      #  @excel1["named_formula"].should == 4
+      #end
 
       it "should raise an error if name not defined" do
         expect {
@@ -1791,14 +1791,14 @@ module RobustExcelOle
       it "should raise an error if name not defined for the sheet" do
         expect {
           @excel1.rangeval("foo")
-          }.to raise_error(NameNotFound, /cannot find name "foo"/)
+          }.to raise_error(NameNotFound, /name "foo" not in/)
         expect {
           @excel1.rangeval("named_formula")
-          }.to raise_error(NameNotFound, /cannot find name "named_formula"/)
+          }.to raise_error(NameNotFound, /name "named_formula" not in/)
         expect {
           excel2 = Excel.create
           excel2.rangeval("one")
-        }.to raise_error(NameNotFound, /cannot find name "one"/)
+        }.to raise_error(NameNotFound, /name "one" not in/)
       end
     
       it "should set a range to a value" do
@@ -1810,7 +1810,7 @@ module RobustExcelOle
       it "should raise an error if name cannot be evaluated" do
         expect{
           @excel1.set_nameval("foo", 1)
-        }.to raise_error(NameNotFound, /cannot find name "foo"/)
+        }.to raise_error(NameNotFound, /name "foo" not in/)
       end
 
     end

data/spec/range_spec.rb

@@ -16,7 +16,7 @@ describe RobustExcelOle::Range do
     @dir = create_tmpdir
     @book = Book.open(@dir + '/workbook.xls', :force_excel => :new)
     @sheet = @book.sheet(2)
-    @range = RobustExcelOle::Range.new(@sheet.worksheet.UsedRange.Rows(1))
+    @range = RobustExcelOle::Range.new(@sheet.ole_worksheet.UsedRange.Rows(1))
   end
 
   after do
@@ -53,7 +53,7 @@ describe RobustExcelOle::Range do
     context "when instance is column range" do
       before do
         @sheet = @book.sheet(1)
-        @range = RobustExcelOle::Range.new(@sheet.worksheet.UsedRange.Columns(1))
+        @range = RobustExcelOle::Range.new(@sheet.ole_worksheet.UsedRange.Columns(1))
       end
       it { @range.values.should eq ['foo', 'foo', 'matz'] }
     end

data/spec/sheet_spec.rb

@@ -443,18 +443,18 @@ describe Sheet do
         @sheet1["another"].should == nil
       end 
 
-      it "should evaluate named formula" do
-        @sheet1["named_formula"].should == 4
-      end                
+      #it "should evaluate named formula" do
+      #  @sheet1["named_formula"].should == 4
+      #end                
 
-      it "should evaluate a formula" do
-        @sheet1["another_formula"].should == 5
-      end      
+      #it "should evaluate a formula" do
+      #  @sheet1["another_formula"].should == 5
+      #end      
 
       it "should raise an error if name not defined" do
         expect {
           @sheet1["foo"]
-        }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)        
+        }.to raise_error(NameNotFound, /name "foo" not in #<Sheet: Sheet1/)        
       end
 
       it "should set a range to a value" do
@@ -468,7 +468,7 @@ describe Sheet do
       it "should raise an error if name cannot be evaluated" do
         expect{
           @sheet1["foo"] = 1
-          }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)
+          }.to raise_error(NameNotFound, /name "foo" not in #<Sheet: Sheet1/)
       end
     end
 
@@ -487,20 +487,20 @@ describe Sheet do
         @sheet1.nameval("firstcell").should == "foo"
       end
 
-      it "should evaluate a formula" do
-        @sheet1.nameval("another_formula").should == 5
-      end      
+      #it "should evaluate a formula" do
+      #  @sheet1.nameval("another_formula").should == 5
+      #end      
 
       it "should raise an error if name not defined" do
         expect {
           @sheet1.nameval("foo")
-        }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)
+        }.to raise_error(NameNotFound, /name "foo" not in/)
       end
 
       it "should raise an error of coordinates are given instead of a defined name" do
         expect {
           @sheet1.nameval("A1")
-        }.to raise_error(NameNotFound, /name "A1" not in Sheet1/)
+        }.to raise_error(NameNotFound, /name "A1" not in #<Sheet: Sheet1/)
       end
 
       it "should return default value for a range with empty contents" do
@@ -518,7 +518,7 @@ describe Sheet do
       it "should raise an error if name cannot be evaluated" do
         expect{
           @sheet1.set_nameval("foo", 1)
-        }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)
+        }.to raise_error(NameNotFound, /name "foo" not in #<Sheet: Sheet1/)
       end
     end
 
@@ -560,13 +560,13 @@ describe Sheet do
       it "should raise an error if name not defined for the sheet" do
         expect {
           @sheet1.rangeval("foo")
-          }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)
+          }.to raise_error(NameNotFound, /name "foo" not in #<Sheet: Sheet1/)
         expect {
           @sheet1.rangeval("named_formula")
-          }.to raise_error(NameNotFound, /name "named_formula" not in Sheet1/)
+          }.to raise_error(NameNotFound, /name "named_formula" not in #<Sheet: Sheet1/)
         expect {
           @sheet2.rangeval("firstcell")
-          }.to raise_error(NameNotFound, /name "firstcell" not in Sheet2/)
+          }.to raise_error(NameNotFound, /name "firstcell" not in #<Sheet: Sheet2/)
       end
     
       it "should set a range to a value" do
@@ -580,7 +580,7 @@ describe Sheet do
       it "should raise an error if name cannot be evaluated" do
         expect{
           @sheet1.set_nameval("foo", 1)
-        }.to raise_error(NameNotFound, /name "foo" not in Sheet1/)
+        }.to raise_error(NameNotFound, /name "foo" not in #<Sheet: Sheet1/)
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -26,7 +26,8 @@ dependencies:
         version: 2.6.0
 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.
+                     It is disigned to cope with several kinds of concurrency of both simultaneously running
+                     Excel instances and simultanously happening user interactions.
                      RobustExcelOle deals with various cases of Excel (and user) behaviour,
                      supplies workarounds for some Excel bugs, and supports referenced libraries.
 email: