robust_excel_ole 1.21 → 1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7598173082d025a168f3c4e8021eb41c97fb1af36943e35cf2a812fcc0f39672
-  data.tar.gz: 2e1e0585da1b1369d323b218b0817f23679b71f99f637a269a6abf14673df615
+  metadata.gz: f7d0cb1b064c701e9a0cafbc632baceca0e69a4aeb47a6eba5ddcec109f27dee
+  data.tar.gz: f565901c9fa35233a7668958fd78ccf008e9ceb333e701e0662a850a9b5806e0
 SHA512:
-  metadata.gz: '09581d754af617dcbe58149087d78c0281e7aa1e6d5feb27f4b58a0b08a0cc5967d15398d85952174143a2e867133b2d1dbf352fd0656bc7488183c7edca94ab'
-  data.tar.gz: bc6c1bed4f9b3370a376b875fa5a4f64b690ef6df6da70efde30a5caa49447b32b28ba09864adcb4c0ca9ea861ddeb28b5af851e30db826e749c6c97cc0153de
+  metadata.gz: 69aebb4f2b71f46fbf58f3b9884a11347893b3335a32690b536c2174102fadf0971cb3074f8140feedaa8a4ef91683c79c67b77192c64b846bb310ba2bda20fa
+  data.tar.gz: 06bee2e7e0f277e2e647de1c4281a1961649b9d22128b76389873c03f86c7baf5f8c9681e030b735a29c2358b949bdc7ac54133e74b01adb6750e9368b2daffd

data/Changelog

@@ -1,6 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.22] 2020-10-08
+
+### Added
+  - Range#set_value
+
+## [1.21] 2020-05-08
+  
+### Added
+  - Range#rows, columns
 
 ## [1.20] 2020-23-07
 

data/README.rdoc

@@ -27,7 +27,6 @@ RobustExcelOle supports
 - availability of all VBA methods
 - availability of the Excel constants (in form if Ruby constants: Excel constant.capitalize)
 - all standard Excel file formats (.xlsx, .xls, .xlsm)
-- list objects
 - reopening workbooks after closing them
 - unobtrusively opening workbooks, i.e. opening and processing workbooks
   while preserving their status, e.g. saved, readonly
@@ -65,7 +64,15 @@ 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 ruby shell 'pry' allows, among other useful things, to change the value of 'self' in the console: Let 'object' be an (almost) arbitrary object, e.g. a workbook, then you can put
+
+  object.pry
+
+or
+
+  cd object
+
+to assign self to this object. The original pry console is adapted to preserve local variables.
 
 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,139 +325,6 @@ 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]
 
-=== List Objects
-
-=== Creating List Objects
-
-We can define a list object (or table) from scratch.
-
-  table = ListObject.new(worksheet, "table 1", [1,1], 3,["Person","AmountSales"])
-
-This command creates a list object in worksheet named "table 1", with upper left corner at position [1,1] (first cell), with 3 rows and the columns "Person" and "Amoun%tSales".
-
-Likewise we can get a RobustExcelOle list object with help of an existing WIN32OlE list object.
-
-  ole_listobject = worksheet.ListObjects.Item("Table 1")
-  table = ListObject.new(ole_listobject)
-
-or
-
-  table = ole_listobject.to_reo
-
-Now we have a RobustExcelOle ListObject that wraps a WIN32OLE ListObject. So we can send any WIN32OLE (VBA) method to it. See 
-https://docs.microsoft.com/en-us/office/vba/api/excel.listobject#methods.
-
-A row in this table can be accessed with help of #[], e.g.
-
-  row1 = table[1]
-
-=== Reading and setting values
-
-Now we can set and get the value of a cell of the table with help of methods that are equal to or are underscored variants of the column names, e.g.
-
-  row1.AmountSales = 40
-
-or
-
-  row1.amount_sales = 40
-  
-and
-
-  row1.AmountSales
-  # => 40
-
-or 
-
-  row1.amount_sales
-  # => 40
-
-Special characters in the colare being ignored.
-
-We can also read and set values in a whole row, e.g.
-
-  table.row_values(1)
-  # => ["John", 40]
-
-or
-
-  table[1].values
-  # => ["John", 40]
-
-and
-
-  table.set_row_values(1, ["Herbert", 80])
-  # => ["Herbert", 80]
-
-or
-
-  table[1].set_values(["Herbert", 80])
-
-If the number of given values is less than the number of cells in the row, only the first values are written. The remaining values keep their value.  
-
-Similarly, we can read and set the values in a whole column, e.g.
-
-  table.column_values("Person")
-  # => ["John", "Peter"]
-
-and 
-
-  table.set_column_values(1, ["Herbert","Paul"])
-
-The column names we can get with help of
-
-  table.column_names
-
-A column can be renamed.
-
-  table.rename_column("Person", "Enterprise")
-
-or 
-
-  table.rename_column(1, "Enterprise")
-
-=== Adding and Deleting rows and columns
-
-We can add rows and columns, supplying optionally their name, the position and contents. 
-
-  table.add_column("column_name")
-  table.add_column("column_name", 3)
-  table.add_column("column_name", 3, ["John", "Paul"])
-  
-  table.add_row(3)
-  table.add_row(3, ["John", 40, 2, 2004])
-
-Deleting columns and rows is done by
-
-  table.delete_column("column_name")
-  table.delete_row(3)
-
-We can delete only the contents of a column
-
-  table.delete_column_values("column_name")
-
-Similarly can delete only the contents of a row.
-
-  table.delete_row_values(2)
-
-or 
-
-  table[2].delete_values
-
-Finally we can delete empty rows and columns.
-
-  table.delete_empty_rows
-  table.delete_empty_columns
-
-=== Finding values and sorting 
-
-You can find all cells containing a given value, e.g.
-
-  table.find_value(value)
-  #=> [#<Cell: (5,8)>#, #<Cell: (9,6)>#]
-
-You can sort a table according to a given column and sort order, e.g.
-
-  table.sort("Person", :ascending)
 
 === More things
 

data/bin/jreo

@@ -2,23 +2,23 @@
 # -*- jruby -*-
 
 require 'pry'
-require 'robust_excel_ole'
+require '../robust_excel_ole/lib/robust_excel_ole'
 
 include REO
 include General
 
-puts 'REO console started'
-puts 
-
 # some pry configuration
 Pry.config.windows_console_warning = false
-Pry.config.history.should_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, _) { ">> " },
-#    ->(*) { "  " }
-#  ]
 
-pry
+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

@@ -9,14 +9,11 @@ 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/jreo.bat

@@ -1,3 +1,3 @@
 @echo off
 
-jirb -f -r ./lib/robust_excel_ole -r ./lib/jreo_console.rb
+jruby lib/reo_console.rb

data/lib/reo_console.rb

@@ -4,16 +4,89 @@ require '../robust_excel_ole/lib/robust_excel_ole'
 include REO
 include General
 
+# pry mit behalten lokaler Variablen
+
+class Object
+
+  def pry(object = nil, hash = {})
+    @local_vars ||= { }
+    if object.nil? || Hash === object # rubocop:disable Style/CaseEquality
+      Pry.start(self, object || {})
+    else
+      Pry.start(object, hash)
+    end
+  end
+
+end
+
+class Pry
+
+  def self.set_local_vars local_vars
+    @local_vars = local_vars
+  end
+  
+  def self.get_local_vars
+    @local_vars
+  end  
+
+  def self.binding_for(target)
+    return target if Binding === target # rubocop:disable Style/CaseEquality
+    return TOPLEVEL_BINDING if Pry.main == target
+    __bnd = target.instance_eval{ target.__binding__ }
+    @local_vars.each{ |var,value| __bnd.local_variable_set(var, value) }
+    #target.__binding__
+    __bnd
+  end
+
+  class REPL
+
+    def repl
+      loop do
+        case val = read
+        when :control_c
+          output.puts ""
+          pry.reset_eval_string
+        when :no_more_input
+          output.puts "" if output.tty?
+          break
+        else
+          output.puts "" if val.nil? && output.tty?                    
+          # determine the local variables in the binding before evaluation
+          bnd = pry.binding_stack.first
+          exclude_vars = [:__, :_, :_dir, :_dir_, :_file, :_file_, :_in_, :_out_, :_ex, :_ex_, :pry_instance]
+          local_vars = Pry.get_local_vars
+          bnd.local_variables.each{ |var| local_vars[var] = bnd.local_variable_get(var) unless exclude_vars.include?(var) }
+          Pry.set_local_vars(local_vars)
+          return pry.exit_value unless pry.eval(val)
+        end
+      end
+    end
+  end
+end
+
+
 # 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, _) { ">> " },
-#->(*) { "  " }
-#]
+
+Pry.config.prompt = Pry::Prompt.new(
+  "REO",
+  "The RobustExcelOle Prompt. Besides the standard information it puts the current object",
+  [
+   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?}> "
+ },
+
+ 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?}* "
+ }
+]
+)
+
 
 hooks = Pry::Hooks.new
 

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