robust_excel_ole 1.26 → 1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2553a7622f9092b5067ad3f7e945d57a1dbfa6e540716b326c6b684a351cf79
-  data.tar.gz: e623c4a2f3e22ef1da88b6475d7f6dc277c9f3f4581db27427fd9ca6aa400f24
+  metadata.gz: bf42835b0febd0db61ca5f87c473f63256d97d2dbaaf05cbe8b97be01fc6f17e
+  data.tar.gz: 81c4e849c1aceca218207e04577e8857098c1c68482c209515a79e2ead44c5ed
 SHA512:
-  metadata.gz: 9056cec7af1bf9c6c04ab2df83dd080bb63308f5c5a7d6af13286090d357441928d7dcb2dde2371940e36729fafb26460098d2063254f8809796a9dde87ddc85
-  data.tar.gz: d036c741ef593695e0fecfd8f1e34b1db5bec0e7e2430b5a88f1e16a297a804b1a9d95c8bc847bc993f0a1ea4b666cd56db200cc9cdfec38078dab6c5b4ef59b
+  metadata.gz: 88fadf70ac1ec5fab7e133d21fe9a6e9f0ed5399fec3dd0d5198d9c639ebde470dde7f657778564c8a7b9a326fe6b0d177e3cfeca66c4f3642ca97fccfd9314e
+  data.tar.gz: 578aa3c80a722c10b2d4cdc390a45f1286775586fc58ac4c67dfe7dedb1da0939b4e79fea366bc6bf49034d9631f1b8cfaac3eb54c56b6dab3385f1811f86254

data/Changelog

@@ -1,6 +1,8 @@
 # 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

data/README.rdoc

@@ -320,7 +320,11 @@ For more details about reading and writing contents of cells and ranges see {REA
 
 === More features
 
-The ruby shell 'pry' allows, among other useful things, to change the value of 'self' in the console. For example,
+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
 
@@ -328,13 +332,14 @@ or
 
   cd object
 
-will set +object+ to self. However, this command also starts another pry repl (with another binding). Moreover, local variables in the previous binding are forgotten.
+However, this command also starts another pry repl (with another binding). Moreover, local variables in the previous binding are forgotten.
+
 
-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. 
+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
 
-  General.change_current_binding
+  range.ole_range.copy([4,3])
 
-You can convert some Win32Ole objects into a RobustExcelOle object.
+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,7 +2,7 @@
 # -*- jruby -*-
 
 require 'pry'
-require '../robust_excel_ole/lib/robust_excel_ole'
+require_relative '../lib/robust_excel_ole'
 
 include REO
 include General

data/bin/reo

@@ -2,7 +2,7 @@
 # -*- ruby -*-
 
 require 'pry'
-require '../robust_excel_ole/lib/robust_excel_ole'
+require_relative '../lib/robust_excel_ole'
 
 include REO
 include General

data/lib/reo_console.rb

@@ -4,35 +4,6 @@ require '../robust_excel_ole/lib/robust_excel_ole'
 include REO
 include General
 
-# change the current binding such that self is the current object in the pry-instance, 
-# preserve the local variables
-
-class Pry
-
-  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
-
-end
-
 # some pry configuration
 Pry.config.windows_console_warning = false
 Pry.config.color = false
@@ -65,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/excel.rb

@@ -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?

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')
@@ -68,8 +68,95 @@ module General
     Pry.change_current_binding(current_object)
   end
 
-  module_function :absolute_path, :canonize, :normalize, :change_current_binding
+  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
@@ -122,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

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.26"
+  VERSION = "1.27"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: '1.26'
+  version: '1.27'
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -126,7 +126,6 @@ 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
@@ -149,7 +148,6 @@ files:
 - 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