robust_excel_ole 1.18.2 → 1.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7e99b95395eacc6a02673421b2ff467afd173244990fc19a9834d1c9a2f6c0
-  data.tar.gz: c58927fbaf2b4d7f301dba8a17a52e966e9b25041ae44f6c782e02785c5df522
+  metadata.gz: e27445ccdfcf45a843bf7d4271a36f9ced4b8ab8a0e78212ee4d6f10b5fe4aca
+  data.tar.gz: 9aaf9daad0c04d97161dad9bfd3836504812b9581e78ce94eceb1c24ba43705a
 SHA512:
-  metadata.gz: d01c45a26903e3cfb9eb0a45c712a89b4e65dac4050982749df443199b4df19137d26dbb591a15b41ebede0db55877170774fb6f4095a1ec435aba78df7d064c
-  data.tar.gz: 8e8b3bcfde250213591e7536fc182a5b058e98361b68dfb0e6a95eae96ca5a66568ddf47030eba649870c1b7186686ad55d52e36ce79c10eec857745ff3ddd89
+  metadata.gz: 9748c186da786a3af11bb47215891f2082dee540b1ef2870512393db02d8f5f685b14e58668e9047f2dcc4793d128c750bf26ae18f9f19e19bc68a5577d9ef2e
+  data.tar.gz: 9e1d163cc6e6c035cb6621aaafbc6701785e553cf8a19f7b0fe7936a0253b1f298864a6905319b4501fb9cece53d512083dd0148abc3571eae9326b9966d8329

data/Changelog

@@ -1,14 +1,19 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+
+## [1.19] 2020-30-5
+
+### Added
+  - Workheet#values, each_rowvalue
+
+
 ## [1.18] 2020-30-4
 
 ### Added
   - Workbook#worksheets, worksheets_count
   - Worksheet#each_value
   - Range#value, value=
-
-### Changed
   - Range#initialize: optional paramter worksheet
 
 ## [1.17]

data/benchmarking/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rubyXL'
+gem 'roo'
+gem 'creek'
+gem 'spreadsheet'
+gem 'simple_xlsx_reader'

data/benchmarking/README.md

@@ -0,0 +1,131 @@
+# ruby-excel-library-examples
+This project contains sample code for reading Excel files with different Ruby libraries.
+
+## `.xlsx` File Examples
+Below are code samples for reading current OOXML Excel files using [**rubyXL**](https://github.com/weshatheleopard/rubyXL), [**roo**](https://github.com/roo-rb/roo), [**creek**](https://github.com/pythonicrubyist/creek), and [**simple_xlsx_reader**](https://github.com/woahdae/simple_xlsx_reader).
+
+### [rubyXL](https://github.com/weshatheleopard/rubyXL)
+```ruby
+require 'rubyXL'
+
+workbook = RubyXL::Parser.parse './sample_excel_files/xlsx_500_rows.xlsx'
+worksheets = workbook.worksheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.sheet_name}"
+  num_rows = 0
+
+  worksheet.each do |row|
+    row_cells = row.cells.map{ |cell| cell.value }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'
+```
+### [roo](https://github.com/roo-rb/roo)
+```ruby
+require 'roo'
+
+workbook = Roo::Spreadsheet.open './sample_excel_files/xlsx_500_rows.xlsx'
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet}"
+  num_rows = 0
+
+  workbook.sheet(worksheet).each_row_streaming do |row|
+    row_cells = row.map { |cell| cell.value }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join ' '
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'
+```
+### [creek](https://github.com/pythonicrubyist/creek)
+```ruby
+require 'creek'
+
+workbook = Creek::Book.new './sample_excel_files/xlsx_500_rows.xlsx'
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row.values
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'
+```
+### [simple_xlsx_reader](https://github.com/woahdae/simple_xlsx_reader)
+```ruby
+require 'simple_xlsx_reader'
+
+workbook = SimpleXlsxReader.open './sample_excel_files/xlsx_500000_rows.xlsx'
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join ' '
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'
+```
+
+## Legacy `.xls` Files
+Below are code samples for reading legacy Excel files using [**spreadsheet**](https://github.com/zdavatz/spreadsheet)
+
+### [spreadsheet](https://github.com/zdavatz/spreadsheet)
+```ruby
+require 'spreadsheet'
+
+# Note: spreadsheet only supports .xls files (not .xlsx)
+workbook = Spreadsheet.open './sample_excel_files/xls_500_rows.xls'
+worksheets = workbook.worksheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row.to_a.map{ |v| v.methods.include?(:value) ? v.value : v }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+puts 'Done'
+```

data/benchmarking/creek_example.rb

@@ -0,0 +1,33 @@
+
+require 'creek'
+
+start_time = Time.now 
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+workbook = Creek::Book.new './sample_excel_files/xlsx_500_rows.xlsx'
+
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+  
+  worksheet.rows.each do |row|
+    row_cells = row.values
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/generating_excel_files.rb

@@ -0,0 +1,28 @@
+require_relative '../lib/robust_excel_ole'
+
+include RobustExcelOle
+
+begin
+
+  filename = './large_excel_files/xlsx_10_rows.xlsx'
+  Excel.kill_all
+ 
+  Workbook.open(filename, :if_absent => :create) do |workbook|
+    # default: 3 worksheets
+    num_worksheets = 1
+    workbook.each do |worksheet|
+      puts "worksheet-number #{num_worksheets}"
+      num_rows = 1
+      (1..10).each do |row|
+        puts "row-number: #{num_rows}"
+        (1..10).each do |column|
+          worksheet[num_rows,column].value = (num_rows-1)*10+column
+        end
+        num_rows += 1
+      end
+      num_worksheets += 1
+    end
+    workbook.save
+  end
+
+end

data/benchmarking/reo_example.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+start_time = Time.now 
+
+workbook = RobustExcelOle::Workbook.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+puts "Found #{workbook.worksheets_count} worksheets"
+
+workbook.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.values.each do |row_vals|
+    row_cells = row_vals
+    num_rows += 1
+  end
+
+  puts "Read #{num_rows} rows"
+
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/reo_example1.rb

@@ -0,0 +1,31 @@
+#require 'robust_excel_ole'
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+start_time = Time.now 
+
+workbook = RobustExcelOle::Workbook.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+puts "Found #{workbook.Worksheets.Count} worksheets"
+
+workbook.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.each_row do |row|
+    row_cells = row.map{ |cell| cell.value }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+
+end
+
+
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/reo_example2.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '../lib/robust_excel_ole')
+
+start_time = Time.now 
+
+workbook = RobustExcelOle::Workbook.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+puts "Found #{workbook.worksheets_count} worksheets"
+
+workbook.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.each_rowvalue do |row_vals|
+    row_cells = row_vals
+    num_rows += 1
+  end
+
+  puts "Read #{num_rows} rows"
+
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/roo_example.rb

@@ -0,0 +1,33 @@
+require 'roo'
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+start_time = Time.now
+
+workbook = Roo::Spreadsheet.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet}"
+  num_rows = 0
+
+  workbook.sheet(worksheet).each_row_streaming do |row|
+    row_cells = row.map { |cell| cell.value }
+    #puts row_cells.inspect
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join ' '
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/ruby_xl_example.rb

@@ -0,0 +1,36 @@
+
+require 'rubyXL'
+
+start_time = Time.now 
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+workbook = RubyXL::Parser.parse './sample_excel_files/xlsx_500_rows.xlsx'
+
+worksheets = workbook.worksheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.sheet_name}"
+  num_rows = 0
+
+  worksheet.each do |row|
+    row_cells = row.cells.map{ |cell| cell.value }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'
+
+
+puts 'Done'

data/benchmarking/simple_xlsx_reader_example.rb

@@ -0,0 +1,33 @@
+
+require 'simple_xlsx_reader'
+
+start_time = Time.now 
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+workbook = SimpleXlsxReader.open './sample_excel_files/xlsx_500_rows.xlsx'
+
+worksheets = workbook.sheets
+puts "Found #{worksheets.count} worksheets"
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join ' '
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+puts 'Done'

data/benchmarking/spreadsheet_example.rb

@@ -0,0 +1,36 @@
+
+require 'spreadsheet'
+
+start_time = Time.now 
+
+# ============================================
+# ===========   Read Example   ===============
+# ============================================
+
+# Note: spreadsheet only supports .xls files (not .xlsx)
+workbook = Spreadsheet.open './sample_excel_files/xls_500_rows.xls'
+
+worksheets = workbook.worksheets
+puts "Found #{worksheets.count} worksheets"
+
+
+worksheets.each do |worksheet|
+  puts "Reading: #{worksheet.name}"
+  num_rows = 0
+
+  worksheet.rows.each do |row|
+    row_cells = row.to_a.map{ |v| v.methods.include?(:value) ? v.value : v }
+    num_rows += 1
+
+    # uncomment to print out row values
+    # puts row_cells.join " "
+  end
+  puts "Read #{num_rows} rows"
+end
+
+end_time = Time.now
+running_time = end_time - start_time
+puts "time: #{running_time} sec."
+
+
+puts 'Done'

data/bin/jreo.bat

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

data/bin/reo.bat

@@ -0,0 +1,3 @@
+@echo off
+
+irb -f -r ../lib/robust_excel_ole -r ../lib/reo_console.rb

data/docs/README_ranges.rdoc

@@ -394,9 +394,14 @@ The methods Worksheet#each, Worksheet#each_row and Worksheet#each_column enable
     # do something with column
   end
 
-The method Worksheet#each_value accesses the values of each row.
+The method Worksheet#values yields all cell values of the used range of the worksheet into a 2-dimensional array. For example:
 
-  worksheet.each_value do |row_values|
+  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.
+
+  worksheet.each_rowvalue do |row_values|
     # do something with the row_values
   end
 
@@ -405,6 +410,10 @@ You access a range of a row by giving the number of the row, and optionally, the
   worksheet.row_range(1)  # => first row
   worksheet.row_range(1, 1..3 )  # => first three cells of the first row  
 
+Reading the values is enabled with help of #values:
+
+  worksheet.row_range(1).values  
+
 Simarly you can access a range of a column.
 
   worksheet.col_range(3)  # => third column

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "1.18.2"
+  VERSION = "1.18.3"
 end

data/lib/robust_excel_ole/worksheet.rb

@@ -109,11 +109,10 @@ module RobustExcelOle
     # @params row and column
     # @returns value of the cell
     def cellval(x,y)
-      xy = "#{x}_#{y}"
       begin
         @ole_worksheet.Cells.Item(x, y).Value
       rescue
-        raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
+        raise RangeNotEvaluatable, "cannot read cell (#{x.inspect},#{y.inspect})"
       end
     end
 
@@ -122,7 +121,7 @@ module RobustExcelOle
       xy = "#{x}_#{y}"
       @cells = { }
       begin
-        @cells[xy] = RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
+        @cells[xy] ||= RobustExcelOle::Cell.new(@ole_worksheet.Cells.Item(x, y), @worksheet)
         @cells[xy].Value
       rescue
         raise RangeNotEvaluatable, "cannot read cell (#{p1.inspect},#{p2.inspect})"
@@ -141,6 +140,10 @@ module RobustExcelOle
       raise RangeNotEvaluatable, "cannot assign value #{value.inspect} to cell (#{y.inspect},#{x.inspect})"
     end
 
+    def values
+      @ole_worksheet.UsedRange.Value
+    end
+
     def each
       each_row do |row_range|
         row_range.each do |cell|
@@ -159,13 +162,17 @@ module RobustExcelOle
       end
     end
 
-    def each_value
+    def each_rowvalue
       @ole_worksheet.UsedRange.Value.each do |row_values|
         yield row_values
       end
     end
 
-    def each_value_with_index(offset = 0)
+    def each_value   # :deprecated: #
+      each_rowvalue
+    end
+
+    def each_rowvalue_with_index(offset = 0)
       i = offset
       @ole_worksheet.UsedRange.Value.each do |row_values|
         yield row_values, i

data/robust_excel_ole.gemspec

@@ -34,6 +34,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_development_dependency "rspec", '>= 2.6.0'
-  s.required_ruby_version = '>= 1.8.6'
-  #s.extensions << 'extconf.rb'
+  s.required_ruby_version = '>= 2.1'
 end

data/spec/worksheet_spec.rb

@@ -295,17 +295,25 @@ describe Worksheet do
 
     end
 
-    describe "#each_value" do
+    describe "#values" do
+
+      it "should yield cell values of the used range" do
+        @sheet.values.should == [["foo", "workbook", "sheet1"], ["foo", nil, "foobaaa"], ["matz", "is", "nice"]]
+      end
+
+    end
+
+    describe "#each_rowvalue" do
 
       it "should yield arrays" do
-        @sheet.each_value do |row_value|
+        @sheet.each_rowvalue do |row_value|
           row_value.should be_kind_of Array
         end
       end
 
       it "should read the rows" do
         i = 0
-        @sheet.each_value do |row_values|
+        @sheet.each_rowvalue do |row_values|
           case i
           when 0
             row_values.should == ['foo', 'workbook', 'sheet1']
@@ -317,7 +325,7 @@ describe Worksheet do
       end
 
       it "should read the rows with index" do
-        @sheet.each_value_with_index do |row_values, i|
+        @sheet.each_rowvalue_with_index do |row_values, i|
           case i
           when 0
             row_values.should == ['foo', 'workbook', 'sheet1']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robust_excel_ole
 version: !ruby/object:Gem::Version
-  version: 1.18.2
+  version: 1.18.3
 platform: ruby
 authors:
 - traths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,7 +33,9 @@ description: "RobustExcelOle helps controlling Excel. \n                   This
   are supported.\n                   It runs on Windows and uses the win32ole library."
 email:
 - Thomas.Raths@gmx.net
-executables: []
+executables:
+- jreo.bat
+- reo.bat
 extensions: []
 extra_rdoc_files:
 - README.rdoc
@@ -50,6 +52,20 @@ files:
 - Rakefile
 - TodoList.md
 - ___dummy_workbook.xls
+- benchmarking/Gemfile
+- benchmarking/README.md
+- benchmarking/creek_example.rb
+- benchmarking/generating_excel_files.rb
+- benchmarking/reo_example.rb
+- benchmarking/reo_example1.rb
+- benchmarking/reo_example2.rb
+- benchmarking/roo_example.rb
+- benchmarking/ruby_xl_example.rb
+- benchmarking/sample_excel_files/xlsx_500_rows.xlsx
+- benchmarking/simple_xlsx_reader_example.rb
+- benchmarking/spreadsheet_example.rb
+- bin/jreo.bat
+- bin/reo.bat
 - docs/README_excel.rdoc
 - docs/README_open.rdoc
 - docs/README_ranges.rdoc
@@ -82,7 +98,6 @@ files:
 - examples/open_save_close/example_reuse.rb
 - examples/open_save_close/example_simple.rb
 - examples/open_save_close/example_unobtrusively.rb
-- extconf.rb
 - jreo.bat
 - lib/jreo_console.rb
 - lib/reo_console.rb
@@ -159,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/extconf.rb

@@ -1,13 +0,0 @@
-dummy_make_content = "make:\n" \
-                     "\t:\n" \
-                     "install:\n" \
-                     "\t:\n" \
-                     "clean:\n" \
-                     "\t:\n"
-File.write('Makefile', dummy_make_content)
-
-puts "hello"
-
-a = 2
-
-puts a