axlsx 1.0.16 → 1.1.0

data/lib/axlsx/doc_props/app.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   # App represents the app.xml document. The attributes for this object are primarily managed by the application the end user uses to edit the document. None of the attributes are required to serialize a valid xlsx object.
   # @see shared-documentPropertiesExtended.xsd
@@ -17,7 +17,7 @@ module Axlsx
     attr_reader :Manager
 
     # @return [String] The name of the company generating the document.
-    attr_reader :Company 
+    attr_reader :Company
 
     # @return [Integer] The number of pages in the document.
     attr_reader :Pages
@@ -43,7 +43,7 @@ module Axlsx
     # @return [Integer] The number of slides that have notes.
     attr_reader :Notes
 
-    # @return [Integer] The total amount of time spent editing.   
+    # @return [Integer] The total amount of time spent editing.
     attr_reader :TotalTime
 
     # @return [Integer] The number of hidden slides.
@@ -60,11 +60,11 @@ module Axlsx
 
     # @return [Integer] The number of characters in the document including spaces.
     attr_reader :CharactersWithSpaces
-    
+
     # @return [Boolean] Indicates if the document is shared.
     attr_reader :ShareDoc
 
-    # @return [String] The base for hyper links in the document. 
+    # @return [String] The base for hyper links in the document.
     attr_reader :HyperLinkBase
 
     # @return [Boolean] Indicates that the hyper links in the document have been changed.
@@ -96,7 +96,7 @@ module Axlsx
     # @option options [Boolean] ScaleCrop
     # @option options [Boolean] LinksUpToDate
     # @option options [Integer] CharactersWithSpaces
-    # @option options [Boolean] ShareDoc    
+    # @option options [Boolean] ShareDoc
     # @option options [String] HyperLinkBase
     # @option options [String] HyperlinksChanged
     # @option options [String] Application
@@ -109,70 +109,67 @@ module Axlsx
     end
 
     # Sets the Template property of your app.xml file
-    def Template=(v) Axlsx::validate_string v; @Template = v; end 
+    def Template=(v) Axlsx::validate_string v; @Template = v; end
 
     # Sets the Manager property of your app.xml file
-    def Manager=(v) Axlsx::validate_string v; @Manager = v; end 
+    def Manager=(v) Axlsx::validate_string v; @Manager = v; end
 
     # Sets the Company property of your app.xml file
-    def Company=(v) Axlsx::validate_string v; @Company = v; end 
+    def Company=(v) Axlsx::validate_string v; @Company = v; end
 
     # Sets the Pages property of your app.xml file
-    def Pages=(v) Axlsx::validate_int v; @Pages = v; end 
+    def Pages=(v) Axlsx::validate_int v; @Pages = v; end
 
     # Sets the Words property of your app.xml file
-    def Words=(v) Axlsx::validate_int v; @Words = v; end 
+    def Words=(v) Axlsx::validate_int v; @Words = v; end
 
     # Sets the Characters property of your app.xml file
-    def Characters=(v) Axlsx::validate_int v; @Characters = v; end 
+    def Characters=(v) Axlsx::validate_int v; @Characters = v; end
 
 
     # Sets the PresentationFormat property of your app.xml file
-    def PresentationFormat=(v) Axlsx::validate_string v; @PresentationFormat = v; end 
+    def PresentationFormat=(v) Axlsx::validate_string v; @PresentationFormat = v; end
     # Sets the Lines property of your app.xml file
-    def Lines=(v) Axlsx::validate_int v; @Lines = v; end 
+    def Lines=(v) Axlsx::validate_int v; @Lines = v; end
     # Sets the Paragraphs property of your app.xml file
-    def Paragraphs=(v) Axlsx::validate_int v; @Paragraphs = v; end 
+    def Paragraphs=(v) Axlsx::validate_int v; @Paragraphs = v; end
     # Sets the Slides property of your app.xml file
-    def Slides=(v) Axlsx::validate_int v; @Slides = v; end 
+    def Slides=(v) Axlsx::validate_int v; @Slides = v; end
     # Sets the Notes property of your app.xml file
-    def Notes=(v) Axlsx::validate_int v; @Notes = v; end 
+    def Notes=(v) Axlsx::validate_int v; @Notes = v; end
     # Sets the TotalTime property of your app.xml file
-    def TotalTime=(v) Axlsx::validate_int v; @TotalTime = v; end 
+    def TotalTime=(v) Axlsx::validate_int v; @TotalTime = v; end
     # Sets the HiddenSlides property of your app.xml file
-    def HiddenSlides=(v) Axlsx::validate_int v; @HiddenSlides = v; end 
+    def HiddenSlides=(v) Axlsx::validate_int v; @HiddenSlides = v; end
     # Sets the MMClips property of your app.xml file
-    def MMClips=(v) Axlsx::validate_int v; @MMClips = v; end 
+    def MMClips=(v) Axlsx::validate_int v; @MMClips = v; end
     # Sets the ScaleCrop property of your app.xml file
-    def ScaleCrop=(v) Axlsx::validate_boolean v; @ScaleCrop = v; end 
+    def ScaleCrop=(v) Axlsx::validate_boolean v; @ScaleCrop = v; end
     # Sets the LinksUpToDate property of your app.xml file
-    def LinksUpToDate=(v) Axlsx::validate_boolean v; @LinksUpToDate = v; end 
+    def LinksUpToDate=(v) Axlsx::validate_boolean v; @LinksUpToDate = v; end
     # Sets the CharactersWithSpaces property of your app.xml file
-    def CharactersWithSpaces=(v) Axlsx::validate_int v; @CharactersWithSpaces = v; end 
+    def CharactersWithSpaces=(v) Axlsx::validate_int v; @CharactersWithSpaces = v; end
     # Sets the ShareDoc property of your app.xml file
-    def ShareDoc=(v) Axlsx::validate_boolean v; @ShareDoc = v; end 
+    def ShareDoc=(v) Axlsx::validate_boolean v; @ShareDoc = v; end
     # Sets the HyperLinkBase property of your app.xml file
-    def HyperLinkBase=(v) Axlsx::validate_string v; @HyperLinkBase = v; end 
+    def HyperLinkBase=(v) Axlsx::validate_string v; @HyperLinkBase = v; end
     # Sets the HyperLinksChanged property of your app.xml file
-    def HyperlinksChanged=(v) Axlsx::validate_boolean v; @HyperlinksChanged = v; end 
+    def HyperlinksChanged=(v) Axlsx::validate_boolean v; @HyperlinksChanged = v; end
     # Sets the Application property of your app.xml file
-    def Application=(v) Axlsx::validate_string v; @Application = v; end 
+    def Application=(v) Axlsx::validate_string v; @Application = v; end
     # Sets the AppVersion property of your app.xml file
-    def AppVersion=(v) Axlsx::validate_string v; @AppVersion = v; end 
+    def AppVersion=(v) Axlsx::validate_string v; @AppVersion = v; end
     # Sets the DocSecurity property of your app.xml file
-    def DocSecurity=(v) Axlsx::validate_int v; @DocSecurity = v; end 
-
-    # Generate an app.xml document
-    # @return [String] The document as a string
-    def to_xml()
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send(:Properties, :xmlns => APP_NS, :'xmlns:vt' => APP_NS_VT) {
-          self.instance_values.each do |name, value|
-            xml.send(name, value)
-          end
-        }
-      end      
-      builder.to_xml(:save_with => 0)
+    def DocSecurity=(v) Axlsx::validate_int v; @DocSecurity = v; end
+
+    # Serialize the app.xml document
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<Properties xmlns="' << APP_NS << '" xmlns:vt="' << APP_NS_VT << '">'
+      str << instance_values.map { |key, value| '<' << key.to_s << '>' << value.to_s << '</' << key.to_s << '>' }.join
+      str << '</Properties>'
     end
+
   end
 end

data/lib/axlsx/doc_props/core.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The core object for the package.
   # @note Packages manage their own core object.
@@ -6,29 +7,24 @@ module Axlsx
     # The author of the document. By default this is 'axlsx'
     # @return [String]
     attr_accessor :creator
-    
+
     # Creates a new Core object.
     # @option options [String] creator
     def initialize(options={})
-      @creator = options[:creator] || 'axlsx'      
+      @creator = options[:creator] || 'axlsx'
     end
 
-    # Serializes the core object. The created dcterms item is set to the current time when this method is called.
+    # serializes the core.xml document
     # @return [String]
-    def to_xml()
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send('cp:coreProperties', 
-                 :"xmlns:cp" => CORE_NS, 
-                 :'xmlns:dc' => CORE_NS_DC, 
-                 :'xmlns:dcmitype'=>CORE_NS_DCMIT, 
-                 :'xmlns:dcterms'=>CORE_NS_DCT, 
-                 :'xmlns:xsi'=>CORE_NS_XSI) {
-          xml['dc'].creator self.creator
-          xml['dcterms'].created Time.now.strftime('%Y-%m-%dT%H:%M:%S'), :'xsi:type'=>"dcterms:W3CDTF"
-          xml['cp'].revision 0
-        }
-      end  
-      builder.to_xml(:save_with => 0)
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<cp:coreProperties xmlns:cp="' << CORE_NS << '" xmlns:dc="' << CORE_NS_DC << '" '
+      str << 'xmlns:dcmitype="' << CORE_NS_DCMIT << '" xmlns:dcterms="' << CORE_NS_DCT << '" '
+      str << 'xmlns:xsi="' << CORE_NS_XSI << '">'
+      str << '<dc:creator>' << self.creator << '</dc:creator>'
+      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << Time.now.strftime('%Y-%m-%dT%H:%M:%S') << '</dcterms:created>'
+      str << '<cp:revision>0</cp:revision>'
+      str << '</cp:coreProperties>'
     end
   end
 end

data/lib/axlsx/drawing/axis.rb

@@ -1,8 +1,9 @@
+# encoding: UTF-8
 module Axlsx
  # the access class defines common properties and values for a chart axis.
   class Axis
 
-    # the id of the axis. 
+    # the id of the axis.
     # @return [Integer]
     attr_reader :axId
 
@@ -14,7 +15,7 @@ module Axlsx
     # @see Scaling
     # @return [Scaling]
     attr_reader :scaling
-    
+
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
     # @return [Symbol]
@@ -33,7 +34,11 @@ module Axlsx
     # specifies how the perpendicular axis is crossed
     # must be one of [:autoZero, :min, :max]
     # @return [Symbol]
-    attr_reader :crosses 
+    attr_reader :crosses
+
+    # specifies if gridlines should be shown in the chart
+    # @return [Boolean]
+    attr_reader :gridlines
 
     # Creates an Axis object
     # @param [Integer] axId the id of this axis
@@ -48,11 +53,12 @@ module Axlsx
       @axId = axId
       @crossAx = crossAx
       @format_code = "General"
-      @scaling = Scaling.new(:orientation=>:minMax)      
+      @scaling = Scaling.new(:orientation=>:minMax)
       self.axPos = :b
       self.tickLblPos = :nextTo
       self.format_code = "General"
       self.crosses = :autoZero
+      self.gridlines = true
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
@@ -69,25 +75,39 @@ module Axlsx
     # default :General
     def format_code=(v) Axlsx::validate_string(v); @format_code = v; end
 
+    # Specify if gridlines should be shown for this axis
+    # default true
+    def gridlines=(v) Axlsx::validate_boolean(v); @gridlines = v; end
+
     # specifies how the perpendicular axis is crossed
     # must be one of [:autoZero, :min, :max]
     def crosses=(v) RestrictionValidator.validate "#{self.class}.crosses", [:autoZero, :min, :max], v; @crosses = v; end
 
-    # Serializes the common axis
-    # @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.axId :val=>@axId
-      @scaling.to_xml(xml)
-      xml.delete :val=>0
-      xml.axPos :val=>@axPos
-      xml.majorGridlines
-      xml.numFmt :formatCode => @format_code, :sourceLinked=>"1"
-      xml.majorTickMark :val=>"none"
-      xml.minorTickMark :val=>"none"
-      xml.tickLblPos :val=>@tickLblPos
-      xml.crossAx :val=>@crossAx
-      xml.crosses :val=>@crosses
-    end    
+    def to_xml_string(str = '')
+      str << '<c:axId val="' << @axId.to_s << '"/>'
+      @scaling.to_xml_string str
+      str << '<c:delete val="0"/>'
+      str << '<c:axPos val="' << @axPos.to_s << '"/>'
+      str << '<c:majorGridlines>'
+      if self.gridlines == false
+        str << '<c:spPr>'
+        str << '<a:ln>'
+        str << '<a:noFill/>'
+        str << '</a:ln>'
+        str << '</c:spPr>'
+      end
+      str << '</c:majorGridlines>'
+      str << '<c:numFmt formatCode="' << @format_code << '" sourceLinked="1"/>'
+      str << '<c:majorTickMark val="none"/>'
+      str << '<c:minorTickMark val="none"/>'
+      str << '<c:tickLblPos val="' << @tickLblPos.to_s << '"/>'
+      str << '<c:crossAx val="' << @crossAx.to_s << '"/>'
+      str << '<c:crosses val="' << @crosses.to_s << '"/>'
+    end
+
   end
 end

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 
   # The Bar3DChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
@@ -40,7 +41,7 @@ module Axlsx
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
-    
+
     # Creates a new bar chart object
     # @param [GraphicFrame] frame The workbook that owns this chart.
     # @option options [Cell, String] title
@@ -66,14 +67,14 @@ module Axlsx
       @valAxId = rand(8 ** 8)
       @catAxis = CatAxis.new(@catAxId, @valAxId)
       @valAxis = ValAxis.new(@valAxId, @catAxId, :tickLblPos => :low)
-      super(frame, options)      
+      super(frame, options)
       @series_type = BarSeries
       @view3D = View3D.new({:rAngAx=>1}.merge(options))
     end
 
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
-    def barDir=(v) 
+    def barDir=(v)
       RestrictionValidator.validate "Bar3DChart.barDir", [:bar, :col], v
       @barDir = v
     end
@@ -99,38 +100,39 @@ module Axlsx
 
     # The shabe of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
-    def shape=(v) 
+    def shape=(v)
       RestrictionValidator.validate "Bar3DChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v
     end
-    
-    # Serializes the bar chart
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml
-      super() do |xml|
-        xml.bar3DChart {
-          xml.barDir :val => barDir
-          xml.grouping :val=>grouping
-          xml.varyColors :val=>1
-          @series.each { |ser| ser.to_xml(xml) }
-          xml.dLbls {
-            xml.showLegendKey :val=>0
-            xml.showVal :val=>0
-            xml.showCatName :val=>0
-            xml.showSerName :val=>0
-            xml.showPercent :val=>0
-            xml.showBubbleSize :val=>0            
-          }
-          xml.gapWidth :val=>@gapWidth unless @gapWidth.nil?
-          xml.gapDepth :val=>@gapDepth unless @gapDepth.nil?
-          xml.shape :val=>@shape unless @shape.nil?
-          xml.axId :val=>@catAxId
-          xml.axId :val=>@valAxId
-          xml.axId :val=>0
-        }
-        @catAxis.to_xml(xml)
-        @valAxis.to_xml(xml)        
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:bar3DChart>'
+        str_inner << '<c:barDir val="' << barDir.to_s << '"/>'
+        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
+        str_inner << '<c:varyColors val="1"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        str_inner << '<c:dLbls>'
+        str_inner << '<c:showLegendKey val="0"/>'
+        str_inner << '<c:showVal val="0"/>'
+        str_inner << '<c:showCatName val="0"/>'
+        str_inner << '<c:showSerName val="0"/>'
+        str_inner << '<c:showPercent val="0"/>'
+        str_inner << '<c:showBubbleSize val="0"/>'
+        str_inner << '</c:dLbls>'
+        str_inner << '<c:gapWidth val="' << @gapWidth.to_s << '"/>' unless @gapWidth.nil?
+        str_inner << '<c:gapDepth val="' << @gapDepth.to_s << '"/>' unless @gapDepth.nil?
+        str_inner << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
+        str_inner << '<c:axId val="' << @catAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @valAxId.to_s << '"/>'
+        str_inner << '<c:axId val="0"/>'
+        str_inner << '</c:bar3DChart>'
+        @catAxis.to_xml_string str_inner
+        @valAxis.to_xml_string str_inner
       end
-    end    
-  end  
+    end
+  end
 end

data/lib/axlsx/drawing/bar_series.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A BarSeries defines the title, data and labels for bar charts
   # @note The recommended way to manage series is to use Chart#add_series
@@ -5,8 +6,8 @@ module Axlsx
   # @see Chart#add_series
   class BarSeries < Series
 
-  
-    # The data for this series. 
+
+    # The data for this series.
     # @return [Array, SimpleTypedList]
     attr_reader :data
 
@@ -30,28 +31,27 @@ module Axlsx
       super(chart, options)
       self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
       self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    end 
+    end
 
     # The shabe of the bars or columns
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    def shape=(v) 
+    def shape=(v)
       RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v
     end
 
-    # Serializes the series
-    # @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)
-      super(xml) do |xml_inner|
-        @labels.to_xml(xml_inner) unless @labels.nil?
-        @data.to_xml(xml_inner) unless @data.nil?
-        xml_inner.shape :val=>@shape
-      end      
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        @labels.to_xml_string(str_inner) unless @labels.nil?
+        @data.to_xml_string(str_inner) unless @data.nil?
+        str_inner << '<shape val="' << @shape.to_s << '"/>'
+      end
     end
 
-    
-    private 
+    private
 
     # assigns the data for this series
     def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end

data/lib/axlsx/drawing/cat_axis.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   #A CatAxis object defines a chart category axis
   class CatAxis < Axis
@@ -9,7 +10,7 @@ module Axlsx
     # specifies how the perpendicular axis is crossed
     # must be one of [:ctr, :l, :r]
     # @return [Symbol]
-    attr_reader :lblAlgn 
+    attr_reader :lblAlgn
 
     # The offset of the labels
     # must be between a string between 0 and 1000
@@ -19,7 +20,7 @@ module Axlsx
     # regex for validating label offset
     LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/
 
-    # Creates a new CatAxis object    
+    # Creates a new CatAxis object
     # @param [Integer] axId the id of this axis. Inherited
     # @param [Integer] crossAx the id of the perpendicular axis. Inherited
     # @option options [Symbol] axPos. Inherited
@@ -27,13 +28,13 @@ module Axlsx
     # @option options [Symbol] crosses. Inherited
     # @option options [Boolean] auto
     # @option options [Symbol] lblAlgn
-    # @option options [Integer] lblOffset    
+    # @option options [Integer] lblOffset
     def initialize(axId, crossAx, options={})
       self.auto = 1
       self.lblAlgn = :ctr
       self.lblOffset = "100%"
       super(axId, crossAx, options)
-    end 
+    end
 
     # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
     def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
@@ -46,18 +47,19 @@ module Axlsx
     # must be between a string between 0 and 1000
     def lblOffset=(v) RegexValidator.validate "#{self.class}.lblOffset", LBL_OFFSET_REGEX, v; @lblOffset = v; end
 
-    # Serializes the category axis
-    # @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.catAx {
-        super(xml)
-        xml.auto :val=>@auto
-        xml.lblAlgn :val=>@lblAlgn
-        xml.lblOffset :val=>@lblOffset
-      }
+    def to_xml_string(str = '')
+      str << '<c:catAx>'
+      super(str)
+      str << '<c:auto val="' << @auto.to_s << '"/>'
+      str << '<c:lblAlgn val="' << @lblAlgn.to_s << '"/>'
+      str << '<c:lblOffset val="' << @lblOffset.to_s << '"/>'
+      str << '</c:catAx>'
     end
+
   end
-  
+
 
 end

data/lib/axlsx/drawing/cat_axis_data.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The CatAxisData class serializes the category axis data for a chart
   class CatAxisData < SimpleTypedList
@@ -10,26 +11,24 @@ module Axlsx
       data.each { |i| @list << i } if data.is_a?(SimpleTypedList)
     end
 
-    # Serializes the category axis data
-    # @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.cat {
-        xml.strRef {
-          xml.f Axlsx::cell_range(@list)
-          xml.strCache {
-            xml.ptCount :val=>size
-            each_with_index do |item, index|
-              v = item.is_a?(Cell) ? item.value : item
-              xml.pt(:idx=>index) {
-                xml.v v
-              }                          
-            end
-          }
-        }
-      }
+    def to_xml_string(str = '')
+      str << '<c:cat>'
+      str << '<c:strRef>'
+      str << '<c:f>' << Axlsx::cell_range(@list) << '</c:f>'
+      str << '<c:strCache>'
+      str << '<c:ptCount val="' << size.to_s << '"/>'
+      each_with_index do |item, index|
+        v = item.is_a?(Cell) ?  item.value.to_s : item
+        str << '<c:pt idx="' << index.to_s << '"><c:v>' << v << '</c:v></c:pt>'
+      end
+      str << '</c:strCache>'
+      str << '</c:strRef>'
+      str << '</c:cat>'
     end
 
   end
-  
+
 end