axlsx 1.0.11 → 1.0.12

data/lib/axlsx/rels/relationship.rb

@@ -1,44 +0,0 @@
-module Axlsx
-  # A relationship defines a reference between package parts.
-  # @note Packages automatcially manage relationships.
-  class Relationship
-
-    # The location of the relationship target
-    # @return [String]
-    attr_reader :Target
-
-    # The type of relationship
-    # @note Supported types are defined as constants in Axlsx:
-    # @see XML_NS_R
-    # @see TABLE_R
-    # @see WORKBOOK_R
-    # @see WORKSHEET_R
-    # @see APP_R
-    # @see RELS_R
-    # @see CORE_R
-    # @see STYLES_R
-    # @see CHART_R
-    # @see DRAWING_R
-    # @return [String]
-    attr_reader :Type
-    def initialize(type, target)
-      self.Target=target
-      self.Type=type
-    end
-
-    # @see Target
-    def Target=(v) Axlsx::validate_string v; @Target = v end
-    # @see Type
-    def Type=(v) Axlsx::validate_relationship_type v; @Type = v end
-
-    # Serializes the relationship    
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @param [String] rId the reference id of the object.
-    # @return [String]
-    def to_xml(xml, rId)
-      h = self.instance_values
-      h[:Id] = rId
-      xml.Relationship(h)
-    end
-  end
-end

data/lib/axlsx/rels/relationships.rb

@@ -1,25 +0,0 @@
-module Axlsx
-require 'axlsx/rels/relationship.rb'
-
-  # 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

@@ -1,57 +0,0 @@
-module Axlsx
-  # This class details a border used in Office Open XML spreadsheet styles.
-  class Border
-
-    # @return [Boolean] The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell. 
-    attr_reader :diagonalUp
-    
-    # @return [Boolean] The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.
-    attr_reader :diagonalDown
-
-    # @return [Boolean] The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.
-    attr_reader :outline
-
-    # @return [SimpleTypedList] A list of BorderPr objects for this border. 
-    attr_reader :prs
-
-    # Creates a new Border object
-    # @option options [Boolean] diagonalUp
-    # @option options [Boolean] diagonalDown
-    # @option options [Boolean] outline
-    # @example Making a border
-    #   p = Package.new
-    #   red_border = Border.new
-    #   [:left, :right, :top, :bottom].each do |item| 
-    #     red_border.prs << BorderPr.new(:name=>item, :style=>:thin, :color=>Color.new(:rgb=>"FFFF0000"))     #   
-    #   end
-    #   # this sets red_border to be the index for the created border.
-    #   red_border = p.workbook.styles.@borders << red_border
-    #   #used in row creation as follows. This will add a red border to each of the cells in the row.
-    #   p.workbook.add_worksheet.rows << :values=>[1,2,3] :style=>red_border
-    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        
-
-    # @see diagonalUp
-    def diagonalUp=(v) Axlsx::validate_boolean v; @diagonalUp = v end
-    # @see diagonalDown
-    def diagonalDown=(v) Axlsx::validate_boolean v; @diagonalDown = v end
-    # @see outline
-    def outline=(v) Axlsx::validate_boolean v; @outline = v end
-
-    # Serializes the border element
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    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 do |part| 
-            part.to_xml(xml) 
-          end
-        end
-      }
-    end
-  end
-end

data/lib/axlsx/stylesheet/border_pr.rb

@@ -1,68 +0,0 @@
-module Axlsx
-  # A border part. 
-  class BorderPr
-    
-    # @return [Color] The color of this border part.
-    attr_reader :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_reader :style
-
-    # @return [Symbol] The name of this border part
-    # @note 
-    #  The following are allowed
-    #   :start
-    #   :end
-    #   :left
-    #   :right
-    #   :top
-    #   :bottom
-    #   :diagonal
-    #   :vertical
-    #   :horizontal
-    attr_reader :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
-
-    # @see name
-    def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
-    # @see color
-    def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end    
-    # @see style
-    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.
-    # @return [String]
-    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

@@ -1,105 +0,0 @@
-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_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 :textRotation
-
-    # Indicate if the text of the cell should wrap
-    # @return [Boolean]
-    attr_reader :wrapText
-    
-    # The amount of indent
-    # @return [Integer]
-    attr_reader :indent
-
-    # The amount of relativeIndent
-    # @return [Integer]
-    attr_reader :relativeIndent
-
-    # Indicate if the last line should be justified.
-    # @return [Boolean]
-    attr_reader :justifyLastLine
-
-    # Indicate if the text should be shrunk to the fit in the cell.
-    # @return [Boolean]
-    attr_reader :shrinkToFit
-
-    # The reading order of the text
-    # 0 Context Dependent 
-    # 1 Left-to-Right
-    # 2 Right-to-Left
-    # @return [Integer]
-    attr_reader :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        
-    
-    # @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 textRotation=(v) Axlsx::validate_unsigned_int v; @textRotation = v end    
-    # @see wrapText
-    def wrapText=(v) Axlsx::validate_boolean v; @wrapText = v end    
-    # @see indent
-    def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end    
-    # @see relativeIndent
-    def relativeIndent=(v) Axlsx::validate_int v; @relativeIndent = v end    
-    # @see justifyLastLine
-    def justifyLastLine=(v) Axlsx::validate_boolean v; @justifyLastLine = v end    
-    # @see shrinkToFit
-    def shrinkToFit=(v) Axlsx::validate_boolean v; @shrinkToFit = v end    
-    # @see readingOrder
-    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

@@ -1,36 +0,0 @@
-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_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={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    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 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

@@ -1,65 +0,0 @@
-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_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
-
-    # 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
-    # @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 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

@@ -1,69 +0,0 @@
-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