fast_excel 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7acf199afdfc96f315ac6487ec4c72a25f6624388d2139821ca1a14aaac9a5e
-  data.tar.gz: 071322b38f573d7774a26025c1f866203a9e1b0b0bca143fdbedfc81af274fd0
+  metadata.gz: 792a2afe9492aeeaba9fbb65da941d2b604a2fd14bf934b17662fdf05281ac32
+  data.tar.gz: 11795006b99d4fc9403fd3f85ab6babff417b1ed49341a2081073852063d2a71
 SHA512:
-  metadata.gz: f0f4583c984b84dd9e4960771ab1d094ade8fc271d66e7052b3bb249a870e5fec0302a898652e020cec61d17ceaa2babf73cf84a3a2556c05f83e1b8cf82182b
-  data.tar.gz: 162dee5762798ce6ecac84bcc0cc10f38f03f46d3fd4eb490c039dc2e67ede50294f7bfd744be72e58dedacc41c3aad76997a1642ba3e379d8c33d8edca938d0
+  metadata.gz: 7215d937426efb2580ba947c727a60a519fb411a5504eb58162a1646057bd191812eae00394ac9c915a9f7f53a6acf6cfff66e4d773a8ac579bb3494164c3292
+  data.tar.gz: 9f381f209a7d4f7c22a0994ed241b2be0a67d994c400f7867529fa1fa95fbc6326189a9dc53588f0bfbc376933ffab6fee4eaee37f7ac57d6a4f68a66295c8cc

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: [2.7, '3.0', 3.1, 3.2, 3.3]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - run: bundle config set --local without 'benchmarks'
+      - run: bundle install
+      - run: make
+      - run: make install
+
+      - run: rake test
+      - run: rake examples
+      - run: gem build fast_excel.gemspec

data/.gitignore

@@ -18,3 +18,5 @@ libxlsxwriter/test
 ext/fast_excel/text_width_ext.o
 ext/fast_excel/Makefile
 ext/fast_excel/text_width_ext.bundle
+Gemfile.lock
+lib/libxlsxwriter.dylib

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+#### Version 0.5.0 - 02 jan 2024
+
+* Support ruby 3.3
+* Sync latest libxlsxwriter
+* Add support for writing cell comments
+* Add more examples
+* Fix compilation of minizip on NixOS (Thanks to @Mange)
+* On close set empty columns to default width (Thanks to @steffansluis)
+
+#### Version 0.4.1 - 13 jan 2023
+
+* Support ruby 3.2
+* Improve library loading (Thanks to @sly7-7 and @BrianHawley)
+* Ensure Time.zone is not nil (Thanks to @ksuh90)
+* Get utc_offset from current value if possible (Thanks to @KevinSchiffmann)
+* Validate worksheet name using Libxlsxwriter (Thanks to @datbth)
+* Fix readme typo (Thanks to @sw4d)
+
 #### Version 0.4.0 - 14 feb 2021
 
 * Support ruby 3.0

data/Gemfile

@@ -1,18 +1,19 @@
 source 'https://rubygems.org'
 
-gem 'ffi'
-gem 'ffi_gen', require: false
+gemspec
 
 gem 'rake'
 
-gem 'roo', '2.8.3', git: 'https://github.com/roo-rb/roo.git', tag: 'v2.8.3'
+gem 'roo'
 
 gem 'minitest'
 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
+
+group :benchmarks do
+  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
+end

data/Makefile

@@ -3,12 +3,39 @@ ifdef V
 Q=
 endif
 
+UNAME := $(shell uname)
+
+LIBXLSXWRITER_SO = libxlsxwriter.so
+
+ifeq ($(UNAME), Darwin)
+LIBXLSXWRITER_SO = libxlsxwriter.dylib
+endif
+
+# Check for MinGW/MinGW64/Cygwin environments.
+ifneq (,$(findstring MINGW, $(UNAME)))
+MING_LIKE = y
+endif
+ifneq (,$(findstring MSYS, $(UNAME)))
+MING_LIKE = y
+endif
+ifneq (,$(findstring CYGWIN, $(UNAME)))
+MING_LIKE = y
+endif
+
+ifdef MING_LIKE
+LIBXLSXWRITER_SO = libxlsxwriter.dll
+endif
+
 # with xcode better to use cmake
 UNAME_S := $(shell uname -s)
 ifeq ($(UNAME_S),"Darwin")
 	USE_CMAKE := $(shell command -v cmake 2> /dev/null)
 endif
 
+ifndef ($(sitearchdir))
+	sitearchdir = './lib'
+endif
+
 all :
 	# @echo "Compiling ext/text_width ..."
 	# rake compile
@@ -24,4 +51,4 @@ clean :
 	$(Q)$(MAKE) clean -C libxlsxwriter
 
 install :
-	@echo "Nothing to install"
+	$(Q)cp libxlsxwriter/lib/$(LIBXLSXWRITER_SO) $(sitearchdir)

data/README.md

@@ -55,7 +55,7 @@ workbook = FastExcel.open # creates tmp file
 send_data(workbook.read_string, filename: "table.xlsx") # read tmp file and delete it
 ```
 
-Also can use  `workbook.remove_tmp_file` to delete tmp file manually
+Also can use  `workbook.remove_tmp_folder` to delete tmp file manually
 
 
 **Constant memory mode**: saves each row to disk, good for really big files but can not change previous lines that already saved
@@ -118,7 +118,7 @@ worksheet.write_url(0, 2, "https://github.com/Paxa/fast_excel", url_format)
 
 ### Data Formatting
 ```ruby
-format = worksheet.add_format(
+format = workbook.add_format(
   bold: true,
   italic: true,
   font_outline: true,

data/examples/example.rb

@@ -22,6 +22,8 @@ worksheet.set_column(2, 2, 20, date_format)
 
 worksheet.write_row(0, ["message", "price", "date", "complete"], bold)
 
+worksheet.write_comment(2, 2, "Comment to field")
+
 for i in 1..1000
   worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now, i % 2 == 0])
 

data/examples/example_date_time.rb

@@ -0,0 +1,38 @@
+require_relative '../lib/fast_excel'
+
+require 'date'
+require 'time'
+
+
+File.unlink("example_date_time.xlsx") if File.exist?("example_date_time.xlsx")
+
+workbook = FastExcel.open("example_date_time.xlsx", constant_memory: true)
+workbook.default_format.set(
+  font_size: 0, # user's default
+)
+worksheet = workbook.add_worksheet
+
+worksheet.set_columns_width(0, 4, 25)
+worksheet.set_column(1, 1, 25, workbook.number_format("[$-409]m/d/yy hh:mm;@"))
+
+intro = "Date and time in excel file stored as decimal number, it show number of days since January 1900, decimal part is for time of the day"
+worksheet.merge_range(0, 0, 0, 4, intro, nil)
+worksheet.write_value(1, 0, "")
+
+worksheet.append_row(['', 'Formatted as Date', 'No formatting, plain number'])
+
+worksheet.append_row(["Time.now", Time.now, Time.now, 'local timezone'])
+worksheet.append_row(["Time.now.utc", Time.now.utc, Time.now.utc, 'UTC timezone'])
+
+worksheet.append_row(["DateTime.now", DateTime.now, DateTime.now, 'local timezone'])
+dt = DateTime.now.new_offset("+02:00")
+worksheet.append_row(["DateTime new_offset", dt, dt, 'GMT+2 timezone'])
+
+today = Date.today
+worksheet.append_row(["Date.today", today, today])
+
+worksheet.append_row(["0 (just zero)", 0, 0, '00 January 1900'])
+
+
+workbook.close
+puts "Saved to file example_date_time.xlsx"

data/examples/example_filters.rb

@@ -12,8 +12,8 @@ workbook.default_format.set(
 
 worksheet = workbook.add_worksheet("Payments Report")
 
-p worksheet[:filter_on]
-FastExcel.print_ffi_obj(worksheet)
+# p worksheet[:filter_on]
+# FastExcel.print_ffi_obj(worksheet)
 
 bold = workbook.bold_format
 worksheet.set_column(0, 0, FastExcel::DEF_COL_WIDTH, bold)

data/fast_excel.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.4.0"
+  s.version     = "0.5.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 Writer}
   s.description = "Wrapper for libxlsxwriter using ffi"
   s.license     = 'MIT'
-  s.required_ruby_version = ['>= 2.0', '< 4.0']
+  s.required_ruby_version = ['>= 2.0']
 
   s.files       = `git ls-files`.split("\n")
   s.test_files  = []

data/lib/fast_excel/binding/format.rb

@@ -697,9 +697,14 @@ module Libxlsxwriter
     include FormatWrappers
     layout :file, :pointer,
            :xf_format_indices, :pointer, #HashTable.ptr,
+           :dxf_format_indices, :pointer,
            :num_xf_formats, :pointer,
+           :num_dxf_formats, :pointer,
+
            :xf_index, :int32_t,
            :dxf_index, :int32_t,
+           :xf_id, :int32_t,
+
            :num_format, [:char, 128],
            :font_name, [:char, 128],
            :font_scheme, [:char, 128],
@@ -708,6 +713,7 @@ module Libxlsxwriter
            :has_font, :uchar,
            :has_dxf_font, :uchar,
            :font_size, :double,
+
            :bold, :uchar,
            :italic, :uchar,
            :font_color, :int,
@@ -722,24 +728,32 @@ module Libxlsxwriter
            :font_extend, :uchar,
            :theme, :uchar,
            :hyperlink, :uchar,
+
            :hidden, :uchar,
            :locked, :uchar,
+
            :text_h_align, :uchar,
            :text_wrap, :uchar,
            :text_v_align, :uchar,
            :text_justlast, :uchar,
            :rotation, :short,
+
            :fg_color, :int,
            :bg_color, :int,
+           :dxf_fg_color, :int,
+           :dxf_bg_color, :int,
+
            :pattern, :uchar,
            :has_fill, :uchar,
            :has_dxf_fill, :uchar,
            :fill_index, :int,
            :fill_count, :int,
+
            :border_index, :int,
            :has_border, :uchar,
            :has_dxf_border, :uchar,
            :border_count, :int,
+
            :bottom, :uchar,
            :diag_border, :uchar,
            :diag_type, :uchar,
@@ -751,6 +765,7 @@ module Libxlsxwriter
            :left_color, :int,
            :right_color, :int,
            :top_color, :int,
+
            :indent, :uchar,
            :shrink, :uchar,
            :merge_range, :uchar,
@@ -758,6 +773,8 @@ module Libxlsxwriter
            :just_distrib, :uchar,
            :color_indexed, :uchar,
            :font_only, :uchar,
+
+           :quote_prefix, :uchar,
            :list_pointers, FormatListPointers.by_value
   end
 

data/lib/fast_excel/binding/workbook.rb

@@ -7,7 +7,9 @@ module Libxlsxwriter
   class WorkbookOptions < FFI::Struct
     layout :constant_memory, :uchar,
            :tmpdir, :string,
-           :use_zip64, :uchar
+           :use_zip64, :uchar,
+           :output_buffer, :pointer,
+           :output_buffer_size, :pointer
   end
 
   # = Fields:
@@ -147,7 +149,7 @@ module Libxlsxwriter
     # @param [String] sheetname 
     # @return [Symbol from _enum_error_] 
     def validate_worksheet_name(sheetname)
-      Libxlsxwriter.workbook_validate_worksheet_name(self, sheetname)
+      Libxlsxwriter.workbook_validate_sheet_name(self, sheetname)
     end
   
     # @return [nil] 
@@ -174,6 +176,9 @@ module Libxlsxwriter
            :chartsheets, :pointer,
            :worksheet_names, WorksheetNames.ptr,
            :chartsheet_names, :pointer,
+           :image_md5s, :pointer,
+           :header_image_md5s, :pointer,
+           :background_md5s, :pointer,
            :charts, Charts.ptr,
            :ordered_charts, Charts.ptr,
            :formats, Formats.ptr,
@@ -181,26 +186,43 @@ module Libxlsxwriter
            :sst, Sst.ptr,
            :properties, DocProperties.ptr,
            :custom_properties, CustomProperties.ptr,
-           :filename, :pointer,
+           :filename, :string,
            :options, WorkbookOptions.by_value,
-           :num_sheets, :uint16,
-           :num_worksheets, :uint16,
-           :num_chartsheets, :uint16,
-           :first_sheet, :uint16,
-           :active_sheet, :uint16,
-           :num_xf_formats, :uint16,
+
+           :num_sheets,       :uint16,
+           :num_worksheets,   :uint16,
+           :num_chartsheets,  :uint16,
+           :first_sheet,      :uint16,
+           :active_sheet,     :uint16,
+           :num_xf_formats,   :uint16,
+           :num_dxf_formats,  :uint16,
            :num_format_count, :uint16,
-           :drawing_count, :uint16,
-           :font_count, :uint16,
-           :border_count, :uint16,
-           :fill_count, :uint16,
-           :optimize, :uchar,
-           :has_png, :uchar,
+           :drawing_count,    :uint16,
+           :comment_count,    :uint16,
+
+           :font_count,     :uint16,
+           :border_count,   :uint16,
+           :fill_count,     :uint16,
+           :optimize,       :uchar,
+           :max_url_length, :uint16,
+           :read_only,      :uchar,
+
+           :has_png,  :uchar,
            :has_jpeg, :uchar,
-           :has_bmp, :uchar,
+           :has_bmp,  :uchar,
+           :has_gif, :uchar,
+           :has_vml, :uchar,
+           :has_comments, :uchar,
+           :has_metadata, :uchar,
+
            :used_xf_formats, HashTable.ptr,
-           :vba_project, :pointer,
-           :vba_codename, :pointer
+           :used_dxf_formats, HashTable.ptr,
+
+           :vba_project, :string,
+           :vba_project_signature, :string,
+           :vba_codename, :string,
+
+           :default_url_format, :pointer
   end
 
   attach_function :workbook_default_format, :workbook_default_format, [Workbook], Format
@@ -319,12 +341,12 @@ module Libxlsxwriter
   # @scope class
   attach_function :workbook_get_worksheet_by_name, :workbook_get_worksheet_by_name, [Workbook, :string], Worksheet
 
-  # @method workbook_validate_worksheet_name(workbook, sheetname)
+  # @method workbook_validate_sheet_name(workbook, sheetname)
   # @param [Workbook] workbook 
   # @param [String] sheetname 
   # @return [Symbol from _enum_error_] 
   # @scope class
-  attach_function :workbook_validate_worksheet_name, :workbook_validate_worksheet_name, [Workbook, :string], :error
+  attach_function :workbook_validate_sheet_name, :workbook_validate_sheet_name, [Workbook, :string], :error
 
   # @method workbook_free(workbook)
   # @param [Workbook] workbook 

data/lib/fast_excel/binding/worksheet.rb

@@ -209,7 +209,11 @@ module Libxlsxwriter
     def write_string(row, col, string, format)
       Libxlsxwriter.worksheet_write_string(self, row, col, string, format)
     end
-  
+
+    def write_comment(row, col, string)
+      Libxlsxwriter.worksheet_write_comment(self, row, col, string)
+    end
+
     # @param [Integer] row 
     # @param [Integer] col 
     # @param [String] formula 
@@ -684,29 +688,45 @@ module Libxlsxwriter
     include WorksheetWrappers
     layout :file, :pointer,
            :optimize_tmpfile, :pointer,
+           :optimize_buffer, :pointer,
+           :optimize_buffer_size, :size_t,
            :table, TableRows.ptr,
            :hyperlinks, TableRows.ptr,
+           :comments, TableRows.ptr,
            :array, :pointer,
            :merged_ranges, MergedRanges.ptr,
-           :selections, Selections.ptr,
+           #:selections, Selections.ptr,
            :data_validations, :pointer, # TODO add real definition for lxw_data_validations
+           :conditional_formats, :pointer,
+           :image_props, :pointer,
            :image_data, ImageData.ptr,
            :chart_data, ChartData.ptr,
+           :drawing_rel_ids, :pointer,
+           :vml_drawing_rel_ids, :pointer,
+           :comment_objs, :pointer,
+           :header_image_objs, :pointer,
+           :button_objs, :pointer,
+           :table_objs, :pointer,
+           :table_count, :uint16,
+
            :dim_rowmin, :uint32,
            :dim_rowmax, :uint32,
            :dim_colmin, :uint16,
            :dim_colmax, :uint16,
+
            :sst, Sst.ptr,
            :name, :string,
            :quoted_name, :string,
            :tmpdir, :pointer,
-           :index, :uint32,
-           :active, :uint8,
-           :selected, :uint8,
-           :hidden, :uint8,
+
+           :index, :uint16,
+           :active, :uchar,
+           :selected, :uchar,
+           :hidden, :uchar,
            :active_sheet, :pointer,
            :first_sheet, :pointer,
-           :is_chartsheet, :uint8,
+           :is_chartsheet, :uchar,
+
            :col_options, :pointer,
            :col_options_max, :uint16,
            :col_sizes, :pointer,
@@ -717,6 +737,7 @@ module Libxlsxwriter
            :row_size_changed, :uint8,
            :optimize, :uint8,
            :optimize_row, :pointer,
+
            :fit_height, :uint16,
            :fit_width, :uint16,
            :horizontal_dpi, :uint16,
@@ -726,6 +747,7 @@ module Libxlsxwriter
            :rel_count, :uint16,
            :vertical_dpi, :uint16,
            :zoom, :uint16,
+
            :filter_on,             :uint8,
            :fit_page,              :uint8,
            :hcenter,               :uint8,
@@ -747,8 +769,12 @@ module Libxlsxwriter
            :show_zeros,            :uint8,
            :vcenter,               :uint8,
            :zoom_scale_normal,     :uint8,
+           :black_white,           :uint8,
            :num_validations,       :uint8,
+           :has_dynamic_arrays,    :uint8,
+
            :vba_codename, :pointer,
+           :num_buttons, :uint16,
            :tab_color, :int,
            :margin_left, :double,
            :margin_right, :double,
@@ -756,30 +782,44 @@ module Libxlsxwriter
            :margin_bottom, :double,
            :margin_header, :double,
            :margin_footer, :double,
+
            :default_row_height, :double,
            :default_row_pixels, :uint,
            :default_col_pixels, :uint,
-           :default_row_zeroed, :uchar,
+           :default_row_zeroed, :uint8,
            :default_row_set, :uint8,
+           :outline_row_level, :uint8,
+           :outline_col_level, :uint8,
+
            :header_footer_changed, :uint8,
-           :header, [:char, 255],
-           :footer, [:char, 255],
+           :header, :pointer,
+           :footer, :pointer,
            :repeat_rows, RepeatRows.by_value,
            :repeat_cols, RepeatCols.by_value,
            :print_area, PrintArea.by_value,
            :autofilter, Autofilter.by_value,
+
            :merged_range_count, :uint16,
+           :max_url_length, :uint16,
+
            :hbreaks, :pointer,
            :vbreaks, :pointer,
            :hbreaks_count, :uint16,
            :vbreaks_count, :uint16,
+
+           :drawing_rel_id, :uint,
+           :vml_drawing_rel_id, :uint,
+
            :external_hyperlinks, :pointer,
            :external_drawing_links, :pointer,
            :drawing_links, :pointer,
+           :vml_drawing_links, :pointer,
+           :external_table_links, :pointer,
+
            :panes, Panes.by_value,
-           :protection, Protection.by_value,
-           :drawing, Drawing.ptr,
-           :list_pointers, WorksheetListPointers.by_value
+           :protection, Protection.by_value
+           # :drawing, Drawing.ptr,
+           # :list_pointers, WorksheetListPointers.by_value
   end
 
   # = Fields:
@@ -990,6 +1030,8 @@ module Libxlsxwriter
   # @scope class
   attach_function :worksheet_write_string, :worksheet_write_string, [Worksheet, :uint32, :ushort, :string, Format], :error
 
+  attach_function :worksheet_write_comment, :worksheet_write_comment, [Worksheet, :uint32, :ushort, :string], :error
+
   # @method worksheet_write_formula(worksheet, row, col, formula, format)
   # @param [Worksheet] worksheet 
   # @param [Integer] row 
@@ -1514,6 +1556,8 @@ module Libxlsxwriter
   # @scope class
   attach_function :worksheet_find_cell, :lxw_worksheet_find_cell, [Row, :ushort], Cell
 
+  attach_function :worksheet_add_table, :worksheet_add_table, [Worksheet, :uint, :ushort, :uint, :ushort, :pointer], :error
+
   # = Fields:
   # :rbe_left ::
   #   (FFI::Pointer(*WorksheetName)) 

data/lib/fast_excel/binding.rb

@@ -5,15 +5,12 @@ require 'ffi'
 module Libxlsxwriter
   extend FFI::Library
 
-  LIB_FILENAME = if RUBY_PLATFORM =~ /darwin/
-    "libxlsxwriter.dylib"
-  elsif ['x64-mingw32', 'i386-mingw32'].include? RUBY_PLATFORM
-    "libxlsxwriter.dll"
-  else
-    "libxlsxwriter.so"
-  end
+  LIB_FILENAME = "libxlsxwriter.#{FFI::Platform::LIBSUFFIX}".freeze
+
+  libs = [File.expand_path("../../#{LIB_FILENAME}", __FILE__)]
+  libs.unshift(File.join(Gem.loaded_specs['fast_excel'].extension_dir, LIB_FILENAME)) if Gem.loaded_specs['fast_excel']
 
-  ffi_lib File.expand_path("./../../../libxlsxwriter/lib/#{LIB_FILENAME}", __FILE__)
+  ffi_lib(libs)
 
   def self.attach_function(name, *_)
     begin; super; rescue FFI::NotFoundError => e
@@ -330,13 +327,13 @@ module Libxlsxwriter
     :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_feature_not_supported, 11,
+    :error_null_parameter_ignored, 12,
+    :error_parameter_validation, 13,
+    :error_sheetname_length_exceeded, 14,
+    :error_invalid_sheetname_character, 15,
+    :error_sheetname_start_end_apostrophe, 16,
+    :error_sheetname_already_used, 17,
     :error_32_string_length_exceeded, 18,
     :error_128_string_length_exceeded, 19,
     :error_255_string_length_exceeded, 20,