axlsx 1.0.12 → 1.0.13

data/lib/axlsx/stylesheet/table_style.rb

@@ -0,0 +1,47 @@
+module Axlsx
+  # A single table style definition and is a collection for tableStyleElements
+  # @note Table are not supported in this version and only the defaults required for a valid workbook are created.
+  class TableStyle < SimpleTypedList
+
+    # The name of this table style
+    # @return [string]
+    attr_reader :name
+
+    # indicates if this style should be applied to pivot tables
+    # @return [Boolean]
+    attr_reader :pivot
+
+    # indicates if this style should be applied to tables
+    # @return [Boolean]
+    attr_reader :table
+
+    # creates a new TableStyle object
+    # @raise [ArgumentError] if name option is not provided.
+    # @param [String] name
+    # @option options [Boolean] pivot
+    # @option options [Boolean] table
+    def initialize(name, options={})
+      self.name = name
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+      super TableStyleElement
+    end
+
+    # @see name
+    def name=(v) Axlsx::validate_string v; @name=v end
+    # @see pivot
+    def pivot=(v) Axlsx::validate_boolean v; @pivot=v end
+    # @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.
+    # @return [String]
+    def to_xml(xml)
+      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) } }
+    end
+  end
+end

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -0,0 +1,71 @@
+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. 
+  class TableStyleElement
+    # The type of style element. The following type are allowed
+    #   :wholeTable
+    #   :headerRow
+    #   :totalRow
+    #   :firstColumn
+    #   :lastColumn
+    #   :firstRowStripe
+    #   :secondRowStripe
+    #   :firstColumnStripe
+    #   :secondColumnStripe
+    #   :firstHeaderCell
+    #   :lastHeaderCell
+    #   :firstTotalCell
+    #   :lastTotalCell
+    #   :firstSubtotalColumn
+    #   :secondSubtotalColumn
+    #   :thirdSubtotalColumn
+    #   :firstSubtotalRow
+    #   :secondSubtotalRow
+    #   :thirdSubtotalRow
+    #   :blankRow
+    #   :firstColumnSubheading
+    #   :secondColumnSubheading
+    #   :thirdColumnSubheading
+    #   :firstRowSubheading
+    #   :secondRowSubheading
+    #   :thirdRowSubheading
+    #   :pageFieldLabels
+    #   :pageFieldValues
+    # @return [Symbol]
+    attr_reader :type
+
+    # Number of rows or columns used in striping when the type is firstRowStripe, secondRowStripe, firstColumnStripe, or secondColumnStripe.
+    # @return [Integer]
+    attr_reader :size
+
+    # The dxfId this style element points to 
+    # @return [Integer]
+    attr_reader :dxfId
+
+    # creates a new TableStyleElement object
+    # @option options [Symbol] type
+    # @option options [Integer] size
+    # @option options [Integer] dxfId
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+
+    # @see type
+    def type=(v) Axlsx::validate_table_element_type v; @type = v end
+
+    # @see size
+    def size=(v) Axlsx::validate_unsigned_int v; @size = v end
+
+    # @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.
+    # @return [String]
+    def to_xml(xml)
+      xml.tableStyleElement self.instance_values
+    end
+  end
+end

data/lib/axlsx/stylesheet/table_styles.rb

@@ -0,0 +1,39 @@
+module Axlsx
+  # TableStyles represents a collection of style definitions for table styles and pivot table styles.
+  # @note Support for custom table styles does not exist in this version. Many of the classes required are defined in preparation for future release. Please do not attempt to add custom table styles.
+  class TableStyles < SimpleTypedList
+
+    # The default table style. The default value is 'TableStyleMedium9'
+    # @return [String]
+    attr_reader :defaultTableStyle
+
+    # 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"      
+      super TableStyle
+    end
+    # @see defaultTableStyle
+    def defaultTableStyle=(v) Axlsx::validate_string(v); @defaultTableStyle = v; end
+    # @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.
+    # @return [String]
+    def to_xml(xml)
+      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) }
+      }
+    end
+  end
+
+end

data/lib/axlsx/stylesheet/xf.rb

@@ -0,0 +1,138 @@
+module Axlsx
+  # The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
+  # @see Styles#add_style
+  class Xf
+    #does not support extList (ExtensionList)
+
+    # The cell alignment for this style
+    # @return [CellAlignment]
+    # @see CellAlignment
+    attr_reader :alignment
+
+    # The cell protection for this style
+    # @return [CellProtection]
+    # @see CellProtection
+    attr_reader :protection
+
+    # id of the numFmt to apply to this style
+    # @return [Integer]
+    attr_reader :numFmtId
+
+    # 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
+
+    # index (0 based) of the border to be used in this style
+    # @return [Integer]
+    attr_reader :borderId
+
+    # index (0 based) of cellStylesXfs item to be used in this style. Only applies to cellXfs items
+    # @return [Integer]
+    attr_reader :xfId
+
+    # indecates if text should be prefixed by a single quote in the cell
+    # @return [Boolean]
+    attr_reader :quotePrefix
+
+    # indicates if the cell has a pivot table drop down button
+    # @return [Boolean]
+    attr_reader :pivotButton
+
+    # indicates if the numFmtId should be applied
+    # @return [Boolean]
+    attr_reader :applyNumberFormat
+
+    # indicates if the fontId should be applied
+    # @return [Boolean]
+    attr_reader :applyFont
+    
+    # indicates if the fillId should be applied
+    # @return [Boolean]
+    attr_reader :applyFill
+
+    # indicates if the borderId should be applied
+    # @return [Boolean]
+    attr_reader :applyBorder
+
+    # Indicates if the alignment options should be applied
+    # @return [Boolean]
+    attr_reader :applyAlignment
+
+    # Indicates if the protection options should be applied
+    # @return [Boolean]
+    attr_reader :applyProtection
+
+    # Creates a new Xf object
+    # @option options [Integer] numFmtId
+    # @option options [Integer] fontId
+    # @option options [Integer] fillId
+    # @option options [Integer] borderId
+    # @option options [Integer] xfId
+    # @option options [Boolean] quotePrefix
+    # @option options [Boolean] pivotButton
+    # @option options [Boolean] applyNumberFormat 
+    # @option options [Boolean] applyFont
+    # @option options [Boolean] applyFill
+    # @option options [Boolean] applyBorder
+    # @option options [Boolean] applyAlignment
+    # @option options [Boolean] applyProtection
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end    
+    
+    # @see Xf#alignment
+    def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
+
+    # @see protection
+    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    
+
+    # @see fontId
+    def fontId=(v) Axlsx::validate_unsigned_int v; @fontId = v end    
+    # @see fillId
+    def fillId=(v) Axlsx::validate_unsigned_int v; @fillId = v end    
+    # @see borderId
+    def borderId=(v) Axlsx::validate_unsigned_int v; @borderId = v end    
+    # @see xfId
+    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end    
+    # @see quotePrefix
+    def quotePrefix=(v) Axlsx::validate_boolean v; @quotePrefix = v end    
+    # @see pivotButton
+    def pivotButton=(v) Axlsx::validate_boolean v; @pivotButton = v end    
+    # @see applyNumberFormat
+    def applyNumberFormat=(v) Axlsx::validate_boolean v; @applyNumberFormat = v end    
+    # @see applyFont
+    def applyFont=(v) Axlsx::validate_boolean v; @applyFont = v end    
+    # @see applyFill
+    def applyFill=(v) Axlsx::validate_boolean v; @applyFill = v end    
+
+    # @see applyBorder
+    def applyBorder=(v) Axlsx::validate_boolean v; @applyBorder = v end    
+
+    # @see applyAlignment
+    def applyAlignment=(v) Axlsx::validate_boolean v; @applyAlignment = v end    
+
+    # @see applyProtection
+    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.
+    # @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
+      }
+    end
+  end
+end

data/lib/axlsx/util/constants.rb

@@ -0,0 +1,220 @@
+module Axlsx
+
+  # XML Encoding
+  ENCODING = "UTF-8"
+
+  # spreadsheetML namespace
+  XML_NS = "http://schemas.openxmlformats.org/spreadsheetml/2006/main"
+
+  # content-types namespace
+  XML_NS_T = "http://schemas.openxmlformats.org/package/2006/content-types"
+
+  # extended-properties namespace
+  APP_NS = "http://schemas.openxmlformats.org/officeDocument/2006/extended-properties"
+
+  XML_NS_MC="http://schemas.openxmlformats.org/markup-compatibility/2006" 
+
+  XML_NS_X14AC = "http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac"
+
+  # doc props namespace
+  APP_NS_VT = "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"
+
+  # core properties namespace
+  CORE_NS = "http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
+
+  # dc elements (core) namespace
+  CORE_NS_DC = "http://purl.org/dc/elements/1.1/"
+  
+  # dcmit (core) namespcace
+  CORE_NS_DCMIT = "http://purl.org/dc/dcmitype/"
+
+  # dc terms namespace
+  CORE_NS_DCT = "http://purl.org/dc/terms/"
+
+  # xml schema namespace
+  CORE_NS_XSI = "http://www.w3.org/2001/XMLSchema-instance"
+  
+  # spreadsheet drawing namespace
+  XML_NS_XDR = "http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"
+  
+  # drawing namespace
+  XML_NS_A  = "http://schemas.openxmlformats.org/drawingml/2006/main"
+
+  # chart namespace
+  XML_NS_C  = "http://schemas.openxmlformats.org/drawingml/2006/chart"
+
+  # relationships namespace
+  XML_NS_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+
+
+  # relationships name space
+  RELS_R = "http://schemas.openxmlformats.org/package/2006/relationships"
+
+  # table rels namespace
+  TABLE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/table"
+  
+  # workbook rels namespace
+  WORKBOOK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
+
+  # worksheet rels namespace
+  WORKSHEET_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"
+
+  # app rels namespace
+  APP_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties"
+
+  # core rels namespace
+  CORE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties"
+
+  # styles rels namespace
+  STYLES_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"
+
+  # drawing rels namespace
+  DRAWING_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"
+
+  # chart rels namespace
+  CHART_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart"
+
+  # image rels namespace
+  IMAGE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
+
+  # table content type 
+  TABLE_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"
+
+  # workbook content type
+  WORKBOOK_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"
+
+  # app content type
+  APP_CT = "application/vnd.openxmlformats-officedocument.extended-properties+xml"
+
+  # rels content type
+  RELS_CT = "application/vnd.openxmlformats-package.relationships+xml"  
+
+  # styles content type
+  STYLES_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"
+
+  # xml content type
+  XML_CT = "application/xml"
+  
+  # worksheet content type
+  WORKSHEET_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"
+
+  # shared strings content type
+  SHARED_STRINGS_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"
+
+  # core content type
+  CORE_CT = "application/vnd.openxmlformats-package.core-properties+xml"
+
+  # chart content type
+  CHART_CT = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml"
+
+  # jpeg content type
+  JPEG_CT = "image/jpeg"
+
+  # gif content type
+  GIF_CT = "image/gif"
+
+  # png content type
+  PNG_CT = "image/png"
+
+  #drawing content type
+  DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml"
+
+  # xml content type extensions
+  XML_EX = "xml"
+
+  # jpeg extension
+  JPEG_EX = "jpeg"
+  
+  # gif extension
+  GIF_EX = "gif"
+
+  # png extension
+  PNG_EX = "png"
+
+  # rels content type extension
+  RELS_EX = "rels"
+
+  # workbook part
+  WORKBOOK_PN = "xl/workbook.xml"
+
+  # styles part
+  STYLES_PN = "styles.xml"
+  
+  # app part
+  APP_PN = "docProps/app.xml"
+  
+  # core part
+  CORE_PN = "docProps/core.xml"
+
+  # content types part
+  CONTENT_TYPES_PN = "[Content_Types].xml"
+
+  # rels part
+  RELS_PN = "_rels/.rels"
+
+  # workbook rels part
+  WORKBOOK_RELS_PN = "xl/_rels/workbook.xml.rels"
+
+  # worksheet part
+  WORKSHEET_PN = "worksheets/sheet%d.xml"
+
+  # worksheet rels part
+  WORKSHEET_RELS_PN = "worksheets/_rels/sheet%d.xml.rels"
+
+  # drawing part
+  DRAWING_PN = "drawings/drawing%d.xml"
+
+  # drawing rels part
+  DRAWING_RELS_PN = "drawings/_rels/drawing%d.xml.rels"
+
+  # chart part
+  CHART_PN = "charts/chart%d.xml"
+
+  # chart part
+  IMAGE_PN = "media/image%d.%s"
+
+  # App validation schema
+  APP_XSD = "lib/schema/shared-documentPropertiesExtended.xsd"
+
+  # core validation schema
+  CORE_XSD = "lib/schema/opc-coreProperties.xsd"
+
+  # content types validation schema
+  CONTENT_TYPES_XSD = "lib/schema/opc-contentTypes.xsd"
+
+  # rels validation schema
+  RELS_XSD = "lib/schema/opc-relationships.xsd"
+
+  # spreadsheetML validation schema
+  SML_XSD = "lib/schema/sml.xsd"
+  
+  # drawing validation schema
+  DRAWING_XSD = "lib/schema/dml-spreadsheetDrawing.xsd"
+
+  # number format id for pecentage formatting using the default formatting id.
+  NUM_FMT_PERCENT = 9 
+
+  # number format id for date format like 2011/11/13
+  NUM_FMT_YYYYMMDD = 100
+
+  # number format id for time format the creates 2011/11/13 12:23:10
+  NUM_FMT_YYYYMMDDHHMMSS = 101
+
+  # cellXfs id for thin borders around the cell
+  STYLE_THIN_BORDER = 1
+
+  # cellXfs id for default date styling
+  STYLE_DATE = 2
+
+  # error messages RestrictionValidor
+  ERR_RESTRICTION = "Invalid Data: %s. %s must be one of %s." 
+
+  # error message DataTypeValidator
+  ERR_TYPE = "Invalid Data %s for %s. must be %s."
+
+  # error message for RegexValidator
+  ERR_REGEX = "Invalid Data. %s does not match %s."
+
+  # error message for duplicate sheet names
+  ERR_DUPLICATE_SHEET_NAME = "There is already a worksheet in this workbook named '%s'. Please use a unique name"
+end