robust_excel_ole 1.16 → 1.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87f0b689fc32747c5adbeaeff32f823b2153dc613a2dc27ae6b3a52060241ca0
-  data.tar.gz: 2d89ef58db655b2a84b95b9dc3622fe1daae6bfafc37c1f03f9de1984cf7958e
+  metadata.gz: e27445ccdfcf45a843bf7d4271a36f9ced4b8ab8a0e78212ee4d6f10b5fe4aca
+  data.tar.gz: 9aaf9daad0c04d97161dad9bfd3836504812b9581e78ce94eceb1c24ba43705a
 SHA512:
-  metadata.gz: 2a0074c2f763882481cdc43bb9a99b0c3b62d8ed2bfea646fc5d6d581719f01df7bb8a223c0d3629d698695b56629f1813b26f363a962707df91c42b51bebee0
-  data.tar.gz: 863b6380c04612c239bec9ce6998be0e9ed59ec884e2f57107aa2833f11b0ba4bca7258621bc48e818591a6c6d973fe961a5ca591b2dc85cd5a15fa13dbf1ed6
+  metadata.gz: 9748c186da786a3af11bb47215891f2082dee540b1ef2870512393db02d8f5f685b14e58668e9047f2dcc4793d128c750bf26ae18f9f19e19bc68a5577d9ef2e
+  data.tar.gz: 9e1d163cc6e6c035cb6621aaafbc6701785e553cf8a19f7b0fe7936a0253b1f298864a6905319b4501fb9cece53d512083dd0148abc3571eae9326b9966d8329

data/Changelog

@@ -1,6 +1,29 @@
 # 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=
+  - Range#initialize: optional paramter worksheet
+
+## [1.17]
+
+### Added
+  - Excel#active_workbook
+
+### Changed
+  - Excel#namevalue, set_namevalue, namevalue_glob, set_namevalue_glob are being removed
+
 ## [1.16]
 
 ### Added

data/README.rdoc

@@ -14,6 +14,23 @@ Library references are supported.
 RobustExcelOle works by sending VBA methods via Win32OLE. 
 Therefore, it runs on Windows only.
 
+== Feature list
+
+- opening and processing workbooks across various Excel instances
+- reading and writing workbooks (cells and ranges)
+- reopening and unobtrusively opening workbooks
+- convenient methods for standard tasks (like opening, reading, writing, closing, saving workbooks, naming, adding, and copying ranges and worksheets)
+- dealing with various cases of Excel and user behaviour, e.g. managing conflicts when opening workbooks (e.g. blocking or unsaved workbooks),
+  even with simultanously happening user interactions
+- workarounds for Excel bugs and JRuby bugs
+- various workbook formats, e.g. .xlsx, .xls, .xlsm are supported
+- library references are supported
+- console for convenient usage
+
+== What's new?
+
+  - removing methods to operate on ranges directly from an Excel instance. However, you can use the method Excel.active_workbook to do so.
+  See ChangeLogs.
 
 == Requirements
 

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'