caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -1,132 +1,124 @@
-# encoding: UTF-8
-module Axlsx
-  
- 
-  # CellAlignment stores information about the cell alignment of a style Xf Object.
-  # @note Using Styles#add_style is the recommended way to manage cell alignment.
-  # @see Styles#add_style
-  class CellAlignment
-    
-
-    include Axlsx::SerializedAttributes
-    include Axlsx::OptionsParser
-    
-    serializable_attributes :horizontal, :vertical, :text_rotation, :wrap_text, :indent, :relative_indent, :justify_last_line, :shrink_to_fit, :reading_order
-    # Create a new cell_alignment object
-    # @option options [Symbol] horizontal
-    # @option options [Symbol] vertical
-    # @option options [Integer] text_rotation
-    # @option options [Boolean] wrap_text
-    # @option options [Integer] indent
-    # @option options [Integer] relative_indent
-    # @option options [Boolean] justify_last_line
-    # @option options [Boolean] shrink_to_fit
-    # @option options [Integer] reading_order
-    def initialize(options={})
-      parse_options options
-    end
-
-
-
-    # The horizontal alignment of the cell.
-    # @note
-    #  The horizontal cell alignement style must be one of
-    #   :general
-    #   :left
-    #   :center
-    #   :right
-    #   :fill
-    #   :justify
-    #   :centerContinuous
-    #   :distributed
-    # @return [Symbol]
-    attr_reader :horizontal
-
-    # The vertical alignment of the cell.
-    # @note
-    #  The vertical cell allingment style must be one of the following:
-    #   :top
-    #   :center
-    #   :bottom
-    #   :justify
-    #   :distributed
-    # @return [Symbol]
-    attr_reader :vertical
-
-    # The textRotation of the cell.
-    # @return [Integer]
-    attr_reader :text_rotation
-    alias :textRotation :text_rotation
-
-    # Indicate if the text of the cell should wrap
-    # @return [Boolean]
-    attr_reader :wrap_text
-    alias :wrapText :wrap_text
-
-    # The amount of indent
-    # @return [Integer]
-    attr_reader :indent
-
-    # The amount of relativeIndent
-    # @return [Integer]
-    attr_reader :relative_indent
-    alias :relativeIndent :relative_indent
-
-    # Indicate if the last line should be justified.
-    # @return [Boolean]
-    attr_reader :justify_last_line
-    alias :justifyLastLine :justify_last_line
-
-    # Indicate if the text should be shrunk to the fit in the cell.
-    # @return [Boolean]
-    attr_reader :shrink_to_fit
-    alias :shrinkToFit :shrink_to_fit
-
-    # The reading order of the text
-    # 0 Context Dependent
-    # 1 Left-to-Right
-    # 2 Right-to-Left
-    # @return [Integer]
-    attr_reader :reading_order
-    alias :readingOrder :reading_order
-
-    # @see horizontal
-    def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end
-    # @see vertical
-    def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end
-    # @see textRotation
-    def text_rotation=(v) Axlsx::validate_unsigned_int v; @text_rotation = v end
-    alias :textRotation= :text_rotation=
-
-    # @see wrapText
-    def wrap_text=(v) Axlsx::validate_boolean v; @wrap_text = v end
-    alias :wrapText= :wrap_text=
-
-    # @see indent
-    def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end
-
-    # @see relativeIndent
-    def relative_indent=(v) Axlsx::validate_int v; @relative_indent = v end
-    alias :relativeIndent= :relative_indent=
-
-    # @see justifyLastLine
-    def justify_last_line=(v) Axlsx::validate_boolean v; @justify_last_line = v end
-    alias :justifyLastLine= :justify_last_line=
-
-    # @see shrinkToFit
-    def shrink_to_fit=(v) Axlsx::validate_boolean v; @shrink_to_fit = v end
-    alias :shrinkToFit= :shrink_to_fit=
-
-    # @see readingOrder
-    def reading_order=(v) Axlsx::validate_unsigned_int v; @reading_order = v end
-    alias :readingOrder= :reading_order=
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('alignment', str)
-    end
-
-  end
-end
+module Axlsx
+  # CellAlignment stores information about the cell alignment of a style Xf Object.
+  # @note Using Styles#add_style is the recommended way to manage cell alignment.
+  # @see Styles#add_style
+  class CellAlignment
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+
+    serializable_attributes :horizontal, :vertical, :text_rotation, :wrap_text, :indent, :relative_indent, :justify_last_line, :shrink_to_fit, :reading_order
+    # Create a new cell_alignment object
+    # @option options [Symbol] horizontal
+    # @option options [Symbol] vertical
+    # @option options [Integer] text_rotation
+    # @option options [Boolean] wrap_text
+    # @option options [Integer] indent
+    # @option options [Integer] relative_indent
+    # @option options [Boolean] justify_last_line
+    # @option options [Boolean] shrink_to_fit
+    # @option options [Integer] reading_order
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # The horizontal alignment of the cell.
+    # @note
+    #  The horizontal cell alignement style must be one of
+    #   :general
+    #   :left
+    #   :center
+    #   :right
+    #   :fill
+    #   :justify
+    #   :centerContinuous
+    #   :distributed
+    # @return [Symbol]
+    attr_reader :horizontal
+
+    # The vertical alignment of the cell.
+    # @note
+    #  The vertical cell allingment style must be one of the following:
+    #   :top
+    #   :center
+    #   :bottom
+    #   :justify
+    #   :distributed
+    # @return [Symbol]
+    attr_reader :vertical
+
+    # The textRotation of the cell.
+    # @return [Integer]
+    attr_reader :text_rotation
+    alias :textRotation :text_rotation
+
+    # Indicate if the text of the cell should wrap
+    # @return [Boolean]
+    attr_reader :wrap_text
+    alias :wrapText :wrap_text
+
+    # The amount of indent
+    # @return [Integer]
+    attr_reader :indent
+
+    # The amount of relativeIndent
+    # @return [Integer]
+    attr_reader :relative_indent
+    alias :relativeIndent :relative_indent
+
+    # Indicate if the last line should be justified.
+    # @return [Boolean]
+    attr_reader :justify_last_line
+    alias :justifyLastLine :justify_last_line
+
+    # Indicate if the text should be shrunk to the fit in the cell.
+    # @return [Boolean]
+    attr_reader :shrink_to_fit
+    alias :shrinkToFit :shrink_to_fit
+
+    # The reading order of the text
+    # 0 Context Dependent
+    # 1 Left-to-Right
+    # 2 Right-to-Left
+    # @return [Integer]
+    attr_reader :reading_order
+    alias :readingOrder :reading_order
+
+    # @see horizontal
+    def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end
+    # @see vertical
+    def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end
+    # @see textRotation
+    def text_rotation=(v) Axlsx::validate_unsigned_int v; @text_rotation = v end
+    alias :textRotation= :text_rotation=
+
+    # @see wrapText
+    def wrap_text=(v) Axlsx::validate_boolean v; @wrap_text = v end
+    alias :wrapText= :wrap_text=
+
+    # @see indent
+    def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end
+
+    # @see relativeIndent
+    def relative_indent=(v) Axlsx::validate_int v; @relative_indent = v end
+    alias :relativeIndent= :relative_indent=
+
+    # @see justifyLastLine
+    def justify_last_line=(v) Axlsx::validate_boolean v; @justify_last_line = v end
+    alias :justifyLastLine= :justify_last_line=
+
+    # @see shrinkToFit
+    def shrink_to_fit=(v) Axlsx::validate_boolean v; @shrink_to_fit = v end
+    alias :shrinkToFit= :shrink_to_fit=
+
+    # @see readingOrder
+    def reading_order=(v) Axlsx::validate_unsigned_int v; @reading_order = v end
+    alias :readingOrder= :reading_order=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('alignment', str)
+    end
+  end
+end

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -1,41 +1,38 @@
-# encoding: UTF-8
-module Axlsx
-  # CellProtection stores information about locking or hiding cells in spreadsheet.
-  # @note Using Styles#add_style is the recommended way to manage cell protection.
-  # @see Styles#add_style
-  class CellProtection
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    serializable_attributes :hidden, :locked
-
-    # specifies locking for cells that have the style containing this protection
-    # @return [Boolean]
-    attr_reader :hidden
-
-    # specifies if the cells that have the style containing this protection
-    # @return [Boolean]
-    attr_reader :locked
-
-    # Creates a new CellProtection
-    # @option options [Boolean] hidden value for hidden protection
-    # @option options [Boolean] locked value for locked protection
-    def initialize(options={})
-      parse_options options
-    end
-
-    # @see hidden
-    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
-    # @see locked
-    def locked=(v) Axlsx::validate_boolean v; @locked = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('protection', str)
-    end
-
-  end
-end
+module Axlsx
+  # CellProtection stores information about locking or hiding cells in spreadsheet.
+  # @note Using Styles#add_style is the recommended way to manage cell protection.
+  # @see Styles#add_style
+  class CellProtection
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :hidden, :locked
+
+    # specifies locking for cells that have the style containing this protection
+    # @return [Boolean]
+    attr_reader :hidden
+
+    # specifies if the cells that have the style containing this protection
+    # @return [Boolean]
+    attr_reader :locked
+
+    # Creates a new CellProtection
+    # @option options [Boolean] hidden value for hidden protection
+    # @option options [Boolean] locked value for locked protection
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # @see hidden
+    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    # @see locked
+    def locked=(v) Axlsx::validate_boolean v; @locked = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('protection', str)
+    end
+  end
+end

data/lib/axlsx/stylesheet/cell_style.rb

@@ -1,72 +1,68 @@
-# encoding: UTF-8
-module Axlsx
-  # CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.
-  # @note Using Styles#add_style is the recommended way to manage cell styling.
-  # @see Styles#add_style
-  class CellStyle
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creats a new CellStyle object
-    # @option options [String] name
-    # @option options [Integer] xfId
-    # @option options [Integer] buildinId
-    # @option options [Integer] iLevel
-    # @option options [Boolean] hidden
-    # @option options [Boolean] customBuiltIn
-    def initialize(options={})
-      parse_options options
-    end
-
-    serializable_attributes :name, :xfId, :buildinId, :iLevel, :hidden, :customBuilin
-
-    # The name of this cell style
-    # @return [String]
-    attr_reader :name
-
-    # The formatting record id this named style utilizes
-    # @return [Integer]
-    # @see Axlsx::Xf
-    attr_reader :xfId
-
-    # The buildinId to use when this named style is applied
-    # @return [Integer]
-    # @see Axlsx::NumFmt
-    attr_reader :builtinId
-
-    # Determines if this formatting is for an outline style, and what level of the outline it is to be applied to.
-    # @return [Integer]
-    attr_reader :iLevel
-
-    # Determines if this named style should show in the list of styles when using excel
-    # @return [Boolean]
-    attr_reader :hidden
-
-    # Indicates that the build in style reference has been customized.
-    # @return [Boolean]
-    attr_reader :customBuiltin
-
-     # @see name
-    def name=(v)  Axlsx::validate_string v; @name = v end
-    # @see xfId
-    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
-    # @see builtinId
-    def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
-    # @see iLivel
-    def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
-    # @see hidden
-    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
-    # @see customBuiltin
-    def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('cellStyle', str)
-    end
-
-  end
-
-end
+module Axlsx
+  # CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.
+  # @note Using Styles#add_style is the recommended way to manage cell styling.
+  # @see Styles#add_style
+  class CellStyle
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creats a new CellStyle object
+    # @option options [String] name
+    # @option options [Integer] xfId
+    # @option options [Integer] buildinId
+    # @option options [Integer] iLevel
+    # @option options [Boolean] hidden
+    # @option options [Boolean] customBuiltIn
+    def initialize(options = {})
+      parse_options options
+    end
+
+    serializable_attributes :name, :xfId, :buildinId, :iLevel, :hidden, :customBuilin
+
+    # The name of this cell style
+    # @return [String]
+    attr_reader :name
+
+    # The formatting record id this named style utilizes
+    # @return [Integer]
+    # @see Axlsx::Xf
+    attr_reader :xfId
+
+    # The buildinId to use when this named style is applied
+    # @return [Integer]
+    # @see Axlsx::NumFmt
+    attr_reader :builtinId
+
+    # Determines if this formatting is for an outline style, and what level of the outline it is to be applied to.
+    # @return [Integer]
+    attr_reader :iLevel
+
+    # Determines if this named style should show in the list of styles when using excel
+    # @return [Boolean]
+    attr_reader :hidden
+
+    # Indicates that the build in style reference has been customized.
+    # @return [Boolean]
+    attr_reader :customBuiltin
+
+    # @see name
+    def name=(v) Axlsx::validate_string v; @name = v end
+    # @see xfId
+    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
+    # @see builtinId
+    def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
+    # @see iLivel
+    def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
+    # @see hidden
+    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    # @see customBuiltin
+    def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('cellStyle', str)
+    end
+  end
+end

data/lib/axlsx/stylesheet/color.rb

@@ -1,76 +1,77 @@
-# encoding: UTF-8
-module Axlsx
-  # The color class represents a color used for borders, fills an fonts
-  class Color
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creates a new Color object
-    # @option options [Boolean] auto
-    # @option options [String] rgb
-    # @option options [Float] tint
-    def initialize(options={})
-      @rgb = "FF000000"
-      parse_options options
-    end
-
-    serializable_attributes :auto, :rgb, :tint
-
-    # Determines if the color is system color dependant
-    # @return [Boolean]
-    attr_reader :auto
-
-    # The color as defined in rgb terms.
-    # @note
-    #  rgb colors need to conform to ST_UnsignedIntHex. That basically means put 'FF' before you color
-    # When assigning the rgb value the behavior is much like CSS selectors and can use shorthand versions as follows:
-    # If you provide a two character value it will be repeated for each r, g, b assignment
-    # If you provide data that is not 2 characters in length, and is less than 8 characters it will be padded with "F"
-    # @example
-    #        Color.new :rgb => "FF000000"
-    #          => #<Axlsx::Color:0x102106b68 @rgb="FF000000">
-    #        Color.new :rgb => "0A"
-    #          => #<Axlsx::Color:0x102106b68 @rgb="FF0A0A0A">
-    #        Color.new :rgb => "00BB"
-    #          => #<Axlsx::Color:0x102106b68 @rgb="FFFF00BB">
-    # @return [String]
-    attr_reader :rgb
-
-    # no support for theme just yet
-    # @return [Integer]
-    #attr_reader :theme
-
-    # The tint value.
-    # @note valid values are between -1.0 and 1.0
-    # @return [Float]
-    attr_reader :tint
-
-     # @see auto
-    def auto=(v) Axlsx::validate_boolean v; @auto = v end
-    # @see color
-    def rgb=(v)
-      Axlsx::validate_string(v)
-      v = v.upcase
-      v = v * 3 if v.size == 2
-      v = v.rjust(8, 'FF')
-      raise ArgumentError, "Invalid color rgb value: #{v}." unless v.match(/[0-9A-F]{8}/)
-      @rgb = v
-    end
-    # @see tint
-    def tint=(v) Axlsx::validate_float v; @tint = v end
-
-    # This version does not support themes
-    # def theme=(v) Axlsx::validate_unsigned_integer v; @theme = v end
-
-    # Indexed colors are for backward compatability which I am choosing not to support
-    # def indexed=(v) Axlsx::validate_unsigned_integer v; @indexed = v end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '', tag_name = 'color')
-      serialized_tag('' + tag_name + '', str)
-    end
-  end
-end
+module Axlsx
+  # The color class represents a color used for borders, fills an fonts
+  class Color
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new Color object
+    # @option options [Boolean] auto
+    # @option options [String] rgb
+    # @option options [Float] tint
+    def initialize(options = {})
+      @rgb = "FF000000"
+      parse_options options
+    end
+
+    serializable_attributes :auto, :rgb, :tint
+
+    # Determines if the color is system color dependant
+    # @return [Boolean]
+    attr_reader :auto
+
+    # The color as defined in rgb terms.
+    # @note
+    #  rgb colors need to conform to ST_UnsignedIntHex. That basically means put 'FF' before you color
+    # When assigning the rgb value the behavior is much like CSS selectors and can use shorthand versions as follows:
+    # If you provide a two character value it will be repeated for each r, g, b assignment
+    # If you provide data that is not 2 characters in length, and is less than 8 characters it will be padded with "F"
+    # @example
+    #        Color.new :rgb => "FF000000"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FF000000">
+    #        Color.new :rgb => "0A"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FF0A0A0A">
+    #        Color.new :rgb => "00BB"
+    #          => #<Axlsx::Color:0x102106b68 @rgb="FFFF00BB">
+    # @return [String]
+    attr_reader :rgb
+
+    # no support for theme just yet
+    # @return [Integer]
+    # attr_reader :theme
+
+    # The tint value.
+    # @note valid values are between -1.0 and 1.0
+    # @return [Float]
+    attr_reader :tint
+
+    # @see auto
+    def auto=(v) Axlsx::validate_boolean v; @auto = v end
+
+    # @see color
+    def rgb=(v)
+      Axlsx::validate_string(v)
+      v = v.upcase
+      v = v * 3 if v.size == 2
+      v = v.rjust(8, 'FF')
+      raise ArgumentError, "Invalid color rgb value: #{v}." unless v.match(/[0-9A-F]{8}/)
+
+      @rgb = v
+    end
+
+    # @see tint
+    def tint=(v) Axlsx::validate_float v; @tint = v end
+
+    # This version does not support themes
+    # def theme=(v) Axlsx::validate_unsigned_integer v; @theme = v end
+
+    # Indexed colors are for backward compatability which I am choosing not to support
+    # def indexed=(v) Axlsx::validate_unsigned_integer v; @indexed = v end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '', tag_name = 'color')
+      serialized_tag('' + tag_name + '', str)
+    end
+  end
+end