robust_excel_ole 1.20 → 1.23

data/lib/robust_excel_ole/range_owners.rb

@@ -62,7 +62,7 @@ module RobustExcelOle
     # sets the contents of a range
     # @param [String]  name  the name of a range
     # @param [Variant] value the contents of the range
-    # @option opts [Symbol] :color the color of the cell when set
+    # @option opts [Symbol] :color the color of the range when set
     def set_namevalue_glob(name, value, opts = { }) 
       begin
         name_obj = begin
@@ -177,36 +177,10 @@ module RobustExcelOle
     end
 
     # creates a range from a given defined name or address
-    # range(address) does work for Worksheet objects only
-    # @params [Variant] range name or address
+    # @params [Variant] defined name or address, and optional a worksheet
     # @return [Range] a range
-    def range(name_or_address, address2 = :__not_provided)
-      begin
-        worksheet = self if self.is_a?(Worksheet)
-        if address2 == :__not_provided
-          range = if name_or_address.is_a?(String)
-            begin
-              RobustExcelOle::Range.new(name_object(name_or_address).RefersToRange, worksheet) 
-            rescue NameNotFound
-              nil
-            end
-          end
-        end
-        if self.is_a?(Worksheet) && (range.nil? || (address2 != :__not_provided))
-          address = name_or_address
-          address = [name_or_address,address2] unless address2 == :__not_provided         
-          self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
-          range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange, worksheet)
-          self.Names.Item('__dummy001').Delete
-          workbook = self.is_a?(Workbook) ? self : self.workbook
-          workbook.save
-          range                    
-        end
-      rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
-        address2_string = address2.nil? ? "" : ", #{address2.inspect}"
-        raise RangeNotCreated, "cannot create range (#{name_or_address.inspect}#{address2_string})"
-      end      
-      range
+    def range(*args)
+      raise RangeNotCreated, "not yet implemented"
     end
 
     def name2range(name)   # :deprecated: #

data/lib/robust_excel_ole/vba_objects.rbs

@@ -0,0 +1,23 @@
+
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  class VbaObjects < Base
+
+    def to_reo -> VbaObjects
+
+    def address_tool -> AddressTool
+
+  end
+
+  class RangeNotEvaluatable < MiscREOError         
+  end
+
+  class OptionInvalid < MiscREOError               
+  end
+
+  class ObjectNotAlive < MiscREOError              
+  end
+
+end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.20"
+  VERSION = "1.23"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -823,11 +823,12 @@ module RobustExcelOle
         opts = sheet
         sheet = nil
       end
-      new_sheet_name = opts.delete(:as)
-      last_sheet_local = last_sheet
-      after_or_before, base_sheet = opts.to_a.first || [:after, last_sheet_local]
-      base_sheet_ole = base_sheet.ole_worksheet
       begin
+        sheet = sheet.to_reo unless sheet.nil?
+        new_sheet_name = opts.delete(:as)
+        last_sheet_local = last_sheet
+        after_or_before, base_sheet = opts.to_a.first || [:after, last_sheet_local]
+        base_sheet_ole = base_sheet.to_reo.ole_worksheet
         if !::COPYSHEETS_JRUBY_BUG          
           add_or_copy_sheet_simple(sheet, { after_or_before.to_s => base_sheet_ole })
         else
@@ -843,7 +844,7 @@ module RobustExcelOle
             end
           end
         end
-      rescue WIN32OLERuntimeError, NameNotFound, Java::OrgRacobCom::ComFailException
+      rescue # WIN32OLERuntimeError, NameNotFound, Java::OrgRacobCom::ComFailException
         raise WorksheetREOError, "could not add given worksheet #{sheet.inspect}"
       end
       new_sheet = worksheet_class.new(ole_workbook.Activesheet)
@@ -881,6 +882,24 @@ module RobustExcelOle
       worksheet_class.new(@ole_workbook.Worksheets.Item(1))
     end
 
+    # creates a range from a given defined name or from a given worksheet and address
+    # @params [Variant] defined name or a worksheet
+    # @params [Address] address
+    # @return [Range] a range
+    def range(name_or_worksheet, name_or_address = :__not_provided, address2 = :__not_provided)
+      if name_or_worksheet.respond_to?(:gsub)
+        name = name_or_worksheet
+        RobustExcelOle::Range.new(name_object(name).RefersToRange)
+      else 
+        begin 
+          worksheet = name_or_worksheet.to_reo
+          worksheet.range(name_or_address, address2)
+        rescue
+          raise RangeNotCreated, "argument error: a defined name or a worksheet and an address must be provided"
+        end          
+      end
+    end
+
     # returns the value of a range
     # @param [String] name the name of a range
     # @returns [Variant] the value of the range
@@ -892,7 +911,7 @@ module RobustExcelOle
     # @param [String]  name  the name of the range
     # @param [Variant] value the contents of the range
     def []= (name, value)
-      set_namevalue_glob(name, value, :color => 42)   
+      set_namevalue_glob(name, value)   
     end
 
     # sets options
@@ -921,7 +940,7 @@ module RobustExcelOle
 
     # returns the full file name of the workbook
     def filename
-      @ole_workbook.Fullname.tr('\\','/') rescue nil
+      General.canonize(@ole_workbook.Fullname.tr('\\','/')) rescue nil
     end
 
     # @private
@@ -1004,7 +1023,7 @@ module RobustExcelOle
 
     # @private
     def inspect    
-      '#<Workbook: ' + ('not alive ' unless alive?).to_s + (File.basename(self.filename) if alive?).to_s + " #{@ole_workbook} #{@excel}" + '>'
+      '#<Workbook: ' + ('not alive ' unless alive?).to_s + (File.basename(self.filename) if alive?).to_s + " #{@excel}" + '>'
     end
 
     # @private

data/lib/robust_excel_ole/worksheet.rb

@@ -14,6 +14,8 @@ module RobustExcelOle
     attr_reader :ole_worksheet
     attr_reader :workbook
 
+    alias ole_object ole_worksheet
+
     def initialize(win32_worksheet)
       @ole_worksheet = win32_worksheet
       if @ole_worksheet.ProtectContents
@@ -62,7 +64,7 @@ module RobustExcelOle
       end
     end
 
-    # a cell given the defined name or row and column
+    # returns a cell given the defined name or row and column
     # @params row, column, or name
     # @returns cell, if row and column are given
     def [] p1, p2 = :__not_provided
@@ -94,7 +96,7 @@ module RobustExcelOle
       else
         name, value = p1, p2
         begin
-          set_namevalue_glob(name, value, :color => 42)
+          set_namevalue_glob(name, value)
         rescue REOError
           begin
             workbook.set_namevalue_glob(name, value)
@@ -116,19 +118,6 @@ module RobustExcelOle
       end
     end
 
-=begin
-    def cellval(x,y)
-      xy = "#{x}_#{y}"
-      @cells = { }
-      begin
-        @cells[xy] ||= RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
-        @cells[xy].Value
-      rescue
-        raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
-      end
-    end
-=end
-
     # sets the value of a cell, if row, column and color of the cell are given
     # @params [Integer] x,y row and column
     # @option opts [Symbol] :color the color of the cell when set
@@ -224,6 +213,41 @@ module RobustExcelOle
         self.Name == other_worksheet.Name
     end
 
+    # creates a range from a given defined name or address
+    # @params [Variant] defined name or address
+    # @return [Range] a range
+    def range(name_or_address, address2 = :__not_provided)
+      if name_or_address.respond_to?(:gsub) && address2 == :__not_provided
+        name = name_or_address
+        range = RobustExcelOle::Range.new(name_object(name).RefersToRange, self) rescue nil
+      end
+      unless range
+        address = name_or_address
+        address = [name_or_address,address2] unless address2 == :__not_provided         
+        workbook.retain_saved do
+          begin
+            self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
+            range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange, self)
+            self.Names.Item('__dummy001').Delete
+          rescue
+            address2_string = address2.nil? ? "" : ", #{address2.inspect}"
+            raise RangeNotCreated, "cannot create range (#{name_or_address.inspect}#{address2_string})"
+          end
+        end
+      end
+      range
+    end
+
+    # @private
+    # returns true, if the worksheet object responds to VBA methods, false otherwise
+    def alive?
+      @ole_worksheet.UsedRange
+      true
+    rescue
+      # trace $!.message
+      false
+    end
+
     # @private
     def self.workbook_class  
       @workbook_class ||= begin
@@ -246,9 +270,11 @@ module RobustExcelOle
 
     # @private
     def inspect  
-      self.to_s
+      to_s
     end
 
+    include MethodHelpers
+
   private
 
     def method_missing(name, *args)

data/reo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+ruby lib/reo_console.rb

data/robust_excel_ole.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_runtime_dependency "pry", '>= 0.12.1'
+  s.add_runtime_dependency "pry-bond", '>=0.01'
   s.add_development_dependency "rspec", '>= 2.6.0'
   s.required_ruby_version = '>= 2.1'
 end

data/spec/general_spec.rb

@@ -52,7 +52,7 @@ module RobustExcelOle
         ole_table = worksheet.ListObjects.Item(1)
         table = Table.new(ole_table)
         table.Name.should == "table3"
-        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Price"]
         table.ListRows.Count.should == 6
         worksheet[3,4].Value.should == "Number"
       end
@@ -151,13 +151,11 @@ module RobustExcelOle
       end
 
       it "should do methods for sheet" do
-        # ((@ole_sheet_methods + @sheet_methods) - @book1.sheet(1).methods).should be_empty
-        (Object.instance_methods.select{|m| m =~ /^(?!\_)/}  - @book1.sheet(1).methods).sort.should be_empty       
+        ((@ole_sheet_methods + @sheet_methods) - @book1.sheet(1).methods).should be_empty
       end
 
       it "should do own_methods with popular ole_excel and excel methods" do
-        # ((@ole_sheet_methods + @sheet_methods) - @book1.sheet(1).own_methods).should == [] #be_empty
-         (Object.instance_methods - @book1.sheet(1).own_methods).should == Object.instance_methods
+        ((@ole_sheet_methods + @sheet_methods) - @book1.sheet(1).own_methods).should == [] #be_empty
       end
 
       it "should respond to popular sheet methods" do
@@ -223,10 +221,12 @@ module RobustExcelOle
           canonize("this../.i.s/.../..the/..../pa.th/").should == "this../.i.s/.../..the/..../pa.th"
         end
 
+=begin
         it "should downcase" do
           canonize("/This/IS/tHe/path").should == "/this/is/the/path"
           canonize("///THIS/.///./////iS//the/../PatH/////").should == "/this/is/path"
         end
+=end
 
         it "should raise an error for no strings" do
           expect{
@@ -234,14 +234,13 @@ module RobustExcelOle
           }.to raise_error(TypeREOError, "No string given to canonize, but 1")
         end
 
-        it "should yield the hostname share path" do
-          General.canonize(@network_path).should == normalize(@hostname_share_path).downcase
-          General.canonize(@hostname_share_path).should == normalize(@hostname_share_path).downcase
-          General.canonize(@simple_file).should == normalize(@simple_file).downcase
-          General.canonize(@simple_file_extern).should == normalize(@simple_file_extern).downcase
+        it "should yield the network path" do
+          General.canonize(@hostname_share_path).should == @network_path
+          General.canonize(@network_path).should == @network_path
+          General.canonize(@simple_file).should == @simple_file
+          General.canonize(@simple_file_extern).should == @simple_file_extern
         end
 
-
       end
     end
 

data/spec/list_object_spec.rb

@@ -41,6 +41,13 @@ describe ListObject do
         @sheet[1,1].Value.should == "Person"
       end
 
+      it "should do the idempotence" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(ole_table)
+        table2 = Table.new(table)
+        table2.ole_table.should be_a WIN32OLE
+      end
+
       it "should type-lift a Win32ole list object into a RobustExcelOle list object" do
         ole_table = @sheet.ListObjects.Item(1)
         table = Table.new(ole_table)
@@ -103,19 +110,25 @@ describe ListObject do
     context "with new table" do
 
       before do
-        @table = Table.new(@sheet, "table_name", [1,1], 3, ["Person","Amount"])
+        @table = Table.new(@sheet, "table_name", [1,1], 3, ["Person","Amo%untSales"])
         @table_row1 = @table[1]
       end
 
-      it "should set and read values" do
+      it "should read and set values via alternative column names" do
         @table_row1.person.should be nil
         @table_row1.person = "John"
         @table_row1.person.should == "John"
         @sheet[2,1].Value.should == "John"
-        @table_row1.amount.should be nil
-        @table_row1.amount = 42
-        @table_row1.amount.should == 42
+        @table_row1.amount_sales.should be nil
+        @table_row1.amount_sales = 42
+        @table_row1.amount_sales.should == 42
         @sheet[2,2].Value.should == 42
+        @table_row1.Person = "Herbert"
+        @table_row1.Person.should == "Herbert"
+        @sheet[2,1].Value.should == "Herbert"
+        @table_row1.AmountSales = 80
+        @table_row1.AmountSales.should == 80
+        @sheet[2,2].Value.should == 80
       end
 
     end

data/spec/range_spec.rb

@@ -177,9 +177,9 @@ describe RobustExcelOle::Range do
     end
   end
 
-  describe "#v" do
+  describe "#value" do
 
-    context "v, v=" do
+    context "value, value=" do
 
       before do
         @sheet1 = @book.sheet(1)
@@ -207,6 +207,12 @@ describe RobustExcelOle::Range do
         @sheet1.range([1..2,3..5]).v = [[1,2,3],[4,5,6]]
         @sheet1.range([1..2,3..5]).v.should == [[1,2,3],[4,5,6]]
       end
+
+      it "should color the range" do
+        @sheet1.range([1..2,3..5]).set_value([[1,2,3],[4,5,6]],:color => 42)
+        @sheet1.range([1..2,3..5]).Interior.ColorIndex.should == 42
+      end
+
     end
   end
 

data/spec/workbook_specs/workbook_misc_spec.rb

@@ -763,7 +763,7 @@ describe Workbook do
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1["new"].should == "bar"
       @book1["new"] = "bar"
-      @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 42
+      @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1.save
       @book1.close
       #book2 = Workbook.open(@simple_file1, :visible =>  true)
@@ -777,7 +777,7 @@ describe Workbook do
       @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1["new"].should == "bar"
       @book1["new"] = "bar"
-      @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 42
+      @book1.Names.Item("new").RefersToRange.Interior.ColorIndex.should == 4
       @book1.save
       @book1.close
     end
@@ -1096,6 +1096,16 @@ describe Workbook do
         range.Address.should == "$A$1:$D$3"
       end
 
+      it "should raise error when given integer range" do
+        expect{
+          @book1.range([1..2,3..4])
+        }.to raise_error(RangeNotCreated, /argument/)
+      end
+
+      it "should accept an integer range when given a worksheet" do
+        @book1.range(@book1.sheet(1),[4..5,1..2]).Address.should == "$A$4:$B$5"
+      end
+
     end
 
     context "adding and deleting the name of a range" do

data/spec/worksheet_spec.rb

@@ -19,6 +19,7 @@ describe Worksheet do
   before do
     @dir = create_tmpdir
     @simple_file = @dir + '/workbook.xls'
+    @another_workbook = @dir + '/another_workbook.xls'
     @protected_file = @dir + '/protected_sheet.xls'
     @blank_file = @dir + '/book_with_blank.xls'
     @merge_file = @dir + '/merge_cells.xls'
@@ -207,11 +208,13 @@ describe Worksheet do
     describe "range" do
 
       it "should a range with relative r1c1-reference" do
+        @sheet.range([1,1]).Select
         @sheet.range(["Z1S[3]:Z[2]S8"]).Address.should == "$D$1:$H$3"
         @sheet.range(["Z1S3:Z2S8"]).Address.should == "$C$1:$H$2"
       end
 
       it "should a range with relative integer-range-reference" do
+        @sheet.range([1,1]).Select
         @sheet.range([1..[2],[3]..8]).Address.should == "$D$1:$H$3"
       end