fast_excel 0.2.1 → 0.3.0

data/Rakefile

@@ -16,3 +16,19 @@ Rake::TestTask.new do |test|
 end
 
 #task :default => :test
+
+desc "Run all examples"
+task :examples do
+  Dir.glob('examples/**/*.rb').each do |file|
+    require './' + file.sub(/\.rb$/, '')
+  end
+end
+
+desc "Compile libxlsxwriter shared library"
+task :compile do
+  %x{
+    cd ext/fast_excel
+    ruby ./extconf.rb
+    make
+  }
+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

@@ -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

data/examples/example.rb

@@ -1,5 +1,4 @@
 require_relative '../lib/fast_excel'
-require 'pp'
 
 workbook = FastExcel.open("example.xlsx", constant_memory: true)
 
@@ -12,7 +11,7 @@ workbook.default_format.set(
 
 worksheet = workbook.add_worksheet("Payments Report")
 
-bold = workbook.bold_cell_format
+bold = workbook.bold_format
 worksheet.set_column(0, 0, FastExcel::DEF_COL_WIDTH, bold)
 
 price = workbook.number_format("#,##0.00")
@@ -21,10 +20,10 @@ 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.write_row(0, ["message", "price", "date", "complete"], bold)
 
 for i in 1..1000
-  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now])
+  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now, i % 2 == 0])
 
   # Or manually
   # worksheet.write_string(i, 0, "Hello", nil)

data/examples/example_align.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/fast_excel'
+
+workbook = FastExcel.open("example_align.xlsx", constant_memory: true)
+
+worksheet = workbook.add_worksheet
+
+row_format = workbook.add_format
+
+row_format.align = {h: :center, v: :center}
+# Can also be called as:
+# row_format.align = :align_center
+# row_format.align = :align_vertical_center
+
+print "Align set as: "
+p row_format.align # => {horizontal: :align_center, vertical: :align_vertical_center}
+
+worksheet.set_column_width(0, 30)
+worksheet.set_row(0, 30, row_format)
+
+worksheet.write_row(0, ["Hello"])
+
+workbook.close
+puts "Saved to file example_align.xlsx"

data/examples/example_auto_width.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/fast_excel'
+
+workbook = FastExcel.open("example_auto_width.xlsx", constant_memory: false)
+
+# this is required to make auto-width works correctly
+workbook.default_format.set(
+  font_size: 13,
+  font_family: "Arial"
+)
+
+worksheet = workbook.add_worksheet
+worksheet.auto_width = true
+
+['Arial', 'Calibri', 'Times New Roman'].each_with_index do |font, index|
+  col_format = workbook.add_format(font_family: font, font_size: 17)
+  worksheet.set_column(index * 4, index * 4 + 3, 10, col_format)
+
+  worksheet.write_value(0, index * 4 + 2, font)
+  worksheet.write_value(1, index * 4, "tini")
+  worksheet.write_value(1, index * 4 + 1, "Longer")
+  worksheet.write_value(1, index * 4 + 2, "Some longer text!")
+  worksheet.write_value(1, index * 4 + 3, "This gem is FFI binding for libxlsxwriter C library")
+end
+
+workbook.close
+puts "Saved to file example_auto_width.xlsx"

data/examples/example_colors.rb

@@ -0,0 +1,37 @@
+require_relative '../lib/fast_excel'
+
+workbook = FastExcel.open("example_colors.xlsx", constant_memory: true)
+
+worksheet = workbook.add_worksheet
+
+color_format = workbook.add_format
+
+# We can use color names as string and symbols, color hex codes and color hex numbers
+
+color_format.set(
+  font_color: '9900FF',
+  bg_color: '#FFAAAA',
+
+  border_bottom: :medium,
+  border_bottom_color: 'green',
+
+  border_left: :slant_dash_dot,
+  border_left_color: 0x00FF00,
+
+  border_right: :double,
+  border_right_color: :crimson,
+
+  border_top: :border_hair,
+  border_top_color: :medium_blue
+)
+
+# Possible border styles:
+# [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :medium_dashed,
+#  :dash_dot, :medium_dash_dot, :dash_dot_dot, :medium_dash_dot_dot, :slant_dash_dot]
+
+worksheet.set_column_width(1, 30)
+
+worksheet.write_value(1, 1, "Hello", color_format)
+
+workbook.close
+puts "Saved to file example_colors.xlsx"

data/examples/example_filters.rb

@@ -0,0 +1,36 @@
+require_relative '../lib/fast_excel'
+
+`rm example_filters.xlsx` if File.exist?('example_filters.xlsx')
+workbook = FastExcel.open("example_filters.xlsx", constant_memory: false)
+
+workbook.default_format.set(
+  font_size: 0, # user's default
+  #font_family: "Arial"
+)
+
+# pp workbook.default_format
+
+worksheet = workbook.add_worksheet("Payments Report")
+
+p worksheet[:filter_on]
+FastExcel.print_ffi_obj(worksheet)
+
+bold = workbook.bold_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", "complete"], bold)
+
+for i in 1..1000
+  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now, i % 2 == 0])
+end
+
+worksheet.enable_filters!(end_col: 3)
+
+workbook.close
+puts "Saved to file example_filters.xlsx"

data/examples/example_formula.rb

@@ -1,6 +1,4 @@
 require_relative '../lib/fast_excel'
-require 'pp'
-require 'looksee'
 
 workbook = FastExcel.open("example_formula.xlsx", constant_memory: false)
 
@@ -12,9 +10,7 @@ worksheet.write_row(2, ["Phone", 0.138])
 worksheet.write_row(3, ["Mouse", 0.099])
 worksheet.write_row(4, ["Speaker", 2.5])
 worksheet.write_row(5, ["Camera", 0.383])
-worksheet.write_row(6, ["Total", FastExcel::Formula.new("SUM(B2:B6)")], workbook.bold_cell_format)
-
-bold = workbook.bold_cell_format
+worksheet.write_row(6, ["Total", FastExcel::Formula.new("SUM(B2:B6)")], workbook.bold_format)
 
 workbook.close
 puts "Saved to file example_formula.xlsx"