fast_excel 0.2.6 → 0.3.0

data/Rakefile

@@ -17,12 +17,14 @@ 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

data/examples/example.rb

@@ -11,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")
@@ -20,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_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

@@ -10,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"

data/examples/example_hyperlink.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/fast_excel'
+
+workbook = FastExcel.open("example_hyperlink.xlsx", constant_memory: false)
+worksheet = workbook.add_worksheet
+worksheet.auto_width = true
+
+url_format = workbook.add_format(underline: :underline_single, font_color: :blue)
+
+worksheet.append_row([
+  "Ultra Fast Excel Writer for Ruby",
+  FastExcel::URL.new("https://github.com/Paxa/fast_excel"),
+  FastExcel::URL.new("postgres://localhost")
+], [nil, url_format])
+
+# Same as:
+#   worksheet.write_value(0, 0, "Ultra Fast Excel Writer for Ruby")
+#   worksheet.write_url(0, 1, "https://github.com/Paxa/fast_excel", url_format)
+
+workbook.close
+puts "Saved to file example_hyperlink.xlsx"

data/fast_excel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.2.6"
+  s.version     = "0.3.0"
   s.author      = ["Pavel Evstigneev"]
   s.email       = ["pavel.evst@gmail.com"]
   s.homepage    = "https://github.com/paxa/fast_excel"

data/lib/fast_excel.rb

@@ -13,12 +13,19 @@ 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
     if filename
-      if File.exist?(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
@@ -298,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
@@ -344,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)
@@ -353,16 +362,18 @@ module FastExcel
     end
 
     def add_worksheet(sheetname = nil)
-      sheetname = nil if sheetname == ""
-
-      if !sheetname.nil? && @sheet_names.include?(sheetname)
-        raise ArgumentError, "Worksheet name '#{sheetname}' is already in use"
+      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_names << sheetname
 
-      sheet = super
+      sheet = super(sheetname)
       sheet.workbook = self
       @sheets << sheet
+      @sheet_names << sheet[:name]
       sheet
     end
 
@@ -383,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?
@@ -445,8 +456,13 @@ module FastExcel
         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?(Formula)
+      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?
@@ -487,6 +503,10 @@ module FastExcel
       write_row(last_row_number, values, formats)
     end
 
+    def <<(values)
+      append_row(values)
+    end
+
     def last_row_number
       @last_row_number
     end
@@ -510,6 +530,10 @@ module FastExcel
       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|

data/lib/fast_excel/binding.rb

@@ -119,6 +119,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 +321,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 +898,7 @@ module Libxlsxwriter
     include DrawingWrappers
     layout :file, :pointer,
            :embedded, :uchar,
+           :orientation, :uchar,
            :drawing_objects, DrawingObjects
   end
   
@@ -2610,9 +2622,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 +2630,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 

data/lib/fast_excel/binding/chart.rb

@@ -906,7 +906,23 @@ module Libxlsxwriter
     :end_, 0,
     :no, 1
   ]
-  
+
+  enum :chart_error_bar_axis, [
+    :axis_x, 0,
+    :axis_y, 1
+  ]
+
+  enum :chart_axis_label_alignment, [
+    :align_center, 0,
+    :align_left, 1,
+    :align_right, 2
+  ]
+
+  enum :chart_axis_type, [
+    :axis_type_x, 0,
+    :axis_type_y, 1
+  ]
+
   # = Fields:
   # :type ::
   #   (Integer) 
@@ -1268,6 +1284,7 @@ module Libxlsxwriter
            :show_labels_legend, :uchar,
            :show_labels_percent, :uchar,
            :label_position, :uchar,
+           :label_align, :uchar,
            :label_separator, :uchar,
            :default_label_position, :uchar,
            :label_num_format, :string,
@@ -1934,6 +1951,7 @@ module Libxlsxwriter
            :in_use, :uchar,
            :chart_group, :uchar,
            :cat_has_num_fmt, :uchar,
+           :is_chartsheet, :uchar,
            :has_horiz_cat_axis, :uchar,
            :has_horiz_val_axis, :uchar,
            :style_id, :uchar,
@@ -1976,6 +1994,7 @@ module Libxlsxwriter
            :up_bar_fill, ChartFill,
            :down_bar_fill, ChartFill,
            :default_label_position, :uchar,
+           :is_protected, :uchar,
            :ordered_list_pointers, ChartOrderedListPointers.by_value,
            :list_pointers, ChartListPointers.by_value
   end

data/lib/fast_excel/binding/workbook.rb

@@ -6,7 +6,8 @@ module Libxlsxwriter
   #   (String) Directory to use for the temporary files created by libxlsxwriter.
   class WorkbookOptions < FFI::Struct
     layout :constant_memory, :uchar,
-           :tmpdir, :string
+           :tmpdir, :string,
+           :use_zip64, :uchar
   end
 
   # = Fields:
@@ -168,8 +169,11 @@ module Libxlsxwriter
   class Workbook < FFI::Struct
     include WorkbookWrappers
     layout :file, :pointer,
+           :sheets, Sheets.ptr,
            :worksheets, Worksheets.ptr,
+           :chartsheets, :pointer,
            :worksheet_names, WorksheetNames.ptr,
+           :chartsheet_names, :pointer,
            :charts, Charts.ptr,
            :ordered_charts, Charts.ptr,
            :formats, Formats.ptr,
@@ -180,6 +184,8 @@ module Libxlsxwriter
            :filename, :pointer,
            :options, WorkbookOptions.by_value,
            :num_sheets, :uint16,
+           :num_worksheets, :uint16,
+           :num_chartsheets, :uint16,
            :first_sheet, :uint16,
            :active_sheet, :uint16,
            :num_xf_formats, :uint16,
@@ -192,7 +198,9 @@ module Libxlsxwriter
            :has_png, :uchar,
            :has_jpeg, :uchar,
            :has_bmp, :uchar,
-           :used_xf_formats, HashTable.ptr
+           :used_xf_formats, HashTable.ptr,
+           :vba_project, :pointer,
+           :vba_codename, :pointer
   end
 
   attach_function :workbook_default_format, :workbook_default_format, [Workbook], Format

data/lib/fast_excel/binding/worksheet.rb

@@ -593,7 +593,7 @@ module Libxlsxwriter
     end
   
     # @return [nil] 
-    def right_to_left()
+    def set_right_to_left()
       Libxlsxwriter.worksheet_right_to_left(self)
     end
   
@@ -689,6 +689,7 @@ module Libxlsxwriter
            :array, :pointer,
            :merged_ranges, MergedRanges.ptr,
            :selections, Selections.ptr,
+           :data_validations, :pointer, # TODO add real definition for lxw_data_validations
            :image_data, ImageData.ptr,
            :chart_data, ChartData.ptr,
            :dim_rowmin, :uint32,
@@ -705,6 +706,7 @@ module Libxlsxwriter
            :hidden, :uint8,
            :active_sheet, :pointer,
            :first_sheet, :pointer,
+           :is_chartsheet, :uint8,
            :col_options, :pointer,
            :col_options_max, :uint16,
            :col_sizes, :pointer,
@@ -724,25 +726,29 @@ module Libxlsxwriter
            :rel_count, :uint16,
            :vertical_dpi, :uint16,
            :zoom, :uint16,
-           :filter_on, :uint8,
-           :fit_page, :uint8,
-           :hcenter, :uint8,
-           :orientation, :uint8,
-           :outline_changed, :uint8,
-           :outline_on, :uint8,
-           :page_order, :uint8,
-           :page_setup_changed, :uint8,
-           :page_view, :uint8,
-           :paper_size, :uint8,
-           :print_gridlines, :uint8,
-           :print_headers, :uint8,
+           :filter_on,             :uint8,
+           :fit_page,              :uint8,
+           :hcenter,               :uint8,
+           :orientation,           :uint8,
+           :outline_changed,       :uint8,
+           :outline_on,            :uint8,
+           :outline_style,         :uint8,
+           :outline_below,         :uint8,
+           :outline_right,         :uint8,
+           :page_order,            :uint8,
+           :page_setup_changed,    :uint8,
+           :page_view,             :uint8,
+           :paper_size,            :uint8,
+           :print_gridlines,       :uint8,
+           :print_headers,         :uint8,
            :print_options_changed, :uint8,
-           :right_to_left, :uint8,
-           :screen_gridlines, :uint8,
-           :show_zeros, :uint8,
-           :vba_codename, :uint8,
-           :vcenter, :uint8,
-           :zoom_scale_normal, :uint8,
+           :right_to_left,         :uint8,
+           :screen_gridlines,      :uint8,
+           :show_zeros,            :uint8,
+           :vcenter,               :uint8,
+           :zoom_scale_normal,     :uint8,
+           :num_validations,       :uint8,
+           :vba_codename, :pointer,
            :tab_color, :int,
            :margin_left, :double,
            :margin_right, :double,
@@ -891,13 +897,14 @@ module Libxlsxwriter
     :number_cell, 1,
     :string_cell, 2,
     :inline_string_cell, 3,
-    :formula_cell, 4,
-    :array_formula_cell, 5,
-    :blank_cell, 6,
-    :boolean_cell, 7,
-    :hyperlink_url, 8,
-    :hyperlink_internal, 9,
-    :hyperlink_external, 10
+    :inline_rich_string_cell, 4,
+    :formula_cell, 5,
+    :array_formula_cell, 6,
+    :blank_cell, 7,
+    :boolean_cell, 8,
+    :hyperlink_url, 9,
+    :hyperlink_internal, 10,
+    :hyperlink_external, 11
   ]
 
   # = Fields:
@@ -1552,4 +1559,14 @@ module Libxlsxwriter
     layout :stqh_first, Worksheet.ptr,
            :stqh_last, :pointer
   end
-end
+
+  class Sheet < FFI::Struct
+    layout :is_chartsheet, :uchar,
+           :list_pointers, :pointer
+  end
+
+  class Sheets < FFI::Struct
+    layout :stqh_first, Sheet.ptr,
+           :stqh_last, :pointer
+  end
+end