robust_excel_ole 1.22.2 → 1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60404c6338fa948418c3381d8f83b80147861694abd07956009fd332c923bc7
-  data.tar.gz: 1f50eae2f0c909a712563dd6ae2df38e45d9924ece79f1915987346bc3b6d1e1
+  metadata.gz: bf42835b0febd0db61ca5f87c473f63256d97d2dbaaf05cbe8b97be01fc6f17e
+  data.tar.gz: 81c4e849c1aceca218207e04577e8857098c1c68482c209515a79e2ead44c5ed
 SHA512:
-  metadata.gz: c5067ff3c58c8d9e83715db4cdba7ffd18305b27e77eb8e9b420f91fdffba784c6545453419e23af643372d1e16b2d328ef839ae7fb75b927611f235d2deab2c
-  data.tar.gz: 78080f4450242c98edb442d8a519ae2a0713fb3bedaf5fdb7500e8b9430856dace574f79d98bc45faedc72b0267bbf11e068d71a3e7dab2121a22c6188e70792
+  metadata.gz: 88fadf70ac1ec5fab7e133d21fe9a6e9f0ed5399fec3dd0d5198d9c639ebde470dde7f657778564c8a7b9a326fe6b0d177e3cfeca66c4f3642ca97fccfd9314e
+  data.tar.gz: 578aa3c80a722c10b2d4cdc390a45f1286775586fc58ac4c67dfe7dedb1da0939b4e79fea366bc6bf49034d9631f1b8cfaac3eb54c56b6dab3385f1811f86254

data/Changelog

@@ -1,8 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.27] 2020-20-10
+
+## [1.26] 2020-09-10
+
+### Added
+  - General#change_current_binding
+
+## [1.25] 2020-10-09]
+
+## [1.24] 2020-25-09
+
+## [1.23] 2020-02-09
+
 ## [1.22] 2020-10-08
 
+### Added
+  - Range#set_value
+
 ## [1.21] 2020-05-08
   
 ### Added

data/README.rdoc

@@ -64,7 +64,7 @@ If you want to start the console under jruby, and if you don't want to use a ver
  
  jreo
 
-The call of the console will include RobustExcelOle for you.
+The call of the console will include RobustExcelOle for you. The consoles require the ruby gem 'pry' and 'pry-bond' to enable the ruby shell 'pry' with filename and string completion. 
 
 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.
 
@@ -318,9 +318,28 @@ 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]
 
 
-=== More things
+=== More features
 
-You can convert some Win32Ole objects into a RobustExcelOle object.
+1. The method +General.change_current_binding+ allows to change the value of self within the current binding, while preserving the local variables, without starting another repl. Assume, +object+ shall be the self, then you would put
+
+  General.change_current_binding(object)
+
+Without this method, the ruby shell 'pry' allows to change the value of 'self' in the console as well, e.g. 
+
+  object.pry
+
+or
+
+  cd object
+
+However, this command also starts another pry repl (with another binding). Moreover, local variables in the previous binding are forgotten.
+
+
+2. The method +General.update_to_reo+ extends the class Win32Ole such that RobustExcelOle methods can be applied to Win32Ole objects. As mentioned above, the RobustExcelOle objects are wrapper of corresponding WIN32OLE objects. With help of +update_to_reo+ the RobustExcelOle objects and their wrapped Win32Ole objects are interchangeable. One example would be
+
+  range.ole_range.copy([4,3])
+
+Likewise it is possible to convert ("type-lift") Win32Ole objects into the corresponding RobustExcelOle object, using General.to_reo.
 
   range = sheet.Names.Item("firstcell").to_reo
 

data/bin/jreo

@@ -2,21 +2,18 @@
 # -*- jruby -*-
 
 require 'pry'
-require 'robust_excel_ole'
+require_relative '../lib/robust_excel_ole'
 
 include REO
 include General
 
 # some pry configuration
 Pry.config.windows_console_warning = false
-#Pry.config.history_save = true
 Pry.config.color = false
+Pry.config.prompt_name = "REO "
+
+#Pry.config.history_save = true
 #Pry.editor = 'notepad'  # 'subl', 'vi'
-#Pry.config.prompt =
-#[
-#->(_obj, _nest_level, _) { ">> " },
-#->(*) { "  " }
-#]
 
 hooks = Pry::Hooks.new
 

data/bin/reo

@@ -2,21 +2,18 @@
 # -*- ruby -*-
 
 require 'pry'
-require 'robust_excel_ole'
+require_relative '../lib/robust_excel_ole'
 
 include REO
 include General
 
 # some pry configuration
 Pry.config.windows_console_warning = false
-#Pry.config.history_save = true
 Pry.config.color = false
+Pry.config.prompt_name = "REO "
+
+#Pry.config.history_save = true
 #Pry.editor = 'notepad'  # 'subl', 'vi'
-#Pry.config.prompt =
-#[
-#->(_obj, _nest_level, _) { ">> " },
-#->(*) { "  " }
-#]
 
 hooks = Pry::Hooks.new
 

data/docs/README_ranges.rdoc

@@ -42,14 +42,18 @@ or
 
   range = worksheet.range(["A1:D3"])
 
-You can read the values by 
+You can also access a range from a workbook by providing the worksheet
+
+  range = workbook(workbook.sheet(1), [1..3,1..4])
+
+Now you can read the values by 
 
   range.Value
   => [["foo", "workbook", "sheet1", nil], ["foo", nil, "foobaaa", nil], ["matz", "is", "nice", nil]]
 
 or
 
-  range.v
+  range.value or range.v
   => [["foo", "workbook", "sheet1", nil], ["foo", nil, "foobaaa", nil], ["matz", "is", "nice", nil]]
 
 or as flat array
@@ -63,8 +67,20 @@ You can set values with help of range#Value or range#v, e.g.
 
 or 
 
+  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]]
 
+or
+
+  range.set_value([[1,2,3,4],[5,6,7,8],[9,10,11,12]])
+
+You can color the range when setting the contents of a range.
+
+  range.set_value([[1,2,3,4],[5,6,7,8],[9,10,11,12]], :color => 42)
+
 Now we copy the range. With help of VBA methods you would do
 
   range.Copy(:destination => sheet.range([4,5]).ole_range)
@@ -194,6 +210,10 @@ or
 
   range = worksheet.range([[1]..3,2..[4]])
 
+You can access a range also from a workbook by providing the respective worksheet
+
+  range = workbook(worksheet, [[1..3],2..[4]])
+
 You get the values of the range as flat array with help of
 
   range.values
@@ -202,6 +222,10 @@ You can access a range via its defined name with
 
   range = worksheet.range("name")
 
+or
+
+  range = workbook(worksheet, "name")
+
 === Copying a range
 
 Let's assume, you have a source range
@@ -310,10 +334,6 @@ You can color the range when setting the contents of a range.
 
   workbook.set_namevalue_glob("name", "new_value", :color => 4)
 
-The method []= sets the contents of a range and colors the range via some default color.
-
-  workbook["name"] = "new_value"
-
 Similarly, the contents of a named range can be read and modified in a worksheet
 
   worksheet = workbook.sheet(1)

data/docs/README_sheet.rdoc

@@ -97,7 +97,7 @@ The method Worksheet#values yields all cell values of the used range of the work
   worksheet.values
   => [["foo", "workbook", "sheet1"], ["foo", nil, "foobaaa"], ["matz", "is", "nice"]]
 
-The method Worksheet#each_rowvalue provides enable to access the values of each row.
+The method Worksheet#each_rowvalue enables to access the values of each row.
 
   worksheet.each_rowvalue do |row_values|
     # do something with the row_values

data/lib/reo_console.rb

@@ -6,14 +6,29 @@ include General
 
 # some pry configuration
 Pry.config.windows_console_warning = false
-#Pry.config.history_save = true
 Pry.config.color = false
+Pry.config.prompt_name = "REO "
+
+#Pry.config.history_save = true
 #Pry.editor = 'notepad'  # 'subl', 'vi'
-#Pry.config.prompt =
-#[
-#->(_obj, _nest_level, _) { ">> " },
-#->(*) { "  " }
-#]
+
+prompt_proc1 = proc { |target_self, nest_level, pry|
+   "[#{pry.input_ring.count}] #{pry.config.prompt_name}(#{Pry.view_clip(target_self.inspect)})#{":#{nest_level}" unless nest_level.zero?}> "
+ }
+
+prompt_proc2 =  proc { |target_self, nest_level, pry|
+  "[#{pry.input_ring.count}] #{pry.config.prompt_name}(#{Pry.view_clip(target_self.inspect)})#{":#{nest_level}" unless nest_level.zero?}* "
+ }
+
+Pry.config.prompt = if RUBY_PLATFORM =~ /java/
+  [prompt_proc1, prompt_proc2]
+else
+  Pry::Prompt.new(
+    "REO",
+    "The RobustExcelOle Prompt. Besides the standard information it puts the current object",
+    [prompt_proc1, prompt_proc2]
+    )
+end
 
 hooks = Pry::Hooks.new
 
@@ -21,4 +36,7 @@ hooks.add_hook :when_started, :hook12 do
 puts 'REO console started'
 puts
 end
+
+General.uplift_to_reo
+
 Pry.start(nil, hooks: hooks)

data/lib/robust_excel_ole.rb

@@ -18,5 +18,5 @@ 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')
 
-include RobustExcelOle
+#include RobustExcelOle
 include General

data/lib/robust_excel_ole/base.rbs

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+LOG_TO_STDOUT: Boolean = false        
+REO_LOG_DIR: String   
+REO_LOG_FILE: String  
+
+class String 
+  
+  def end_with? : (suffixes: Array[String]) -> String
+
+end
+
+module RobustExcelOle
+
+  class VBAMethodMissingError < RuntimeError 
+  end
+
+  class REOError < RuntimeError                    
+  end
+
+  class ExcelREOError < REOError                   
+  end
+
+  class WorkbookREOError < REOError                
+  end
+
+  class WorksheetREOError < REOError                   
+  end
+
+  class FileREOError < REOError                    
+  end
+
+  class NamesREOError < REOError                   
+  end
+
+  class MiscREOError < REOError                    
+  end
+
+  class TypeREOError < REOError                    
+  end
+
+  # @private
+  class UnexpectedREOError < REOError              
+  end
+
+  # @private
+  class NotImplementedREOError < REOError          
+  end
+    
+
+  class Base
+
+    def own_methods -> Array[Symbol]
+
+    def self.tr1: (_text1: String) -> void
+
+    def self.trace: (text: String) -> void
+
+    def self.puts_hash: (hash: Hash) -> void
+
+  end
+
+end

data/lib/robust_excel_ole/cell.rb

@@ -12,14 +12,17 @@ module RobustExcelOle
       ole_cell
     end
 
-    def v
+    def value
       self.Value
     end
 
-    def v=(value)
+    def value=(value)
       self.Value = value
     end
 
+    alias_method :v, :value
+    alias_method :v=, :value=
+
     # @private
     def ole_cell
       @ole_range = @ole_range.MergeArea.Item(1,1) if @ole_range.MergeCells

data/lib/robust_excel_ole/cell.rbs

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  class Cell < Range
+
+    def initialize: (win32_cell: WIN32OLE, worksheet: Worksheet) -> void     
+
+    def value -> String
+
+    def value= (value: Variant) -> Variant
+
+    def v -> String
+    
+    def v= (value: Variant) -> Variant
+
+    def ole_cell -> WIN32OLE | void
+
+    def to_s -> String   
+
+    def inspect -> String 
+
+  end
+
+end

data/lib/robust_excel_ole/excel.rb

@@ -76,7 +76,7 @@ module RobustExcelOle
       end
       connected = (not ole_xl.nil?) && win32ole_excel.nil?
       ole_xl ||= WIN32OLE.new('Excel.Application')
-      hwnd = ole_xl.HWnd
+      hwnd = ole_xl.Hwnd
       stored = hwnd2excel(hwnd)
       if stored && stored.alive?
         result = stored
@@ -297,7 +297,7 @@ module RobustExcelOle
       finishing_living_excel = alive?
       if finishing_living_excel
         hwnd = (begin
-                  @ole_excel.HWnd
+                  @ole_excel.Hwnd
                 rescue
                   nil
                 end)
@@ -370,7 +370,7 @@ module RobustExcelOle
       number = 0
       WIN32OLE.connect('winmgmts:\\\\.').InstancesOf('win32_process').each do |p|
         begin
-          if p.name == 'EXCEL.EXE'
+          if p.Name == 'EXCEL.EXE'
             Process.kill('KILL', p.processid)
             number += 1
           end
@@ -384,7 +384,7 @@ module RobustExcelOle
 
     def self.excels_number
       processes = WIN32OLE.connect('winmgmts:\\\\.').InstancesOf('win32_process')
-      processes.select { |p| p.name == 'EXCEL.EXE' }.size
+      processes.select { |p| p.Name == 'EXCEL.EXE' }.size
     end
 
     def self.known_excels_number
@@ -417,7 +417,7 @@ module RobustExcelOle
           result.Visible # send any method, just to see if it responds
         rescue
           trace 'dead excel ' + (begin
-                                 "Window-handle = #{result.HWnd}"
+                                 "Window-handle = #{result.Hwnd}"
                                  rescue
                                  'without window handle'
                                  end)
@@ -471,13 +471,13 @@ module RobustExcelOle
         pid2excel[pid] = excel
       end
       processes = WIN32OLE.connect('winmgmts:\\\\.').InstancesOf('win32_process')
-      processes.select { |p| Excel.new(pid2excel[p.processid]) if p.name == 'EXCEL.EXE' && pid2excel.include?(p.processid) }
+      processes.select { |p| Excel.new(pid2excel[p.ProcessId]) if p.Name == 'EXCEL.EXE' && pid2excel.include?(p.ProcessId) }
       result = []
       processes.each do |p|
-        next unless p.name == 'EXCEL.EXE'
+        next unless p.Name == 'EXCEL.EXE'
 
-        if pid2excel.include?(p.processid)
-          excel = pid2excel[p.processid]
+        if pid2excel.include?(p.ProcessId)
+          excel = pid2excel[p.ProcessId]
           result << excel
         end
         # how to connect to an (interactively opened) Excel instance and get a WIN32OLE object?
@@ -640,13 +640,8 @@ module RobustExcelOle
     # set options in this Excel instance
     def for_this_instance(options)
       set_options(options)
-      #self.class.new(@ole_excel, options)
     end
 
-    #def set_options(options)
-    #  for_this_instance(options)
-    #end  
-
     def set_options(options)      
       @properties ||= { }
       PROPERTIES.each do |property|

data/lib/robust_excel_ole/general.rb

@@ -3,14 +3,14 @@
 module General
 
   IS_JRUBY_PLATFORM = (RUBY_PLATFORM =~ /java/)
-  ::EXPANDPATH_JRUBY_BUG   = IS_JRUBY_PLATFORM && true
-  ::CONNECT_JRUBY_BUG      = IS_JRUBY_PLATFORM && true
-  ::COPYSHEETS_JRUBY_BUG   = IS_JRUBY_PLATFORM && true
-  ::ERRORMESSAGE_JRUBY_BUG = IS_JRUBY_PLATFORM && true
-  ::CONNECT_EXCEL_JRUBY_BUG      = IS_JRUBY_PLATFORM && true
-  ::RANGES_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
-
-  @private
+  ::EXPANDPATH_JRUBY_BUG    = IS_JRUBY_PLATFORM && true
+  ::CONNECT_JRUBY_BUG       = IS_JRUBY_PLATFORM && true
+  ::COPYSHEETS_JRUBY_BUG    = IS_JRUBY_PLATFORM && true
+  ::ERRORMESSAGE_JRUBY_BUG  = IS_JRUBY_PLATFORM && true
+  ::CONNECT_EXCEL_JRUBY_BUG = IS_JRUBY_PLATFORM && true
+  ::RANGES_JRUBY_BUG        = IS_JRUBY_PLATFORM && true
+
+  # @private
   NetworkDrive = Struct.new(:drive_letter, :network_name) do
 
     def self.get_all(drives)
@@ -24,7 +24,7 @@ module General
 
   end
 
-  @private
+  # @private
   def hostnameshare2networkpath(filename)
     return filename unless filename[0,2] == "//"
     network = WIN32OLE.new('WScript.Network')
@@ -44,7 +44,7 @@ module General
     file[0,2] = './' if ::EXPANDPATH_JRUBY_BUG && file  =~ /[A-Z]:[^\/]/
     file = File.expand_path(file)
     file = RobustExcelOle::Cygwin.cygpath('-w', file) if RUBY_PLATFORM =~ /cygwin/
-    WIN32OLE.new('Scripting.FileSystemObject').GetAbsolutePathName(file).tr('/','\\')
+    WIN32OLE.new('Scripting.FileSystemObject').GetAbsolutePathName(file) #.tr('/','\\')
   end
 
   # @private
@@ -64,8 +64,99 @@ module General
     path
   end
 
-  module_function :absolute_path, :canonize, :normalize
+  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}]
+  end
+
+
+  # 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)
+          WIN32OLE.send(:define_method, inst_method) do |*args, &blk|  
+            self.to_reo.send(inst_method, *args, &blk) 
+          end
+        end
+      end
+    end
+    nil
+  end
+
+  module_function :absolute_path, :canonize, :normalize, :change_current_binding, :class2method, :uplift_to_reo
+
+end
+
+# @private
+class Pry
+
+  # change the current binding such that self is the current object in the pry-instance, 
+  # preserve the local variables
+
+  class << self
+    attr_accessor :pry_instance
+  end
+
+  def self.change_current_binding(current_object)
+    pry_instance = self.pry_instance
+    old_binding = pry_instance.binding_stack.pop
+    pry_instance.push_binding(current_object.__binding__)
+    exclude_vars = [:__, :_, :_dir, :_dir_, :_file, :_file_, :_in_, :_out_, :_ex, :_ex_, :pry_instance]
+    old_binding.local_variables.each do |var|
+      pry_instance.add_sticky_local(var) {old_binding.local_variable_get(var)} unless exclude_vars.include?(var)
+    end
+    self.pry_instance = pry_instance
+    nil
+  end
 
+  def push_initial_binding(target = nil)
+    # memorize the current pry instance
+    self.class.pry_instance = self 
+    push_binding(target || Pry.toplevel_binding)
+  end
+
+  class REPL
+
+    def read
+      @indent.reset if pry.eval_string.empty?
+      current_prompt = pry.select_prompt
+      indentation = pry.config.auto_indent ? @indent.current_prefix : ''
+      val = read_line("#{current_prompt}#{indentation}")
+      # Return nil for EOF, :no_more_input for error, or :control_c for <Ctrl-C>
+      return val unless val.is_a?(String)
+      if pry.config.auto_indent
+        original_val = "#{indentation}#{val}"
+        indented_val = @indent.indent(val)
+
+        if output.tty? &&
+           pry.config.correct_indent &&
+           Pry::Helpers::BaseHelpers.use_ansi_codes?
+          # avoid repeating read line
+
+          #output.print @indent.correct_indentation(
+          #  current_prompt,
+          #  indented_val,
+          #  calculate_overhang(current_prompt, original_val, indented_val)
+          #)
+          output.flush
+        end
+      else
+        indented_val = val
+      end
+      indented_val
+    end
+  end
 end
 
 # @private
@@ -118,14 +209,7 @@ class WIN32OLE
   
   # type-lifting WIN32OLE objects to RobustExcelOle objects
   def to_reo
-    class2method = [
-      {Excel => :Hwnd},
-      {Workbook => :FullName},
-      {Worksheet => :UsedRange},
-      {RobustExcelOle::Range => :Row},
-      {ListObject => :ListRows}
-    ]
-    class2method.each do |element|
+    General.class2method.each do |element|
       classname = element.first.first
       method = element.first.last
       begin
@@ -142,16 +226,37 @@ class WIN32OLE
     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 xx_method_missing(name, *args, &blk)
+  
+  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
@@ -276,7 +381,6 @@ module MethodHelpers
       super
     end
   end
-
 end
 
 REO = RobustExcelOle

data/lib/robust_excel_ole/list_object.rb

@@ -17,23 +17,30 @@ module RobustExcelOle
     alias ole_object ole_table
 
     # constructs a list object (or table).
-    # @param [Variable] worksheet_or_ole_listobject  a worksheet or a Win32Ole list object
+    # @param [Variable] worksheet_or_listobject      a worksheet or a 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 = "",
+    def initialize(worksheet_or_listobject,
+                   table_name_or_number = "_table_name",
                    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
+
+      # ole_table is being assigned to the first parameter, if this parameter is a ListObject
+      # otherwise the first parameter could be a worksheet, and get the ole_table via the ListObject name or number
+      @ole_table = if worksheet_or_listobject.respond_to?(:ListRows)
+        worksheet_or_listobject.ole_table
       else
-        @worksheet = worksheet_or_ole_listobject.to_reo
-        @ole_table = @worksheet.ListObjects.Item(table_name_or_number) rescue nil
+        begin
+          worksheet_or_listobject.send(:ListRows)
+          worksheet_or_listobject
+        rescue
+          @worksheet = worksheet_or_listobject.to_reo
+          @worksheet.ListObjects.Item(table_name_or_number) rescue nil
+        end
       end
       unless @ole_table
         columns_count = 
@@ -52,6 +59,7 @@ module RobustExcelOle
         end
       end
 
+
       ole_table = @ole_table
       @row_class = Class.new(ListRow) do
 

data/lib/robust_excel_ole/range.rb

@@ -5,7 +5,7 @@ module RobustExcelOle
   # This class essentially wraps a Win32Ole Range object. 
   # You can apply all VBA methods (starting with a capital letter) 
   # that you would apply for a Range object. 
-  # See https://docs.microsoft.com/en-us/office/vba/api/excel.worksheet#methods
+  # See https://docs.microsoft.com/en-us/office/vba/api/excel.range#methods
 
   class Range < VbaObjects
 
@@ -70,7 +70,9 @@ module RobustExcelOle
       end
     end
 
-    def v
+    # returns flat array of the values of a given range
+    # @returns [Array] values of the range (as a nested array)    
+    def value
       begin
         if !::RANGES_JRUBY_BUG
           self.Value
@@ -89,7 +91,9 @@ module RobustExcelOle
 
     end
 
-    def v=(value)
+    # sets the values if the range
+    # @param [Variant] value
+    def value=(value)
       begin
         if !::RANGES_JRUBY_BUG
           ole_range.Value = value
@@ -102,12 +106,33 @@ module RobustExcelOle
         end
         value
       rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException => msg  
-        raise RangeNotEvaluatable, "cannot assign value to range #{address_r1c1.inspect}"
+        raise RangeNotEvaluatable, "cannot assign value to range #{self.inspect}"
       end
     end
 
-    alias_method :value, :v
-    alias_method :value=, :v=
+    alias_method :v, :value
+    alias_method :v=, :value=
+
+    # sets the values if the range with a given color
+    # @param [Variant] value
+    # @option opts [Symbol] :color the color of the cell when set
+    def set_value(value, opts = { })
+      begin
+        if !::RANGES_JRUBY_BUG
+          ole_range.Value = value
+        else
+          rows.each_with_index do |r,i|
+            columns.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
+        ole_range.Interior.ColorIndex = opts[:color] unless opts[:color].nil?
+        value
+      rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException => msg  
+        raise RangeNotEvaluatable, "cannot assign value to range #{self.inspect}"
+      end
+    end
 
     # copies a range
     # @params [Address or Address-Array] address or upper left position of the destination range
@@ -189,12 +214,11 @@ module RobustExcelOle
     # @private
     def to_s
       "#<REO::Range: " + "#{@ole_range.Address('External' => true).gsub(/\$/,'')} " + ">"
-      # "#<REO::Range: " + "#{@ole_range.Address.gsub(/\$/,'')} " + "#{worksheet.Name} " + ">"
     end
 
     # @private
     def inspect
-      to_s # [0..-2] + "#{worksheet.workbook.Name} " + ">"
+      to_s
     end
 
     # @private

data/lib/robust_excel_ole/range_owners.rb

@@ -62,7 +62,7 @@ module RobustExcelOle
     # sets the contents of a range
     # @param [String]  name  the name of a range
     # @param [Variant] value the contents of the range
-    # @option opts [Symbol] :color the color of the cell when set
+    # @option opts [Symbol] :color the color of the range when set
     def set_namevalue_glob(name, value, opts = { }) 
       begin
         name_obj = begin
@@ -177,36 +177,10 @@ module RobustExcelOle
     end
 
     # creates a range from a given defined name or address
-    # range(address) does work for Worksheet objects only
-    # @params [Variant] range name or address
+    # @params [Variant] defined name or address, and optional a worksheet
     # @return [Range] a range
-    def range(name_or_address, address2 = :__not_provided)
-      begin
-        worksheet = self if self.is_a?(Worksheet)
-        if address2 == :__not_provided
-          range = if name_or_address.is_a?(String)
-            begin
-              RobustExcelOle::Range.new(name_object(name_or_address).RefersToRange, worksheet) 
-            rescue NameNotFound
-              nil
-            end
-          end
-        end
-        if self.is_a?(Worksheet) && (range.nil? || (address2 != :__not_provided))
-          address = name_or_address
-          address = [name_or_address,address2] unless address2 == :__not_provided         
-          self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
-          range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange, worksheet)
-          self.Names.Item('__dummy001').Delete
-          workbook = self.is_a?(Workbook) ? self : self.workbook
-          workbook.save
-          range                    
-        end
-      rescue WIN32OLERuntimeError, Java::OrgRacobCom::ComFailException
-        address2_string = address2.nil? ? "" : ", #{address2.inspect}"
-        raise RangeNotCreated, "cannot create range (#{name_or_address.inspect}#{address2_string})"
-      end      
-      range
+    def range(*args)
+      raise RangeNotCreated, "not yet implemented"
     end
 
     def name2range(name)   # :deprecated: #

data/lib/robust_excel_ole/vba_objects.rbs

@@ -0,0 +1,23 @@
+
+# -*- coding: utf-8 -*-
+
+module RobustExcelOle
+
+  class VbaObjects < Base
+
+    def to_reo -> VbaObjects
+
+    def address_tool -> AddressTool
+
+  end
+
+  class RangeNotEvaluatable < MiscREOError         
+  end
+
+  class OptionInvalid < MiscREOError               
+  end
+
+  class ObjectNotAlive < MiscREOError              
+  end
+
+end

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.22.2"
+  VERSION = "1.27"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -882,6 +882,24 @@ module RobustExcelOle
       worksheet_class.new(@ole_workbook.Worksheets.Item(1))
     end
 
+    # creates a range from a given defined name or from a given worksheet and address
+    # @params [Variant] defined name or a worksheet
+    # @params [Address] address
+    # @return [Range] a range
+    def range(name_or_worksheet, name_or_address = :__not_provided, address2 = :__not_provided)
+      if name_or_worksheet.respond_to?(:gsub)
+        name = name_or_worksheet
+        RobustExcelOle::Range.new(name_object(name).RefersToRange)
+      else 
+        begin 
+          worksheet = name_or_worksheet.to_reo
+          worksheet.range(name_or_address, address2)
+        rescue
+          raise RangeNotCreated, "argument error: a defined name or a worksheet and an address must be provided"
+        end          
+      end
+    end
+
     # returns the value of a range
     # @param [String] name the name of a range
     # @returns [Variant] the value of the range

data/lib/robust_excel_ole/worksheet.rb

@@ -64,7 +64,7 @@ module RobustExcelOle
       end
     end
 
-    # a cell given the defined name or row and column
+    # returns a cell given the defined name or row and column
     # @params row, column, or name
     # @returns cell, if row and column are given
     def [] p1, p2 = :__not_provided
@@ -118,19 +118,6 @@ module RobustExcelOle
       end
     end
 
-=begin
-    def cellval(x,y)
-      xy = "#{x}_#{y}"
-      @cells = { }
-      begin
-        @cells[xy] ||= RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
-        @cells[xy].Value
-      rescue
-        raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
-      end
-    end
-=end
-
     # sets the value of a cell, if row, column and color of the cell are given
     # @params [Integer] x,y row and column
     # @option opts [Symbol] :color the color of the cell when set
@@ -226,6 +213,31 @@ module RobustExcelOle
         self.Name == other_worksheet.Name
     end
 
+    # creates a range from a given defined name or address
+    # @params [Variant] defined name or address
+    # @return [Range] a range
+    def range(name_or_address, address2 = :__not_provided)
+      if name_or_address.respond_to?(:gsub) && address2 == :__not_provided
+        name = name_or_address
+        range = RobustExcelOle::Range.new(name_object(name).RefersToRange, self) rescue nil
+      end
+      unless range
+        address = name_or_address
+        address = [name_or_address,address2] unless address2 == :__not_provided         
+        workbook.retain_saved do
+          begin
+            self.Names.Add('__dummy001',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))          
+            range = RobustExcelOle::Range.new(name_object('__dummy001').RefersToRange, self)
+            self.Names.Item('__dummy001').Delete
+          rescue
+            address2_string = address2.nil? ? "" : ", #{address2.inspect}"
+            raise RangeNotCreated, "cannot create range (#{name_or_address.inspect}#{address2_string})"
+          end
+        end
+      end
+      range
+    end
+
     # @private
     # returns true, if the worksheet object responds to VBA methods, false otherwise
     def alive?
@@ -258,7 +270,7 @@ module RobustExcelOle
 
     # @private
     def inspect  
-      self.to_s[0..-2] + "#{workbook.Name} " + ">"
+      to_s
     end
 
     include MethodHelpers

data/robust_excel_ole.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_runtime_dependency "pry", '>= 0.12.1'
+  s.add_runtime_dependency "pry-bond", '>=0.0.1'
   s.add_development_dependency "rspec", '>= 2.6.0'
   s.required_ruby_version = '>= 2.1'
 end

data/spec/general_spec.rb

@@ -96,6 +96,34 @@ module RobustExcelOle
 
     end
 
+    describe "General.uplift_to_reo" do
+
+      before do
+        @book1 = Workbook.open(@simple_file, :visible => true)
+      end
+
+      it "should apply reo-methods to win32ole objects" do
+        General.uplift_to_reo  
+        ole_book1 = @book1.ole_workbook
+        sheet1 = ole_book1.sheet(1)
+        sheet1.should be_a Worksheet
+        sheet1.name.should == "Sheet1"
+        ole_sheet1 = sheet1.ole_worksheet
+        range1 = ole_sheet1.range([1..2,3..4])
+        range1.should be_a RobustExcelOle::Range
+        range1.value.should == [["sheet1",nil],["foobaaa",nil]]
+        ole_range1 = range1.ole_range
+        ole_range1.copy([6,6])
+        range2 = sheet1.range([6..7,6..7])
+        range2.value.should == [["sheet1",nil],["foobaaa",nil]]
+        excel1 = @book1.excel
+        ole_excel1 = excel1.ole_excel
+        ole_excel1.close(:if_unsaved => :forget)
+        Excel.kill_all
+      end
+
+    end
+
     describe "methods, own_methods, respond_to?" do
 
       before do

data/spec/list_object_spec.rb

@@ -41,6 +41,13 @@ describe ListObject do
         @sheet[1,1].Value.should == "Person"
       end
 
+      it "should do the idempotence" do
+        ole_table = @sheet.ListObjects.Item(1)
+        table = Table.new(ole_table)
+        table2 = Table.new(table)
+        table2.ole_table.should be_a WIN32OLE
+      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)
@@ -330,8 +337,6 @@ describe ListObject do
       cells[0].Column.should == 8
       cells[1].Row.should == 9
       cells[1].Column.should == 6
-      puts "cells[0]: #{[cells[0]]}"
-      p "cells[0]: #{[cells[0]]}"
     end
   
   end

data/spec/range_spec.rb

@@ -177,9 +177,9 @@ describe RobustExcelOle::Range do
     end
   end
 
-  describe "#v" do
+  describe "#value" do
 
-    context "v, v=" do
+    context "value, value=" do
 
       before do
         @sheet1 = @book.sheet(1)
@@ -207,6 +207,12 @@ describe RobustExcelOle::Range do
         @sheet1.range([1..2,3..5]).v = [[1,2,3],[4,5,6]]
         @sheet1.range([1..2,3..5]).v.should == [[1,2,3],[4,5,6]]
       end
+
+      it "should color the range" do
+        @sheet1.range([1..2,3..5]).set_value([[1,2,3],[4,5,6]],:color => 42)
+        @sheet1.range([1..2,3..5]).Interior.ColorIndex.should == 42
+      end
+
     end
   end
 

data/spec/workbook_specs/workbook_misc_spec.rb

@@ -1096,6 +1096,16 @@ describe Workbook do
         range.Address.should == "$A$1:$D$3"
       end
 
+      it "should raise error when given integer range" do
+        expect{
+          @book1.range([1..2,3..4])
+        }.to raise_error(RangeNotCreated, /argument/)
+      end
+
+      it "should accept an integer range when given a worksheet" do
+        @book1.range(@book1.sheet(1),[4..5,1..2]).Address.should == "$A$4:$B$5"
+      end
+
     end
 
     context "adding and deleting the name of a range" do

data/spec/worksheet_spec.rb

@@ -19,6 +19,7 @@ describe Worksheet do
   before do
     @dir = create_tmpdir
     @simple_file = @dir + '/workbook.xls'
+    @another_workbook = @dir + '/another_workbook.xls'
     @protected_file = @dir + '/protected_sheet.xls'
     @blank_file = @dir + '/book_with_blank.xls'
     @merge_file = @dir + '/merge_cells.xls'
@@ -207,11 +208,13 @@ describe Worksheet do
     describe "range" do
 
       it "should a range with relative r1c1-reference" do
+        @sheet.range([1,1]).Select
         @sheet.range(["Z1S[3]:Z[2]S8"]).Address.should == "$D$1:$H$3"
         @sheet.range(["Z1S3:Z2S8"]).Address.should == "$C$1:$H$2"
       end
 
       it "should a range with relative integer-range-reference" do
+        @sheet.range([1,1]).Select
         @sheet.range([1..[2],[3]..8]).Address.should == "$D$1:$H$3"
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: 1.22.2
+  version: '1.27'
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: pry-bond
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,13 +126,14 @@ files:
 - examples/open_save_close/example_reuse.rb
 - examples/open_save_close/example_simple.rb
 - examples/open_save_close/example_unobtrusively.rb
-- jreo.bat
 - lib/reo_console.rb
 - lib/robust_excel_ole.rb
 - lib/robust_excel_ole/address_tool.rb
 - lib/robust_excel_ole/base.rb
+- lib/robust_excel_ole/base.rbs
 - lib/robust_excel_ole/bookstore.rb
 - lib/robust_excel_ole/cell.rb
+- lib/robust_excel_ole/cell.rbs
 - lib/robust_excel_ole/cygwin.rb
 - lib/robust_excel_ole/excel.rb
 - lib/robust_excel_ole/general.rb
@@ -128,11 +143,11 @@ files:
 - lib/robust_excel_ole/robustexcelole.sublime-project
 - lib/robust_excel_ole/robustexcelole.sublime-workspace
 - lib/robust_excel_ole/vba_objects.rb
+- lib/robust_excel_ole/vba_objects.rbs
 - lib/robust_excel_ole/version.rb
 - lib/robust_excel_ole/workbook.rb
 - lib/robust_excel_ole/worksheet.rb
 - lib/spec_helper.rb
-- reo.bat
 - robust_excel_ole.gemspec
 - spec/address_tool_spec.rb
 - spec/base_spec.rb

data/jreo.bat

@@ -1,3 +0,0 @@
-@echo off
-
-jruby lib/reo_console.rb

data/reo.bat

@@ -1,3 +0,0 @@
-@echo off
-
-ruby lib/reo_console.rb