fast_excel 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81f6dc41f599591425a032e95046733c9a27b7b44e5f6d15f71c9040e1452eaf
-  data.tar.gz: 05ce040ed72e6c056311177c5753d6f363d8750515502054648cac440d3cde09
+  metadata.gz: f3735cb9c55d31df98975baa51a0547f67ca33fb1519b7bbd986af3ea9d78658
+  data.tar.gz: 9e79dcc1be146f889e86f373d87959754b1ffbfb4a617cbf363db04652fbfc45
 SHA512:
-  metadata.gz: f614c8458db906397a2c27825c302e4a0d7a3f2958ed7053a33c9bd2dcbfd063fd27e5a6a8b1a7b3d230afc23919f359d27e61b785ded07b6cf95de55081d711
-  data.tar.gz: cbc0d5436ddde9052359e069a2d4e706810b9bd9ed28c544eca6e072566d32af9fba8b762cb47c011400d676dc71d7b641902058758f97cab98f44a9baef5ff9
+  metadata.gz: b91c2d94389477e2aa48ecf5354783c5ad4d003f20646e1ee9265a2d79ff88c66811465755b9dd62f32691d3caab4f4fb04c708722da4cc41b70b7de29f2167b
+  data.tar.gz: f84e5a0db01a38502b1325ec019725ada1ab87700d79ecfded77570d495da12b533387e963439bde75b93b9168cf6e899e16091bf2bf4c024d621ca2ede250c9

data/.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        ruby: [2.7, '3.0', 3.1, 3.2]
+        ruby: [2.7, 3.1, 3.3, 3.4]
 
     runs-on: ${{ matrix.os }}
 
@@ -27,8 +27,6 @@ jobs:
       - run: rake examples
       - run: gem build fast_excel.gemspec
 
-
-gobills-critical
-gp-di-critical
-
-gp-di-alert
+      - name: Coverage Report by octocov
+        if: ${{ matrix.os == 'ubuntu-latest' && matrix.ruby == '3.4' }}
+        uses: k1LoW/octocov-action@v1

data/.gitignore

@@ -20,3 +20,6 @@ ext/fast_excel/Makefile
 ext/fast_excel/text_width_ext.bundle
 Gemfile.lock
 lib/libxlsxwriter.dylib
+coverage/
+*.so
+*.time

data/.octocov.yml

@@ -0,0 +1,28 @@
+coverage:
+  paths:
+    - coverage/.resultset.json
+codeToTestRatio:
+  code:
+    - '**/*.rb'
+    - '!test/**/*.rb'
+  test:
+    - 'test/**/*_test.rb'
+testExecutionTime:
+  if: true
+diff:
+  datastores:
+    - artifact://${GITHUB_REPOSITORY}
+comment:
+  if: false
+body:
+  if: true
+#comment:
+#  if: is_pull_request
+#  deletePrevious: true
+report:
+  if: is_default_branch
+  datastores:
+    - artifact://${GITHUB_REPOSITORY}
+timeout: 5min
+summary:
+  if: true

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+#### Version 0.6.0 - 19 oct 2026
+
+* Fix segfault in `workbook#get_worksheet_by_name` when sheet does not exist (Thanks to @amberstarlight)
+* Add support for `worksheet_write_comment_opt` with styled comments and hash options (Thanks to @ololoshka12345)
+* Respect current environment's temp directory and add `tmpdir:` option to `FastExcel.open` (Thanks to @spyderdfx)
+* Add tests for `FastExcel.lxw_time`, `color_to_hex`, and pretty print improvements
+
+#### 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

data/Gemfile

@@ -4,14 +4,16 @@ gemspec
 
 gem 'rake'
 
-gem 'roo', '2.8.3', git: 'https://github.com/roo-rb/roo.git', tag: 'v2.8.3'
+gem 'roo'
+gem 'csv'
+gem 'bigdecimal'
 
+gem 'simplecov', require: false
 gem 'minitest'
 gem 'minitest-reporters'
 
-
 group :benchmarks do
-  gem 'axlsx', git: 'https://github.com/randym/axlsx.git'
+  gem 'caxlsx', git: 'https://github.com/caxlsx/caxlsx'
   gem 'write_xlsx'
   gem 'xlsxtream'
   gem 'benchmark-ips'

data/examples/comment_options.rb

@@ -0,0 +1,39 @@
+require_relative '../lib/fast_excel'
+
+workbook = FastExcel.open('comment_options.xlsx', constant_memory: true)
+worksheet = workbook.add_worksheet('Comment Options')
+
+worksheet.write_value(0, 0, 'Cell with basic comment')
+worksheet.write_comment(0, 0, 'Very basic comment.')
+
+options = Libxlsxwriter::CommentOptions.new
+options.author = 'Lol'
+options.visible = 1
+
+worksheet.write_value(2, 0, 'Cell with visible comment and custom author')
+worksheet.write_comment_opt(2, 0, 'This comment is visible and has a custom author', options)
+
+options = Libxlsxwriter::CommentOptions.new
+options.author = 'Kek'
+options.width = 250
+options.height = 100
+options.color = '#FF0000'
+options.font_name = 'Courier New'
+options.font_size = 10.0
+options.visible = 1
+
+worksheet.write_value(5, 0, 'Cell with styled comment')
+worksheet.write_comment_opt(5, 0, 'If a song plants an idea or a feeling in a mind, it has already changed the world.', options)
+
+options = Libxlsxwriter::CommentOptions.new
+options.start_row = 10
+options.start_col = 2
+options.x_offset = 20
+options.y_offset = 20
+options.visible = 1
+
+worksheet.write_value(10, 0, 'Cell with repositioned comment')
+worksheet.write_comment_opt(10, 0, 'This comment is positioned away from the cell.', options)
+
+workbook.close
+puts 'Saved to file comment_options.xlsx'

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/fast_excel.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.4.1"
+  s.version     = "0.6.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  = []
@@ -15,5 +15,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.extensions = ["extconf.rb"]
 
-  s.add_runtime_dependency "ffi", ["> 1.9", "< 2"]
+  s.add_runtime_dependency "ffi", ["> 1.17", "< 2"]
+  s.add_runtime_dependency "base64", [">= 0.2", "< 2"]
 end

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

@@ -1,13 +1,52 @@
 module Libxlsxwriter
+  # Data converters
+  module UTF8StringPointer
+    extend FFI::DataConverter
+    native_type FFI::Type::POINTER
+
+    class << self
+      # Given either a String or nil, make an actual FFI::Pointer
+      # of that value.
+      #
+      # @param [#to_str, nil] value
+      # @param ctx
+      # @return [FFI::Pointer]
+      def to_native(value, ctx)
+        value && FFI::MemoryPointer.from_string(value.to_str.encode(Encoding::UTF_8))
+      end
+
+      # Given a pointer, read out it’s string.
+      #
+      # @param [FFI::Pointer] value
+      # @param ctx
+      # @return [String, nil]
+      def from_native(value, ctx)
+        value.read_string.force_encoding(Encoding::UTF_8) unless value.null?
+      end
+
+      # Used by FFI::StructLayoutField to know if this field
+      # requires the reference to be maintained by FFI. If we
+      # return false here, the MemoryPointer from to_native
+      # will be garbage collected before the struct.
+      def reference_required?
+        true
+      end
+    end
+  end
+
   # = Fields:
   # :constant_memory ::
   #   (Integer) Optimize the workbook to use constant memory for worksheets
   # :tmpdir ::
   #   (String) Directory to use for the temporary files created by libxlsxwriter.
   class WorkbookOptions < FFI::Struct
-    layout :constant_memory, :uchar,
-           :tmpdir, :string,
-           :use_zip64, :uchar
+    conf = {}
+    conf[:constant_memory] = :uchar
+    conf[:tmpdir] = UTF8StringPointer
+    conf[:use_zip64] = :uchar
+    conf[:output_buffer] = :pointer
+    conf[:output_buffer_size] = :pointer
+    layout(conf)
   end
 
   # = Fields:
@@ -141,7 +180,8 @@ module Libxlsxwriter
     # @param [String] name 
     # @return [Worksheet] 
     def get_worksheet_by_name(name)
-      Worksheet.new Libxlsxwriter.workbook_get_worksheet_by_name(self, name)
+      ptr = Libxlsxwriter.workbook_get_worksheet_by_name(self, name)
+      ptr.null? ? nil : Worksheet.new(ptr)
     end
   
     # @param [String] sheetname 
@@ -174,6 +214,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 +224,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

data/lib/fast_excel/binding/worksheet.rb

@@ -209,7 +209,25 @@ 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, options = nil)
+      if options
+        write_comment_opt(row, col, string, options)
+      else
+        Libxlsxwriter.worksheet_write_comment(self, row, col, string)
+      end
+    end
+
+    # @param [Integer] row
+    # @param [Integer] col
+    # @param [String] string
+    # @param [CommentOptions, Hash] options
+    # @return [Symbol from _enum_error_]
+    def write_comment_opt(row, col, string, options)
+      options = Libxlsxwriter::CommentOptions.new(options) if options.is_a?(Hash)
+      Libxlsxwriter.worksheet_write_comment_opt(self, row, col, string, options)
+    end
+
     # @param [Integer] row 
     # @param [Integer] col 
     # @param [String] formula 
@@ -684,29 +702,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 +751,7 @@ module Libxlsxwriter
            :row_size_changed, :uint8,
            :optimize, :uint8,
            :optimize_row, :pointer,
+
            :fit_height, :uint16,
            :fit_width, :uint16,
            :horizontal_dpi, :uint16,
@@ -726,6 +761,7 @@ module Libxlsxwriter
            :rel_count, :uint16,
            :vertical_dpi, :uint16,
            :zoom, :uint16,
+
            :filter_on,             :uint8,
            :fit_page,              :uint8,
            :hcenter,               :uint8,
@@ -747,8 +783,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 +796,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 +1044,18 @@ 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_comment_opt(worksheet, row, col, string, options)
+  # @param [Worksheet] worksheet
+  # @param [Integer] row
+  # @param [Integer] col
+  # @param [String] string
+  # @param [CommentOptions] options
+  # @return [Symbol from _enum_error_]
+  # @scope class
+  attach_function :worksheet_write_comment_opt, :worksheet_write_comment_opt, [Worksheet, :uint32, :ushort, :string, CommentOptions], :error
+
   # @method worksheet_write_formula(worksheet, row, col, formula, format)
   # @param [Worksheet] worksheet 
   # @param [Integer] row 
@@ -1514,6 +1580,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))