caxlsx 3.3.0 → 4.0.0

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

@@ -1,10 +1,11 @@
+# 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.
   # If a column in the AutoFilter range has no criteria specified,
   # then there is no corresponding filterColumn collection expressed for that column.
   class FilterColumn
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -17,7 +18,7 @@ module Axlsx
     # @option [Boolean] show_button @see show_button
     def initialize(col_id, filter_type, options = {})
       RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
-      #Axlsx::validate_unsigned_int(col_id)
+      # Axlsx::validate_unsigned_int(col_id)
       self.col_id = col_id
       parse_options options
       @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
@@ -27,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]
@@ -52,7 +53,7 @@ module Axlsx
     end
 
     # Sets the col_id attribute for this filter column.
-    # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies. 
+    # @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.
     #                         When you specify a cell, the column index will be read off the cell
     # @return [Integer]
     def col_id=(column_index)
@@ -65,8 +66,9 @@ module Axlsx
     # @param [Array] row A row from a worksheet that needs to be
     # filtered.
     def apply(row, offset)
-      row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
+      row.hidden = @filter.apply(row.cells[offset + col_id.to_i])
     end
+
     # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
     # @return [Boolean]
     def hidden_button=(hidden)
@@ -85,8 +87,10 @@ module Axlsx
     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

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

@@ -1,6 +1,7 @@
-module Axlsx
+# frozen_string_literal: true
 
-  # When multiple values are chosen to filter by, or when a group of date values are chosen to filter by, 
+module Axlsx
+  # When multiple values are chosen to filter by, or when a group of date values are chosen to filter by,
   # this object groups those criteria together.
   class Filters
     include Axlsx::OptionsParser
@@ -16,20 +17,20 @@ module Axlsx
     # @note The recommended way to interact with filter objects is via AutoFilter#add_column
     # @example
     #   ws.auto_filter.add_column(0, :filters, :blank => true, :calendar_type => 'japan', :filter_items => [100, 'a'])
-    def initialize(options={})
+    def initialize(options = {})
       parse_options options
     end
 
     serializable_attributes :blank, :calendar_type
 
     # Allowed calendar types
-    CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none)
+    CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none).freeze
 
     # Flag indicating whether to filter by blank.
     # @return [Boolean]
     attr_reader :blank
 
-    # Calendar type for date grouped items. 
+    # Calendar type for date grouped items.
     # Used to interpret the values in dateGroupItem.
     # This is the calendar type used to evaluate all dates in the filter column,
     # even when those dates are not using the same calendar system / date formatting.
@@ -42,6 +43,7 @@ module Axlsx
     # TODO implement this for date filters as well!
     def apply(cell)
       return false unless cell
+
       filter_items.each do |filter|
         return false if cell.value == filter.val
       end
@@ -74,14 +76,16 @@ module Axlsx
     end
 
     # Serialize the object to xml
-    def to_xml_string(str = '')
-      str << "<filters #{serialized_attributes}>"
-      filter_items.each {  |filter| filter.to_xml_string(str) }
+    def to_xml_string(str = +'')
+      str << '<filters '
+      serialized_attributes(str)
+      str << '>'
+      filter_items.each { |filter| filter.to_xml_string(str) }
       date_group_items.each { |date_group_item| date_group_item.to_xml_string(str) }
       str << '</filters>'
     end
 
-    # not entirely happy with this. 
+    # not entirely happy with this.
     # filter_items should be a simple typed list that overrides << etc
     # to create Filter objects from the inserted values. However this
     # is most likely so rarely used...(really? do you know that?)
@@ -98,13 +102,13 @@ module Axlsx
     def date_group_items=(options)
       options.each do |date_group|
         raise ArgumentError, "date_group_items should be an array of hashes specifying the options for each date_group_item" unless date_group.is_a?(Hash)
+
         date_group_items << DateGroupItem.new(date_group)
       end
     end
 
     # This class expresses a filter criteria value.
     class Filter
-
       # Creates a new filter value object
       # @param [Any] value   The value of the filter. This is not restricted, but
       #                       will be serialized via to_s so if you are passing an object
@@ -113,18 +117,16 @@ module Axlsx
         @val = value
       end
 
-
-      #Filter value used in the criteria.
+      # Filter value used in the criteria.
       attr_accessor :val
 
       # Serializes the filter value object
       # @param [String] str The string to concact the serialization information to.
-      def to_xml_string(str = '')
-        str << "<filter val='#{@val.to_s}' />"
+      def to_xml_string(str = +'')
+        str << "<filter val='#{@val}' />"
       end
     end
 
-
     # This collection is used to express a group of dates or times which are
     # used in an AutoFilter criteria. Values are always written in the calendar
     # type of the first date encountered in the filter range, so that all
@@ -132,7 +134,7 @@ module Axlsx
     # types, can be correctly compared for the purposes of filtering.
     class DateGroupItem
       include Axlsx::OptionsParser
-include Axlsx::SerializedAttributes
+      include Axlsx::SerializedAttributes
 
       # Creates a new DateGroupItem
       # @param [Hash] options A hash of options to use when
@@ -145,16 +147,17 @@ include Axlsx::SerializedAttributes
       # @option [Integer] hour @see hour
       # @option [Integer] minute @see minute
       # @option [Integer] second @see second
-      def initialize(options={})
-        raise ArgumentError,  "You must specify a year for date time grouping" unless options[:year]
+      def initialize(options = {})
+        raise ArgumentError, "You must specify a year for date time grouping" unless options[:year]
         raise ArgumentError, "You must specify a date_time_grouping when creating a DateGroupItem for auto filter" unless options[:date_time_grouping]
+
         parse_options options
       end
 
       serializable_attributes :date_time_grouping, :year, :month, :day, :hour, :minute, :second
 
       # Allowed date time groupings
-      DATE_TIME_GROUPING = %w(year month day hour minute second)
+      DATE_TIME_GROUPING = %w(year month day hour minute second).freeze
 
       # Grouping level
       # This must be one of year, month, day, hour, minute or second.
@@ -200,7 +203,7 @@ include Axlsx::SerializedAttributes
       end
 
       # The day value for the date group item
-      # This must be between 1 and 31 
+      # This must be between 1 and 31
       # @note no attempt is made to ensure the date value is valid for any given month
       def day=(value)
         RangeValidator.validate "DateGroupItem.day", 0, 31, value
@@ -236,7 +239,7 @@ include Axlsx::SerializedAttributes
 
       # Serialize the object to xml
       # @param [String] str The string object this serialization will be concatenated to.
-      def to_xml_string(str = '')
+      def to_xml_string(str = +'')
         serialized_tag('dateGroupItem', str)
       end
     end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Axlsx
+  # This class represents a individual sort condition belonging to the sort state of an auto filter
+  class SortCondition
+    # Creates a new SortCondition object
+    # @param [Integer] column_index Zero-based index indicating the AutoFilter column to which the sorting should be applied to
+    # @param [Symbol] order The order the column should be sorted on, can only be :asc or :desc
+    # @param [Array] custom_list An array containg a custom sorting list in order.
+    def initialize(column_index:, order:, custom_list:)
+      Axlsx.validate_int column_index
+      @column_index = column_index
+
+      RestrictionValidator.validate 'SortCondition.order', [:asc, :desc], order
+      @order = order
+
+      DataTypeValidator.validate :sort_condition_custom_list, Array, custom_list
+      @custom_list = custom_list
+    end
+
+    attr_reader :column_index, :order, :custom_list
+
+    # converts the ref String from the sort_state to a string representing the ref of a single column
+    # for the xml string to be returned.
+    def ref_to_single_column(ref, column_index)
+      first_cell, last_cell = ref.split(':')
+
+      start_point = Axlsx.name_to_indices(first_cell)
+
+      first_row = first_cell[/\d+/]
+      last_row = last_cell[/\d+/]
+
+      first_column = Axlsx.col_ref(column_index + start_point.first)
+      last_column = first_column
+
+      "#{first_column}#{first_row}:#{last_column}#{last_row}"
+    end
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str, ref)
+      ref = ref_to_single_column(ref, column_index)
+
+      str << "<sortCondition "
+      str << "descending='1' " if order == :desc
+      str << "ref='#{ref}' "
+      str << "customList='#{custom_list.join(',')}' " unless custom_list.empty?
+      str << "/>"
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'axlsx/workbook/worksheet/auto_filter/sort_condition'
+
+module Axlsx
+  # This class performs sorting on a range in a worksheet
+  class SortState
+    # creates a new SortState object
+    # @param [AutoFilter] auto_filter the auto_filter that this sort_state belongs to
+    def initialize(auto_filter)
+      @auto_filter = auto_filter
+    end
+
+    # A collection of SortConditions for this sort_state
+    # @return [SimpleTypedList]
+    def sort_conditions
+      @sort_conditions ||= SimpleTypedList.new SortCondition
+    end
+
+    # Adds a SortCondition to the sort_state. This is the recommended way to add conditions to it.
+    # It requires a column_index for the sorting, descending and the custom order are optional.
+    # @param [Integer] column_index Zero-based index indicating the AutoFilter column to which the sorting should be applied to
+    # @param [Symbol] order The order the column should be sorted on, can only be :asc or :desc
+    # @param [Array] custom_list An array containg a custom sorting list in order.
+    # @return [SortCondition]
+    def add_sort_condition(column_index:, order: :asc, custom_list: [])
+      sort_conditions << SortCondition.new(column_index: column_index, order: order, custom_list: custom_list)
+      sort_conditions.last
+    end
+
+    # method to increment the String representing the first cell of the range of the autofilter by 1 row for the sortCondition
+    # xml string
+    def increment_cell_value(str)
+      letter = str[/[A-Za-z]+/]
+      number = str[/\d+/].to_i
+
+      incremented_number = number + 1
+
+      "#{letter}#{incremented_number}"
+    end
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str = +'')
+      return if sort_conditions.empty?
+
+      ref = @auto_filter.range
+      first_cell, last_cell = ref.split(':')
+      ref = "#{increment_cell_value(first_cell)}:#{last_cell}"
+
+      str << "<sortState xmlns:xlrd2='http://schemas.microsoft.com/office/spreadsheetml/2017/richdata2' ref='#{ref}'>"
+      sort_conditions.each { |sort_condition| sort_condition.to_xml_string(str, ref) }
+      str << "</sortState>"
+    end
+  end
+end

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

@@ -1,39 +1,45 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module Axlsx
   class BorderCreator
-    attr_reader :worksheet, :cells, :edges, :width, :color
-
-    def initialize(worksheet, cells, args)
+    def initialize(worksheet:, cells:, edges: nil, style: nil, color: nil)
       @worksheet = worksheet
-      @cells     = cells
-      if args.is_a?(Hash)
-        @edges = args[:edges] || Axlsx::Border::EDGES
-        @width = args[:style] || :thin
-        @color = args[:color] || '000000'
-      else
-        @edges = args || Axlsx::Border::Edges
-        @width = :thin
-        @color = '000000'
-      end
+      @cells = cells
+
+      @edges = edges || :all
+      @style = style || :thin
+      @color = color || "000000"
 
       if @edges == :all
         @edges = Axlsx::Border::EDGES
-      elsif @edges.is_a?(Array)
-        @edges = (@edges.map(&:to_sym).uniq & Axlsx::Border::EDGES)
+      elsif !@edges.is_a?(Array)
+        raise ArgumentError, "Invalid edges provided, #{@edges}"
       else
-        @edges = []
+        @edges = @edges.map { |x| x&.to_sym }.uniq
+
+        unless (@edges - Axlsx::Border::EDGES).empty?
+          raise ArgumentError, "Invalid edges provided, #{edges}"
+        end
       end
     end
 
     def draw
-      @edges.each do |edge| 
-        worksheet.add_style(
-          border_cells[edge], 
+      if @cells.size == 1
+        @worksheet.add_style(
+          first_cell,
           {
-            border: {style: @width, color: @color, edges: [edge]}
+            border: { style: @style, color: @color, edges: @edges }
           }
         )
+      else
+        @edges.each do |edge|
+          @worksheet.add_style(
+            border_cells[edge],
+            {
+              border: { style: @style, color: @color, edges: [edge] }
+            }
+          )
+        end
       end
     end
 
@@ -44,16 +50,16 @@ module Axlsx
         top:     "#{first_cell}:#{last_col}#{first_row}",
         right:   "#{last_col}#{first_row}:#{last_cell}",
         bottom:  "#{first_col}#{last_row}:#{last_cell}",
-        left:    "#{first_cell}:#{first_col}#{last_row}",
+        left:    "#{first_cell}:#{first_col}#{last_row}"
       }
     end
 
     def first_cell
-      @first_cell ||= cells.first.r
+      @first_cell ||= @cells.first.r
     end
 
     def last_cell
-      @last_cell ||= cells.last.r
+      @last_cell ||= @cells.last.r
     end
 
     def first_row
@@ -71,6 +77,5 @@ module Axlsx
     def last_col
       @last_col ||= last_cell.scan(/\D+/).first
     end
-
   end
 end

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

@@ -1,9 +1,9 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # The Break class stores the details for row and column page breaks.
   # @see RowBreaks, ColBreaks
   class Break
-
     include Axlsx::OptionsParser
     include Axlsx::Accessors
     include Axlsx::SerializedAttributes
@@ -15,7 +15,7 @@ module Axlsx
     # @option options [Integer] max Zero-based index of end row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index.
     # @option options [Boolean] man Manual Break flag. 1 means the break is a manually inserted break.
     # @option option [Boolean] pt Flag indicating that a PivotTable created this break.
-    def initialize(options={})
+    def initialize(options = {})
       parse_options options
       yield self if block_given?
     end
@@ -27,9 +27,8 @@ module Axlsx
     serializable_attributes :id, :min, :max, :man, :pt
 
     # serializes the break to xml
-    def to_xml_string(str='')
+    def to_xml_string(str = +'')
       serialized_tag('brk', str)
     end
   end
 end
-