fast_excel 0.4.0 → 0.5.0

data/lib/fast_excel.rb

@@ -36,13 +36,10 @@ module FastExcel
 
     filename = filename.to_s if defined?(Pathname) && filename.is_a?(Pathname)
 
-    workbook = if constant_memory
-      opt = Libxlsxwriter::WorkbookOptions.new
-      opt[:constant_memory] = 1
-      Libxlsxwriter.workbook_new_opt(filename, opt)
-    else
-      Libxlsxwriter.workbook_new(filename)
-    end
+    opt = Libxlsxwriter::WorkbookOptions.new
+    opt[:constant_memory] = constant_memory ? 1 : 0
+    workbook = Libxlsxwriter.workbook_new_opt(filename, opt)
+
     result = Libxlsxwriter::Workbook.new(workbook)
 
     if default_format
@@ -91,8 +88,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
@@ -102,26 +102,37 @@ module FastExcel
     time.to_f / XLSX_DATE_DAY + XLSX_DATE_EPOCH_DIFF + offset / XLSX_DATE_DAY
   end
 
-  def self.print_ffi_obj(value)
-    puts "#{value.class}"
+  def self.print_ffi_obj(value, do_print: true, offset: "", deep: false)
+    result = "#{value.class}"
+
     value.members.each do |key|
-      field_val = if value[key].is_a?(FFI::Pointer) && value[key].null? || value[key].nil?
+      fval = value[key]
+      field_val = if fval.is_a?(FFI::Pointer) && fval.null? || fval.nil?
         "nil"
-      elsif value[key].is_a?(FFI::StructLayout::CharArray)
-        value[key].to_str.inspect
-      elsif value[key].is_a?(String)
-        value[key].inspect
-      elsif value[key].is_a?(Symbol)
-        value[key].inspect
+      elsif fval.is_a?(FFI::StructLayout::CharArray)
+        fval.to_str.inspect
+      elsif fval.is_a?(String)
+        fval.inspect
+      elsif fval.is_a?(Symbol)
+        fval.inspect
+      elsif fval.is_a?(FFI::Struct) && deep
+        print_ffi_obj(fval, do_print: false, offset: offset + "    ", deep: deep)
       else
-        value[key]
+        fval
       end
-      puts "* #{key}: #{field_val}"
+
+      result += "\n#{offset}* #{key}: #{field_val}"
+    end
+
+    if do_print
+      puts result
+    else
+      return result
     end
-    nil
   end
 
 
+  ERROR_ENUM = Libxlsxwriter.enum_type(:error)
   COLOR_ENUM = Libxlsxwriter.enum_type(:defined_colors)
   EXTRA_COLORS = {
     alice_blue: 0xF0F8FF,
@@ -363,10 +374,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
 
@@ -536,7 +548,7 @@ module FastExcel
 
     def close
       if auto_width?
-        @column_widths.each do |num, width|
+        @column_widths.transform_values!{ |width| width || DEF_COL_WIDTH }.each do |num, width|
           set_column_width(num, width + 0.2)
         end
       end

data/libxlsxwriter/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["paypal.me/xlsxwriter"]

data/libxlsxwriter/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,85 @@
+# libxlsxwriter: Reporting Bugs
+
+Here are some tips on reporting bugs in `libxlsxwriter`.
+
+### Upgrade to the latest version of the library
+
+Upgrade to the latest version of the library since the bug you are reporting
+may already be fixed.
+
+Check the [Changes][changes] section of the documentation to see what has
+changed in the latest versions.
+
+[changes]: http://libxlsxwriter.github.io/changes.html
+
+You can check which version of `libxlsxwriter` that you are using by checking
+the `xlsxwriter.h` header file or by adding the following to your program:
+
+```C
+#include <stdio.h>
+#include "xlsxwriter.h"
+
+int main() {
+
+    printf("Libxlsxwriter version = %s\n", lxw_version());
+
+    return 0;
+}
+```
+
+### Read the documentation
+
+Read or search the `libxlsxwriter` [documentation][docs] to see if the issue
+you are encountering is already explained.
+
+[docs]: http://libxlsxwriter.github.io/index.html
+
+### Look at the example programs
+
+There are many [examples programs][examples] in the distribution. Try to
+identify an example program that corresponds to your query and adapt it to use
+as a bug report.
+
+[examples]: http://libxlsxwriter.github.io/examples.html
+
+
+### Tips for submitting a bug report
+
+1.  Describe the problem as clearly and as concisely as possible.
+2.  Include a sample program. This is probably the most important step.
+    It is generally easier to describe a problem in code than in written
+    prose.
+3.  The sample program should be as small as possible to demonstrate the
+    problem. Don't copy and paste large non-relevant sections of your
+    program.
+
+A sample bug report is shown below. This format helps analyze and respond to
+the bug report more quickly.
+
+
+> Subject: Issue with SOMETHING
+>
+> Greetings,
+>
+> I am using libxlsxwriter to do SOMETHING but it appears to do SOMETHING ELSE.
+>
+> I am using CC version X.Y.Z, OS = uname and libxlsxwriter x.y.z.
+>
+> Here is some code that demonstrates the problem:
+>
+>
+>```C
+>#include "xlsxwriter.h"
+>
+>int main() {
+>
+>    lxw_workbook  *workbook  = workbook_new("bug_report.xlsx");
+>    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+>
+>    worksheet_write_string(worksheet, 0, 0, "Hello", NULL);
+>    worksheet_write_number(worksheet, 1, 0, 123, NULL);
+>
+>    return workbook_close(workbook);
+>}
+>```
+>

data/libxlsxwriter/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,130 @@
+# libxlsxwriter: Submitting Pull Requests
+
+# Pull Requests and Contributing to Libxlsxwriter
+
+All patches and pull requests are welcome but in general you should start with
+an issue tracker to describe what you intend to do before you do it.
+
+
+### Getting Started
+
+1. Pull requests and new feature proposals must start with an [issue
+   tracker][issues]. This serves as the focal point for the design discussion.
+2. Describe what you plan to do. If there are API changes add some code
+   example to demonstrate them.
+3. Fork the repository.
+4. Run all the tests to make sure the current code works on your system using
+   `make test`.  See the [Running the Test Suite][tests] section of the docs
+   for instructions.
+5. Create a feature branch for your new feature.
+
+
+[tests]: http://libxlsxwriter.github.io/running_the_tests.html
+
+### Code Style
+
+The code style is mainly K&R style with 4 space indents.
+
+The author uses GNU indent (`gindent`) 2.2.10 with the following options:
+
+```
+    --braces-on-if-line
+    --braces-on-struct-decl-line
+    --case-indentation 4
+    --continue-at-parentheses
+    --declaration-comment-column 0
+    --format-first-column-comments
+    --honour-newlines
+    --ignore-profile
+    --indent-label 0
+    --indent-level 4
+    --no-space-after-function-call-names
+    --no-tabs
+    --swallow-optional-blank-lines
+```
+
+The [indent configuration file][indentpro] is available in the repo. The code
+can be indented automatically if the same version of `gindent` is used with
+the following make command:
+
+```shell
+    make indent
+```
+
+Note, make sure you have backed up your files or added them to the index
+before running this command.
+
+In general follow the existing style in the code.
+
+[indentpro]: https://github.com/jmcnamara/libxlsxwriter/blob/master/.indent.pro
+
+### Writing and Running Tests
+
+Any significant features should be accompanied by a test. See the `test`
+directory and the [Running the Test Suite][tests] section of the docs for
+details of the test setup.
+
+The tests can be run as follows:
+
+```shell
+    make test
+```
+Same as:
+
+```shell
+    make test_unit
+    make test_functional
+```
+
+The functional tests require the Python module [pytest][pytest] as a test runner.
+
+If you have `valgrind` installed you can use the test suite to check for memory leaks:
+
+```shell
+    make test_valgrind
+```
+
+When you push your changes they will also be tested automatically using
+[GitHub Actions][actions].
+
+[actions]: https://github.com/jmcnamara/libxlsxwriter/actions
+[pytest]: http://pytest.org/
+
+
+### Documentation
+
+The `libxlsxwriter` documentation is written in Doxygen format in the header
+files and in additional `.dox` files in the `docs/src` directory of the
+repo. The documentation can be built as follows:
+
+```shell
+    make docs
+    open docs/html/index.html
+```
+
+
+### Example programs
+
+If applicable add an example program to the `examples` directory. Example
+files can be built using:
+
+```shell
+   make docs
+```
+
+### Copyright and License
+
+Copyright remains with the original author. Do not include additional
+copyright claims or Licensing requirements. GitHub and the `git` repository
+will record your contribution and it will be acknowledged it in the Changes
+file.
+
+
+### Submitting the Pull Request
+
+If your change involves several incremental `git` commits then `rebase` or
+`squash` them onto another branch so that the Pull Request is a single commit
+or a small number of logical commits.
+
+Push your changes to GitHub and submit the Pull Request with a hash link to
+the to the Issue tracker that was opened above.

data/libxlsxwriter/.github/workflows/cmake_actions.yml

@@ -0,0 +1,48 @@
+name: Test CMake build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name:
+      Cmake
+    strategy:
+      fail-fast: false
+      matrix:
+        cc:          [gcc, clang]
+        cmake_flags: ["",
+                      "-DBUILD_EXAMPLES=ON       -DBUILD_TESTS=ON",
+                      "-DUSE_DTOA_LIBRARY=ON     -DBUILD_TESTS=ON",
+                      "-DUSE_MEM_FILE=ON         -DBUILD_TESTS=ON",
+                      "-DUSE_NO_MD5=ON           -DBUILD_TESTS=ON",
+                      "-DUSE_OPENSSL_MD5=ON      -DBUILD_TESTS=ON",
+                      "-DUSE_STANDARD_TMPFILE=ON -DBUILD_TESTS=ON",
+                      "-DUSE_SYSTEM_MINIZIP=ON   -DBUILD_TESTS=ON",
+                      "-DUSE_SYSTEM_MINIZIP=ON   -DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON"]
+    runs-on: ubuntu-latest
+    env:
+      CC: ${{ matrix.cc }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        sudo apt update
+        sudo apt-get -y install zlib1g-dev
+        sudo apt-get -y install libminizip-dev
+        sudo apt-get -y install libssl-dev
+
+    - name: Configure CMake
+      working-directory: ${{ github.workspace }}/cmake
+      run:  cmake .. -DBUILD_TESTS=ON ${{ matrix.cmake_flags }} -DCMAKE_BUILD_TYPE=Release
+
+    - name: Build
+      working-directory: ${{ github.workspace }}/cmake
+      run: cmake --build . --config Release --parallel
+
+    - name: Test
+      working-directory: ${{ github.workspace }}/cmake
+      run: ctest -C Release -V

data/libxlsxwriter/.github/workflows/code_style.yml

@@ -0,0 +1,23 @@
+name: Check code style
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name:
+      Check code style
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get -y install indent
+        sudo ln -s /usr/bin/indent /usr/bin/gindent
+
+    - name: Make indent
+      run: |
+        make indent
+        git status | grep 'nothing to commit'

data/libxlsxwriter/.github/workflows/coverity.yml

@@ -0,0 +1,22 @@
+name: Coverity Scan
+
+on:
+  push:
+    branches: [coverity]
+
+jobs:
+  coverity:
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Build third party libs to exclude them from scan
+      run: make third_party
+
+    - uses: vapier/coverity-scan-action@v1
+      with:
+        project: libxlsxwriter
+        email: ${{ secrets.COVERITY_SCAN_EMAIL }}
+        token: ${{ secrets.COVERITY_SCAN_TOKEN }}
+        command: make -C src libxlsxwriter.a

data/libxlsxwriter/.github/workflows/make_actions.yml

@@ -0,0 +1,52 @@
+name: Test Make build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name:
+      Make
+    strategy:
+      fail-fast: false
+      matrix:
+        cc:         [gcc, clang]
+        make_flags: ["",
+                     "USE_STANDARD_TMPFILE=1",
+                     "USE_SYSTEM_MINIZIP=1",
+                     "USE_DTOA_LIBRARY=1",
+                     "USE_NO_MD5=1",
+                     "USE_OPENSSL_MD5=1",
+                     "USE_MEM_FILE=1"]
+    runs-on: ubuntu-latest
+    env:
+      CC:     ${{ matrix.cc }}
+      CXX:    ${{ matrix.cc }}
+      CFLAGS: '-Werror'
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        sudo apt update
+        sudo apt-get -y install zlib1g-dev
+        sudo apt-get -y install libminizip-dev
+        sudo apt-get -y install libssl-dev
+        sudo apt-get -y install valgrind
+
+    - name: make
+      run: ${{ matrix.make_flags }} make V=1
+
+    - name: test unit
+      run: ${{ matrix.make_flags }} make test_unit V=1
+
+    - name: test functional
+      run: ${{ matrix.make_flags }} make test_functional V=1 -j
+
+    - name: test cpp
+      run: ${{ matrix.make_flags }} make test_cpp V=1
+
+    - name: test examples
+      run: ${{ matrix.make_flags }} make examples V=1

data/libxlsxwriter/.github/workflows/valgrind.yml

@@ -0,0 +1,23 @@
+name: Test for memory leaks
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name:
+      Valgrind
+    runs-on: ubuntu-latest
+    env:
+      CC: gcc
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install dependencies
+      run: |
+        sudo apt update
+        sudo apt-get -y install valgrind
+        sudo apt-get -y install zlib1g-dev
+
+    - name: test valgrind
+      run: make test_valgrind V=1 -j 2

data/libxlsxwriter/.github/workflows/windows_build.yml

@@ -0,0 +1,54 @@
+name: Test Cmake build on Windows
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: CMake on Windows
+
+    strategy:
+      fail-fast: false
+      matrix:
+        cmake_flags: ["-DBUILD_EXAMPLES=ON       -DBUILD_TESTS=ON",
+                      "-DUSE_DTOA_LIBRARY=ON     -DBUILD_TESTS=ON",
+                      #"-DUSE_SYSTEM_MINIZIP=ON   -DBUILD_TESTS=ON",
+                      #"-DUSE_SYSTEM_MINIZIP=ON   -DUSE_OPENSSL_MD5=ON -DBUILD_TESTS=ON",
+                      "-DUSE_OPENSSL_MD5=ON      -DBUILD_TESTS=ON",
+                      ]
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install dependencies
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      shell: cmd
+      run: |
+        vcpkg.exe install zlib:x64-windows minizip:x64-windows openssl:x64-windows
+        vcpkg.exe integrate install
+        pip install pytest
+
+    - name: Configure CMake
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      shell: cmd
+      run: |
+        cd cmake
+        call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
+        cmake .. -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_flags }} -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -A x64
+
+    - name: Build
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      shell: cmd
+      run: |
+        cd cmake
+        call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
+        cmake --build . --config Release
+
+    - name: Test
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      shell: cmd
+      run: |
+        cd cmake
+        copy test\functional\src\Release\*.exe test\functional\src
+        pytest -v test/functional

data/libxlsxwriter/.github/workflows/zig_build.yml

@@ -0,0 +1,22 @@
+name: Zig Build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.runs-on }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: 0.11.0
+
+      - name: Build Summary
+        run: zig build -DBUILD_TESTS -DBUILD_EXAMPLES -DUSE_SYSTEM_MINIZIP --summary all -freference-trace

data/libxlsxwriter/.gitignore

@@ -1,11 +1,14 @@
 *.a
 *.o
 *.so
+*.so.*
 *.to
 *.lo
 *.la
 *.dylib
 *.dll
+*.gcno
+*.gcda
 test_*
 !test_*.c
 !test_*.cpp
@@ -35,10 +38,12 @@ docs/latex
 _temp.c
 examples/*
 !examples/*.c
-!examples/logo.png
+!examples/*.png
 !examples/Makefile
+!examples/vbaProject.bin
 cov-int
 libxlsxwriter-coverity.tgz
+build
 
 third_party/zlib-1.2.8/configure.log
 third_party/zlib-1.2.8/contrib/minizip/miniunz
@@ -48,3 +53,13 @@ third_party/zlib-1.2.8/examplesh
 third_party/zlib-1.2.8/minigzip
 third_party/zlib-1.2.8/minigzipsh
 third_party/zlib-1.2.8/zlib.pc
+
+cmake
+!cmake/FindMINIZIP.cmake
+!cmake/FindPackage.cmake
+!cmake/i686-toolchain.cmake
+
+.vscode
+
+zig-cache/
+zig-out/