caxlsx 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1084b09a06fdcca750fa734735fe339c527327f
-  data.tar.gz: cb0849f0edbe032dc82e3d6766245e7a42ebf81f
+SHA256:
+  metadata.gz: 49062d90fcd29bac6406a90ad46894a3b0624b2a5c391d8fc24a4b35f4c7a0b3
+  data.tar.gz: 18fbd2886127ae59169c94ce4b7025adf78bb15651dba590d1f2955a2e276940
 SHA512:
-  metadata.gz: 736a38bbbb7bebebc204e3e81778e84d7ee45f9794e21b0bfab39d42ed1afe1e1e2cc905345b32889fb8cf3ae3b11a3ac7656173f991016296064a5ca82e98a7
-  data.tar.gz: 4532801d92486550f8db5ab177acb8a72de3f0e209f2483db9e13df11a7e05ef3a63f97c9062099d478ca0469c86f1ebe7a7bc5cc8d5be8018a8a3abf49b8fe4
+  metadata.gz: e5be713d4ea7daa76c58bbb648d37a146b094ea2cb9a132e3f02e58a536b20551aabef73513d4f1f619eb29c54294d02ec758f1fd959a50edbd4be565b368ade
+  data.tar.gz: 8a58ee22d90bdd99a3b0a85c59441f926c15f5ce66fdcb6ec2bb969380ba5e2c12458ab16e97cc67291b69d9e4633d102385662733de130aa2cd7bb06e693130

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 ---------
 
+- **Unreleased**
+
+- **December.7.20**: 3.0.3
+  - [PR #62](https://github.com/caxlsx/caxlsx/pull/62) - Fix edge cases in format detection for objects whose string representation made them look like numbers but the object didn’t respond to `#to_i` or `#to_f`.
+  - [PR #56](https://github.com/caxlsx/caxlsx/pull/56) - Add `zip_command` option to `#serialize` for faster serialization of large Excel files by using a zip binary
+  - [PR #54](https://github.com/caxlsx/caxlsx/pull/54) - Fix type detection for floats with out-of-rage exponents
+  
 - **July.16.20**: 3.0.2
   - [I #51](https://github.com/caxlsx/caxlsx/issues/51) - Images do not import on Windows. IO read set explicitly to binary mode.
   - [PR #53](https://github.com/caxlsx/caxlsx/pull/53) - Limit column width to 255. Maximum column width limit in MS Excel is 255 characters, see https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3

data/examples/generate.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+files = if !ARGV.empty?
+          ARGV.select { |file| File.exist?(file) }
+        else
+          Dir['*_example.md']
+        end
+
+files.each do |file|
+  puts "Executing #{file.split('.')[0].tr('_', ' ')}"
+  code = File.read(file).match(/```ruby(?<code>.+)```/m)[:code]
+  unless code.nil?
+    eval(['$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"', code].join("\n"))
+  end
+end

data/lib/axlsx.rb

@@ -10,6 +10,7 @@ require 'axlsx/util/accessors.rb'
 require 'axlsx/util/serialized_attributes'
 require 'axlsx/util/options_parser'
 require 'axlsx/util/mime_type_utils'
+require 'axlsx/util/zip_command'
 
 require 'axlsx/stylesheet/styles.rb'
 

data/lib/axlsx/drawing/pie_series.rb

@@ -47,7 +47,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       super(str) do
-        str << '<c:explosion val="' + @explosion + '"/>' unless @explosion.nil?
+        str << '<c:explosion val="' + @explosion.to_s + '"/>' unless @explosion.nil?
         colors.each_with_index do |c, index|
           str << '<c:dPt>'
           str << ('<c:idx val="' << index.to_s << '"/>')

data/lib/axlsx/package.rb

@@ -75,6 +75,9 @@ module Axlsx
     #
     # @param [String] output The name of the file you want to serialize your package to
     # @param [Boolean] confirm_valid Validate the package prior to serialization.
+    # @param [String, nil] zip_command When `nil`, `#serialize` with RubyZip to
+    #   zip the XLSX file contents. When a String, the provided zip command (e.g.,
+    #   "zip") is used to zip the file contents (may be faster for large files)
     # @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
     # @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
     #   confirm_valid should be used in the rare case that you cannot open the serialized file.
@@ -88,13 +91,23 @@ module Axlsx
     #   # ......add cool stuff to your workbook......
     #   p.serialize("example.xlsx")
     #
+    #   # Serialize to a file, using a system zip binary
+    #   p.serialize("example.xlsx", false, zip_command: "zip")
+    #   p.serialize("example.xlsx", false, zip_command: "/path/to/zip")
+    #   p.serialize("example.xlsx", false, zip_command: "zip -1")
+    #
     #   # Serialize to a stream
     #   s = p.to_stream()
     #   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
-    def serialize(output, confirm_valid=false)
+    def serialize(output, confirm_valid=false, zip_command: nil)
       return false unless !confirm_valid || self.validate.empty?
+      zip_provider = if zip_command
+                       ZipCommand.new(zip_command)
+                     else
+                       Zip::OutputStream
+                     end
       Relationship.initialize_ids_cache
-      Zip::OutputStream.open(output) do |zip|
+      zip_provider.open(output) do |zip|
         write_parts(zip)
       end
       true
@@ -153,8 +166,8 @@ module Axlsx
     private
 
     # Writes the package parts to a zip archive.
-    # @param [Zip::OutputStream] zip
-    # @return [Zip::OutputStream]
+    # @param [Zip::OutputStream, ZipCommand] zip
+    # @return [Zip::OutputStream, ZipCommand]
     def write_parts(zip)
       p = parts
       p.each do |part|

data/lib/axlsx/util/constants.rb

@@ -393,7 +393,8 @@ module Axlsx
   ISO_8601_REGEX = /\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z/.freeze
 
   # FLOAT recognition
-  FLOAT_REGEX = /\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\Z/.freeze
+  SAFE_FLOAT_REGEX = /\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]{1,2})?\Z/.freeze
+  MAYBE_FLOAT_REGEX = /\A[-+]?[0-9]*\.?[0-9]+[eE](?<exp>[-+]?[0-9]{3})\Z/.freeze
 
   # Numeric recognition
   NUMERIC_REGEX = /\A[+-]?\d+?\Z/.freeze

data/lib/axlsx/util/zip_command.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+require 'open3'
+require 'shellwords'
+
+module Axlsx
+
+  # The ZipCommand class supports zipping the Excel file contents using
+  # a binary zip program instead of RubyZip's `Zip::OutputStream`.
+  #
+  # The methods provided here mimic `Zip::OutputStream` so that `ZipCommand` can
+  # be used as a drop-in replacement. Note that method signatures are not
+  # identical to `Zip::OutputStream`, they are only sufficiently close so that
+  # `ZipCommand` and `Zip::OutputStream` can be interchangeably used within
+  # `caxlsx`.
+  class ZipCommand
+    # Raised when the zip command exits with a non-zero status.
+    class ZipError < StandardError; end
+
+    def initialize(zip_command)
+      @current_file = nil
+      @files = []
+      @zip_command = zip_command
+    end
+
+    # Create a temporary directory for writing files to.
+    #
+    # The directory and its contents are removed at the end of the block.
+    def open(output, &block)
+      Dir.mktmpdir do |dir|
+        @dir = dir
+        block.call(self)
+        write_file
+        zip_parts(output)
+      end
+    end
+
+    # Closes the current entry and opens a new for writing.
+    def put_next_entry(entry)
+      write_file
+      @current_file = "#{@dir}/#{entry.name}"
+      @files << entry.name
+      FileUtils.mkdir_p(File.dirname(@current_file))
+    end
+
+    # Write to a buffer that will be written to the current entry
+    def write(content)
+      @buffer << content
+    end
+    alias << write
+
+    private
+
+    def write_file
+      if @current_file
+        @buffer.rewind
+        File.open(@current_file, "wb") { |f| f.write @buffer.read }
+      end
+      @current_file = nil
+      @buffer = StringIO.new
+    end
+
+    def zip_parts(output)
+      output = Shellwords.shellescape(File.absolute_path(output))
+      inputs = Shellwords.shelljoin(@files)
+      escaped_dir = Shellwords.shellescape(@dir)
+      command = "cd #{escaped_dir} && #{@zip_command} #{output} #{inputs}"
+      stdout_and_stderr, status = Open3.capture2e(command)
+      if !status.success?
+        raise(ZipError.new(stdout_and_stderr))
+      end
+    end
+  end
+end

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "3.0.2"
+  VERSION = "3.0.3"
 end

data/lib/axlsx/workbook/worksheet/cell.rb

@@ -451,9 +451,11 @@ module Axlsx
         :time
       elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
         :boolean
-      elsif v.to_s =~ Axlsx::NUMERIC_REGEX
+      elsif v.to_s =~ Axlsx::NUMERIC_REGEX && v.respond_to?(:to_i)
         :integer
-      elsif v.to_s =~ Axlsx::FLOAT_REGEX
+      elsif v.to_s =~ Axlsx::SAFE_FLOAT_REGEX && v.respond_to?(:to_f)
+        :float
+      elsif (matchdata = v.to_s.match(MAYBE_FLOAT_REGEX)) && (Float::MIN_10_EXP..Float::MAX_10_EXP).cover?(matchdata[:exp].to_i) && v.respond_to?(:to_f)
         :float
       elsif v.to_s =~ Axlsx::ISO_8601_REGEX
         :iso_8601

data/test/drawing/tc_drawing.rb

@@ -23,7 +23,7 @@ class TestDrawing < Test::Unit::TestCase
   end
 
   def test_add_image
-    src = File.dirname(__FILE__) + "/../../examples/image1.jpeg"
+    src = File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
     image = @ws.add_image(:image_src => src, :start_at=>[0,0], :width=>600, :height=>400)
     assert(@ws.drawing.anchors.last.is_a?(Axlsx::OneCellAnchor))
     assert(image.is_a?(Axlsx::Pic))
@@ -31,7 +31,7 @@ class TestDrawing < Test::Unit::TestCase
     assert_equal(400, image.height)
   end
   def test_add_two_cell_anchor_image
-     src = File.dirname(__FILE__) + "/../../examples/image1.jpeg"
+     src = File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
      image = @ws.add_image(:image_src => src, :start_at=>[0,0], :end_at => [15,0])
     assert(@ws.drawing.anchors.last.is_a?(Axlsx::TwoCellAnchor))
     assert(image.is_a?(Axlsx::Pic))

data/test/drawing/tc_hyperlink.rb

@@ -5,7 +5,7 @@ class TestHyperlink < Test::Unit::TestCase
   def setup
     @p = Axlsx::Package.new
     ws = @p.workbook.add_worksheet
-    @test_img =  File.dirname(__FILE__) + "/../../examples/image1.jpeg"
+    @test_img =  File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
     @image = ws.add_image :image_src => @test_img, :hyperlink => "http://axlsx.blogspot.com"
     @hyperlink = @image.hyperlink
   end

data/test/drawing/tc_one_cell_anchor.rb

@@ -5,7 +5,7 @@ class TestOneCellAnchor < Test::Unit::TestCase
   def setup
     @p = Axlsx::Package.new
     @ws = @p.workbook.add_worksheet
-    @test_img =  File.dirname(__FILE__) + "/../../examples/image1.jpeg"
+    @test_img =  File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
     @image = @ws.add_image :image_src => @test_img
     @anchor = @image.anchor
   end

data/test/drawing/tc_pic.rb

@@ -5,10 +5,10 @@ class TestPic < Test::Unit::TestCase
   def setup
     @p = Axlsx::Package.new
     ws = @p.workbook.add_worksheet
-    @test_img = @test_img_jpg =  File.dirname(__FILE__) + "/../../examples/image1.jpeg"
-    @test_img_png =  File.dirname(__FILE__) + "/../../examples/image1.png"
-    @test_img_gif =  File.dirname(__FILE__) + "/../../examples/image1.gif"
-    @test_img_fake =  File.dirname(__FILE__) + "/../../examples/image1_fake.jpg"
+    @test_img = @test_img_jpg =  File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
+    @test_img_png =  File.dirname(__FILE__) + "/../fixtures/image1.png"
+    @test_img_gif =  File.dirname(__FILE__) + "/../fixtures/image1.gif"
+    @test_img_fake =  File.dirname(__FILE__) + "/../fixtures/image1_fake.jpg"
     @image = ws.add_image :image_src => @test_img, :hyperlink => 'https://github.com/randym', :tooltip => "What's up doc?", :opacity => 5
   end
 

data/test/drawing/tc_pie_series.rb

@@ -20,12 +20,13 @@ class TestPieSeries < Test::Unit::TestCase
     assert_raise(ArgumentError, "require valid explosion") { @series.explosion = :lots }
     assert_nothing_raised("allow valid explosion") { @series.explosion = 20 }
     assert(@series.explosion == 20)
+    # issue 58 - explosion caused to_xml_string to fail - now tested
+    assert_nothing_raised("allow to_xml_string") { @series.to_xml_string }
   end
 
   def test_to_xml_string
     doc = Nokogiri::XML(@series.to_xml_string)
     assert(doc.xpath("//srgbClr[@val='#{@series.colors[0]}']"))
-
   end
   #TODO test unique serialization parts
 

data/test/tc_package.rb

@@ -65,7 +65,7 @@ class TestPackage < Test::Unit::TestCase
     end
 
     @fname = 'axlsx_test_serialization.xlsx'
-    img = File.expand_path('../../examples/image1.jpeg', __FILE__)
+    img = File.expand_path('../fixtures/image1.jpeg', __FILE__)
     ws.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
       image.width=720
       image.height=666
@@ -73,12 +73,12 @@ class TestPackage < Test::Unit::TestCase
       image.start_at 5, 5
       image.end_at 10, 10
     end
-    ws.add_image :image_src => File.expand_path('../../examples/image1.gif', __FILE__) do |image|
+    ws.add_image :image_src => File.expand_path('../fixtures/image1.gif', __FILE__) do |image|
       image.start_at 0, 20
       image.width=360
       image.height=333
     end
-    ws.add_image :image_src => File.expand_path('../../examples/image1.png', __FILE__) do |image|
+    ws.add_image :image_src => File.expand_path('../fixtures/image1.png', __FILE__) do |image|
       image.start_at 9, 20
       image.width = 180
       image.height = 167
@@ -127,18 +127,35 @@ class TestPackage < Test::Unit::TestCase
   end
 
   def test_serialization
-    assert_nothing_raised do
-      begin
-        @package.serialize(@fname)
-        zf = Zip::File.open(@fname)
-        @package.send(:parts).each{ |part| zf.get_entry(part[:entry]) }
-        File.delete(@fname)
-      rescue Errno::EACCES
-        puts "WARNING:: test_serialization requires write access."
-      end
+    @package.serialize(@fname)
+    assert_zip_file_matches_package(@fname, @package)
+    File.delete(@fname)
+  end
+
+  def test_serialization_with_zip_command
+    @package.serialize(@fname, false, zip_command: "zip")
+    assert_zip_file_matches_package(@fname, @package)
+    File.delete(@fname)
+  end
+
+  def test_serialization_with_zip_command_and_absolute_path
+    fname = "#{Dir.tmpdir}/#{@fname}"
+    @package.serialize(fname, false, zip_command: "zip")
+    assert_zip_file_matches_package(fname, @package)
+    File.delete(fname)
+  end
+
+  def test_serialization_with_invalid_zip_command
+    assert_raises Axlsx::ZipCommand::ZipError do
+      @package.serialize(@fname, false, zip_command: "invalid_zip")
     end
   end
 
+  def assert_zip_file_matches_package(fname, package)
+    zf = Zip::File.open(fname)
+    package.send(:parts).each{ |part| zf.get_entry(part[:entry]) }
+  end
+
   # See comment for Package#zip_entry_for_part
   def test_serialization_creates_identical_files_at_any_time_if_created_at_is_set
     @package.core.created = Time.now

data/test/util/tc_mime_type_utils.rb

@@ -1,7 +1,7 @@
 require 'tc_helper.rb'
 class TestMimeTypeUtils < Test::Unit::TestCase
   def setup
-    @test_img = File.dirname(__FILE__) + "/../../examples/image1.jpeg"
+    @test_img = File.dirname(__FILE__) + "/../fixtures/image1.jpeg"
   end
 
   def teardown

data/test/workbook/worksheet/tc_cell.rb

@@ -100,6 +100,12 @@ class TestCell < Test::Unit::TestCase
 
   def test_cell_type_from_value
     assert_equal(@c.send(:cell_type_from_value, 1.0), :float)
+    assert_equal(@c.send(:cell_type_from_value, "1e1"), :float)
+    assert_equal(@c.send(:cell_type_from_value, "1e#{Float::MAX_10_EXP}"), :float)
+    assert_equal(@c.send(:cell_type_from_value, "1e#{Float::MAX_10_EXP + 1}"), :string)
+    assert_equal(@c.send(:cell_type_from_value, "1e-1"), :float)
+    assert_equal(@c.send(:cell_type_from_value, "1e#{Float::MIN_10_EXP}"), :float)
+    assert_equal(@c.send(:cell_type_from_value, "1e#{Float::MIN_10_EXP - 1}"), :string)
     assert_equal(@c.send(:cell_type_from_value, 1), :integer)
     assert_equal(@c.send(:cell_type_from_value, Date.today), :date)
     assert_equal(@c.send(:cell_type_from_value, Time.now), :time)
@@ -114,6 +120,31 @@ class TestCell < Test::Unit::TestCase
     assert_equal(:iso_8601, @c.send(:cell_type_from_value, '2008-08-30T01:45:36.123+09:00'))
   end
 
+  def test_cell_type_from_value_looks_like_number_but_is_not
+    mimic_number = Class.new do
+      def initialize(to_s_value)
+        @to_s_value = to_s_value
+      end
+
+      def to_s
+        @to_s_value
+      end
+    end
+
+    number_strings = [
+      '1',
+      '1234567890',
+      '1.0',
+      '1e1',
+      '0',
+      "1e#{Float::MIN_10_EXP}"
+    ]
+
+    number_strings.each do |number_string|
+      assert_equal(@c.send(:cell_type_from_value, mimic_number.new(number_string)), :string)
+    end
+  end
+
   def test_cast_value
     @c.type = :string
     assert_equal(@c.send(:cast_value, 1.0), "1.0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Randy Morgan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -105,20 +105,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.2
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -151,33 +145,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/2010_comments.rb
-- examples/anchor_swapping.rb
-- examples/auto_filter.rb
-- examples/basic_charts.rb
-- examples/chart_colors.rb
-- examples/colored_links.rb
-- examples/conditional_formatting/example_conditional_formatting.rb
-- examples/conditional_formatting/getting_barred.rb
-- examples/conditional_formatting/hitting_the_high_notes.rb
-- examples/conditional_formatting/scaled_colors.rb
-- examples/conditional_formatting/stop_and_go.rb
-- examples/data_validation.rb
-- examples/example.rb
-- examples/extractive.rb
-- examples/image1.jpeg
-- examples/ios_preview.rb
-- examples/merge_cells.rb
-- examples/no_grid_with_borders.rb
-- examples/page_setup.rb
-- examples/pivot_table.rb
-- examples/pivot_test.rb
-- examples/sheet_protection.rb
-- examples/skydrive/real_example.rb
-- examples/split.rb
-- examples/styles.rb
-- examples/underline.rb
-- examples/wrap_text.rb
+- examples/assets/image1.jpeg
+- examples/generate.rb
 - lib/axlsx.rb
 - lib/axlsx/content_type/abstract_content_type.rb
 - lib/axlsx/content_type/content_type.rb
@@ -256,6 +225,7 @@ files:
 - lib/axlsx/util/simple_typed_list.rb
 - lib/axlsx/util/storage.rb
 - lib/axlsx/util/validators.rb
+- lib/axlsx/util/zip_command.rb
 - lib/axlsx/version.rb
 - lib/axlsx/workbook/defined_name.rb
 - lib/axlsx/workbook/defined_names.rb
@@ -403,6 +373,11 @@ files:
 - test/drawing/tc_view_3D.rb
 - test/drawing/tc_vml_drawing.rb
 - test/drawing/tc_vml_shape.rb
+- test/fixtures/image1.gif
+- test/fixtures/image1.jpeg
+- test/fixtures/image1.jpg
+- test/fixtures/image1.png
+- test/fixtures/image1_fake.jpg
 - test/profile.rb
 - test/rels/tc_relationship.rb
 - test/rels/tc_relationships.rb
@@ -492,8 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Excel OOXML (xlsx) with charts, styles, images and autowidth columns.
@@ -547,6 +521,11 @@ test_files:
 - test/drawing/tc_view_3D.rb
 - test/drawing/tc_vml_drawing.rb
 - test/drawing/tc_vml_shape.rb
+- test/fixtures/image1.gif
+- test/fixtures/image1.jpeg
+- test/fixtures/image1.jpg
+- test/fixtures/image1.png
+- test/fixtures/image1_fake.jpg
 - test/profile.rb
 - test/rels/tc_relationship.rb
 - test/rels/tc_relationships.rb