robust_excel_ole 1.29 → 1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ad362b2dfdd26980d413527196770cd2fb7a48b62120c2f760534c34b50f63
-  data.tar.gz: 40913cb74eebf1f37a60eb54d3cae2d9ceaabaf21c9a8ce29a16c8a90d10be0b
+  metadata.gz: 468109a0884d48ed77c70d9681d0067453aadfbd7294c6b152fb6457141bb98d
+  data.tar.gz: 2527cdd343eefb7325c077204203e1893d8e32f00830a8a6591669aba7ad43ec
 SHA512:
-  metadata.gz: 4ee1041c26230fbf1d0406f2a4a7ac31116f01c3e28c40aa05d15f7fd19c78dcf27ca812c345e7dfe9f0c6aa8acb1ca5b48856565ec337e82e2a81cc7420a69d
-  data.tar.gz: 5606ffb364e94adbfb5654ef146ce67127a302d237c85422eaf0ca4a58fac4d6113798fb155bf316af6e6430d7b90ab4bd8971d5481993daef323996ae3d3d8c
+  metadata.gz: 5637d87926eef9515335fb075add5cf4810cf97229c762f2b182fbdad42cae99f128c6a2ee253acbf29362c49005d579944e283e875aff4785df5220a6f0bff6
+  data.tar.gz: 59f015190d12c0a0b3c7e8016e6dd81da74ae5b760e166d0044a5b04dab5d0fb0b8fa295d13f66a30861a71867c921c2352119957b0543caeb467ecd881b3223

data/Changelog

@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.30] 2020-18-11
+
+## [1.29] 2020-05-11
+
+### Added
+  - Workbook.open can also take a Pathname object
+  - General#init_reo_for_win32ole
+
 ## [1.28] 2020-23-10
 
 ## [1.27] 2020-16-10

data/docs/README_open.rdoc

@@ -17,6 +17,11 @@ The semantics is similar to, e.g.,  +File.open+.
     # do something
   end
 
+You can provide the filename as a string (as above) or as Pathname object.
+
+  pathname = Pathname('spec/data/workbook.xls')
+  workbook = Workbook.open(pathname)
+
 The options are the following:
 
 +:default+:: if the workbook was already open, then use the properties of this workbook.otherwise use the properties stated in +:default+
@@ -195,12 +200,11 @@ The method +unobtrusively+ enables the user to read or modify a workbook, no mat
 
 Options are the following:
 
-+:if_closed+:: the Excel instance in which to open the workbook, if it was closed (default: +:current+). (Note: this option works workbooks opened via RobustExcelOle only.)
-
 +:read_only+:: Whether the workbook shall be forced to be open in ReadOnly mode
-+:writable+::  Whether changes in the workbook shall be saved
-
++:writable+::  Whether changes in the workbook shall be saved and the workbook shall be opened in ReadOnly mode by default (i.e., when the workbook was not open before) (default: true)
 +:keep_open+:: Whether the workbook shall be open after unobtrusively opening (default: false)
++:if_closed+:: the Excel instance in which to open the workbook, if it was closed (default: +:current+). 
+(Note: this option works workbooks opened via RobustExcelOle only.)
 
 There are the class method and the instance method of +unobtrusively+. Here is an example of the class method:
 

data/lib/robust_excel_ole/address_tool.rb

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 
-#using RefinedSpaceship
-
 module RobustExcelOle
 
   class AddressTool < Base

data/lib/robust_excel_ole/bookstore.rb

@@ -4,7 +4,7 @@ module RobustExcelOle
 
   # @private
   class Bookstore < Base
-    
+
     def initialize
       @filename2books ||= Hash.new { |hash, key| hash[key] = [] }
       @hidden_excel_instance = nil

data/lib/robust_excel_ole/excel.rb

@@ -15,6 +15,7 @@ module RobustExcelOle
   # See https://docs.microsoft.com/en-us/office/vba/api/excel.application(object)#methods
 
   class Excel < VbaObjects
+
     attr_reader :ole_excel
     attr_reader :properties
     attr_reader :address_tool
@@ -684,21 +685,7 @@ module RobustExcelOle
       # Win32API.new("user32","SetForegroundWindow","","I").call
       # end
     end
-
-    # returns the value of a range
-    # @param [String] name the name of a range
-    # @returns [Variant] the value of the range
-    def [] name
-      namevalue_glob(name)
-    end
-
-    # sets the value of a range
-    # @param [String]  name  the name of the range
-    # @param [Variant] value the contents of the range
-    def []=(name, value)
-      set_namevalue_glob(name, value)
-    end
-
+    
     # @private
     # returns active workbook
     def workbook
@@ -717,6 +704,9 @@ module RobustExcelOle
       to_s
     end
 
+    using ParentRefinement
+    using StringRefinement
+
     # @private
     def self.workbook_class  
       @workbook_class ||= begin

data/lib/robust_excel_ole/general.rb

@@ -1,4 +1,240 @@
 # -*- coding: utf-8 -*-
+require 'pathname'
+
+# @private
+module ToReoRefinement
+
+  refine WIN32OLE do
+
+    # 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
+
+  end
+
+end
+
+# @private
+class WIN32OLE
+
+  include Enumerable
+
+end
+
+# @private
+module FindAllIndicesRefinement
+
+  refine Array do
+
+    def find_all_indices elem
+      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
+
+# @private
+module StringRefinement
+
+  refine String do
+   
+    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
+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
+    # 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
+
+end
+
+
+=begin
+# @private
+module SpaceshipRefinement
+
+  refine Integer do
+
+    alias old_spaceship <=>
+
+    def <=> other
+      # p other
+      if other.is_a? Array
+        self <=> other.first
+      else
+        old_spaceship other
+      end
+    end
+  end
+
+  refine Array do
+
+    alias old_spaceship <=>
+
+    def <=> other
+      # p other
+      if other.is_a? Integer
+        self <=> [other]
+      else
+        old_spaceship other
+      end
+    end
+  end
+end
+=end
 
 module General
 
@@ -39,7 +275,8 @@ module General
   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)
@@ -76,6 +313,7 @@ module General
      {RobustExcelOle::ListObject => :ListRows}]
   end
 
+  using ToReoRefinement
 
   # enable RobustExcelOle methods to Win32Ole objects
   def init_reo_for_win32ole
@@ -160,228 +398,6 @@ class Pry
   end
 end
 
-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
-
-=begin
-# @private
-module RefinedSpaceship
-
-  refine Integer do
-
-    alias old_spaceship <=>
-
-    def <=> other
-      # p other
-      if other.is_a? Array
-        self <=> other.first
-      else
-        old_spaceship other
-      end
-    end
-  end
-
-  refine Array do
-
-    alias old_spaceship <=>
-
-    def <=> other
-      # p other
-      if other.is_a? Integer
-        self <=> [other]
-      else
-        old_spaceship other
-      end
-    end
-  end
-end
-=end
-
-# @private
-class Array
-
-  def find_all_indices elem
-    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
-
-# @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
-
-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