xlsxtream 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 642a452b03d01ae99f30e2718d0ade58a6bb20d1
-  data.tar.gz: 767f1ab54f50f8fea6c4061d2820d4f21783bbac
+  metadata.gz: e9291c6ab43b7b9218c0341b2556daabe838f919
+  data.tar.gz: 31aca2466d4cbd18fdc4a3ec9181de16a9488f70
 SHA512:
-  metadata.gz: 34026fb0948c29a706c71345a872665946222c20d90e8772e80cd87c7643b6afc78ccff915d6b3e88b8dbcea61dcfe813307dd19c4eb816f99600e0caa6eeb94
-  data.tar.gz: f341216f5220bead5c40f230b6a2df3c05b85b5540173c0783a40493cd6ba4b2f6b126a3e63f0bd900f7d68127a64c789944de3a8a1f27de864b1f3262e82607
+  metadata.gz: cd1d0aab1d0c4117f87ccd9efc432977d4057538ecc4769a339ea46f964020a02b255f971ce8aa1a1c2c4af6d28814a8d740ee1cf0fabcfe76d8c6741312fe19
+  data.tar.gz: 5c373153d1b97ca5db24c7c8cd7be7e79605a4129993f2d8b586b3e8ee1fc9c8ccdd51478886a0ca3bebde688ffc72c20e7b932293ff2e2bc861fbcaf6d9cea5

data/.travis.yml

@@ -6,9 +6,6 @@ cache: bundler
 before_install: gem install bundler -v '~> 1.15' --conservative --minimal-deps
 
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
   - 2.1.10
   - 2.2.7
   - 2.3.4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.0.0 (2017-10-31)
+
+- Replace RubyZip with ZipTricks as default compressor (#16)
+- Drop support for Ruby < 2.1.0 (required for zip\_tricks gem)
+- Deprecate :io\_wrapper option, you can now pass wrapper instances (#20)
+
 ## 1.3.2 (2017-10-30)
 
 - Fix circular require in workbook

data/README.md

@@ -61,7 +61,7 @@ end
 # for the workbook or a single worksheet. The SST has to be kept in memory,
 # so do not use it if you have a huge amount of rows or a little duplication
 # of content across cells. A single SST is used for the whole workbook.
-xlsx.write_worksheet('SheetWithSST', :use_shared_strings => true) do |sheet|
+xlsx.write_worksheet('SheetWithSST', use_shared_strings: true) do |sheet|
   sheet << ['the', 'same', 'old', 'story']
   sheet << ['the', 'old', 'same', 'story']
   sheet << ['old', 'the', 'same', 'story']
@@ -72,7 +72,7 @@ end
 # "Number stored as text". Dates and times must be in the ISO-8601 format and
 # numeric values must contain only numbers and an optional decimal separator.
 # The strings true and false are detected as boolean values.
-xlsx.write_worksheet('SheetWithAutoFormat', :auto_format => true) do |sheet|
+xlsx.write_worksheet('SheetWithAutoFormat', auto_format: true) do |sheet|
   # these two rows will be identical in the xlsx-output
   sheet << [true, 11.85, DateTime.parse('2050-01-01T12:00'), Date.parse('1984-01-01')]
   sheet << ['true', '11.85', '2050-01-01T12:00', '1984-01-01']
@@ -84,14 +84,41 @@ xlsx.close
 io.close
 
 # Changing the default font from Calibri, 12pt, Swiss
-Xlsxtream::Workbook.new(io, :font => {
-  :name => 'Times New Roman',
-  :size => 10, # size in pt
-  :family => 'Roman' # Swiss, Modern, Script, Decorative
+Xlsxtream::Workbook.new(io, font: {
+  name: 'Times New Roman',
+  size: 10, # size in pt
+  family: 'Roman' # Swiss, Modern, Script, Decorative
 })
 
 ```
 
+## Compatibility
+
+The current version of Xlsxtream requires at least Ruby 2.1.0.
+
+If you are using an older Ruby version you can use the following in your Gemfile:
+
+```ruby
+gem 'xlsxtream', '< 2'
+```
+
+* The last version with support for Ruby 1.9.1 is 1.2.0.
+* The last version with support for Ruby 1.9.2 is 1.3.2.
+
+## Upgrading
+
+If you are upgrading from a version earlier than 2.x and are using the undocumented `:io_wrapper` option you need to update your code:
+
+```ruby
+# Pre 2.x code with :io_wrapper option
+Xlsxtream::Workbook.new(io, io_wrapper: MyCustomIOWrapper)
+# New code with IO wrapper instance
+io_wrapper = MyCustomIOWrapper.new(io)
+Xlsxtream::Workbook.new(io_wrapper)
+```
+
+Every IO-like object that responds to `:add_file` is treated as an IO wrapper.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/xlsxtream/errors.rb

@@ -1,3 +1,4 @@
 module Xlsxtream
   class Error < StandardError; end
+  class Deprecation < StandardError; end
 end

data/lib/xlsxtream/io/directory.rb

@@ -5,6 +5,7 @@ module Xlsxtream
     class Directory
       def initialize(path)
         @path = Pathname(path)
+        @file = nil
       end
 
       def <<(data)
@@ -19,7 +20,7 @@ module Xlsxtream
       end
 
       def close
-        @file.close if @file.respond_to? :close
+        @file.close if @file
       end
     end
   end

data/lib/xlsxtream/io/stream.rb

@@ -3,6 +3,7 @@ module Xlsxtream
     class Stream
       def initialize(stream)
         @stream = stream
+        @path = nil
       end
 
       def <<(data)

data/lib/xlsxtream/io/zip_tricks.rb

@@ -0,0 +1,44 @@
+require "zip_tricks"
+
+module Xlsxtream
+  module IO
+    class ZipTricks
+      BUFFER_SIZE = 64 * 1024
+
+      def initialize(body)
+        @streamer = ::ZipTricks::Streamer.new(body)
+        @wf = nil
+        @buffer = ''
+      end
+
+      def <<(data)
+        @buffer << data
+        flush_buffer if @buffer.size >= BUFFER_SIZE
+        self
+      end
+
+      def add_file(path)
+        flush_file
+        @wf = @streamer.write_deflated_file(path)
+      end
+
+      def close
+        flush_file
+        @streamer.close
+      end
+
+      private
+
+      def flush_buffer
+        @wf << @buffer
+        @buffer.clear
+      end
+
+      def flush_file
+        return unless @wf
+        flush_buffer if @buffer.size > 0
+        @wf.close
+      end
+    end
+  end
+end

data/lib/xlsxtream/io/zip_tricks_fibers.rb

@@ -0,0 +1,36 @@
+require "zip_tricks"
+
+module Xlsxtream
+  module IO
+    class ZipTricksFibers
+      def initialize(body)
+        @streamer = ::ZipTricks::Streamer.new(body)
+        @wf = nil
+      end
+
+      def <<(data)
+        @wf.resume(data)
+        self
+      end
+
+      def add_file(path)
+        @wf.resume(:__close__) if @wf
+
+        @wf = Fiber.new do | bytes_or_close_sym |
+          @streamer.write_deflated_file(path) do |write_sink|
+            loop do
+              break if bytes_or_close_sym == :__close__
+              write_sink << bytes_or_close_sym
+              bytes_or_close_sym = Fiber.yield
+            end
+          end
+        end
+      end
+
+      def close
+        @wf.resume(:__close__) if @wf
+        @streamer.close
+      end
+    end
+  end
+end

data/lib/xlsxtream/version.rb

@@ -1,3 +1,3 @@
 module Xlsxtream
-  VERSION = '1.3.2'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/xlsxtream/workbook.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
-require "stringio"
 require "xlsxtream/errors"
 require "xlsxtream/xml"
 require "xlsxtream/shared_string_table"
 require "xlsxtream/worksheet"
-require "xlsxtream/io/rubyzip"
+require "xlsxtream/io/zip_tricks"
 
 module Xlsxtream
   class Workbook
@@ -20,7 +19,7 @@ module Xlsxtream
 
     class << self
 
-      def open(output = nil, options = {})
+      def open(output, options = {})
         workbook = new(output, options)
         if block_given?
           begin
@@ -35,15 +34,25 @@ module Xlsxtream
 
     end
 
-    def initialize(output = nil, options = {})
-      output ||= StringIO.new
+    def initialize(output, options = {})
+      if output.nil?
+        fail Error, "Xlsxtream::Workbook.new output cannot be nil"
+      end
       @options = options
-      io_wrapper = options[:io_wrapper] || IO::RubyZip
+      if options[:io_wrapper]
+        fail Deprecation,
+          "The Xlsxtream::Workbook.new :io_wrapper option is deprecated. "\
+          "Please pass an IO wrapper instance as the first argument instead."
+      end
       if output.is_a?(String) || !output.respond_to?(:<<)
         @file = File.open(output, 'wb')
-        @io = io_wrapper.new(@file)
+        @io = IO::ZipTricks.new(@file)
+      elsif output.respond_to? :add_file
+        @file = nil
+        @io = output
       else
-        @io = io_wrapper.new(output)
+        @file = nil
+        @io = IO::ZipTricks.new(output)
       end
       @sst = SharedStringTable.new
       @worksheets = Hash.new { |hash, name| hash[name] = hash.size + 1 }
@@ -77,7 +86,7 @@ module Xlsxtream
       write_workbook_rels
       write_root_rels
       write_content_types
-      @io.close
+      @io.close if @io.respond_to? :close
       @file.close if @file
       nil
     end

data/xlsxtream.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_ruby_version = ">= 2.1.0"
 
-  spec.add_dependency "rubyzip", ">= 1.2.0"
+  spec.add_dependency "zip_tricks", "~> 4.5"
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubyzip", "~> 1.2"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xlsxtream
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Felix Bünemann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: zip_tricks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -40,18 +40,32 @@ dependencies:
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,8 @@ files:
 - lib/xlsxtream/io/hash.rb
 - lib/xlsxtream/io/rubyzip.rb
 - lib/xlsxtream/io/stream.rb
+- lib/xlsxtream/io/zip_tricks.rb
+- lib/xlsxtream/io/zip_tricks_fibers.rb
 - lib/xlsxtream/row.rb
 - lib/xlsxtream/shared_string_table.rb
 - lib/xlsxtream/version.rb
@@ -122,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="