robust_excel_ole 1.20 → 1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cbad43d74758e37eb8e8d17e0297ead9f7cda838f5a157832145d41bacb743a
-  data.tar.gz: 80a112947a96132e8f8bb5ccccdccace4b7c1227418475aac51d6aa771b2e876
+  metadata.gz: d73c62c763182694dfebd8d6c08aff0c4202752cb27dd7d8b7b46f6c1960ca4d
+  data.tar.gz: f3381ababd070bf4f9c19a7a244d7a763d4bb97893c75b36770e27ee0b051bc5
 SHA512:
-  metadata.gz: 4983b1d7e31e09873bf70e9903e3bdcd7a438e238283c5f2bae9198b5ed53c83fd5726f55b7e9ad4559b820dca65f2c82cb82f85091b199f4b58adfa98064c6b
-  data.tar.gz: 6c1c920de4c68699a10e87241121a01e66884317f06ad8ce9962b049c024658b797e014ef0aaaa297287065e80d85514d384925f24412bf1175aa8d97c252865
+  metadata.gz: 86e25e6d15f705b8a44058050d2a6360da2581a72855ed552a8f30958a6da707fcddb18d661416b63fa721e864bc57e6ee4102ca7a4d5569182569353538e38a
+  data.tar.gz: 28daa6be28ba71b70ece8a387cac4e06441232e5ada825970338faaf4e0a269da1c32a471ea0d38eaa2c704f438281be7db127a8a7a257d2aa4b79d784f4547a

data/Changelog

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

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,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'. If you want to use the nice feature of filename and string completion, you may install pry-bond as well.
 
 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,125 +317,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","Amount"])
-
-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 "Amount".
-
-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 underscored versions of the column names, e.g.
-
-  row1.person = "John"
-  row1.person
-  # => "John"
-
-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

@@ -2,23 +2,23 @@
 # -*- ruby -*-
 
 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/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,18 +4,18 @@ 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/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/bookstore.rb

@@ -2,6 +2,7 @@
 
 module RobustExcelOle
 
+  # @private
   class Bookstore < Base
     
     def initialize
@@ -31,7 +32,7 @@ module RobustExcelOle
     def fetch(filename, options = { :prefer_writable => true })
       return nil unless filename
       filename = General.absolute_path(filename)
-      filename_key = General.canonize(filename)
+      filename_key = General.canonize(filename).downcase
       weakref_books = @filename2books[filename_key]
       return nil if weakref_books.nil? || weakref_books.empty?
 
@@ -69,9 +70,9 @@ module RobustExcelOle
     # stores a workbook
     # @param [Workbook] book a given book
     def store(book)
-      filename_key = General.canonize(book.filename)
+      filename_key = General.canonize(book.filename).downcase
       if book.stored_filename
-        old_filename_key = General.canonize(book.stored_filename)
+        old_filename_key = General.canonize(book.stored_filename).downcase
         # deletes the weak reference to the book
         @filename2books[old_filename_key].delete(book)
       end