robust_excel_ole 1.20 → 1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cbad43d74758e37eb8e8d17e0297ead9f7cda838f5a157832145d41bacb743a
-  data.tar.gz: 80a112947a96132e8f8bb5ccccdccace4b7c1227418475aac51d6aa771b2e876
+  metadata.gz: 7598173082d025a168f3c4e8021eb41c97fb1af36943e35cf2a812fcc0f39672
+  data.tar.gz: 2e1e0585da1b1369d323b218b0817f23679b71f99f637a269a6abf14673df615
 SHA512:
-  metadata.gz: 4983b1d7e31e09873bf70e9903e3bdcd7a438e238283c5f2bae9198b5ed53c83fd5726f55b7e9ad4559b820dca65f2c82cb82f85091b199f4b58adfa98064c6b
-  data.tar.gz: 6c1c920de4c68699a10e87241121a01e66884317f06ad8ce9962b049c024658b797e014ef0aaaa297287065e80d85514d384925f24412bf1175aa8d97c252865
+  metadata.gz: '09581d754af617dcbe58149087d78c0281e7aa1e6d5feb27f4b58a0b08a0cc5967d15398d85952174143a2e867133b2d1dbf352fd0656bc7488183c7edca94ab'
+  data.tar.gz: bc6c1bed4f9b3370a376b875fa5a4f64b690ef6df6da70efde30a5caa49447b32b28ba09864adcb4c0ca9ea861ddeb28b5af851e30db826e749c6c97cc0153de

data/Changelog

@@ -2,7 +2,7 @@
 All notable changes to this project will be documented in this file.
 
 
-## [1.20] 2020-14-07
+## [1.20] 2020-23-07
 
 ### Changed
   - using pry in console

data/README.rdoc

@@ -320,13 +320,13 @@ For more details about reading and writing contents of cells and ranges see {REA
 
 === List Objects
 
-=== Creating list objects
+=== Creating List Objects
 
 We can define a list object (or table) from scratch.
 
-  table = ListObject.new(worksheet, "table 1", [1,1], 3,["Person","Amount"])
+  table = ListObject.new(worksheet, "table 1", [1,1], 3,["Person","AmountSales"])
 
-This command creates a list object in worksheet named "table 1", with upper left corner at position [1,1] (first cell), with 3 rows and the columns "Person" and "Amount".
+This command creates a list object in worksheet named "table 1", with upper left corner at position [1,1] (first cell), with 3 rows and the columns "Person" and "Amoun%tSales".
 
 Likewise we can get a RobustExcelOle list object with help of an existing WIN32OlE list object.
 
@@ -346,11 +346,25 @@ A row in this table can be accessed with help of #[], e.g.
 
 === Reading and setting values
 
-Now we can set and get the value of a cell of the table with help of methods that are underscored versions of the column names, e.g.
+Now we can set and get the value of a cell of the table with help of methods that are equal to or are underscored variants of the column names, e.g.
 
-  row1.person = "John"
-  row1.person
-  # => "John"
+  row1.AmountSales = 40
+
+or
+
+  row1.amount_sales = 40
+  
+and
+
+  row1.AmountSales
+  # => 40
+
+or 
+
+  row1.amount_sales
+  # => 40
+
+Special characters in the colare being ignored.
 
 We can also read and set values in a whole row, e.g.
 

data/bin/reo

@@ -2,23 +2,26 @@
 # -*- ruby -*-
 
 require 'pry'
-require 'robust_excel_ole'
+require '../robust_excel_ole/lib/robust_excel_ole'
 
 include REO
 include General
 
-puts 'REO console started'
-puts 
-
 # some pry configuration
 Pry.config.windows_console_warning = false
-Pry.config.history.should_save = true
+#Pry.config.history_save = true
 Pry.config.color = false
 #Pry.editor = 'notepad'  # 'subl', 'vi'
 #Pry.config.prompt =
-#  [
-#    ->(_obj, _nest_level, _) { ">> " },
-#    ->(*) { "  " }
-#  ]
+#[
+#->(_obj, _nest_level, _) { ">> " },
+#->(*) { "  " }
+#]
 
-pry
+hooks = Pry::Hooks.new
+
+hooks.add_hook :when_started, :hook12 do
+puts 'REO console started'
+puts
+end
+Pry.start(nil, hooks: hooks)

data/lib/reo_console.rb

@@ -4,18 +4,21 @@ require '../robust_excel_ole/lib/robust_excel_ole'
 include REO
 include General
 
-puts 'REO console started'
-puts 
-
 # some pry configuration
 Pry.config.windows_console_warning = false
-Pry.config.history.should_save = true
+#Pry.config.history_save = true
 Pry.config.color = false
 #Pry.editor = 'notepad'  # 'subl', 'vi'
 #Pry.config.prompt =
-#  [
-#    ->(_obj, _nest_level, _) { ">> " },
-#    ->(*) { "  " }
-#  ]
+#[
+#->(_obj, _nest_level, _) { ">> " },
+#->(*) { "  " }
+#]
 
-pry
+hooks = Pry::Hooks.new
+
+hooks.add_hook :when_started, :hook12 do
+puts 'REO console started'
+puts
+end
+Pry.start(nil, hooks: hooks)

data/lib/robust_excel_ole/bookstore.rb

@@ -2,6 +2,7 @@
 
 module RobustExcelOle
 
+  # @private
   class Bookstore < Base
     
     def initialize

data/lib/robust_excel_ole/cell.rb

@@ -26,7 +26,7 @@ module RobustExcelOle
 
     # @private
     def to_s    
-      @ole_table.Name.to_s
+      @ole_range.Name.to_s
     end
 
     # @private

data/lib/robust_excel_ole/general.rb

@@ -38,49 +38,7 @@ module General
   def self.normalize_drive_letter(drive)
     drive.upcase.end_with?(':') ? drive : "#{drive}:"
   end
-
   
-=begin
-  NetworkDrive = Struct.new(:drive_letter, :network_name)
-
-  @private
-  def network2hostnamesharepath(filename)
-    puts "network2hostnamesharepath:"
-    puts "filename: #{filename}"
-    network = WIN32OLE.new('WScript.Network')
-    drives = network.enumnetworkdrives
-    puts "drives: #{drives.inspect}"
-    drive_letter, filename_after_drive_letter = filename.split(':')
-    puts "drive_letter: #{drive_letter.inspect}"
-    puts "filename_after_drive_letter: #{filename_after_drive_letter.inspect}"
-    drive_letter = normalize_drive_letter(drive_letter)
-    puts "drive_letter: #{drive_letter.inspect}"
-    network_drives = get_network_drives
-    puts "network_drives: #{network_drives.inspect}"
-    network_drive = network_drives.find{ |d| d.drive_letter == drive_letter }
-    puts "network_drive: #{network_drive.inspect}"
-    return filename unless network_drive
-    #return (File.exists?(filename) ? filename : nil) unless network_drive 
-    return network_drive.network_name + filename_after_drive_letter
-  end
-
-  def get_network_drives
-    network = WIN32OLE.new('WScript.Network')
-    drives = network.enumnetworkdrives
-    ndrives = []
-    count = drives.Count
-    (0..(count - 1)).step(2) do |i|
-      ndrives << NetworkDrive.new( drives.Item(i), drives.Item(i + 1))
-    end
-    ndrives
-  end
-
-  def normalize_drive_letter(drive)
-    drive.upcase.end_with?(':') ? drive : "#{drive}:"
-  end
-
-=end
-
   # @private
   def absolute_path(file)     
     file[0,2] = './' if ::EXPANDPATH_JRUBY_BUG && file  =~ /[A-Z]:[^\/]/
@@ -163,7 +121,7 @@ class WIN32OLE
     class2method = [
       {Excel => :Hwnd},
       {Workbook => :FullName},
-      {Worksheet => :Copy},
+      {Worksheet => :UsedRange},
       {RobustExcelOle::Range => :Row},
       {ListObject => :ListRows}
     ]
@@ -224,6 +182,31 @@ class ::String
     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)

data/lib/robust_excel_ole/list_object.rb

@@ -14,6 +14,8 @@ module RobustExcelOle
 
     attr_reader :ole_table
 
+    alias ole_object ole_table
+
     # constructs a list object (or table).
     # @param [Variable] worksheet_or_ole_listobject  a worksheet or a Win32Ole list object
     # @param [Variable] table_name_or_number         a table name or table number
@@ -115,31 +117,42 @@ module RobustExcelOle
             raise TableError, "could not delete values"
           end
         end
-       
+
         def method_missing(name, *args)
-          name_before_last_equal = name.to_s.split('=').first
+          name_str = name.to_s
+          core_name = name_str[-1]!='=' ? name_str : name_str[0..-2]
           column_names = @@ole_table.HeaderRowRange.Value.first
-          method_names = column_names.map{|c| c.underscore.gsub(/[^[\w\d]]/, '_')}
-          column_name = column_names[method_names.index(name_before_last_equal)]
+          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
-            ole_cell = @@ole_table.Application.Intersect(
-              @ole_listrow.Range, @@ole_table.ListColumns.Item(column_name).Range)
-            define_getting_setting_method(ole_cell,name.to_s)            
-            self.send(name, *args)
+            method_name = core_name.gsub(/\W/,'') + (name_str[-1]!='=' ? "" : "=")
+            define_and_call_method(column_name,method_name,*args)
           else
-            super
+            super(name, *args)
           end
         end
 
       private
 
-        def define_getting_setting_method(ole_cell,name_str)
-          if name_str[-1] != '='
-            self.class.define_method(name_str) do
+        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_str) do |value|
+            self.class.define_method(name) do |value|
               ole_cell.Value = value
             end
           end
@@ -349,6 +362,16 @@ module RobustExcelOle
       @ole_table.Sort.Apply
     end
 
+    # @private
+    # returns true, if the list object responds to VBA methods, false otherwise
+    def alive?
+      @ole_table.ListRows
+      true
+    rescue
+      # trace $!.message
+      false
+    end
+
     # @private
     def to_s    
       @ole_table.Name.to_s
@@ -361,6 +384,8 @@ module RobustExcelOle
       " #{@ole_table.Parent.Name}" + " #{@ole_table.Parent.Parent.Name}" + ">"
     end
 
+    include MethodHelpers
+
   private
 
     def method_missing(name, *args) 

data/lib/robust_excel_ole/range.rb

@@ -8,14 +8,20 @@ module RobustExcelOle
   # See https://docs.microsoft.com/en-us/office/vba/api/excel.worksheet#methods
 
   class Range < VbaObjects
+
     include Enumerable
+    
     attr_reader :ole_range
     attr_reader :worksheet
 
+    alias ole_object ole_range
+
+
     def initialize(win32_range, worksheet = nil)
       @ole_range = win32_range
-      @worksheet = worksheet ? worksheet : worksheet_class.new(self.Parent)
-      #@worksheet = worksheet_class.new(self.Parent)
+      @worksheet = worksheet ? worksheet.to_reo : worksheet_class.new(self.Parent)
+      address_r1c1 = @ole_range.AddressLocal(true,true,XlR1C1)
+      @rows, @columns = address_tool.as_integer_ranges(address_r1c1)
     end
 
     def each
@@ -64,12 +70,10 @@ module RobustExcelOle
         if !::RANGES_JRUBY_BUG
           self.Value
         else
-          address_r1c1 = self.AddressLocal(true,true,XlR1C1)
-          row, col = address_tool.as_integer_ranges(address_r1c1)
           values = []
-          row.each do |r|
+          @rows.each do |r|
             values_col = []
-            col.each{ |c| values_col << worksheet.Cells(r,c).Value}
+            @columns.each{ |c| values_col << worksheet.Cells(r,c).Value}
             values << values_col
           end
           values
@@ -85,10 +89,8 @@ module RobustExcelOle
         if !::RANGES_JRUBY_BUG
           ole_range.Value = value
         else
-          address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
-          row, col = address_tool.as_integer_ranges(address_r1c1)
-          row.each_with_index do |r,i|
-            col.each_with_index do |c,j|
+          @rows.each_with_index do |r,i|
+            @columns.each_with_index do |c,j|
               ole_range.Cells(i+1,j+1).Value = (value.respond_to?(:first) ? value[i][j] : value)
             end
           end
@@ -107,55 +109,52 @@ module RobustExcelOle
     # @options [Worksheet] the destination worksheet
     # @options [Hash] options: :transpose, :values_only
     def copy(dest_address1, sheet_or_dest_address2 = :__not_provided, options_or_sheet = :__not_provided, not_provided_or_options = :__not_provided)
-      dest_address = if sheet_or_dest_address2.is_a?(Object::Range) or sheet_or_dest_address2.is_a?(Integer)
-        [dest_address1,sheet_or_dest_address2] 
-      else
-        dest_address1
-      end
-      dest_sheet = if sheet_or_dest_address2.is_a?(Worksheet)
-        sheet_or_dest_address2
-      else
-        if options_or_sheet.is_a?(Worksheet)
-          options_or_sheet
+      begin
+        dest_address = if sheet_or_dest_address2.is_a?(Object::Range) or sheet_or_dest_address2.is_a?(Integer)
+          [dest_address1,sheet_or_dest_address2] 
         else
-          @worksheet
+          dest_address1
         end
-      end
-      options = if options_or_sheet.is_a?(Hash)
-        options_or_sheet 
-      else
-        if not_provided_or_options.is_a?(Hash)
-          not_provided_or_options
+        dest_sheet = if sheet_or_dest_address2.is_a?(Worksheet) or sheet_or_dest_address2.is_a?(WIN32OLE)
+          sheet_or_dest_address2.to_reo
         else
-          { }
+          if options_or_sheet.is_a?(Worksheet) or options_or_sheet.is_a?(WIN32OLE)
+            options_or_sheet.to_reo
+          else
+            @worksheet
+          end
         end
-      end
-      rows, columns = address_tool.as_integer_ranges(dest_address)
-      dest_address_is_position = (rows.min == rows.max && columns.min == columns.max)
-      dest_range_address = if (not dest_address_is_position) 
-          [rows.min..rows.max,columns.min..columns.max]
+        options = if options_or_sheet.is_a?(Hash)
+          options_or_sheet 
         else
-          if (not options[:transpose])
-            [rows.min..rows.min+self.Rows.Count-1,
-             columns.min..columns.min+self.Columns.Count-1]
+          if not_provided_or_options.is_a?(Hash)
+            not_provided_or_options
           else
-            [rows.min..rows.min+self.Columns.Count-1,
-             columns.min..columns.min+self.Rows.Count-1]
+            { }
           end
         end
-      dest_range = dest_sheet.range(dest_range_address)
-      begin
+        rows, columns = address_tool.as_integer_ranges(dest_address)
+        dest_address_is_position = (rows.min == rows.max && columns.min == columns.max)
+        dest_range_address = if (not dest_address_is_position) 
+            [rows.min..rows.max,columns.min..columns.max]
+          else
+            if (not options[:transpose])
+              [rows.min..rows.min+self.Rows.Count-1,
+               columns.min..columns.min+self.Columns.Count-1]
+            else
+              [rows.min..rows.min+self.Columns.Count-1,
+               columns.min..columns.min+self.Rows.Count-1]
+            end
+          end
+        dest_range = dest_sheet.range(dest_range_address)
         if options[:values_only]
-          # dest_range.Value = options[:transpose] ? self.Value.transpose : self.Value
           dest_range.v = options[:transpose] ? self.v.transpose : self.v
         else
           if dest_range.worksheet.workbook.excel == @worksheet.workbook.excel 
             if options[:transpose]
               self.Copy              
-              #dest_range.PasteSpecial('transpose' => true) 
               dest_range.PasteSpecial(XlPasteAll,XlPasteSpecialOperationNone,false,true)
             else
-              #self.Copy('destination' => dest_range.ole_range)
               self.Copy(dest_range.ole_range)
             end            
           else
@@ -166,7 +165,6 @@ module RobustExcelOle
               @worksheet.workbook.excel.with_displayalerts(false) {added_sheet.Delete}
             else
               self.Copy
-              #dest_sheet.Paste('destination' => dest_range.ole_range)
               dest_sheet.Paste(dest_range.ole_range)
             end
           end
@@ -184,7 +182,7 @@ module RobustExcelOle
     def copy_special(dest_address, dest_sheet = :__not_provided, options = { })
       rows, columns = address_tool.as_integer_ranges(dest_address)
       dest_sheet = @worksheet if dest_sheet == :__not_provided
-      dest_address_is_position = (rows.min == rows.max && columns.min == columns.max)
+      dest_address_is_position = (rows.min == rows.max && @columns.min == @columns.max)
       dest_range_address = if (not dest_address_is_position) 
           [rows.min..rows.max,columns.min..columns.max]
         else
@@ -239,6 +237,26 @@ module RobustExcelOle
       @worksheet.workbook.excel
     end
 
+    # @private
+    # returns true, if the Range object responds to VBA methods, false otherwise
+    def alive?
+      @ole_range.Row
+      true
+    rescue
+      # trace $!.message
+      false
+    end
+
+    # @private
+    def to_s
+      "#<REO::Range: " + "[#{@rows},#{@columns}] " + "#{worksheet.Name} " + ">"
+    end
+
+    # @private
+    def inspect
+      self.to_s
+    end
+
     # @private
     def self.worksheet_class   
       @worksheet_class ||= begin
@@ -254,6 +272,8 @@ module RobustExcelOle
       self.class.worksheet_class
     end
 
+    include MethodHelpers
+
   private
 
     def method_missing(name, *args) 

data/lib/robust_excel_ole/version.rb

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

data/lib/robust_excel_ole/workbook.rb

@@ -1004,7 +1004,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
@@ -224,6 +226,16 @@ module RobustExcelOle
         self.Name == other_worksheet.Name
     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
@@ -249,6 +261,8 @@ module RobustExcelOle
       self.to_s
     end
 
+    include MethodHelpers
+
   private
 
     def method_missing(name, *args)

data/spec/list_object_spec.rb

@@ -103,19 +103,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
@@ -324,6 +330,8 @@ describe ListObject do
       cells[0].Column.should == 8
       cells[1].Row.should == 9
       cells[1].Column.should == 6
+      puts "cells[0]: #{[cells[0]]}"
+      p "cells[0]: #{[cells[0]]}"
     end
   
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: '1.20'
+  version: '1.21'
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry