xlsxtream 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b825830ee0ab905c1f96c80dd54ba8c307578d165ec429c5ffd275e64720225c
-  data.tar.gz: b5b75f151994915de22b8a8533c92f3cdb35d9acfb7a8940b2a4baf7f688cce7
+  metadata.gz: e8cc8d872dffb10c74eca0a31318350d2343ee609475a67a1aedc4c515ecc786
+  data.tar.gz: 715eae8f94c4a59f86b4abb1ec263266a481383fee3ceee912804f96cc6c592a
 SHA512:
-  metadata.gz: d91bb3c4804ac213150e6dfdff6a73f8919ac7f1ce649545af96a8bc328e45180d3ed06cfb0fd2431452d0a8f6999150fd12ccee70ac5dbbbdd23962e11b13e2
-  data.tar.gz: 46d67651baf5d02202563fe4a1c2f756320626ec405cfae9a47b3f03e8b4d6b0b38b60d49889ef365a83deccb296baa6ded0666f141d707d2ea62d157c524bed
+  metadata.gz: d4c2025bc90c39d416af05af138c91439d4c0a16e9f20c0be718505c8809013044f060938284006d536be11862974f2041c983da0885f788fd02c09355df6c80
+  data.tar.gz: 70e5a60021a8c64a7adda9a3bcbac071a73f2fce8cc62c709ab502c34693e5c931532c5215023a10c627b31b1b68eeff9bc26f7b90e5d386455ab70f20aa581b

data/.travis.yml

@@ -7,6 +7,7 @@ before_install: gem install bundler -v '~> 1.15' --conservative --minimal-deps
 
 rvm:
   - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.1.0 (2018-07-21)
+
+- New `:columns` option, allowing column widths to be specified (#25)
+- Fix compatibility with `ruby --enable-frozen-string-literal` (#27)
+- Support giving the worksheet name as an option to write\_worksheet (#28)
+
 ## 2.0.1 (2018-03-11)
 
 - Rescue gracefully from invalid dates with auto-format (#22)
@@ -48,7 +54,7 @@
 
 ## 0.3.0 (2017-07-12)
 
-- Add support for auto-formatting
+- Add support for auto-formatting (#8)
 
 ## 0.2.0 (2017-02-20)
 

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(name: '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(name: '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']
@@ -90,8 +90,20 @@ Xlsxtream::Workbook.new(io, font: {
   family: 'Roman' # Swiss, Modern, Script, Decorative
 })
 
+# Specifying column widths in pixels or characters; 3 column example;
+# "pixel" widths appear to be *relative* to an assumed 11pt Calibri
+# font, so if selecting a different font or size (see above), do not
+# adjust widths to match. Calculate pixel widths for 11pt Calibri.
+Xlsxtream::Workbook.new(io, columns: [
+  { width_pixels: 33 },
+  { width_chars: 7 },
+  { width_chars: 24 }
+])
+# The :columns option can also be given to write_worksheet, so it's
+# possible to have multiple worksheets with different column widths.
 ```
 
+
 ## Compatibility
 
 The current version of Xlsxtream requires at least Ruby 2.1.0.

data/lib/xlsxtream.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "xlsxtream/version"
 
 module Xlsxtream
@@ -5,4 +6,5 @@ end
 
 require "xlsxtream/workbook"
 require "xlsxtream/worksheet"
+require "xlsxtream/columns"
 require "xlsxtream/row"

data/lib/xlsxtream/columns.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module Xlsxtream
+  class Columns
+
+    # Pass an Array of column options Hashes. Symbol Hash keys and associated
+    # values are as follows:
+    #
+    # +width_chars+::  Approximate column with in characters, calculated per
+    #                  MSDN docs as if using a default 11 point Calibri font
+    #                  for a 96 DPI target. Specify as an integer.
+    #
+    # +width_pixels+:: Exact with of column in pixels. Specify as a Float.
+    #                  Overrides +width_chars+ if that is also provided.
+    #
+    def initialize(column_options_array)
+      @columns = column_options_array
+    end
+
+    def to_xml
+      xml = String.new('<cols>')
+
+      @columns.each_with_index do |column, index|
+        width_chars  = column[ :width_chars  ]
+        width_pixels = column[ :width_pixels ]
+
+        if width_chars.nil? && width_pixels.nil?
+          xml << %Q{<col min="#{index + 1}" max="#{index + 1}"/>}
+        else
+
+          # https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.column.aspx
+          #
+          # Truncate(
+          #   [{Number of Characters} * {Maximum Digit Width} + {5 pixel padding}]
+          #   /{Maximum Digit Width}*256
+          # )/256
+          #
+          # "Using the Calibri font as an example, the maximum digit width of
+          #  11 point font size is 7 pixels (at 96 dpi)"
+          #
+          # By observation, though, I note that a different spreadsheet-wide
+          # font size selected via the Workbook's ":font => { :size => ... }"
+          # options Hash entry results in Excel, at least, scaling the given
+          # widths in proportion with the requested font size change. We do
+          # not, apparently, need to do that ourselves and run the calculation
+          # based on the reference 11 point -> 7 pixel figure.
+          #
+          width_pixels ||= ((((width_chars * 7.0) + 5) / 7) * 256).truncate() / 256.0
+
+          xml << %Q{<col min="#{index + 1}" max="#{index + 1}" width="#{width_pixels}" customWidth="1"/>}
+        end
+      end
+
+      xml << '</cols>'
+    end
+
+  end
+end

data/lib/xlsxtream/errors.rb

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

data/lib/xlsxtream/io/directory.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "pathname"
 
 module Xlsxtream

data/lib/xlsxtream/io/hash.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xlsxtream
   module IO
     class Hash

data/lib/xlsxtream/io/rubyzip.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "zip"
 require "xlsxtream/errors"
 

data/lib/xlsxtream/io/stream.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xlsxtream
   module IO
     class Stream

data/lib/xlsxtream/io/zip_tricks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "zip_tricks"
 
 module Xlsxtream
@@ -8,7 +9,7 @@ module Xlsxtream
       def initialize(body)
         @streamer = ::ZipTricks::Streamer.new(body)
         @wf = nil
-        @buffer = ''
+        @buffer = String.new
       end
 
       def <<(data)

data/lib/xlsxtream/row.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 require "date"
 require "xlsxtream/xml"
 
@@ -27,8 +27,8 @@ module Xlsxtream
     end
 
     def to_xml
-      column = 'A'
-      xml = %Q{<row r="#{@rownum}">}
+      column = String.new('A')
+      xml = String.new(%Q{<row r="#{@rownum}">})
 
       @row.each do |value|
         cid = "#{column}#{@rownum}"

data/lib/xlsxtream/shared_string_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xlsxtream
   class SharedStringTable < Hash
     def initialize

data/lib/xlsxtream/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xlsxtream
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/xlsxtream/workbook.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 require "xlsxtream/errors"
 require "xlsxtream/xml"
 require "xlsxtream/shared_string_table"
@@ -65,13 +65,14 @@ module Xlsxtream
       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 ||= "Sheet#{@worksheets.size + 1}"
+      name = name || options[:name] || "Sheet#{@worksheets.size + 1}"
       sheet_id = @worksheets[name]
       @io.add_file "xl/worksheets/sheet#{sheet_id}.xml"
 
-      worksheet = Worksheet.new(@io, :sst => sst, :auto_format => auto_format)
+      worksheet = Worksheet.new(@io, :sst => sst, :auto_format => auto_format, :columns => columns)
       yield worksheet if block_given?
       worksheet.close
 
@@ -104,7 +105,7 @@ module Xlsxtream
     end
 
     def write_workbook
-      rid = "rId0"
+      rid = String.new("rId0")
       @io.add_file "xl/workbook.xml"
       @io << XML.header
       @io << XML.strip(<<-XML)
@@ -184,7 +185,7 @@ module Xlsxtream
     end
 
     def write_workbook_rels
-      rid = "rId0"
+      rid = String.new("rId0")
       @io.add_file "xl/_rels/workbook.xml.rels"
       @io << XML.header
       @io << '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'

data/lib/xlsxtream/worksheet.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 require "xlsxtream/xml"
 require "xlsxtream/row"
 
@@ -28,6 +28,14 @@ module Xlsxtream
       @io << XML.header
       @io << XML.strip(<<-XML)
         <worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
+      XML
+
+      columns = Array(@options[:columns])
+      unless columns.empty?
+        @io << Columns.new(columns).to_xml
+      end
+
+      @io << XML.strip(<<-XML)
           <sheetData>
       XML
     end

data/lib/xlsxtream/xml.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xlsxtream
   module XML
     XML_ESCAPES = {

data/xlsxtream.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'xlsxtream/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlsxtream
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Felix Bünemann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip_tricks
@@ -112,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - lib/xlsxtream.rb
+- lib/xlsxtream/columns.rb
 - lib/xlsxtream/errors.rb
 - lib/xlsxtream/io/directory.rb
 - lib/xlsxtream/io/hash.rb
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Xlsxtream is a streaming XLSX spreadsheet writer