caxlsx 3.3.0 → 4.0.0

data/lib/axlsx/workbook/workbook.rb

@@ -1,65 +1,65 @@
-# -*- coding: utf-8 -*-
+# 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/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/worksheet_hyperlink'
-require 'axlsx/workbook/worksheet/worksheet_hyperlinks'
-require 'axlsx/workbook/worksheet/break'
-require 'axlsx/workbook/worksheet/row_breaks'
-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/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'
+  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'
+  require 'axlsx/workbook/worksheet/row_breaks'
+  require 'axlsx/workbook/worksheet/col_breaks'
+  require 'axlsx/workbook/workbook_view'
+  require 'axlsx/workbook/workbook_views'
+  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.
   #
@@ -84,7 +84,6 @@ require 'axlsx/workbook/worksheet/selection.rb'
   #
   #   *workbookPr is only supported to the extend of date1904
   class Workbook
-
     BOLD_FONT_MULTIPLIER = 1.5
     FONT_SCALE_DIVISOR = 10.0
 
@@ -96,7 +95,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
 
     # @see use_shared_strings
     def use_shared_strings=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @use_shared_strings = v
     end
 
@@ -105,33 +104,32 @@ require 'axlsx/workbook/worksheet/selection.rb'
     attr_reader :is_reversed
 
     def is_reversed=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @is_reversed = v
     end
 
-
-   # A collection of worksheets associated with this workbook.
+    # A collection of worksheets associated with this workbook.
     # @note The recommended way to manage worksheets is add_worksheet
     # @see Workbook#add_worksheet
     # @see Worksheet
     # @return [SimpleTypedList]
     attr_reader :worksheets
 
-    # A colllection of charts associated with this workbook
+    # A collection of charts associated with this workbook
     # @note The recommended way to manage charts is Worksheet#add_chart
     # @see Worksheet#add_chart
     # @see Chart
     # @return [SimpleTypedList]
     attr_reader :charts
 
-    # A colllection of images associated with this workbook
+    # A collection of images associated with this workbook
     # @note The recommended way to manage images is Worksheet#add_image
     # @see Worksheet#add_image
     # @see Pic
     # @return [SimpleTypedList]
     attr_reader :images
 
-    # A colllection of drawings associated with this workbook
+    # A collection of drawings associated with this workbook
     # @note The recommended way to manage drawings is Worksheet#add_chart
     # @see Worksheet#add_chart
     # @see Drawing
@@ -140,15 +138,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
 
     # pretty sure this two are always empty and can be removed.
 
-
-    # A colllection of tables associated with this workbook
+    # A collection of tables associated with this workbook
     # @note The recommended way to manage drawings is Worksheet#add_table
     # @see Worksheet#add_table
     # @see Table
     # @return [SimpleTypedList]
     attr_reader :tables
 
-    # A colllection of pivot tables associated with this workbook
+    # A collection of pivot tables associated with this workbook
     # @note The recommended way to manage drawings is Worksheet#add_table
     # @see Worksheet#add_table
     # @see Table
@@ -174,7 +171,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @see Comment
     # @return [Comments]
     def comments
-      worksheets.map { |sheet| sheet.comments }.compact
+      worksheets.map(&:comments).compact
     end
 
     # The styles associated with this workbook
@@ -200,16 +197,16 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # 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
@@ -217,23 +214,21 @@ require 'axlsx/workbook/worksheet/selection.rb'
       self.styles_applied = true
     end
 
-
     # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
     @@date1904 = false
 
-
     # A quick helper to retrive a worksheet by name
     # @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
-    # The recomended way to work with workbooks is via Package#workbook
-    # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.
-    def initialize(options={})
+    # Creates a new Workbook.
+    # The recommended way to work with workbooks is via Package#workbook.
+    # @option options [Boolean] date1904 If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.
+    def initialize(options = {})
       @styles = Styles.new
       @worksheets = SimpleTypedList.new Worksheet
       @drawings = SimpleTypedList.new Drawing
@@ -243,13 +238,12 @@ require 'axlsx/workbook/worksheet/selection.rb'
       @tables = SimpleTypedList.new Table
       @pivot_tables = SimpleTypedList.new PivotTable
       @comments = SimpleTypedList.new Comments
-
-
       @use_autowidth = true
       @bold_font_multiplier = BOLD_FONT_MULTIPLIER
       @font_scale_divisor = FONT_SCALE_DIVISOR
 
-      self.date1904= !options[:date1904].nil? && options[:date1904]
+      self.escape_formulas = options[:escape_formulas].nil? ? Axlsx.escape_formulas : options[:escape_formulas]
+      self.date1904 = !options[:date1904].nil? && options[:date1904]
       yield self if block_given?
     end
 
@@ -258,16 +252,29 @@ require 'axlsx/workbook/worksheet/selection.rb'
     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
 
+    # 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.
+    # See https://www.owasp.org/index.php/CSV_Injection for details.
+    # @return [Boolean]
+    attr_reader :escape_formulas
+
+    # Sets whether to treat values starting with an equals sign as formulas or as literal strings.
+    # @param [Boolean] value The value to set.
+    def escape_formulas=(value)
+      Axlsx.validate_boolean(value)
+      @escape_formulas = value
+    end
+
     # Indicates if the workbook should use autowidths or not.
     # @note This gem no longer depends on RMagick for autowidth
     #     calculation. Thus the performance benefits of turning this off are
@@ -276,7 +283,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     def use_autowidth() @use_autowidth; end
 
     # 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
@@ -284,7 +291,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     attr_reader :bold_font_multiplier
 
     def bold_font_multiplier=(v)
-      Axlsx::validate_float v
+      Axlsx.validate_float v
       @bold_font_multiplier = v
     end
 
@@ -294,7 +301,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     attr_reader :font_scale_divisor
 
     def font_scale_divisor=(v)
-      Axlsx::validate_float v
+      Axlsx.validate_float v
       @font_scale_divisor = v
     end
 
@@ -306,7 +313,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @param [Hash] options Options to pass into the worksheed during initialization.
     # @option options [String] name The name of the worksheet
     # @option options [Hash] page_margins The page margins for the worksheet
-    def insert_worksheet(index=0, options={})
+    def insert_worksheet(index = 0, options = {})
       worksheet = Worksheet.new(self, options)
       @worksheets.delete_at(@worksheets.size - 1)
       @worksheets.insert(index, worksheet)
@@ -320,7 +327,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @option options [String] name The name of the worksheet.
     # @option options [Hash] page_margins The page margins for the worksheet.
     # @see Worksheet#initialize
-    def add_worksheet(options={})
+    def add_worksheet(options = {})
       worksheet = Worksheet.new(self, options)
       yield worksheet if block_given?
       worksheet
@@ -330,7 +337,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @return WorkbookViews
     # @option options [Hash] options passed into the added WorkbookView
     # @see WorkbookView#initialize
-    def add_view(options={})
+    def add_view(options = {})
       views << WorkbookView.new(options)
     end
 
@@ -347,14 +354,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
     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)
+      r << Relationship.new(self, STYLES_R, STYLES_PN)
       if use_shared_strings
-          r << Relationship.new(self, SHARED_STRINGS_R, SHARED_STRINGS_PN)
+        r << Relationship.new(self, SHARED_STRINGS_R, SHARED_STRINGS_PN)
       end
       r
     end
@@ -362,7 +369,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # 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.
@@ -380,28 +387,29 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # @param [Symbol] space must be one of :preserve or :default
     def xml_space=(space)
       Axlsx::RestrictionValidator.validate(:xml_space, [:preserve, :default], space)
-      @xml_space = space;
+      @xml_space = space
     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(/.+!/,"")]
+
+      worksheet[cell_def.gsub(/.+!/, "")]
     end
 
     # 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
@@ -414,12 +422,11 @@ require 'axlsx/workbook/worksheet/selection.rb'
       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
       str << '</workbook>'
     end
-
   end
 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"/>
@@ -19,19 +21,16 @@
 # </xsd:complexType>
 
 module Axlsx
-
   # A BookView defines the display properties for a workbook.
   # Units for window widths and other dimensions are expressed in twips.
   # Twip measurements are portable between different display resolutions.
   # The formula is (screen pixels) * (20 * 72) / (logical device dpi),
   # where the logical device dpi can be different for x and y coordinates.
   class WorkbookView
-
     include Axlsx::SerializedAttributes
     include Axlsx::OptionsParser
     include Axlsx::Accessors
 
-
     # Creates a new BookView object
     # @param [Hash] options  A hash of key/value pairs that will be mapped to this instances attributes.
     # @option [Symbol] visibility Specifies visible state of the workbook window. The default value for this attribute is :visible.
@@ -47,16 +46,15 @@ module Axlsx
     # @option [Integer] window_width Specifies the width of the workbook window. The unit of measurement for this value is twips.
     # @option [Integer] window_height Specifies the height of the workbook window. The unit of measurement for this value is twips.
     # @option [Boolean] auto_filter_date_grouping Specifies a boolean value that indicates whether to group dates when presenting the user with filtering options in the user interface.
-    def initialize(options={})
+    def initialize(options = {})
       parse_options options
       yield self if block_given?
     end
 
-
     unsigned_int_attr_accessor :x_window, :y_window, :window_width, :window_height,
                                :tab_ratio, :first_sheet, :active_tab
 
-    validated_attr_accessor  [:visibility], :validate_view_visibility
+    validated_attr_accessor [:visibility], :validate_view_visibility
 
     serializable_attributes :visibility, :minimized,
                             :show_horizontal_scroll, :show_vertical_scroll,
@@ -67,14 +65,13 @@ module Axlsx
     boolean_attr_accessor :minimized, :show_horizontal_scroll, :show_vertical_scroll,
                           :show_sheet_tabs, :auto_filter_date_grouping
 
-
     # Serialize the WorkbookView
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
-       str << '<workbookView '
-       serialized_attributes str
-       str << '></workbookView>'
+    def to_xml_string(str = +'')
+      str << '<workbookView '
+      serialized_attributes str
+      str << '></workbookView>'
     end
   end
 end

data/lib/axlsx/workbook/workbook_views.rb

@@ -1,7 +1,8 @@
+# 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
@@ -10,13 +11,12 @@ module Axlsx
     # Serialize to xml
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return if empty?
+
       str << "<bookViews>"
       each { |view| view.to_xml_string(str) }
       str << '</bookViews>'
     end
   end
 end
-
-

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

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
 
-require 'axlsx/workbook/worksheet/auto_filter/filter_column.rb'
-require 'axlsx/workbook/worksheet/auto_filter/filters.rb'
+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
+  # This class represents an auto filter range in a worksheet
   class AutoFilter
-
     # creates a new Autofilter object
     # @param [Worksheet] worksheet
     def initialize(worksheet)
       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'
@@ -27,7 +29,8 @@ module Axlsx
     # @return [String]
     def defined_name
       return unless range
-      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name)})
+
+      Axlsx.cell_range(range.split(':').collect { |name| worksheet.name_to_cell(name) })
     end
 
     # A collection of filterColumns for this auto_filter
@@ -47,31 +50,86 @@ 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] || []
+      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|
           next if row.hidden
+
           column.apply(row, column_offset)
         end
       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
 end