fast_excel 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac39efd3391a98291ae2c1f5ba4102850b8ad678
-  data.tar.gz: 7d2eb11896d20f80f20405778b009e09ac1b41ea
+SHA256:
+  metadata.gz: af06f03372f15efb18eaf09669f7822ee81b67a5d4c6be7a55c3b8eb2609fd82
+  data.tar.gz: af892b143b010078e56380d38c76216ff19cb524f3e73c5206d18131546f216c
 SHA512:
-  metadata.gz: ae26296476e89298ff1d584ae59e87e81f46a118e0c7583f5328fb12845afe970e1fe040c8783388e541d3b4077948957cec5923cd124d325475629e5272c495
-  data.tar.gz: 921ca060bf7cb21c541dc0664767a13d5f95be2f76d7947c24e2677133c06cc21d558f925e372b4d49f4fc56977650a13c876883e3b0f3850ba2f4953ab565a5
+  metadata.gz: 979827252546904e71283dcf5996636fad7d04963ea1d07f6adf916484ac94a39e9b5a6f7d479529cb42971f53dc2dbadf0c08d1d57caf3eac7a91747308b6f2
+  data.tar.gz: 6a64e0cfa1894134759a2a1784c78c2641ff6aec2b81c48e9afb81fcc335d24ff7a0022f3ef252bb2ba0824fc8afe5220159829bee5bc32556687ed170009bbd

data/.dockerignore

@@ -0,0 +1,2 @@
+libxlsxwriter
+.git

data/.gitignore

@@ -1,4 +1,5 @@
 .ruby-version
+.idea/
 try.c
 try.rb
 gen.rb
@@ -7,7 +8,13 @@ gen_ffi.rb
 a.out
 .DS_Store
 *.gem
+*.cmake
+libxlsxwriter/CmakeFiles
+libxlsxwriter/CmakeCache.txt
 libxlsxwriter/dev
 libxlsxwriter/docs
 libxlsxwriter/examples
 libxlsxwriter/test
+ext/fast_excel/text_width_ext.o
+ext/fast_excel/Makefile
+ext/fast_excel/text_width_ext.bundle

data/.travis.yml

@@ -0,0 +1,44 @@
+---
+language: ruby
+
+matrix:
+  include:
+#  - os: linux
+#    rvm: 2.2.10
+#  - os: osx
+#    rvm: 2.2.10
+  - os: linux
+    rvm: 2.3.8
+  - os: osx
+    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
+  fast_finish: true
+
+before_install:
+  - gem install bundler -v 2.0.2
+
+script:
+  - bundle install
+  - make
+  - bundle exec rake test
+  - bundle exec rake examples
+  - if [ -n "$BUILD_DOCKER" ]; then docker build . -f Dockerfile.test --build-arg TRAVIS_COMMIT --build-arg TRAVIS_BRANCH ; fi

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+#### Version 0.3.0 - 23 jul 2020
+
+* Add support for FastExcel::URL
+* Add support for writing boolean values
+* Add enable_filters!(end_col: X)
+* Allow to open with an empty existing file
+* Add missing enums to chart
+* Don't change sheet name from "" to nil
+* Support build with docker
+* Fix crash when sheet name exceeds maximum length.
+* [BREAKING CHANGE] Rename `worksheet.right_to_left` to `worksheet.set_right_to_left`:
+  - now it will work properly when using the `pry-rails` gem, not forcing the document start from right even when this method is not called.
+
+#### Version 0.2.6 - 26 jan 2019
+
+* Add column auto width (thanks to @duffyjp)
+
+#### Version 0.2.5 - 22 jun 2018
+
+* Update libxlsxwriter to 0.7.7
+
+#### Version 0.2.4 - 13 mar 2018
+
+* Update libxlsxwriter to 0.7.6
+* Don’t crash process when duplicated worksheet name
+
+#### Version 0.2.3 - 27 oct 2017
+
+* Allow Date along with DateTime in write_value (thanks to @noxern)
+
+#### Version 0.2.2 - 20 sep 2017
+
+* Nice setters and getters for format.align
+* Add nice setters for colors and borders
+* Add sheet.append_row, sheet.last_row_number
+* Run tests in CI
+* Performance optimizations and type check refactoring
+* Add styles_example.rb
+* Fix assigning align from other format
+
 #### Version 0.2.1 - 20 jun 2017
 
 * Add FastExcel::Formula
@@ -10,4 +50,4 @@
 
 #### Version 0.1.0 - 24 feb 2017
 
-Initial
+Initial

data/Dockerfile.test

@@ -0,0 +1,16 @@
+FROM ruby
+
+RUN gem install fast_excel
+
+ARG TRAVIS_COMMIT
+ARG TRAVIS_BRANCH
+
+RUN echo "source 'https://rubygems.org'" > Gemfile
+
+RUN [ -z "$TRAVIS_COMMIT" ] && \
+  echo "gem 'fast_excel', git: 'https://github.com/Paxa/fast_excel.git'" >> Gemfile || true
+RUN [ -z "$TRAVIS_COMMIT" ] || \
+  echo "gem 'fast_excel', git: 'https://github.com/Paxa/fast_excel.git', branch: '$TRAVIS_BRANCH', ref: '$TRAVIS_COMMIT'" >> Gemfile
+
+RUN cat Gemfile
+RUN bundle

data/Gemfile

@@ -3,7 +3,9 @@ source 'https://rubygems.org'
 gem 'ffi'
 gem 'ffi_gen', require: false
 
-gem 'roo', '2.7.1', git: 'https://github.com/roo-rb/roo.git'
+gem 'rake'
+
+gem 'roo', '2.8.3', git: 'https://github.com/roo-rb/roo.git', tag: 'v2.8.3'
 
 gem 'minitest'
 gem 'minitest-reporters'
@@ -11,5 +13,6 @@ 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'
+gem 'process_memory', git: 'https://github.com/paxa/process_memory', platforms: :ruby

data/Gemfile.lock

@@ -1,54 +1,59 @@
 GIT
   remote: https://github.com/paxa/process_memory
-  revision: 1aa4df28c9a98903301317236104abe591e086fd
+  revision: 282c75336a4a6b92207cd1eaa57f20887b92601e
   specs:
     process_memory (0.1)
 
 GIT
   remote: https://github.com/randym/axlsx.git
-  revision: c8ac844572b25fda358cc01d2104720c4c42f450
+  revision: 8e7b4b3b7259103452c191f73ce0bf64f66033fe
   specs:
-    axlsx (2.1.0.pre)
-      htmlentities (~> 4.3.4)
+    axlsx (3.0.0.pre)
+      htmlentities (~> 4.3, >= 4.3.4)
       mimemagic (~> 0.3)
-      nokogiri (>= 1.6.6)
-      rubyzip (>= 1.2.1)
+      nokogiri (~> 1.8, >= 1.8.2)
+      rubyzip (~> 1.2, >= 1.2.1)
 
 GIT
   remote: https://github.com/roo-rb/roo.git
-  revision: 6bde8588dfd97d7a18981ee3ac7b444fec165a2c
+  revision: d416f1520c50bbab160ca2ed9a49498fcc3edf50
+  tag: v2.8.3
   specs:
-    roo (2.7.1)
+    roo (2.8.3)
       nokogiri (~> 1)
-      rubyzip (>= 1.2.1, < 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    benchmark-ips (2.7.2)
-    builder (3.2.3)
-    ffi (1.9.18)
+    benchmark-ips (2.8.2)
+    builder (3.2.4)
+    ffi (1.13.1)
     ffi_gen (1.2.0)
       ffi (~> 1.0)
     htmlentities (4.3.4)
-    mimemagic (0.3.2)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    minitest-reporters (1.1.14)
+    mimemagic (0.3.5)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    ruby-progressbar (1.8.1)
-    rubyzip (1.2.1)
-    write_xlsx (0.83.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    rubyzip (1.3.0)
+    write_xlsx (0.85.7)
       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.3.1)
 
 PLATFORMS
   ruby
@@ -61,8 +66,10 @@ DEPENDENCIES
   minitest
   minitest-reporters
   process_memory!
-  roo (= 2.7.1)!
+  rake
+  roo (= 2.8.3)!
   write_xlsx
+  xlsxtream
 
 BUNDLED WITH
-   1.14.5
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Pavel Evstigneev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -3,9 +3,22 @@ ifdef V
 Q=
 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
+
 all :
+	# @echo "Compiling ext/text_width ..."
+	# rake compile
 	@echo "Compiling libxlsxwriter ..."
+ifdef USE_CMAKE
+	@echo "run cmake libxlsxwriter ..."
+	cmake libxlsxwriter
+else
 	$(Q)$(MAKE) -C libxlsxwriter
+endif
 
 clean :
 	$(Q)$(MAKE) clean -C libxlsxwriter

data/README.md

@@ -1,9 +1,9 @@
-# Ultra Fast Excel Writter for Ruby
+# Ultra Fast Excel Writer for Ruby
 
 ```ruby
 require 'fast_excel'
 
-workbook = FastExcel.open("hello_world_ffi.xlsx", constant_memory: true)
+workbook = FastExcel.open("hello_world.xlsx", constant_memory: true)
 workbook.default_format.set(
   font_size: 0, # user's default
   font_family: "Arial"
@@ -11,7 +11,7 @@ workbook.default_format.set(
 
 worksheet = workbook.add_worksheet("Example Report")
 
-bold = workbook.bold_cell_format
+bold = workbook.bold_format
 worksheet.set_column(0, 0, FastExcel::DEF_COL_WIDTH, bold)
 
 price = workbook.number_format("#,##0.00")
@@ -20,56 +20,179 @@ worksheet.set_column(1, 1, 20, price)
 date_format = workbook.number_format("[$-409]m/d/yy h:mm AM/PM;@")
 worksheet.set_column(2, 2, 20, date_format)
 
-worksheet.write_row(0, ["message", "price", "date"], bold)
+worksheet.append_row(["message", "price", "date"], bold)
 
 for i in 1..1000
-  worksheet.write_row(i, ["Hello", (rand * 10_000_000).round(2), Time.now])
+  worksheet.append_row(["Hello", (rand * 10_000_000).round(2), Time.now])
 end
 
-worksheet.write_row(1001, ["Sum", FastExcel::Formula.new("SUM(B2:B1001)")], bold)
+worksheet.append_row(["Sum", FastExcel::Formula.new("SUM(B2:B1001)")], bold)
 
 workbook.close
 ```
 
-This repositiry and gem contain sources of [libxlsxwriter](https://github.com/jmcnamara/libxlsxwriter)
+See [more examples](https://github.com/Paxa/fast_excel/tree/master/examples)
 
-## Benchmarks
+This repository and gem contain sources of [libxlsxwriter](https://github.com/jmcnamara/libxlsxwriter)
 
-1000 rows:
+## Install
+
+```ruby
+# Gemfile
+gem 'fast_excel'
 ```
-Comparison:
-           FastExcel:       31.7 i/s
-               Axlsx:        8.0 i/s - 3.98x  slower
-          write_xlsx:        6.9 i/s - 4.62x  slower
+Or
+```
+gem install fast_excel
 ```
 
-20000 rows:
+
+
+### Create Document
+```ruby
+workbook = FastExcel.open # creates tmp file
+# ...
+send_data(workbook.read_string, filename: "table.xlsx") # read tmp file and delete it
 ```
-Comparison:
-           FastExcel:        1.4 i/s
-               Axlsx:        0.4 i/s - 3.46x  slower
-          write_xlsx:        0.1 i/s - 17.04x  slower
+
+Also can use  `workbook.remove_tmp_file` 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
+```ruby
+workbook = FastExcel.open(constant_memory: true)
 ```
 
-Max memory usage, generating 100k rows:
+**Save to file**
+```ruby
+workbook = FastExcel.open("my_dinner.xlsx")
 ```
-FastExcel   - 20 MB
-Axlsx       - 60 MB
-write_xlsx - 100 MB
+
+### Write Data
+FastExcel will automatically detect data type and one of `write_number` or `write_datetime` or `write_formula` or `write_string` or `write_url`
+```ruby
+workbook = FastExcel.open
+worksheet = workbook.add_worksheet
+
+# write specific type value value
+worksheet.write_number(row = 0, col = 5, 1_234_567, format = nil)
+
+# write value with type detection
+worksheet.write_value(row = 0, col = 5, 1_234_567, format = nil)
+
+# write row of values. format argument can be format object or array of format objects
+worksheet.write_row(row = 1, ["strong", 123_456, Time.now], format = nil)
+
+# write row to the bottom
+worksheet.append_row(["strong", 123_456, Time.now], )
+
+# shortcut for append_row()
+worksheet << ["strong", 123_456, Time.now]
 ```
 
-## Install
+**Saving dates**: excel store dates as number of days since 1st January 1900, and FastExcel will make it for you.
 
+To make saving of dates slightly faster can use `FastExcel.date_num` helper:
 ```ruby
-# Gemfile
-gem 'fast_excel'
+date_format = workbook.number_format("[$-409]m/d/yy hh:mm;@")
+worksheet.write_number(0, 0, FastExcel.date_num(Time.now, Time.zone.utc_offset), date_format)
 ```
-Or
+
+**Formulas**: special type of value in excel
+```ruby
+worksheet << [1, 2, 3, 4]
+worksheet << [FastExcel::Formula.new("SUM(A1:D1)")] # A2 will be shown as 10
 ```
-gem install fast_excel
+
+**URL**: Link to website or something else
+```ruby
+url_format = workbook.add_format(underline: :underline_single, font_color: :blue) # format is optional
+worksheet.append_row([
+  FastExcel::URL.new("https://github.com/Paxa/fast_excel"),
+  FastExcel::URL.new("postgres://localhost")
+], url_format)
+# or
+worksheet.write_url(0, 2, "https://github.com/Paxa/fast_excel", url_format)
+```
+
+
+### Data Formatting
+```ruby
+format = worksheet.add_format(
+  bold: true,
+  italic: true,
+  font_outline: true,
+  font_shadow: true,
+  text_wrap: true,
+  font_strikeout: true,
+  shrink: true,
+  text_justlast: true,
+  font_size: 13, # default is 11, use 0 for user's default
+  font_name: "Arial", # default is Calibri, also accessible via font_family
+  font_color: :orange, # can use RGB hex as "#FF0000" or 0x00FF00 or color name as symbol or string
+  font_script: :font_subscript,
+  rotation: 10,
+  underline: :underline_single, # or :underline_double or :underline_single_accounting or :underline_double_accounting
+  indent: 1,
+  # border styles
+  border: :border_thin,
+  left: :medium,
+  top: :dashed,
+  right: :double,
+  bottom: :hair,
+  bottom_color: :alice_blue,
+  top_color: "#11ABCD",
+  # Align
+  align: {h: :align_center, v: :align_vertical_center},
+  num_format: "#,##0.00"
+)
 ```
 
-## API
+**Shortcuts**:
+```ruby
+workbook.bold_format # bold text
+workbook.number_format("[$-409]m/d/yy h:mm AM/PM;@") # format for date
+```
+
+### Set Column Width
+
+```ruby
+worksheet.set_column(start_col, end_col, width = nil, format = nil)
+# or
+worksheet.set_column_width(col, width = 60)
+# or
+worksheet.set_columns_width(start_col, end_col, width = 60)
+```
+
+### Set Row Height
+```ruby
+worksheet.set_row(row_num = 0, height = 30, format = nil)
+```
+
+### Column Auto Width
+
+Column authwidth only works for string values, because numbers may have custom formatting
+
+Enabling column auto widths will slow down writing string values for about 15-25%
+
+```ruby
+require 'fast_excel'
+
+workbook = FastExcel.open(constant_memory: true)
+
+worksheet = workbook.add_worksheet
+worksheet.auto_width = true
+
+worksheet.append_row(["some text", "some longer text for example"])
+
+content = workbook.read_string
+File.open('./some_file.xlsx', 'wb') {|f| f.write(content) }
+```
+
+![fast_excel_auto_width](https://user-images.githubusercontent.com/26019/51788441-ba981300-21b0-11e9-9611-54dda78effcd.png)
+
+
+### API
 
 This gem is FFI binding for libxlsxwriter C library with some syntax sugar. All original functions is avaliable, for example:
 
@@ -81,15 +204,29 @@ worksheet.activate
 
 Full libxlsxwriter documentation: [http://libxlsxwriter.github.io/](http://libxlsxwriter.github.io/)
 
-Helper Methods:
-
-* `FastExcel.open(filename = nil, constant_memory: false, default_format: {})` - open new workbook, if `filename` is nil - it will craete tmp file, `default_format` will be called with `workbook.default_format.set(...)`
-* `FastExcel.date_num(time, offset = nil)` - generate Excel's internal date value, number of days since 1900-Jan-01, works faster then creating `Libxlsxwriter::Datetime` struct. `offset` argument is number hours from UTC, e.g. `3.5`
-* `FastExcel.print_ffi_obj(object)` - print FFI object fields, just for debugging
-* `workbook.bold_cell_format` - shortcut for creating bold format
-* `workbook.number_format(num_format)` - create number or date format, for money usually: `"#,##0.00"`, for date: `"[$-409]m/d/yy h:mm AM/PM;@"`
-* `workbook.read_string` - close workbook, read file to string, delete file (only if tmp file)
-* `workbook.remove_tmp_file` - delete tmp file (only if tmp file)
-* `worksheet.write_row(row_num, array_of_mixed_value, formats = nil)` - write values one by one, detecting type automatically. `formats` can be array, or Format object or nil
-* `format.font_family` - alias for `format.font_name`
-* `workbook.default_format.font_size` - set it to 0 if you want to use default font size (that what user set in Excel settings)
+Generated rdoc: [rubydoc.info/github/Paxa/fast_excel](https://www.rubydoc.info/github/Paxa/fast_excel)
+
+## Benchmarks
+
+1000 rows:
+```
+Comparison:
+           FastExcel:       31.7 i/s
+               Axlsx:        8.0 i/s - 3.98x  slower
+          write_xlsx:        6.9 i/s - 4.62x  slower
+```
+
+20000 rows:
+```
+Comparison:
+           FastExcel:        1.4 i/s
+               Axlsx:        0.4 i/s - 3.46x  slower
+          write_xlsx:        0.1 i/s - 17.04x  slower
+```
+
+Max memory usage, generating 100k rows:
+```
+FastExcel   - 20 MB
+Axlsx       - 60 MB
+write_xlsx - 100 MB
+```