caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/stylesheet/dxf.rb

@@ -1,79 +1,75 @@
-# encoding: UTF-8
-module Axlsx
-  # The Dxf class defines an incremental 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 Dxf
-
-    include Axlsx::OptionsParser
-
-    # The order in which the child elements is put in the XML seems to
-    # be important for Excel
-    CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
-    #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
-
-    # the child NumFmt to be used to this style
-    # @return [NumFmt]
-    attr_reader :numFmt
-
-    # the child font to be used for this style
-    # @return [Font]
-    attr_reader :font
-
-    # the child fill to be used in this style
-    # @return [Fill]
-    attr_reader :fill
-
-    # the border to be used in this style
-    # @return [Border]
-    attr_reader :border
-
-    # Creates a new Xf object
-    # @option options [Border] border
-    # @option options [NumFmt] numFmt
-    # @option options [Fill] fill
-    # @option options [Font] font
-    # @option options [CellAlignment] alignment
-    # @option options [CellProtection] protection
-    def initialize(options={})
-      parse_options options
-    end
-
-    # @see Dxf#alignment
-    def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
-    # @see protection
-    def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
-    # @see numFmt
-    def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
-    # @see font
-    def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
-    # @see border
-    def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
-    # @see fill
-    def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<dxf>'
-      # Dxf elements have no attributes. All of the instance variables
-      # are child elements.
-      CHILD_ELEMENTS.each do |element|
-        self.send(element).to_xml_string(str) if self.send(element)
-      end
-      str << '</dxf>'
-    end
-
-  end
-
-end
+module Axlsx
+  # The Dxf class defines an incremental 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 Dxf
+    include Axlsx::OptionsParser
+
+    # The order in which the child elements is put in the XML seems to
+    # be important for Excel
+    CHILD_ELEMENTS = [:font, :numFmt, :fill, :alignment, :border, :protection]
+    # 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
+
+    # the child NumFmt to be used to this style
+    # @return [NumFmt]
+    attr_reader :numFmt
+
+    # the child font to be used for this style
+    # @return [Font]
+    attr_reader :font
+
+    # the child fill to be used in this style
+    # @return [Fill]
+    attr_reader :fill
+
+    # the border to be used in this style
+    # @return [Border]
+    attr_reader :border
+
+    # Creates a new Xf object
+    # @option options [Border] border
+    # @option options [NumFmt] numFmt
+    # @option options [Fill] fill
+    # @option options [Font] font
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # @see Dxf#alignment
+    def alignment=(v) DataTypeValidator.validate "Dxf.alignment", CellAlignment, v; @alignment = v end
+    # @see protection
+    def protection=(v) DataTypeValidator.validate "Dxf.protection", CellProtection, v; @protection = v end
+    # @see numFmt
+    def numFmt=(v) DataTypeValidator.validate "Dxf.numFmt", NumFmt, v; @numFmt = v end
+    # @see font
+    def font=(v) DataTypeValidator.validate "Dxf.font", Font, v; @font = v end
+    # @see border
+    def border=(v) DataTypeValidator.validate "Dxf.border", Border, v; @border = v end
+    # @see fill
+    def fill=(v) DataTypeValidator.validate "Dxf.fill", Fill, v; @fill = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<dxf>'
+      # Dxf elements have no attributes. All of the instance variables
+      # are child elements.
+      CHILD_ELEMENTS.each do |element|
+        self.send(element).to_xml_string(str) if self.send(element)
+      end
+      str << '</dxf>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/fill.rb

@@ -1,35 +1,31 @@
-# encoding: UTF-8
-module Axlsx
-  # The Fill is a formatting object that manages the background color, and pattern for cells.
-  # @note The recommended way to manage styles in your workbook is to use Styles#add_style.
-  # @see Styles#add_style
-  # @see PatternFill
-  # @see GradientFill
-  class Fill
-
-    # The type of fill
-    # @return [PatternFill, GradientFill]
-    attr_reader :fill_type
-
-    # Creates a new Fill object
-    # @param [PatternFill, GradientFill] fill_type
-    # @raise [ArgumentError] if the fill_type parameter is not a PatternFill or a GradientFill instance
-    def initialize(fill_type)
-      self.fill_type = fill_type
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<fill>'
-      @fill_type.to_xml_string(str)
-      str << '</fill>'
-    end
-
-    # @see fill_type
-    def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
-
-
-  end
-end
+module Axlsx
+  # The Fill is a formatting object that manages the background color, and pattern for cells.
+  # @note The recommended way to manage styles in your workbook is to use Styles#add_style.
+  # @see Styles#add_style
+  # @see PatternFill
+  # @see GradientFill
+  class Fill
+    # The type of fill
+    # @return [PatternFill, GradientFill]
+    attr_reader :fill_type
+
+    # Creates a new Fill object
+    # @param [PatternFill, GradientFill] fill_type
+    # @raise [ArgumentError] if the fill_type parameter is not a PatternFill or a GradientFill instance
+    def initialize(fill_type)
+      self.fill_type = fill_type
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<fill>'
+      @fill_type.to_xml_string(str)
+      str << '</fill>'
+    end
+
+    # @see fill_type
+    def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
+  end
+end

data/lib/axlsx/stylesheet/font.rb

@@ -1,156 +1,157 @@
-# encoding: UTF-8
-module Axlsx
-  # The Font class details a font instance for use in styling cells.
-  # @note The recommended way to manage fonts, and other styles is Styles#add_style
-  # @see Styles#add_style
-  class Font
-    include Axlsx::OptionsParser
-
-    # Creates a new Font
-    # @option options [String] name
-    # @option options [Integer] charset
-    # @option options [Integer] family
-    # @option options [Integer] family
-    # @option options [Boolean] b
-    # @option options [Boolean] i
-    # @option options [Boolean] u
-    # @option options [Boolean] strike
-    # @option options [Boolean] outline
-    # @option options [Boolean] shadow
-    # @option options [Boolean] condense
-    # @option options [Boolean] extend
-    # @option options [Color] color
-    # @option options [Integer] sz
-    def initialize(options={})
-      parse_options options
-    end
-
-    # The name of the font
-    # @return [String]
-    attr_reader :name
-
-    # The charset of the font
-    # @return [Integer]
-    # @note
-    #  The following values are defined in the OOXML specification and are OS dependant values
-    #   0   ANSI_CHARSET
-    #   1   DEFAULT_CHARSET
-    #   2   SYMBOL_CHARSET
-    #   77  MAC_CHARSET
-    #   128 SHIFTJIS_CHARSET
-    #   129 HANGUL_CHARSET
-    #   130 JOHAB_CHARSET
-    #   134 GB2312_CHARSET
-    #   136 CHINESEBIG5_CHARSET
-    #   161 GREEK_CHARSET
-    #   162 TURKISH_CHARSET
-    #   163 VIETNAMESE_CHARSET
-    #   177 HEBREW_CHARSET
-    #   178 ARABIC_CHARSET
-    #   186 BALTIC_CHARSET
-    #   204 RUSSIAN_CHARSET
-    #   222 THAI_CHARSET
-    #   238 EASTEUROPE_CHARSET
-    #   255 OEM_CHARSET
-    attr_reader :charset
-
-    # The font's family
-    # @note
-    #  The following are defined OOXML specification
-    #   0 Not applicable.
-    #   1 Roman
-    #   2 Swiss
-    #   3 Modern
-    #   4 Script
-    #   5 Decorative
-    #   6..14 Reserved for future use
-    # @return [Integer]
-    attr_reader :family
-
-    # Indicates if the font should be rendered in *bold*
-    # @return [Boolean]
-    attr_reader :b
-
-    # Indicates if the font should be rendered italicized
-    # @return [Boolean]
-    attr_reader :i
-
-    # Indicates if the font should be rendered underlined
-    # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting, true, false
-    # @return [String]
-    # @note
-    #  true or false is for backwards compatibility and is reassigned to :single or :none respectively
-    attr_reader :u
-
-    # Indicates if the font should be rendered with a strikthrough
-    # @return [Boolean]
-    attr_reader :strike
-
-    # Indicates if the font should be rendered with an outline
-    # @return [Boolean]
-    attr_reader :outline
-
-    # Indicates if the font should be rendered with a shadow
-    # @return [Boolean]
-    attr_reader :shadow
-
-    # Indicates if the font should be condensed
-    # @return [Boolean]
-    attr_reader :condense
-
-    # The font's extend property
-    # @return [Boolean]
-    attr_reader  :extend
-
-    # The color of the font
-    # @return [Color]
-    attr_reader :color
-
-    # The size of the font.
-    # @return [Integer]
-    attr_reader :sz
-
-     # @see name
-    def name=(v) Axlsx::validate_string v; @name = v end
-    # @see charset
-    def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
-    # @see family
-    def family=(v) Axlsx::validate_unsigned_int v; @family = v end
-    # @see b
-    def b=(v) Axlsx::validate_boolean v; @b = v end
-    # @see i
-    def i=(v) Axlsx::validate_boolean v; @i = v end
-    # @see u
-    def u=(v)
-      v = :single if (v == true || v == 1 || v == :true || v == 'true')
-      v = :none if (v == false || v == 0 || v == :false || v == 'false')
-      Axlsx::validate_cell_u v
-      @u = v
-    end
-    # @see strike
-    def strike=(v) Axlsx::validate_boolean v; @strike = v end
-    # @see outline
-    def outline=(v) Axlsx::validate_boolean v; @outline = v end
-    # @see shadow
-    def shadow=(v) Axlsx::validate_boolean v; @shadow = v end
-    # @see condense
-    def condense=(v) Axlsx::validate_boolean v; @condense = v end
-    # @see extend
-    def extend=(v) Axlsx::validate_boolean v; @extend = v end
-    # @see color
-    def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color=v end
-    # @see sz
-    def sz=(v) Axlsx::validate_unsigned_int v; @sz=v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<font>'
-      instance_values.each do |k, v|
-        v.is_a?(Color) ? v.to_xml_string(str) : (str << ('<' << k.to_s << ' val="' << Axlsx.booleanize(v).to_s << '"/>'))
-      end
-      str << '</font>'
-    end
-  end
-end
+module Axlsx
+  # The Font class details a font instance for use in styling cells.
+  # @note The recommended way to manage fonts, and other styles is Styles#add_style
+  # @see Styles#add_style
+  class Font
+    include Axlsx::OptionsParser
+
+    # Creates a new Font
+    # @option options [String] name
+    # @option options [Integer] charset
+    # @option options [Integer] family
+    # @option options [Integer] family
+    # @option options [Boolean] b
+    # @option options [Boolean] i
+    # @option options [Boolean] u
+    # @option options [Boolean] strike
+    # @option options [Boolean] outline
+    # @option options [Boolean] shadow
+    # @option options [Boolean] condense
+    # @option options [Boolean] extend
+    # @option options [Color] color
+    # @option options [Integer] sz
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # The name of the font
+    # @return [String]
+    attr_reader :name
+
+    # The charset of the font
+    # @return [Integer]
+    # @note
+    #  The following values are defined in the OOXML specification and are OS dependant values
+    #   0   ANSI_CHARSET
+    #   1   DEFAULT_CHARSET
+    #   2   SYMBOL_CHARSET
+    #   77  MAC_CHARSET
+    #   128 SHIFTJIS_CHARSET
+    #   129 HANGUL_CHARSET
+    #   130 JOHAB_CHARSET
+    #   134 GB2312_CHARSET
+    #   136 CHINESEBIG5_CHARSET
+    #   161 GREEK_CHARSET
+    #   162 TURKISH_CHARSET
+    #   163 VIETNAMESE_CHARSET
+    #   177 HEBREW_CHARSET
+    #   178 ARABIC_CHARSET
+    #   186 BALTIC_CHARSET
+    #   204 RUSSIAN_CHARSET
+    #   222 THAI_CHARSET
+    #   238 EASTEUROPE_CHARSET
+    #   255 OEM_CHARSET
+    attr_reader :charset
+
+    # The font's family
+    # @note
+    #  The following are defined OOXML specification
+    #   0 Not applicable.
+    #   1 Roman
+    #   2 Swiss
+    #   3 Modern
+    #   4 Script
+    #   5 Decorative
+    #   6..14 Reserved for future use
+    # @return [Integer]
+    attr_reader :family
+
+    # Indicates if the font should be rendered in *bold*
+    # @return [Boolean]
+    attr_reader :b
+
+    # Indicates if the font should be rendered italicized
+    # @return [Boolean]
+    attr_reader :i
+
+    # Indicates if the font should be rendered underlined
+    # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting, true, false
+    # @return [String]
+    # @note
+    #  true or false is for backwards compatibility and is reassigned to :single or :none respectively
+    attr_reader :u
+
+    # Indicates if the font should be rendered with a strikthrough
+    # @return [Boolean]
+    attr_reader :strike
+
+    # Indicates if the font should be rendered with an outline
+    # @return [Boolean]
+    attr_reader :outline
+
+    # Indicates if the font should be rendered with a shadow
+    # @return [Boolean]
+    attr_reader :shadow
+
+    # Indicates if the font should be condensed
+    # @return [Boolean]
+    attr_reader :condense
+
+    # The font's extend property
+    # @return [Boolean]
+    attr_reader :extend
+
+    # The color of the font
+    # @return [Color]
+    attr_reader :color
+
+    # The size of the font.
+    # @return [Integer]
+    attr_reader :sz
+
+    # @see name
+    def name=(v) Axlsx::validate_string v; @name = v end
+    # @see charset
+    def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
+    # @see family
+    def family=(v) Axlsx::validate_unsigned_int v; @family = v end
+    # @see b
+    def b=(v) Axlsx::validate_boolean v; @b = v end
+    # @see i
+    def i=(v) Axlsx::validate_boolean v; @i = v end
+
+    # @see u
+    def u=(v)
+      v = :single if (v == true || v == 1 || v == :true || v == 'true')
+      v = :none if (v == false || v == 0 || v == :false || v == 'false')
+      Axlsx::validate_cell_u v
+      @u = v
+    end
+
+    # @see strike
+    def strike=(v) Axlsx::validate_boolean v; @strike = v end
+    # @see outline
+    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+    # @see shadow
+    def shadow=(v) Axlsx::validate_boolean v; @shadow = v end
+    # @see condense
+    def condense=(v) Axlsx::validate_boolean v; @condense = v end
+    # @see extend
+    def extend=(v) Axlsx::validate_boolean v; @extend = v end
+    # @see color
+    def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color = v end
+    # @see sz
+    def sz=(v) Axlsx::validate_unsigned_int v; @sz = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<font>'
+      Axlsx.instance_values_for(self).each do |k, v|
+        v.is_a?(Color) ? v.to_xml_string(str) : (str << ('<' << k.to_s << ' val="' << Axlsx.booleanize(v).to_s << '"/>'))
+      end
+      str << '</font>'
+    end
+  end
+end