fast_excel 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0913c4454d805190410b1ba3657913a0f5dc9c1
-  data.tar.gz: a1d3fe3a3f3ee227fcaa900791bb34c0320709e7
+SHA256:
+  metadata.gz: 26cc6868779b440f2c848e60a68bce2272760255e1c4d4e887edae312d16eb76
+  data.tar.gz: 43e3d4288b2c2bb06685308a4c97b267a563d72c32c4902793dd6d3030cde890
 SHA512:
-  metadata.gz: 9b6761029c771b2fcc9444e5b896c64282e12ee4dc19b9eb316481f86aca2543f70156c79159966dd50b6488dccd8bc32292725101bfd6068044b1d938b709e9
-  data.tar.gz: 7d89bc8a36f46ab01cd74826dc411233e6b1f532d0eaa1762e296e4c1f71b7b5d9f42ba706c2445d98ff87d919cf91bcf2e4b8c9a6f299991eb7aa27b37c3a13
+  metadata.gz: 49fa98254e1c6b147e0edd4262ddd87d5b75410b42b38843ae887bbb98ce9aae6bf6607bdebeec840bca73c98ebc5be1f451ed227d51a147fb6a1c6bd8bd0f67
+  data.tar.gz: 724f6b6e146816061c270899d798faa6ddcbe29e8ce9aba958bc23cb14c3ecdd0e0ce7de686b92b997957c73164a7f83c52f3283499a193eab96670bc9fdecec

data/.gitignore

@@ -1,4 +1,5 @@
 .ruby-version
+.idea/
 try.c
 try.rb
 gen.rb
@@ -11,6 +12,6 @@ libxlsxwriter/dev
 libxlsxwriter/docs
 libxlsxwriter/examples
 libxlsxwriter/test
-
+ext/fast_excel/text_width_ext.o
 ext/fast_excel/Makefile
 ext/fast_excel/text_width_ext.bundle

data/.travis.yml

@@ -3,26 +3,26 @@ language: ruby
 
 matrix:
   include:
+#  - os: linux
+#    rvm: 2.2.10
+#  - os: osx
+#    rvm: 2.2.10
   - os: linux
-    rvm: 2.1
+    rvm: 2.3.8
   - os: osx
-    rvm: 2.1
+    rvm: 2.3.8
   - os: linux
-    rvm: 2.2.7
+    rvm: 2.4.5
   - os: osx
-    rvm: 2.2.7
+    rvm: 2.4.5
   - os: linux
-    rvm: 2.3.4
+    rvm: 2.5.3
   - os: osx
-    rvm: 2.3.4
+    rvm: 2.5.3
   - os: linux
-    rvm: 2.4.0
+    rvm: 2.6.0
   - os: osx
-    rvm: 2.4.0
-  - os: linux
-    rvm: 2.5.0
-  - os: osx
-    rvm: 2.5.0
+    rvm: 2.6.0
   fast_finish: true
 
 script:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+#### Version 0.2.6 - 26 jan 2019
+
+* Add column auto width (thanks to @duffyjp)
+
 #### Version 0.2.5 - 22 jun 2018
 
 * Update libxlsxwriter to 0.7.7

data/Gemfile

@@ -5,7 +5,7 @@ gem 'ffi_gen', require: false
 
 gem 'rake'
 
-gem 'roo', '2.7.1', git: 'https://github.com/roo-rb/roo.git'
+gem 'roo', '2.8.1', git: 'https://github.com/roo-rb/roo.git', tag: 'v2.8.1'
 
 gem 'minitest'
 gem 'minitest-reporters'
@@ -13,5 +13,6 @@ gem 'minitest-reporters'
 # For benchmakrs
 gem 'axlsx', git: 'https://github.com/randym/axlsx.git'
 gem 'write_xlsx'
+gem 'xlsxtream'
 gem 'benchmark-ips'
 gem 'process_memory', git: 'https://github.com/paxa/process_memory', platforms: :ruby

data/Gemfile.lock

@@ -1,12 +1,12 @@
 GIT
   remote: https://github.com/paxa/process_memory
-  revision: 1aa4df28c9a98903301317236104abe591e086fd
+  revision: 282c75336a4a6b92207cd1eaa57f20887b92601e
   specs:
     process_memory (0.1)
 
 GIT
   remote: https://github.com/randym/axlsx.git
-  revision: 73d9477fc33706f4a186e92794134248fb389183
+  revision: c593a08b2a929dac7aa8dc418b55e26b4c49dc34
   specs:
     axlsx (3.0.0.pre)
       htmlentities (~> 4.3, >= 4.3.4)
@@ -16,9 +16,10 @@ GIT
 
 GIT
   remote: https://github.com/roo-rb/roo.git
-  revision: 3ed05e1caef0ce3c5db5c19f1fa14e6f74193079
+  revision: 5bbda9849ca6deb0ad8020c4476c1ab9ddfd824b
+  tag: v2.8.1
   specs:
-    roo (2.7.1)
+    roo (2.8.1)
       nokogiri (~> 1)
       rubyzip (>= 1.2.1, < 2.0.0)
 
@@ -28,28 +29,31 @@ GEM
     ansi (1.5.0)
     benchmark-ips (2.7.2)
     builder (3.2.3)
-    ffi (1.9.23)
+    ffi (1.10.0)
     ffi_gen (1.2.0)
       ffi (~> 1.0)
     htmlentities (4.3.4)
-    mimemagic (0.3.2)
-    mini_portile2 (2.3.0)
+    mimemagic (0.3.3)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
-    minitest-reporters (1.1.19)
+    minitest-reporters (1.3.6)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    rake (12.3.0)
-    ruby-progressbar (1.9.0)
-    rubyzip (1.2.1)
-    write_xlsx (0.85.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.2)
+    ruby-progressbar (1.10.0)
+    rubyzip (1.2.2)
+    write_xlsx (0.85.5)
       rubyzip (>= 1.0.0)
       zip-zip
+    xlsxtream (2.1.0)
+      zip_tricks (~> 4.5)
     zip-zip (0.3)
       rubyzip (>= 1.0.0)
+    zip_tricks (4.7.1)
 
 PLATFORMS
   ruby
@@ -63,8 +67,9 @@ DEPENDENCIES
   minitest-reporters
   process_memory!
   rake
-  roo (= 2.7.1)!
+  roo (= 2.8.1)!
   write_xlsx
+  xlsxtream
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/Makefile

@@ -4,6 +4,8 @@ Q=
 endif
 
 all :
+	@echo "Compiling ext/text_width ..."
+	rake compile
 	@echo "Compiling libxlsxwriter ..."
 	$(Q)$(MAKE) -C libxlsxwriter
 

data/README.md

@@ -20,17 +20,19 @@ worksheet.set_column(1, 1, 20, price)
 date_format = workbook.number_format("[$-409]m/d/yy h:mm AM/PM;@")
 worksheet.set_column(2, 2, 20, date_format)
 
-worksheet.write_row(0, ["message", "price", "date"], bold)
+worksheet.append_row(["message", "price", "date"], bold)
 
 for i in 1..1000
-  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now])
+  worksheet.append_row(["Hello", (rand * 10_000_000).round(2), Time.now])
 end
 
-worksheet.write_row(1001, ["Sum", FastExcel::Formula.new("SUM(B2:B1001)")], bold)
+worksheet.append_row(["Sum", FastExcel::Formula.new("SUM(B2:B1001)")], bold)
 
 workbook.close
 ```
 
+See [more examples](https://github.com/Paxa/fast_excel/tree/master/examples)
+
 This repository and gem contain sources of [libxlsxwriter](https://github.com/jmcnamara/libxlsxwriter)
 
 ## Benchmarks
@@ -69,6 +71,29 @@ Or
 gem install fast_excel
 ```
 
+## Column Auto Width
+
+Column authwidth only works for string values, because numbers may have custom formatting
+
+Enabling column auto widths will slow down writing string values for about 15-25%
+
+```ruby
+require 'fast_excel'
+
+workbook = FastExcel.open(constant_memory: true)
+
+worksheet = workbook.add_worksheet
+worksheet.auto_width = true
+
+worksheet.append_row(["some text", "some longer text for example"])
+
+content = workbook.read_string
+File.open('./some_file.xlsx', 'wb') {|f| f.write(content) }
+```
+
+![fast_excel_auto_width](https://user-images.githubusercontent.com/26019/51788441-ba981300-21b0-11e9-9611-54dda78effcd.png)
+
+
 ## API
 
 This gem is FFI binding for libxlsxwriter C library with some syntax sugar. All original functions is avaliable, for example:
@@ -93,3 +118,5 @@ Helper Methods:
 * `worksheet.write_row(row_num, array_of_mixed_value, formats = nil)` - write values one by one, detecting type automatically. `formats` can be array, or Format object or nil
 * `format.font_family` - alias for `format.font_name`
 * `workbook.default_format.font_size` - set it to 0 if you want to use default font size (that what user set in Excel settings)
+* `worksheet.write_row(num, values_array, formats = nil)` - Write row of values
+* `worksheet.append_row(values_array, formats = nil)` - Append row of values ot the bottom of worksheet

data/Rakefile

@@ -22,3 +22,11 @@ task :examples do
     require './' + file.sub(/\.rb$/, '')
   end
 end
+
+task :compile do
+  %x{
+    cd ext/fast_excel
+    ruby ./extconf.rb
+    make
+  }
+end

data/benchmarks/1k_rows.rb

@@ -1,6 +1,6 @@
 require_relative 'init'
 
-HEADERS = ["id", "name", "age", "date"]
+HEADERS = ["id", "name", "age", "date"].freeze
 
 DATA = []
 1000.times do |n|
@@ -8,15 +8,15 @@ DATA = []
 end
 
 Benchmark.ips do |x|
-  x.config(time: 10, warmup: 2)
+  x.config(time: 10, warmup: 40)
 
   x.report("FastExcel") do
     workbook = FastExcel.open(constant_memory: true)
     worksheet = workbook.add_worksheet("benchmark")
 
     worksheet.write_row(0, HEADERS)
-    DATA.each_with_index do |row, i|
-      worksheet.write_row(i + 1, row)
+    DATA.each do |row|
+      worksheet.append_row(row)
     end
     workbook.read_string
   end
@@ -55,5 +55,18 @@ Benchmark.ips do |x|
     File.delete(filename)
   end
 
+  x.report("xlsxtream") do
+    filename = "#{Dir.mktmpdir}/xlsxtream.xlsx"
+
+    Xlsxtream::Workbook.open(filename) do |xlsx|
+      xlsx.write_worksheet do |sheet|
+        sheet << HEADERS
+        DATA.each do |row|
+          sheet << row
+        end
+      end
+    end
+  end
+
   x.compare!
 end

data/benchmarks/20k_rows.rb

@@ -22,5 +22,9 @@ Benchmark.ips do |x|
     write_xlsx_20k
   end
 
+  x.report("xlsxtream") do
+    write_xlsxtream_20k
+  end
+
   x.compare!
 end

data/benchmarks/auto_width.rb

@@ -0,0 +1,37 @@
+require_relative 'init'
+
+HEADERS = ["id", "name", "age", "date"]
+
+DATA = []
+1000.times do |n|
+  DATA << [n, "String string #{n}", (n * rand * 10).round, Time.at(n * 1000 + 1492922688)]
+end
+
+Benchmark.ips do |x|
+  x.config(time: 10, warmup: 2)
+
+  x.report("Normal") do
+    workbook = FastExcel.open(constant_memory: true)
+    worksheet = workbook.add_worksheet("benchmark")
+
+    worksheet.write_row(0, HEADERS)
+    DATA.each_with_index do |row, i|
+      worksheet.write_row(i + 1, row)
+    end
+    workbook.read_string
+  end
+
+  x.report("With auto_width") do
+    workbook = FastExcel.open(constant_memory: true)
+    worksheet = workbook.add_worksheet("benchmark")
+    worksheet.auto_width = true
+
+    worksheet.write_row(0, HEADERS)
+    DATA.each_with_index do |row, i|
+      worksheet.write_row(i + 1, row)
+    end
+    workbook.read_string
+  end
+
+  x.compare!
+end

data/benchmarks/init.rb

@@ -8,10 +8,9 @@ require_relative '../lib/fast_excel'
 require "benchmark/ips"
 require 'axlsx'
 require 'write_xlsx'
+require 'xlsxtream'
 require 'process_memory'
 
-require_relative 'init'
-
 def write_fast_excel_20k
   workbook = FastExcel.open(constant_memory: true)
   worksheet = workbook.add_worksheet("benchmark")
@@ -57,3 +56,16 @@ def write_axlsx_20k
     File.delete(filename)
   end
 end
+
+def write_xlsxtream_20k
+  filename = "#{Dir.mktmpdir}/xlsxtream.xlsx"
+
+  Xlsxtream::Workbook.open(filename) do |xlsx|
+    xlsx.write_worksheet do |sheet|
+      sheet << HEADERS
+      DATA.each do |row|
+        sheet << row
+      end
+    end
+  end
+end

data/benchmarks/memory.rb

@@ -11,6 +11,7 @@ puts "warm up..."
 write_fast_excel_20k
 write_axlsx_20k
 write_xlsx_20k
+write_xlsxtream_20k
 
 DATA.clear
 50_000.times do |n|
@@ -47,3 +48,10 @@ sleep 5
 measure_memory("write_xlsx") do
   write_xlsx_20k
 end
+
+GC.start
+sleep 5
+
+measure_memory("xlsxtream") do
+  write_xlsxtream_20k
+end

data/benchmarks/profiler.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/fast_excel'
+require 'ruby-prof'
+
+DATA = []
+1000.times do |n|
+  DATA << [n, "String string #{n}", (n * rand * 10).round, Time.at(n * 1000 + 1492922688)]
+end
+
+RubyProf.start
+
+100.times do
+  workbook = FastExcel.open(constant_memory: true)
+  worksheet = workbook.add_worksheet("benchmark")
+  worksheet.auto_width = true
+
+  DATA.each_with_index do |row, i|
+    worksheet.write_row(i + 1, row)
+  end
+  workbook.read_string
+
+  print '.'
+end
+result = RubyProf.stop
+
+# print a flat profile to text
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)

data/benchmarks/write_value.rb

@@ -0,0 +1,62 @@
+require_relative '../lib/fast_excel'
+require "benchmark/memory"
+require "benchmark/ips"
+
+DATA = []
+1000.times do |n|
+  DATA << [n, "String string #{n}", (n * rand * 10).round, Time.at(n * 1000 + 1492922688)]
+end
+
+5.times do
+  workbook = FastExcel.open(constant_memory: true)
+  worksheet = workbook.add_worksheet("benchmark")
+
+  DATA.each_with_index do |row, row_num|
+    row.each_with_index do |val, cell_num|
+      worksheet.write_value(row_num + 1, cell_num + 1, val)
+    end
+  end
+  workbook.read_string
+end
+
+
+workbook = FastExcel.open(constant_memory: true)
+worksheet = workbook.add_worksheet("benchmark")
+
+DATA.each_with_index do |row, row_num|
+  row.each_with_index do |val, cell_num|
+    worksheet.write_value(row_num + 1, cell_num + 1, val)
+  end
+end
+workbook.read_string
+
+Benchmark.ips do |x|
+  #x.config(time: 10, warmup: 2)
+
+  x.report("Normal") do
+    workbook = FastExcel.open(constant_memory: true)
+    worksheet = workbook.add_worksheet("benchmark")
+
+    DATA.each_with_index do |row, row_num|
+      row.each_with_index do |val, cell_num|
+        worksheet.write_value(row_num + 1, cell_num + 1, val)
+      end
+    end
+    workbook.read_string
+  end
+
+  x.report("Auto-width") do
+    workbook = FastExcel.open(constant_memory: true)
+    worksheet = workbook.add_worksheet("benchmark")
+    worksheet.auto_width = true
+
+    DATA.each_with_index do |row, row_num|
+      row.each_with_index do |val, cell_num|
+        worksheet.write_value(row_num + 1, cell_num + 1, val)
+      end
+    end
+    workbook.read_string
+  end
+
+  x.compare!
+end