axlsx 1.2.0 → 2.0.0

data/examples/ios_preview.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+p.use_shared_strings = true
+s = p.workbook.add_worksheet(:name => "Formula test")
+s.add_row [1, 2, 3]
+s.add_row %w(a b c)
+s.add_row ["=SUM(A1:C1)"], :formula_values => [6]
+p.serialize "ios_preview.xlsx"

data/examples/page_setup.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+xls = Axlsx::Package.new
+wb = xls.workbook
+wb.add_worksheet do |ws|
+  # Excel does not currently follow the specification and will ignore paper_width and paper_height so if you need
+  # to for a paper size, be sure to set :paper_size
+  ws.page_setup.set :paper_width => "210mm", :paper_size => 10,  :paper_height => "297mm", :orientation => :landscape
+  ws.add_row %w(AXLSX is cool)
+end
+xls.serialize "page_setup.xlsx"

data/examples/pivot_table.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+# Create some data in a sheet
+def month
+  %w(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec).sample
+end
+def year
+  %w(2010 2011 2012).sample
+end
+def type
+  %w(Meat Dairy Beverages Produce).sample
+end
+def sales
+  rand(5000)
+end
+def region
+  %w(East West North South).sample
+end
+
+wb.add_worksheet(:name => "Data Sheet") do |sheet|
+  sheet.add_row ['Month', 'Year', 'Type', 'Sales', 'Region']
+  30.times { sheet.add_row [month, year, type, sales, region] }
+  sheet.add_pivot_table 'G4:L17', "A1:E31" do |pivot_table|
+    pivot_table.rows = ['Month', 'Year']
+    pivot_table.columns = ['Type']
+    pivot_table.data = ['Sales']
+    pivot_table.pages = ['Region']
+  end
+end
+
+# Write the excel file
+p.serialize("pivot_table.xlsx")

data/examples/skydrive/real_example.rb

@@ -1,18 +1,18 @@
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
 
 require 'axlsx'
 
 Axlsx::Package.new do |p|
   p.workbook do |wb|
     styles = wb.styles
-    header = styles.add_style :bg_color => "DD", :sz => 16, :b => true, :alignment => {:horizontal => :center}
+    header     = styles.add_style :bg_color => "DD", :sz => 16, :b => true, :alignment => {:horizontal => :center}
     tbl_header = styles.add_style :b => true, :alignment => { :horizontal => :center }
     ind_header = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => {:indent => 1}
-    col_header  = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => { :horizontal => :center }
-    label       = styles.add_style :alignment => { :indent => 1 }
-    money       = styles.add_style :num_fmt => 5
-    t_label       = styles.add_style :b => true, :bg_color => "FFDFDEDF"
-    t_money = styles.add_style :b => true, :num_fmt => 5, :bg_color => "FFDFDEDF"
+    col_header = styles.add_style :bg_color => "FFDFDEDF", :b => true, :alignment => { :horizontal => :center }
+    label      = styles.add_style :alignment => { :indent => 1 }
+    money      = styles.add_style :num_fmt => 5
+    t_label    = styles.add_style :b => true, :bg_color => "FFDFDEDF"
+    t_money    = styles.add_style :b => true, :num_fmt => 5, :bg_color => "FFDFDEDF"
 
     wb.add_worksheet do |sheet|
       sheet.add_row
@@ -54,7 +54,7 @@ Axlsx::Package.new do |p|
         chart.start_at 7, 16
         chart.end_at 12, 31
       end
-      sheet.merged_cells.concat ["B4:C4","E4:F4","B11:C11","E11:F11","B2:F2"]
+      %w(B4:C4 E4:F4 B11:C11 E11:F11 B2:F2).each { |range| sheet.merge_cells(range) }
       sheet.column_widths 2, nil, nil, 2, nil, nil, 2
     end
   end

data/examples/styles.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+require 'date'
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.styles do |style|
+
+  # Date/Time Styles
+  #
+  # The most important thing to remember about OOXML styles is that they are
+  # exclusive. This means that each style must define all the components it
+  # requires to render the cell the way you want. A good example of this is
+  # changing the font size for a date. You cannot specify just the font size,
+  # you must also specify the number format or format code so that renders
+  # know how to display the serialized date float value 
+  #
+  # The parts that make up a custom styles are:
+  #
+  # fonts(Font), fills(Fill), borders(Border) and number formats(NumFmt).
+  # Getting to know those classes will help you make the most out of custom
+  # styling. However axlsx certainly does not expect you to create all those
+  # objects manually.
+  #
+  # workbook.styles.add_style provides a helper method 'add_style' for defining
+  # styles in one go. The docs for that method are definitely worth a read.
+  # @see Style#add_style
+
+  # When no style is applied to a cell, axlsx will automatically apply date/time
+  # formatting to Date and Time objects for you. However, if you are defining
+  # custom styles, you define all aspects of the style you want to apply.
+  #
+  # An aside on styling and auto-width. Auto-width calculations do not
+  # currently take into account any style or formatting you have applied to the
+  # data in your cells as it would require the creation of a rendering engine,
+  # and frankly kill performance. If you are doing a lot of custom formatting,
+  # you are going to be better served by specifying fixed column widths.
+  #
+  # Let's look at an example:
+  #
+  # A style that only applies a font size
+  large_font = wb.styles.add_style :sz => 20
+
+  # A style that applies both a font size and a predefined number format.
+  # @see NumFmt
+  predefined_format = wb.styles.add_style :sz => 20, :num_fmt => 14
+
+  # A style that a applies a font size and a custom formatting code
+  custom_format = wb.styles.add_style :sz => 20, :format_code => 'yyyy-mm-dd'
+
+  # A style that overrides top and left border style
+  override_border = wb.styles.add_style :border => { :style => :thin, :color =>"FAAC58", :edges => [:right, :top, :left] }, :border_top => { :style => :thick, :color => "01DF74" }, :border_left => { :color => "0101DF" }
+
+
+  wb.add_worksheet do |sheet|
+
+    # We then apply those styles positionally
+    sheet.add_row [123, "123", Time.now], style: [nil, large_font, predefined_format]
+    sheet.add_row [123, "123", Date.new(2012, 9, 14)], style: [large_font, nil, custom_format]
+    sheet.add_row [123, "123", Date.new(2000, 9, 12)] # This uses the axlsx default format_code (14)
+    sheet.add_row [123, "123", Time.now], style: [large_font, override_border, predefined_format]
+  end
+
+end
+p.serialize 'styles.xlsx'
+

data/examples/underline.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  wb.styles do |s|
+    no_underline = s.add_style :sz => 10, :b => true, :u => false, :alignment => { :horizontal=> :right }
+    wb.add_worksheet(:name => 'wunderlinen') do |sheet|
+      sheet.add_row %w{a b c really?}, :style => no_underline
+    end
+  end
+end
+p.serialize 'no_underline.xlsx'
+

data/examples/wrap_text.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  wb.styles do |s|
+    wrap_text = s.add_style :fg_color=> "FFFFFF",
+                            :b => true,
+                            :bg_color => "004586",
+                            :sz => 12,
+                            :border => { :style => :thin, :color => "00" },
+                            :alignment => { :horizontal => :center,
+                                            :vertical => :center ,
+                                            :wrap_text => true}
+    wb.add_worksheet(:name => 'wrap text') do |sheet|
+      sheet.add_row ['Torp, White and Cronin'], :style => wrap_text
+      # Forcing the column to be a bit narrow so we can see if the text wrap.
+      sheet.column_info.first.width = 5
+    end
+  end
+end
+p.serialize 'wrap_text.xlsx'

data/lib/axlsx/content_type/abstract_content_type.rb

@@ -0,0 +1,32 @@
+module Axlsx
+
+  # This class extracts the common parts from Default and Override
+  class AbstractContentType
+
+    include Axlsx::OptionsParser
+
+    # Initializes an abstract content type
+    # @see Default, Override
+    def initialize(options={})
+       parse_options options
+    end
+
+    # The type of content.
+    # @return [String]
+    attr_reader :content_type
+    alias :ContentType :content_type
+
+    # The content type.
+    # @see Axlsx#validate_content_type
+    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
+    alias :ContentType= :content_type=
+
+    # Serialize the contenty type to xml
+    def to_xml_string(node_name = '', str = '')
+      str << "<#{node_name} "
+      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
+      str << '/>'
+    end
+
+  end
+end

data/lib/axlsx/content_type/content_type.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 module Axlsx
-
+  require 'axlsx/content_type/abstract_content_type.rb'
   require 'axlsx/content_type/default.rb'
   require 'axlsx/content_type/override.rb'
 

data/lib/axlsx/content_type/default.rb

@@ -2,55 +2,24 @@
 module Axlsx
 
   # An default content part. These parts are automatically created by for you based on the content of your package.
-  class Default
+  class Default < AbstractContentType
 
-    #Creates a new Default object
-    # @option options [String] extension
-    # @option options [String] content_type
-    # @raise [ArgumentError] An argument error is raised if both extension and content_type are not specified.
-    def initialize(options={})
-      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
-    end
-
-    # Error string for option validation
-    INVALID_ARGUMENTS = "extension and content_type are required"
+    # The serialization node name for this class
+    NODE_NAME = 'Default'
 
     # The extension of the content type.
     # @return [String]
     attr_reader :extension
     alias :Extension :extension
 
-    # The type of content.
-    # @return [String]
-    attr_reader :content_type
-    alias :ContentType :content_type
-
     # Sets the file extension for this content type.
     def extension=(v) Axlsx::validate_string v; @extension = v end
     alias :Extension= :extension=
 
-    # Sets the content type
-    # @see Axlsx#validate_content_type
-    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
-    alias :ContentType= :content_type=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<Default '
-      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
-      str << '/>'
-    end
-
-    private
-    def validate_options(options)
-      (options[:Extension] || options[:extension]) && (options[:content_type] || options[:ContentType])
+    # Serializes this object to xml
+    def to_xml_string(str ='')
+      super(NODE_NAME, str)
     end
-
   end
 
 end

data/lib/axlsx/content_type/override.rb

@@ -1,27 +1,12 @@
+
 # encoding: UTF-8
 module Axlsx
 
   # An override content part. These parts are automatically created by for you based on the content of your package.
-  class Override
-
-    #Creates a new Override object
-    # @option options [String] PartName
-    # @option options [String] ContentType
-    # @raise [ArgumentError] An argument error is raised if both PartName and ContentType are not specified.
-    def initialize(options={})
-      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
-    end
+  class Override < AbstractContentType
 
-    # Error message for invalid options
-    INVALID_ARGUMENTS = 'part_name and content_type are required'
-
-    # The type of content.
-    # @return [String]
-    attr_reader :content_type
-    alias :ContentType :content_type
+    # Serialization node name for this object
+    NODE_NAME = 'Override'
 
     # The name and location of the part.
     # @return [String]
@@ -32,26 +17,9 @@ module Axlsx
     def part_name=(v) Axlsx::validate_string v; @part_name = v end
     alias :PartName= :part_name=
 
-    # The content type.
-    # @see Axlsx#validate_content_type
-    def content_type=(v) Axlsx::validate_content_type v; @content_type = v end
-    alias :ContentType= :content_type=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
+    # Serializes this object to xml
     def to_xml_string(str = '')
-      str << '<Override '
-      str << instance_values.map { |key, value| '' << Axlsx::camel(key) << '="' << value.to_s << '"' }.join(' ')
-      str << '/>'
-    end
-
-    private 
-
-    def validate_options(options)
-      (options[:PartName] || options[:part_name]) && (options[:ContentType] || options[:content_type])
+      super(NODE_NAME, str)
     end
-
   end
-
 end

data/lib/axlsx/doc_props/app.rb

@@ -11,6 +11,8 @@ module Axlsx
   #    DigSig (DigSigBlob)
   class App
 
+    include Axlsx::OptionsParser
+
     # Creates an App object
     # @option options [String] template
     # @option options [String] manager
@@ -35,9 +37,7 @@ module Axlsx
     # @option options [String] app_version
     # @option options [Integer] doc_security
     def initialize(options={})
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
+      parse_options options
     end
 
     # @return [String] The name of the document template.
@@ -134,15 +134,15 @@ module Axlsx
 
     # Sets the template property of your app.xml file
     def template=(v) Axlsx::validate_string v; @template = v; end
-    alias :Template :template
+    alias :Template= :template=
 
     # Sets the manager property of your app.xml file
     def manager=(v) Axlsx::validate_string v; @manager = v; end
-    alias :Manager :manager
+    alias :Manager= :manager=
 
     # Sets the company property of your app.xml file
     def company=(v) Axlsx::validate_string v; @company = v; end
-    alias :Company :company
+    alias :Company= :company=
     # Sets the pages property of your app.xml file
     def pages=(v) Axlsx::validate_int v; @pages = v; end
 
@@ -223,7 +223,10 @@ module Axlsx
     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| '<' << Axlsx.camel(key) << '>' << value.to_s << '</' << Axlsx.camel(key) << '>' }.join
+      instance_values.each do |key, value|
+        node_name = Axlsx.camel(key)
+        str << "<#{node_name}>#{value}</#{node_name}>"
+      end
       str << '</Properties>'
     end
 

data/lib/axlsx/doc_props/core.rb

@@ -8,14 +8,19 @@ module Axlsx
  
     # Creates a new Core object.
     # @option options [String] creator
+    # @option options [Time] created
     def initialize(options={})
       @creator = options[:creator] || 'axlsx'
+      @created = options[:created]
     end
 
     # The author of the document. By default this is 'axlsx'
     # @return [String]
     attr_accessor :creator
 
+    # Creation time of the document. If nil, the current time will be used.
+    attr_accessor :created
+
     # serializes the core.xml document
     # @return [String]
     def to_xml_string(str = '')
@@ -24,7 +29,7 @@ module Axlsx
       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') << 'Z</dcterms:created>'
+      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << (created || Time.now).strftime('%Y-%m-%dT%H:%M:%S') << 'Z</dcterms:created>'
       str << '<cp:revision>0</cp:revision>'
       str << '</cp:coreProperties>'
     end

data/lib/axlsx/drawing/axes.rb

@@ -0,0 +1,61 @@
+module Axlsx
+  
+  # The Axes class creates and manages axis information and
+  # serialization for charts.
+  class Axes
+
+    # @param [Hash] options options used to generate axis each key
+    # should be an axis name like :val_axis and its value should be the
+    # class of the axis type to construct. The :cat_axis, if there is one,
+    # must come first (we assume a Ruby 1.9+ Hash or an OrderedHash).
+    def initialize(options={})
+      raise(ArgumentError, "CatAxis must come first") if options.keys.include?(:cat_axis) && options.keys.first != :cat_axis
+      options.each do |name, axis_class|
+        add_axis(name, axis_class)
+      end
+    end
+
+    # [] provides assiciative access to a specic axis store in an axes
+    # instance. 
+    # @return [Axis]
+    def [](name)
+      axes.assoc(name)[1]
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @param [Hash] options
+    # @option options ids
+    # If the ids option is specified only the axis identifier is
+    # serialized. Otherwise, each axis is serialized in full. 
+    def to_xml_string(str = '', options = {})
+      if options[:ids]
+        # CatAxis must come first in the XML (for Microsoft Excel at least)
+        sorted = axes.sort_by { |name, axis| axis.kind_of?(CatAxis) ? 0 : 1 }
+        sorted.inject(str) { |string, axis| string << '<c:axId val="' << axis[1].id.to_s << '"/>' }        
+      else
+        axes.each { |axis| axis[1].to_xml_string(str) }
+      end
+    end
+
+    # Adds an axis to the collection
+    # @param [Symbol] name The name of the axis
+    # @param [Axis] axis_class The axis class to generate
+    def add_axis(name, axis_class)
+      axis = axis_class.new
+      set_cross_axis(axis)
+      axes << [name, axis]
+    end
+
+    private
+
+    def axes
+      @axes ||= []
+    end
+
+    def set_cross_axis(axis)
+      axes.first[1].cross_axis = axis if axes.size == 1
+      axis.cross_axis = axes.first[1] unless axes.empty?
+    end
+  end
+end

data/lib/axlsx/drawing/axis.rb

@@ -4,18 +4,16 @@ module Axlsx
   # the access class defines common properties and values for a chart axis.
   class Axis
 
+    include Axlsx::OptionsParser
+
     # Creates an Axis object
-    # @param [Integer] ax_id the id of this axis
-    # @param [Integer] cross_ax the id of the perpendicular axis
+    # @option options [Axis] cross_axis the perpendicular axis
     # @option options [Symbol] ax_pos
     # @option options [Symbol] crosses
     # @option options [Symbol] tick_lbl_pos
     # @raise [ArgumentError] If axi_id or cross_ax are not unsigned integers
-    def initialize(ax_id, cross_ax, options={})
-      Axlsx::validate_unsigned_int(ax_id)
-      Axlsx::validate_unsigned_int(cross_ax)
-      @ax_id = ax_id
-      @cross_ax = cross_ax
+    def initialize(options={})
+      @id = rand(8 ** 8)
       @format_code = "General"
       @delete = @label_rotation = 0
       @scaling = Scaling.new(:orientation=>:minMax)
@@ -25,9 +23,7 @@ module Axlsx
       self.format_code = "General"
       self.crosses = :autoZero
       self.gridlines = true
-      options.each do |name, value|
-        self.send("#{name}=", value) if self.respond_to? "#{name}="
-      end
+      parse_options options
     end
 
     # the fill color to use in the axis shape properties. This should be a 6 character long hex string
@@ -37,13 +33,13 @@ module Axlsx
 
     # the id of the axis.
     # @return [Integer]
-    attr_reader :ax_id
-    alias :axID :ax_id
+    attr_reader :id
+    alias :axID :id
 
     # The perpendicular axis
     # @return [Integer]
-    attr_reader :cross_ax
-    alias :crossAx :cross_ax
+    attr_reader :cross_axis
+    alias :crossAx :cross_axis
 
     # The scaling of the axis
     # @see Scaling
@@ -94,6 +90,13 @@ module Axlsx
     def color=(color_rgb)
       @color = color_rgb
     end
+    
+    # The crossing axis for this axis
+    # @param [Axis] axis
+    def cross_axis=(axis)
+       DataTypeValidator.validate "#{self.class}.cross_axis", [Axis], axis
+       @cross_axis = axis
+    end
 
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
@@ -102,7 +105,7 @@ module Axlsx
 
     # the position of the tick labels
     # must be one of [:nextTo, :high, :low1]
-    def tick_lbl_pos=(v) RestrictionValidator.validate "#{self.class}.tick_lbl_pos", [:nextTo, :high, :low], v; @tick_lbl_pos = v; end
+    def tick_lbl_pos=(v) RestrictionValidator.validate "#{self.class}.tick_lbl_pos", [:nextTo, :high, :low, :none], v; @tick_lbl_pos = v; end
     alias :tickLblPos= :tick_lbl_pos=
 
     # The number format format code for this axis
@@ -147,7 +150,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<c:axId val="' << @ax_id.to_s << '"/>'
+      str << '<c:axId val="' << @id.to_s << '"/>'
       @scaling.to_xml_string str
       str << '<c:delete val="'<< @delete.to_s << '"/>'
       str << '<c:axPos val="' << @ax_pos.to_s << '"/>'
@@ -175,7 +178,7 @@ module Axlsx
       end
       # some potential value in implementing this in full. Very detailed!
       str << '<c:txPr><a:bodyPr rot="' << @label_rotation.to_s << '"/><a:lstStyle/><a:p><a:pPr><a:defRPr/></a:pPr><a:endParaRPr/></a:p></c:txPr>'
-      str << '<c:crossAx val="' << @cross_ax.to_s << '"/>'
+      str << '<c:crossAx val="' << @cross_axis.id.to_s << '"/>'
       str << '<c:crosses val="' << @crosses.to_s << '"/>'
     end