axlsx 1.0.18 → 1.1.0

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Axlsx
   # The GradientStop object represents a color point in a gradient.
-  # @see Open Office XML Part 1 §18.8.24  
+  # @see Open Office XML Part 1 §18.8.24
   class GradientStop
     # The color for this gradient stop
     # @return [Color]
@@ -23,11 +23,15 @@ module Axlsx
     # @see color
     def color=(v) DataTypeValidator.validate "GradientStop.color", Color, v; @color=v end
     # @see position
-    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |arg| arg >= 0 && arg <= 1}; @position = v end    
+    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |arg| arg >= 0 && arg <= 1}; @position = v end
 
-    # Serializes the gradientStop
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml) xml.stop(:position => self.position) {self.color.to_xml(xml)} end
+    def to_xml_string(str = '')
+      str << '<stop position="' << position.to_s << '">'
+      self.color.to_xml_string(str)
+      str << '</stop>'
+    end
   end
 end

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -1,11 +1,11 @@
 # encoding: UTF-8
 module Axlsx
-  # A NumFmt object defines an identifier and formatting code for data in cells. 
+  # A NumFmt object defines an identifier and formatting code for data in cells.
   # @note The recommended way to manage styles is Styles#add_style
   class NumFmt
     # @return [Integer] An unsinged integer referencing a standard or custom number format.
     # @note
-    #  These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and NUM_FRM_YYYYMMDDHHMMSS. 
+    #  These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and NUM_FRM_YYYYMMDDHHMMSS.
     #   1 0
     #   2 0.00
     #   3 #,##0
@@ -40,7 +40,7 @@ module Axlsx
     # @see Axlsx
     attr_reader :numFmtId
 
-    # @return [String] The formatting to use for this number format. 
+    # @return [String] The formatting to use for this number format.
     # @see http://support.microsoft.com/kb/264372
     attr_reader :formatCode
     def initialize(options={})
@@ -56,9 +56,15 @@ module Axlsx
     # @see formatCode
     def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
 
-    # Creates a numFmt element applying the instance values of this object as attributes.
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    def to_xml(xml) xml.numFmt(self.instance_values) end    
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<numFmt '
+      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
+    end
 
   end
 end

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -7,15 +7,15 @@ module Axlsx
 
     # The color to use for the the background in solid fills.
     # @return [Color]
-    attr_reader :fgColor 
+    attr_reader :fgColor
 
     # The color to use for the background of the fill when the type is not solid.
     # @return [Color]
     attr_reader :bgColor
 
     # The pattern type to use
-    # @note 
-    #  patternType must be one of 
+    # @note
+    #  patternType must be one of
     #   :none
     #   :solid
     #   :mediumGray
@@ -53,15 +53,30 @@ module Axlsx
     # @see bgColor
     def bgColor=(v) DataTypeValidator.validate "PatternFill.bgColor", Color, v; @bgColor=v end
     # @see patternType
-    def patternType=(v) Axlsx::validate_pattern_type v; @patternType = v end    
+    def patternType=(v) Axlsx::validate_pattern_type v; @patternType = v end
 
-    # Serializes the pattern fill
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml) 
-      xml.patternFill(:patternType => self.patternType) { 
-        self.instance_values.reject { |k,v| k.to_sym == :patternType }.each { |k,v| xml.send(k, v.instance_values) }    
-      }
+    def to_xml_string(str = '')
+      str << '<patternFill patternType="' << patternType.to_s << '">'
+      if fgColor.is_a?(Color)
+        str << "<fgColor "
+        fgColor.instance_values.each do |key, value|
+          str << key.to_s << '="' << value.to_s << '" '
+        end
+        str << "/>"
+      end
+
+      if bgColor.is_a?(Color)
+        str << "<bgColor "
+        bgColor.instance_values.each do |key, value|
+          str << key.to_s << '="' << value.to_s << '" '
+        end
+        str << "/>"
+      end
+      str << '</patternFill>'
     end
+
   end
 end

data/lib/axlsx/stylesheet/styles.rb

@@ -120,7 +120,7 @@ module Axlsx
     end
 
     # Drastically simplifies style creation and management.
-    # @return [Integer] 
+    # @return [Integer]
     # @option options [String] fg_color The text color
     # @option options [Integer] sz The text size
     # @option options [Boolean] b Indicates if the text should be bold
@@ -133,13 +133,13 @@ module Axlsx
     # @option options [String] font_name The name of the font to use
     # @option options [Integer] num_fmt The number format to apply
     # @option options [String] format_code The formatting to apply. If this is specified, num_fmt is ignored.
-    # @option options [Integer] border The border style to use. 
+    # @option options [Integer] border The border style to use.
     # @option options [String] bg_color The background color to apply to the cell
     # @option options [Boolean] hidden Indicates if the cell should be hidden
     # @option options [Boolean] locked Indicates if the cell should be locked
     # @option options [Hash] alignment A hash defining any of the attributes used in CellAlignment
     # @see CellAlignment
-    # 
+    #
     # @example You Got Style
     #   require "rubygems" # if that is your preferred way to manage gems!
     #   require "axlsx"
@@ -148,7 +148,7 @@ module Axlsx
     #   ws = p.workbook.add_worksheet
     #
     #   # black text on a white background at 14pt with thin borders!
-    #   title = ws.style.add_style(:bg_color => "FFFF0000", :fg_color=>"#FF000000", :sz=>14,  :border=>Axlsx::STYLE_THIN_BORDER
+    #   title = ws.style.add_style(:bg_color => "FFFF0000", :fg_color=>"#FF000000", :sz=>14,  :border=> {:style => :thin, :color => "FFFF0000"}
     #
     #   ws.add_row :values => ["Least Popular Pets"]
     #   ws.add_row :values => ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"], :style=>title
@@ -165,15 +165,15 @@ module Axlsx
     #   ws = p.workbook.add_worksheet
     #
     #   # define your styles
-    #   title = ws.style.add_style(:bg_color => "FFFF0000", 
+    #   title = ws.style.add_style(:bg_color => "FFFF0000",
     #                              :fg_color=>"#FF000000",
-    #                              :border=>Axlsx::STYLE_THIN_BORDER, 
+    #                              :border=>Axlsx::STYLE_THIN_BORDER,
     #                              :alignment=>{:horizontal => :center})
     #
     #   date_time = ws.style.add_style(:num_fmt => Axlsx::NUM_FMT_YYYYMMDDHHMMSS,
     #                                  :border=>Axlsx::STYLE_THIN_BORDER)
     #
-    #   percent = ws.style.add_style(:num_fmt => Axlsx::NUM_FMT_PERCENT, 
+    #   percent = ws.style.add_style(:num_fmt => Axlsx::NUM_FMT_PERCENT,
     #                                :border=>Axlsx::STYLE_THIN_BORDER)
     #
     #   currency = ws.style.add_style(:format_code=>"¥#,##0;[Red]¥-#,##0",
@@ -190,7 +190,7 @@ module Axlsx
     #   f = File.open('example_you_got_style.xlsx', 'w')
     #   p.serialize(f)
     def add_style(options={})
-      
+
       numFmtId = if options[:format_code]
                    n = @numFmts.map{ |f| f.numFmtId }.max + 1
                    numFmts << NumFmt.new(:numFmtId => n, :formatCode=> options[:format_code])
@@ -198,19 +198,29 @@ module Axlsx
                  else
                    options[:num_fmt] || 0
                  end
-      
+
       borderId = options[:border] || 0
 
+      if borderId.is_a?(Hash)
+        raise ArgumentError, "border hash definitions must include both style and color" unless borderId.keys.include?(:style) && borderId.keys.include?(:color)
+
+        s = borderId.delete :style
+        c = borderId.delete :color
+        border = Border.new
+        [:left, :right, :top, :bottom].each {|pr| border.prs << BorderPr.new(:name => pr, :style=>s, :color => Color.new(:rgb => c))}
+        borderId = self.borders << border
+      end
+
       raise ArgumentError, "Invalid borderId" unless borderId < borders.size
-      
+
       fill = if options[:bg_color]
                color = Color.new(:rgb=>options[:bg_color])
                pattern = PatternFill.new(:patternType =>:solid, :fgColor=>color)
-               fills << Fill.new(pattern)   
+               fills << Fill.new(pattern)
              else
                0
              end
-      
+
       fontId = if (options.values_at(:fg_color, :sz, :b, :i, :u, :strike, :outline, :shadow, :charset, :family, :font_name).length)
                  font = Font.new()
                  [:b, :i, :u, :strike, :outline, :shadow, :charset, :family, :sz].each { |k| font.send("#{k}=", options[k]) unless options[k].nil? }
@@ -218,42 +228,41 @@ module Axlsx
                  font.name = options[:font_name] unless options[:font_name].nil?
                  fonts << font
                else
-                 0 
+                 0
                end
-      
+
       applyProtection = (options[:hidden] || options[:locked]) ? 1 : 0
-      
+
       xf = Xf.new(:fillId => fill, :fontId=>fontId, :applyFill=>1, :applyFont=>1, :numFmtId=>numFmtId, :borderId=>borderId, :applyProtection=>applyProtection)
 
       xf.applyNumberFormat = true if xf.numFmtId > 0
       xf.applyBorder = true if borderId > 0
-      
+
       if options[:alignment]
         xf.alignment = CellAlignment.new(options[:alignment])
+        xf.applyAlignment = true
       end
-      
+
       if applyProtection
         xf.protection = CellProtection.new(options)
       end
-      
+
       cellXfs << xf
     end
-    
-    # Serializes the styles document
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml()
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.styleSheet(:xmlns => XML_NS) {
-          [:numFmts, :fonts, :fills, :borders, :cellStyleXfs, :cellXfs, :cellStyles, :dxfs, :tableStyles].each do |key|
-            self.instance_values[key.to_s].to_xml(xml) unless self.instance_values[key.to_s].nil?
-          end
-        }
+    def to_xml_string(str = '')
+      str << '<styleSheet xmlns="' << XML_NS << '">'
+      [:numFmts, :fonts, :fills, :borders, :cellStyleXfs, :cellXfs, :cellStyles, :dxfs, :tableStyles].each do |key|
+        self.instance_values[key.to_s].to_xml_string(str) unless self.instance_values[key.to_s].nil?
       end
-      builder.to_xml(:save_with => 0)
+      str << '</styleSheet>'
     end
 
     private
-    # Creates the default set of styles the exel requires to be valid as well as setting up the 
+    # Creates the default set of styles the exel requires to be valid as well as setting up the
     # Axlsx::STYLE_THIN_BORDER
     def load_default_styles
       @numFmts = SimpleTypedList.new NumFmt, 'numFmts'
@@ -274,8 +283,8 @@ module Axlsx
       @borders = SimpleTypedList.new Border, 'borders'
       @borders << Border.new
       black_border = Border.new
-      [:left, :right, :top, :bottom].each do |item| 
-        black_border.prs << BorderPr.new(:name=>item, :style=>:thin, :color=>Color.new(:rgb=>"FF000000")) 
+      [:left, :right, :top, :bottom].each do |item|
+        black_border.prs << BorderPr.new(:name=>item, :style=>:thin, :color=>Color.new(:rgb=>"FF000000"))
       end
       @borders << black_border
       @borders.lock
@@ -300,4 +309,4 @@ module Axlsx
     end
   end
 end
-  
+

data/lib/axlsx/stylesheet/table_style.rb

@@ -36,13 +36,18 @@ module Axlsx
     # @see table
     def table=(v) Axlsx::validate_boolean v; @table=v end
 
-    # Serializes the table style
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
+    def to_xml_string(str = '')
       attr = self.instance_values.select { |k, v| [:name, :pivot, :table].include? k }
       attr[:count] = self.size
-      xml.tableStyle(attr) { self.each { |table_style_el| table_style_el.to_xml(xml) } }
+      str << '<tableStyle '
+      str << attr.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '>'
+      each { |table_style_el| table_style_el.to_xml_string(str) }
+      str << '</tableStyle>'
     end
+
   end
 end

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Axlsx
-  # an element of style that belongs to a table style. 
-  # @note tables and table styles are not supported in this version. This class exists in preparation for that support. 
+  # an element of style that belongs to a table style.
+  # @note tables and table styles are not supported in this version. This class exists in preparation for that support.
   class TableStyleElement
     # The type of style element. The following type are allowed
     #   :wholeTable
@@ -39,7 +39,7 @@ module Axlsx
     # @return [Integer]
     attr_reader :size
 
-    # The dxfId this style element points to 
+    # The dxfId this style element points to
     # @return [Integer]
     attr_reader :dxfId
 
@@ -62,11 +62,14 @@ module Axlsx
     # @see dxfId
     def dxfId=(v) Axlsx::validate_unsigned_int v; @dxfId = v end
 
-    # Serializes the table style element
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.tableStyleElement self.instance_values
+    def to_xml_string(str = '')
+      str << '<tableStyleElement '
+      str << instance_values.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
     end
+
   end
 end

data/lib/axlsx/stylesheet/table_styles.rb

@@ -11,13 +11,13 @@ module Axlsx
     # The default pivot table style. The default value is  'PivotStyleLight6'
     # @return [String]
     attr_reader :defaultPivotStyle
-    
+
     # Creates a new TableStyles object that is a container for TableStyle objects
     # @option options [String] defaultTableStyle
     # @option options [String] defaultPivotStyle
     def initialize(options={})
       @defaultTableStyle = options[:defaultTableStyle] || "TableStyleMedium9"
-      @defaultPivotStyle = options[:defaultPivotStyle] || "PivotStyleLight16"      
+      @defaultPivotStyle = options[:defaultPivotStyle] || "PivotStyleLight16"
       super TableStyle
     end
     # @see defaultTableStyle
@@ -25,16 +25,19 @@ module Axlsx
     # @see defaultPivotStyle
     def defaultPivotStyle=(v) Axlsx::validate_string(v); @defaultPivotStyle = v; end
 
-    # Serializes the table styles element
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
+    def to_xml_string(str = '')
       attr = self.instance_values.reject {|k, v| ![:defaultTableStyle, :defaultPivotStyle].include?(k.to_sym) }
       attr[:count] = self.size
-      xml.tableStyles(attr) {
-        self.each { |table_style| table_style.to_xml(xml) }
-      }
+      str << '<tableStyles '
+      str << attr.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '>'
+      each { |table_style| table_style.to_xml_string(str) }
+      str << '</tableStyles>'
     end
+
   end
 
 end

data/lib/axlsx/stylesheet/xf.rb

@@ -22,7 +22,7 @@ module Axlsx
     # index (0 based) of the font to be used in this style
     # @return [Integer]
     attr_reader :fontId
-    
+
     # index (0 based) of the fill to be used in this style
     # @return [Integer]
     attr_reader :fillId
@@ -50,7 +50,7 @@ module Axlsx
     # indicates if the fontId should be applied
     # @return [Boolean]
     attr_reader :applyFont
-    
+
     # indicates if the fillId should be applied
     # @return [Boolean]
     attr_reader :applyFill
@@ -75,7 +75,7 @@ module Axlsx
     # @option options [Integer] xfId
     # @option options [Boolean] quotePrefix
     # @option options [Boolean] pivotButton
-    # @option options [Boolean] applyNumberFormat 
+    # @option options [Boolean] applyNumberFormat
     # @option options [Boolean] applyFont
     # @option options [Boolean] applyFill
     # @option options [Boolean] applyBorder
@@ -87,8 +87,8 @@ module Axlsx
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
-    end    
-    
+    end
+
     # @see Xf#alignment
     def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
 
@@ -96,44 +96,48 @@ module Axlsx
     def protection=(v) DataTypeValidator.validate "Xf.protection", CellProtection, v; @protection = v end
 
     # @see numFmtId
-    def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end    
+    def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
 
     # @see fontId
-    def fontId=(v) Axlsx::validate_unsigned_int v; @fontId = v end    
+    def fontId=(v) Axlsx::validate_unsigned_int v; @fontId = v end
     # @see fillId
-    def fillId=(v) Axlsx::validate_unsigned_int v; @fillId = v end    
+    def fillId=(v) Axlsx::validate_unsigned_int v; @fillId = v end
     # @see borderId
-    def borderId=(v) Axlsx::validate_unsigned_int v; @borderId = v end    
+    def borderId=(v) Axlsx::validate_unsigned_int v; @borderId = v end
     # @see xfId
-    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end    
+    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
     # @see quotePrefix
-    def quotePrefix=(v) Axlsx::validate_boolean v; @quotePrefix = v end    
+    def quotePrefix=(v) Axlsx::validate_boolean v; @quotePrefix = v end
     # @see pivotButton
-    def pivotButton=(v) Axlsx::validate_boolean v; @pivotButton = v end    
+    def pivotButton=(v) Axlsx::validate_boolean v; @pivotButton = v end
     # @see applyNumberFormat
-    def applyNumberFormat=(v) Axlsx::validate_boolean v; @applyNumberFormat = v end    
+    def applyNumberFormat=(v) Axlsx::validate_boolean v; @applyNumberFormat = v end
     # @see applyFont
-    def applyFont=(v) Axlsx::validate_boolean v; @applyFont = v end    
+    def applyFont=(v) Axlsx::validate_boolean v; @applyFont = v end
     # @see applyFill
-    def applyFill=(v) Axlsx::validate_boolean v; @applyFill = v end    
+    def applyFill=(v) Axlsx::validate_boolean v; @applyFill = v end
 
     # @see applyBorder
-    def applyBorder=(v) Axlsx::validate_boolean v; @applyBorder = v end    
+    def applyBorder=(v) Axlsx::validate_boolean v; @applyBorder = v end
 
     # @see applyAlignment
-    def applyAlignment=(v) Axlsx::validate_boolean v; @applyAlignment = v end    
+    def applyAlignment=(v) Axlsx::validate_boolean v; @applyAlignment = v end
 
     # @see applyProtection
-    def applyProtection=(v) Axlsx::validate_boolean v; @applyProtection = v end    
+    def applyProtection=(v) Axlsx::validate_boolean v; @applyProtection = v end
 
-    # Serializes the xf elemen
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.xf(self.instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}) {
-        alignment.to_xml(xml) if self.alignment
-        protection.to_xml(xml) if self.protection
-      }
+    def to_xml_string(str = '')
+      str << '<xf '
+      h = instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}
+      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << '>'
+      alignment.to_xml_string(str) if self.alignment
+      protection.to_xml_string(str) if self.protection
+      str << '</xf>'
     end
+
   end
 end