axlsx 2.0.1 → 2.1.0.pre

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,48 @@ 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
+      each_with_index do | cell, index |
+        cell.style = style.is_a?(Array) ? style[index] : style
       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
-    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 +139,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_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

@@ -23,7 +23,7 @@ module Axlsx
     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

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

@@ -4,15 +4,11 @@ module Axlsx
   # The Worksheet class represents a worksheet in the workbook.
   class Worksheet
     include Axlsx::OptionsParser
-
+    include Axlsx::SerializedAttributes
     # definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count.
     # This is used for autowidth calculations
-    # @return [String]
-    def self.thin_chars
-      # removed 'e' and 'y' from this list - as a GUESS
-      @thin_chars ||= "^.acfijklrstxzFIJL()-"
-    end
-
+    THIN_CHARS = '^.acfijklrstxzFIJL()-'.freeze
+    
     # Creates a new worksheet.
     # @note the recommended way to manage worksheets is Workbook#add_worksheet
     # @see Workbook#add_worksheet
@@ -24,12 +20,15 @@ module Axlsx
     def initialize(wb, options={})
       self.workbook = wb
       @sheet_protection = nil
-
       initialize_page_options(options)
       parse_options options
       @workbook.worksheets << self
+      @sheet_id = index + 1
+      yield self if block_given?
     end
 
+    serializable_attributes :sheet_id, :name, :state
+
     # Initalizes page margin, setup and print options
     # @param [Hash] options Options passed in from the initializer
     def initialize_page_options(options)
@@ -44,7 +43,23 @@ module Axlsx
     # The name of the worksheet
     # @return [String]
     def name
-      @name ||=  "Sheet" + (index+1).to_s
+      @name ||= "Sheet" + (index+1).to_s
+    end
+
+    # Specifies the visible state of this sheet. Allowed states are
+    # :visible, :hidden or :very_hidden. The default value is :visible.
+    #
+    # Worksheets in the :hidden state can be shown using the sheet formatting properties in excel.
+    # :very_hidden sheets should be inaccessible to end users.
+    # @param [Symbol] sheet_state The visible state for this sheet.
+    def state=(sheet_state)
+      RestrictionValidator.validate :worksheet_state, [:visible, :hidden, :very_hidden], sheet_state
+      @state = sheet_state
+    end
+
+    # The visibility of this sheet
+    def state
+      @state ||= :visible
     end
 
     # The sheet calculation properties
@@ -129,7 +144,7 @@ module Axlsx
     # @return [SimpleTypedList]
     # @see Worksheet#add_row
     def rows
-      @rows ||=  SimpleTypedList.new Row
+      @rows ||= SimpleTypedList.new Row
     end
 
     # returns the sheet data as columns
@@ -142,7 +157,7 @@ module Axlsx
       @rows.transpose(&block)
     end
 
-    # An range that excel will apply an auto-filter to "A1:B3"
+    # A range that excel will apply an auto-filter to "A1:B3"
     # This will turn filtering on for the cells in the range.
     # The first row is considered the header, while subsequent rows are considered to be data.
     # @return String
@@ -346,7 +361,7 @@ module Axlsx
     # @param [String] v
     # @see auto_filter
     def auto_filter=(v)
-      DataTypeValidator.validate "Worksheet.auto_filter", String, v
+      DataTypeValidator.validate :worksheet_auto_filter, String, v
       auto_filter.range = v
     end
 
@@ -427,10 +442,10 @@ module Axlsx
     # @option options [Array] widths each member of the widths array will affect how auto_fit behavies.
     # @option options [Float] height the row's height (in points)
     def add_row(values=[], options={})
-      Row.new(self, values, options)
-      update_column_info @rows.last.cells, options.delete(:widths) || []
-      yield @rows.last if block_given?
-      @rows.last
+      row = Row.new(self, values, options)
+      update_column_info row, options.delete(:widths)
+      yield row if block_given?
+      row
     end
 
     alias :<< :add_row
@@ -522,7 +537,7 @@ module Axlsx
     # @example
     #   ws.add_page_break("A4")
     def add_page_break(cell)
-      DataTypeValidator.validate "Worksheet#add_page_break cell", [String, Cell], cell
+      DataTypeValidator.validate :worksheet_page_break, [String, Cell], cell
       column_index, row_index = if cell.is_a?(String)
           Axlsx.name_to_indices(cell)
         else
@@ -535,7 +550,7 @@ module Axlsx
     end
 
     # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
-    # Axlsx is sparse, so if you have not set data for a column, you cannot set the width.
+    # Note that you must call column_widths AFTER adding data, otherwise the width will not be set successfully.
     # Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.
     # @example This would set the first and third column widhts but leave the second column in autofit state.
     #      ws.column_widths 7.2, nil, 3
@@ -559,7 +574,7 @@ module Axlsx
     # @see README.md for an example
     def col_style(index, style, options={})
       offset = options.delete(:row_offset) || 0
-      cells = @rows[(offset..-1)].map { |row| row.cells[index] }.flatten.compact
+      cells = @rows[(offset..-1)].map { |row| row[index] }.flatten.compact
       cells.each { |cell| cell.style = style }
     end
 
@@ -577,18 +592,26 @@ module Axlsx
       cells.each { |cell| cell.style = style }
     end
 
+    # Returns a sheet node serialization for this sheet in the workbook.
+    def to_sheet_node_xml_string(str='')
+      add_autofilter_defined_name_to_workbook
+      str << '<sheet '
+      serialized_attributes str
+      str << ('r:id="' << rId << '"></sheet>')
+    end
+
     # Serializes the worksheet object to an xml string
     # This intentionally does not use nokogiri for performance reasons
     # @return [String]
-    def to_xml_string
+    def to_xml_string str=''
+      add_autofilter_defined_name_to_workbook
       auto_filter.apply if auto_filter.range
-      str = '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << worksheet_node
       serializable_parts.each do |item|
         item.to_xml_string(str) if item
       end
       str << '</worksheet>'
-      Axlsx::sanitize(str)
     end
 
     # The worksheet relationships. This is managed automatically by the worksheet
@@ -622,7 +645,7 @@ module Axlsx
     def name_to_cell(name)
       col_index, row_index = *Axlsx::name_to_indices(name)
       r = rows[row_index]
-      r.cells[col_index] if r
+      r[col_index] if r
     end
 
     # shortcut method to access styles direclty from the worksheet
@@ -675,7 +698,7 @@ module Axlsx
     end
 
     def validate_sheet_name(name)
-      DataTypeValidator.validate "Worksheet.name", String, name
+      DataTypeValidator.validate :worksheet_name, String, name
       raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if name.size > 31
       raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if '[]*/\?:'.chars.any? { |char| name.include? char }
       name = Axlsx::coder.encode(name)
@@ -695,8 +718,8 @@ module Axlsx
     def range(*cell_def)
       first, last = cell_def
       cells = []
-      rows[(first.row.index..last.row.index)].each do |r|
-        r.cells[(first.index..last.index)].each do |c|
+      rows[(first.row.row_index..last.row.row_index)].each do |r|
+        r[(first.index..last.index)].each do |c|
           cells << c
         end
       end
@@ -734,7 +757,7 @@ module Axlsx
     # Helper method for parsingout the root node for worksheet
     # @return [String]
     def worksheet_node
-       "<worksheet xmlns=\"%s\" xmlns:r=\"%s\" xml:space=\"#{xml_space}\">" % [XML_NS, XML_NS_R]
+      "<worksheet xmlns=\"#{XML_NS}\" xmlns:r=\"#{XML_NS_R}\" xml:space=\"#{xml_space}\">"
     end
 
     def sheet_data
@@ -753,11 +776,12 @@ module Axlsx
 
     def workbook=(v) DataTypeValidator.validate "Worksheet.workbook", Workbook, v; @workbook = v; end
 
-    def update_column_info(cells, widths=[])
+    def update_column_info(cells, widths=nil)
       cells.each_with_index do |cell, index|
+        width = widths ? widths[index] : nil
         col = find_or_create_column_info(index)
-        next if widths[index] == :ignore
-        col.update_width(cell, widths[index], workbook.use_autowidth)
+        next if width == :ignore
+        col.update_width(cell, width, workbook.use_autowidth)
       end
     end
 
@@ -765,5 +789,10 @@ module Axlsx
       column_info[index] ||= Col.new(index + 1, index + 1)
     end
 
+    def add_autofilter_defined_name_to_workbook
+      return if !auto_filter.range
+      workbook.add_defined_name auto_filter.defined_name, name: '_xlnm._FilterDatabase', local_sheet_id: index, hidden: 1
+    end
+
   end
 end