xlsxtream 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa056909b0dd743240cb8b4ddb85a86fd1110042110cd49731e9e8d13e7df5d9
-  data.tar.gz: 6726cf3a9d3f52bfe690551124d2d9cd769fd6c1b20d96893a0b336536a09c44
+  metadata.gz: ad3cd850f298db3909ce061876610fdaad2de689675d9b23d6738f8a177f5254
+  data.tar.gz: 5b1002fa1031cd53612735d6732acd43a8b0c086aaccc0f62f9a761583f21c5a
 SHA512:
-  metadata.gz: 27292c56f60cf20c186af8bba0d52a1c799a0c1f6a76de49660d3c591986375df39b59e5752042aa1c5bf1016e17ce81ef28ceefdf3a6f59fc34a3f7d6a5d981
-  data.tar.gz: 743ea2bcdac011ac472f146222c5f20e63cb4bc38304ae470f80d6cf5660a65071556d3c61afd421e4c5933a0b6c705331348bd44a20641c77a92f1c736c0ee0
+  metadata.gz: bed396c449a050615e3822fc9c76935db6e9c7cb7434bc5a49c4effd76221ed66a023be3cff3859f30d290259c33cf685f8e8a2baaa237d52ae5787b79ee7d67
+  data.tar.gz: 5c31396c6b49b90c7eb9f4fd4a32959ff97eefbe2fa0936833dfc4326954d6e06a267ee4e97ee42faaf8268a2147b3e15edc1ed3341f55794e96f5531afff601

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
-sudo: false
+os: linux
+dist: xenial
 cache: bundler
 
 before_install:
@@ -10,6 +11,7 @@ rvm:
   - 2.1.10
   - 2.2.10
   - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.4.0 (2020-06-27)
+
+- Allow writing worksheets without a block using add\_worksheet (#42, #45)
+- Deprecate calling add\_worksheet with a block, use write\_worksheet instead (#45)
+- Relax rubyzip development dependency to allow current version (#46)
+
 ## 2.3.0 (2019-11-27)
 
 - Speed up date / time conversion to OA format (#39)

data/README.md

@@ -78,6 +78,13 @@ xlsx.write_worksheet(name: 'SheetWithAutoFormat', auto_format: true) do |sheet|
   sheet << ['true', '11.85', '2050-01-01T12:00', '1984-01-01']
 end
 
+# You can also create worksheet without a block, using the `add_worksheet` method.
+# It can be only used sequentially, so remember to manually close the worksheet
+# when you are done (before opening a new one).
+worksheet = xls.add_worksheet(name: 'SheetWithoutBlock')
+worksheet << ['some', 'data']
+worksheet.close
+
 # Writes metadata and ZIP archive central directory
 xlsx.close
 # Close IO object

data/lib/xlsxtream/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Xlsxtream
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/xlsxtream/workbook.rb

@@ -55,30 +55,32 @@ module Xlsxtream
         @io = IO::ZipTricks.new(output)
       end
       @sst = SharedStringTable.new
-      @worksheets = Hash.new { |hash, name| hash[name] = hash.size + 1 }
+      @worksheets = []
     end
 
-    def write_worksheet(name = nil, options = {})
-      if name.is_a? Hash and options.empty?
-        options = name
-        name = nil
+    def add_worksheet(*args, &block)
+      if block_given?
+        # This method used to be an alias for `write_worksheet`. This was never publicly documented,
+        # but to avoid breaking this private API we keep the old behaviour when called with a block.
+        Kernel.warn "#{caller.first[/.*:\d+:(?=in `)/]} warning: Calling #{self.class}#add_worksheet with a block is deprecated, use #write_worksheet instead."
+        return write_worksheet(*args, &block)
       end
-      use_sst = options.fetch(:use_shared_strings, @options[:use_shared_strings])
-      auto_format = options.fetch(:auto_format, @options[:auto_format])
-      columns = options.fetch(:columns, @options[:columns])
-      sst = use_sst ? @sst : nil
 
-      name = name || options[:name] || "Sheet#{@worksheets.size + 1}"
-      sheet_id = @worksheets[name]
-      @io.add_file "xl/worksheets/sheet#{sheet_id}.xml"
+      unless @worksheets.all? { |ws| ws.closed? }
+        fail Error, "Close the current worksheet before adding a new one"
+      end
+
+      build_worksheet(*args)
+    end
+
+    def write_worksheet(*args)
+      worksheet = build_worksheet(*args)
 
-      worksheet = Worksheet.new(@io, :sst => sst, :auto_format => auto_format, :columns => columns)
       yield worksheet if block_given?
       worksheet.close
 
       nil
     end
-    alias_method :add_worksheet, :write_worksheet
 
     def close
       write_workbook
@@ -93,6 +95,27 @@ module Xlsxtream
     end
 
     private
+    def build_worksheet(name = nil, options = {})
+      if name.is_a? Hash and options.empty?
+        options = name
+        name = nil
+      end
+
+      use_sst = options.fetch(:use_shared_strings, @options[:use_shared_strings])
+      auto_format = options.fetch(:auto_format, @options[:auto_format])
+      columns = options.fetch(:columns, @options[:columns])
+      sst = use_sst ? @sst : nil
+
+      sheet_id = @worksheets.size + 1
+      name = name || options[:name] || "Sheet#{sheet_id}"
+
+      @io.add_file "xl/worksheets/sheet#{sheet_id}.xml"
+
+      worksheet = Worksheet.new(@io, :id => sheet_id, :name => name, :sst => sst, :auto_format => auto_format, :columns => columns)
+      @worksheets << worksheet
+
+      worksheet
+    end
 
     def write_root_rels
       @io.add_file "_rels/.rels"
@@ -113,8 +136,8 @@ module Xlsxtream
           <workbookPr date1904="false"/>
           <sheets>
       XML
-      @worksheets.each do |name, sheet_id|
-        @io << %'<sheet name="#{XML.escape_attr name}" sheetId="#{sheet_id}" r:id="#{rid.next!}"/>'
+      @worksheets.each do |worksheet|
+        @io << %'<sheet name="#{XML.escape_attr worksheet.name}" sheetId="#{worksheet.id}" r:id="#{rid.next!}"/>'
       end
       @io << XML.strip(<<-XML)
           </sheets>
@@ -189,8 +212,8 @@ module Xlsxtream
       @io.add_file "xl/_rels/workbook.xml.rels"
       @io << XML.header
       @io << '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'
-      @worksheets.each do |name, sheet_id|
-        @io << %'<Relationship Id="#{rid.next!}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="worksheets/sheet#{sheet_id}.xml"/>'
+      @worksheets.each do |worksheet|
+        @io << %'<Relationship Id="#{rid.next!}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="worksheets/sheet#{worksheet.id}.xml"/>'
       end
       @io << %'<Relationship Id="#{rid.next!}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="styles.xml"/>'
       @io << %'<Relationship Id="#{rid.next!}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings" Target="sharedStrings.xml"/>' unless @sst.empty?
@@ -208,8 +231,8 @@ module Xlsxtream
           <Override PartName="/xl/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"/>
       XML
       @io << '<Override PartName="/xl/sharedStrings.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"/>' unless @sst.empty?
-      @worksheets.each_value do |sheet_id|
-        @io << %'<Override PartName="/xl/worksheets/sheet#{sheet_id}.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>'
+      @worksheets.each do |worksheet|
+        @io << %'<Override PartName="/xl/worksheets/sheet#{worksheet.id}.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>'
       end
       @io << '</Types>'
     end

data/lib/xlsxtream/worksheet.rb

@@ -7,6 +7,7 @@ module Xlsxtream
     def initialize(io, options = {})
       @io = io
       @rownum = 1
+      @closed = false
       @options = options
 
       write_header
@@ -20,6 +21,19 @@ module Xlsxtream
 
     def close
       write_footer
+      @closed = true
+    end
+
+    def closed?
+      @closed
+    end
+
+    def id
+      @options[:id]
+    end
+
+    def name
+      @options[:name]
     end
 
     private

data/xlsxtream.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", ">= 1.7", "< 3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubyzip", "~> 1.2"
+  spec.add_development_dependency "rubyzip", ">= 1.2"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlsxtream
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Felix Bünemann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip_tricks
@@ -68,14 +68,14 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
@@ -142,7 +142,7 @@ homepage: https://github.com/felixbuenemann/xlsxtream
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Xlsxtream is a streaming XLSX spreadsheet writer
 test_files: []