robust_excel_ole 1.30 → 1.31

data/lib/robust_excel_ole/list_row.rb

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  using StringRefinement
+
+  class ListRow    
+
+    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
+
+    # sets the value of the cell with given column name or number
+    # @param [Variant] column number or column name
+    # @param [Variant] value of the cell
+    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
+    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.underscore == core_name ||
+        c.underscore.gsub(/\W/,'_') == core_name ||
+        c.replace_umlauts.gsub(/\W/,'_') == core_name ||
+        c.replace_umlauts.underscore.gsub(/\W/,'_') == core_name 
+      end         
+      if column_name
+        appended_eq = (name_str[-1]!='=' ? "" : "=")
+        method_name = core_name.replace_umlauts.underscore + appended_eq 
+        define_and_call_method(column_name,method_name,*args)
+      else
+        super(name, *args)
+      end
+    end
+
+    # @private
+    def to_s    
+      inspect  
+    end
+
+    # @private
+    def inspect    
+      "#<ListRow: " + "index:#{@ole_listrow.Index}" + " size:#{ole_table.ListColumns.Count}" + " #{ole_table.Name}" + ">"
+    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
+  
+  TableRow = ListRow
+
+end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.30"
+  VERSION = "1.31"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -158,7 +158,7 @@ module RobustExcelOle
         @excel = excel_class.new(ole_excel)
         filename = @ole_workbook.Fullname.tr('\\','/') 
       else
-        filename = file_or_workbook            
+        filename = file_or_workbook
         ensure_workbook(filename, opts)        
       end      
       apply_options(filename, opts)
@@ -236,7 +236,7 @@ module RobustExcelOle
     end
 
     # @private    
-    def ensure_workbook(filename, options)  
+    def ensure_workbook(filename, options)
       set_was_open options, true
       return if (@ole_workbook && alive? && (options[:read_only].nil? || @ole_workbook.ReadOnly == options[:read_only]))
       set_was_open options, false
@@ -253,9 +253,7 @@ module RobustExcelOle
       if @ole_workbook && alive?
         set_was_open options, true
         manage_blocking_or_unsaved_workbook(filename,options)
-        if @ole_workbook.ReadOnly != options[:read_only]
-        end
-        open_or_create_workbook(filename,options) if @ole_workbook.ReadOnly != options[:read_only]
+        open_or_create_workbook(filename,options) if (!options[:read_only].nil?) && options[:read_only] != @ole_workbook.ReadOnly
       else
         if (excel_option.nil? || excel_option == :current) &&  
           !(::CONNECT_JRUBY_BUG && filename[0] == '/')
@@ -341,11 +339,12 @@ module RobustExcelOle
       end        
     end
 
-    def manage_blocking_workbook(filename, options)
+    def manage_blocking_workbook(filename, options)     
+      blocked_filename = -> { General.canonize(@ole_workbook.Fullname.tr('\\','/')) }
       case options[:if_obstructed]
       when :raise
         raise WorkbookBlocked, "can't open workbook #{filename},
-        because it is being blocked by #{@ole_workbook.Fullname.tr('\\','/')} with the same name in a different path." +
+        because it is being blocked by #{blocked_filename.call} with the same name in a different path." +
         "\nHint: Use the option :if_blocked with values :forget or :save,
          to allow automatic closing of the old workbook (without or with saving before, respectively),
          before the new workbook is being opened."
@@ -355,7 +354,7 @@ module RobustExcelOle
         manage_saving_workbook(filename, options)        
       when :close_if_saved
         if !@ole_workbook.Saved
-          raise WorkbookBlocked, "workbook with the same name in a different path is unsaved: #{@ole_workbook.Fullname.tr('\\','/')}" +
+          raise WorkbookBlocked, "workbook with the same name in a different path is unsaved: #{blocked_filename.call}" +
           "\nHint: Use the option :if_blocked => :save to save the workbook"
         else
           manage_forgetting_workbook(filename, options)
@@ -371,9 +370,14 @@ module RobustExcelOle
     def manage_unsaved_workbook(filename, options)
       case options[:if_unsaved]
       when :raise
-        raise WorkbookNotSaved, "workbook is already open but not saved: #{File.basename(filename).inspect}" +
-        "\nHint: Save the workbook or open the workbook using option :if_unsaved with values :forget and :accept to
-         close the unsaved workbook and reopen it, or to let the unsaved workbook open, respectively"
+        msg = if !options[:read_only].nil? && @ole_workbook.ReadOnly != options[:read_only]
+          "cannot change read-only mode of the workbook #{File.basename(filename).inspect}, because it contains unsaved changes"
+        else
+          "workbook is already open but not saved: #{File.basename(filename).inspect}"
+        end
+        raise WorkbookNotSaved, msg +
+        "\nHint: Use the option :if_unsaved with values :forget to close the unsaved workbook, 
+         :accept to let it open, or :save to save it, respectivly"
       when :forget
         manage_forgetting_workbook(filename, options)
       when :accept
@@ -406,7 +410,24 @@ module RobustExcelOle
       @ole_workbook = nil
       open_or_create_workbook(filename, options)
     end
-    
+
+    def explore_workbook_error(msg, want_change_readonly = nil)
+      if msg.message =~ /800A03EC/ && msg.message =~ /0x80020009/
+        # error message: 
+        # 'This workbook is currently referenced by another workbook and cannot be closed'
+        # 'Diese Arbeitsmappe wird momentan von einer anderen Arbeitsmappe verwendet und kann nicht geschlossen werden.'
+        if want_change_readonly==true
+          raise WorkbookLinked, "read-only mode of this workbook cannot be changed, because it is being used by another workbook"
+        elsif want_change_readonly.nil?
+          raise WorkbookLinked, "workbook is being used by another workbook"
+        else
+          raise UnexpectedREOError, "unknown WIN32OLERuntimeError:\n#{msg.message}"
+        end
+      else
+        raise UnexpectedREOError, "unknown WIN32OLERuntimeError:\n#{msg.message}"
+      end
+    end
+
     def open_or_create_workbook(filename, options)
       return if @ole_workbook && options[:if_unsaved] != :alert && options[:if_unsaved] != :excel &&
         (options[:read_only].nil? || options[:read_only]==@ole_workbook.ReadOnly )
@@ -427,7 +448,8 @@ module RobustExcelOle
         rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException => msg
           # for Excel2007: for option :if_unsaved => :alert and user cancels: this error appears?
           # if yes: distinguish these events
-          raise UnexpectedREOError, "cannot open workbook: #{msg.message} #{msg.backtrace}"
+          want_change_readonly = !options[:read_only].nil? && (options[:read_only] != @ole_workbook.ReadOnly)
+          explore_workbook_error(msg, want_change_readonly)
         end
         begin
           # workaround for bug in Excel 2010: workbook.Open does not always return the workbook when given file name
@@ -522,7 +544,14 @@ module RobustExcelOle
   private
 
     def close_workbook
-      @ole_workbook.Close if alive?
+      #@ole_workbook.Close if alive?
+      if alive?
+        begin
+          @ole_workbook.Close 
+        rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException => msg
+          explore_workbook_error(msg)          
+        end
+      end      
       @ole_workbook = nil unless alive?
     end
 
@@ -1103,6 +1132,10 @@ public
   class WorkbookNotSaved < WorkbookREOError        
   end
 
+  # @private
+  class WorkbookLinked < WorkbookREOError        
+  end
+
   # @private
   class WorkbookReadOnly < WorkbookREOError        
   end

data/lib/robust_excel_ole/worksheet.rb

@@ -11,6 +11,8 @@ module RobustExcelOle
   # worksheet: see https://github.com/Thomas008/robust_excel_ole/blob/master/lib/robust_excel_ole/worksheet.rb
   class Worksheet < RangeOwners
 
+    using ToReoRefinement
+
     attr_reader :ole_worksheet
     attr_reader :workbook
 
@@ -194,10 +196,12 @@ module RobustExcelOle
       raise RangeNotEvaluatable, "cannot assign value #{value.inspect} to cell (#{y.inspect},#{x.inspect})"
     end
 
+    # provides a 2-dimensional array that contains the values in each row
     def values
       @ole_worksheet.UsedRange.Value
     end
 
+    # enumerator for accessing cells
     def each
       each_row do |row_range|
         row_range.each do |cell|
@@ -216,24 +220,7 @@ module RobustExcelOle
       end
     end
 
-    def each_rowvalue
-      @ole_worksheet.UsedRange.Value.each do |row_values|
-        yield row_values
-      end
-    end
-
-    def each_value   # :deprecated: #
-      each_rowvalue
-    end
-
-    def each_rowvalue_with_index(offset = 0)
-      i = offset
-      @ole_worksheet.UsedRange.Value.each do |row_values|
-        yield row_values, i
-        i += 1
-      end
-    end
-
+    # enumerator for accessing rows
     def each_row(offset = 0)
       offset += 1
       1.upto(@end_row) do |row|
@@ -248,6 +235,7 @@ module RobustExcelOle
       end
     end
 
+    # enumerator for accessing columns
     def each_column(offset = 0)
       offset += 1
       1.upto(@end_column) do |column|
@@ -262,6 +250,24 @@ module RobustExcelOle
       end
     end
 
+    def each_rowvalue  # :deprecated: #
+      values.each do |row_values|
+        yield row_values
+      end
+    end
+
+    def each_value   # :deprecated: #
+      each_rowvalue
+    end
+
+    def each_rowvalue_with_index(offset = 0)    # :deprecated: #
+      i = offset
+      values.each do |row_values|
+        yield row_values, i
+        i += 1
+      end
+    end
+
     def row_range(row, integer_range = nil)
       integer_range ||= 1..@end_column
       RobustExcelOle::Range.new(@ole_worksheet.Range(@ole_worksheet.Cells(row, integer_range.min), @ole_worksheet.Cells(row, integer_range.max)), self)
@@ -303,6 +309,17 @@ module RobustExcelOle
       range
     end
 
+    # @params [Variant] table (listobject) name or number 
+    # @return [ListObject] a table (listobject)
+    def table(number_or_name)
+      begin
+        ole_listobject = @ole_worksheet.ListObjects.Item(number_or_name)
+      rescue
+        raise WorksheetREOError, "table #{number_or_name} not found"
+      end
+      ListObject.new(ole_listobject)
+    end
+
     # @private
     # returns true, if the worksheet object responds to VBA methods, false otherwise
     def alive?

data/lib/spec_helper.rb

@@ -2,7 +2,7 @@
 require 'rspec'
 require 'tmpdir'
 require 'fileutils'
-require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+require_relative '../lib/robust_excel_ole'
 
 # @private
 module RobustExcelOle::SpecHelpers

data/spec/address_tool_spec.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
-require File.expand_path( '../../lib/robust_excel_ole/base', __FILE__)
+require_relative 'spec_helper'
+require_relative '../lib/robust_excel_ole/base'
 
 $VERBOSE = nil
 

data/spec/base_spec.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
-require File.expand_path( '../../lib/robust_excel_ole/base', __FILE__)
+require_relative 'spec_helper'
+require_relative '../lib/robust_excel_ole/base'
 
 $VERBOSE = nil
 

data/spec/bookstore_spec.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require_relative 'spec_helper'
 
 =begin
 RSpec.configure do |config|

data/spec/cell_spec.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), './spec_helper')
+require_relative 'spec_helper'
 
 include RobustExcelOle
 include General

data/spec/cygwin_spec.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require File.join(File.dirname(__FILE__), './spec_helper')
+require_relative 'spec_helper'
 
 describe "on cygwin",  :if => RUBY_PLATFORM =~ /cygwin/ do
   describe ".cygpath" do

data/spec/excel_spec.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require_relative 'spec_helper'
 
 $VERBOSE = nil
 

data/spec/general_spec.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require File.join(File.dirname(__FILE__), './spec_helper')
+require_relative 'spec_helper'
 
 $VERBOSE = nil
 
@@ -34,6 +34,8 @@ module RobustExcelOle
       @simple_file_xlsx = @dir + '/workbook.xlsx'
       @network_path = "N:/data/workbook.xls"
       @hostname_share_path = "//DESKTOP-A3C5CJ6/spec/data/workbook.xls"
+      @network_path_downcase = "n:/data/workbook.xls"
+      @hostname_share_path_downcase = "//desktop-a3c5cj6/spec/data/workbook.xls"
       @simple_file_extern = "D:/data/workbook.xls"
       @hostname_share_path = "//DESKTOP-A3C5CJ6/spec/data/workbook.xls"
     end
@@ -43,6 +45,23 @@ module RobustExcelOle
       rm_tmp(@dir)
     end
 
+    describe "relace_umlauts, underscore" do
+
+      it "should" do
+        "ä".replace_umlauts.should == "ae"
+      end
+
+      it "should replace umlauts" do
+        new_word = "BeforeÄÖÜäöüßAfter".replace_umlauts
+        new_word.should == "BeforeAeOeUeaeoeuessAfter"
+      end
+
+      it "should underscore" do
+        "BeforeAfter".underscore.should == "before_after"
+      end
+
+    end
+
     describe "to_reo" do
 
       before do
@@ -269,6 +288,8 @@ module RobustExcelOle
           General.canonize(@network_path).should == @network_path
           General.canonize(@simple_file).should == @simple_file
           General.canonize(@simple_file_extern).should == @simple_file_extern
+          General.canonize(@hostname_share_path_downcase).should == @network_path
+          General.canonize(@network_path_downcase).should == @network_path_downcase
         end
 
       end
@@ -279,12 +300,18 @@ module RobustExcelOle
       it "should create a path" do
         path1 = "this" / "is" / "a" / "path"
         path1.should == "this/is/a/path"
-        path2 = "this" / "is" / "a" / "path" / 
-        #path2.should == "this/is/a/path/"
-        path3 = "this" / 
-        #path3.should == "this/"
-        path4 = "this" / nil
-        path4.should == "this"
+        path2 = "this" / nil
+        path2.should == "this"
+        path3 = "N:/E2" / "C:/gim/E2/workbook.xls"
+        path3.should == "C:/gim/E2/workbook.xls"
+        path4 = "N:/E2/" / "/gim/E2/workbook.xls"
+        path4.should == "/gim/E2/workbook.xls"
+        path5 = "N:/E2/" / "gim/E2/workbook.xls"
+        path5.should == "N:/E2/gim/E2/workbook.xls"
+        path6 = "N:/E2" / "spec/data/workbook.xls"
+        path6.should == "N:/E2/spec/data/workbook.xls"
+        path7 = "N:/E2" / "c:/gim/E2/workbook.xls"
+        path7.should == "c:/gim/E2/workbook.xls"
       end
     end