axlsx 1.0.0 → 1.0.1

data/lib/axlsx/rels/relationship.rb~

@@ -0,0 +1,18 @@
+module Axlsx
+  class Relationship
+    attr_accessor :Target, :Type
+    def initialize(type, target)
+      self.Target=target
+      self.Type=type
+    end
+
+    def Target=(v) Axlsx::validate_string v; @Target = v end
+    def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
+
+    def to_xml(xml, rId)
+      h = self.instance_values
+      h[:Id] = rId
+      xml.Relationship(h)
+    end
+  end
+end

data/lib/axlsx/rels/relationships.rb~

@@ -0,0 +1,23 @@
+module Axlsx
+  # Relationships are a collection of Relations that define how package parts are related.
+  # @note The package automatically manages releationships.
+  class Relationships < SimpleTypedList
+
+    # Creates a new Relationships collection based on SimpleTypedList
+    def initialize
+      super Relationship
+    end
+
+    # Serializes the relationships document.
+    # @return [String]
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.Relationships(:xmlns => Axlsx::RELS_R) {
+          each_with_index { |rel, index| rel.to_xml(xml, "rId#{index+1}") }
+        }
+      end
+      builder.to_xml
+    end
+  
+  end
+end

data/lib/axlsx/stylesheet/border.rb~

@@ -0,0 +1,24 @@
+module Axlsx
+  class Border
+    attr_accessor :diagonalUp, :diagonalDown, :outline
+    attr_reader :prs
+    def initialize(options={})
+      @prs = SimpleTypedList.new BorderPr
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end        
+
+    def diagonalUp=(v) Axlsx::validate_boolean v; @diagonalUp = v end
+    def diagonalDown=(v) Axlsx::validate_boolean v; @diagonalDown = v end
+    def outline=(v) Axlsx::validate_boolean v; @outline = v end
+
+    def to_xml(xml)
+      xml.border(self.instance_values.select{ |k,v| [:diagonalUp, :diagonalDown, :outline].include? k }) {
+        [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
+          @prs.select { |pr| pr.name == k }.each { |pr| pr.to_xml(xml) }
+        end
+      }
+    end
+  end
+end

data/lib/axlsx/stylesheet/border_pr.rb~

@@ -0,0 +1,64 @@
+module Axlsx
+  # A border part. 
+  class BorderPr
+    
+    # @return [Color] The color of this border part.
+    attr_accessor :color
+
+    # @return [Symbol] The syle of this border part. 
+    # @note 
+    #  The following are allowed
+    #   :none 
+    #   :thin
+    #   :medium
+    #   :dashed
+    #   :dotted
+    #   :thick
+    #   :double
+    #   :hair 
+    #   :mediumDashed
+    #   :dashDot
+    #   :mediumDashDot
+    #   :dashDotDot
+    #   :mediumDashDotDot
+    #   :slantDashDot
+    attr_accessor :style
+
+    # @return [Symbol] The name of this border part
+    # @note 
+    #  The following are allowed
+    #   :start
+    #   :end
+    #   :left
+    #   :right
+    #   :top
+    #   :bottom
+    #   :diagonal
+    #   :vertical
+    #   :horizontal
+    attr_accessor :name
+    
+    # Creates a new Border Part Object
+    # @option options [Color] color
+    # @option options [Symbol] name
+    # @option options [Symbol] style
+    # @see Axlsx::Border
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+    def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
+    def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end    
+    def style=(v) RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v; @style = v end
+
+    # Serializes the border part
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    def to_xml(xml)
+      xml.send(@name, :style=>@style) {
+        @color.to_xml(xml) if @color.is_a? Color
+      } 
+    end
+  end
+end

data/lib/axlsx/stylesheet/cell_alignment.rb~

@@ -0,0 +1,93 @@
+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
+    # @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_insigned_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,16 @@
+module Axlsx
+
+  class CellProtection
+    attr_accessor :hidden, :locked
+    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    
+    def to_xml(xml)
+      xml.protection(self.instance_values)
+    end
+  end
+end

data/lib/axlsx/stylesheet/cell_style.rb~

@@ -0,0 +1,61 @@
+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={})
+      raise ArgumentError, "Support for extLst has not been implimented" if options[:extLst]
+      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,56 @@
+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={})
+      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_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
+
+    private 
+    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,33 @@
+module Axlsx
+
+
+  class Font
+    attr_accessor :name, :charset, :family, :b, :i, :strike, :outline, :shadow, :condense, :extend, :color, :sz
+    def initialize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+    #there must be a cleaner way to do this.... 
+    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
+    
+    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 && v <= 1}; @left = v end    
+    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |v| v >= 0 && v <= 1}; @right = v end    
+    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |v| v >= 0 && v <= 1}; @top = v end    
+    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |v| v >= 0 && v <= 1}; @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