fast_excel 0.2.2 → 0.4.0

data/fast_excel.gemspec

@@ -1,14 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.2.2"
+  s.version     = "0.4.0"
   s.author      = ["Pavel Evstigneev"]
   s.email       = ["pavel.evst@gmail.com"]
   s.homepage    = "https://github.com/paxa/fast_excel"
-  s.summary     = %q{Ultra Fast Excel Writter}
+  s.summary     = %q{Ultra Fast Excel Writer}
   s.description = "Wrapper for libxlsxwriter using ffi"
   s.license     = 'MIT'
-  s.has_rdoc    = false
-  s.required_ruby_version = '~> 2.0'
+  s.required_ruby_version = ['>= 2.0', '< 4.0']
 
   s.files       = `git ls-files`.split("\n")
   s.test_files  = []

data/letters.html

@@ -0,0 +1,114 @@
+<style>
+  html, body {
+    font-family: Arial;
+  }
+  #result {
+    font-size: 14px;
+    font-family: Arial;
+    white-space: pre;
+  }
+</style>
+
+<select onchange="generateFor(this.value)">
+  <option></option>
+  <option>Arial</option>
+  <option>Calibri</option>
+  <option>Times New Roman</option>
+</select>
+
+<pre id="result">
+  
+</pre>
+
+<script>
+  function ready(fn){var d=document;(d.readyState=='loading')?d.addEventListener('DOMContentLoaded',fn):fn();}
+
+  let average = (array) => array.reduce((a, b) => a + b) / array.length;
+
+  window.widths = {};
+  window.combos = {};
+  window.characters = [];
+
+  for (var n = 32; n <= 126; n++) {
+    characters.push(String.fromCharCode(n));
+  }
+
+  function generateFor(fontFamily) {
+    window.widths = {};
+    window.combos = {};
+
+    var startTime = (new Date()).getTime();
+
+    var canvas = document.createElement('canvas').getContext('2d');
+    canvas.font = `normal 100px ${fontFamily}`;
+    canvas.textAlign = 'start';
+    canvas.textBaseline = 'alphabetic';
+
+    window.textWidth = function getWidth(value) {
+      return canvas.measureText(value).width;
+    }
+
+    characters.forEach((char) => {
+      widths[char] = textWidth(char);
+    });
+
+    characters.forEach((char1) => {
+      characters.forEach((char2) => {
+        var combined = textWidth(char1 + char2);
+        var expected = widths[char1] + widths[char2];
+
+        if (Math.abs(combined - expected) > 0.001) {
+          combos[ char1 + char2 ] = [combined, expected];
+          //console.log('delta', char1, char2, Math.abs(el.clientWidth - expected));
+        }
+      });
+    });
+
+    printOutput(startTime, fontFamily);
+  }
+
+  function printOutput(startTime, fontFamily) {
+    //document.querySelector('#result').innerText = JSON.stringify(widths, null, 4) + "\n" + JSON.stringify(combos, null, 4);
+    var fontPrefix = fontFamily.replace(/\s+/g, '_').toUpperCase();
+    var output = "";
+
+    var averageSize = average(Object.values(widths));
+
+    output += `static float ${fontPrefix}_DEFAULT = ${averageSize};\n`;
+    output += `static float ${fontPrefix}_CHAR_WIDTH[127] = {0`;
+    for (var n = 1; n <= 126; n++) {
+      output += `, ${widths[String.fromCharCode(n)] || '0' }`;
+    }
+    output += "};\n";
+
+    output += `static float ${fontPrefix}_KERNING[127][127] = {\n`;
+    for (var n1 = 0; n1 <= 126; n1++) {
+      var char1 = String.fromCharCode(n1);
+      var charDisplay = characters.includes(char1) ? char1 : '';
+
+      var prefix = `/* ${n1} : ${charDisplay} */`;
+      if (Object.keys(combos).some((pair) => { return pair[0] == char1 })) {
+        output += `  ${prefix} { 0`;
+        for (var n2 = 1; n2 <= 126; n2++) {
+          var char2 = String.fromCharCode(n2);
+          output += `, ${combos[char1 + char2] ? combos[char1 + char2][0] : '0' }`;
+        }
+        output += ` }${n1 == 126 ? '' : ','}\n`;
+      } else {
+        output += `  ${prefix} { 0 },\n`;
+      }
+    }
+    output += "};\n";
+
+    output += "\nKerning:\n";
+    Object.keys(combos).forEach((pair) => {
+      output += `${pair} = ${combos[pair][0]} (not ${combos[pair][1]})\n`
+    });
+
+    document.querySelector('#result').innerText = output;
+
+    var endTime = (new Date()).getTime();
+    //alert(`done ${endTime - startTime} ms`);
+    console.log(`done ${endTime - startTime} ms, ${Object.keys(combos).length} combos`);
+  }
+</script>

data/lib/fast_excel.rb

@@ -1,4 +1,8 @@
 require_relative './fast_excel/binding'
+require 'set'
+
+# not used for now
+#require_relative '../ext/fast_excel/text_width_ext'
 
 module FastExcel
 
@@ -9,20 +13,27 @@ module FastExcel
     end
   end
 
+  class URL
+    attr_accessor :url
+    def initialize(url)
+      @url = url
+    end
+  end
+
   DEF_COL_WIDTH = 8.43
 
   def self.open(filename = nil, constant_memory: false, default_format: nil)
     tmp_file = false
-    unless filename
+    if filename
+      if File.exist?(filename) && File.size(filename) > 0
+        raise ArgumentError, "File '#{filename}' already exists. FastExcel can not open existing files, only create new files"
+      end
+    else
       require 'tmpdir'
       filename = "#{Dir.mktmpdir}/fast_excel.xlsx"
       tmp_file = true
     end
 
-    unless filename
-      raise ArgumentError, "filename is required"
-    end
-
     filename = filename.to_s if defined?(Pathname) && filename.is_a?(Pathname)
 
     workbook = if constant_memory
@@ -294,7 +305,7 @@ module FastExcel
         if respond_to?("#{key}=")
           send("#{key}=", value)
         elsif respond_to?("set_#{key}=")
-            send("set_#{key}=", value)
+          send("set_#{key}=", value)
         else
           self[key] = value
         end
@@ -323,6 +334,8 @@ module FastExcel
 
     def initialize(struct)
       @is_open = true
+      @sheet_names = Set.new
+      @sheets = []
       super(struct)
     end
 
@@ -338,6 +351,8 @@ module FastExcel
       bold
     end
 
+    alias_method :bold_format, :bold_cell_format
+
     # "#,##0.00"
     # "[$-409]m/d/yy h:mm AM/PM;@"
     def number_format(pattern)
@@ -347,13 +362,31 @@ module FastExcel
     end
 
     def add_worksheet(sheetname = nil)
-      sheet = super
+      if !sheetname.nil?
+        if sheetname.length > Libxlsxwriter::SHEETNAME_MAX
+          raise ArgumentError, "Worksheet name '#{sheetname}' exceeds Excel's limit of #{Libxlsxwriter::SHEETNAME_MAX} characters"
+        elsif @sheet_names.include?(sheetname)
+          raise ArgumentError, "Worksheet name '#{sheetname}' is already in use"
+        end
+      end
+
+      sheet = super(sheetname)
       sheet.workbook = self
+      @sheets << sheet
+      @sheet_names << sheet[:name]
+      sheet
+    end
+
+    def get_worksheet_by_name(name)
+      sheet = super(name)
+      sheet.workbook = self
+
       sheet
     end
 
     def close
       @is_open = false
+      @sheets.each(&:close)
       super
     end
 
@@ -361,11 +394,11 @@ module FastExcel
       close if @is_open
       File.open(filename, 'rb', &:read)
     ensure
-      remove_tmp_file
+      remove_tmp_folder
     end
 
-    def remove_tmp_file
-      File.delete(filename) if tmp_file
+    def remove_tmp_folder
+      FileUtils.remove_entry(File.dirname(filename)) if tmp_file
     end
 
     def constant_memory?
@@ -379,6 +412,13 @@ module FastExcel
 
     include AttributeHelper
 
+    def initialize(struct)
+      @is_open = true
+      @col_formats = {}
+      @last_row_number = -1
+      super(struct)
+    end
+
     def write_row(row_number, values, formats = nil)
       values.each_with_index do |value, index|
         format = if formats
@@ -389,52 +429,118 @@ module FastExcel
       end
     end
 
+    def auto_width?
+      defined?(@auto_width) && @auto_width
+    end
+
+    def auto_width=(v)
+      @auto_width = v
+      @column_widths = {}
+    end
+
+    def calculated_column_widths
+      @column_widths || {}
+    end
+
     def write_value(row_number, cell_number, value, format = nil)
 
-      if workbook.constant_memory? && row_number < last_row_number
+      if workbook.constant_memory? && row_number < @last_row_number
         raise ArgumentError, "Can not write to saved row in constant_memory mode (attempted row: #{row_number}, last saved row: #{last_row_number})"
       end
 
       if value.is_a?(Numeric)
         write_number(row_number, cell_number, value, format)
-      elsif defined?(DateTime) && value.is_a?(DateTime)
-        write_datetime(row_number, cell_number, FastExcel.lxw_datetime(value), format)
+      elsif defined?(Date) && value.is_a?(Date)
+        write_datetime(row_number, cell_number, FastExcel.lxw_datetime(value.to_datetime), format)
       elsif value.is_a?(Time)
-        write_datetime(row_number, cell_number, FastExcel.lxw_time(value), format)
-      elsif value.is_a?(Formula)
+        write_number(row_number, cell_number, FastExcel.date_num(value), format)
+      elsif defined?(DateTime) && value.is_a?(DateTime)
+        write_number(row_number, cell_number, FastExcel.date_num(value), format)
+      elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        write_boolean(row_number, cell_number, value ? 1 : 0, format)
+      elsif value.is_a?(FastExcel::Formula)
         write_formula(row_number, cell_number, value.fml, format)
+      elsif value.is_a?(FastExcel::URL)
+        write_url(row_number, cell_number, value.url, format)
+        add_text_width(value.url, format, cell_number) if auto_width?
       else
         write_string(row_number, cell_number, value.to_s, format)
+        add_text_width(value, format, cell_number) if auto_width?
+      end
+
+      @last_row_number = row_number > @last_row_number ? row_number : @last_row_number
+    end
+
+    def add_text_width(value, format, cell_number)
+      font_size = 0
+      if format
+        font_size = format.font_size
       end
 
-      @last_row_number = row_number > last_row_number ? row_number : last_row_number
+      if font_size == 0
+        if @col_formats[cell_number] && @col_formats[cell_number].font_size
+          font_size = @col_formats[cell_number].font_size
+        end
+      end
+
+      if font_size == 0
+        font_size = workbook.default_format.font_size
+      end
+
+      font_size = 13 if font_size == nil || font_size == 0
+
+      scale = 0.08
+      new_width = (scale * font_size * value.to_s.length )
+      @column_widths[cell_number] = if new_width > (@column_widths[cell_number] || 0)
+        new_width
+      else
+        @column_widths[cell_number]
+      end
     end
 
     def append_row(values, formats = nil)
-      increment_last_row_number!
+      @last_row_number += 1
       write_row(last_row_number, values, formats)
     end
 
-    def last_row_number
-      defined?(@last_row_number) ? @last_row_number : -1
+    def <<(values)
+      append_row(values)
     end
 
-    def increment_last_row_number!
-      @last_row_number = last_row_number + 1
+    def last_row_number
+      @last_row_number
     end
 
-    def set_column(start_col, end_col, width, format = nil)
-      super(start_col, end_col, width, format)
+    def set_column(start_col, end_col, width = nil, format = nil)
+      super(start_col, end_col, width || DEF_COL_WIDTH, format)
+
+      return unless format
+      start_col.upto(end_col) do |i|
+        @col_formats[i] = format
+      end
     end
 
     def set_column_width(col, width)
-      set_column(col, col, width, nil)
+      set_column(col, col, width, @col_formats[col])
     end
 
     def set_columns_width(start_col, end_col, width)
-      set_column(start_col, end_col, width, nil)
+      start_col.upto(end_col) do |i|
+        set_column_width(i, width)
+      end
     end
 
+    def enable_filters!(start_col: 0, end_col:)
+      autofilter(start_col, 0, @last_row_number, end_col)
+    end
+
+    def close
+      if auto_width?
+        @column_widths.each do |num, width|
+          set_column_width(num, width + 0.2)
+        end
+      end
+    end
   end
 
   module FormatExt

data/lib/fast_excel/binding.rb

@@ -7,6 +7,8 @@ module Libxlsxwriter
 
   LIB_FILENAME = if RUBY_PLATFORM =~ /darwin/
     "libxlsxwriter.dylib"
+  elsif ['x64-mingw32', 'i386-mingw32'].include? RUBY_PLATFORM
+    "libxlsxwriter.dll"
   else
     "libxlsxwriter.so"
   end
@@ -119,6 +121,10 @@ module Libxlsxwriter
   
   SCHEMA_ROOT = "http://schemas.openxmlformats.org"
   
+
+  PORTRAIT = 1
+  LANDSCAPE = 0
+
   def error(message)
     fprintf(STDERR, "[ERROR][%s:%d]: \"message\"\n", FILE, LINE)
   end
@@ -317,24 +323,31 @@ module Libxlsxwriter
     :error_memory_malloc_failed, 1,
     :error_creating_xlsx_file, 2,
     :error_creating_tmpfile, 3,
-    :error_zip_file_operation, 4,
-    :error_zip_file_add, 5,
-    :error_zip_close, 6,
-    :error_null_parameter_ignored, 7,
-    :error_parameter_validation, 8,
-    :error_sheetname_length_exceeded, 9,
-    :error_invalid_sheetname_character, 10,
-    :error_sheetname_already_used, 11,
-    :error_128_string_length_exceeded, 12,
-    :error_255_string_length_exceeded, 13,
-    :error_max_string_length_exceeded, 14,
-    :error_shared_string_index_not_found, 15,
-    :error_worksheet_index_out_of_range, 16,
-    :error_worksheet_max_number_urls_exceeded, 17,
-    :error_image_dimensions, 18,
-    :max_errno, 19
+    :error_reading_tmpfile, 4,
+    :error_zip_file_operation, 5,
+    :error_zip_parameter_error, 6,
+    :error_zip_bad_zip_file, 7,
+    :error_zip_internal_error, 8,
+    :error_zip_file_add, 9,
+    :error_zip_close, 10,
+    :error_null_parameter_ignored, 11,
+    :error_parameter_validation, 12,
+    :error_sheetname_length_exceeded, 13,
+    :error_invalid_sheetname_character, 14,
+    :error_sheetname_start_end_apostrophe, 15,
+    :error_sheetname_already_used, 16,
+    :error_sheetname_reserved, 17,
+    :error_32_string_length_exceeded, 18,
+    :error_128_string_length_exceeded, 19,
+    :error_255_string_length_exceeded, 20,
+    :error_max_string_length_exceeded, 21,
+    :error_shared_string_index_not_found, 22,
+    :error_worksheet_index_out_of_range, 23,
+    :error_worksheet_max_number_urls_exceeded, 24,
+    :error_image_dimensions, 25,
+    :max_errno, 26
   ]
-  
+
   # = Fields:
   # :year ::
   #   (Integer) Year     : 1900 - 9999
@@ -887,6 +900,7 @@ module Libxlsxwriter
     include DrawingWrappers
     layout :file, :pointer,
            :embedded, :uchar,
+           :orientation, :uchar,
            :drawing_objects, DrawingObjects
   end
   
@@ -2610,9 +2624,7 @@ module Libxlsxwriter
            :zipfile_info, ZipFileinfo.by_value,
            :filename, :string,
            :buffer, :string,
-           :tmpdir, :string,
-           :chart_count, :ushort,
-           :drawing_count, :ushort
+           :tmpdir, :string
   end
   
   # @method packager_new(filename, tmpdir)
@@ -2620,7 +2632,7 @@ module Libxlsxwriter
   # @param [String] tmpdir 
   # @return [Packager] 
   # @scope class
-  attach_function :packager_new, :lxw_packager_new, [:string, :string], Packager
+  attach_function :packager_new, :lxw_packager_new, [:string, :string, :uchar], Packager
   
   # @method packager_free(packager)
   # @param [Packager] packager