robust_excel_ole 1.19 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5ff7771ae8a35d2cf47dce37e92a9d4d720148faa91eb37dc2342b1239f7d0a
-  data.tar.gz: 4d50eb99f297d38a60845eca2550a36ae2734694b538c52eb23052a9e9db0077
+  metadata.gz: cc09b14fea1e80ffe22d0f47b5b5155b044b669ecabdd882995a966480516085
+  data.tar.gz: 85b55ef13fc3506b2fce3271e1f1c40cd97c3dd872dff4d79a953dbcef68d58b
 SHA512:
-  metadata.gz: 2ccd9358b7d0ca576c8120e249c7af4122c4040f51357efc339536f93cde6d8a6b9a2bb32071382f5c5d8ddc3f084920831eda36df0c1a8ed9698972cea9d516
-  data.tar.gz: f1b813c71610b01d3bfd7e70245a52b02522910b2d0cbd6a9742825c06a131f47bc7f9310c59749b0caf881fef6d8a8bc64336f709ba2104a4f78bff844a44b6
+  metadata.gz: 7ec786a35f9ce637f0bdc745f6ef4bb3c683d9cbe6242a2a0bc9a27636c72b1d95e7b47bf8c49c3cc188d9e09406b5ef270abbce7a7d71ad32ec0e0277c15aae
+  data.tar.gz: cb64cb1d4068da94c0ea6765e6626078c5cc8672bc40c5c18f6962cc5cbcf14c4be4a5032302e8936f5012a54d0891aff9a0914452d2400471ddece1a3a22865

data/.gitignore

@@ -10,3 +10,4 @@ doc/*
 .yardoc
 TodoList.md
 spec/data/*.xls*
+spec/data/workbook_listobjects.xlsx

data/Changelog

@@ -2,7 +2,12 @@
 All notable changes to this project will be documented in this file.
 
 
-## [1.19] 2020-30-5
+## [1.20] 2020-31.-8
+
+### Added
+  - ListObject
+
+## [1.19] 2020-10-6
 
 ### Added
   - Workheet#values, each_rowvalue

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
@@ -20,17 +20,18 @@ RobustExcelOle supports
 
 - opening and processing workbooks across various Excel instances
 - standard tasks like opening, reading, writing, saving, closing workbooks
+- dealing with simultanously happening user interactions
 - dealing with various cases of Excel and user behaviour
 - managing conflicts when opening workbooks (e.g. blocking or unsaved workbooks)
-- dealing with simultanously happening user interactions
 - workarounds for Excel bugs and JRuby bugs
 - availability of all VBA methods
-- availability of Excel constants (in form if Ruby constants: Excel constant.capitalize)
-- standard Excel file formats (.xlsx, .xls, .xlsm)
+- availability of the Excel constants (in form if Ruby constants: Excel constant.capitalize)
+- all standard Excel file formats (.xlsx, .xls, .xlsm)
+- list objects
 - reopening workbooks after closing them
 - unobtrusively opening workbooks, i.e. opening and processing workbooks
-  while preserving their status, e.g. saved status
-- reading and writing workbooks, worksheets, cells, ranges, rows, columns
+  while preserving their status, e.g. saved, readonly
+- reading and writing workbooks, worksheets, list objects, ranges, rows, columns, cells
 - naming, adding, and copying ranges and worksheets
 - references to other Excel libraries
 - console for interactive mode
@@ -313,10 +314,37 @@ 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
+
+We can define a list object (or table) from scratch.
+
+  table = ListObject.new(worksheet, "table 1", [1,1], 3,["Person","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 "Amount".
+
+A row in this table can be accessed with help of [], e.g.
+
+  table[1]
+
+Now we can set and get the value of a cell of the table, e.g.
+
+  table[1].person = "John"
+  table[1].person
+  # => "John"
+
+Likewise we can get a table with help of an existing Win32OlE table.
+
+  ole_listobject = worksheet.ListObjects.Item("Table 1")
+  table = ListObject.new(ole_listobject)
+
+   r4 = t4[1]
+r4.person
+# =>
+r.person = "John"
 
 === More things
 
-You can convert some win32ole objects into a RobustExcelOle object.
+You can convert some Win32Ole objects into a RobustExcelOle object.
 
   range = sheet.Names.Item("firstcell").to_reo
 

data/bin/reo

@@ -1,61 +1,4 @@
-#!/usr/bin/env jruby
-# -*- mode: jruby -*-
+@echo off
 
-require 'robust_excel_ole'
-include REO
-# include RobustExcelOle
-include General
+irb -f -r ../lib/reo_console.rb
 
-require 'irb'
-require 'irb/completion'
-require 'irb/ext/save-history'
-
-ARGV.concat ['--readline',
-             '--prompt-mode',
-             'simple']
-
-# 250 entries in the list
-IRB.conf[:SAVE_HISTORY] = 250
-
-# Store results in home directory with specified file name
-# IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.irb-history"
-IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.reo-history"
-
-# @private
-module Readline
-  module Hist 
-    LOG = IRB.conf[:HISTORY_FILE]
-    #    LOG = "#{ENV['HOME']}/.irb-history"
-
-    def self.write_log(line)
-      File.open(LOG, 'ab') do |f|
-        f << "#{line}
-      "
-      end
-    end
-
-    def self.start_session_log
-      timestamp = proc { Time.now.strftime('%Y-%m-%d, %H:%M:%S') }
-      # @private
-      class <<timestamp 
-        alias_method :to_s, :call
-      end
-      write_log("###### session start: #{timestamp}")
-      at_exit { write_log("###### session stop:  #{timestamp}") }
-    end
-  end
-
-  alias old_readline readline
-  def readline(*args)
-    ln = old_readline(*args)
-    begin
-      Hist.write_log(ln)
-    rescue StandardError
-    end
-    ln
-  end
-end
-
-Readline::Hist.start_session_log
-puts 'REO console started'
-IRB.start

data/lib/reo_console.rb

@@ -1,4 +1,4 @@
-require '../robust_excel_ole/lib/robust_excel_ole'
+require '../../robust_excel_ole/lib/robust_excel_ole'
 include REO
 # include RobustExcelOle
 include General
@@ -18,7 +18,7 @@ IRB.conf[:SAVE_HISTORY] = 250
 # IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.irb-history"
 IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.reo-history"
 
-IRB.conf[:PROMPT_MODE] = 'ert' #:SIMPLE
+IRB.conf[:PROMPT_MODE] = :SIMPLE
 #IRB.conf[:USE_READLINE] = true
 #IRB.conf[:AUTO_INDENT]  = true
 
@@ -58,6 +58,5 @@ module Readline
 end
 
 Readline::Hist.start_session_log
-puts 'REO console started'
-IRB.start
-
+puts 'REO console started: the changed one'
+#IRB.start

data/lib/robust_excel_ole.rb

@@ -14,6 +14,7 @@ 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')
 

data/lib/robust_excel_ole/general.rb

@@ -98,7 +98,13 @@ class WIN32OLE
   
   # type-lifting WIN32OLE objects to RobustExcelOle objects
   def to_reo
-    class2method = [{Excel => :Hwnd}, {Workbook => :FullName}, {Worksheet => :Copy}, {RobustExcelOle::Range => :Row}]
+    class2method = [
+      {Excel => :Hwnd},
+      {Workbook => :FullName},
+      {Worksheet => :Copy},
+      {RobustExcelOle::Range => :Row},
+      {ListObject => :ListRows}
+    ]
     class2method.each do |element|
       classname = element.first.first
       method = element.first.last

data/lib/robust_excel_ole/list_object.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  class ListRow
+  end
+
+  # 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. 
+  # See https://docs.microsoft.com/en-us/office/vba/api/excel.listobject#methods
+
+  class ListObject < VbaObjects
+
+    attr_reader :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
+    # @param [Array]    position                     a position of the upper left corner
+    # @param [Integer]  rows_count                   number of rows
+    # @param [Variable] columns_count_or_names       number of columns or array of column names
+    # @return [ListObject] a ListObject object
+    def initialize(worksheet_or_ole_listobject,
+                   table_name_or_number = "",
+                   position = [1,1],
+                   rows_count = 1, 
+                   columns_count_or_names = 1)
+                   
+      if (worksheet_or_ole_listobject.ListRows rescue nil)
+        @ole_table = worksheet_or_ole_listobject
+      else
+        @worksheet = worksheet_or_ole_listobject.to_reo
+        @ole_table = @worksheet.ListObjects.Item(table_name_or_number) rescue nil
+      end
+      unless @ole_table
+        columns_count = 
+          columns_count_or_names.is_a?(Integer) ? columns_count_or_names : columns_count_or_names.length 
+        column_names = columns_count_or_names.respond_to?(:first) ? columns_count_or_names : []
+        begin
+          listobjects = @worksheet.ListObjects
+          @ole_table = listobjects.Add(XlSrcRange, 
+                                       @worksheet.range([position[0]..position[0]+rows_count-1,
+                                                  position[1]..position[1]+columns_count-1]).ole_range,
+                                       XlYes)
+          @ole_table.Name = table_name_or_number
+          @ole_table.HeaderRowRange.Value = [column_names] unless column_names.empty?
+        rescue WIN32OLERuntimeError => msg # , Java::OrgRacobCom::ComFailException => msg
+          raise TableError, "error #{$!.message}"
+        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
+       
+        def method_missing(name, *args)
+          name_before_last_equal = name.to_s.split('=').first
+          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)]
+          if column_name
+            ole_cell = @@ole_table.Application.Intersect(
+              @ole_listrow.Range, @@ole_table.ListColumns(column_name).Range)
+            define_getting_setting_method(ole_cell,name.to_s)            
+            self.send(name, *args)
+          else
+            super
+          end
+        end
+
+        def define_getting_setting_method(ole_cell,name_str)
+          if name_str[-1] != '='
+            self.class.define_method(name_str) do
+              ole_cell.Value
+            end
+          else
+            self.class.define_method(name_str) 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
+
+  private
+
+    def method_missing(name, *args) 
+      if name.to_s[0,1] =~ /[A-Z]/
+        if ::ERRORMESSAGE_JRUBY_BUG
+          begin
+            @ole_table.send(name, *args)
+          rescue Java::OrgRacobCom::ComFailException 
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          end
+        else
+          begin
+            @ole_table.send(name, *args)
+          rescue NoMethodError 
+            raise VBAMethodMissingError, "unknown VBA property or method #{name.inspect}"
+          end
+        end
+      else
+        super
+      end
+    end
+  end
+
+  # @private
+  class TableError < WorksheetREOError
+  end
+
+  Table = ListObject
+  TableRow = ListRow
+
+end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.19"
+  VERSION = "1.19.1"
 end

data/spec/general_spec.rb

@@ -20,6 +20,7 @@ module RobustExcelOle
 
     before do
       @dir = create_tmpdir
+      @listobject_file = @dir + '/workbook_listobjects.xlsx'
       @simple_file = @dir + '/workbook.xls'
       @simple_save_file = @dir + '/workbook_save.xls'
       @different_file = @dir + '/different_workbook.xls'
@@ -39,6 +40,17 @@ module RobustExcelOle
 
       before do
         @book1 = Workbook.open(@simple_file)
+        @book2 = Workbook.open(@listobject_file)        
+      end
+
+      it "should type-lift an ListObject" do
+        worksheet = @book2.sheet(3)
+        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.ListRows.Count.should == 6
+        worksheet[3,4].Value.should == "Number"
       end
 
       it "should type-lift an Excel" do

data/spec/list_object_spec.rb

@@ -0,0 +1,143 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), './spec_helper')
+
+$VERBOSE = nil
+
+include RobustExcelOle
+include General
+
+describe ListObject do
+ 
+  before(:all) do
+    excel = Excel.new(:reuse => true)
+    open_books = excel == nil ? 0 : excel.Workbooks.Count
+    puts "*** open books *** : #{open_books}" if open_books > 0
+    Excel.kill_all
+  end 
+
+  before do
+    @dir = create_tmpdir
+    @listobject_file = @dir + '/workbook_listobjects.xlsx'
+    @book = Workbook.open(@listobject_file, :visible => true)
+    @sheet = @book.sheet(3)
+  end
+
+  after do
+    @book.close(:if_unsaved => :forget)
+    Excel.kill_all
+    rm_tmp(@dir)
+  end
+
+  describe "creating" do
+
+    context "with standard" do
+
+      it "should simply create a new table" do
+        table = Table.new(@sheet, "table_name", [1,1], 3, ["Person","Amount"])
+        table.Name.should == "table_name"
+        table.HeaderRowRange.Value.first.should == ["Person","Amount"]
+        table.ListRows.Count.should == 3
+        @sheet[1,1].Value.should == "Person"
+      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)
+        table.Name.should == "table3"
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.ListRows.Count.should == 6
+        @sheet[3,4].Value.should == "Number"
+      end
+
+      it "should type-lift a Win32ole list object into a RobustExcelOle list object with table name" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(@sheet, "table3")
+        table.Name.should == "table3"
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.ListRows.Count.should == 6
+        @sheet[3,4].Value.should == "Number"
+      end
+
+      it "should type-lift a Win32ole list object into a RobustExcelOle list object with item number" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(@sheet, 1)
+        table.Name.should == "table3"
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.ListRows.Count.should == 6
+        @sheet[3,4].Value.should == "Number"
+      end
+
+      it "should simply create a new table from a ole-worksheet" do
+        table = Table.new(@sheet.ole_worksheet, "table_name", [1,1], 3, ["Person","Amount"])
+        table.Name.should == "table_name"
+        table.HeaderRowRange.Value.first.should == ["Person","Amount"]
+        table.ListRows.Count.should == 3
+        @sheet[1,1].Value.should == "Person"
+      end
+
+      it "should type-lift a Win32ole list object into a RobustExcelOle list object with table name" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(@sheet.ole_worksheet, "table3")
+        table.Name.should == "table3"
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.ListRows.Count.should == 6
+        @sheet[3,4].Value.should == "Number"
+      end
+
+      it "should type-lift a Win32ole list object into a RobustExcelOle list object with item number" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(@sheet.ole_worksheet, 1)
+        table.Name.should == "table3"
+        table.HeaderRowRange.Value.first.should == ["Number","Person","Amount","Time","Date"]
+        table.ListRows.Count.should == 6
+        @sheet[3,4].Value.should == "Number"
+      end
+
+    end
+
+  end
+
+  describe "getting and setting values" do
+
+    context "with new table" do
+
+      before do
+        @table = Table.new(@sheet, "table_name", [1,1], 3, ["Person","Amount"])
+        @table_row1 = @table[1]
+      end
+
+      it "should set and read values" 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
+        @sheet[2,2].Value.should == 42
+      end
+    end
+
+    context "with type-lifted ole list object" do
+
+      before do
+        ole_table = @sheet.ListObjects.Item(1)
+        @table = Table.new(ole_table)
+        @table_row1 = @table[1]
+      end
+
+      it "should set and read values" do
+        @table_row1.number.should == 3
+        @table_row1.number = 1
+        @table_row1.number.should == 1
+        @sheet[4,4].Value.should == 1
+        @table_row1.person.should == "Herbert"
+        @table_row1.person = "John"
+        @table_row1.person.should == "John"
+        @sheet[4,5].Value.should == "John"
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: '1.19'
+  version: 1.19.1
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -109,6 +109,7 @@ files:
 - lib/robust_excel_ole/cygwin.rb
 - lib/robust_excel_ole/excel.rb
 - lib/robust_excel_ole/general.rb
+- lib/robust_excel_ole/list_object.rb
 - lib/robust_excel_ole/range.rb
 - lib/robust_excel_ole/range_owners.rb
 - lib/robust_excel_ole/robustexcelole.sublime-project
@@ -117,7 +118,6 @@ files:
 - lib/robust_excel_ole/version.rb
 - lib/robust_excel_ole/workbook.rb
 - lib/robust_excel_ole/worksheet.rb
-- lib/rubygems_plugin.rb
 - lib/spec_helper.rb
 - reo.bat
 - robust_excel_ole.gemspec
@@ -141,10 +141,12 @@ files:
 - spec/data/workbook_connected.xlsm
 - spec/data/workbook_linked.xlsm
 - spec/data/workbook_linked_sub.xlsm
+- spec/data/workbook_listobjects.xlsx
 - spec/excel_spec.rb
 - spec/general_spec.rb
 - spec/helpers/create_temporary_dir.rb
 - spec/helpers/key_sender.rb
+- spec/list_object_spec.rb
 - spec/range_spec.rb
 - spec/spec_helper.rb
 - spec/workbook_spec.rb

data/lib/rubygems_plugin.rb

@@ -1,3 +0,0 @@
-Gem.post_install do
-  puts "post_install called for gem"
-end