caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/stylesheet/table_style.rb

@@ -1,54 +1,51 @@
-# encoding: UTF-8
-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
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # 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
-      parse_options options
-      super TableStyleElement
-    end
-
-    serializable_attributes :name, :pivot, :table
-
-    # 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
-
-    # @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 object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<tableStyle '
-      serialized_attributes str, {:count => self.size}
-      str << '>'
-      each { |table_style_el| table_style_el.to_xml_string(str) }
-      str << '</tableStyle>'
-    end
-
-  end
-end
+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
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # 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
+      parse_options options
+      super TableStyleElement
+    end
+
+    serializable_attributes :name, :pivot, :table
+
+    # 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
+
+    # @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 object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<tableStyle '
+      serialized_attributes str, { :count => self.size }
+      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,77 +1,74 @@
-# 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.
-  class TableStyleElement
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # creates a new TableStyleElement object
-    # @option options [Symbol] type
-    # @option options [Integer] size
-    # @option options [Integer] dxfId
-    def initialize(options={})
-      parse_options options
-    end
-
-    serializable_attributes :type, :size, :dxfId
-
-    # 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
-
-    # @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 object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('tableStyleElement', str)
-    end
-
-  end
-end
+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
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # creates a new TableStyleElement object
+    # @option options [Symbol] type
+    # @option options [Integer] size
+    # @option options [Integer] dxfId
+    def initialize(options = {})
+      parse_options options
+    end
+
+    serializable_attributes :type, :size, :dxfId
+
+    # 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
+
+    # @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 object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('tableStyleElement', str)
+    end
+  end
+end

data/lib/axlsx/stylesheet/table_styles.rb

@@ -1,46 +1,42 @@
-# encoding: UTF-8
-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
-
-    include Axlsx::SerializedAttributes
-
-    # 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
-
-    serializable_attributes :defaultTableStyle, :defaultPivotStyle
-
-    # 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
-
-   # @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 object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<tableStyles '
-      serialized_attributes str, {:count => self.size }
-      str << '>'
-      each { |table_style| table_style.to_xml_string(str) }
-      str << '</tableStyles>'
-    end
-
-  end
-
-end
+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
+    include Axlsx::SerializedAttributes
+
+    # 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
+
+    serializable_attributes :defaultTableStyle, :defaultPivotStyle
+
+    # 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
+
+    # @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 object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<tableStyles '
+      serialized_attributes str, { :count => self.size }
+      str << '>'
+      each { |table_style| table_style.to_xml_string(str) }
+      str << '</tableStyles>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/xf.rb

@@ -1,147 +1,144 @@
-# encoding: UTF-8
-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)
-
-    include Axlsx::SerializedAttributes
-    include Axlsx::OptionsParser
-    # 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={})
-      parse_options options
-    end
-
-    serializable_attributes :numFmtId, :fontId, :fillId, :borderId, :xfId, :quotePrefix,
-                            :pivotButton, :applyNumberFormat, :applyFont, :applyFill, :applyBorder, :applyAlignment,
-                            :applyProtection
-
-    # 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
-
-      # @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 object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<xf '
-      serialized_attributes str
-      str << '>'
-      alignment.to_xml_string(str) if self.alignment
-      protection.to_xml_string(str) if self.protection
-      str << '</xf>'
-    end
-
-
-  end
-end
+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)
+
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    # 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 = {})
+      parse_options options
+    end
+
+    serializable_attributes :numFmtId, :fontId, :fillId, :borderId, :xfId, :quotePrefix,
+                            :pivotButton, :applyNumberFormat, :applyFont, :applyFill, :applyBorder, :applyAlignment,
+                            :applyProtection
+
+    # 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
+
+    # @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 object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<xf '
+      serialized_attributes str
+      str << '>'
+      alignment.to_xml_string(str) if self.alignment
+      protection.to_xml_string(str) if self.protection
+      str << '</xf>'
+    end
+  end
+end