caxlsx 2.0.2 → 3.0.4

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

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

@@ -4,14 +4,7 @@ module Axlsx
   # The Worksheet class represents a worksheet in the workbook.
   class Worksheet
     include Axlsx::OptionsParser
-
-    # 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
+    include Axlsx::SerializedAttributes
 
     # Creates a new worksheet.
     # @note the recommended way to manage worksheets is Workbook#add_worksheet
@@ -24,12 +17,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, :state
+
     # Initalizes page margin, setup and print options
     # @param [Hash] options Options passed in from the initializer
     def initialize_page_options(options)
@@ -44,7 +40,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
@@ -76,7 +88,7 @@ module Axlsx
     # @see [SheetFormatPr]
     def sheet_format_pr
       @sheet_format_pr ||= SheetFormatPr.new
-      yeild @sheet_format_pr if block_given?
+      yield @sheet_format_pr if block_given?
       @sheet_format_pr
     end
 
@@ -129,7 +141,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
@@ -137,12 +149,12 @@ module Axlsx
     # cell at a specific index. The block will be called with the row and column
     # index in the missing cell was found.
     # @example
-    #     cols { |row_index, column_index| p "warn - row #{row_index} is does not have a cell at #{column_index}
+    #     cols { |row_index, column_index| puts "warn - row #{row_index} does not have a cell at #{column_index}" }
     def cols(&block)
       @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
@@ -249,7 +261,7 @@ module Axlsx
       @header_footer
     end
 
-    # convinience method to access all cells in this worksheet
+    # convenience method to access all cells in this worksheet
     # @return [Array] cells
     def cells
       rows.flatten
@@ -290,50 +302,6 @@ module Axlsx
       @sheet_pr ||= SheetPr.new self
     end
 
-    # Indicates if gridlines should be shown in the sheet.
-    # This is true by default.
-    # @return [Boolean]
-    # @deprecated Use SheetView#show_grid_lines= instead.
-    def show_gridlines=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines= has been depreciated. This value can be set over SheetView#show_grid_lines=.')
-      Axlsx::validate_boolean v
-      sheet_view.show_grid_lines = v
-    end
-
-    # @see selected
-    # @return [Boolean]
-    # @deprecated Use SheetView#tab_selected= instead.
-    def selected=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#selected= has been depreciated. This value can be set over SheetView#tab_selected=.')
-      Axlsx::validate_boolean v
-      sheet_view.tab_selected = v
-    end
-
-    # Indicates if the worksheet should show gridlines or not
-    # @return Boolean
-    # @deprecated Use SheetView#show_grid_lines instead.
-    def show_gridlines
-      warn('axlsx::DEPRECIATED: Worksheet#show_gridlines has been depreciated. This value can get over SheetView#show_grid_lines.')
-      sheet_view.show_grid_lines
-    end
-
-    # Indicates if the worksheet is selected in the workbook
-    # It is possible to have more than one worksheet selected, however it might cause issues
-    # in some older versions of excel when using copy and paste.
-    # @return Boolean
-    # @deprecated Use SheetView#tab_selected instead.
-    def selected
-      warn('axlsx::DEPRECIATED: Worksheet#selected has been depreciated. This value can get over SheetView#tab_selected.')
-      sheet_view.tab_selected
-    end
-
-    # (see #fit_to_page)
-    # @return [Boolean]
-    def fit_to_page=(v)
-      warn('axlsx::DEPRECIATED: Worksheet#fit_to_page has been depreciated. This value will automatically be set for you when you use PageSetup#fit_to.')
-      fit_to_page?
-    end
-
     # The name of the worksheet
     # The name of a worksheet must be unique in the workbook, and must not exceed 31 characters
     # @param [String] name
@@ -346,7 +314,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
 
@@ -419,6 +387,12 @@ module Axlsx
     # @example - use << alias
     #     ws << [3, 4, 5], :types => [nil, :float]
     #
+    # @example - specify whether a row should escape formulas or not
+    #     ws.add_row ['=IF(2+2=4,4,5)', 2, 3], :escape_formulas=>true
+    #
+    # @example - specify whether a certain cells in a row should escape formulas or not
+    #     ws.add_row ['=IF(2+2=4,4,5)', '=IF(13+13=4,4,5)'], :escape_formulas=>[true, false]
+    #
     # @see Worksheet#column_widths
     # @return [Row]
     # @option options [Array] values
@@ -426,11 +400,15 @@ module Axlsx
     # @option options [Array, Integer] style
     # @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)
+    # @option options [Array, Boolean] escape_formulas - Whether to treat a value starting with an equal
+    #    sign as formula (default) or as simple string.
+    #    Allowing user generated data to be interpreted as formulas can be dangerous
+    #   (see https://www.owasp.org/index.php/CSV_Injection for details).
     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 +500,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,12 +513,12 @@ 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
     # @note For updating only a single column it is probably easier to just set the width of the ws.column_info[col_index].width directly
-    # @param [Integer|Float|Fixnum|nil] widths
+    # @param [Integer|Float|nil] widths
     def column_widths(*widths)
       widths.each_with_index do |value, index|
         next if value == nil
@@ -559,7 +537,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 +555,27 @@ 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 << ('name="' << name << '" ')
+      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
@@ -606,7 +593,7 @@ module Axlsx
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
-    def [] (cell_def)
+    def [](cell_def)
       return rows[cell_def] if cell_def.is_a?(Integer)
       parts = cell_def.split(':').map{ |part| name_to_cell part }
       if parts.size == 1
@@ -622,7 +609,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,8 +662,10 @@ module Axlsx
     end
 
     def validate_sheet_name(name)
-      DataTypeValidator.validate "Worksheet.name", String, name
-      raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if name.size > 31
+      DataTypeValidator.validate :worksheet_name, String, name
+      # ignore first character (BOM) after encoding to utf16 because Excel does so, too.
+      character_length = name.encode("utf-16")[1..-1].encode("utf-16").bytesize / 2
+      raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if character_length > 31
       raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if '[]*/\?:'.chars.any? { |char| name.include? char }
       name = Axlsx::coder.encode(name)
       sheet_names = @workbook.worksheets.reject { |s| s == self }.map { |s| s.name }
@@ -695,8 +684,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 +723,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 +742,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 +755,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