kmadej_fast_excel_fork 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c036baf1c91ac62746a505b2a05e5911da35172
+  data.tar.gz: 7b984910b9ba3a6f8a081fff195665815a4d6810
+SHA512:
+  metadata.gz: 7da1e648fc700d7ed47bd41bdfdf0fe11041e0cbc3671208d65afc0a76c43e85137f8de648ea1327905ce2fbd5ca9d2fd5bb5739a107d3644de808f407e32d42
+  data.tar.gz: 0184f0ac3e58b9acf1f44a3627bac1e7d1083cc32a211ec7c2ddd9846d3202152847960af57102f9c3bbe230b0a066b1dedc4b1238a9017414289cfaac1d4cf1

data/.gitignore

@@ -0,0 +1,13 @@
+.ruby-version
+try.c
+try.rb
+gen.rb
+gen_ffi.rb
+*.xlsx
+a.out
+.DS_Store
+*.gem
+libxlsxwriter/dev
+libxlsxwriter/docs
+libxlsxwriter/examples
+libxlsxwriter/test

data/.travis.yml

@@ -0,0 +1,28 @@
+---
+language: ruby
+
+matrix:
+  include:
+  - os: linux
+    rvm: 2.1
+  - os: osx
+    rvm: 2.1
+  - os: linux
+    rvm: 2.2.7
+  - os: osx
+    rvm: 2.2.7
+  - os: linux
+    rvm: 2.3.4
+  - os: osx
+    rvm: 2.3.4
+  - os: linux
+    rvm: 2.4.0
+  - os: osx
+    rvm: 2.4.0
+  fast_finish: true
+
+script:
+  - bundle install
+  - make
+  - bundle exec rake test
+  - bundle exec rake examples

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+#### Version 0.2.1 - 20 jun 2017
+
+* Add FastExcel::Formula
+
+#### Version 0.2.0 - 24 apr 2017
+
+* Add FastExcel.date_num
+* Add feature to use user default font
+* Add benchmarks
+
+#### Version 0.1.0 - 24 feb 2017
+
+Initial

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem 'ffi'
+gem 'ffi_gen', require: false
+
+gem 'rake'
+
+gem 'roo', '2.7.1', git: 'https://github.com/roo-rb/roo.git'
+
+gem 'minitest'
+gem 'minitest-reporters'
+
+# For benchmakrs
+gem 'axlsx', git: 'https://github.com/randym/axlsx.git'
+gem 'write_xlsx'
+gem 'benchmark-ips'
+gem 'process_memory', git: 'https://github.com/paxa/process_memory', platforms: :ruby

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GIT
+  remote: https://github.com/paxa/process_memory
+  revision: 1aa4df28c9a98903301317236104abe591e086fd
+  specs:
+    process_memory (0.1)
+
+GIT
+  remote: https://github.com/randym/axlsx.git
+  revision: c8ac844572b25fda358cc01d2104720c4c42f450
+  specs:
+    axlsx (2.1.0.pre)
+      htmlentities (~> 4.3.4)
+      mimemagic (~> 0.3)
+      nokogiri (>= 1.6.6)
+      rubyzip (>= 1.2.1)
+
+GIT
+  remote: https://github.com/roo-rb/roo.git
+  revision: 85c2736b0ea1c984391688c5aeb4acf85f225405
+  specs:
+    roo (2.7.1)
+      nokogiri (~> 1)
+      rubyzip (>= 1.2.1, < 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    benchmark-ips (2.7.2)
+    builder (3.2.3)
+    ffi (1.9.18)
+    ffi_gen (1.2.0)
+      ffi (~> 1.0)
+    htmlentities (4.3.4)
+    mimemagic (0.3.2)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    rake (12.0.0)
+    ruby-progressbar (1.8.1)
+    rubyzip (1.2.1)
+    write_xlsx (0.85.1)
+      rubyzip (>= 1.0.0)
+      zip-zip
+    zip-zip (0.3)
+      rubyzip (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  axlsx!
+  benchmark-ips
+  ffi
+  ffi_gen
+  minitest
+  minitest-reporters
+  process_memory!
+  rake
+  roo (= 2.7.1)!
+  write_xlsx
+
+BUNDLED WITH
+   1.15.1

data/Makefile

@@ -0,0 +1,14 @@
+Q=@
+ifdef V
+Q=
+endif
+
+all :
+	@echo "Compiling libxlsxwriter ..."
+	$(Q)$(MAKE) -C libxlsxwriter
+
+clean :
+	$(Q)$(MAKE) clean -C libxlsxwriter
+
+install :
+	@echo "Nothing to install"

data/README.md

@@ -0,0 +1,95 @@
+# Ultra Fast Excel Writter for Ruby
+
+```ruby
+require 'fast_excel'
+
+workbook = FastExcel.open("hello_world_ffi.xlsx", constant_memory: true)
+workbook.default_format.set(
+  font_size: 0, # user's default
+  font_family: "Arial"
+)
+
+worksheet = workbook.add_worksheet("Example Report")
+
+bold = workbook.bold_cell_format
+worksheet.set_column(0, 0, FastExcel::DEF_COL_WIDTH, bold)
+
+price = workbook.number_format("#,##0.00")
+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)
+
+for i in 1..1000
+  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now])
+end
+
+worksheet.write_row(1001, ["Sum", FastExcel::Formula.new("SUM(B2:B1001)")], bold)
+
+workbook.close
+```
+
+This repositiry and gem contain sources of [libxlsxwriter](https://github.com/jmcnamara/libxlsxwriter)
+
+## Benchmarks
+
+1000 rows:
+```
+Comparison:
+           FastExcel:       31.7 i/s
+               Axlsx:        8.0 i/s - 3.98x  slower
+          write_xlsx:        6.9 i/s - 4.62x  slower
+```
+
+20000 rows:
+```
+Comparison:
+           FastExcel:        1.4 i/s
+               Axlsx:        0.4 i/s - 3.46x  slower
+          write_xlsx:        0.1 i/s - 17.04x  slower
+```
+
+Max memory usage, generating 100k rows:
+```
+FastExcel   - 20 MB
+Axlsx       - 60 MB
+write_xlsx - 100 MB
+```
+
+## Install
+
+```ruby
+# Gemfile
+gem 'fast_excel'
+```
+Or
+```
+gem install fast_excel
+```
+
+## API
+
+This gem is FFI binding for libxlsxwriter C library with some syntax sugar. All original functions is avaliable, for example:
+
+```ruby
+Libxlsxwriter.worksheet_activate(worksheet) # => will call void worksheet_activate(lxw_worksheet *worksheet)
+# or shorter:
+worksheet.activate
+```
+
+Full libxlsxwriter documentation: [http://libxlsxwriter.github.io/](http://libxlsxwriter.github.io/)
+
+Helper Methods:
+
+* `FastExcel.open(filename = nil, constant_memory: false, default_format: {})` - open new workbook, if `filename` is nil - it will craete tmp file, `default_format` will be called with `workbook.default_format.set(...)`
+* `FastExcel.date_num(time, offset = nil)` - generate Excel's internal date value, number of days since 1900-Jan-01, works faster then creating `Libxlsxwriter::Datetime` struct. `offset` argument is number hours from UTC, e.g. `3.5`
+* `FastExcel.print_ffi_obj(object)` - print FFI object fields, just for debugging
+* `workbook.bold_cell_format` - shortcut for creating bold format
+* `workbook.number_format(num_format)` - create number or date format, for money usually: `"#,##0.00"`, for date: `"[$-409]m/d/yy h:mm AM/PM;@"`
+* `workbook.read_string` - close workbook, read file to string, delete file (only if tmp file)
+* `workbook.remove_tmp_file` - delete tmp file (only if tmp file)
+* `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)

data/Rakefile

@@ -0,0 +1,24 @@
+desc "Sync github.com:Paxa/libxlsxwriter to ./libxlsxwriter"
+task :sync do
+  require 'fileutils'
+  FileUtils.rm_rf("./libxlsxwriter")
+  system("git clone --depth 10 git@github.com:Paxa/libxlsxwriter.git")
+  Dir.chdir("./libxlsxwriter") do
+    system("git show --pretty='format:%cd %h' --date=iso --quiet > version.txt")
+    FileUtils.rm_rf("./.git")
+  end
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.test_files = Dir.glob('test/**/*_test.rb')
+end
+
+#task :default => :test
+
+task :examples do
+  Dir.glob('examples/**/*.rb').each do |file|
+    require './' + file.sub(/\.rb$/, '')
+  end
+end

data/appveyor.yml

@@ -0,0 +1,25 @@
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - SET PATH=C:\MinGW\bin;%PATH%
+  - SET RAKEOPT=-rdevkit
+  - copy c:\MinGW\bin\mingw32-make.exe c:\MinGW\bin\make.exe
+  - ruby --version
+  - gem --version
+  - bundle install
+  - make
+
+build: off
+
+test_script:
+  - bundle exec rake test
+
+environment:
+  matrix:
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"

data/benchmarks/1k_rows.rb

@@ -0,0 +1,59 @@
+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("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)
+    end
+    workbook.read_string
+  end
+
+  x.report("Axlsx") do
+    filename = "#{Dir.mktmpdir}/axlsx.xlsx"
+    Axlsx::Package.new do |package|
+      package.use_autowidth = false
+      package.workbook.add_worksheet do |sheet|
+        sheet.add_row(HEADERS)
+        DATA.each do |row|
+          sheet.add_row(row)
+        end
+      end
+      package.serialize(filename)
+      File.open(filename, 'rb', &:read)
+      File.delete(filename)
+    end
+  end
+
+  x.report("write_xlsx") do
+    filename = "#{Dir.mktmpdir}/write_xlsx.xlsx"
+    workbook = WriteXLSX.new(filename)
+    worksheet = workbook.add_worksheet
+    HEADERS.each_with_index do |value, i|
+      worksheet.write(0, i, value)
+    end
+    DATA.each_with_index do |row, row_num|
+      worksheet.write_number(row_num + 1, 0, row[0])
+      worksheet.write_string(row_num + 1, 1, row[1])
+      worksheet.write_number(row_num + 1, 2, row[2])
+      worksheet.write_number(row_num + 1, 3, row[3])
+    end
+    workbook.close
+    File.open(filename, 'rb', &:read)
+    File.delete(filename)
+  end
+
+  x.compare!
+end

data/benchmarks/20k_rows.rb

@@ -0,0 +1,26 @@
+require_relative 'init'
+
+HEADERS = ["id", "name", "age", "date", "random"]
+
+DATA = []
+20_000.times do |n|
+  DATA << [n, "String string #{n}" * 5, (n * rand * 10).round, Time.at(n * 1000 + 1492922688), n * 100]
+end
+
+Benchmark.ips do |x|
+  x.config(time: 10, warmup: 2)
+
+  x.report("FastExcel") do
+    write_fast_excel_20k
+  end
+
+  x.report("Axlsx") do
+    write_axlsx_20k
+  end
+
+  x.report("write_xlsx") do
+    write_xlsx_20k
+  end
+
+  x.compare!
+end

data/benchmarks/init.rb

@@ -0,0 +1,59 @@
+require 'bundler/setup'
+require 'fileutils'
+require 'tmpdir'
+require_relative '../lib/fast_excel'
+
+# gem install axlsx benchmark-ips write_xlsx
+
+require "benchmark/ips"
+require 'axlsx'
+require 'write_xlsx'
+require 'process_memory'
+
+require_relative 'init'
+
+def write_fast_excel_20k
+  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
+
+def write_xlsx_20k
+  filename = "#{Dir.mktmpdir}/write_xlsx.xlsx"
+  workbook = WriteXLSX.new(filename)
+  worksheet = workbook.add_worksheet
+  HEADERS.each_with_index do |value, i|
+    worksheet.write(0, i, value)
+  end
+  DATA.each_with_index do |row, row_num|
+    worksheet.write_number(row_num + 1, 0, row[0])
+    worksheet.write_string(row_num + 1, 1, row[1])
+    worksheet.write_number(row_num + 1, 2, row[2])
+    worksheet.write_number(row_num + 1, 3, row[3])
+    worksheet.write_number(row_num + 1, 4, row[4])
+  end
+  workbook.close
+  File.open(filename, 'rb', &:read)
+  File.delete(filename)
+end
+
+def write_axlsx_20k
+  filename = "#{Dir.mktmpdir}/axlsx.xlsx"
+  Axlsx::Package.new do |package|
+    package.use_autowidth = false
+    package.workbook.add_worksheet do |sheet|
+      sheet.add_row(HEADERS)
+      DATA.each do |row|
+        sheet.add_row(row)
+      end
+    end
+    package.serialize(filename)
+    File.open(filename, 'rb', &:read)
+    File.delete(filename)
+  end
+end