axlsx 1.0.0

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -0,0 +1,96 @@
+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
+    # 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_accessor :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_accessor :vertical
+
+    # The textRotation of the cell.
+    # @return [Integer]
+    attr_accessor :textRotation
+
+    # Indicate if the text of the cell should wrap
+    # @return [Boolean]
+    attr_accessor :wrapText
+    
+    # The amount of indent
+    # @return [Integer]
+    attr_accessor :indent
+
+    # The amount of relativeIndent
+    # @return [Integer]
+    attr_accessor :relativeIndent
+
+    # Indicate if the last line should be justified.
+    # @return [Boolean]
+    attr_accessor :justifyLastLine
+
+    # Indicate if the text should be shrunk to the fit in the cell.
+    # @return [Boolean]
+    attr_accessor :shrinkToFit
+
+    # The reading order of the text
+    # 0 Context Dependent 
+    # 1 Left-to-Right
+    # 2 Right-to-Left
+    # @return [Integer]
+    attr_accessor :readingOrder
+    
+    # Create a new cell_alignment object
+    # @option options [Symbol] horizontal
+    # @option options [Symbol] vertical
+    # @option options [Integer] textRotation
+    # @option options [Boolean] wrapText
+    # @option options [Integer] indent
+    # @option options [Integer] relativeIndent
+    # @option options [Boolean] justifyLastLine
+    # @option options [Boolean] shrinkToFit
+    # @option options [Integer] readingOrder
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end        
+    
+    def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end    
+    def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end    
+    def textRotation=(v) Axlsx::validate_unsigned_int v; @textRotation = v end    
+    def wrapText=(v) Axlsx::validate_boolean v; @wrapText = v end    
+    def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end    
+    def relativeIndent=(v) Axlsx::validate_int v; @relativeIndent = v end    
+    def justifyLastLine=(v) Axlsx::validate_boolean v; @justifyLastLine = v end    
+    def shrinkToFit=(v) Axlsx::validate_boolean v; @shrinkToFit = v end    
+    def readingOrder=(v) Axlsx::validate_unsigned_int v; @readingOrder = v end  
+
+    # Serializes the cell alignment
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.alignment(self.instance_values)      
+    end
+    
+  end
+end

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -0,0 +1,33 @@
+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
+    
+    # specifies locking for cells that have the style containing this protection
+    # @return [Boolean]
+    attr_accessor :hidden
+
+    # specifies if the cells that have the style containing this protection
+    # @return [Boolean]
+    attr_accessor :locked
+
+    # Creates a new CellProtection
+    # @option options [Boolean] hidden value for hidden protection
+    # @option options [Boolean] locked value for locked protection
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end    
+    def locked=(v) Axlsx::validate_boolean v; @locked = v end    
+
+    # Serializes the cell protection
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.protection(self.instance_values)
+    end
+  end
+end

data/lib/axlsx/stylesheet/cell_style.rb

@@ -0,0 +1,60 @@
+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
+    # The name of this cell style
+    # @return [String]
+    attr_accessor :name
+    
+    # The formatting record id this named style utilizes
+    # @return [Integer]
+    # @see Axlsx::Xf
+    attr_accessor :xfId
+
+    # The buildinId to use when this named style is applied
+    # @return [Integer]
+    # @see Axlsx::NumFmt
+    attr_accessor :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_accessor :iLevel
+
+    # Determines if this named style should show in the list of styles when using excel
+    # @return [Boolean]
+    attr_accessor :hidden
+
+    # Indicates that the build in style reference has been customized.
+    # @return [Boolean]
+    attr_accessor :customBuiltin
+
+    # 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={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+
+    def name=(v)  Axlsx::validate_string v; @name = v end
+    def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
+    def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
+    def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
+    def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
+
+    # Serializes the cell style
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.cellStyle(self.instance_values)
+    end
+  end
+
+end

data/lib/axlsx/stylesheet/color.rb

@@ -0,0 +1,57 @@
+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_accessor :auto
+    
+    # Backwards compatability color index
+    # return [Integer]
+    #attr_accessor :indexed
+
+    # The color as defined in rgb terms. 
+    # @note 
+    #  rgb colors need to conform to ST_UnsignedIntHex. That basically means put 'FF' before you color
+    # @example rgb colors
+    #  "FF000000" is black
+    #  "FFFFFFFF" is white
+    # @return [String]
+    attr_accessor :rgb
+
+    # no support for theme just yet
+    # @return [Integer]
+    #attr_accessor :theme
+    
+    # The tint value.
+    # @note valid values are between -1.0 and 1.0
+    # @return [Float]
+    attr_accessor :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
+    
+    def auto=(v) Axlsx::validate_boolean v; @auto = v end    
+    def rgb=(v) Axlsx::validate_string v; @rgb = v end    
+    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,31 @@
+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_accessor :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
+
+    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,128 @@
+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_accessor :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_accessor :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_accessor :family
+
+    # Indicates if the font should be rendered in *bold*
+    # @return [Boolean]
+    attr_accessor :b
+
+    # Indicates if the font should be rendered italicized
+    # @return [Boolean]
+    attr_accessor :i
+
+    # Indicates if the font should be rendered with a strikthrough
+    # @return [Boolean]
+    attr_accessor :strike
+
+    # Indicates if the font should be rendered with an outline
+    # @return [Boolean]
+    attr_accessor :outline
+
+    # Indicates if the font should be rendered with a shadow
+    # @return [Boolean]
+    attr_accessor :shadow
+
+    # Indicates if the font should be condensed
+    # @return [Boolean]
+    attr_accessor :condense
+
+    # The font's extend property
+    # @return [Boolean]
+    attr_accessor  :extend
+
+    # The color of the font
+    # @return [Color]
+    attr_accessor :color
+
+    # The size of the font.
+    # @return [Integer]
+    attr_accessor :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
+
+    def name=(v) Axlsx::validate_string v; @name = v end    
+    def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
+    def family=(v) Axlsx::validate_unsigned_int v; @family = v end
+    def b=(v) Axlsx::validate_boolean v; @b = v end    
+    def i=(v) Axlsx::validate_boolean v; @i = v end
+    def strike=(v) Axlsx::validate_boolean v; @strike = v end
+    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+    def shadow=(v) Axlsx::validate_boolean v; @shadow = v end    
+    def condense=(v) Axlsx::validate_boolean v; @condense = v end
+    def extend=(v) Axlsx::validate_boolean v; @extend = v end
+    def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color=v end
+    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,70 @@
+# -*- 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_accessor :type
+
+    # Angle of the linear gradient
+    # @return [Float]
+    attr_accessor :degree
+
+    # Percentage format left
+    # @return [Float]
+    attr_accessor :left
+
+    # Percentage format right
+    # @return [Float]
+    attr_accessor :right
+
+    # Percentage format top
+    # @return [Float]
+    attr_accessor :top 
+
+    # Percentage format bottom
+    # @return [Float]
+    attr_accessor :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
+
+    def type=(v) Axlsx::validate_gradient_type v; @type = v end    
+    def degree=(v) Axlsx::validate_float v; @degree = v end    
+    def left=(v) DataTypeValidator.validate "GradientFill.left", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @left = v end    
+    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @right = v end    
+    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @top = v end    
+    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |v| v >= 0.0 && v <= 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