fast_excel 0.4.1 → 0.6.0

data/lib/fast_excel/binding.rb

@@ -327,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,
@@ -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,27 +20,24 @@ 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
 
     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
+    opt[:tmpdir] = tmpdir || Dir.tmpdir
+    workbook = Libxlsxwriter.workbook_new_opt(filename, opt)
+
     result = Libxlsxwriter::Workbook.new(workbook)
 
     if default_format
@@ -105,23 +100,33 @@ 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
 
 
@@ -288,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)
@@ -327,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
 
@@ -383,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
 
@@ -536,12 +544,12 @@ 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
       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