robust_excel_ole 1.1 → 1.1.1

data/lib/robust_excel_ole/excel.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 require 'weakref'
+require 'Win32API'
 
 def ka 
   Excel.kill_all
@@ -381,10 +382,8 @@ module RobustExcelOle
       processes.select{ |p| p.name == "EXCEL.EXE"}.size
     end
 
-    # provide Excel objects 
-    # (so far restricted to all Excel instances opened with RobustExcelOle,
-    #  not for Excel instances opened by the user)
-    def self.excel_processes
+    # returns all Excel objects for all Excel instances opened with RobustExcelOle,
+    def self.known_excel_instances
       pid2excel = {}
       @@hwnd2excel.each do |hwnd,wr_excel|
         if wr_excel.weakref_alive?
@@ -601,7 +600,7 @@ module RobustExcelOle
     # @param [String]  name  the name of the range
     # @param [Variant] value the contents of the range
     def []= (name, value)
-      set_nameval(name,value)
+      set_nameval(name,value, :color => 42) # 42 - aqua-marin, 7-green
     end
 
     # returns the contents of a range with given name
@@ -611,17 +610,12 @@ module RobustExcelOle
     # @param [Hash]   opts  the options
     # @option opts [Variant] :default value (default: nil)
     def nameval(name, opts = {:default => nil})
-      begin
-        name_obj = self.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise NameNotFound, "cannot find name #{name.inspect}"
-      end
-      begin
-        value = name_obj.RefersToRange.Value
+      name_obj = name_object(name)
+      value = begin
+        name_obj.RefersToRange.Value
       rescue  WIN32OLERuntimeError
         begin
-          value = self.Evaluate(name_obj.Name)
+          self.Evaluate(name_obj.Name)
         rescue WIN32OLERuntimeError
           return opts[:default] if opts[:default]
           raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect}"
@@ -634,22 +628,36 @@ module RobustExcelOle
       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
-    def set_nameval(name,value)
-      begin
-        name_obj = self.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        raise NameNotFound, "cannot find name #{name.inspect}"
-      end
+    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
+    def set_nameval(name,value, opts = {:color => 0})
       begin
-        name_obj.RefersToRange.Value = value
+        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    
+    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
@@ -679,14 +687,16 @@ module RobustExcelOle
     # assigns a value to a range given a locally defined name
     # @param [String]  name   the range name
     # @param [Variant] value  the assigned value
-    def set_rangeval(name,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.Value = value
+        range.Interior.ColorIndex = opts[:color]
+        range.Value = value        
       rescue  WIN32OLERuntimeError
         raise RangeNotEvaluatable, "cannot assign value to range named #{name.inspect} in #{self.name}"
       end

data/lib/robust_excel_ole/general.rb

@@ -113,7 +113,7 @@ module MethodHelpers
   end
 
   def methods   # :nodoc: # 
-    (super + ole_object.ole_methods.map{|m| m.to_s}).uniq.select{|m| m =~ /^(?!\_)/}.sort
+    (super.map{|m| m.to_s} + ole_object.ole_methods.map{|m| m.to_s}).uniq.select{|m| m =~ /^(?!\_)/}.sort
   end
 
 end

data/lib/robust_excel_ole/sheet.rb

@@ -48,7 +48,11 @@ module RobustExcelOle
         y, x = p1, p2
         yx = "#{y}_#{x}"
         @cells = { }
-        @cells[yx] = RobustExcelOle::Cell.new(@worksheet.Cells.Item(y, x))
+        begin
+          @cells[yx] = RobustExcelOle::Cell.new(@worksheet.Cells.Item(y, x))
+        rescue
+          raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
+        end
       else
         name = p1
         begin
@@ -68,11 +72,17 @@ module RobustExcelOle
     def []= (p1, p2, p3 = :__not_provided)
       if p3 != :__not_provided
         y, x, value = p1, p2, p3
-        @worksheet.Cells.Item(y, x).Value = value
+        begin
+          cell = @worksheet.Cells.Item(y, x)
+          cell.Value = value
+          cell.Interior.ColorIndex = 42 # aqua-marin, 4-green
+        rescue WIN32OLERuntimeError
+          raise RangeNotEvaluatable, "cannot assign value #{p3.inspect} to cell (#{p1.inspect},#{p2.inspect})"
+        end
       else
         name, value = p1, p2
         begin
-          set_nameval(name, value) 
+          set_nameval(name, value, :color => 42) # aqua-marin, 4-green
         rescue REOError
           begin
             workbook.set_nameval(name, value)
@@ -83,52 +93,6 @@ module RobustExcelOle
       end
     end
 
-    def each
-      each_row do |row_range|
-        row_range.each do |cell|
-          yield cell
-        end
-      end
-    end
-
-    def each_row(offset = 0)
-      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)))
-      end
-    end
-
-    def each_row_with_index(offset = 0)
-      each_row(offset) do |row_range|
-        yield RobustExcelOle::Range.new(row_range), (row_range.row - 1 - offset)
-      end
-    end
-
-    def each_column(offset = 0)
-      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)))
-      end
-    end
-
-    def each_column_with_index(offset = 0)
-      each_column(offset) do |column_range|
-        yield RobustExcelOle::Range.new(column_range), (column_range.column - 1 - offset)
-      end
-    end
-
-    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 )))
-    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 )))
-    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
@@ -136,17 +100,12 @@ module RobustExcelOle
     # @param [Hash]   opts  the options
     # @option opts [Variant] :default default value (default: nil)
     def nameval(name, opts = {:default => nil})
-      begin
-        name_obj = self.Names.Item(name)
+      name_obj = name_object(name)
+      value = begin
+        name_obj.RefersToRange.Value
       rescue WIN32OLERuntimeError
-        return opts[:default] if opts[:default]
-        raise NameNotFound, "name #{name.inspect} not in #{self.Name}"
-      end
-      begin
-        value = name_obj.RefersToRange.Value
-      rescue  WIN32OLERuntimeError
         begin
-          value = self.Evaluate(name_obj.Name)
+          self.Evaluate(name_obj.Name)
         rescue WIN32OLERuntimeError
           return opts[:default] if opts[:default]
           raise RangeNotEvaluatable, "cannot evaluate range named #{name.inspect} in #{self.Name}"
@@ -163,19 +122,33 @@ module RobustExcelOle
     # assigns a value to a range
     # @param [String]  name   the name of a range
     # @param [Variant] value  the assigned value
-    def set_nameval(name,value)
+    # @param [Hash]    opts :color [FixNum]  the color when setting the contents
+    def set_nameval(name,value, opts = {:color => 0})
       begin
-        name_obj = self.Names.Item(name)
-      rescue WIN32OLERuntimeError
-        raise NameNotFound, "name #{name.inspect} not in #{self.name}"
-      end
-      begin
-        name_obj.RefersToRange.Value = value
+        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
@@ -203,13 +176,15 @@ 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_rangeval(name,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}"
@@ -235,6 +210,64 @@ module RobustExcelOle
       end
     end
 
+
+    def each
+      each_row do |row_range|
+        row_range.each do |cell|
+          yield cell
+        end
+      end
+    end
+
+    def each_with_index(offset = 0)
+      i = offset
+      each_row do |row_range|
+        row_range.each do |cell|          
+          yield cell, i
+          i+=1
+        end
+      end
+    end
+
+    def each_row(offset = 0)
+      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)))
+      end
+    end
+
+    def each_row_with_index(offset = 0)
+      each_row(offset) do |row_range|
+        yield RobustExcelOle::Range.new(row_range), (row_range.row - 1 - offset)
+      end
+    end
+
+    def each_column(offset = 0)
+      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)))
+      end
+    end
+
+    def each_column_with_index(offset = 0)
+      each_column(offset) do |column_range|
+        yield RobustExcelOle::Range.new(column_range), (column_range.column - 1 - offset)
+      end
+    end
+
+    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 )))
+    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 )))
+    end
+
+
     def self.book_class   # :nodoc: #
       @book_class ||= begin
         module_name = self.parent_name

data/lib/robust_excel_ole/version.rb

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

data/reo.bat

@@ -1,3 +1,3 @@
 @echo off
 
-irb -f -r lib/robust_excel_ole -r lib/reo_console.rb
+irb -f -r ../robust_excel_ole/lib/robust_excel_ole -r ../robust_excel_ole/lib/reo_console.rb

data/spec/book_spec.rb

@@ -654,7 +654,7 @@ describe Book do
           @excel1.close
           @excel2.close 
         rescue ExcelError => msg
-          puts "ExcelError: #{msg.message}" if msg.message =~ /Excel instance not alive or damaged/
+          # puts "ExcelError: #{msg.message}" if msg.message =~ /Excel instance not alive or damaged/
         end
       end
 
@@ -1345,6 +1345,12 @@ describe Book do
           sheet.should be_kind_of Sheet
         end
       end
+
+      it 'with each_with_index' do
+        @book.each_with_index do |sheet,i|
+          sheet.should be_kind_of Sheet
+        end
+      end
     end
 
     describe "with retain_saved" do

data/spec/book_specs/book_misc_spec.rb

@@ -654,10 +654,6 @@ describe Book 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 raise an error if name not defined" do
       expect {
         @book1.nameval("foo")

data/spec/excel_spec.rb

@@ -1556,33 +1556,31 @@ module RobustExcelOle
 
     end
 
-    describe "excel_processes" do
+    describe "known_excel_instances" do
 
       it "should return empty list" do
-        Excel.excel_processes.should be_empty
+        Excel.known_excel_instances.should be_empty
       end
 
       it "should return list of one Excel process" do
         excel = Excel.new
-        Excel.excel_processes.should == [excel]
+        Excel.known_excel_instances.should == [excel]
         excel.close
       end
 
       it "should return list of two Excel processes" do
         excel1 = Excel.create
         excel2 = Excel.create
-        Excel.excel_processes.should == [excel1,excel2]
+        Excel.known_excel_instances.should == [excel1,excel2]
       end
 
       it "should return list of two Excel processes" do
         excel1 = Excel.new
         excel2 = Excel.current
         excel3 = Excel.create
-        Excel.excel_processes.should == [excel1,excel3]
+        Excel.known_excel_instances.should == [excel1,excel3]
       end
 
-
-
     end
 
     context "with hwnd and hwnd2excel" do
@@ -1724,10 +1722,6 @@ module RobustExcelOle
         @excel1["firstcell"].should == "foo"
       end        
 
-      it "should return default value if name not defined and default value is given" do
-        @excel1.nameval("foo", :default => 2).should == 2
-      end
-
       it "should evaluate a formula" do
         @excel1.nameval("named_formula").should == 4
         @excel1["named_formula"].should == 4
@@ -1736,18 +1730,18 @@ module RobustExcelOle
       it "should raise an error if name not defined" do
         expect {
           @excel1.nameval("foo")
-        }.to raise_error(NameNotFound, /cannot find name "foo"/)
+        }.to raise_error(NameNotFound, /name "foo"/)
         expect {
         @excel1["foo"]
-        }.to raise_error(NameNotFound, /cannot find name "foo"/)
+        }.to raise_error(NameNotFound, /name "foo"/)
         expect {
           excel2 = Excel.create
           excel2.nameval("one")
-        }.to raise_error(NameNotFound, /cannot find name "one"/)
+        }.to raise_error(NameNotFound, /name "one"/)
         expect {
           excel3 = Excel.create(:visible => true)
           excel3["one"]
-        }.to raise_error(NameNotFound, /cannot find name "one"/)
+        }.to raise_error(NameNotFound, /name "one"/)
       end
 
       it "should set a range to a value" do
@@ -1761,10 +1755,10 @@ 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"/)
         expect{
           @excel1["foo"] = 1
-          }.to raise_error(NameNotFound, /cannot find name "foo"/)
+          }.to raise_error(NameNotFound, /name "foo"/)
       end
     end