caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -1,103 +1,101 @@
-# encoding: UTF-8
-module Axlsx
-  # A GradientFill defines the color and positioning for gradiant cell fill.
-  # @see Open Office XML Part 1 §18.8.24
-  class GradientFill
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creates a new GradientFill object
-    # @option options [Symbol] type
-    # @option options [Float] degree
-    # @option options [Float] left
-    # @option options [Float] right
-    # @option options [Float] top
-    # @option options [Float] bottom
-    def initialize(options={})
-      options[:type] ||= :linear
-      parse_options options
-      @stop = SimpleTypedList.new GradientStop
-    end
-
-    serializable_attributes :type, :degree, :left, :right, :top, :bottom
-
-    # The type of gradient.
-    # @note
-    #  valid options are
-    #   :linear
-    #   :path
-    # @return [Symbol]
-    attr_reader :type
-
-    # Angle of the linear gradient
-    # @return [Float]
-    attr_reader :degree
-
-    # Percentage format left
-    # @return [Float]
-    attr_reader :left
-
-    # Percentage format right
-    # @return [Float]
-    attr_reader :right
-
-    # Percentage format top
-    # @return [Float]
-    attr_reader :top
-
-    # Percentage format bottom
-    # @return [Float]
-    attr_reader :bottom
-
-    # Collection of stop objects
-    # @return [SimpleTypedList]
-    attr_reader :stop
-
-    # @see type
-    def type=(v) Axlsx::validate_gradient_type v; @type = v end
-
-    # @see degree
-    def degree=(v) Axlsx::validate_float v; @degree = v end
-
-    # @see left
-    def left=(v)
-      validate_format_percentage "GradientFill.left", v
-      @left = v
-    end
-
-    # @see right
-    def right=(v)
-     validate_format_percentage "GradientFill.right", v
-     @right = v
-    end
-
-    # @see top
-    def top=(v)
-      validate_format_percentage "GradientFill.top", v
-      @top = v
-    end
-
-    # @see bottom
-    def bottom=(v)
-      validate_format_percentage "GradientFill.bottom", v
-      @bottom = v
-    end
-
-    # validates that the value provided is between 0.0 and 1.0
-    def validate_format_percentage(name, value)
-      DataTypeValidator.validate name, Float, value, lambda { |arg| arg >= 0.0 && arg <= 1.0}
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<gradientFill '
-      serialized_attributes str
-      str << '>'
-      @stop.each { |s| s.to_xml_string(str) }
-      str << '</gradientFill>'
-    end
-  end
-end
+module Axlsx
+  # A GradientFill defines the color and positioning for gradiant cell fill.
+  # @see Open Office XML Part 1 §18.8.24
+  class GradientFill
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new GradientFill object
+    # @option options [Symbol] type
+    # @option options [Float] degree
+    # @option options [Float] left
+    # @option options [Float] right
+    # @option options [Float] top
+    # @option options [Float] bottom
+    def initialize(options = {})
+      options[:type] ||= :linear
+      parse_options options
+      @stop = SimpleTypedList.new GradientStop
+    end
+
+    serializable_attributes :type, :degree, :left, :right, :top, :bottom
+
+    # The type of gradient.
+    # @note
+    #  valid options are
+    #   :linear
+    #   :path
+    # @return [Symbol]
+    attr_reader :type
+
+    # Angle of the linear gradient
+    # @return [Float]
+    attr_reader :degree
+
+    # Percentage format left
+    # @return [Float]
+    attr_reader :left
+
+    # Percentage format right
+    # @return [Float]
+    attr_reader :right
+
+    # Percentage format top
+    # @return [Float]
+    attr_reader :top
+
+    # Percentage format bottom
+    # @return [Float]
+    attr_reader :bottom
+
+    # Collection of stop objects
+    # @return [SimpleTypedList]
+    attr_reader :stop
+
+    # @see type
+    def type=(v) Axlsx::validate_gradient_type v; @type = v end
+
+    # @see degree
+    def degree=(v) Axlsx::validate_float v; @degree = v end
+
+    # @see left
+    def left=(v)
+      validate_format_percentage "GradientFill.left", v
+      @left = v
+    end
+
+    # @see right
+    def right=(v)
+      validate_format_percentage "GradientFill.right", v
+      @right = v
+    end
+
+    # @see top
+    def top=(v)
+      validate_format_percentage "GradientFill.top", v
+      @top = v
+    end
+
+    # @see bottom
+    def bottom=(v)
+      validate_format_percentage "GradientFill.bottom", v
+      @bottom = v
+    end
+
+    # validates that the value provided is between 0.0 and 1.0
+    def validate_format_percentage(name, value)
+      DataTypeValidator.validate name, Float, value, lambda { |arg| arg >= 0.0 && arg <= 1.0 }
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<gradientFill '
+      serialized_attributes str
+      str << '>'
+      @stop.each { |s| s.to_xml_string(str) }
+      str << '</gradientFill>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -1,37 +1,36 @@
-# encoding: UTF-8
-module Axlsx
-  # The GradientStop object represents a color point in a gradient.
-  # @see Open Office XML Part 1 §18.8.24
-  class GradientStop
-    # The color for this gradient stop
-    # @return [Color]
-    # @see Color
-    attr_reader :color
-
-    # The position of the color
-    # @return [Float]
-    attr_reader :position
-
-    # Creates a new GradientStop object
-    # @param [Color] color
-    # @param [Float] position
-    def initialize(color, position)
-      self.color = color
-      self.position = position
-    end
-
-    # @see color
-    def color=(v) DataTypeValidator.validate "GradientStop.color", Color, v; @color=v end
-    # @see position
-    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |arg| arg >= 0 && arg <= 1}; @position = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << ('<stop position="' << position.to_s << '">')
-      self.color.to_xml_string(str)
-      str << '</stop>'
-    end
-  end
-end
+module Axlsx
+  # The GradientStop object represents a color point in a gradient.
+  # @see Open Office XML Part 1 §18.8.24
+  class GradientStop
+    # The color for this gradient stop
+    # @return [Color]
+    # @see Color
+    attr_reader :color
+
+    # The position of the color
+    # @return [Float]
+    attr_reader :position
+
+    # Creates a new GradientStop object
+    # @param [Color] color
+    # @param [Float] position
+    def initialize(color, position)
+      self.color = color
+      self.position = position
+    end
+
+    # @see color
+    def color=(v) DataTypeValidator.validate "GradientStop.color", Color, v; @color = v end
+    # @see position
+    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |arg| arg >= 0 && arg <= 1 }; @position = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << ('<stop position="' << position.to_s << '">')
+      self.color.to_xml_string(str)
+      str << '</stop>'
+    end
+  end
+end

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -1,86 +1,83 @@
-# encoding: UTF-8
-module Axlsx
-  # A NumFmt object defines an identifier and formatting code for data in cells.
-  # @note The recommended way to manage styles is Styles#add_style
-  class NumFmt
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creates a new NumFmt object
-    # @param [Hash] options Options for the number format object
-    # @option [Integer] numFmtId The predefined format id or new format id for this format
-    # @option [String] formatCode The format code for this number format
-    def initialize(options={})
-      @numFmtId = 0
-      @formatCode = ""
-      parse_options options
-    end
-
-    serializable_attributes :formatCode, :numFmtId
-
-    # @return [String] The formatting to use for this number format.
-    # @see http://support.microsoft.com/kb/264372
-    attr_reader :formatCode
-
-    # @return [Integer] An unsigned integer referencing a standard or custom number format.
-    # @note
-    #  These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and NUM_FRM_YYYYMMDDHHMMSS.
-    #   1 0
-    #   2 0.00
-    #   3 #,##0
-    #   4 #,##0.00
-    #   5 $#,##0_);($#,##0)
-    #   6 $#,##0_);[Red]($#,##0)
-    #   7 $#,##0.00_);($#,##0.00)
-    #   8 $#,##0.00_);[Red]($#,##0.00)
-    #   9 0%
-    #   10 0.00%
-    #   11 0.00E+00
-    #   12 # ?/?
-    #   13 # ??/??
-    #   14 m/d/yyyy
-    #   15 d-mmm-yy
-    #   16 d-mmm
-    #   17 mmm-yy
-    #   18 h:mm AM/PM
-    #   19 h:mm:ss AM/PM
-    #   20 h:mm
-    #   21 h:mm:ss
-    #   22 m/d/yyyy h:mm
-    #   37 #,##0_);(#,##0)
-    #   38 #,##0_);[Red](#,##0)
-    #   39 #,##0.00_);(#,##0.00)
-    #   40 #,##0.00_);[Red](#,##0.00)
-    #   45 mm:ss
-    #   46 [h]:mm:ss
-    #   47 mm:ss.0
-    #   48 ##0.0E+0
-    #   49 @
-    # @see Axlsx
-    attr_reader :numFmtId
-
-    # @see numFmtId
-    def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
-
-    # @see formatCode
-    def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('numFmt', str)
-    end
-
-    # Override to avoid removing underscores
-    def serialized_attributes(str = '', additional_attributes = {})
-      attributes = declared_attributes.merge! additional_attributes
-      attributes.each do |key, value|
-        str << "#{Axlsx.camel(key, false)}=\"#{Axlsx.booleanize(value)}\" "
-      end
-      str
-    end
-
-  end
-end
+module Axlsx
+  # A NumFmt object defines an identifier and formatting code for data in cells.
+  # @note The recommended way to manage styles is Styles#add_style
+  class NumFmt
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new NumFmt object
+    # @param [Hash] options Options for the number format object
+    # @option [Integer] numFmtId The predefined format id or new format id for this format
+    # @option [String] formatCode The format code for this number format
+    def initialize(options = {})
+      @numFmtId = 0
+      @formatCode = ""
+      parse_options options
+    end
+
+    serializable_attributes :formatCode, :numFmtId
+
+    # @return [String] The formatting to use for this number format.
+    # @see http://support.microsoft.com/kb/264372
+    attr_reader :formatCode
+
+    # @return [Integer] An unsigned integer referencing a standard or custom number format.
+    # @note
+    #  These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and NUM_FRM_YYYYMMDDHHMMSS.
+    #   1 0
+    #   2 0.00
+    #   3 #,##0
+    #   4 #,##0.00
+    #   5 $#,##0_);($#,##0)
+    #   6 $#,##0_);[Red]($#,##0)
+    #   7 $#,##0.00_);($#,##0.00)
+    #   8 $#,##0.00_);[Red]($#,##0.00)
+    #   9 0%
+    #   10 0.00%
+    #   11 0.00E+00
+    #   12 # ?/?
+    #   13 # ??/??
+    #   14 m/d/yyyy
+    #   15 d-mmm-yy
+    #   16 d-mmm
+    #   17 mmm-yy
+    #   18 h:mm AM/PM
+    #   19 h:mm:ss AM/PM
+    #   20 h:mm
+    #   21 h:mm:ss
+    #   22 m/d/yyyy h:mm
+    #   37 #,##0_);(#,##0)
+    #   38 #,##0_);[Red](#,##0)
+    #   39 #,##0.00_);(#,##0.00)
+    #   40 #,##0.00_);[Red](#,##0.00)
+    #   45 mm:ss
+    #   46 [h]:mm:ss
+    #   47 mm:ss.0
+    #   48 ##0.0E+0
+    #   49 @
+    # @see Axlsx
+    attr_reader :numFmtId
+
+    # @see numFmtId
+    def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
+
+    # @see formatCode
+    def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('numFmt', str)
+    end
+
+    # Override to avoid removing underscores
+    def serialized_attributes(str = '', additional_attributes = {})
+      attributes = declared_attributes.merge! additional_attributes
+      attributes.each do |key, value|
+        str << "#{Axlsx.camel(key, false)}=\"#{Axlsx.booleanize(value)}\" "
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -1,73 +1,71 @@
-# encoding: UTF-8
-module Axlsx
-  # A PatternFill is the pattern and solid fill styling for a cell.
-  # @note The recommended way to manage styles is with Styles#add_style
-  # @see Style#add_style
-  class PatternFill
-
-    include Axlsx::OptionsParser
-    # Creates a new PatternFill Object
-    # @option options [Symbol] patternType
-    # @option options [Color] fgColor
-    # @option options [Color] bgColor
-    def initialize(options={})
-      @patternType = :none
-      parse_options options
-    end
-
-    # The color to use for the the background in solid fills.
-    # @return [Color]
-    attr_reader :fgColor
-
-    # The color to use for the background of the fill when the type is not solid.
-    # @return [Color]
-    attr_reader :bgColor
-
-    # The pattern type to use
-    # @note
-    #  patternType must be one of
-    #   :none
-    #   :solid
-    #   :mediumGray
-    #   :darkGray
-    #   :lightGray
-    #   :darkHorizontal
-    #   :darkVertical
-    #   :darkDown
-    #   :darkUp
-    #   :darkGrid
-    #   :darkTrellis
-    #   :lightHorizontal
-    #   :lightVertical
-    #   :lightDown
-    #   :lightUp
-    #   :lightGrid
-    #   :lightTrellis
-    #   :gray125
-    #   :gray0625
-    # @see Office Open XML Part 1 18.18.55
-    attr_reader :patternType
-
-    # @see fgColor
-    def fgColor=(v) DataTypeValidator.validate "PatternFill.fgColor", Color, v; @fgColor=v end
-    # @see bgColor
-    def bgColor=(v) DataTypeValidator.validate "PatternFill.bgColor", Color, v; @bgColor=v end
-    # @see patternType
-    def patternType=(v) Axlsx::validate_pattern_type v; @patternType = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << ('<patternFill patternType="' << patternType.to_s << '">')
-      if fgColor.is_a?(Color)
-        fgColor.to_xml_string str, "fgColor"
-      end
-
-      if bgColor.is_a?(Color)
-        bgColor.to_xml_string str, "bgColor"
-      end
-      str << '</patternFill>'
-    end
-  end
-end
+module Axlsx
+  # A PatternFill is the pattern and solid fill styling for a cell.
+  # @note The recommended way to manage styles is with Styles#add_style
+  # @see Style#add_style
+  class PatternFill
+    include Axlsx::OptionsParser
+    # Creates a new PatternFill Object
+    # @option options [Symbol] patternType
+    # @option options [Color] fgColor
+    # @option options [Color] bgColor
+    def initialize(options = {})
+      @patternType = :none
+      parse_options options
+    end
+
+    # The color to use for the the background in solid fills.
+    # @return [Color]
+    attr_reader :fgColor
+
+    # The color to use for the background of the fill when the type is not solid.
+    # @return [Color]
+    attr_reader :bgColor
+
+    # The pattern type to use
+    # @note
+    #  patternType must be one of
+    #   :none
+    #   :solid
+    #   :mediumGray
+    #   :darkGray
+    #   :lightGray
+    #   :darkHorizontal
+    #   :darkVertical
+    #   :darkDown
+    #   :darkUp
+    #   :darkGrid
+    #   :darkTrellis
+    #   :lightHorizontal
+    #   :lightVertical
+    #   :lightDown
+    #   :lightUp
+    #   :lightGrid
+    #   :lightTrellis
+    #   :gray125
+    #   :gray0625
+    # @see Office Open XML Part 1 18.18.55
+    attr_reader :patternType
+
+    # @see fgColor
+    def fgColor=(v) DataTypeValidator.validate "PatternFill.fgColor", Color, v; @fgColor = v end
+    # @see bgColor
+    def bgColor=(v) DataTypeValidator.validate "PatternFill.bgColor", Color, v; @bgColor = v end
+    # @see patternType
+    def patternType=(v) Axlsx::validate_pattern_type v; @patternType = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << ('<patternFill patternType="' << patternType.to_s << '">')
+      if fgColor.is_a?(Color)
+        fgColor.to_xml_string str, "fgColor"
+      end
+
+      if bgColor.is_a?(Color)
+        bgColor.to_xml_string str, "bgColor"
+      end
+      str << '</patternFill>'
+    end
+  end
+end