caxlsx 3.0.0 → 3.1.0

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.0"
+  VERSION = "3.1.0"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -197,15 +197,6 @@ require 'axlsx/workbook/worksheet/selection.rb'
       @worksheets[index] if index
     end
 
-    # lets come back to this later when we are ready for parsing.
-    #def self.parse entry
-    #  io = entry.get_input_stream
-    #  w = self.new
-    #  w.parser_xml = Nokogiri::XML(io.read)
-    #  w.parse_string :date1904, "//xmlns:workbookPr/@date1904"
-    #  w
-    #end
-
     # Creates a new Workbook
     # The recomended way to work with workbooks is via Package#workbook
     # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.

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

@@ -12,7 +12,7 @@ module Axlsx
 
     # @param [Row] row The row this cell belongs to.
     # @param [Any] value The value associated with this cell.
-    # @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the vlue provided.
+    # @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the value provided.
     # @option options [Integer] style The index of the cellXfs item to be applied to this cell. If not specified, the default style (0) will be applied.
     # @option options [String] font_name
     # @option options [Integer] charset
@@ -30,6 +30,10 @@ module Axlsx
     # @option options [String] color an 8 letter rgb specification
     # @option options [Number] formula_value The value to cache for a formula cell.
     # @option options [Symbol] scheme must be one of :none, major, :minor
+    # @option options [Boolean] escape_formulas - Whether to treat a value starting with an equal
+    #    sign as formula (default) or as simple string.
+    #    Allowing user generated data to be interpreted as formulas can be dangerous
+    #   (see https://www.owasp.org/index.php/CSV_Injection for details).
     def initialize(row, value = nil, options = {})
       @row = row
       # Do not use instance vars if not needed to use less RAM
@@ -38,6 +42,8 @@ module Axlsx
       type = options.delete(:type) || cell_type_from_value(value)
       self.type = type unless type == :string
 
+      escape_formulas = options[:escape_formulas]
+      self.escape_formulas = escape_formulas unless escape_formulas.nil?
 
       val = options.delete(:style)
       self.style = val unless val.nil? || val == 0
@@ -102,6 +108,18 @@ module Axlsx
       self.value = @value unless !defined?(@value) || @value.nil?
     end
 
+    # Whether to treat a value starting with an equal
+    #    sign as formula (default) or as simple string.
+    #    Allowing user generated data to be interpreted as formulas can be dangerous
+    #   (see https://www.owasp.org/index.php/CSV_Injection for details).
+    # @return [Boolean]
+    attr_reader :escape_formulas
+
+    def escape_formulas=(v)
+      Axlsx.validate_boolean(v)
+      @escape_formulas = v
+    end
+
     # The value of this cell.
     # @return [String, Integer, Float, Time, Boolean] casted value based on cell's type attribute.
     attr_reader :value
@@ -324,6 +342,8 @@ module Axlsx
     end
 
     def is_formula?
+      return false if escape_formulas
+
       type == :string && @value.to_s.start_with?(?=)
     end
 
@@ -353,6 +373,7 @@ module Axlsx
     # @return [Float]
     def autowidth
       return if is_formula? || value.nil?
+
       if contains_rich_text?
         string_width('', font_size) + value.autowidth
       elsif styles.cellXfs[style].alignment && styles.cellXfs[style].alignment.wrap_text
@@ -389,7 +410,7 @@ module Axlsx
     #  - scaling is not linear as font sizes increase
     def string_width(string, font_size)
       font_scale = font_size / 10.0
-      (string.to_s.count(Worksheet::THIN_CHARS) + 3.0) * font_scale
+      (string.to_s.size + 3) * font_scale
     end
 
     # we scale the font size if bold style is applied to either the style font or
@@ -430,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
@@ -452,7 +475,11 @@ module Axlsx
       case type
       when :date
         self.style = STYLE_DATE if self.style == 0
-        v
+        if !v.is_a?(Date) && v.respond_to?(:to_date)
+          v.to_date
+        else
+          v
+        end
       when :time
         self.style = STYLE_DATE if self.style == 0
         if !v.is_a?(Time) && v.respond_to?(:to_time)

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

@@ -4,6 +4,10 @@ module Axlsx
   # The Col class defines column attributes for columns in sheets.
   class Col
 
+    # Maximum column width limit in MS Excel is 255 characters
+    # https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
+    MAX_WIDTH = 255
+
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     # Create a new Col objects
@@ -111,10 +115,10 @@ module Axlsx
       # TODO!!!
       #Axlsx.validate_unsigned_numeric(v) unless v == nil
       @custom_width = @best_fit = v != nil
-      @width = v
+      @width = v.nil? ? v : [v, MAX_WIDTH].min
     end
 
-    # updates the width for this col based on the cells autowidth and 
+    # updates the width for this col based on the cells autowidth and
     # an optionally specified fixed width
     # @param [Cell] cell The cell to use in updating this col's width
     # @param [Integer] fixed_width If this is specified the width is set
@@ -127,8 +131,8 @@ module Axlsx
       elsif use_autowidth
        cell_width = cell.autowidth
        self.width = cell_width unless (width || 0) > (cell_width || 0)
-      end 
-    end 
+      end
+    end
 
     # Serialize this columns data to an xml string
     # @param [String] str

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

@@ -171,7 +171,7 @@ module Axlsx
     def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
 
     # @see formula2
-    def formula2=(v); Axlsx::validate_string(v); @formula2 = v end 
+    def formula2=(v); Axlsx::validate_string(v); @formula2 = v end
 
     # @see allowBlank
     def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
@@ -216,8 +216,8 @@ module Axlsx
       valid_attributes = get_valid_attributes
 
       str << '<dataValidation '
-      str << instance_values.map do |key, value| 
-        '' << key << '="' << Axlsx.booleanize(value).to_s << '"' if (valid_attributes.include?(key.to_sym) && !CHILD_ELEMENTS.include?(key.to_sym)) 
+      str << instance_values.map do |key, value|
+        '' << key << '="' << Axlsx.booleanize(value).to_s << '"' if (valid_attributes.include?(key.to_sym) && !CHILD_ELEMENTS.include?(key.to_sym))
       end.join(' ')
       str << '>'
       str << ('<formula1>' << self.formula1 << '</formula1>') if @formula1 and valid_attributes.include?(:formula1)
@@ -229,7 +229,7 @@ module Axlsx
     def get_valid_attributes
       attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
 
-      if [:whole, :decimal, :data, :time, :textLength].include?(@type)
+      if [:whole, :decimal, :data, :time, :date, :textLength].include?(@type)
         attributes << [:operator, :formula1]
         attributes << [:formula2] if [:between, :notBetween].include?(@operator)
       elsif @type == :list

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

@@ -111,8 +111,12 @@ module Axlsx
         if data_field.is_a? String
           data_field = {:ref => data_field}
         end
-        data_field.values.each do |value|
-          DataTypeValidator.validate "#{self.class}.data[]", [String], value
+        data_field.each do |key, value|
+          if key == :num_fmt
+            DataTypeValidator.validate "#{self.class}.data[]", [Integer], value
+          else
+            DataTypeValidator.validate "#{self.class}.data[]", [String], value
+          end
         end
         @data << data_field
       end
@@ -212,6 +216,7 @@ module Axlsx
         data.each do |datum_value|
           # The correct name prefix in ["Sum","Average", etc...]
           str << "<dataField name='#{(datum_value[:subtotal]||'')} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
+          str << " numFmtId='#{datum_value[:num_fmt]}'" if datum_value[:num_fmt]
           str << " subtotal='#{datum_value[:subtotal]}' " if datum_value[:subtotal]
           str << "/>"
         end

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

@@ -53,7 +53,7 @@ module Axlsx
       str <<   '</cacheSource>'
       str << (  '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">')
       pivot_table.header_cells.each do |cell|
-        str << (  '<cacheField name="' << cell.value << '" numFmtId="0">')
+        str << (  '<cacheField name="' << cell.clean_value << '" numFmtId="0">')
         str <<     '<sharedItems count="0">'
         str <<     '</sharedItems>'
         str <<   '</cacheField>'

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

@@ -215,7 +215,7 @@ module Axlsx
     #  - scaling is not linear as font sizes increase
     def string_width(string, font_size)
       font_scale = font_size / 10.0
-      string.count(Worksheet::THIN_CHARS) * font_scale
+      string.size * font_scale
     end
 
     # we scale the font size if bold style is applied to either the style font or

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

@@ -25,11 +25,12 @@ module Axlsx
     # @option options [Array, Symbol] types
     # @option options [Array, Integer] style
     # @option options [Float] height the row's height (in points)
+    # @option options [Integer] offset - add empty columns before values
     # @see Row#array_to_cells
     # @see Cell
     def initialize(worksheet, values=[], options={})
       self.worksheet = worksheet
-      super(Cell, nil, values.size)
+      super(Cell, nil, values.size + options[:offset].to_i)
       self.height = options.delete(:height)
       worksheet.rows << self
       array_to_cells(values, options)
@@ -147,13 +148,15 @@ module Axlsx
     # @option options [Array, Integer] style
     def array_to_cells(values, options={})
       DataTypeValidator.validate :array_to_cells, Array, values
-      types, style, formula_values = options.delete(:types), options.delete(:style), options.delete(:formula_values)
+      types, style, formula_values, escape_formulas, offset = options.delete(:types), options.delete(:style), options.delete(:formula_values), options.delete(:escape_formulas), options.delete(:offset)
+      offset.to_i.times { |index| self[index] = Cell.new(self) } if offset
       values.each_with_index do |value, index|
         options[:style] = style.is_a?(Array) ? style[index] : style if style
         options[:type] = types.is_a?(Array) ? types[index] : types if types
+        options[:escape_formulas] = escape_formulas.is_a?(Array) ? escape_formulas[index] : escape_formulas if escape_formulas
         options[:formula_value] = formula_values[index] if formula_values.is_a?(Array)
 
-        self[index] = Cell.new(self, value, options)
+        self[index + offset.to_i] = Cell.new(self, value, options)
       end
     end
   end

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

@@ -80,7 +80,7 @@ module Axlsx
       str << ('<autoFilter ref="' << @ref << '"/>')
       str << ('<tableColumns count="' << header_cells.length.to_s << '">')
       header_cells.each_with_index do |cell,index|
-        str << ('<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>')
+        str << ('<tableColumn id ="' << (index+1).to_s << '" name="' << cell.clean_value << '"/>')
       end
       str << '</tableColumns>'
       table_style_info.to_xml_string(str)

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

@@ -5,9 +5,6 @@ module Axlsx
   class Worksheet
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
-    # definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count.
-    # This is used for autowidth calculations
-    THIN_CHARS = '^.acfijklrstxzFIJL()-'.freeze
 
     # Creates a new worksheet.
     # @note the recommended way to manage worksheets is Workbook#add_worksheet
@@ -390,6 +387,15 @@ module Axlsx
     # @example - use << alias
     #     ws << [3, 4, 5], :types => [nil, :float]
     #
+    # @example - specify whether a row should escape formulas or not
+    #     ws.add_row ['=IF(2+2=4,4,5)', 2, 3], :escape_formulas=>true
+    #
+    # @example - specify whether a certain cells in a row should escape formulas or not
+    #     ws.add_row ['=IF(2+2=4,4,5)', '=IF(13+13=4,4,5)'], :escape_formulas=>[true, false]
+    #
+    # @example - add a column offset when adding a row (inserts 'n' blank, unstyled columns before data)
+    #     ws.add_row ['I wish', 'for a fish', 'on my fish wish dish'], offset: 3
+    #
     # @see Worksheet#column_widths
     # @return [Row]
     # @option options [Array] values
@@ -397,6 +403,11 @@ module Axlsx
     # @option options [Array, Integer] style
     # @option options [Array] widths each member of the widths array will affect how auto_fit behavies.
     # @option options [Float] height the row's height (in points)
+    # @option options [Integer] offset - add empty columns before values
+    # @option options [Array, Boolean] escape_formulas - Whether to treat a value starting with an equal
+    #    sign as formula (default) or as simple string.
+    #    Allowing user generated data to be interpreted as formulas can be dangerous
+    #   (see https://www.owasp.org/index.php/CSV_Injection for details).
     def add_row(values=[], options={})
       row = Row.new(self, values, options)
       update_column_info row, options.delete(:widths)
@@ -656,7 +667,9 @@ module Axlsx
 
     def validate_sheet_name(name)
       DataTypeValidator.validate :worksheet_name, String, name
-      raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if name.size > 31
+      # ignore first character (BOM) after encoding to utf16 because Excel does so, too.
+      character_length = name.encode("utf-16")[1..-1].encode("utf-16").bytesize / 2
+      raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if character_length > 31
       raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if '[]*/\?:'.chars.any? { |char| name.include? char }
       name = Axlsx::coder.encode(name)
       sheet_names = @workbook.worksheets.reject { |s| s == self }.map { |s| s.name }

data/lib/caxlsx.rb

@@ -0,0 +1,2 @@
+# encoding: UTF-8
+require 'axlsx.rb'

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