caxlsx 3.4.1 → 4.1.0

data/lib/axlsx/util/zip_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 require 'shellwords'
 
@@ -23,10 +25,10 @@ module Axlsx
     # Create a temporary directory for writing files to.
     #
     # The directory and its contents are removed at the end of the block.
-    def open(output, &block)
+    def open(output)
       Dir.mktmpdir do |dir|
         @dir = dir
-        block.call(self)
+        yield(self)
         write_file
         zip_parts(output)
       end
@@ -38,23 +40,21 @@ module Axlsx
       @current_file = "#{@dir}/#{entry.name}"
       @files << entry.name
       FileUtils.mkdir_p(File.dirname(@current_file))
+      @io = File.open(@current_file, "wb")
     end
 
     # Write to a buffer that will be written to the current entry
     def write(content)
-      @buffer << content
+      @io << content
     end
     alias << write
 
     private
 
     def write_file
-      if @current_file
-        @buffer.rewind
-        File.open(@current_file, "wb") { |f| f.write @buffer.read }
-      end
+      @io.close if @current_file
       @current_file = nil
-      @buffer = StringIO.new
+      @io = nil
     end
 
     def zip_parts(output)
@@ -63,8 +63,8 @@ module Axlsx
       escaped_dir = Shellwords.shellescape(@dir)
       command = "cd #{escaped_dir} && #{@zip_command} #{output} #{inputs}"
       stdout_and_stderr, status = Open3.capture2e(command)
-      if !status.success?
-        raise(ZipError.new(stdout_and_stderr))
+      unless status.success?
+        raise ZipError, stdout_and_stderr
       end
     end
   end

data/lib/axlsx/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The current version
-  VERSION = "3.4.1"
+  VERSION = "4.1.0"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  <definedNames>
 #    <definedName name="_xlnm.Print_Titles" localSheetId="0">Sheet1!$1:$1</definedName>
 #  </definedNames>
@@ -107,7 +109,7 @@ module Axlsx
     # The local sheet index (0-based)
     # @param [Integer] value the unsigned integer index of the sheet this defined_name applies to.
     def local_sheet_id=(value)
-      Axlsx::validate_unsigned_int(value)
+      Axlsx.validate_unsigned_int(value)
       @local_sheet_id = value
     end
 
@@ -118,12 +120,12 @@ module Axlsx
     serializable_attributes :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment,
                             :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden, :local_sheet_id
 
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       raise ArgumentError, 'you must specify the name for this defined name. Please read the documentation for Axlsx::DefinedName for more details' unless name
 
-      str << ('<definedName ' << 'name="' << name << '" ')
+      str << '<definedName ' << 'name="' << name << '" '
       serialized_attributes str
-      str << ('>' << @formula << '</definedName>')
+      str << '>' << @formula << '</definedName>'
     end
   end
 end

data/lib/axlsx/workbook/defined_names.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Axlsx
   # a simple types list of DefinedName objects
   class DefinedNames < SimpleTypedList
     # creates the DefinedNames object
     def initialize
-      super DefinedName
+      super(DefinedName)
     end
 
     # Serialize to xml
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return if empty?
 
       str << '<definedNames>'

data/lib/axlsx/workbook/shared_strings_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The Shared String Table class is responsible for managing and serializing common strings in a workbook.
   # While the ECMA-376 spec allows for both inline and shared strings it seems that at least some applications like iWorks Numbers
@@ -34,7 +36,7 @@ module Axlsx
       @index = 0
       @xml_space = xml_space
       @unique_cells = {}
-      @shared_xml_string = ""
+      @shared_xml_string = +''
       shareable_cells = cells.flatten.select { |cell| cell.plain_string? || cell.contains_rich_text? }
       @count = shareable_cells.size
       resolve(shareable_cells)
@@ -43,11 +45,11 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      Axlsx::sanitize(@shared_xml_string)
-      str << ('<?xml version="1.0" encoding="UTF-8"?><sst xmlns="' << XML_NS << '"')
-      str << (' count="' << @count.to_s << '" uniqueCount="' << unique_count.to_s << '"')
-      str << (' xml:space="' << xml_space.to_s << '">' << @shared_xml_string << '</sst>')
+    def to_xml_string(str = +'')
+      Axlsx.sanitize(@shared_xml_string)
+      str << '<?xml version="1.0" encoding="UTF-8"?><sst xmlns="' << XML_NS << '"'
+      str << ' count="' << @count.to_s << '" uniqueCount="' << unique_count.to_s << '"'
+      str << ' xml:space="' << xml_space.to_s << '">' << @shared_xml_string << '</sst>'
     end
 
     private

data/lib/axlsx/workbook/workbook.rb

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
+
 module Axlsx
-  require 'axlsx/workbook/worksheet/sheet_calc_pr.rb'
-  require 'axlsx/workbook/worksheet/auto_filter/auto_filter.rb'
-  require 'axlsx/workbook/worksheet/date_time_converter.rb'
-  require 'axlsx/workbook/worksheet/protected_range.rb'
-  require 'axlsx/workbook/worksheet/protected_ranges.rb'
+  require 'axlsx/workbook/worksheet/sheet_calc_pr'
+  require 'axlsx/workbook/worksheet/auto_filter/auto_filter'
+  require 'axlsx/workbook/worksheet/date_time_converter'
+  require 'axlsx/workbook/worksheet/protected_range'
+  require 'axlsx/workbook/worksheet/protected_ranges'
   require 'axlsx/workbook/worksheet/rich_text_run'
   require 'axlsx/workbook/worksheet/rich_text'
-  require 'axlsx/workbook/worksheet/cell_serializer.rb'
-  require 'axlsx/workbook/worksheet/cell.rb'
-  require 'axlsx/workbook/worksheet/page_margins.rb'
-  require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
-  require 'axlsx/workbook/worksheet/outline_pr.rb'
-  require 'axlsx/workbook/worksheet/page_setup.rb'
-  require 'axlsx/workbook/worksheet/header_footer.rb'
-  require 'axlsx/workbook/worksheet/print_options.rb'
-  require 'axlsx/workbook/worksheet/cfvo.rb'
-  require 'axlsx/workbook/worksheet/cfvos.rb'
-  require 'axlsx/workbook/worksheet/color_scale.rb'
-  require 'axlsx/workbook/worksheet/data_bar.rb'
-  require 'axlsx/workbook/worksheet/icon_set.rb'
-  require 'axlsx/workbook/worksheet/conditional_formatting.rb'
-  require 'axlsx/workbook/worksheet/conditional_formatting_rule.rb'
-  require 'axlsx/workbook/worksheet/conditional_formattings.rb'
-  require 'axlsx/workbook/worksheet/row.rb'
-  require 'axlsx/workbook/worksheet/col.rb'
-  require 'axlsx/workbook/worksheet/cols.rb'
-  require 'axlsx/workbook/worksheet/comments.rb'
-  require 'axlsx/workbook/worksheet/comment.rb'
-  require 'axlsx/workbook/worksheet/merged_cells.rb'
-  require 'axlsx/workbook/worksheet/sheet_protection.rb'
-  require 'axlsx/workbook/worksheet/sheet_pr.rb'
-  require 'axlsx/workbook/worksheet/dimension.rb'
-  require 'axlsx/workbook/worksheet/sheet_data.rb'
-  require 'axlsx/workbook/worksheet/worksheet_drawing.rb'
-  require 'axlsx/workbook/worksheet/worksheet_comments.rb'
+  require 'axlsx/workbook/worksheet/cell_serializer'
+  require 'axlsx/workbook/worksheet/cell'
+  require 'axlsx/workbook/worksheet/page_margins'
+  require 'axlsx/workbook/worksheet/page_set_up_pr'
+  require 'axlsx/workbook/worksheet/outline_pr'
+  require 'axlsx/workbook/worksheet/page_setup'
+  require 'axlsx/workbook/worksheet/header_footer'
+  require 'axlsx/workbook/worksheet/print_options'
+  require 'axlsx/workbook/worksheet/cfvo'
+  require 'axlsx/workbook/worksheet/cfvos'
+  require 'axlsx/workbook/worksheet/color_scale'
+  require 'axlsx/workbook/worksheet/data_bar'
+  require 'axlsx/workbook/worksheet/icon_set'
+  require 'axlsx/workbook/worksheet/conditional_formatting'
+  require 'axlsx/workbook/worksheet/conditional_formatting_rule'
+  require 'axlsx/workbook/worksheet/conditional_formattings'
+  require 'axlsx/workbook/worksheet/row'
+  require 'axlsx/workbook/worksheet/col'
+  require 'axlsx/workbook/worksheet/cols'
+  require 'axlsx/workbook/worksheet/comments'
+  require 'axlsx/workbook/worksheet/comment'
+  require 'axlsx/workbook/worksheet/merged_cells'
+  require 'axlsx/workbook/worksheet/sheet_protection'
+  require 'axlsx/workbook/worksheet/sheet_pr'
+  require 'axlsx/workbook/worksheet/dimension'
+  require 'axlsx/workbook/worksheet/sheet_data'
+  require 'axlsx/workbook/worksheet/worksheet_drawing'
+  require 'axlsx/workbook/worksheet/worksheet_comments'
   require 'axlsx/workbook/worksheet/worksheet_hyperlink'
   require 'axlsx/workbook/worksheet/worksheet_hyperlinks'
   require 'axlsx/workbook/worksheet/break'
@@ -41,22 +43,22 @@ module Axlsx
   require 'axlsx/workbook/worksheet/col_breaks'
   require 'axlsx/workbook/workbook_view'
   require 'axlsx/workbook/workbook_views'
-  require 'axlsx/workbook/worksheet/worksheet.rb'
-  require 'axlsx/workbook/shared_strings_table.rb'
-  require 'axlsx/workbook/defined_name.rb'
-  require 'axlsx/workbook/defined_names.rb'
-  require 'axlsx/workbook/worksheet/table_style_info.rb'
-  require 'axlsx/workbook/worksheet/table.rb'
-  require 'axlsx/workbook/worksheet/tables.rb'
-  require 'axlsx/workbook/worksheet/pivot_table_cache_definition.rb'
-  require 'axlsx/workbook/worksheet/pivot_table.rb'
-  require 'axlsx/workbook/worksheet/pivot_tables.rb'
-  require 'axlsx/workbook/worksheet/data_validation.rb'
-  require 'axlsx/workbook/worksheet/data_validations.rb'
-  require 'axlsx/workbook/worksheet/sheet_view.rb'
-  require 'axlsx/workbook/worksheet/sheet_format_pr.rb'
-  require 'axlsx/workbook/worksheet/pane.rb'
-  require 'axlsx/workbook/worksheet/selection.rb'
+  require 'axlsx/workbook/worksheet/worksheet'
+  require 'axlsx/workbook/shared_strings_table'
+  require 'axlsx/workbook/defined_name'
+  require 'axlsx/workbook/defined_names'
+  require 'axlsx/workbook/worksheet/table_style_info'
+  require 'axlsx/workbook/worksheet/table'
+  require 'axlsx/workbook/worksheet/tables'
+  require 'axlsx/workbook/worksheet/pivot_table_cache_definition'
+  require 'axlsx/workbook/worksheet/pivot_table'
+  require 'axlsx/workbook/worksheet/pivot_tables'
+  require 'axlsx/workbook/worksheet/data_validation'
+  require 'axlsx/workbook/worksheet/data_validations'
+  require 'axlsx/workbook/worksheet/sheet_view'
+  require 'axlsx/workbook/worksheet/sheet_format_pr'
+  require 'axlsx/workbook/worksheet/pane'
+  require 'axlsx/workbook/worksheet/selection'
 
   # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles.
   # The following parts of the Office Open XML spreadsheet specification are not implimented in this version.
@@ -93,7 +95,7 @@ module Axlsx
 
     # @see use_shared_strings
     def use_shared_strings=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @use_shared_strings = v
     end
 
@@ -102,7 +104,7 @@ module Axlsx
     attr_reader :is_reversed
 
     def is_reversed=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @is_reversed = v
     end
 
@@ -169,7 +171,7 @@ module Axlsx
     # @see Comment
     # @return [Comments]
     def comments
-      worksheets.map { |sheet| sheet.comments }.compact
+      worksheets.map(&:comments).compact
     end
 
     # The styles associated with this workbook
@@ -195,16 +197,16 @@ module Axlsx
     # A helper to apply styles that were added using `worksheet.add_style`
     # @return [Boolean]
     def apply_styles
-      return false if !styled_cells
+      return false unless styled_cells
 
       styled_cells.each do |cell|
         current_style = styles.style_index[cell.style]
 
-        if current_style
-          new_style = Axlsx.hash_deep_merge(current_style, cell.raw_style)
-        else
-          new_style = cell.raw_style
-        end
+        new_style = if current_style
+                      Axlsx.hash_deep_merge(current_style, cell.raw_style)
+                    else
+                      cell.raw_style
+                    end
 
         cell.style = styles.add_style(new_style)
       end
@@ -219,8 +221,8 @@ module Axlsx
     # @param [String] name The name of the sheet you are looking for
     # @return [Worksheet] The sheet found, or nil
     def sheet_by_name(name)
-      index = @worksheets.index { |sheet| sheet.name == name }
-      @worksheets[index] if index
+      encoded_name = Axlsx.coder.encode(name)
+      @worksheets.find { |sheet| sheet.name == encoded_name }
     end
 
     # Creates a new Workbook.
@@ -247,18 +249,28 @@ module Axlsx
 
     # Instance level access to the class variable 1904
     # @return [Boolean]
-    def date1904() @@date1904; end
+    def date1904
+      @@date1904
+    end
 
     # see @date1904
-    def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
+    def date1904=(v)
+      Axlsx.validate_boolean v
+      @@date1904 = v
+    end
 
     # Sets the date1904 attribute to the provided boolean
     # @return [Boolean]
-    def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end
+    def self.date1904=(v)
+      Axlsx.validate_boolean v
+      @@date1904 = v
+    end
 
     # retrieves the date1904 attribute
     # @return [Boolean]
-    def self.date1904() @@date1904; end
+    def self.date1904
+      @@date1904
+    end
 
     # Whether to treat values starting with an equals sign as formulas or as literal strings.
     # Allowing user-generated data to be interpreted as formulas is a security risk.
@@ -278,10 +290,13 @@ module Axlsx
     #     calculation. Thus the performance benefits of turning this off are
     #     marginal unless you are creating a very large sheet.
     # @return [Boolean]
-    def use_autowidth() @use_autowidth; end
+    attr_reader :use_autowidth
 
     # see @use_autowidth
-    def use_autowidth=(v = true) Axlsx::validate_boolean v; @use_autowidth = v; end
+    def use_autowidth=(v = true)
+      Axlsx.validate_boolean v
+      @use_autowidth = v
+    end
 
     # Font size of bold fonts is multiplied with this
     # Used for automatic calculation of cell widths with bold text
@@ -289,7 +304,7 @@ module Axlsx
     attr_reader :bold_font_multiplier
 
     def bold_font_multiplier=(v)
-      Axlsx::validate_float v
+      Axlsx.validate_float v
       @bold_font_multiplier = v
     end
 
@@ -299,7 +314,7 @@ module Axlsx
     attr_reader :font_scale_divisor
 
     def font_scale_divisor=(v)
-      Axlsx::validate_float v
+      Axlsx.validate_float v
       @font_scale_divisor = v
     end
 
@@ -352,10 +367,10 @@ module Axlsx
     def relationships
       r = Relationships.new
       @worksheets.each do |sheet|
-        r << Relationship.new(sheet, WORKSHEET_R, WORKSHEET_PN % (r.size + 1))
+        r << Relationship.new(sheet, WORKSHEET_R, format(WORKSHEET_PN, r.size + 1))
       end
       pivot_tables.each_with_index do |pivot_table, index|
-        r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, PIVOT_TABLE_CACHE_DEFINITION_PN % (index + 1))
+        r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, format(PIVOT_TABLE_CACHE_DEFINITION_PN, index + 1))
       end
       r << Relationship.new(self, STYLES_R, STYLES_PN)
       if use_shared_strings
@@ -367,7 +382,7 @@ module Axlsx
     # generates a shared string object against all cells in all worksheets.
     # @return [SharedStringTable]
     def shared_strings
-      SharedStringsTable.new(worksheets.collect { |ws| ws.cells }, xml_space)
+      SharedStringsTable.new(worksheets.collect(&:cells), xml_space)
     end
 
     # The xml:space attribute for the worksheet.
@@ -389,12 +404,12 @@ module Axlsx
     end
 
     # returns a range of cells in a worksheet
-    # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to
+    # @param [String] cell_def The Excel style reference defining the worksheet and cells. The range must specify the sheet to
     # retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell.
     # @return [Cell, Array]
     def [](cell_def)
-      sheet_name = cell_def.split('!')[0] if cell_def.match('!')
-      worksheet =  self.worksheets.select { |s| s.name == sheet_name }.first
+      sheet_name = cell_def.split('!')[0] if cell_def.include?('!')
+      worksheet =  worksheets.find { |s| s.name == sheet_name }
       raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet)
 
       worksheet[cell_def.gsub(/.+!/, "")]
@@ -403,11 +418,11 @@ module Axlsx
     # Serialize the workbook
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-      add_worksheet(name: 'Sheet1') unless worksheets.size > 0
+    def to_xml_string(str = +'')
+      add_worksheet(name: 'Sheet1') if worksheets.empty?
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<workbook xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '">')
-      str << ('<workbookPr date1904="' << @@date1904.to_s << '"/>')
+      str << '<workbook xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '">'
+      str << '<workbookPr date1904="' << @@date1904.to_s << '"/>'
       views.to_xml_string(str)
       str << '<sheets>'
       if is_reversed
@@ -420,7 +435,7 @@ module Axlsx
       unless pivot_tables.empty?
         str << '<pivotCaches>'
         pivot_tables.each do |pivot_table|
-          str << ('<pivotCache cacheId="' << pivot_table.cache_definition.cache_id.to_s << '" r:id="' << pivot_table.cache_definition.rId << '"/>')
+          str << '<pivotCache cacheId="' << pivot_table.cache_definition.cache_id.to_s << '" r:id="' << pivot_table.cache_definition.rId << '"/>'
         end
         str << '</pivotCaches>'
       end

data/lib/axlsx/workbook/workbook_view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # <xsd:complexType name="CT_BookView">
 #     <xsd:sequence>
 #       <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
@@ -66,7 +68,7 @@ module Axlsx
     # Serialize the WorkbookView
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       str << '<workbookView '
       serialized_attributes str
       str << '></workbookView>'

data/lib/axlsx/workbook/workbook_views.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Axlsx
   # a simple types list of BookView objects
   class WorkbookViews < SimpleTypedList
     # creates the book views object
     def initialize
-      super WorkbookView
+      super(WorkbookView)
     end
 
     # Serialize to xml
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return if empty?
 
       str << "<bookViews>"

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

@@ -1,5 +1,8 @@
-require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
-require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
+# frozen_string_literal: true
+
+require 'axlsx/workbook/worksheet/auto_filter/filter_column'
+require 'axlsx/workbook/worksheet/auto_filter/filters'
+require 'axlsx/workbook/worksheet/auto_filter/sort_state'
 
 module Axlsx
   # This class represents an auto filter range in a worksheet
@@ -10,9 +13,10 @@ module Axlsx
       raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
 
       @worksheet = worksheet
+      @sort_on_generate = true
     end
 
-    attr_reader :worksheet
+    attr_reader :worksheet, :sort_on_generate
 
     # The range the autofilter should be applied to.
     # This should be a string like 'A1:B8'
@@ -46,15 +50,50 @@ module Axlsx
       columns.last
     end
 
-    # actually performs the filtering of rows who's cells do not
-    # match the filter.
+    # Performs the sorting of the rows based on the sort_state conditions. Then it actually performs
+    # the filtering of rows who's cells do not match the filter.
     def apply
       first_cell, last_cell = range.split(':')
-      start_point = Axlsx::name_to_indices(first_cell)
-      end_point = Axlsx::name_to_indices(last_cell)
+      start_point = Axlsx.name_to_indices(first_cell)
+      end_point = Axlsx.name_to_indices(last_cell)
       # The +1 is so we skip the header row with the filter drop downs
       rows = worksheet.rows[(start_point.last + 1)..end_point.last] || []
 
+      # the sorting of the rows if sort_conditions are available.
+      if !sort_state.sort_conditions.empty? && sort_on_generate
+        sort_conditions = sort_state.sort_conditions
+        sorted_rows = rows.sort do |row1, row2|
+          comparison = 0
+
+          sort_conditions.each do |condition|
+            cell_value_row1 = row1.cells[condition.column_index + start_point.first].value
+            cell_value_row2 = row2.cells[condition.column_index + start_point.first].value
+            custom_list = condition.custom_list
+            comparison = if cell_value_row1.nil? || cell_value_row2.nil?
+                           cell_value_row1.nil? ? 1 : -1
+                         elsif custom_list.empty?
+                           condition.order == :asc ? cell_value_row1 <=> cell_value_row2 : cell_value_row2 <=> cell_value_row1
+                         else
+                           index1 = custom_list.index(cell_value_row1) || custom_list.size
+                           index2 = custom_list.index(cell_value_row2) || custom_list.size
+
+                           condition.order == :asc ? index1 <=> index2 : index2 <=> index1
+                         end
+
+            break unless comparison.zero?
+          end
+
+          comparison
+        end
+        insert_index = start_point.last + 1
+
+        sorted_rows.each do |row|
+          # Insert the row at the specified index
+          worksheet.rows[insert_index] = row
+          insert_index += 1
+        end
+      end
+
       column_offset = start_point.first
       columns.each do |column|
         rows.each do |row|
@@ -65,13 +104,31 @@ module Axlsx
       end
     end
 
+    # the SortState object for this AutoFilter
+    # @return [SortState]
+    def sort_state
+      @sort_state ||= SortState.new self
+    end
+
+    # @param [Boolean] v Flag indicating whether the AutoFilter should sort the rows when generating the
+    # file. If false, the sorting rules will need to be applied manually after generating to alter
+    # the order of the rows.
+    # @return [Boolean]
+    def sort_on_generate=(v)
+      Axlsx.validate_boolean v
+      @sort_on_generate = v
+    end
+
     # serialize the object
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return unless range
 
       str << "<autoFilter ref='#{range}'>"
       columns.each { |filter_column| filter_column.to_xml_string(str) }
+      unless @sort_state.nil?
+        @sort_state.to_xml_string(str)
+      end
       str << "</autoFilter>"
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # The filterColumn collection identifies a particular column in the AutoFilter
   # range and specifies filter information that has been applied to this column.
@@ -26,7 +28,7 @@ module Axlsx
     serializable_attributes :col_id, :hidden_button, :show_button
 
     # Allowed filters
-    FILTERS = [:filters] # , :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
+    FILTERS = [:filters].freeze # , :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
 
     # Zero-based index indicating the AutoFilter column to which this filter information applies.
     # @return [Integer]
@@ -41,7 +43,9 @@ module Axlsx
     # the filter button can be hidden, and not drawn.
     # @return [Boolean]
     def show_button
-      @show_button ||= true
+      return @show_button if defined?(@show_button)
+
+      true
     end
 
     # Flag indicating whether the AutoFilter button for this column is hidden.
@@ -81,12 +85,14 @@ module Axlsx
     # @return [Boolean]
     def show_button=(show)
       Axlsx.validate_boolean show
-      @show_botton = show
+      @show_button = show
     end
 
     # Serialize the object to xml
-    def to_xml_string(str = '')
-      str << "<filterColumn #{serialized_attributes}>"
+    def to_xml_string(str = +'')
+      str << '<filterColumn '
+      serialized_attributes(str)
+      str << '>'
       @filter.to_xml_string(str)
       str << "</filterColumn>"
     end