robust_excel_ole 1.32 → 1.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f56e6aaeeeec6c073cc4f871ea99185428523959c420e1165d199792979074c5
-  data.tar.gz: 79dd7f6ea160e0045592a3dd8ae31a5b8a162c71b6986dcbcef157eba54c93b4
+  metadata.gz: c1c1d70d522034dc16bc609e2578e02b556396051ec7fdd14e2f11bd5aea85cd
+  data.tar.gz: e14ac932aae718dd25d3a3ddc9ab487d63dc934c6e1d136a1adb069b0c57c81e
 SHA512:
-  metadata.gz: 894959ff3e8c48c8413bbb137013cf8ad7612bb991292f1461b1df9b3371d15c16132ecf0df0dbf78403171381064cfb43d9400604bc2155214f8aa2a514ea7c
-  data.tar.gz: 508b37f27ef7c0e554b565f21263386e1b180cb5269f6a843b2da927eaa3f6eebe5a111a362d5dc96de4726a1c3648673b062b02589739eb7e5ff2a0bb7f59cc
+  metadata.gz: 77e8abbfee1226d86e58d75aa4e1625b3a7d385333974c4cb9e854527d1c6e2cfdcb827a55749343e34dfae0867bc843ac609ebb1541f71960dd08ffbdf7d1fd
+  data.tar.gz: f3b02fa7307c8d7031fdf65d246d3e22a800d39f476a24f227abba0dc2eb058b119dc29c249285392013a8d0de73735c176030d39fd8f97f7ea9150b7a8d0b61

data/Changelog

@@ -1,6 +1,8 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.33] 2021-01-06
+
 ## [1.32] 2021-23-04
 
 ### Added

data/README.rdoc

@@ -19,11 +19,6 @@ This returns the range of cell with address 1,1.
 
 With this new interface, we want to be compatible with the standard syntax of other known Excel libraries, e.g. +spreadsheet+ or +axlsx+.
 
-== Using own WIN32OLE objects
-
-If you use WIN32OLE objects and define your own methods, please use upper-case method names. 
-The reason is that we extend the class WIN32OLE such that RobustExcelOle methods can be applied to WIN32OLE objects, such the RobustExcelOle objects and their wrapped WIN32OLE objects are interchangeable. We want to develop a refinement such that the name space is not being desturbed.
-
 = RobustExcelOle
 
 RobustExcelOle helps controlling Excel. 

data/lib/robust_excel_ole/address_tool.rb

@@ -10,26 +10,27 @@ module RobustExcelOle
       @col_letter = r1c1_letters[1..1]
     end
 
-    # address formats that are valid:
+    # valid address formats are:
     #   r1c1-format: e.g. "Z3S1", "Z3S1:Z5S2", "Z[3]S1", "Z3S[-1]:Z[5]S1", "Z[3]", "S[-2]"
     #                      infinite ranges are not possible, e.g. "Z3:Z5", "S2:S5", "Z2", "S3", "Z[2]" 
-    #   integer_ranges-fromat: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 
+    #   integer_ranges-fromat: e.g. [3,1], [3,"A"], [3..5,1..2], [1..[2],[3]..8], [3..5, "A".."B"], 
     #                               [3..4, nil], [nil, 2..4], [2,nil], [nil,4]
     #   a1-format: e.g. "A3", "A3:B5", "A:B", "3:5", "A", "3"
+    
+
     def as_r1c1(address)
       transform_address(address, :r1c1)
     end
 
+    # transformation from integer-range or r1c1.format to a1-format not implemented
     def as_a1(address)
       transform_address(address, :a1)
     end
 
-    # valid address formats: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 
-    #                             [3..4, nil], [nil, 2..4], [2,nil], [nil,4]
     def as_integer_ranges(address)
       transform_address(address, :int_range)
     end
-   
+
   private
 
     def transform_address(address, format)

data/lib/robust_excel_ole/general.rb

@@ -278,30 +278,48 @@ module General
      [RobustExcelOle::ListRow   , 'ListRow'    , [:Creator, :no_method => :Row]]]
   end
 
+  WIN32OLE_INSTANCE_METHODS = [
+    :ole_methods, :ole_free, :ole_get_methods, :ole_put_methods, :ole_func_methods, :ole_method, :ole_method_help,
+    :ole_activex_initialize, :ole_type, :ole_obj_help, :ole_typelib, :ole_query_interface, :ole_respond_to?, 
+    :invoke, :_invoke, :_getproperty, :_setproperty, :setproperty, :[], :[]=, :methods, :method_missing, :each
+  ]
+
   # @private
   # enable RobustExcelOle methods to Win32Ole objects
   def init_reo_for_win32ole
+    method_occurrences = {}
     main_classes_ole_types_and_recognising_methods.each do |classname, _ole_type, _recognising_method|
-      meths = (classname.instance_methods(false) - WIN32OLE.instance_methods(false) - Object.methods - Enumerable.instance_methods(false) - [:Calculation=])
+      meths = (classname.instance_methods(false) - WIN32OLE_INSTANCE_METHODS - Object.methods - Enumerable.instance_methods(false) - [:Calculation=])
       meths.each do |inst_method|
-        if classname.method_defined?(inst_method)
-          WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
-            begin 
-              obj = to_reo                        
-            rescue
-              return self.send(inst_method.capitalize, *args, &blk)
-            end
-            obj.send(inst_method, *args, &blk)
+        method_occurrences[inst_method] = method_occurrences[inst_method] ? :several_classes : classname
+      end
+    end
+    method_occurrences.each do |inst_method, class_name|
+      if WIN32OLE.method_defined?(inst_method)
+        aliased_method = "#{inst_method}_after_reo".to_s.to_sym
+        WIN32OLE.send(:alias_method, aliased_method, inst_method)
+      else
+        aliased_method = nil
+      end
+      if aliased_method || class_name == :several_classes
+        WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
+          begin 
+            obj = to_reo                        
+          rescue     
+            sending_method = aliased_method ? aliased_method : inst_method.capitalize
+            return self.send(sending_method, *args, &blk)
           end
-        else
-          WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
-            begin 
-              obj = classname.constantize.new(self)       
-            rescue
-              return self.send(inst_method.capitalize, *args, &blk)
-            end
-            obj.send(inst_method, *args, &blk) 
+          obj.send(inst_method, *args, &blk)
+        end
+      else       
+        WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
+          begin 
+            obj = class_name.new(self)     
+          rescue
+             sending_method = aliased_method ? aliased_method : inst_method.capitalize
+            return self.send(sending_method, *args, &blk)
           end
+          obj.send(inst_method, *args, &blk) 
         end
       end
     end

data/lib/robust_excel_ole/list_object.rb

@@ -349,8 +349,8 @@ module RobustExcelOle
 
     def == other_table
       other_table.is_a?(ListObject) && 
-      self.HeaderRowRange.Value == other_table.HeaderRowRange.Value &&
-      self.DataBodyRange.Value == other_table.DataBodyRange.Value
+        self.Range.Address == other_table.Range.Address &&
+        self.Parent.to_reo == other_table.Parent.to_reo
     end
 
 

data/lib/robust_excel_ole/list_row.rb

@@ -11,10 +11,15 @@ module RobustExcelOle
     alias ole_object ole_tablerow
 
     def initialize(rownumber_or_oletablerow)
-      @ole_tablerow = if !rownumber_or_oletablerow.respond_to?(:succ)
-        rownumber_or_oletablerow       
+      @ole_tablerow = if rownumber_or_oletablerow.is_a?(ListRow)
+        rownumber_or_oletablerow.ole_tablerow
       else
-        ole_table.ListRows.Item(rownumber_or_oletablerow)
+        begin
+          rownumber_or_oletablerow.Parent.send(:ListRows)
+          rownumber_or_oletablerow
+        rescue
+          ole_table.ListRows.Item(rownumber_or_oletablerow)
+        end
       end
     end
 

data/lib/robust_excel_ole/range.rb

@@ -19,7 +19,12 @@ module RobustExcelOle
     using ToReoRefinement
 
     def initialize(win32_range, worksheet = nil)
-      @ole_range = win32_range
+      @ole_range = begin
+        win32_range.send(:Areas)
+        win32_range
+      rescue
+        raise TypeREOError, "given win32ole object is not a range"
+      end
       @worksheet = (worksheet ? worksheet : self.Parent).to_reo
     end
 

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.32"
+  VERSION = "1.33"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -93,7 +93,12 @@ module RobustExcelOle
       when NilClass
         raise FileNameNotGiven, "filename is nil"
       when WIN32OLE
-        file = file_or_workbook.Fullname.tr('\\','/') 
+        begin
+          file_or_workbook.send(:LinkSources)
+          file = file_or_workbook.Fullname.tr('\\','/')
+        rescue
+          raise TypeREOError, "given win32ol object is not a workbook"
+        end
       when Workbook
         file = file_or_workbook.Fullname.tr('\\','/')
       when String

data/lib/robust_excel_ole/worksheet.rb

@@ -104,9 +104,17 @@ module RobustExcelOle
         address = normalize_address(name_or_address, address2)
         workbook.retain_saved do
           begin
-            self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
-            range = get_name_object('__dummy001').RefersToRange
-            self.Names.Item('__dummy001').Delete
+            a1_address = address_tool.as_a1(address) rescue nil
+            if a1_address
+              range = self.Range(a1_address)              
+            else
+              begin
+                self.Names.Add('__dummy_name_object_001__',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))
+                range = get_name_object('__dummy_name_object_001__').RefersToRange
+              ensure
+                self.Names.Item('__dummy_name_object_001__').Delete
+              end
+            end
           rescue
             address2_string = (address2.nil? || address2 == :__not_provided) ? "" : ", #{address2.inspect}"
             raise RangeNotCreated, "cannot find name or address #{name_or_address.inspect}#{address2_string})"
@@ -115,7 +123,7 @@ module RobustExcelOle
       end
       range.to_reo
     end
-  
+
   private
 
     def normalize_address(address, address2)

data/spec/bookstore_spec.rb

@@ -55,11 +55,16 @@ describe Bookstore do
     @simple_file_other_path = @dir + '/more_data/workbook.xls'
     @simple_file1 = @simple_file
     @different_file1 = @different_file
-
     @file_path = "spec/data/workbook.xls"
     @absolute_file_path = "C:/gim/ats/aSrc/gems/robust_excel_ole/spec/data/workbook.xls"
     @network_path = "N:/data/workbook.xls"
-    @hostname_share_path = "DESKTOP-A3C5CJ6/spec/data/workbook.xls"
+    network = WIN32OLE.new('WScript.Network')
+    computer_name = network.ComputerName
+    #@hostname_share_path = "DESKTOP-A3C5CJ6/spec/data/workbook.xls"
+    @hostname_share_path = "//#{computer_name}/#{absolute_path('spec/data/workbook.xls').tr('\\','/').gsub('C:','c$')}"
+    @network_path_not_existing = "M:/data/workbook.xls"
+    @hostname_not_existing_share_path = "//DESKTOP_not_existing/spec/data/workbook.xls"
+    @hostname_share_not_existing_path = "//#{computer_name}/c$/gim/ats/aSrc/gems/robust_excel_ole/spec_not_existing/data/workbook.xls"
   end
 
   after do
@@ -135,16 +140,6 @@ describe Bookstore do
 
   describe "fetch" do
 
-    before do
-      @file_path = "spec/data/workbook.xls"
-      @absolute_file_path = "C:/gim/ats/aSrc/gems/robust_excel_ole/spec/data/workbook.xls"
-      @network_path = "N:/data/workbook.xls"
-      @hostname_share_path = "//DESKTOP-A3C5CJ6/spec/data/workbook.xls"
-      @network_path_not_existing = "M:/data/workbook.xls"
-      @hostname_not_existing_share_path = "//DESKTOP_not_existing/spec/data/workbook.xls"
-      @hostname_share_not_existing_path = "//DESKTOP-A3C5CJ6/spec_not_existing/data/workbook.xls"
-    end
-
     context "with stored network and hostname share path" do
 
       it "should fetch to a given network path file the stored hostname_share_path file" do

data/spec/excel_spec.rb

@@ -1925,7 +1925,7 @@ module RobustExcelOle
         excel_instances.first.should == excel
         excel_instances.to_a.should == [excel]
         res = []
-        excel_instances.each.with_index{|e,i| res << [e,i]}
+        excel_instances.each_with_index{|e,i| res << [e,i]}
         res.should == [[excel,0]]
       end
 
@@ -1937,7 +1937,7 @@ module RobustExcelOle
         excel_instances.first.should == excel1
         excel_instances.to_a.should == [excel1, excel2]
         res = []
-        excel_instances.each.with_index{|e,i| res << [e,i]}
+        excel_instances.each_with_index{|e,i| res << [e,i]}
         res.should == [[excel1,0],[excel2,1]]
       end
 

data/spec/general_spec.rb

@@ -1,5 +1,15 @@
 # -*- coding: utf-8 -*-
 
+require 'win32ole'
+
+class WIN32OLE
+  def save
+    "save"
+  end
+end
+
+NETWORK = WIN32OLE.new('WScript.Network')
+
 require_relative 'spec_helper'
 
 $VERBOSE = nil
@@ -34,11 +44,12 @@ module RobustExcelOle
       @simple_file_xlsm = @dir + '/workbook.xls'
       @simple_file_xlsx = @dir + '/workbook.xlsx'
       @network_path = "N:/data/workbook.xls"
-      @hostname_share_path = "//DESKTOP-A3C5CJ6/spec/data/workbook.xls"
-      @network_path_downcase = "n:/data/workbook.xls"
-      @hostname_share_path_downcase = "//desktop-a3c5cj6/spec/data/workbook.xls"
+      computer_name = NETWORK.ComputerName
+      #@hostname_share_path = "//#{computer_name}/spec/data/workbook.xls"
+      @hostname_share_path = "//#{computer_name}/#{absolute_path('spec/data/workbook.xls').tr('\\','/').gsub('C:','c$')}"
+      @network_path_downcase = @network_path.downcase
+      @hostname_share_path_downcase = @hostname_share_path.downcase
       @simple_file_extern = "D:/data/workbook.xls"
-      @hostname_share_path = "//DESKTOP-A3C5CJ6/spec/data/workbook.xls"
     end
 
     after do
@@ -46,6 +57,66 @@ module RobustExcelOle
       rm_tmp(@dir)
     end
 
+    describe "General.init_reo_for_win32ole" do
+
+      before do
+        @book1 = Workbook.open(@simple_file, :visible => true)
+      end
+
+      it "should preserve the instance method of a win32ole object via calling an aliased method" do
+        NETWORK.save.should == "save"
+      end
+
+      it "should preserve the instance methods of a win32ole object " do
+        RobustExcelOle::Excel.define_method(:ComputerName){ "computer" }
+        network = WIN32OLE.new('WScript.Network')
+        computername = network.ComputerName
+        General.init_reo_for_win32ole
+        network.ComputerName.should == computername
+      end
+
+      #it "should preserve the lower-case instance methods of a win32ole object " do
+      #  RobustExcelOle::Excel.define_method(:computername){ "computer" }
+      #  network = WIN32OLE.new('WScript.Network')
+      #  computername = network.computername
+      #  General.init_reo_for_win32ole
+      #  network.computername.should == computername
+      #end
+
+      it "should call a capitalized method for an instance method occurring in one classes" do
+        expect{
+          NETWORK.delete_empty_columns
+        }.to raise_error(NoMethodError, /Delete_empty_columns/)
+      end
+
+
+      it "should call a capitalized method for an instance method occurring in several classes" do
+        expect{
+          NETWORK.focus
+        }.to raise_error(NoMethodError, /Focus/)
+      end
+
+      it "should apply reo-methods to win32ole objects" do
+        ole_book1 = @book1.ole_workbook
+        sheet1 = ole_book1.sheet(1)
+        sheet1.should be_a Worksheet
+        sheet1.name.should == "Sheet1"
+        ole_sheet1 = sheet1.ole_worksheet
+        range1 = ole_sheet1.range([1..2,3..4])
+        range1.should be_a RobustExcelOle::Range
+        range1.value.should == [["sheet1"],["foobaaa"]]
+        ole_range1 = range1.ole_range
+        ole_range1.copy([6,6])
+        range2 = sheet1.range([6..7,6..7])
+        range2.value.should == [["sheet1"],["foobaaa"]]
+        excel1 = @book1.excel
+        ole_excel1 = excel1.ole_excel
+        ole_excel1.close(:if_unsaved => :forget)
+        Excel.kill_all
+      end
+
+    end
+
     describe "find_all_indices" do
 
       it "should find all occurrences" do
@@ -149,41 +220,6 @@ module RobustExcelOle
 
     end
 
-    describe "General.init_reo_for_win32ole" do
-
-      before do
-        @book1 = Workbook.open(@simple_file, :visible => true)
-      end
-
-      it "should not overwrite methods" do
-        RobustExcelOle::Excel.define_method(:ComputerName){ "computer" }
-        network = WIN32OLE.new('WScript.Network')
-        computername = network.ComputerName
-        General.init_reo_for_win32ole
-        network.ComputerName.should == computername
-      end
-
-      it "should apply reo-methods to win32ole objects" do
-        ole_book1 = @book1.ole_workbook
-        sheet1 = ole_book1.sheet(1)
-        sheet1.should be_a Worksheet
-        sheet1.name.should == "Sheet1"
-        ole_sheet1 = sheet1.ole_worksheet
-        range1 = ole_sheet1.range([1..2,3..4])
-        range1.should be_a RobustExcelOle::Range
-        range1.value.should == [["sheet1",nil],["foobaaa",nil]]
-        ole_range1 = range1.ole_range
-        ole_range1.copy([6,6])
-        range2 = sheet1.range([6..7,6..7])
-        range2.value.should == [["sheet1",nil],["foobaaa",nil]]
-        excel1 = @book1.excel
-        ole_excel1 = excel1.ole_excel
-        ole_excel1.close(:if_unsaved => :forget)
-        Excel.kill_all
-      end
-
-    end
-
     describe "methods, own_methods, respond_to?" do
 
       before do

data/spec/list_row_spec.rb

@@ -49,8 +49,10 @@ describe ListRow do
 
      it "should promote a win32ole tablerow" do
       table1 = @sheet.table(1)
-      ole_tablerow = table1[2].ole_tablerow
-      ListRow.new(ole_tablerow).values.should == [2.0, "Fred", nil, 0.5416666666666666, 40]
+      tablerow1 = table1[2]
+      ole_tablerow1 = tablerow1.ole_tablerow
+      ListRow.new(ole_tablerow1).values.should == [2.0, "Fred", nil, 0.5416666666666666, 40]
+      ListRow.new(tablerow1).values.should == [2.0, "Fred", nil, 0.5416666666666666, 40]
     end 
   end
 

data/spec/workbook_specs/workbook_all_spec.rb

@@ -9,6 +9,5 @@ require_relative 'workbook_close_spec'
 require_relative 'workbook_save_spec'
 require_relative 'workbook_misc_spec'
 require_relative 'workbook_sheet_spec'
-require_relative 'workbook
-_unobtr_spec'
+require_relative 'workbook_unobtr_spec'
 require_relative 'workbook_subclass_spec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: '1.32'
+  version: '1.33'
 platform: ruby
 authors:
 - traths
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: win32api
@@ -227,7 +227,7 @@ homepage: https://github.com/Thomas008/robust_excel_ole
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -246,9 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: robust_excel_ole
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: RobustExcelOle automates processing Excel workbooks in Windows by using the
   win32ole library.