robust_excel_ole 1.30 → 1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 468109a0884d48ed77c70d9681d0067453aadfbd7294c6b152fb6457141bb98d
-  data.tar.gz: 2527cdd343eefb7325c077204203e1893d8e32f00830a8a6591669aba7ad43ec
+  metadata.gz: 304ee26bf15359eec5e54ac846203b60f3d7419e54779ced816182f76f6e9b46
+  data.tar.gz: 0ea8a4d763d10b286cd29610261b815ca51308cb364483935c5c396fa31e2c67
 SHA512:
-  metadata.gz: 5637d87926eef9515335fb075add5cf4810cf97229c762f2b182fbdad42cae99f128c6a2ee253acbf29362c49005d579944e283e875aff4785df5220a6f0bff6
-  data.tar.gz: 59f015190d12c0a0b3c7e8016e6dd81da74ae5b760e166d0044a5b04dab5d0fb0b8fa295d13f66a30861a71867c921c2352119957b0543caeb467ecd881b3223
+  metadata.gz: ae94a7357c87e0069e15e279a0eb420df939840192fc2e674f8e3c1890bebdaa7c49d37e0d8a888939f8009109fc7fabf0105e7b76f6b75f168431cb58d2e0e1
+  data.tar.gz: 450ebbad0840bd557c652cc2fa9027dee4a45114a6d3b8ea0065fd5120e9b916ad26ad63a1f97088bb148f1dc07cff7fd9cdf8c9b956e6a0ee2295be4434dec2

data/Changelog

@@ -1,6 +1,11 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.31] 2021-14-01
+
+### Added
+  - Worksheet#table
+
 ## [1.30] 2020-18-11
 
 ## [1.29] 2020-05-11

data/README.rdoc

@@ -335,11 +335,13 @@ or
 However, this command also starts another pry repl (with another binding). Moreover, local variables in the previous binding are forgotten.
 
 
-2. The class Win32Ole is being extended such that RobustExcelOle methods can be applied to Win32Ole objects. As mentioned above, the RobustExcelOle objects are wrapper of corresponding WIN32OLE objects. With help of +update_to_reo+ the RobustExcelOle objects and their wrapped Win32Ole objects are interchangeable. One example would be
+2. The class Win32Ole is being extended such that RobustExcelOle methods can be applied to Win32Ole objects. As mentioned above, the RobustExcelOle objects are wrapper of corresponding WIN32OLE objects. So the RobustExcelOle objects and their wrapped Win32Ole objects are interchangeable. One example would be
 
   range.ole_range.copy([4,3])
 
-Likewise it is possible to convert ("type-lift") Win32Ole objects into the corresponding RobustExcelOle object, using General.to_reo.
+Likewise it is possible to convert ("type-lift") Win32Ole objects into the corresponding RobustExcelOle object, using the method +to_reo+. It is a refinement of the class WIN32OLE. So you can write
+
+  using ToReoRefinement
 
   range = sheet.Names.Item("firstcell").to_reo
 

data/benchmarking/reo_example.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+require_relative '../lib/robust_excel_ole'
 
 start_time = Time.now 
 

data/benchmarking/reo_example1.rb

@@ -1,5 +1,5 @@
 #require 'robust_excel_ole'
-require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+require_relative '../lib/robust_excel_ole'
 
 start_time = Time.now 
 

data/benchmarking/reo_example2.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+require_relative '../lib/robust_excel_ole'
 
 start_time = Time.now 
 

data/docs/README_sheet.rdoc

@@ -92,17 +92,11 @@ The methods Worksheet#each, Worksheet#each_row and Worksheet#each_column enable
     # do something with column
   end
 
-The method Worksheet#values yields all cell values of the used range of the worksheet into a 2-dimensional array. For example:
+The method Worksheet#values yields a 2-dimensional array that contains the values in each row, e.g.
 
   worksheet.values
   => [["foo", "workbook", "sheet1"], ["foo", nil, "foobaaa"], ["matz", "is", "nice"]]
 
-The method Worksheet#each_rowvalue enables to access the values of each row.
-
-  worksheet.each_rowvalue do |row_values|
-    # do something with the row_values
-  end
-
 You access a range of a row by giving the number of the row, and optionally, the range of the cell numbers.
 
   worksheet.row_range(1)  # => first row

data/examples/introductory_examples/example_open.rb

@@ -18,7 +18,18 @@ puts "open a workbook"
 book = Workbook.open(simple_file) 
 puts "make it visible"
 book.visible = true
+
+ole_workbook = book.ole_workbook
+puts "ole_workbook: #{ole_workbook}"
+sheet = ole_workbook.sheet(1)
+puts "sheet: #{sheet}"
+
+using ToReoRefinement
 puts "book: #{book}"
+ole_workbook = book.ole_workbook
+puts "ole_workbook: #{ole_workbook.inspect}"
+upliftet_ole_workbook = ole_workbook.to_reo
+puts "upliftet_ole_workbook: #{upliftet_ole_workbook.inspect}"
 # open a workbook in a new Excel instance
 puts "open the workbook in a new Excel instance and make it visible"
 book2 = Workbook.open(another_simple_file, :default => {:excel => :new}, :visible => true)

data/lib/robust_excel_ole.rb

@@ -1,21 +1,25 @@
+# -*- coding: utf-8 -*-
+
 if RUBY_PLATFORM =~ /java/
   require 'jruby-win32ole'
 else
   require 'win32ole'
 end
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/general')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/base')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/vba_objects')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/range_owners')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/address_tool')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/bookstore')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/workbook')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/worksheet')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/cell')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/range')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/list_object')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/cygwin') if RUBY_PLATFORM =~ /cygwin/
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/version')
+
+require_relative 'robust_excel_ole/general'
+require_relative 'robust_excel_ole/base'
+require_relative 'robust_excel_ole/vba_objects'
+require_relative 'robust_excel_ole/range_owners'
+require_relative 'robust_excel_ole/address_tool'
+require_relative 'robust_excel_ole/excel'
+require_relative 'robust_excel_ole/bookstore'
+require_relative 'robust_excel_ole/workbook'
+require_relative 'robust_excel_ole/worksheet'
+require_relative 'robust_excel_ole/cell'
+require_relative 'robust_excel_ole/range'
+require_relative 'robust_excel_ole/list_row'
+require_relative 'robust_excel_ole/list_object'
+require_relative 'robust_excel_ole/cygwin' if RUBY_PLATFORM =~ /cygwin/
+require_relative 'robust_excel_ole/version'
 
 General.init_reo_for_win32ole

data/lib/robust_excel_ole/cell.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './range')
+require_relative 'range'
 
 module RobustExcelOle
 

data/lib/robust_excel_ole/cygwin.rb

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 module RobustExcelOle
   module Cygwin
     require 'Win32API'

data/lib/robust_excel_ole/general.rb

@@ -2,6 +2,7 @@
 require 'pathname'
 
 # @private
+#class WIN32OLE
 module ToReoRefinement
 
   refine WIN32OLE do
@@ -61,7 +62,7 @@ end
 module StringRefinement
 
   refine String do
-   
+
     def / path_part
       if empty?
         path_part
@@ -70,7 +71,8 @@ module StringRefinement
           self
         else
           begin
-            File.join self, path_part
+            path_part = path_part.strip
+            (path_part  =~ /^(\/|([A-Z]:\/))/i) ? path_part : (self.chomp('/') + '/' + path_part)
           rescue TypeError
             raise TypeError, "Only strings can be parts of paths (given: #{path_part.inspect} of class #{path_part.class})"
           end
@@ -78,6 +80,17 @@ module StringRefinement
       end
     end
 
+    def replace_umlauts
+      word = self.force_encoding('iso-8859-1').encode('utf-8')
+      #word = self.encode("UTF-8")
+      #word = self.encode("UTF-8", "Windows-1252")    
+      word.gsub('ä','ae').gsub('Ä','Ae').gsub('ö','oe').gsub('Ö','Oe').gsub('ü','ue').gsub('Ü','Ue')
+      word.gsub('ß','ss').gsub('²','2').gsub('³','3')      
+      #word.gsub("\x84",'ae').gsub("\x8E",'Ae').gsub("\x94",'oe').gsub("\x99",'Oe').gsub("\x81",'ue').gsub("\x9A",'Ue')
+      #word.gsub("\xE1",'ss').gsub("\xFD",'2').gsub("\xFC",'3')
+      word
+    end
+
     # taken from http://apidock.com/rails/ActiveSupport/Inflector/underscore
     def underscore
       word = gsub('::', '/')
@@ -88,31 +101,6 @@ module StringRefinement
       word
     end
 
-    def delete_multiple_underscores
-      word = self
-      while word.index('__') do
-        word.gsub!('__','_')
-      end    
-      word
-    end
-
-    def replace_umlauts
-      word = self
-      word.gsub!('ä','ae')
-      word.gsub!('Ä','Ae')
-      word.gsub!('ö','oe')
-      word.gsub!('Ö','Oe')
-      word.gsub!('ü','ue')
-      word.gsub!('Ü','Ue')
-      #word.gsub!(/\x84/,'ae')
-      #word.gsub!(/\x8E/,'Ae')
-      #word.gsub!(/\x94/,'oe')
-      #word.gsub!(/\x99/,'Oe')
-      #word.gsub!(/\x81/,'ue')
-      #word.gsub!(/\x9A/,'Ue')
-      word
-    end
-
     # taken from http://apidock.com/rails/ActiveSupport/Inflector/constantize
     # File activesupport/lib/active_support/inflector/methods.rb, line 226
     def constantize # (camel_cased_word)
@@ -202,42 +190,10 @@ class Array
 end
 
 
-=begin
-# @private
-module SpaceshipRefinement
-
-  refine Integer do
-
-    alias old_spaceship <=>
-
-    def <=> other
-      # p other
-      if other.is_a? Array
-        self <=> other.first
-      else
-        old_spaceship other
-      end
-    end
-  end
-
-  refine Array do
-
-    alias old_spaceship <=>
-
-    def <=> other
-      # p other
-      if other.is_a? Integer
-        self <=> [other]
-      else
-        old_spaceship other
-      end
-    end
-  end
-end
-=end
-
 module General
 
+  using ToReoRefinement
+
   IS_JRUBY_PLATFORM = (RUBY_PLATFORM =~ /java/)
   ::EXPANDPATH_JRUBY_BUG    = IS_JRUBY_PLATFORM && true
   ::CONNECT_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
@@ -249,7 +205,9 @@ module General
   # @private
   NetworkDrive = Struct.new(:drive_letter, :network_name) do
 
-    def self.get_all(drives)
+    def self.get_all_drives
+      network = WIN32OLE.new('WScript.Network')
+      drives = network.enumnetworkdrives
       ndrives = []
       count = drives.Count
       (0..(count - 1)).step(2) do |i|
@@ -257,21 +215,14 @@ module General
       end
       ndrives
     end
-
   end
 
   # @private
   def hostnameshare2networkpath(filename)
     return filename unless filename[0,2] == "//"
-    network = WIN32OLE.new('WScript.Network')
-    drives = network.enumnetworkdrives
-    network_drives = NetworkDrive.get_all(drives)
-    f_c = filename.dup
-    network_drive = network_drives.find do |d| 
-      e = f_c.sub!(d.network_name,d.drive_letter)
-      return e if e
+    NetworkDrive.get_all_drives.inject(filename) do |fn_modified, d| 
+      fn_modified.sub(/#{(Regexp.escape(d.network_name))}/i,d.drive_letter)
     end    
-    filename 
   end  
 
   # @private
@@ -301,10 +252,12 @@ module General
     path
   end
 
+  # @private
   def change_current_binding(current_object)
     Pry.change_current_binding(current_object)
   end
 
+  # @private
   def class2method
     [{RobustExcelOle::Excel => :Hwnd},
      {RobustExcelOle::Workbook => :FullName},
@@ -313,18 +266,15 @@ module General
      {RobustExcelOle::ListObject => :ListRows}]
   end
 
-  using ToReoRefinement
-
+  # @private
   # enable RobustExcelOle methods to Win32Ole objects
   def init_reo_for_win32ole
-    exclude_list = [:each, :each_with_index, :inspect, :Calculation=]
     class2method.each do |element|
       classname = element.first.first
-      classname.instance_methods(false).each do |inst_method|
-        if !exclude_list.include?(inst_method)
-          WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
-            self.to_reo.send(inst_method, *args, &blk) 
-          end
+      meths = (classname.instance_methods(false) - WIN32OLE.instance_methods(false) - Object.methods - Enumerable.instance_methods(false) - [:Calculation=])
+      meths.each do |inst_method|
+        WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
+          self.to_reo.send(inst_method, *args, &blk) 
         end
       end
     end
@@ -332,7 +282,7 @@ module General
   end
 
   module_function :absolute_path, :canonize, :normalize, :change_current_binding, :class2method, 
-                  :init_reo_for_win32ole, :hostnameshare2networkpath
+                  :init_reo_for_win32ole, :hostnameshare2networkpath, :test
 
 end
 

data/lib/robust_excel_ole/list_object.rb

@@ -2,9 +2,9 @@
 
 module RobustExcelOle
 
-  class ListRow
-  end
-
+  using ToReoRefinement
+  using FindAllIndicesRefinement
+ 
   # This class essentially wraps a Win32Ole ListObject. 
   # You can apply all VBA methods (starting with a capital letter) 
   # that you would apply for a ListObject. 
@@ -16,10 +16,6 @@ module RobustExcelOle
 
     alias ole_object ole_table
 
-    using FindAllIndicesRefinement
-    using StringRefinement
-    using ToReoRefinement
-   
     # constructs a list object (or table).
     # @param [Variable] worksheet_or_listobject      a worksheet or a list object
     # @param [Variable] table_name_or_number         a table name or table number
@@ -63,121 +59,25 @@ module RobustExcelOle
         end
       end
 
-
       ole_table = @ole_table
+
       @row_class = Class.new(ListRow) do
 
         @@ole_table = ole_table
 
-        def initialize(row_number)
-          @ole_listrow = @@ole_table.ListRows.Item(row_number)
-        end
-
-        # returns the value of the cell with given column name or number
-        # @param [Variant]  column number or column name
-        # @return [Variant] value of the cell 
-        def [] column_number_or_name
-          begin
-            ole_cell = @@ole_table.Application.Intersect(
-              @ole_listrow.Range, @@ole_table.ListColumns.Item(column_number_or_name).Range)
-            ole_cell.Value
-          rescue WIN32OLERuntimeError
-            raise TableRowError, "could not determine the value at column #{column_number_or_name}"
-          end
-        end
-
-
-        def []=(column_number_or_name, value)
-          begin
-            ole_cell = @@ole_table.Application.Intersect(
-              @ole_listrow.Range, @@ole_table.ListColumns.Item(column_number_or_name).Range)
-            ole_cell.Value = value
-          rescue WIN32OLERuntimeError
-            raise TableRowError, "could not assign value #{value.inspect} to cell at column #{column_number_or_name}"
-          end
+        def ole_table
+          @@ole_table
         end
+      
+      end      
 
-        # values of the row
-        # @return [Array] values of the row
-        def values
-          begin
-            @ole_listrow.Range.Value.first
-          rescue WIN32OLERuntimeError
-            raise TableError, "could not read values"
-          end
-        end
-
-        # sets the values of the row
-        # @param [Array] values of the row
-        def set_values values
-          begin
-            updated_values = self.values
-            updated_values[0,values.length] = values
-            @ole_listrow.Range.Value = [updated_values]
-            values
-          rescue WIN32OLERuntimeError
-            raise TableError, "could not set values #{values.inspect}"
-          end
-        end
-
-        # deletes the values of the row
-        def delete_values
-          begin
-            @ole_listrow.Range.Value = [[].fill(nil,0..(@@ole_table.ListColumns.Count)-1)]
-            nil
-          rescue WIN32OLERuntimeError
-            raise TableError, "could not delete values"
-          end
-        end        
-
-        def method_missing(name, *args)
-          name_str = name.to_s
-          core_name = name_str[-1]!='=' ? name_str : name_str[0..-2]
-          column_names = @@ole_table.HeaderRowRange.Value.first
-          column_name = column_names.find do |c|
-            c == core_name ||  
-            c.gsub(/\W/,'') == core_name ||
-            c.replace_umlauts == core_name ||
-            c.gsub(/\W/,'').replace_umlauts == core_name ||
-            c.gsub(/\W/,'').replace_umlauts.underscore.gsub(/[^[\w\d]]/, '_').delete_multiple_underscores == core_name           
-          end
-          if column_name
-            method_name = core_name.gsub(/\W/,'') + (name_str[-1]!='=' ? "" : "=")
-            define_and_call_method(column_name,method_name,*args)
-          else
-            super(name, *args)
-          end
-        end
-
-      private
-
-        def define_and_call_method(column_name,method_name,*args)
-          ole_cell = @@ole_table.Application.Intersect(
-              @ole_listrow.Range, @@ole_table.ListColumns.Item(column_name).Range)
-          define_getting_setting_method(ole_cell,method_name)            
-          self.send(method_name, *args)
-        end
-       
-        def define_getting_setting_method(ole_cell,name)
-          if name[-1] != '='
-            self.class.define_method(name) do
-              ole_cell.Value
-            end
-          else
-            self.class.define_method(name) do |value|
-              ole_cell.Value = value
-            end
-          end
-        end
-      end
-
-      # accesses a table row object
-      # @param [Integer]  a row number (>= 1)
-      # @return [ListRow] a object of dynamically constructed class with superclass ListRow 
-      def [] row_number
-        @row_class.new(row_number)
-      end
+    end
 
+    # accesses a table row object
+    # @param [Integer]  a row number (>= 1)
+    # @return [ListRow] a object of dynamically constructed class with superclass ListRow 
+    def [] row_number
+      @row_class.new(row_number)
     end
 
     # @return [Array] a list of column names
@@ -217,7 +117,7 @@ module RobustExcelOle
 
     # deletes a row
     # @param [Integer] position of the old row
-    def delete_row(row_number)
+    def delete_row(row_number)                          # :nodoc: #
       begin
         @ole_table.ListRows.Item(row_number).Delete
       rescue WIN32OLERuntimeError
@@ -227,7 +127,7 @@ module RobustExcelOle
 
     # deletes a column
     # @param [Variant] column number or column name
-    def delete_column(column_number_or_name)
+    def delete_column(column_number_or_name)              # :nodoc: #
       begin
         @ole_table.ListColumns.Item(column_number_or_name).Delete
       rescue WIN32OLERuntimeError
@@ -261,7 +161,7 @@ module RobustExcelOle
     # renames a row
     # @param [String] previous name or number of the column
     # @param [String] new name of the column   
-    def rename_column(name_or_number, new_name)
+    def rename_column(name_or_number, new_name)              # :nodoc: #
       begin
         @ole_table.ListColumns.Item(name_or_number).Name = new_name
       rescue
@@ -430,6 +330,5 @@ module RobustExcelOle
   end
 
   Table = ListObject
-  TableRow = ListRow
 
 end