fast_excel 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7acf199afdfc96f315ac6487ec4c72a25f6624388d2139821ca1a14aaac9a5e
-  data.tar.gz: 071322b38f573d7774a26025c1f866203a9e1b0b0bca143fdbedfc81af274fd0
+  metadata.gz: 81f6dc41f599591425a032e95046733c9a27b7b44e5f6d15f71c9040e1452eaf
+  data.tar.gz: 05ce040ed72e6c056311177c5753d6f363d8750515502054648cac440d3cde09
 SHA512:
-  metadata.gz: f0f4583c984b84dd9e4960771ab1d094ade8fc271d66e7052b3bb249a870e5fec0302a898652e020cec61d17ceaa2babf73cf84a3a2556c05f83e1b8cf82182b
-  data.tar.gz: 162dee5762798ce6ecac84bcc0cc10f38f03f46d3fd4eb490c039dc2e67ede50294f7bfd744be72e58dedacc41c3aad76997a1642ba3e379d8c33d8edca938d0
+  metadata.gz: f614c8458db906397a2c27825c302e4a0d7a3f2958ed7053a33c9bd2dcbfd063fd27e5a6a8b1a7b3d230afc23919f359d27e61b785ded07b6cf95de55081d711
+  data.tar.gz: cbc0d5436ddde9052359e069a2d4e706810b9bd9ed28c544eca6e072566d32af9fba8b762cb47c011400d676dc71d7b641902058758f97cab98f44a9baef5ff9

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+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]
+
+    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
+
+
+gobills-critical
+gp-di-critical
+
+gp-di-alert

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,12 @@
+#### 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,7 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'ffi'
-gem 'ffi_gen', require: false
+gemspec
 
 gem 'rake'
 
@@ -10,9 +9,11 @@ gem 'roo', '2.8.3', git: 'https://github.com/roo-rb/roo.git', tag: 'v2.8.3'
 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_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,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "fast_excel"
-  s.version     = "0.4.0"
+  s.version     = "0.4.1"
   s.author      = ["Pavel Evstigneev"]
   s.email       = ["pavel.evst@gmail.com"]
   s.homepage    = "https://github.com/paxa/fast_excel"

data/lib/fast_excel/binding/workbook.rb

@@ -147,7 +147,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] 
@@ -319,12 +319,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.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

data/lib/fast_excel.rb

@@ -91,8 +91,11 @@ module FastExcel
   # https://support.microsoft.com/en-us/help/214330/differences-between-the-1900-and-the-1904-date-system-in-excel
   def self.date_num(time, offset = nil)
     unless offset
-      # Try use Rails' app timezone
-      if Time.respond_to?(:zone)
+      # Try use value utc_offset
+      if time.respond_to?(:utc_offset)
+        offset = time.utc_offset
+      # Else try use Rails' app timezone
+      elsif Time.respond_to?(:zone) && !Time.zone.nil?
         offset = Time.zone.utc_offset
       else
         offset = 0 # rollback to UTC
@@ -122,6 +125,7 @@ module FastExcel
   end
 
 
+  ERROR_ENUM = Libxlsxwriter.enum_type(:error)
   COLOR_ENUM = Libxlsxwriter.enum_type(:defined_colors)
   EXTRA_COLORS = {
     alice_blue: 0xF0F8FF,
@@ -363,10 +367,11 @@ module FastExcel
 
     def add_worksheet(sheetname = nil)
       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"
+        error = validate_worksheet_name(sheetname)
+        if error != :no_error
+          error_code = ERROR_ENUM.find(error)
+          error_str = error_code ? Libxlsxwriter.strerror(error_code) : ''
+          raise ArgumentError, "Invalid worksheet name '#{sheetname}': (#{error_code} - #{error}) #{error_str}"
         end
       end
 

data/test/validations_test.rb

@@ -11,7 +11,7 @@ describe "FastExcel validations" do
     end
 
     assert_equal(ArgumentError, error.class)
-    assert_equal("Worksheet name 'Payments Report' is already in use", error.message)
+    assert_equal("Invalid worksheet name 'Payments Report': (16 - error_sheetname_already_used) Worksheet name is already in use.", error.message)
   end
 
   it "should not raise error when worksheet name is null" do
@@ -33,7 +33,7 @@ describe "FastExcel validations" do
     end
 
     assert_equal(ArgumentError, error.class)
-    assert_equal("Worksheet name 'ABCDEFGHIJKLMNOPQRSTUVWXYZ012345' exceeds Excel's limit of 31 characters", error.message)
+    assert_equal("Invalid worksheet name 'ABCDEFGHIJKLMNOPQRSTUVWXYZ012345': (13 - error_sheetname_length_exceeded) Worksheet name exceeds Excel's limit of 31 characters.", error.message)
   end
 
   it "should not raise error when the sheet name is at maximum length" do
@@ -44,4 +44,15 @@ describe "FastExcel validations" do
 
     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.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?': (14 - error_invalid_sheetname_character) Worksheet name cannot contain invalid characters: '[ ] : * ? / \\'", error.message)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_excel
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Pavel Evstigneev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -39,17 +39,15 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".dockerignore"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile.test
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - Makefile
 - README.md
 - Rakefile
-- appveyor.yml
 - benchmarks/1k_rows.rb
 - benchmarks/20k_rows.rb
 - benchmarks/auto_width.rb
@@ -173,7 +171,6 @@ files:
 - test/format_test.rb
 - test/reopen_test.rb
 - test/test_helper.rb
-- test/text_width_test.rb
 - test/tmpfile_test.rb
 - test/validations_test.rb
 - test/worksheet_test.rb
@@ -199,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Ultra Fast Excel Writer

data/.travis.yml

@@ -1,51 +0,0 @@
----
-language: ruby
-
-matrix:
-  include:
-#  - os: linux
-#    rvm: 2.2.10
-#  - os: osx
-#    rvm: 2.2.10
-  - os: linux
-    rvm: 2.3.8
-  - os: linux
-    rvm: 2.4.6
-  - os: osx
-    rvm: 2.4.6
-  - os: linux
-    rvm: 2.5.5
-  - os: osx
-    rvm: 2.5.5
-  - os: linux
-    rvm: 2.6.3
-    env: BUILD_DOCKER=true
-    services:
-      - docker
-  - os: osx
-    rvm: 2.6.3
-    osx_image: xcode10.2
-    before_script:
-      - ls -lah /Applications
-      - sudo xcode-select -s /Applications/Xcode-10.2.1.app/Contents/Developer
-      - clang --version
-  - os: linux
-    rvm: 2.7.2
-  - os: linux
-    rvm: 3.0.0-preview2
-  fast_finish: true
-  allow_failures:
-    - rvm: 3.0.0-preview2
-
-before_install:
-  - gem install bundler -v 2.2.2
-
-script:
-  - bundle install
-  - make
-  - bundle exec rake test
-  - bundle exec rake examples
-  - gem build fast_excel.gemspec
-  - export GIT_REPO=${TRAVIS_PULL_REQUEST_SLUG:-$TRAVIS_REPO_SLUG}
-  - env
-  - if [ -n "$BUILD_DOCKER" ]; then docker build . -f Dockerfile.test --build-arg GIT_REPO --build-arg TRAVIS_COMMIT --build-arg TRAVIS_BRANCH ; fi

data/Gemfile.lock

@@ -1,79 +0,0 @@
-GIT
-  remote: https://github.com/paxa/process_memory
-  revision: 282c75336a4a6b92207cd1eaa57f20887b92601e
-  specs:
-    process_memory (0.1)
-
-GIT
-  remote: https://github.com/randym/axlsx.git
-  revision: 8e7b4b3b7259103452c191f73ce0bf64f66033fe
-  specs:
-    axlsx (3.0.0.pre)
-      htmlentities (~> 4.3, >= 4.3.4)
-      mimemagic (~> 0.3)
-      nokogiri (~> 1.8, >= 1.8.2)
-      rubyzip (~> 1.2, >= 1.2.1)
-
-GIT
-  remote: https://github.com/roo-rb/roo.git
-  revision: d416f1520c50bbab160ca2ed9a49498fcc3edf50
-  tag: v2.8.3
-  specs:
-    roo (2.8.3)
-      nokogiri (~> 1)
-      rubyzip (>= 1.3.0, < 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    benchmark-ips (2.8.4)
-    builder (3.2.4)
-    ffi (1.14.2)
-    ffi_gen (1.2.0)
-      ffi (~> 1.0)
-    htmlentities (4.3.4)
-    mimemagic (0.3.5)
-    minitest (5.14.3)
-    minitest-reporters (1.4.3)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    nokogiri (1.11.1-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.11.1-x86_64-linux)
-      racc (~> 1.4)
-    racc (1.5.2)
-    rake (13.0.3)
-    ruby-progressbar (1.11.0)
-    rubyzip (1.3.0)
-    write_xlsx (1.04.0)
-      rubyzip (>= 1.0.0)
-      zip-zip
-    xlsxtream (2.4.0)
-      zip_tricks (>= 4.5, < 6)
-    zip-zip (0.3)
-      rubyzip (>= 1.0.0)
-    zip_tricks (5.5.0)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-19
-  x86_64-linux
-
-DEPENDENCIES
-  axlsx!
-  benchmark-ips
-  ffi
-  ffi_gen
-  minitest
-  minitest-reporters
-  process_memory!
-  rake
-  roo (= 2.8.3)!
-  write_xlsx
-  xlsxtream
-
-BUNDLED WITH
-   2.2.2

data/appveyor.yml

@@ -1,25 +0,0 @@
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - SET PATH=C:\MinGW\bin;%PATH%
-  - SET RAKEOPT=-rdevkit
-  - copy c:\MinGW\bin\mingw32-make.exe c:\MinGW\bin\make.exe
-  - ruby --version
-  - gem --version
-  - bundle install
-  - make
-
-build: off
-
-test_script:
-  - bundle exec rake test
-
-environment:
-  matrix:
-    - ruby_version: "24"
-    - ruby_version: "24-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"

data/test/text_width_test.rb

@@ -1,80 +0,0 @@
-require_relative 'test_helper'
-
-
-describe "FastExcel Arial text_width" do
-
-  before do
-    skip "Use basic width calc for now"
-  end
-
-  it "should calculate width for character" do
-    assert_in_delta(FastExcel.arial_text_width('a'), 55.61, 0.1)
-  end
-
-  it "should calculate width with kerning" do
-    assert_in_delta(FastExcel.arial_text_width('A'), 66.69, 0.1)
-    assert_in_delta(FastExcel.arial_text_width('V'), 66.69, 0.1)
-
-    assert_in_delta(FastExcel.arial_text_width('AV'), 125.97, 0.1)
-
-    assert_in_delta(FastExcel.arial_text_width('11'), 103.80, 0.1)
-  end
-
-  it "should skip system characters" do
-    assert_in_delta(FastExcel.arial_text_width(10.chr), 0.0)
-  end
-
-  it "should handle multiline text" do
-    assert_in_delta(FastExcel.arial_text_width("More\nThen\nOne Line"), 405.85, 0.1)
-  end
-end
-
-describe "FastExcel Calibri text_width" do
-
-  before do
-    skip "Use basic width calc for now"
-  end
-
-  it "should calculate width for character" do
-    assert_in_delta(FastExcel.calibri_text_width('a'), 47.90, 0.1)
-  end
-
-  it "should calculate width with kerning" do
-    assert_in_delta(FastExcel.calibri_text_width('A'), 57.86, 0.1)
-    assert_in_delta(FastExcel.calibri_text_width('V'), 56.73, 0.1)
-
-    assert_in_delta(FastExcel.calibri_text_width('AV'), 110.25, 0.1)
-
-    assert_in_delta(FastExcel.calibri_text_width('11'), 101.36, 0.1)
-  end
-
-  it "should skip system characters" do
-    assert_in_delta(FastExcel.calibri_text_width(10.chr), 0.0)
-  end
-
-end
-
-describe "FastExcel Times New Roman text_width" do
-
-  before do
-    skip "Use basic width calc for now"
-  end
-
-  it "should calculate width for character" do
-    assert_in_delta(FastExcel.times_new_roman_text_width('a'), 44.38, 0.1)
-  end
-
-  it "should calculate width with kerning" do
-    assert_in_delta(FastExcel.times_new_roman_text_width('A'), 72.21, 0.1)
-    assert_in_delta(FastExcel.times_new_roman_text_width('V'), 72.21, 0.1)
-
-    assert_in_delta(FastExcel.times_new_roman_text_width('AV'), 131.54, 0.1)
-
-    assert_in_delta(FastExcel.times_new_roman_text_width('11'), 96.28, 0.1)
-  end
-
-  it "should skip system characters" do
-    assert_in_delta(FastExcel.times_new_roman_text_width(10.chr), 0.0)
-  end
-
-end