robust_excel_ole 1.19.10 → 1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614de074c7752061f3544fd8501eaa7c13e84be83540388886d33afedc1ae736
-  data.tar.gz: e499ec767f61227f8256cb4b0779bb25bccdefe8bda26b28a59d60b48308cc47
+  metadata.gz: 7598173082d025a168f3c4e8021eb41c97fb1af36943e35cf2a812fcc0f39672
+  data.tar.gz: 2e1e0585da1b1369d323b218b0817f23679b71f99f637a269a6abf14673df615
 SHA512:
-  metadata.gz: 5a4d5db7e4d68d2ab0cb7fae6dd589dbebbab6582a2b9a9583241cabd5af4d06632cf1b350fc503c3b444fab8acc0c394c2b74cd3dfc64d90c612c2b956c1611
-  data.tar.gz: 47b6118c63a036db294f2cd15de8e05dd929b4553a25bc61176b0f8d57f5d7accf3be196b7c9d1ebae5f909ef51a2dd8ed784c40b340be07250f32dbf46e8f0c
+  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-12-07
+## [1.20] 2020-23-07
 
 ### Changed
   - using pry in console

data/README.rdoc

@@ -11,7 +11,7 @@ It supports handling workbooks across Excel instances by keeping track of workbo
 
 Library references are supported.
 
-RobustExcelOle works by sending VBA methods via Win32OlE. 
+RobustExcelOle works by sending VBA methods via WIN32OlE. 
 Therefore, it runs on Windows only.
 
 == Features
@@ -77,10 +77,10 @@ Let's open a workbook.
 
   workbook = Workbook.open 'spec/data/workbook.xls'
 
-Now we have a Workbook object that wraps a WIN32OLE object. That is, you can send any WIN32OLE (VBA) method to it. See 
+Now we have a Workbook object that wraps a WIN32OLE object. That is, we can send any WIN32OLE (VBA) method to it. See 
 https://docs.microsoft.com/en-us/office/vba/api/excel.workbook#methods.
 
-For example, you can determine the name of the workbook.
+For example, we can determine the name of the workbook.
 
   workbook.Name 
   # => "workbook.xls"
@@ -122,11 +122,11 @@ RobustExcelOle allows unobtrusively reading and modifying workbooks, i.e. access
     # do something
   end
 
-You can also create a new, empty workbook. 
+We can also create a new, empty workbook. 
 
   Workbook.create('spec/data/new_workbook.xls', :visible => true)
 
-Moreover, you can open the workbook using a block, similar to, e.g., +File.open+. 
+Moreover, we can open the workbook using a block, similar to, e.g., +File.open+. 
 
   Workbook.open('spec/data/workbook.xls') do |workbook|
     # do something
@@ -318,33 +318,139 @@ and set another value to that range.
 
 For more details about reading and writing contents of cells and ranges see {README_ranges}[https://github.com/Thomas008/robust_excel_ole/blob/master/docs/README_ranges.rdoc]
 
-=== Reading and writing list objects
+=== 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 "Amoun%tSales".
 
-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".
+Likewise we can get a RobustExcelOle list object with help of an existing WIN32OlE list object.
+
+  ole_listobject = worksheet.ListObjects.Item("Table 1")
+  table = ListObject.new(ole_listobject)
 
-A row in this table can be accessed with help of [], e.g.
+or
 
-  table[1]
+  table = ole_listobject.to_reo
 
-Now we can set and get the value of a cell of the table, e.g.
+Now we have a RobustExcelOle ListObject that wraps a WIN32OLE ListObject. So we can send any WIN32OLE (VBA) method to it. See 
+https://docs.microsoft.com/en-us/office/vba/api/excel.listobject#methods.
 
-  table[1].person = "John"
-  table[1].person
-  # => "John"
+A row in this table can be accessed with help of #[], e.g.
 
-Likewise we can get a table with help of an existing Win32OlE table.
+  row1 = table[1]
 
-  ole_listobject = worksheet.ListObjects.Item("Table 1")
-  table = ListObject.new(ole_listobject)
+=== Reading and setting values
+
+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.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.
+
+  table.row_values(1)
+  # => ["John", 40]
+
+or
+
+  table[1].values
+  # => ["John", 40]
+
+and
+
+  table.set_row_values(1, ["Herbert", 80])
+  # => ["Herbert", 80]
+
+or
+
+  table[1].set_values(["Herbert", 80])
+
+If the number of given values is less than the number of cells in the row, only the first values are written. The remaining values keep their value.  
+
+Similarly, we can read and set the values in a whole column, e.g.
+
+  table.column_values("Person")
+  # => ["John", "Peter"]
+
+and 
+
+  table.set_column_values(1, ["Herbert","Paul"])
+
+The column names we can get with help of
+
+  table.column_names
+
+A column can be renamed.
+
+  table.rename_column("Person", "Enterprise")
+
+or 
+
+  table.rename_column(1, "Enterprise")
+
+=== Adding and Deleting rows and columns
+
+We can add rows and columns, supplying optionally their name, the position and contents. 
+
+  table.add_column("column_name")
+  table.add_column("column_name", 3)
+  table.add_column("column_name", 3, ["John", "Paul"])
+  
+  table.add_row(3)
+  table.add_row(3, ["John", 40, 2, 2004])
+
+Deleting columns and rows is done by
+
+  table.delete_column("column_name")
+  table.delete_row(3)
+
+We can delete only the contents of a column
+
+  table.delete_column_values("column_name")
+
+Similarly can delete only the contents of a row.
+
+  table.delete_row_values(2)
+
+or 
+
+  table[2].delete_values
+
+Finally we can delete empty rows and columns.
+
+  table.delete_empty_rows
+  table.delete_empty_columns
+
+=== Finding values and sorting 
+
+You can find all cells containing a given value, e.g.
+
+  table.find_value(value)
+  #=> [#<Cell: (5,8)>#, #<Cell: (9,6)>#]
+
+You can sort a table according to a given column and sort order, e.g.
 
-   r4 = t4[1]
-r4.person
-# =>
-r.person = "John"
+  table.sort("Person", :ascending)
 
 === More things
 

data/bin/jreo

@@ -1,3 +1,24 @@
-@echo off
+#!/usr/bin/env jruby
+# -*- jruby -*-
 
-jruby ../lib/reo_console.rb
+require 'pry'
+require '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.color = false
+#Pry.editor = 'notepad'  # 'subl', 'vi'
+#Pry.config.prompt =
+#  [
+#    ->(_obj, _nest_level, _) { ">> " },
+#    ->(*) { "  " }
+#  ]
+
+pry

data/bin/reo

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# -*- ruby -*-
+
+require 'pry'
+require '../robust_excel_ole/lib/robust_excel_ole'
+
+include REO
+include General
+
+# some pry configuration
+Pry.config.windows_console_warning = false
+#Pry.config.history_save = true
+Pry.config.color = false
+#Pry.editor = 'notepad'  # 'subl', 'vi'
+#Pry.config.prompt =
+#[
+#->(_obj, _nest_level, _) { ">> " },
+#->(*) { "  " }
+#]
+
+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

@@ -1,21 +1,24 @@
 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/robust_excel_ole/bookstore.rb

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

data/lib/robust_excel_ole/cell.rb

@@ -24,6 +24,16 @@ module RobustExcelOle
       @ole_range = @ole_range.MergeArea.Item(1,1) if @ole_range.MergeCells
     end
 
+    # @private
+    def to_s    
+      @ole_range.Name.to_s
+    end
+
+    # @private
+    def inspect    
+      "#<Cell:" + " (#{@ole_range.Row},#{@ole_range.Column})" + ">#" 
+    end
+
   private
 
     # @private

data/lib/robust_excel_ole/general.rb

@@ -10,28 +10,35 @@ module General
   ::CONNECT_EXCEL_JRUBY_BUG      = IS_JRUBY_PLATFORM && true
   ::RANGES_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
 
+  NetworkDrive = Struct.new(:drive_letter, :network_name) do
+
+    def self.get_all(drives)
+      ndrives = []
+      count = drives.Count
+      (0..(count - 1)).step(2) do |i|
+        ndrives << NetworkDrive.new( drives.Item(i), drives.Item(i + 1))
+      end
+      ndrives
+    end
+
+  end
+
   @private
   def network2hostnamesharepath(filename)
     network = WIN32OLE.new('WScript.Network')
     drives = network.enumnetworkdrives
-    drive_letter, filename_after_drive_letter = filename.split(':') 
-    # if filename starts with a drive letter not c and this drive exists,
-    # then determine the corresponding host_share_path
-    default_drive = File.absolute_path(".")[0]
-    if drive_letter != default_drive && drive_letter != filename  
-      for i in 0 .. drives.Count-1
-        next if i % 2 == 1
-        if drives.Item(i).gsub(':','') == drive_letter
-          hostname_share = drives.Item(i+1)  #.gsub('\\','/').gsub('//','')
-          break
-        end
-      end
-      hostname_share + filename_after_drive_letter if hostname_share
-    else
-      return filename
-    end
+    drive_letter, filename_after_drive_letter = filename.split(':')
+    drive_letter = normalize_drive_letter(drive_letter)
+    network_drives = NetworkDrive.get_all(drives)
+    network_drive = network_drives.find{ |d| d.drive_letter == drive_letter }
+    return filename unless network_drive
+    return network_drive.network_name + filename_after_drive_letter
   end
 
+  def self.normalize_drive_letter(drive)
+    drive.upcase.end_with?(':') ? drive : "#{drive}:"
+  end
+  
   # @private
   def absolute_path(file)     
     file[0,2] = './' if ::EXPANDPATH_JRUBY_BUG && file  =~ /[A-Z]:[^\/]/
@@ -44,11 +51,12 @@ module General
   def canonize(filename)
     raise TypeREOError, "No string given to canonize, but #{filename.inspect}" unless filename.is_a?(String)
     filename = network2hostnamesharepath(filename)
-    normalize(filename).downcase
+    normalize(filename).downcase if filename
   end
 
   # @private
-  def normalize(path)      
+  def normalize(path)  
+    return unless path    
     path = path.gsub('/./', '/') + '/'
     path = path.gsub(/[\/\\]+/, '/')
     nil while path.gsub!(/(\/|^)(?!\.\.?)([^\/]+)\/\.\.\//, '\1')
@@ -90,9 +98,19 @@ class Array
     end
   end
 
+  def find_each_index find
+    found, index, q = -1, -1, []
+    while found
+      found = self[index+1..-1].index(find)
+      if found
+        index = index + found + 1
+        q << index
+      end
+    end
+    q
+  end
 end
 
-
 # @private
 class WIN32OLE
 
@@ -103,7 +121,7 @@ class WIN32OLE
     class2method = [
       {Excel => :Hwnd},
       {Workbook => :FullName},
-      {Worksheet => :Copy},
+      {Worksheet => :UsedRange},
       {RobustExcelOle::Range => :Row},
       {ListObject => :ListRows}
     ]
@@ -113,7 +131,7 @@ class WIN32OLE
       begin
         self.send(method)
         if classname == RobustExcelOle::Range && self.Rows.Count == 1 && self.Columns.Count == 1
-          return Cell.new(self)
+          return Cell.new(self, self.Parent)
         else
           return classname.new(self)
         end
@@ -164,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)