caxlsx 3.0.0 → 3.1.0

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

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 require 'htmlentities'
 require 'axlsx/version.rb'
-require 'mimemagic'
+require 'marcel'
 
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
@@ -9,9 +9,8 @@ require 'axlsx/util/validators.rb'
 require 'axlsx/util/accessors.rb'
 require 'axlsx/util/serialized_attributes'
 require 'axlsx/util/options_parser'
-# to be included with parsable intitites.
-#require 'axlsx/util/parser.rb'
 require 'axlsx/util/mime_type_utils'
+require 'axlsx/util/zip_command'
 
 require 'axlsx/stylesheet/styles.rb'
 

data/lib/axlsx/drawing/bar_chart.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Axlsx
 
-  # The BarChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
+  # The BarChart is a two dimentional barchart that you can add to your worksheet.
   # @see Worksheet#add_chart
   # @see Chart#add_series
   # @see Package#serialize
@@ -49,7 +49,7 @@ module Axlsx
       @grouping ||= :clustered
     end
 
-    # The shabe of the bars or columns
+    # The shape of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     # @return [Symbol]
     def shape
@@ -106,7 +106,7 @@ module Axlsx
     end
     alias :gapDepth= :gap_depth=
 
-    # The shabe of the bars or columns
+    # The shape of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     def shape=(v)
       RestrictionValidator.validate "BarChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v

data/lib/axlsx/drawing/bar_series.rb

@@ -15,9 +15,8 @@ module Axlsx
     # @return [Array, SimpleTypedList]
     attr_reader :labels
 
-    # The shabe of the bars or columns
-    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    # @return [Symbol]
+    # The shape of the bars or columns
+    # @return [Symbol] must be one of [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     attr_reader :shape
 
     # An array of rgb colors to apply to your bar chart.
@@ -41,8 +40,7 @@ module Axlsx
     # @see colors
     def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
 
-    # The shabe of the bars or columns
-    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
+    # @see shape
     def shape=(v)
       RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v

data/lib/axlsx/drawing/d_lbls.rb

@@ -55,7 +55,7 @@ module Axlsx
 
     # @see DLbls#d_lbl_pos
     # Assigns the label postion for this data labels on this chart.
-    # Allowed positions are :bestFilt, :b, :ctr, :inBase, :inEnd, :l,
+    # Allowed positions are :bestFit, :b, :ctr, :inBase, :inEnd, :l,
     # :outEnd, :r and :t
     # The default is :bestFit
     # @param [Symbol] label_position the postion you want to use.

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/drawing/series_title.rb

@@ -7,13 +7,15 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
+      clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
+
       str << '<c:tx>'
       str << '<c:strRef>'
       str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
       str << '<c:strCache>'
       str << '<c:ptCount val="1"/>'
       str << '<c:pt idx="0">'
-      str << ('<c:v>' << @text << '</c:v>')
+      str << ('<c:v>' << clean_value << '</c:v>')
       str << '</c:pt>'
       str << '</c:strCache>'
       str << '</c:strRef>'

data/lib/axlsx/drawing/title.rb

@@ -62,6 +62,7 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<c:title>'
       unless @text.empty?
+        clean_value = Axlsx::trust_input ? @text.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@text.to_s))
         str << '<c:tx>'
         if @cell.is_a?(Cell)
           str << '<c:strRef>'
@@ -69,7 +70,7 @@ module Axlsx
           str << '<c:strCache>'
           str << '<c:ptCount val="1"/>'
           str << '<c:pt idx="0">'
-          str << ('<c:v>' << @text << '</c:v>')
+          str << ('<c:v>' << clean_value << '</c:v>')
           str << '</c:pt>'
           str << '</c:strCache>'
           str << '</c:strRef>'
@@ -80,7 +81,7 @@ module Axlsx
             str << '<a:p>'
               str << '<a:r>'
                 str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
-                str << ('<a:t>' << @text.to_s << '</a:t>')
+                str << ('<a:t>' << clean_value << '</a:t>')
               str << '</a:r>'
             str << '</a:p>'
           str << '</c:rich>'

data/lib/axlsx/package.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Axlsx
   # Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid
-  # xlsx document including valdation and serialization.
+  # xlsx document including validation and serialization.
   class Package
     include Axlsx::OptionsParser
 
@@ -68,23 +68,20 @@ module Axlsx
       @workbook
     end
 
-    #def self.parse(input, confirm_valid = false)
-    #  p = Package.new
-    #  z = Zip::File.open(input)
-    #  p.workbook = Workbook.parse z.get_entry(WORKBOOK_PN)
-    #  p
-    #end
-
     # @see workbook
     def workbook=(workbook) DataTypeValidator.validate :Package_workbook, Workbook, workbook; @workbook = workbook; end
 
     # Serialize your workbook to disk as an xlsx document.
     #
     # @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 [Hash] options
+    # @option options [Boolean] :confirm_valid Validate the package prior to serialization.
+    # @option options [String] :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.
+    #   options[:confirm_valid] should be used in the rare case that you cannot open the serialized file.
     # @see Package#validate
     # @example
     #   # This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
@@ -95,16 +92,29 @@ 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", zip_command: "zip", confirm_valid: false)
+    #   p.serialize("example.xlsx", zip_command: "/path/to/zip")
+    #   p.serialize("example.xlsx", 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, options = {}, secondary_options = nil)
+      confirm_valid, zip_command = parse_serialize_options(options, secondary_options)
       return false unless !confirm_valid || self.validate.empty?
-      Relationship.clear_cached_instances
-      Zip::OutputStream.open(output) do |zip|
+      zip_provider = if zip_command
+                       ZipCommand.new(zip_command)
+                     else
+                       Zip::OutputStream
+                     end
+      Relationship.initialize_ids_cache
+      zip_provider.open(output) do |zip|
         write_parts(zip)
       end
       true
+    ensure
+      Relationship.clear_ids_cache
     end
 
 
@@ -113,11 +123,13 @@ module Axlsx
     # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
     def to_stream(confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
-      Relationship.clear_cached_instances
+      Relationship.initialize_ids_cache
       zip = write_parts(Zip::OutputStream.new(StringIO.new, true))
       stream = zip.close_buffer
       stream.rewind
       stream
+    ensure
+      Relationship.clear_ids_cache
     end
 
     # Encrypt the package into a CFB using the password provided
@@ -135,7 +147,7 @@ module Axlsx
     #   dcterms and xml namespaces. Those remote schema are included in this gem, and the original files have been altered to
     #   refer to the local versions.
     #
-    #   If by chance you are able to creat a package that does not validate it indicates that the internal
+    #   If by chance you are able to create a package that does not validate it indicates that the internal
     #   validation is not robust enough and needs to be improved. Please report your errors to the gem author.
     # @see http://www.ecma-international.org/publications/standards/Ecma-376.htm
     # @example
@@ -156,8 +168,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|
@@ -167,7 +179,7 @@ module Axlsx
         end
         unless part[:path].nil?
           zip.put_next_entry(zip_entry_for_part(part))
-          zip.write IO.read(part[:path])
+          zip.write IO.read(part[:path], mode: "rb")
         end
       end
       zip
@@ -349,6 +361,28 @@ module Axlsx
       rels.lock
       rels
     end
+
+    # Parse the arguments of `#serialize`
+    # @return [Boolean, (String or nil)] Returns an array where the first value is
+    #   `confirm_valid` and the second is the `zip_command`.
+    # @private
+    def parse_serialize_options(options, secondary_options)
+      if secondary_options
+        warn "[DEPRECATION] Axlsx::Package#serialize with 3 arguments is deprecated. " +
+          "Use keyword args instead e.g., package.serialize(output, confirm_valid: false, zip_command: 'zip')"
+      end
+      if options.is_a?(Hash)
+        options.merge!(secondary_options || {})
+        invalid_keys = options.keys - [:confirm_valid, :zip_command]
+        if invalid_keys.any?
+          raise ArgumentError.new("Invalid keyword arguments: #{invalid_keys}")
+        end
+        [options.fetch(:confirm_valid, false), options.fetch(:zip_command, nil)]
+      else
+        warn "[DEPRECATION] Axlsx::Package#serialize with confirm_valid as a boolean is deprecated. " +
+          "Use keyword args instead e.g., package.serialize(output, confirm_valid: false)"
+        parse_serialize_options((secondary_options || {}).merge(confirm_valid: options), nil)
+      end
+    end
   end
 end
-

data/lib/axlsx/rels/relationship.rb

@@ -5,32 +5,40 @@ module Axlsx
   class Relationship
     
     class << self
-      # Keeps track of all instances of this class.
+      # Keeps track of relationship ids in use.
       # @return [Array]
-      def instances
-        @instances ||= []
+      def ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] ||= {}
       end
-      
-      # Clear cached instances.
+
+      # Initialize cached ids.
       # 
       # This should be called before serializing a package (see {Package#serialize} and
       # {Package#to_stream}) to make sure that serialization is idempotent (i.e. 
       # Relationship instances are generated with the same IDs everytime the package
       # is serialized).
+      def initialize_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = {}
+      end
+      
+      # Clear cached ids.
       # 
-      # Also, calling this avoids memory leaks (cached instances lingering around 
+      # This should be called after serializing a package (see {Package#serialize} and
+      # {Package#to_stream}) to free the memory allocated for cache.
+      # 
+      # Also, calling this avoids memory leaks (cached ids lingering around 
       # forever). 
-      def clear_cached_instances
-        @instances = []
+      def clear_ids_cache
+        Thread.current[:axlsx_relationship_ids_cache] = nil
       end
       
       # Generate and return a unique id (eg. `rId123`) Used for setting {#Id}. 
       #
-      # The generated id depends on the number of cached instances, so using
-      # {clear_cached_instances} will automatically reset the generated ids, too.
+      # The generated id depends on the number of previously cached ids, so using
+      # {clear_ids_cache} will automatically reset the generated ids, too.
       # @return [String]
       def next_free_id
-        "rId#{@instances.size + 1}"
+        "rId#{ids_cache.size + 1}"
       end
     end
 
@@ -80,12 +88,7 @@ module Axlsx
       self.Target=target
       self.Type=type
       self.TargetMode = options[:target_mode] if options[:target_mode]
-      @Id = if (existing = self.class.instances.find{ |i| should_use_same_id_as?(i) })
-        existing.Id
-      else
-        self.class.next_free_id
-      end
-      self.class.instances << self
+      @Id = (self.class.ids_cache[ids_cache_key] ||= self.class.next_free_id)
     end
 
     # @see Target
@@ -106,7 +109,7 @@ module Axlsx
       str << '/>'
     end
     
-    # Whether this relationship should use the same id as `other`.
+    # A key that determines whether this relationship should use already generated id.
     #
     # Instances designating the same relationship need to use the same id. We can not simply
     # compare the {#Target} attribute, though: `foo/bar.xml`, `../foo/bar.xml`, 
@@ -116,13 +119,11 @@ module Axlsx
     # then {#Target} will be an absolute URL and thus can safely be compared).
     #
     # @todo Implement comparison of {#Target} based on normalized path names.
-    # @param other [Relationship]
-    def should_use_same_id_as?(other)
-      result = self.source_obj == other.source_obj && self.Type == other.Type && self.TargetMode == other.TargetMode
-      if self.TargetMode == :External
-        result &&= self.Target == other.Target
-      end
-      result
+    # @return [Array]
+    def ids_cache_key
+      key = [source_obj, self.Type, self.TargetMode]
+      key << self.Target if self.TargetMode == :External
+      key
     end
     
   end

data/lib/axlsx/stylesheet/font.rb

@@ -76,7 +76,10 @@ module Axlsx
     attr_reader :i
 
     # Indicates if the font should be rendered underlined
-    # @return [Boolean]
+    # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting, true, false
+    # @return [String]
+    # @note
+    #  true or false is for backwards compatibility and is reassigned to :single or :none respectively
     attr_reader :u
 
     # Indicates if the font should be rendered with a strikthrough
@@ -118,7 +121,12 @@ module Axlsx
     # @see i
     def i=(v) Axlsx::validate_boolean v; @i = v end
     # @see u
-    def u=(v) Axlsx::validate_boolean v; @u = v end
+    def u=(v)
+      v = :single if (v == true || v == 1 || v == :true || v == 'true')
+      v = :none if (v == false || v == 0 || v == :false || v == 'false')
+      Axlsx::validate_cell_u v
+      @u = v
+    end
     # @see strike
     def strike=(v) Axlsx::validate_boolean v; @strike = v end
     # @see outline

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/mime_type_utils.rb

@@ -5,7 +5,7 @@ module Axlsx
     # @param [String] v File path
     # @return [String] File mime type
     def self.get_mime_type(v)
-      MimeMagic.by_magic(File.open(v)).to_s
+      Marcel::MimeType.for(Pathname.new(v))
     end
   end
 end

data/lib/axlsx/util/validators.rb

@@ -92,7 +92,7 @@ module Axlsx
 
   # Requires that the value is a Integer or Float and is greater or equal to 0
   # @param [Any] v The value validated
-  # @raise [ArgumentError] raised if the value is not a Fixnun, Integer, Float value greater or equal to 0
+  # @raise [ArgumentError] raised if the value is not a Integer, Float value greater or equal to 0
   # @return [Boolean] true if the data is valid
   def self.validate_unsigned_numeric(v)
     DataTypeValidator.validate(:unsigned_numeric, Numeric, v, UINT_VALIDATOR)
@@ -269,7 +269,7 @@ module Axlsx
   # valid types must be one of custom, data, decimal, list, none, textLength, time, whole
   # @param [Any] v The value validated
   def self.validate_data_validation_type(v)
-    RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
+    RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :date, :time, :whole], v
   end
 
   # Requires that the value is a valid sheet view type.