robust_excel_ole 1.9 → 1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf45dfa8d36893f06b8196d99990c94b76056fdfd8b98e2a1cff18f11dedec5
-  data.tar.gz: 2fb8ee7deb7bb700c9a7557340933b0a60a6ee38a8eaff9ed2c2f4b4669cadc0
+  metadata.gz: e9645dff34f91fdb38da9b5a8375e17170bace4159355b126b142cb4ab6689bf
+  data.tar.gz: d0ca3dbd87bca685ecb98ba1ac747b427c430e52bfe3de5b14beccfefd30d94c
 SHA512:
-  metadata.gz: 6b8c23bf581b8ec11b9e510bf0bf805e2309a089a307c01bdcaf4aead8dc1aa31becd972e94beedb5e7ac82183ac4f84bd0c5ea6883a4a15baa2d2f95fd13dba
-  data.tar.gz: 6958f89f6a6204f359a2f16469ca602a33b1572588b31944a073ffbc48936a9e9412edd4b742bb57ecff4e3b96756e99258924f60d5d2b7aaf8fefabafc0c697
+  metadata.gz: ae0be8a8538c3dd3c27a44c3d11d781be260cb2898e1cf221925d0902160ef4104b9142fd99c106ee5f210aa83688fa062d4ee1a13c8ae49dcb96b150b3baaeb
+  data.tar.gz: c21be14de79476461692a475685e518f478947051ac9cc8d417952646690b642e8dc2e52999a16b56c2cb8e337ac58b21ae2a28dfffbd8f89260aeced27d216b

data/.gitignore

@@ -9,3 +9,4 @@ doc/*
 *.sublime-workspace
 .yardoc
 TodoList.md
+spec/data/*.xls*

data/Changelog

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.10]
+
+### Added
+  - workarounds for running in Jruby
+  - Range,Cell#v
+
 ## [1.9]
 
 ### Added

data/README.rdoc

@@ -36,6 +36,12 @@ and go into the path of the gem 'robust_excel_ole'. There you start the console
 
   reo
 
+or
+
+  jreo
+
+depending on whether you are using ruby or jruby.
+
 The call of the console will include RobustExcelOle for you.
 
 The following examples can be used for both scripts and console. If you have started the console in the gem path, you can just put these examples.
@@ -299,6 +305,14 @@ 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]
 
+=== Running in jruby
+
+RobustExcelOle runs in jruby as well. You can call the console via the command +jreo+. However, note that, due to some restrictions of the library jruby-win32ole, there are some restrictions. So we had implemented some adaptions and workarounds. Some issues still remain when running under jruby:
+
+1. Excel.current or Excel.new(:reuse => true) does not connect to an already running Excel instance, unless some workbook has been opened via RobustExcelOle. 2. Excel.kill_all does work, Excel.close_all does not work. 3. When providing an absolute path, you have to state the "/" ("C:/abc.xls" works, "C:abc" does not work)
+
+
+
 === More things
 
 You can convert a win32ole object into a RobustExcelOle object.

data/docs/README_ranges.rdoc

@@ -57,6 +57,14 @@ or as flat array
   range.values
   =>  ["foo", "workbook", "sheet1", nil, "foo", nil, "foobaaa", nil, "matz", "is", "nice", nil]
 
+You can set values with help of range#Value or range#v, e.g.
+
+  range.Value = [[1,2,3,4],[5,6,7,8],[9,10,11,12]]
+
+or 
+
+  range.v = [[1,2,3,4],[5,6,7,8],[9,10,11,12]]
+
 Now we copy the range. With help of VBA methods you would do
 
   range.Copy(:destination => sheet.range([4..6,5..8]).ole_range)

data/docs/README_sheet.rdoc

@@ -67,12 +67,14 @@ Additionally you can specify a name and a position.
 
   book.copy_sheet(sheet, :as => 'new_name', :after => another_sheet)
 
-If you want to copy a worksheet, if a sheet is given, and add an empty worksheet, if no worksheet is given, then use
+If you want to copy a worksheet, if a worksheet +sheet+ is given, and add an empty worksheet, if no worksheet is given, then use
 
   book.add_or_copy_sheet
 
   book.add_or_copy_sheet(sheet, :as => 'new_name', :after => another_sheet)  
 
+Note, that running in jruby, due to some restrictions of jruby, there is a workaround when adding or copy a worksheet at the end (appending): the last worksheet is being copied and deleted afterwards, in order to serve as a dummy worksheet. This may cause a different behaviour.
+
 == Code
 
 worksheet.rb[https://github.com/Thomas008/robust_excel_ole/blob/master/lib/robust_excel_ole/worksheet.rb]

data/examples/modifying_sheets/example_access_sheets_and_cells.rb

@@ -46,7 +46,7 @@ begin
   book.close               # close the book
   
 ensure
-  Excel.close_all
+  Excel.close_all(:if_unsaved => :forget)
   rm_tmp(dir)
 end
 

data/examples/modifying_sheets/example_adding_sheets.rb

@@ -7,7 +7,7 @@ require "fileutils"
 
 include RobustExcelOle
 
-Excel.close_all
+Excel.kill_all
 begin
   dir = create_tmpdir
   simple_file = dir + 'workbook.xls'
@@ -63,7 +63,7 @@ begin
   @book.close(:if_unsaved => :forget)   # close the book without saving it
   
 ensure
-  Excel.close_all
+  Excel.close_all(:if_unsaved => :forget)
   rm_tmp(dir)
 end
 

data/examples/open_save_close/example_if_obstructed_closeifsaved.rb

@@ -20,7 +20,7 @@ begin
   sleep 1
   begin
     new_book = Workbook.open(other_file_name, :if_obstructed => :close_if_saved) # raises an exception since the file is not saved
-    rescue WorkbookNotSaved => msg                                             
+  rescue WorkbookBlocked => msg                                             
     puts "error: open: #{msg.message}"
   end                                                        
   book.save                                                           # save the unsaved book

data/jreo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+jirb -f -r ./lib/robust_excel_ole -r ./lib/jreo_console.rb

data/lib/jreo_console.rb

@@ -0,0 +1,67 @@
+# require '../robust_excel_ole/lib/robust_excel_ole'
+include REO
+# include RobustExcelOle
+include General
+
+require 'irb/completion'
+require 'irb/ext/save-history'
+gem 'jruby-readline'
+
+ARGV.concat ['--readline',
+             '--prompt-mode',
+             'simple',
+             '-rjruby-readline']
+
+#IRB.conf[:PROMPT_MODE] = :SIMPLE
+#IRB.conf[:USE_READLINE] = true
+#IRB.conf[:AUTO_INDENT]  = true
+
+
+
+
+# 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']}/.irb-save-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 'JREO console started'

data/lib/robust_excel_ole.rb

@@ -1,4 +1,8 @@
-require 'win32ole'
+if RUBY_PLATFORM =~ /java/
+  require 'jruby-win32ole'
+else
+  require 'win32ole'
+end
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/reo_common')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/range_owners')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/address')

data/lib/robust_excel_ole/address.rb

@@ -4,12 +4,16 @@ module RobustExcelOle
 
   class Address < REOCommon
 
+    # hack
+    #@@row_letter = "Z"
+    #@@col_letter = "S"
+
     def self.new(r1c1_letters)
       @@row_letter = r1c1_letters[0..0]
       @@col_letter = r1c1_letters[1..1]
     end
 
-    # address formats taht are valid:
+    # address formats that are valid:
     #   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]" 
     #   int_range: e.g. [3,1], [3,"A"], [3..5,1..2], [3..5, "A".."B"], 

data/lib/robust_excel_ole/bookstore.rb

@@ -8,6 +8,14 @@ module RobustExcelOle
       @hidden_excel_instance = nil
     end
 
+    # returns an excel
+    def excel
+      fn2books = @filename2books.first
+      return nil if fn2books.nil? || fn2books.empty? || fn2books[1].empty?  
+      book = fn2books[1].first.__getobj__
+      book.excel
+    end
+
     # returns a book with the given filename, if it was open once
     # @param [String] filename  the file name
     # @param [Hash]   options   the options

data/lib/robust_excel_ole/cell.rb

@@ -5,17 +5,17 @@ module RobustExcelOle
     attr_reader :cell
 
     def initialize(win32_cell)
-      @cell = if win32_cell.MergeCells
-                win32_cell.MergeArea.Item(1,1)
-              else
-                win32_cell
-              end
+      @cell = win32_cell.MergeCells ? win32_cell.MergeArea.Item(1,1) : win32_cell
     end
 
     def v
       self.Value
     end
 
+    def v=(value)
+      self.Value = value
+    end
+
     # @private
     def method_missing(name, *args) 
       #if name.to_s[0,1] =~ /[A-Z]/

data/lib/robust_excel_ole/excel.rb

@@ -75,7 +75,15 @@ module RobustExcelOle
       end
       ole_xl = win32ole_excel unless win32ole_excel.nil?
       options = { :reuse => true }.merge(options)
-      ole_xl = current_excel if options[:reuse] == true
+      #ole_xl = current_excel if options[:reuse] == true
+      if options[:reuse] == true
+        ole_xl = if RUBY_PLATFORM =~ /java/
+          excel_instance = known_excel_instance
+          ole_xl = excel_instance.ole_excel unless excel_instance.nil?
+        else
+          current_excel
+        end
+      end
       ole_xl ||= WIN32OLE.new('Excel.Application')
       hwnd = ole_xl.HWnd
       stored = hwnd2excel(hwnd)
@@ -102,7 +110,7 @@ module RobustExcelOle
         end
       end
       result
-    end
+    end    
 
     def initialize(options = {}); end
 
@@ -141,12 +149,14 @@ module RobustExcelOle
     # connects to the first opened Excel instance
     # if this Excel instance is being closed, then Excel creates a new Excel instance
     # @private
-    def self.current_excel 
-      result = begin
-                 WIN32OLE.connect('Excel.Application')
-               rescue
-                 nil
-               end
+    def self.current_excel      
+      result = if result.nil?
+        begin
+          WIN32OLE.connect('Excel.Application')
+        rescue
+          nil
+        end
+      end
       if result
         begin
           result.Visible # send any method, just to see if it responds
@@ -413,7 +423,18 @@ module RobustExcelOle
       processes.select { |p| p.name == 'EXCEL.EXE' }.size
     end
 
-    # returns all Excel objects for all Excel instances opened with RobustExcelOle,
+    # returns an Excel instance
+    def self.known_excel_instance
+      @@hwnd2excel.each do |hwnd, wr_excel|
+        if wr_excel.weakref_alive?
+          excel = wr_excel.__getobj__
+          return excel if excel.alive?
+        end
+      end
+      nil
+    end
+
+    # returns all Excel objects for all Excel instances opened with RobustExcelOle
     def self.known_excel_instances
       pid2excel = {}
       @@hwnd2excel.each do |hwnd,wr_excel|
@@ -427,8 +448,6 @@ module RobustExcelOle
         pid2excel[pid] = excel
       end
       processes = WIN32OLE.connect('winmgmts:\\\\.').InstancesOf('win32_process')
-      # excel_processes = processes.select{ |p| p.name == "EXCEL.EXE" && pid2excel.include?(p.processid)}
-      # excel_processes.map{ |p| Excel.new(pid2excel[p.processid]) }
       processes.select { |p| Excel.new(pid2excel[p.processid]) if p.name == 'EXCEL.EXE' && pid2excel.include?(p.processid) }
       result = []
       processes.each do |p|

data/lib/robust_excel_ole/general.rb

@@ -27,10 +27,6 @@ module General
 
   module_function :absolute_path, :canonize, :normalize
 
-  # @private
-  class VBAMethodMissingError < RuntimeError 
-  end
-
 end
 
 # @private

data/lib/robust_excel_ole/range.rb

@@ -26,7 +26,13 @@ module RobustExcelOle
     # @params [Range] a range
     # @returns [Array] the values
     def values(range = nil)
-      result = map { |x| x.Value }.flatten
+      #result = map { |x| x.Value }.flatten
+      result_unflatten = if RUBY_PLATFORM !~ /java/
+        map { |x| x.v }
+      else
+        self.v
+      end
+      result = result_unflatten.flatten
       if range
         relevant_result = []
         result.each_with_index { |row_or_column, i| relevant_result << row_or_column if range.include?(i) }
@@ -37,7 +43,42 @@ module RobustExcelOle
     end
 
     def v
-      self.Value
+      begin
+        if RUBY_PLATFORM !~ /java/ 
+          self.Value
+        else
+          address_r1c1 = self.AddressLocal(true,true,XlR1C1)
+          row, col = Address.int_range(address_r1c1)
+          values = []
+          row.each do |r|
+            values_col = []
+            col.each{ |c| values_col << worksheet.Cells(r,c).Value}
+            values << values_col
+          end
+          values
+        end
+      rescue WIN32OLERuntimeError
+        raise RangeNotEvaluatable, 'cannot read value'
+      end 
+    end
+
+    def v=(value)
+      begin
+        if RUBY_PLATFORM !~ /java/
+          ole_range.Value = value
+        else
+          address_r1c1 = ole_range.AddressLocal(true,true,XlR1C1)
+          row, col = Address.int_range(address_r1c1)
+          row.each_with_index do |r,i|
+            col.each_with_index do |c,j|
+              ole_range.Cells(i+1,j+1).Value = (value.respond_to?(:first) ? value[i][j] : value)
+            end
+          end
+        end
+        value
+      rescue # WIN32OLERuntimeError
+        raise RangeNotEvaluatable, "cannot assign value to range #{address_r1c1.inspect}"
+      end
     end
 
     def [] index
@@ -74,7 +115,7 @@ module RobustExcelOle
         end
       end
       rows, columns = Address.int_range(dest_address)
-      dest_sheet = @worksheet if dest_sheet == :__not_provided
+      #dest_sheet = @worksheet if dest_sheet == :__not_provided
       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]
@@ -90,14 +131,17 @@ module RobustExcelOle
       dest_range = dest_sheet.range(dest_range_address)
       begin
         if options[:values_only]
-          dest_range.Value = options[:transpose] ? self.Value.transpose : self.Value
+          # 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) 
+              self.Copy              
+              #dest_range.PasteSpecial('transpose' => true) 
+              dest_range.PasteSpecial(XlPasteAll,XlPasteSpecialOperationNone,false,true)
             else
-              self.Copy('destination' => dest_range.ole_range)
+              #self.Copy('destination' => dest_range.ole_range)
+              self.Copy(dest_range.ole_range)
             end            
           else
             if options[:transpose]
@@ -107,7 +151,8 @@ 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('destination' => dest_range.ole_range)
+              dest_sheet.Paste(dest_range.ole_range)
             end
           end
         end
@@ -144,9 +189,11 @@ module RobustExcelOle
           if dest_range.worksheet.workbook.excel == @worksheet.workbook.excel     
             if options[:transpose]
               self.Copy
-              dest_range.PasteSpecial('transpose' => true) 
+              #dest_range.PasteSpecial('transpose' => true) 
+              dest_range.PasteSpecial(XlPasteAll,XlPasteSpecialOperationNone,false,true)
             else
-              self.Copy('destination' => dest_range.ole_range)
+              #self.Copy('destination' => dest_range.ole_range)
+              self.Copy(dest_range.ole_range)
             end            
           else
             if options[:transpose]
@@ -156,7 +203,8 @@ 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('destination' => dest_range.ole_range)
+              dest_sheet.Paste(dest_range.ole_range)
             end
           end
         end
@@ -184,7 +232,7 @@ module RobustExcelOle
 
     # @private
     def method_missing(name, *args) 
-      #if name.to_s[0,1] =~ /[A-Z]/
+      if name.to_s[0,1] =~ /[A-Z]/
         begin
           @ole_range.send(name, *args)
         rescue WIN32OLERuntimeError => msg
@@ -194,9 +242,9 @@ module RobustExcelOle
             raise msg
           end
         end
-   #   else
-   #     super
-   #   end
+      else
+        super
+      end
     end
   end
 end