fast_excel 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 792a2afe9492aeeaba9fbb65da941d2b604a2fd14bf934b17662fdf05281ac32
-  data.tar.gz: 11795006b99d4fc9403fd3f85ab6babff417b1ed49341a2081073852063d2a71
+  metadata.gz: f3735cb9c55d31df98975baa51a0547f67ca33fb1519b7bbd986af3ea9d78658
+  data.tar.gz: 9e79dcc1be146f889e86f373d87959754b1ffbfb4a617cbf363db04652fbfc45
 SHA512:
-  metadata.gz: 7215d937426efb2580ba947c727a60a519fb411a5504eb58162a1646057bd191812eae00394ac9c915a9f7f53a6acf6cfff66e4d773a8ac579bb3494164c3292
-  data.tar.gz: 9f381f209a7d4f7c22a0994ed241b2be0a67d994c400f7867529fa1fa95fbc6326189a9dc53588f0bfbc376933ffab6fee4eaee37f7ac57d6a4f68a66295c8cc
+  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, 3.3]
+        ruby: [2.7, 3.1, 3.3, 3.4]
 
     runs-on: ${{ matrix.os }}
 
@@ -26,3 +26,7 @@ jobs:
       - run: rake test
       - run: rake examples
       - run: gem build fast_excel.gemspec
+
+      - 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,10 @@
+#### 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

data/Gemfile

@@ -5,13 +5,15 @@ gemspec
 gem 'rake'
 
 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/fast_excel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.5.0"
+  s.version     = "0.6.0"
   s.author      = ["Pavel Evstigneev"]
   s.email       = ["pavel.evst@gmail.com"]
   s.homepage    = "https://github.com/paxa/fast_excel"
@@ -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/workbook.rb

@@ -1,15 +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,
-           :output_buffer, :pointer,
-           :output_buffer_size, :pointer
+    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:
@@ -143,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 

data/lib/fast_excel/binding/worksheet.rb

@@ -210,8 +210,22 @@ module Libxlsxwriter
       Libxlsxwriter.worksheet_write_string(self, row, col, string, format)
     end
 
-    def write_comment(row, col, string)
-      Libxlsxwriter.worksheet_write_comment(self, row, col, string)
+    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 
@@ -1032,6 +1046,16 @@ module Libxlsxwriter
 
   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 

data/lib/fast_excel/binding.rb

@@ -1153,6 +1153,106 @@ module Libxlsxwriter
            :collapsed, :uchar
   end
 
+  # = Fields:
+  # :visible ::
+  #   (Integer) Make the comment visible.
+  # :author ::
+  #   (String) Author of the comment.
+  # :width ::
+  #   (Integer) Width of the comment box.
+  # :height ::
+  #   (Integer) Height of the comment box.
+  # :x_scale ::
+  #   (Float) X scale of the comment.
+  # :y_scale ::
+  #   (Float) Y scale of the comment.
+  # :color ::
+  #   (Integer) Background color of the comment box.
+  # :font_name ::
+  #   (String) Font name for the comment.
+  # :font_size ::
+  #   (Float) Font size for the comment.
+  # :font_family ::
+  #   (Integer) Font family for the comment.
+  # :start_row ::
+  #   (Integer) Start row for the comment box.
+  # :start_col ::
+  #   (Integer) Start column for the comment box.
+  # :x_offset ::
+  #   (Integer) X offset for the comment box.
+  # :y_offset ::
+  #   (Integer) Y offset for the comment box.
+  class CommentOptions < FFI::Struct
+    layout :visible, :uchar,
+           :author, :pointer,
+           :width, :ushort,
+           :height, :ushort,
+           :x_scale, :double,
+           :y_scale, :double,
+           :color, :uint32,
+           :font_name, :pointer,
+           :font_size, :double,
+           :font_family, :uchar,
+           :start_row, :uint32,
+           :start_col, :ushort,
+           :x_offset, :int32,
+           :y_offset, :int32
+
+    def initialize(*args)
+      if args.first.is_a?(Hash)
+        super()
+        @pointers = {}
+        set(args.first)
+      else
+        super(*args)
+        @pointers = {}
+      end
+    end
+
+    def set(options)
+      options.each do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
+      self
+    end
+
+    [:visible, :width, :height, :x_scale, :y_scale, :font_size, :font_family, :start_row, :start_col, :x_offset, :y_offset].each do |prop|
+      define_method(prop) do
+        self[prop]
+      end
+      define_method("#{prop}=") do |value|
+        self[prop] = value
+      end
+    end
+
+    [:author, :font_name].each do |prop|
+      define_method(prop) do
+        ptr = self[prop]
+        ptr.read_string unless ptr.null?
+      end
+
+      define_method("#{prop}=") do |value|
+        @pointers ||= {}
+        if value.nil?
+          @pointers.delete(prop)
+          self[prop] = nil
+        else
+          ptr = FFI::MemoryPointer.from_string(value.to_s)
+          @pointers[prop] = ptr
+          self[prop] = ptr
+        end
+      end
+    end
+
+    def color
+      self[:color]
+    end
+
+    def color=(value)
+      self[:color] = FastExcel.color_to_hex(value)
+    end
+  end
+
   require_relative 'binding/format'
 
   # 

data/lib/fast_excel.rb

@@ -1,8 +1,6 @@
 require_relative './fast_excel/binding'
 require 'set'
-
-# not used for now
-#require_relative '../ext/fast_excel/text_width_ext'
+require 'tmpdir'
 
 module FastExcel
 
@@ -22,14 +20,13 @@ module FastExcel
 
   DEF_COL_WIDTH = 8.43
 
-  def self.open(filename = nil, constant_memory: false, default_format: nil)
+  def self.open(filename = nil, constant_memory: false, default_format: nil, tmpdir: nil)
     tmp_file = false
     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
@@ -38,6 +35,7 @@ module FastExcel
 
     opt = Libxlsxwriter::WorkbookOptions.new
     opt[:constant_memory] = constant_memory ? 1 : 0
+    opt[:tmpdir] = tmpdir || Dir.tmpdir
     workbook = Libxlsxwriter.workbook_new_opt(filename, opt)
 
     result = Libxlsxwriter::Workbook.new(workbook)
@@ -295,8 +293,8 @@ module FastExcel
         return EXTRA_COLORS[value.to_sym]
       elsif COLOR_ENUM.find(value.to_sym)
         return COLOR_ENUM.find(value.to_sym)
-      elsif COLOR_ENUM.find("color_#{value.to_sym}")
-        return COLOR_ENUM.find("color_#{value.to_sym}")
+      elsif COLOR_ENUM.find("color_#{value}".to_sym)
+        return COLOR_ENUM.find("color_#{value}".to_sym)
       elsif value =~ /^#?(0x)?([\da-f]){6}$/i
         value = value.sub('#', '') if value.start_with?('#')
         return value.start_with?('0x') ? value.to_i(16) : "0x#{value}".to_i(16)
@@ -334,8 +332,8 @@ module FastExcel
       res
     end
 
-    def pretty_print(pp)
-      pp fields_hash
+    def pretty_print(pp_obj)
+      fields_hash.pretty_print(pp_obj)
     end
   end
 
@@ -390,9 +388,12 @@ module FastExcel
     end
 
     def get_worksheet_by_name(name)
-      sheet = super(name)
-      sheet.workbook = self
+      return nil if name.nil? || !@sheet_names.include?(name.to_s)
 
+      sheet = super(name.to_s)
+      return nil if sheet.nil?
+
+      sheet.workbook = self
       sheet
     end
 
@@ -543,7 +544,7 @@ module FastExcel
     end
 
     def enable_filters!(start_col: 0, end_col:)
-      autofilter(start_col, 0, @last_row_number, end_col)
+      autofilter(0, start_col, @last_row_number, end_col)
     end
 
     def close

data/sonar-project.properties

@@ -0,0 +1,4 @@
+sonar.sources=.
+sonar.language=ruby
+sonar.ruby.coverage.reportPaths=coverage/.resultset.json
+sonar.exclusions=**/*_test.rb,**/coverage/**

data/test/color_to_hex_test.rb

@@ -0,0 +1,15 @@
+require_relative 'test_helper'
+
+describe "FastExcel.color_to_hex" do
+  it "should convert hex number color to hex" do
+    assert_equal(FastExcel.color_to_hex(0xFF0000), 0xFF0000)
+  end
+
+  it "should convert color name to hex" do
+    assert_equal(FastExcel.color_to_hex("color_lime"), 0x00FF00)
+  end
+
+  it "should convert color name (extra colors) to hex" do
+    assert_equal(FastExcel.color_to_hex("steel_blue"), 0x4682B4)
+  end
+end

data/test/comment_opt_test.rb

@@ -0,0 +1,76 @@
+require_relative 'test_helper'
+
+describe 'FastExcel::Worksheet write_comment_opt' do
+  let(:workbook) { FastExcel.open(constant_memory: true) }
+  let(:worksheet) { workbook.add_worksheet }
+  let(:options) do
+    Libxlsxwriter::CommentOptions.new.tap do |opts|
+      opts.author = 'Lolo'
+      opts.visible = 1
+      opts.width = 200
+      opts.height = 100
+      opts.x_scale = 1.5
+      opts.y_scale = 1.5
+      opts.color = '0xFFFF00'
+      opts.font_name = 'Arial'
+      opts.font_size = 12.0
+      opts.font_family = 2
+      opts.start_row = 0
+      opts.start_col = 1
+      opts.x_offset = 10
+      opts.y_offset = 10
+    end
+  end
+
+  it 'should write a comment with options struct' do
+    assert_equal(:no_error, worksheet.write_comment_opt(0, 0, 'Hello with options', options))
+  end
+
+  it 'should write a comment with hash options' do
+    assert_equal(:no_error, worksheet.write_comment_opt(1, 0, 'Comment via hash', author: 'Author1', visible: 1, color: '#FF0000'))
+  end
+
+  it 'should write a comment using write_comment with optional options' do
+    assert_equal(:no_error, worksheet.write_comment(2, 0, 'Simple comment'))
+    assert_equal(:no_error, worksheet.write_comment(3, 0, 'Comment with hash', author: 'Alice', color: 'lime'))
+  end
+
+  it 'handles nil author and font_name safely' do
+    opts = Libxlsxwriter::CommentOptions.new
+    opts.author = nil
+    opts.font_name = nil
+    assert_nil opts.author
+    assert_nil opts.font_name
+
+    opts.author = 'Bob'
+    assert_equal 'Bob', opts.author
+    opts.author = nil
+    assert_nil opts.author
+  end
+
+  it 'preserves string pointers across garbage collection' do
+    opts = Libxlsxwriter::CommentOptions.new(author: "Temporary #{rand} Author", font_name: 'Courier New')
+    # Run full GC cycles to ensure MemoryPointer is not collected prematurely
+    10.times { GC.start }
+
+    assert opts.author.start_with?('Temporary')
+    assert_equal 'Courier New', opts.font_name
+    assert_equal :no_error, worksheet.write_comment_opt(4, 0, 'GC test comment', opts)
+  end
+
+  it 'generates a valid excel file with styled comments' do
+    temp_file = File.join(Dir.tmpdir, "test_comments_#{Time.now.to_i}.xlsx")
+    begin
+      wb = FastExcel.open(temp_file)
+      ws = wb.add_worksheet
+      ws.write_value(0, 0, 'Data')
+      ws.write_comment(0, 0, 'Styled comment', author: 'Tester', visible: 1, color: 'yellow', font_name: 'Arial')
+      wb.close
+
+      assert File.exist?(temp_file)
+      assert File.size(temp_file) > 0
+    ensure
+      File.delete(temp_file) if File.exist?(temp_file)
+    end
+  end
+end

data/test/date_test.rb

@@ -54,3 +54,17 @@ describe "FastExcel.write_value" do
   end
 
 end
+
+describe "FastExcel.lxw_time" do
+  it "should make Libxlsxwriter::Datetime" do
+    time = Time.at(610421163).utc
+    lxw_time = FastExcel.lxw_time(time)
+
+    assert_equal(lxw_time[:year], 1989)
+    assert_equal(lxw_time[:month], 5)
+    assert_equal(lxw_time[:day], 6)
+    assert_equal(lxw_time[:hour], 1)
+    assert_equal(lxw_time[:min], 26)
+    assert_equal(lxw_time[:sec], 3.0)
+  end
+end

data/test/format_test.rb

@@ -112,7 +112,11 @@ describe "FastExcel::FormatExt colors" do
       @format.font_color = {aaa: 1}
     end
 
-    assert_equal(error.message, "Can not use Hash ({:aaa=>1}) for color value, expected String or Hex Number")
+    if error.message =~ /=>/
+      assert_equal(error.message, "Can not use Hash ({:aaa=>1}) for color value, expected String or Hex Number")
+    else
+      assert_equal(error.message, "Can not use Hash ({aaa: 1}) for color value, expected String or Hex Number")
+    end
   end
 
   it "should raise for unexpected color" do

data/test/get_worksheet_test.rb

@@ -0,0 +1,28 @@
+require_relative 'test_helper'
+
+describe "FastExcel::Worksheet" do
+  before do
+    @workbook = FastExcel.open(constant_memory: true)
+  end
+
+  describe "#get_worksheet_by_name" do
+    it "should return nil if worksheet does not exist" do
+      ws = @workbook.get_worksheet_by_name("Page1")
+      assert_nil(ws)
+
+      assert_nil(@workbook.get_worksheet_by_name(nil))
+      assert_nil(@workbook.get_worksheet_by_name(:Page1))
+    end
+
+    it "should return worksheet if worksheet does exist" do
+      @workbook.add_worksheet("Page1")
+
+      ws = @workbook.get_worksheet_by_name("Page1")
+      ws.write_row(0, ['1'])
+      assert_kind_of(Libxlsxwriter::Worksheet, ws)
+
+      ws_by_sym = @workbook.get_worksheet_by_name(:Page1)
+      assert_kind_of(Libxlsxwriter::Worksheet, ws_by_sym)
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,13 +1,16 @@
+require "simplecov"
+
+SimpleCov.start do
+  add_filter 'test'
+end
+
 require 'bundler/setup'
 require 'minitest/autorun'
 require "minitest/reporters"
 require 'pp'
-
-##Encoding.default_external = Encoding::UTF_8
-##Encoding.default_internal = Encoding::UTF_8
-
 require 'date'
 
+
 Minitest::Reporters.use!(
   Minitest::Reporters::DefaultReporter.new(color: true)
 )

data/test/tmpdir_test.rb

@@ -0,0 +1,32 @@
+require_relative 'test_helper'
+require 'tmpdir'
+
+describe "FastExcel tmpdir option" do
+  it "uses system Dir.tmpdir by default without creating extra temp directories" do
+    temp_file = File.join(Dir.tmpdir, "test_default_tmpdir_#{Time.now.to_i}.xlsx")
+    begin
+      wb = FastExcel.open(temp_file, constant_memory: true)
+      ws = wb.add_worksheet
+      ws.append_row(["test", 123])
+      wb.close
+
+      assert File.exist?(temp_file)
+      assert File.size(temp_file) > 0
+    ensure
+      File.delete(temp_file) if File.exist?(temp_file)
+    end
+  end
+
+  it "accepts custom tmpdir option" do
+    Dir.mktmpdir do |custom_tmp|
+      temp_file = File.join(custom_tmp, "test_custom_tmpdir.xlsx")
+      wb = FastExcel.open(temp_file, constant_memory: true, tmpdir: custom_tmp)
+      ws = wb.add_worksheet
+      ws.append_row(["hello", "world"])
+      wb.close
+
+      assert File.exist?(temp_file)
+      assert File.size(temp_file) > 0
+    end
+  end
+end

data/test/validations_test.rb

@@ -2,12 +2,14 @@ require_relative 'test_helper'
 
 describe "FastExcel validations" do
 
-  it "should raise error when duplicate sheet name" do
-    workbook = FastExcel.open(constant_memory: true)
+  before do
+    @workbook = FastExcel.open(constant_memory: true)
+  end
 
-    workbook.add_worksheet("Payments Report")
+  it "should raise error when duplicate sheet name" do
+    @workbook.add_worksheet("Payments Report")
     error = assert_raises do
-      workbook.add_worksheet("Payments Report")
+      @workbook.add_worksheet("Payments Report")
     end
 
     assert_equal(ArgumentError, error.class)
@@ -15,10 +17,8 @@ describe "FastExcel validations" do
   end
 
   it "should not raise error when worksheet name is null" do
-    workbook = FastExcel.open(constant_memory: true)
-
-    ws1 = workbook.add_worksheet()
-    ws2 = workbook.add_worksheet()
+    ws1 = @workbook.add_worksheet()
+    ws2 = @workbook.add_worksheet()
     ws2.write_value(0, 2, "aaa")
 
     assert_equal("Sheet1", ws1[:name])
@@ -26,10 +26,8 @@ describe "FastExcel validations" do
   end
 
   it "should raise error when the sheet name exceeds maximum length" do
-    workbook = FastExcel.open(constant_memory: true)
-
     error = assert_raises do
-      workbook.add_worksheet("ABCDEFGHIJKLMNOPQRSTUVWXYZ012345")
+      @workbook.add_worksheet("ABCDEFGHIJKLMNOPQRSTUVWXYZ012345")
     end
 
     assert_equal(ArgumentError, error.class)
@@ -37,22 +35,30 @@ describe "FastExcel validations" do
   end
 
   it "should not raise error when the sheet name is at maximum length" do
-    workbook = FastExcel.open(constant_memory: true)
-
-    worksheet = workbook.add_worksheet("ABCDEFGHIJKLMNOPQRSTUVWXYZ01234")
+    worksheet = @workbook.add_worksheet("ABCDEFGHIJKLMNOPQRSTUVWXYZ01234")
     worksheet.append_row(["aaa", "bbb", "ccc"])
 
     assert_equal("ABCDEFGHIJKLMNOPQRSTUVWXYZ01234", worksheet[:name])
   end
 
   it "should validate using Libxlsxwriter validation" do
-    workbook = FastExcel.open(constant_memory: true)
     error = assert_raises do
-      worksheet = workbook.add_worksheet('a?')
+      worksheet = @workbook.add_worksheet('a?')
       worksheet.write_value(1, 1, 'a') # without the validation, this method will crash the process
     end
 
     assert_equal(ArgumentError, error.class)
     assert_equal("Invalid worksheet name 'a?': (15 - error_invalid_sheetname_character) Worksheet name cannot contain invalid characters: '[ ] : * ? / \\'", error.message)
   end
+
+  it "should raise error when reopening workbook" do
+    @workbook.close
+
+    error = assert_raises do
+      FastExcel.open(@workbook.filename, constant_memory: true)
+    end
+
+    assert_equal(error.class, ArgumentError)
+    assert_equal(error.message, "File '#{@workbook.filename}' already exists. FastExcel can not open existing files, only create new files")
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fast_excel
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Pavel Evstigneev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +25,27 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -41,6 +60,7 @@ files:
 - ".dockerignore"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".octocov.yml"
 - CHANGELOG.md
 - Dockerfile.test
 - Gemfile
@@ -55,6 +75,7 @@ files:
 - benchmarks/memory.rb
 - benchmarks/profiler.rb
 - benchmarks/write_value.rb
+- examples/comment_options.rb
 - examples/example.rb
 - examples/example_align.rb
 - examples/example_auto_width.rb
@@ -194,12 +215,16 @@ files:
 - libxlsxwriter/third_party/tmpfileplus/tmpfileplus.c
 - libxlsxwriter/third_party/tmpfileplus/tmpfileplus.h
 - libxlsxwriter/version.txt
+- sonar-project.properties
 - test/auto_width_test.rb
+- test/color_to_hex_test.rb
+- test/comment_opt_test.rb
 - test/date_test.rb
 - test/default_format_test.rb
 - test/format_test.rb
-- test/reopen_test.rb
+- test/get_worksheet_test.rb
 - test/test_helper.rb
+- test/tmpdir_test.rb
 - test/tmpfile_test.rb
 - test/validations_test.rb
 - test/worksheet_test.rb
@@ -207,7 +232,6 @@ homepage: https://github.com/paxa/fast_excel
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ultra Fast Excel Writer
 test_files: []

data/test/reopen_test.rb

@@ -1,22 +0,0 @@
-require_relative 'test_helper'
-
-describe "FastExcel::Worksheet" do
-
-  it "should get_worksheet_by_name" do
-    workbook = FastExcel.open(constant_memory: false)
-    workbook.add_worksheet("Page1")
-
-    ws = workbook.get_worksheet_by_name("Page1")
-    ws.write_row(0, ['1'])
-
-    workbook.close
-
-    error = assert_raises do
-      FastExcel.open(workbook.filename, constant_memory: false)
-    end
-
-    assert_equal(error.class, ArgumentError)
-    assert_equal(error.message, "File '#{workbook.filename}' already exists. FastExcel can not open existing files, only create new files")
-  end
-
-end