robust_excel_ole 1.33 → 1.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c1d70d522034dc16bc609e2578e02b556396051ec7fdd14e2f11bd5aea85cd
-  data.tar.gz: e14ac932aae718dd25d3a3ddc9ab487d63dc934c6e1d136a1adb069b0c57c81e
+  metadata.gz: 367d0c217ed968287f98cbf62cc786df14d364799f2dec633848af78eb6ce1f0
+  data.tar.gz: de1a58c99a761ae005142a7bf302cab13b3b64021605e000e05ec2d783246fa2
 SHA512:
-  metadata.gz: 77e8abbfee1226d86e58d75aa4e1625b3a7d385333974c4cb9e854527d1c6e2cfdcb827a55749343e34dfae0867bc843ac609ebb1541f71960dd08ffbdf7d1fd
-  data.tar.gz: f3b02fa7307c8d7031fdf65d246d3e22a800d39f476a24f227abba0dc2eb058b119dc29c249285392013a8d0de73735c176030d39fd8f97f7ea9150b7a8d0b61
+  metadata.gz: 65361e347cb55f05bc6d24c6a85f3f3b19696cf057dbc71c14cb86a7c3d8bfc28aca247231cc3a90409d933ca3944104f40e006d2591dfe55f60f84a30f75619
+  data.tar.gz: db86b776ff9359c8ebb3893d1bbc103aacfae6f408dc0358f7b32367312b80096d47a3aed682b7ec367f2a41eb64cef9ac8c3aa9fcc021c8ac05b9e8babb70cf

data/README.rdoc

@@ -1,24 +1,3 @@
-= News
-
-== New Interface of #[]
-
-Worksheet#[] now returns a value instead of a range, e.g.
-
-  worksheet[1,1]
-  # => "foo"
-
-Transformation: To yield the range, write range() instead of (). For example,
-
-  worksheet.range(1,1)
-
- or
-
-  worksheet.range([1,1])
-
-This returns the range of cell with address 1,1.
-
-With this new interface, we want to be compatible with the standard syntax of other known Excel libraries, e.g. +spreadsheet+ or +axlsx+.
-
 = RobustExcelOle
 
 RobustExcelOle helps controlling Excel. 
@@ -126,7 +105,7 @@ Then we'll save the workbook.
 
   workbook.save
 
-=== More features when opening, modifying, creating, saving and closing workbooks
+=== Unobtrusively opening workbooks
 
 RobustExcelOle allows unobtrusively reading and modifying workbooks, i.e. accessing workbooks without changing their "status". The status comprises whether the workbook is open or closed, saved or unsaved, read-only or writable, visible or invisible, whether the calculation mode is manual or automatic, and checking compatibility is done or not done.
 
@@ -142,7 +121,9 @@ RobustExcelOle allows unobtrusively reading and modifying workbooks, i.e. access
     # do something
   end
 
-We can also create a new, empty workbook. 
+=== More featrues about creating, opening, saving and closing workbooks 
+
+We can create a new, empty workbook. 
 
   Workbook.create('spec/data/new_workbook.xls', visible: true)
 
@@ -178,7 +159,7 @@ or save the workbook under a different name.
 
 Finally we can close the workbook
 
-  workbook.save
+  workbook.close
 
 or save and close the workbook in one step.
 
@@ -210,10 +191,6 @@ We close the Excel instance using
 
   excel1.close
 
-Closed Excel instances can be reopened.
-
-  excel1.recreate(reopen_workbooks: true, visible: true)
-
 Closing all Excel instances is done by
 
   Excel.close_all(if_unsaved: :forget)
@@ -237,17 +214,12 @@ Now we want to open another workbook in a different Excel instance.
 
   workbook2 = Workbook.open('spec/data/different_workbook.xls', excel: :new)
 
-We can also create a third Excel instance and open another workbook in this instance.
-
-  excel1 = Excel.create
-  workbook3 = Workbook.open('spec/data/another_workbook.xls', excel: excel1)
-
 A workbook is opened by default in the Excel instance where it was open before most recently.
 
    workbook1.close
    workbook1 = Workbook.open('spec/data/workbook.xls') 
 
-If this Excel instance is damaged or closed, then options control whether the workbook shall be opened in the current (active), a new or a given Excel instance.
+If the Excel instance is damaged or closed, then options control whether the workbook shall be opened in the current (active), a new or a given Excel instance.
 
   workbook1 = Workbook.open('spec/data/workbook.xls', default: {excel: new})
 
@@ -257,7 +229,7 @@ Without the option +:default+, the workbook can be forced to be opened in the cu
 
 === Managing conflicts with unsaved and blocking workbooks
 
-RobustExcelOle enables processing workbooks, while still supporting user's interactions: The commands enable to open, close, reopen, read, modify, write and save Excel workbooks, without the need of the user's interaction, and even without the user noticing. Thus, while running a script containing RobustExcelOle commands, the user can open and process workbooks in any Excel instances at any time. RobustExcelOle manages the complex cases of conflicts that might occur such that the user does not need to interfere and the script can continue.
+RobustExcelOle enables processing workbooks, while supporting user's interactions: The commands enable to open, close, reopen, read, modify, write and save Excel workbooks, without the need of the user's interaction, and even without the user noticing. Thus, while running a script containing RobustExcelOle commands, the user can open and process workbooks in any Excel instances at any time. RobustExcelOle manages the complex cases of conflicts that might occur such that the user does not need to interfere and the script can continue.
 
 For example, suppose we want to process a list of workbooks. RobustExcelOle allows to rapidly open, manipulate, close and save these workbooks. Now assume, the workbook "workbook.xls" is being processed, while the user has already opened this workbook, has modified but not saved it yet. Excel would prompt a message and ask the user what to do. RobustExcelOle solves this conflict by using an option that states whether the changes of the user should be saved (accepted) or discarded (forgotten) before opening the workbook, e.g.
 
@@ -308,22 +280,10 @@ We can define a rectangular range by providing the top left and the bottum down
 
   worksheet.range([1..3,1..4])
 
-We can read the first three cells of the first row
-
-  worksheet.row_range(1, 1..3).values   # => ["foo","workbook","sheet1"]
-
-and the third column
-
-  worksheet.col_range(3).values   # => ["sheet1", 2.0, 4.0]
-
 We can read the first cell, using
 
   worksheet[1,1].    # => "foo"
 
-or
-
-  worksheet.row_range(1)[0].value    # => "foo"
-
 Then we modify it.
 
   worksheet[1,1] = "hello"
@@ -338,7 +298,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 (Tables)
 
 We can define a list object (or table) from scratch
@@ -349,10 +308,6 @@ or get a given list object in a worksheet given its table number or name.
 
   table = worksheet.table(1) 
 
-or
-
-  table = worksheet.table("table1")
-
 A list row can be accessed by providing either the row number or a key, i.e. hash of column name - value pairs, e.g.
 
   row1 = table[1]
@@ -361,8 +316,8 @@ A list row can be accessed by providing either the row number or a key, i.e. has
 
 You can get all or a maximal number of list rows matching the key.
 
-  rows = table[{"Number": 1}, limit: 2]
   rows = table[{"Number": 1}, limit: nil]
+  rows = table[{"Number": 1}, limit: 2]
 
 Now we can set 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.
 
@@ -393,25 +348,21 @@ and
 
   table.set_column_values(1, ["Herbert","Paul"])
 
-We can add and delete rows and columns, supplying optionally their name, the position and contents. 
+For more details about using and processing list objects see {README_listobjects}[https://github.com/Thomas008/robust_excel_ole/blob/master/docs/README_listobjects.rdoc]
 
-  table.add_column("column_name", 3, ["John", "Paul"])
-  table.add_row(3, ["John", 40, 2, 2004])
+=== More features
 
-  table.delete_column_values("column_name")
-  table[2].delete_values
+1. 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. So now the RobustExcelOle objects and their wrapped WIN32OLE objects are interchangeable. One example would be
 
- Finally we can delete empty rows and columns.
+  range.ole_range.copy([4,3])
 
-  table.delete_empty_rows
-  table.delete_empty_columns
+Likewise it is possible to convert ("type-lift") WIN32OLE objects into the corresponding RobustExcelOle object, using the method +to_reo+. It is a refinement of the class WIN32OLE. So you can write
 
-For more details about using and processing list objects see {README_listobjects}[https://github.com/Thomas008/robust_excel_ole/blob/master/docs/README_listobjects.rdoc]
- 
+  using ToReoRefinement
 
-=== More features
+  range = sheet.Names.Item("firstcell").to_reo
 
-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
+2. 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)
 
@@ -425,17 +376,6 @@ or
 
 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. So 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 the method +to_reo+. It is a refinement of the class WIN32OLE. So you can write
-
-  using ToReoRefinement
-
-  range = sheet.Names.Item("firstcell").to_reo
-
 === Design issues
 
 We don't consider active worksheets or workbooks in our implementation, because this has been proven to be very error-prone.

data/lib/robust_excel_ole/list_row.rb

@@ -130,7 +130,13 @@ module RobustExcelOle
   private
 
     def define_and_call_method(column_name,method_name,*args)
-      column_name = column_name.force_encoding('cp850')
+      puts "define_and_call_method:"
+      puts "column_name: #{column_name} #{column_name.inspect}"
+      #column_name = column_name.force_encoding('cp850')
+      puts "after force_encoding: column_name: #{column_name} #{column_name.inspect}"
+      puts "ole_table.ListColumns: #{ole_table.ListColumns.inspect}"
+      column1 = ole_table.ListColumns.Item(column_name)
+      puts "column1: #{column1.inspect}"
       ole_cell = ole_table.Application.Intersect(
           @ole_tablerow.Range, ole_table.ListColumns.Item(column_name).Range)
       define_getting_setting_method(ole_cell,method_name)            

data/lib/robust_excel_ole/range.rb

@@ -80,14 +80,17 @@ module RobustExcelOle
       end
     end
 
-    # returns values of a given range
+    # returns value of a given range restricted to used range
     # @returns [Array] values of the range (as a nested array)    
-=begin  
     def value
       value = begin
         if !::RANGES_JRUBY_BUG    
-          ole_range.Value[0,[ole_range.Rows.Count,worksheet.last_row].min].inject([]) do |res, row| 
-            res << (!row.nil? ? row[0,[ole_range.Columns.Count,worksheet.last_column].min] : nil)
+          intersection_range = ole_range.Application.Intersect(ole_range, worksheet.Range(
+            worksheet.Cells(1,1),worksheet.Cells(worksheet.last_row,worksheet.last_column)))
+          begin
+            intersection_range.Value 
+          rescue 
+            nil
           end
         else
           # optimization is possible here
@@ -104,28 +107,6 @@ module RobustExcelOle
       end
       value
     end
-=end
-
-    def value
-      value = begin
-        if !::RANGES_JRUBY_BUG    
-          ole_range.Application.Intersect(ole_range, worksheet.Range(
-            worksheet.Cells(1,1),worksheet.Cells(worksheet.last_row,worksheet.last_column))).Value
-        else
-          # optimization is possible here
-          rows_used_range = [rows, last_row].min
-          columns_used_rage = [columns, last_column].min
-          values = rows_used_range.map{|r| columns_used_range.map {|c| worksheet.Cells(r,c).Value} }
-          (values.size==1 && values.first.size==1) ? values.first.first : values
-        end
-      rescue
-        raise RangeNotEvaluatable, "cannot evaluate range #{self.inspect}\n#{$!.message}"
-      end
-      if value == -2146828288 + RobustExcelOle::XlErrName
-        raise RangeNotEvaluatable, "cannot evaluate range #{self.inspect}"
-      end
-      value
-    end
 
     # sets the values if the range
     # @param [Variant] value

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.33"
+  VERSION = "1.34"
 end

data/lib/robust_excel_ole/workbook.rb

@@ -278,6 +278,7 @@ module RobustExcelOle
       # changing read-only mode      
       if (!options[:read_only].nil?) && options[:read_only] != @ole_workbook.ReadOnly
         ensure_workbook(filename, options) 
+        raise WorkbookReadOnly, "could not change read-only mode" if options[:read_only] != @ole_workbook.ReadOnly
       end
       retain_saved do
         self.visible = options[:force][:visible].nil? ? @excel.Visible : options[:force][:visible]

data/lib/robust_excel_ole/worksheet.rb

@@ -108,11 +108,13 @@ module RobustExcelOle
             if a1_address
               range = self.Range(a1_address)              
             else
+              saved = self.Parent.Saved
               begin
                 self.Names.Add('__dummy_name_object_001__',nil,true,nil,nil,nil,nil,nil,nil,'=' + address_tool.as_r1c1(address))
                 range = get_name_object('__dummy_name_object_001__').RefersToRange
               ensure
                 self.Names.Item('__dummy_name_object_001__').Delete
+                self.Parent.Saved = saved
               end
             end
           rescue

data/spec/excel_spec.rb

@@ -1925,7 +1925,7 @@ module RobustExcelOle
         excel_instances.first.should == excel
         excel_instances.to_a.should == [excel]
         res = []
-        excel_instances.each_with_index{|e,i| res << [e,i]}
+        excel_instances.each.with_index{|e,i| res << [e,i]}.to_a
         res.should == [[excel,0]]
       end
 
@@ -1937,7 +1937,7 @@ module RobustExcelOle
         excel_instances.first.should == excel1
         excel_instances.to_a.should == [excel1, excel2]
         res = []
-        excel_instances.each_with_index{|e,i| res << [e,i]}
+        excel_instances.each.with_index{|e,i| res << [e,i]}.to_a
         res.should == [[excel1,0],[excel2,1]]
       end
 

data/spec/range_spec.rb

@@ -69,7 +69,7 @@ describe RobustExcelOle::Range do
 
     it "should concatenate" do
       values = []
-      @range2.each.with_index{|c,i| values << [c.v, i]}
+      @range2.each.with_index{|c,i| values << [c.v, i]}.to_a
       values.should == [["simple", 0], ["file", 1], ["sheet2", 2], [nil, 3], [nil, 4], [nil, 5]]
     end
 
@@ -225,7 +225,7 @@ describe RobustExcelOle::Range do
 
       it "should return value" do
         @sheet[1,1].should == 'simple'
-        @sheet.range(1..2,3..4).v.should == [["sheet2", nil], [nil, nil]] 
+        @sheet.range(1..2,3..4).v.should == "sheet2"
       end 
 
       it "should set value of a cell and return its value" do
@@ -237,7 +237,7 @@ describe RobustExcelOle::Range do
       end
 
       it "should set value and return value of a rectangular range" do
-        @sheet1.range([1..2,3..5]).v.should == [["sheet1",nil,nil],["foobaaa",nil,nil]]
+        @sheet1.range([1..2,3..5]).v.should == [["sheet1"], ["foobaaa"]]
         @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

data/spec/workbook_spec.rb

@@ -1425,7 +1425,7 @@ describe Workbook do
 
     it "should concatenate" do
       names = ""
-      @book.each.with_index{|s,i| names << "#{s.name} #{i} " }
+      @book.each.with_index{|s,i| names << "#{s.name} #{i} " }.to_a
       names.should == "Sheet1 0 Sheet2 1 Sheet3 2 "
     end
 

data/spec/workbook_specs/workbook_open_spec.rb

@@ -33,9 +33,11 @@ describe Workbook do
     @simple_file_direct = File.join(File.dirname(__FILE__), 'data') + '/workbook.xls'
     #@simple_file_via_network = File.join('N:/', 'data') + '/workbook.xls'
     @simple_file_network_path = "N:/data/workbook.xls"
-    @simple_file_hostname_share_path = '//DESKTOP-A3C5CJ6/spec/data/workbook.xls'
+    network = WIN32OLE.new('WScript.Network')
+    computer_name = network.ComputerName
+    @simple_file_hostname_share_path = "//#{computer_name}/#{absolute_path('spec/data/workbook.xls').tr('\\','/').gsub('C:','c$')}"
     @simple_file_network_path_other_path = "N:/data/more_data/workbook.xls"
-    @simple_file_hostname_share_path_other_path = '//DESKTOP-A3C5CJ6/spec/data/more_data/workbook.xls'
+    @simple_file_hostname_share_path_other_path = "//#{computer_name}/#{absolute_path('spec/more_data/workbook.xls').tr('\\','/').gsub('C:','c$')}"
     @simple_file_network_path1 = @simple_file_network_path
     @simple_file_hostname_share_path1 = @simple_file_hostname_share_path
     @simple_file_network_path_other_path1 = @simple_file_network_path_other_path
@@ -87,8 +89,8 @@ describe Workbook do
 
       it "should raise error when trying to change the read-only mode of the linked workbook" do
         expect{
-          book2 = Workbook.open(@sub_file, :read_only => true)
-        }.to raise_error(WorkbookLinked)
+          Workbook.open(@sub_file, :read_only => true)
+        }.to raise_error(WorkbookReadOnly, /could not change read-only mode/)
       end
     end
   end
@@ -464,7 +466,7 @@ describe Workbook do
         Workbook.open(@simple_file_network_path1) do |book|
           book.should be_alive
           book.should be_a Workbook
-          book.filename.should == @simple_file_hostname_share_path1.downcase
+          book.filename.should == @simple_file_network_path1 #@simple_file_hostname_share_path1.downcase
           book.Fullname.should == @ole_wb.Fullname
           book.excel.ole_excel.Hwnd.should == @ole_wb.Application.Hwnd
           Excel.instance_count.should == 1
@@ -536,7 +538,7 @@ describe Workbook do
         Workbook.open(@simple_file_hostname_share_path1) do |book|
           book.should be_alive
           book.should be_a Workbook
-          book.filename.should == @simple_file_hostname_share_path1.downcase
+          book.filename.should == @simple_file_network_path1 # @simple_file_hostname_share_path1.downcase
           book.Fullname.should == @ole_wb.Fullname
           book.excel.ole_excel.Hwnd.should == @ole_wb.Application.Hwnd
           Excel.instance_count.should == 1
@@ -2773,7 +2775,7 @@ describe Workbook do
             new_book.should be_alive
             new_book.filename.should_not == @book.filename
             new_book.excel.should_not == @book.excel
-            new_book.sheet(1)[1,1].should == @book.sheet(1)[1,1]
+            new_book.sheet(1)[1,1].should == @old_value
           end
 
           it "should raise an error, if :if_obstructed is default" do

data/spec/workbook_specs/workbook_unobtr_spec.rb

@@ -363,7 +363,7 @@ describe Workbook do
         expect{
           Workbook.unobtrusively(@sub_file, :read_only => true) do
           end
-        }.to raise_error(WorkbookLinked)
+        }.to raise_error(WorkbookReadOnly)
       end
     end
   end

data/spec/worksheet_spec.rb

@@ -505,6 +505,14 @@ describe Worksheet do
 
     describe "#range" do
 
+      it "should delete range, if it was defined before" do
+        @sheet.add_name("__dummy_name_object_001__", [1,1])
+        range = @sheet.range([2,2])
+        expect{
+          @sheet.Names.Item("__dummy_name_object_001__")
+        }.to raise_error
+      end
+
       it "should access a rectangular range [1..2,1..3]" do
         range1 = @sheet.range(1..2,1..3)
         range1.should be_kind_of RobustExcelOle::Range

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: '1.33'
+  version: '1.34'
 platform: ruby
 authors:
 - traths
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: win32api
@@ -210,6 +210,7 @@ files:
 - spec/helpers/key_sender.rb
 - spec/list_object_spec.rb
 - spec/list_row_spec.rb
+- spec/more_data/workbook.xls
 - spec/range_spec.rb
 - spec/spec_helper.rb
 - spec/workbook_spec.rb