axlsx 1.0.12 → 1.0.14

data/lib/axlsx/stylesheet/color.rb

@@ -0,0 +1,69 @@
+module Axlsx
+  # The color class represents a color used for borders, fills an fonts
+  class Color
+    # 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
+    
+    # Creates a new Color object
+    # @option options [Boolean] auto
+    # @option options [String] rgb
+    # @option options [Float] tint    
+    def initialize(options={})
+      @rgb = "FF000000"
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+    # @see auto
+    def auto=(v) Axlsx::validate_boolean v; @auto = v end    
+    # @see color
+    def rgb=(v)
+      Axlsx::validate_string(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 color
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml) xml.color(self.instance_values) end
+  end
+end

data/lib/axlsx/stylesheet/fill.rb

@@ -0,0 +1,32 @@
+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 fill
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.fill { @fill_type.to_xml(xml) }
+    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

@@ -0,0 +1,139 @@
+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
+    # 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 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
+
+    # 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] 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={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+    # @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 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 fill
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.font {
+        self.instance_values.each do |k, v|
+          v.is_a?(Color) ? v.to_xml(xml) : xml.send(k, {:val => v})            
+        end
+      }
+    end
+  end
+end

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -0,0 +1,76 @@
+# -*- coding: 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
+
+    # 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
+    
+    # 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
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+      @stop = SimpleTypedList.new GradientStop
+    end
+
+    # @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) DataTypeValidator.validate "GradientFill.left", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @left = v end    
+    # @see right
+    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @right = v end    
+    # @see top
+    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @top = v end    
+    # @see bottom
+    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @bottom= v end    
+
+    # Serializes the gradientFill
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.gradientFill(self.instance_values.reject { |k,v| k.to_sym == :stop }) {
+        @stop.each { |s| s.to_xml(xml) }
+      }
+    end
+  end
+end

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -0,0 +1,33 @@
+# -*- coding: 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 gradientStop
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml) xml.stop(:position => self.position) {self.color.to_xml(xml)} end
+  end
+end

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -0,0 +1,63 @@
+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
+    # @return [Integer] An unsinged 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
+
+    # @return [String] The formatting to use for this number format. 
+    # @see http://support.microsoft.com/kb/264372
+    attr_reader :formatCode
+    def initialize(options={})
+      @numFmtId = 0
+      @formatCode = ""
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+
+    # @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
+
+    # Creates a numFmt element applying the instance values of this object as attributes.
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    def to_xml(xml) xml.numFmt(self.instance_values) end    
+
+  end
+end

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -0,0 +1,66 @@
+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
+
+    # 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
+
+    # Creates a new PatternFill Object
+    # @option options [Symbol] patternType
+    # @option options [Color] fgColor
+    # @option options [Color] bgColor
+    def initialize(options={})
+      @patternType = :none
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    # @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 pattern fill
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml) 
+      xml.patternFill(:patternType => self.patternType) { 
+        self.instance_values.reject { |k,v| k.to_sym == :patternType }.each { |k,v| xml.send(k, v.instance_values) }    
+      }
+    end
+  end
+end