robust_excel_ole 1.23 → 1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d73c62c763182694dfebd8d6c08aff0c4202752cb27dd7d8b7b46f6c1960ca4d
-  data.tar.gz: f3381ababd070bf4f9c19a7a244d7a763d4bb97893c75b36770e27ee0b051bc5
+  metadata.gz: 07c975ffbb28abda163753fff25e0949c0aafeddefa24d5d840993a8fc8fea02
+  data.tar.gz: 5ac54be9b6ecfcede48a9d9bf0dc67f0ebe86528d41a44e032b29a244a9e3e0d
 SHA512:
-  metadata.gz: 86e25e6d15f705b8a44058050d2a6360da2581a72855ed552a8f30958a6da707fcddb18d661416b63fa721e864bc57e6ee4102ca7a4d5569182569353538e38a
-  data.tar.gz: 28daa6be28ba71b70ece8a387cac4e06441232e5ada825970338faaf4e0a269da1c32a471ea0d38eaa2c704f438281be7db127a8a7a257d2aa4b79d784f4547a
+  metadata.gz: a324a7ab9da6e19e91f0da418e61c19c5cc52cf941763b3f4fac781d03e84f554d4dfe52839f41c6df225dca92157ef644700aa6ed2b3b24d4e3998952ad0872
+  data.tar.gz: b856effb28b64db2d3b22496f229e8b76c24806264b514772424afdbcdb71abb2f0106274bedc994f5145695d8e8b231eeb568f2c82dc7acc6a1762aa459df3d

data/Changelog

@@ -1,6 +1,21 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.28] 2020-23-10
+
+## [1.27] 2020-16-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

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 consoles require the ruby gem 'pry'. If you want to use the nice feature of filename and string completion, you may install pry-bond as well.
+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 class Win32Ole is being extended 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,7 +2,7 @@
 # -*- jruby -*-
 
 require 'pry'
-require '../robust_excel_ole/lib/robust_excel_ole'
+require_relative '../lib/robust_excel_ole'
 
 include REO
 include General
@@ -15,10 +15,29 @@ Pry.config.prompt_name = "REO "
 #Pry.config.history_save = true
 #Pry.editor = 'notepad'  # 'subl', 'vi'
 
+prompt_proc1 = proc { |target_self, nest_level, pry|
+   "[#{pry.input_ring.count}] #{pry.config.prompt_name}(#{Pry.view_clip(target_self)})#{":#{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.gsub(/\"/, ''))})})#{":#{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
 
 hooks.add_hook :when_started, :hook12 do
 puts 'REO console started'
 puts
 end
+
 Pry.start(nil, hooks: hooks)

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
@@ -15,10 +15,29 @@ Pry.config.prompt_name = "REO "
 #Pry.config.history_save = true
 #Pry.editor = 'notepad'  # 'subl', 'vi'
 
+prompt_proc1 = proc { |target_self, nest_level, pry|
+   "[#{pry.input_ring.count}] #{pry.config.prompt_name}(#{Pry.view_clip(target_self)})#{":#{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.gsub(/\"/, ''))})})#{":#{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
 
 hooks.add_hook :when_started, :hook12 do
 puts 'REO console started'
 puts
 end
+
 Pry.start(nil, hooks: hooks)

data/lib/robust_excel_ole.rb

@@ -3,8 +3,8 @@ if RUBY_PLATFORM =~ /java/
 else
   require 'win32ole'
 end
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/base')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/general')
+require File.join(File.dirname(__FILE__), 'robust_excel_ole/base')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/vba_objects')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/range_owners')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/address_tool')
@@ -18,5 +18,4 @@ 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 General
+General.init_reo_for_win32ole

data/lib/robust_excel_ole/base.rb

@@ -65,6 +65,8 @@ module RobustExcelOle
 
   class Base
 
+    include General
+
     # @private
     def own_methods
       (self.methods - Object.methods).sort
@@ -110,3 +112,6 @@ module RobustExcelOle
   end
 
 end
+
+REO = RobustExcelOle
+

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?

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
+    [{RobustExcelOle::Excel => :Hwnd},
+     {RobustExcelOle::Workbook => :FullName},
+     {RobustExcelOle::Worksheet => :UsedRange},
+     {RobustExcelOle::Range => :Row},
+     {RobustExcelOle::ListObject => :ListRows}]
+  end
+
+
+  # enable RobustExcelOle methods to Win32Ole objects
+  def init_reo_for_win32ole
+    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, :init_reo_for_win32ole
+
+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,6 @@ class WIN32OLE
     raise TypeREOError, "given object cannot be type-lifted to a RobustExcelOle object"
   end
 
-  alias method_missing_before_implicit_typelift method_missing 
-  def xx_method_missing(name, *args, &blk)
-    begin
-      reo_obj = self.to_reo
-    rescue
-      puts "$!.message: #{$!.message}"
-      method_missing_before_implicit_typelift(name, *args, &blk)
-    end
-    reo_obj.send(name, *args, &blk)
-  end
 end
 
 # @private
@@ -276,7 +350,4 @@ module MethodHelpers
       super
     end
   end
-
 end
-
-REO = RobustExcelOle

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.23"
+  VERSION = "1.28"
 end

data/robust_excel_ole.gemspec

@@ -34,7 +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.01'
+  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,33 @@ module RobustExcelOle
 
     end
 
+    describe "General.init_reo_for_win32ole" do
+
+      before do
+        @book1 = Workbook.open(@simple_file, :visible => true)
+      end
+
+      it "should apply reo-methods to win32ole objects" do
+        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.23'
+  version: '1.28'
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.01'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.01'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,8 +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
 - lib/robust_excel_ole/base.rb
@@ -149,7 +147,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/lib/reo_console.rb

@@ -1,21 +0,0 @@
-require 'pry'
-require '../robust_excel_ole/lib/robust_excel_ole'
-
-include REO
-include General
-
-# some pry configuration
-Pry.config.windows_console_warning = false
-Pry.config.color = false
-Pry.config.prompt_name = "REO "
-
-#Pry.config.history_save = true
-#Pry.editor = 'notepad'  # 'subl', 'vi'
-
-hooks = Pry::Hooks.new
-
-hooks.add_hook :when_started, :hook12 do
-puts 'REO console started'
-puts
-end
-Pry.start(nil, hooks: hooks)

data/reo.bat

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