robust_excel_ole 1.27 → 1.32

data/lib/robust_excel_ole/general.rb

@@ -1,7 +1,213 @@
 # -*- coding: utf-8 -*-
+require 'pathname'
+
+module ToReoRefinement
+
+  refine WIN32OLE do
+
+    # type-lifting WIN32OLE objects to RobustExcelOle objects
+    def to_reo
+      General.main_classes_ole_types_and_recognising_methods.each do |classname, ole_type, methods|
+        if !::OLETYPE_JRUBY_BUG
+          if self.ole_type.name == ole_type
+            if classname != RobustExcelOle::Range
+              return classname.new(self)
+            elsif self.Rows.Count == 1 && self.Columns.Count == 1
+              return RobustExcelOle::Cell.new(self, self.Parent)
+            else
+              return RobustExcelOle::Range.new(self, self.Parent)
+            end
+          end
+        else
+          begin
+            recognising_method, no_method = methods
+            self.send(recognising_method)
+            unless no_method.nil?
+              begin
+                self.send(no_method[:no_method])
+                next
+              rescue NoMethodError
+                return classname.new(self)
+              end
+            end
+            if classname != RobustExcelOle::Range
+              return classname.new(self)
+            elsif self.Rows.Count == 1 && self.Columns.Count == 1
+              return RobustExcelOle::Cell.new(self, self.Parent)
+            else
+              return RobustExcelOle::Range.new(self, self.Parent)
+            end
+          rescue Java::OrgRacobCom::ComFailException => msg # NoMethodError
+            #if $!.message =~ /undefined method/ && 
+            #  main_classes_ole_types_and_recognising_methods.any?{ |_c, _o, recognising_method| $!.message.include?(recognising_method.to_s) }
+              next
+            #end 
+          end
+        end
+      end
+      raise RobustExcelOle::TypeREOError, "given object cannot be type-lifted to a RobustExcelOle object"
+    end
+
+  end
+end
+
+# @private
+class WIN32OLE
+
+  include Enumerable
+
+end
+
+# @private
+module FindAllIndicesRefinement
+
+  refine Array do
+
+    def find_all_indices elem
+      elem = elem.encode('utf-8') if elem.respond_to?(:gsub)      
+      found, index, result = -1, -1, []
+      while found
+        found = self[index+1..-1].index(elem)
+        if found
+          index = index + found + 1
+          result << index
+        end
+      end
+      result
+    end
+
+  end
+
+end
+
+TRANSLATION_TABLE = {
+      'ä' => 'ae', 'ö' => 'oe', 'ü' => 'ue', 'Ä' => 'Ae', 'Ö' => 'Oe', 'Ü' => 'Ue',
+      'ß' => 'ss', '²' => '2', '³' => '3'
+    }
+
+# @private
+module StringRefinement
+
+  refine String do
+
+    def / path_part
+      return path_part if empty?
+      return self if path_part.nil? || path_part.empty?
+      begin
+        path_part = path_part.strip
+        (path_part  =~ /^(\/|([A-Z]:\/))/i) ? path_part : (chomp('/') + '/' + path_part)
+      rescue TypeError
+        raise TypeError, "Only strings can be parts of paths (given: #{path_part.inspect} of class #{path_part.class})"
+      end
+    end    
+
+    def replace_umlauts
+      TRANSLATION_TABLE.inject(encode('utf-8')) { |word,(umlaut, replacement)| word.gsub(umlaut, replacement) }
+    end
+
+
+    # taken from http://apidock.com/rails/ActiveSupport/Inflector/underscore
+    def underscore
+      word = gsub('::', '/')
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      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)
+      names = split('::')
+
+      # Trigger a builtin NameError exception including the ill-formed constant in the message.
+      Object.const_get(self) if names.empty?
+
+      # Remove the first blank element in case of '::ClassName' notation.
+      names.shift if names.size > 1 && names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check it it's owned
+          # directly before we reach Object or the end of ancestors.
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name)
+
+            const
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name)
+        end
+      end
+    end
+  end
+end
+
+# @private
+module ParentRefinement
+
+  using StringRefinement
+
+  # taken from http://api.rubyonrails.org/v2.3.8/classes/ActiveSupport/CoreExtensions/Module.html#M000806
+  refine Module do
+
+    def parent_name
+      unless defined? @parent_name
+        @parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
+      end
+      @parent_name
+    end
+
+    def parent
+      parent_name ? parent_name.constantize : Object
+    end
+  end
+end
+
+class Integer
+
+  alias old_spaceship <=>
+
+  def <=> other
+    if other.is_a? Array
+      self <=> other.first
+    else
+      old_spaceship other
+    end
+  end
+
+end
+
+# @private
+class Array
+
+  alias old_spaceship <=>
+
+  def <=> other
+    # p other
+    if other.is_a? Integer
+      self <=> [other]
+    else
+      old_spaceship other
+    end
+  end
+
+end
+
 
 module General
 
+  using ToReoRefinement
+
   IS_JRUBY_PLATFORM = (RUBY_PLATFORM =~ /java/)
   ::EXPANDPATH_JRUBY_BUG    = IS_JRUBY_PLATFORM && true
   ::CONNECT_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
@@ -9,37 +215,30 @@ module General
   ::ERRORMESSAGE_JRUBY_BUG  = IS_JRUBY_PLATFORM && true
   ::CONNECT_EXCEL_JRUBY_BUG = IS_JRUBY_PLATFORM && true
   ::RANGES_JRUBY_BUG        = IS_JRUBY_PLATFORM && true
+  ::OLETYPE_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
 
   # @private
   NetworkDrive = Struct.new(:drive_letter, :network_name) do
 
-    def self.get_all(drives)
-      ndrives = []
+    def self.get_all_drives
+      network = WIN32OLE.new('WScript.Network')
+      drives = network.enumnetworkdrives
       count = drives.Count
-      (0..(count - 1)).step(2) do |i|
-        ndrives << NetworkDrive.new( drives.Item(i), drives.Item(i + 1).tr('\\','/'))
-      end
-      ndrives
+      (0..(count - 1)).step(2).map{ |i| NetworkDrive.new( drives.Item(i), drives.Item(i + 1).tr('\\','/')) }
     end
-
   end
 
   # @private
   def hostnameshare2networkpath(filename)
     return filename unless filename[0,2] == "//"
-    network = WIN32OLE.new('WScript.Network')
-    drives = network.enumnetworkdrives
-    network_drives = NetworkDrive.get_all(drives)
-    f_c = filename.dup
-    network_drive = network_drives.find do |d| 
-      e = f_c.sub!(d.network_name,d.drive_letter)
-      return e if e
+    NetworkDrive.get_all_drives.inject(filename) do |fn_modified, d| 
+      fn_modified.sub(/#{(Regexp.escape(d.network_name))}/i,d.drive_letter)
     end    
-    filename 
   end  
 
   # @private
-  def absolute_path(file)    
+  def absolute_path(file)
+    file = file.to_path if file.respond_to?(:to_path)
     return file if file[0,2] == "//" 
     file[0,2] = './' if ::EXPANDPATH_JRUBY_BUG && file  =~ /[A-Z]:[^\/]/
     file = File.expand_path(file)
@@ -64,40 +263,57 @@ module General
     path
   end
 
+  # @private
   def change_current_binding(current_object)
     Pry.change_current_binding(current_object)
   end
 
-  def class2method
-    [{Excel => :Hwnd},
-     {Workbook => :FullName},
-     {Worksheet => :UsedRange},
-     {RobustExcelOle::Range => :Row},
-     {ListObject => :ListRows}]
+  # @private
+  def main_classes_ole_types_and_recognising_methods
+    [[RobustExcelOle::Range     , 'Range'       , :Row],
+     [RobustExcelOle::Worksheet , '_Worksheet'  , :UsedRange],
+     [RobustExcelOle::Workbook  , '_Workbook'   , :FullName],
+     [RobustExcelOle::Excel     , '_Application', :Hwnd],
+     [RobustExcelOle::ListObject, 'ListObject' , :ListRows],
+     [RobustExcelOle::ListRow   , 'ListRow'    , [:Creator, :no_method => :Row]]]
   end
 
-
+  # @private
   # enable RobustExcelOle methods to Win32Ole objects
-  def uplift_to_reo
-    exclude_list = [:each, :inspect]
-    class2method.each do |element|
-      classname = element.first.first
-      method = element.first.last
-      classname.instance_methods(false).each do |inst_method|
-        if !exclude_list.include?(inst_method)
+  def init_reo_for_win32ole
+    main_classes_ole_types_and_recognising_methods.each do |classname, _ole_type, _recognising_method|
+      meths = (classname.instance_methods(false) - WIN32OLE.instance_methods(false) - Object.methods - Enumerable.instance_methods(false) - [:Calculation=])
+      meths.each do |inst_method|
+        if classname.method_defined?(inst_method)
           WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
-            self.to_reo.send(inst_method, *args, &blk) 
+            begin 
+              obj = to_reo                        
+            rescue
+              return self.send(inst_method.capitalize, *args, &blk)
+            end
+            obj.send(inst_method, *args, &blk)
+          end
+        else
+          WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
+            begin 
+              obj = classname.constantize.new(self)       
+            rescue
+              return self.send(inst_method.capitalize, *args, &blk)
+            end
+            obj.send(inst_method, *args, &blk) 
           end
         end
       end
     end
-    nil
   end
 
-  module_function :absolute_path, :canonize, :normalize, :change_current_binding, :class2method, :uplift_to_reo
+  module_function :absolute_path, :canonize, :normalize, :change_current_binding, 
+                  :main_classes_ole_types_and_recognising_methods, 
+                  :init_reo_for_win32ole, :hostnameshare2networkpath, :test
 
 end
 
+
 # @private
 class Pry
 
@@ -159,209 +375,6 @@ class Pry
   end
 end
 
-# @private
-class Integer
-
-  alias old_spaceship <=>
-
-  def <=> other
-    # p other
-    if other.is_a? Array
-      self <=> other.first
-    else
-      old_spaceship other
-    end
-  end
-
-end
-
-# @private
-class Array
-
-  alias old_spaceship <=>
-
-  def <=> other
-    # p other
-    if other.is_a? Integer
-      self <=> [other]
-    else
-      old_spaceship other
-    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
-
-  include Enumerable
-  
-  # type-lifting WIN32OLE objects to RobustExcelOle objects
-  def to_reo
-    General.class2method.each do |element|
-      classname = element.first.first
-      method = element.first.last
-      begin
-        self.send(method)
-        if classname == RobustExcelOle::Range && self.Rows.Count == 1 && self.Columns.Count == 1
-          return Cell.new(self, self.Parent)
-        else
-          return classname.new(self)
-        end
-      rescue
-        next
-      end
-    end
-    raise TypeREOError, "given object cannot be type-lifted to a RobustExcelOle object"
-  end
-
-=begin
-  def to_reo
-    case ole_type.name
-    when 'Range' then RobustExcelOle::Range.new(self)
-    when '_Worksheet' then RobustExcelOle::Worksheet.new(self)
-    when '_Workbook' then RobustExcelOle::Workbook.new(self)
-    when '_Application' then RobustExcelOle::Excel.new(self)
-    else
-      self
-    end
-  end
-=end
-
-=begin
-  alias method_missing_before_implicit_typelift method_missing 
-  
-  def method_missing(name, *args, &blk)
-    puts "method_missing:"
-    puts "name: #{name.inspect}"
-    #raise NoMethodError if name.to_s == "Hwnd" or name.to_s == "FullName" or name.to_s == "UsedRange" or name.to_s == "Row" or name.to_s == "ListRows"
-    begin
-      reo_obj = self.to_reo
-      puts "reo_obj: #{reo_obj.inspect}"
-    rescue
-      puts "$!.message: #{$!.message}"
-      method_missing_before_implicit_typelift(name, *args, &blk)
-    end
-    reo_obj.send(name, *args, &blk)
-  end
-=end
-
-end
-
-# @private
-class ::String 
-  def / path_part
-    if empty?
-      path_part
-    else
-      if path_part.nil? || path_part.empty?
-        self
-      else
-        begin
-          File.join self, path_part
-        rescue TypeError
-          raise TypeError, "Only strings can be parts of paths (given: #{path_part.inspect} of class #{path_part.class})"
-        end
-      end
-    end
-  end
-
-  # taken from http://apidock.com/rails/ActiveSupport/Inflector/underscore
-  def underscore
-    word = gsub('::', '/')
-    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    word.tr!('-', '_')
-    word.downcase!
-    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)
-    names = split('::')
-
-    # Trigger a builtin NameError exception including the ill-formed constant in the message.
-    Object.const_get(self) if names.empty?
-
-    # Remove the first blank element in case of '::ClassName' notation.
-    names.shift if names.size > 1 && names.first.empty?
-
-    names.inject(Object) do |constant, name|
-      if constant == Object
-        constant.const_get(name)
-      else
-        candidate = constant.const_get(name)
-        next candidate if constant.const_defined?(name)
-        next candidate unless Object.const_defined?(name)
-
-        # Go down the ancestors to check it it's owned
-        # directly before we reach Object or the end of ancestors.
-        constant = constant.ancestors.inject do |const, ancestor|
-          break const    if ancestor == Object
-          break ancestor if ancestor.const_defined?(name)
-
-          const
-        end
-
-        # owner is in Object, so raise
-        constant.const_get(name)
-      end
-    end
-  end
-end
-
-# taken from http://api.rubyonrails.org/v2.3.8/classes/ActiveSupport/CoreExtensions/Module.html#M000806
-# @private
-class Module
-  def parent_name
-    unless defined? @parent_name
-      @parent_name = name =~ /::[^:]+\Z/ ? $`.freeze : nil
-    end
-    @parent_name
-  end
-
-  def parent
-    parent_name ? parent_name.constantize : Object
-  end
-end
-
 module MethodHelpers
 
   # @private
@@ -382,5 +395,3 @@ module MethodHelpers
     end
   end
 end
-
-REO = RobustExcelOle