axlsx 2.0.1 → 3.0.0.pre

data/lib/axlsx/workbook/worksheet/protected_ranges.rb

@@ -20,15 +20,18 @@ module Axlsx
              elsif cells.is_a?(SimpleTypedList) || cells.is_a?(Array)
                Axlsx::cell_range(cells, false)
              end
-     @list << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
+     self << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
      last
     end
 
+    # Serializes the protected ranges
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = '')
       return if empty?
       str << '<protectedRanges>'
       each { |range| range.to_xml_string(str) }
-      str << '</protectedRanges>' 
+      str << '</protectedRanges>'
     end
   end
 end

data/lib/axlsx/workbook/worksheet/rich_text.rb

@@ -0,0 +1,55 @@
+module Axlsx
+
+  # A simple, self serializing class for storing TextRuns
+  class RichText < SimpleTypedList
+
+    # creates a new RichText collection
+    # @param [String] text -optional The text to use in creating the first RichTextRun
+    # @param [Object] options -optional The options to use in creating the first RichTextRun
+    # @yield [RichText] self
+    def initialize(text = nil, options={})
+      super(RichTextRun)
+      add_run(text, options) unless text.nil?
+      yield self if block_given?
+    end
+
+    # The cell that owns this RichText collection
+    attr_reader :cell
+
+    # Assign the cell for this RichText collection
+    # @param [Cell] cell The cell which all RichTextRuns in the collection will belong to
+    def cell=(cell)
+      @cell = cell
+      each { |run| run.cell = cell }
+    end
+
+    # Calculates the longest autowidth of the RichTextRuns in this collection
+    # @return [Number]
+    def autowidth
+      widtharray = [0] # Are arrays the best way of solving this problem?
+      each { |run| run.autowidth(widtharray) }
+      widtharray.max
+    end
+
+    # Creates and adds a RichTextRun to this collectino
+    # @param [String] text The text to use in creating a new RichTextRun
+    # @param [Object] options The options to use in creating the new RichTextRun
+    def add_run(text, options={})
+      self << RichTextRun.new(text, options)
+    end
+
+    # The RichTextRuns we own
+    # @return [RichText]
+    def runs
+      self
+    end
+
+    # renders the RichTextRuns in this collection
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str='')
+      each{ |run| run.to_xml_string(str) }
+      str
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/rich_text_run.rb

@@ -0,0 +1,250 @@
+module Axlsx
+
+  # The RichTextRun class creates and self serializing text run.
+  class RichTextRun
+
+    include Axlsx::OptionsParser
+
+    attr_reader :value
+
+    # A list of allowed inline style attributes used for validation
+    INLINE_STYLES = [:font_name, :charset,
+                     :family, :b, :i, :strike, :outline,
+                     :shadow, :condense, :extend, :u,
+                     :vertAlign, :sz, :color, :scheme].freeze
+
+    def initialize(value, options={})
+      self.value = value
+      parse_options(options)
+    end
+
+    def value=(value)
+      @value = value
+    end
+
+    attr_accessor :cell
+
+    # The inline font_name property for the cell
+    # @return [String]
+    attr_reader :font_name
+    # @see font_name
+    def font_name=(v) set_run_style :validate_string, :font_name, v; end
+
+    # The inline charset property for the cell
+    # As far as I can tell, this is pretty much ignored. However, based on the spec it should be one of the following:
+    # 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
+    # @return [String]
+    attr_reader :charset
+    # @see charset
+    def charset=(v) set_run_style :validate_unsigned_int, :charset, v; end
+
+    # The inline family property for the cell
+    # @return [Integer]
+    # 1 Roman
+    # 2 Swiss
+    # 3 Modern
+    # 4 Script
+    # 5 Decorative
+    attr_reader :family
+    # @see family
+    def family=(v)
+      set_run_style :validate_family, :family, v.to_i
+    end
+
+    # The inline bold property for the cell
+    # @return [Boolean]
+    attr_reader :b
+    # @see b
+    def b=(v) set_run_style :validate_boolean, :b, v; end
+
+    # The inline italic property for the cell
+    # @return [Boolean]
+    attr_reader :i
+    # @see i
+    def i=(v) set_run_style :validate_boolean, :i, v; end
+
+    # The inline strike property for the cell
+    # @return [Boolean]
+    attr_reader :strike
+    # @see strike
+    def strike=(v) set_run_style :validate_boolean, :strike, v; end
+
+    # The inline outline property for the cell
+    # @return [Boolean]
+    attr_reader :outline
+    # @see outline
+    def outline=(v) set_run_style :validate_boolean, :outline, v; end
+
+    # The inline shadow property for the cell
+    # @return [Boolean]
+    attr_reader :shadow
+    # @see shadow
+    def shadow=(v) set_run_style :validate_boolean, :shadow, v; end
+
+    # The inline condense property for the cell
+    # @return [Boolean]
+    attr_reader :condense
+    # @see condense
+    def condense=(v) set_run_style :validate_boolean, :condense, v; end
+
+    # The inline extend property for the cell
+    # @return [Boolean]
+    attr_reader :extend
+    # @see extend
+    def extend=(v) set_run_style :validate_boolean, :extend, v; end
+
+    # The inline underline property for the cell.
+    # It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting, true
+    # @return [Boolean]
+    # @return [String]
+    # @note true is for backwards compatability and is reassigned to :single
+    attr_reader :u
+    # @see u
+    def u=(v)
+      v = :single if (v == true || v == 1 || v == :true || v == 'true')
+      set_run_style :validate_cell_u, :u, v
+    end
+
+    # The inline color property for the cell
+    # @return [Color]
+    attr_reader :color
+    # @param [String] v The 8 character representation for an rgb color #FFFFFFFF"
+    def color=(v)
+      @color = v.is_a?(Color) ? v : Color.new(:rgb=>v)
+    end
+
+    # The inline sz property for the cell
+    # @return [Inteter]
+    attr_reader :sz
+    # @see sz
+    def sz=(v) set_run_style :validate_unsigned_int, :sz, v; end
+
+    # The inline vertical alignment property for the cell
+    # this must be one of [:baseline, :subscript, :superscript]
+    # @return [Symbol]
+    attr_reader :vertAlign
+    # @see vertAlign
+    def vertAlign=(v)
+      RestrictionValidator.validate :cell_vertAlign, [:baseline, :subscript, :superscript], v
+      set_run_style nil, :vertAlign, v
+    end
+
+    # The inline scheme property for the cell
+    # this must be one of [:none, major, minor]
+    # @return [Symbol]
+    attr_reader :scheme
+    # @see scheme
+    def scheme=(v)
+      RestrictionValidator.validate :cell_scheme, [:none, :major, :minor], v
+      set_run_style nil, :scheme, v
+    end
+
+    # Tries to work out the width of the longest line in the run
+    # @param [Array] widtharray this array is populated with the widths of each line in the run.
+    # @return [Array]
+    def autowidth(widtharray)
+      return if value.nil?
+      if styles.cellXfs[style].alignment && styles.cellXfs[style].alignment.wrap_text
+        first = true
+        value.to_s.split(/\r?\n/, -1).each do |line|
+          if first
+            first = false
+          else
+            widtharray << 0
+          end
+          widtharray[-1] += string_width(line, font_size)
+        end
+      else
+        widtharray[-1] += string_width(value.to_s, font_size)
+      end
+      widtharray
+    end
+
+    # Utility method for setting inline style attributes
+    def set_run_style(validator, attr, value)
+      return unless INLINE_STYLES.include?(attr.to_sym)
+      Axlsx.send(validator, value) unless validator.nil?
+      self.instance_variable_set :"@#{attr.to_s}", value
+    end
+
+    # Serializes the RichTextRun
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      valid = RichTextRun::INLINE_STYLES
+      data = Hash[self.instance_values.map{ |k, v| [k.to_sym, v] }]
+      data = data.select { |key, value| valid.include?(key) && !value.nil? }
+
+      str << '<r><rPr>'
+      data.keys.each do |key|
+        case key
+        when :font_name
+          str << ('<rFont val="' << font_name << '"/>')
+        when :color
+          str << data[key].to_xml_string
+        else
+          str << ('<' << key.to_s << ' val="' << xml_value(data[key]) << '"/>')
+        end
+      end
+      clean_value = Axlsx::trust_input ? @value.to_s : ::CGI.escapeHTML(Axlsx::sanitize(@value.to_s))
+      str << ('</rPr><t>' << clean_value << '</t></r>')
+    end
+
+    private
+
+    # Returns the width of a string according to the current style
+    # This is still not perfect...
+    #  - scaling is not linear as font sizes increase
+    def string_width(string, font_size)
+      font_scale = font_size / 10.0
+      string.count(Worksheet::THIN_CHARS) * font_scale
+    end
+
+    # we scale the font size if bold style is applied to either the style font or
+    # the cell itself. Yes, it is a bit of a hack, but it is much better than using
+    # imagemagick and loading metrics for every character.
+    def font_size
+      return sz if sz
+      font = styles.fonts[styles.cellXfs[style].fontId] || styles.fonts[0]
+      (font.b || (defined?(@b) && @b)) ? (font.sz * 1.5) : font.sz
+    end
+
+    def style
+      cell.style
+    end
+
+    def styles
+      cell.row.worksheet.styles
+    end
+
+    # Converts the value to the correct XML representation (fixes issues with
+    # Numbers)
+    def xml_value value
+      if value == true
+        1
+      elsif value == false
+        0
+      else
+        value
+      end.to_s
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/row.rb

@@ -3,10 +3,10 @@ module Axlsx
   # A Row is a single row in a worksheet.
   # @note The recommended way to manage rows and cells is to use Worksheet#add_row
   # @see Worksheet#add_row
-  class Row
-
+  class Row < SimpleTypedList
     include SerializedAttributes
     include Accessors
+    
     # No support is provided for the following attributes
     # spans
     # thickTop
@@ -28,11 +28,10 @@ module Axlsx
     # @see Row#array_to_cells
     # @see Cell
     def initialize(worksheet, values=[], options={})
-      @ht = nil
       self.worksheet = worksheet
-      @cells = SimpleTypedList.new Cell
-      @worksheet.rows << self
-      self.height = options.delete(:height) if options[:height]
+      super(Cell, nil, values.size)
+      self.height = options.delete(:height)
+      worksheet.rows << self
       array_to_cells(values, options)
     end
 
@@ -46,14 +45,10 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
-    # The cells this row holds
-    # @return [SimpleTypedList]
-    attr_reader :cells
-
     # Row height measured in point size. There is no margin padding on row height.
     # @return [Float]
     def height
-      @ht
+      defined?(@ht) ? @ht : nil
     end
 
     # Outlining level of the row, when outlining is on
@@ -77,11 +72,12 @@ module Axlsx
       Axlsx.validate_unsigned_numeric(v)
       @outline_level = v
     end
+    
     alias :outlineLevel= :outline_level=
 
     # The index of this row in the worksheet
     # @return [Integer]
-    def index
+    def row_index
       worksheet.rows.index(self)
     end
 
@@ -90,50 +86,55 @@ module Axlsx
     # @param [String] str The string this rows xml will be appended to.
     # @return [String]
     def to_xml_string(r_index, str = '')
-      str << '<row '
-      serialized_attributes(str, { :r => r_index + 1 })
-      str << '>'
-      @cells.each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, str) }
-      str << '</row>'
+      serialized_tag('row', str, :r => r_index + 1) do
+        tmp = '' # time / memory tradeoff, lots of calls to rubyzip costs more
+                 # time..
+        each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, tmp) }
+        str << tmp
+      end
     end
 
-    # Adds a single sell to the row based on the data provided and updates the worksheet's autofit data.
+    # Adds a single cell to the row based on the data provided and updates the worksheet's autofit data.
     # @return [Cell]
-    def add_cell(value="", options={})
+    def add_cell(value = '', options = {})
       c = Cell.new(self, value, options)
-      worksheet.send(:update_column_info, self.cells, [])
+      self << c
+      worksheet.send(:update_column_info, self, [])
       c
     end
 
-    # sets the style for every cell in this row
-    def style=(style)
-      cells.each_with_index do | cell, index |
-        s = style.is_a?(Array) ? style[index] : style
-        cell.style = s
+    # sets the color for every cell in this row
+    def color=(color)
+      each_with_index do | cell, index |
+        cell.color = color.is_a?(Array) ? color[index] : color
       end
     end
 
-    # returns the cells in this row as an array
-    # This lets us transpose the rows into columns
-    # @return [Array]
-    def to_ary
-      @cells.to_ary
+    # sets the style for every cell in this row
+    def style=(style)
+      each_with_index do | cell, index |
+        cell.style = style.is_a?(Array) ? style[index] : style
+      end
     end
 
     # @see height
     def height=(v)
-      Axlsx::validate_unsigned_numeric(v)
       unless v.nil?
-        @ht = v
+        Axlsx::validate_unsigned_numeric(v)
         @custom_height = true
+        @ht = v
       end
-      @ht
+    end
+    
+    # return cells
+    def cells
+      self
     end
 
     private
 
     # assigns the owning worksheet for this row
-    def worksheet=(v) DataTypeValidator.validate "Row.worksheet", Worksheet, v; @worksheet=v; end
+    def worksheet=(v) DataTypeValidator.validate :row_worksheet, Worksheet, v; @worksheet=v; end
 
     # Converts values, types, and style options into cells and associates them with this row.
     # A new cell is created for each item in the values array.
@@ -145,26 +146,14 @@ module Axlsx
     # @option options [Array, Symbol] types
     # @option options [Array, Integer] style
     def array_to_cells(values, options={})
-      values = values
-      DataTypeValidator.validate 'Row.array_to_cells', Array, values
+      DataTypeValidator.validate :array_to_cells, Array, values
       types, style, formula_values = options.delete(:types), options.delete(:style), options.delete(:formula_values)
       values.each_with_index do |value, index|
+        options[:style] = style.is_a?(Array) ? style[index] : style if style
+        options[:type] = types.is_a?(Array) ? types[index] : types if types
+        options[:formula_value] = formula_values[index] if formula_values.is_a?(Array)
 
-        #WTF IS THIS PAP?
-        cell_style = style.is_a?(Array) ? style[index] : style
-        options[:style] = cell_style if cell_style
-
-        cell_type = types.is_a?(Array)? types[index] : types
-        options[:type] = cell_type if cell_type
-
-        formula_value = formula_values[index] if formula_values.is_a?(Array)
-        options[:formula_value] = formula_value if formula_value
-
-        Cell.new(self, value, options)
-
-        options.delete(:style)
-        options.delete(:type)
-        options.delete(:formula_value)
+        self[index] = Cell.new(self, value, options)
       end
     end
   end

data/lib/axlsx/workbook/worksheet/row_breaks.rb

@@ -14,7 +14,7 @@ module Axlsx
     # @see Break
     def add_break(options)
       # force feed the excel default
-      @list << Break.new(options.merge(:max => 16383, :man => true))
+      self << Break.new(options.merge(:max => 16383, :man => true))
       last
     end
  
@@ -25,7 +25,7 @@ module Axlsx
     # </rowBreaks>
     def to_xml_string(str='')
       return if empty?
-      str << '<rowBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
+      str << ('<rowBreaks count="' << self.size.to_s << '" manualBreakCount="' << self.size.to_s << '">')
       each { |brk| brk.to_xml_string(str) }
       str << '</rowBreaks>'
     end

data/lib/axlsx/workbook/worksheet/selection.rb

@@ -95,9 +95,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<selection '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag 'selection', str
     end
   end
 end

data/lib/axlsx/workbook/worksheet/sheet_data.rb

@@ -17,7 +17,9 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<sheetData>'
-      worksheet.rows.each_with_index{ |row, index| row.to_xml_string(index, str) }
+      worksheet.rows.each_with_index do |row, index| 
+        row.to_xml_string(index, str) 
+      end
       str << '</sheetData>'
     end
     

data/lib/axlsx/workbook/worksheet/sheet_pr.rb

@@ -1,6 +1,6 @@
 module Axlsx
 
-  # The SheetPr class manages serialization fo a worksheet's sheetPr element.
+  # The SheetPr class manages serialization of a worksheet's sheetPr element.
   class SheetPr
     include Axlsx::OptionsParser
     include Axlsx::Accessors
@@ -8,7 +8,7 @@ module Axlsx
 
     serializable_attributes :sync_horizontal,
                             :sync_vertical,
-                            :transtion_evaluation,
+                            :transition_evaluation,
                             :transition_entry,
                             :published,
                             :filter_mode,
@@ -20,7 +20,7 @@ module Axlsx
     # waving magic show to set up the attriubte accessors
     boolean_attr_accessor :sync_horizontal,
                           :sync_vertical,
-                          :transtion_evaluation,
+                          :transition_evaluation,
                           :transition_entry,
                           :published,
                           :filter_mode,
@@ -33,6 +33,7 @@ module Axlsx
     def initialize(worksheet, options={})
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
       @worksheet = worksheet
+      @outline_pr = nil
       parse_options options
     end
 
@@ -40,12 +41,18 @@ module Axlsx
     # @return [Worksheet]
     attr_reader :worksheet
 
+    # The tab color of the sheet.
+    # @return [Color]
+    attr_reader :tab_color
+
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
     def to_xml_string(str = '')
       update_properties
       str << "<sheetPr #{serialized_attributes}>"
+      tab_color.to_xml_string(str, 'tabColor') if tab_color
+      outline_pr.to_xml_string(str) if @outline_pr
       page_setup_pr.to_xml_string(str)
       str << "</sheetPr>"
     end
@@ -55,6 +62,17 @@ module Axlsx
     def page_setup_pr
       @page_setup_pr ||= PageSetUpPr.new
     end
+    
+    # The OutlinePr for this sheet pr object
+    # @return [OutlinePr]
+    def outline_pr
+      @outline_pr ||= OutlinePr.new
+    end
+
+    # @see tab_color
+    def tab_color=(v)
+      @tab_color ||= Color.new(:rgb => v)
+    end
 
     private
 

data/lib/axlsx/workbook/worksheet/sheet_protection.rb

@@ -76,9 +76,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<sheetProtection '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag('sheetProtection', str)
     end
 
     private

data/lib/axlsx/workbook/worksheet/table.rb

@@ -58,7 +58,7 @@ module Axlsx
     # @param [String, Cell] v
     # @return [Title]
     def name=(v)
-      DataTypeValidator.validate "#{self.class}.name", [String], v
+      DataTypeValidator.validate :table_name, [String], v
       if v.is_a?(String)
         @name = v
       end
@@ -75,12 +75,12 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << '<table xmlns="' << XML_NS << '" id="' << (index+1).to_s << '" name="' << @name << '" displayName="' << @name.gsub(/\s/,'_') << '" '
-      str << 'ref="' << @ref << '" totalsRowShown="0">'
-      str << '<autoFilter ref="' << @ref << '"/>'
-      str << '<tableColumns count="' << header_cells.length.to_s << '">'
+      str << ('<table xmlns="' << XML_NS << '" id="' << (index+1).to_s << '" name="' << @name << '" displayName="' << @name.gsub(/\s/,'_') << '" ')
+      str << ('ref="' << @ref << '" totalsRowShown="0">')
+      str << ('<autoFilter ref="' << @ref << '"/>')
+      str << ('<tableColumns count="' << header_cells.length.to_s << '">')
       header_cells.each_with_index do |cell,index|
-        str << '<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>'
+        str << ('<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>')
       end
       str << '</tableColumns>'
       table_style_info.to_xml_string(str)

data/lib/axlsx/workbook/worksheet/table_style_info.rb

@@ -43,9 +43,7 @@ module Axlsx
     # seralizes this object to an xml string
     # @param [String] str the string to contact this objects serialization to.
     def to_xml_string(str = '')
-      str << '<tableStyleInfo '
-      serialized_attributes str
-      str << '/>'
+      serialized_tag('tableStyleInfo', str)
     end
   end
 end

data/lib/axlsx/workbook/worksheet/tables.rb

@@ -20,10 +20,13 @@ module Axlsx
       map{ |table| Relationship.new(table, TABLE_R, "../#{table.pn}") }
     end
 
+    # renders the tables xml
+    # @param [String] str
+    # @return [String]
     def to_xml_string(str = "")
       return if empty?
       str << "<tableParts count='#{size}'>"
-      @list.each { |table| str << "<tablePart r:id='#{table.rId}'/>" }
+      each { |table| str << "<tablePart r:id='#{table.rId}'/>" }
       str << '</tableParts>'
     end
   end