caxlsx 3.1.1 → 3.3.0

data/lib/axlsx/util/constants.rb

@@ -274,6 +274,12 @@ module Axlsx
   # cellXfs id for default date styling
   STYLE_DATE = 2
 
+  # worksheet maximum name length
+  WORKSHEET_MAX_NAME_LENGTH = 31
+
+  # worksheet name forbidden characters
+  WORKSHEET_NAME_FORBIDDEN_CHARS = '[]*/\?:'.chars.freeze
+
   # error messages RestrictionValidor
   ERR_RESTRICTION = "Invalid Data: %s. %s must be one of %s.".freeze
 
@@ -286,8 +292,11 @@ module Axlsx
   # error message for RangeValidator
   ERR_RANGE = "Invalid Data. %s must be between %s and %s, (inclusive:%s) you gave: %s".freeze
 
+  # error message for sheets that use explicit empty string name
+  ERR_SHEET_NAME_EMPTY = "Your worksheet name is empty. Worksheet name can't be empty. Please assign name of your sheet or don't use name option at all.".freeze
+
   # error message for sheets that use a name which is longer than 31 bytes
-  ERR_SHEET_NAME_TOO_LONG = "Your worksheet name '%s' is too long. Worksheet names must be 31 characters (bytes) or less".freeze
+  ERR_SHEET_NAME_TOO_LONG = "Your worksheet name '%s' is too long. Worksheet names must be #{WORKSHEET_MAX_NAME_LENGTH} characters (bytes) or less".freeze
 
   # error message for sheets that use a name which include invalid characters
   ERR_SHEET_NAME_CHARACTER_FORBIDDEN = "Your worksheet name '%s' contains a character which is not allowed by MS Excel and will cause repair warnings. Please change the name of your sheet.".freeze
@@ -307,6 +316,12 @@ module Axlsx
   # error message for non 'integerish' value
   ERR_INTEGERISH = "You value must be, or be castable via to_i, an Integer. You provided %s".freeze
 
+  # error message for invalid cell reference
+  ERR_CELL_REFERENCE_INVALID = "Invalid cell definition `%s`".freeze
+
+  # error message for cell reference with last cell missing
+  ERR_CELL_REFERENCE_MISSING_CELL = "Missing cell `%s` for the specified range `%s`".freeze
+
   # Regex to match forbidden control characters
   # The following will be automatically stripped from worksheets.
   #

data/lib/axlsx/util/serialized_attributes.rb

@@ -61,7 +61,7 @@ module Axlsx
     # seraialized_attributes and are not nil.
     # This requires ruby 1.9.3 or higher
     def declared_attributes
-      instance_values.select do |key, value|
+      Axlsx.instance_values_for(self).select do |key, value|
         value != nil && self.class.xml_attributes.include?(key.to_sym)
       end
     end
@@ -75,7 +75,7 @@ module Axlsx
     # @return [String] The serialized output.
     def serialized_element_attributes(str='', additional_attributes=[], &block)
       attrs = self.class.xml_element_attributes + additional_attributes
-      values = instance_values
+      values = Axlsx.instance_values_for(self)
       attrs.each do |attribute_name|
         value = values[attribute_name.to_s]
         next if value.nil?

data/lib/axlsx/util/storage.rb

@@ -122,15 +122,15 @@ module Axlsx
 
     # Creates a new storage object. 
     # @param [String] name the name of the storage
-    # @option options [Integer] color @default black
-    # @option options [Integer] type @default storage
-    # @option options [String] data 
-    # @option options [Integer] left @default -1
-    # @option options [Integer] right @default -1
-    # @option options [Integer] child @default -1
-    # @option options [Integer] created @default 0
-    # @option options [Integer] modified @default 0
-    # @option options [Integer] sector @default 0
+    # @option options [Integer] color (black)
+    # @option options [Integer] type (storage)
+    # @option options [String] data
+    # @option options [Integer] left (-1)
+    # @option options [Integer] right (-1)
+    # @option options [Integer] child (-1)
+    # @option options [Integer] created (0)
+    # @option options [Integer] modified (0)
+    # @option options [Integer] sector (0)
     def initialize(name, options= {})
       @left = @right = @child = -1
       @sector = @size = @created = @modified = 0

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "3.1.1"
+  VERSION = "3.3.0"
 end

data/lib/axlsx/workbook/workbook.rb

@@ -85,6 +85,9 @@ 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
+
     # When true, the Package will be generated with a shared string table. This may be required by some OOXML processors that do not
     # adhere to the ECMA specification that dictates string may be inline in the sheet.
     # Using this option will increase the time required to serialize the document as every string in every cell must be analzed and referenced.
@@ -184,6 +187,36 @@ require 'axlsx/workbook/worksheet/selection.rb'
       @styles
     end
 
+    # An array that holds all cells with styles
+    # @return Set
+    def styled_cells
+      @styled_cells ||= Set.new
+    end
+
+    # Are the styles added with workbook.add_styles applied yet
+    # @return Boolean
+    attr_accessor :styles_applied
+
+    # A helper to apply styles that were added using `worksheet.add_style`
+    # @return [Boolean]
+    def apply_styles
+      return false if !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
+
+        cell.style = styles.add_style(new_style)
+      end
+
+      self.styles_applied = true
+    end
+
 
     # Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
     @@date1904 = false
@@ -213,6 +246,8 @@ require 'axlsx/workbook/worksheet/selection.rb'
 
 
       @use_autowidth = true
+      @bold_font_multiplier = BOLD_FONT_MULTIPLIER
+      @font_scale_divisor = FONT_SCALE_DIVISOR
 
       self.date1904= !options[:date1904].nil? && options[:date1904]
       yield self if block_given?
@@ -243,6 +278,26 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # see @use_autowidth
     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
+    # @return [Float]
+    attr_reader :bold_font_multiplier
+
+    def bold_font_multiplier=(v)
+      Axlsx::validate_float v
+      @bold_font_multiplier = v
+    end
+
+    # Font scale is calculated with this value (font_size / font_scale_divisor)
+    # Used for automatic calculation of cell widths
+    # @return [Float]
+    attr_reader :font_scale_divisor
+
+    def font_scale_divisor=(v)
+      Axlsx::validate_float v
+      @font_scale_divisor = v
+    end
+
     # inserts a worksheet into this workbook at the position specified.
     # It the index specified is out of range, the worksheet will be added to the end of the
     # worksheets collection

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

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+
+module Axlsx
+  class BorderCreator
+    attr_reader :worksheet, :cells, :edges, :width, :color
+
+    def initialize(worksheet, cells, args)
+      @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
+
+      if @edges == :all
+        @edges = Axlsx::Border::EDGES
+      elsif @edges.is_a?(Array)
+        @edges = (@edges.map(&:to_sym).uniq & Axlsx::Border::EDGES)
+      else
+        @edges = []
+      end
+    end
+
+    def draw
+      @edges.each do |edge| 
+        worksheet.add_style(
+          border_cells[edge], 
+          {
+            border: {style: @width, color: @color, edges: [edge]}
+          }
+        )
+      end
+    end
+
+    private
+
+    def border_cells
+      {
+        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}",
+      }
+    end
+
+    def first_cell
+      @first_cell ||= cells.first.r
+    end
+
+    def last_cell
+      @last_cell ||= cells.last.r
+    end
+
+    def first_row
+      @first_row ||= first_cell.scan(/\d+/).first
+    end
+
+    def first_col
+      @first_col ||= first_cell.scan(/\D+/).first
+    end
+
+    def last_row
+      @last_row ||= last_cell.scan(/\d+/).first
+    end
+
+    def last_col
+      @last_col ||= last_cell.scan(/\D+/).first
+    end
+
+  end
+end

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

@@ -82,6 +82,32 @@ module Axlsx
       defined?(@style) ? @style : 0
     end
 
+    attr_accessor :raw_style
+
+    # The index of the cellXfs item to be applied to this cell.
+    # @param [Hash] styles
+    # @see Axlsx::Styles
+    def add_style(style)
+      self.raw_style ||= {}
+
+      new_style = Axlsx.hash_deep_merge(raw_style, style)
+
+      all_edges = [:top, :right, :bottom, :left]
+
+      if !raw_style[:border].nil? && !style[:border].nil?
+        border_at = (raw_style[:border][:edges] || all_edges) + (style[:border][:edges] || all_edges)
+        new_style[:border][:edges] = border_at.uniq.sort
+      elsif !style[:border].nil?
+        new_style[:border] = style[:border]
+      end
+
+      self.raw_style = new_style
+
+      wb = row.worksheet.workbook
+      
+      wb.styled_cells << self
+    end
+
     # The row this cell belongs to.
     # @return [Row]
     attr_reader :row
@@ -409,7 +435,7 @@ module Axlsx
     # This is still not perfect...
     #  - scaling is not linear as font sizes increase
     def string_width(string, font_size)
-      font_scale = font_size / 10.0
+      font_scale = font_size / row.worksheet.workbook.font_scale_divisor
       (string.to_s.size + 3) * font_scale
     end
 
@@ -418,8 +444,9 @@ module Axlsx
     # imagemagick and loading metrics for every character.
     def font_size
       return sz if sz
+
       font = styles.fonts[styles.cellXfs[style].fontId] || styles.fonts[0]
-      (font.b || (defined?(@b) && @b)) ? (font.sz * 1.5) : font.sz
+      font.b || (defined?(@b) && @b) ? (font.sz * row.worksheet.workbook.bold_font_multiplier) : font.sz
     end
 
     # Utility method for setting inline style attributes

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

@@ -22,7 +22,7 @@ module Axlsx
       def run_xml_string(cell, str = '')
         if cell.is_text_run?
           valid = RichTextRun::INLINE_STYLES - [:value, :type]
-          data = Hash[cell.instance_values.map{ |k, v| [k.to_sym, v] }]
+          data = Hash[Axlsx.instance_values_for(cell).map{ |k, v| [k.to_sym, v] }]
           data = data.select { |key, value| valid.include?(key) && !value.nil? }
           RichText.new(cell.value.to_s, data).to_xml_string(str)
         elsif cell.contains_rich_text?

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

@@ -125,12 +125,12 @@ module Axlsx
     # to this value and the cell's attributes are ignored.
     # @param [Boolean] use_autowidth If this is false, the cell's
     # autowidth value will be ignored.
-    def update_width(cell, fixed_width=nil, use_autowidth=true)
+    def update_width(cell, fixed_width = nil, use_autowidth = true)
       if fixed_width.is_a? Numeric
-       self.width = fixed_width
+        self.width = fixed_width
       elsif use_autowidth
-       cell_width = cell.autowidth
-       self.width = cell_width unless (width || 0) > (cell_width || 0)
+        cell_width = cell.autowidth
+        self.width = cell_width unless (width || 0) > (cell_width || 0)
       end
     end
 

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

@@ -13,11 +13,12 @@ module Axlsx
     # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
     # @option options [String] error - Message text of error alert.
     # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
-    # @option options [String] errorTitle - itle bar text of error alert.
+    # @option options [String] errorTitle - Title bar text of error alert.
     # @option options [Symbol] operator - The relational operator used with this data validation.
     # @option options [String] prompt - Message text of input prompt.
     # @option options [String] promptTitle - Title bar text of input prompt.
-    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
+    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation. Be careful: It has an inverted logic, false shows the dropdown list! You should use hideDropDown instead.
+    # @option options [Boolean] hideDropDown - A boolean value indicating whether to hide the dropdown combo box for a list type data validation. Defaults to `false` (meaning the dropdown is visible by default).
     # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
     # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
     # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
@@ -121,13 +122,22 @@ module Axlsx
 
     # Show drop down
     # A boolean value indicating whether to display a dropdown combo box for a list type data
-    # validation. Be careful: false shows the dropdown list!
+    # validation. Be careful: It has an inverted logic, false shows the dropdown list!
     # Available for type list
     # @see type
     # @return [Boolean]
     # default false
     attr_reader :showDropDown
 
+    # Hide drop down
+    # A boolean value indicating whether to hide a dropdown combo box for a list type data
+    # validation. Defaults to `false` (meaning the dropdown is visible by default).
+    # Available for type list
+    # @see type
+    # @return [Boolean]
+    # default false
+    alias :hideDropDown :showDropDown
+
     # Show error message
     # A boolean value indicating whether to display the error alert message when an invalid
     # value has been entered, according to the criteria specified.
@@ -195,7 +205,18 @@ module Axlsx
     def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
 
     # @see showDropDown
-    def showDropDown=(v); Axlsx::validate_boolean(v); @showDropDown = v end
+    def showDropDown=(v)
+      warn 'The `showDropDown` has an inverted logic, false shows the dropdown list! You should use `hideDropDown` instead.'
+      Axlsx::validate_boolean(v)
+      @showDropDown = v
+    end
+
+    # @see hideDropDown
+    def hideDropDown=(v)
+      Axlsx::validate_boolean(v)
+      # It's just an alias for the showDropDown attribute, hideDropDown should set the value of the original showDropDown.
+      @showDropDown = v
+    end
 
     # @see showErrorMessage
     def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
@@ -216,7 +237,7 @@ module Axlsx
       valid_attributes = get_valid_attributes
 
       str << '<dataValidation '
-      str << instance_values.map do |key, value|
+      str << Axlsx.instance_values_for(self).map do |key, value|
         '' << key << '="' << Axlsx.booleanize(value).to_s << '"' if (valid_attributes.include?(key.to_sym) && !CHILD_ELEMENTS.include?(key.to_sym))
       end.join(' ')
       str << '>'

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

@@ -26,17 +26,33 @@ module Axlsx
       @pages = []
       @subtotal = nil
       @no_subtotals_on_headers = []
+      @sort_on_headers = {}
       @style_info = {}
       parse_options options
       yield self if block_given?
     end
 
-    # Defines the headers in which subtotals are not to be included
-    # @return[Array]
+    # Defines the headers in which subtotals are not to be included.
+    # @return [Array]
     attr_accessor :no_subtotals_on_headers
 
+    # Defines the headers in which sort is applied.
+    # Can be an array of headers to sort ascending by default, or a hash for specific control
+    # (with headers as keys, `:ascending` or `:descending` as values).
+    #
+    # Examples: `["year", "month"]` or `{"year" => :descending, "month" => :descending}`
+    # @return [Hash]
+    attr_reader :sort_on_headers
+
+    # (see #sort_on_headers)
+    def sort_on_headers=(headers)
+      headers ||= {}
+      headers = Hash[*headers.map { |h| [h, :ascending] }.flatten] if headers.is_a?(Array)
+      @sort_on_headers = headers
+    end
+
     # Style info for the pivot table
-    # @return[Hash]
+    # @return [Hash]
     attr_accessor :style_info
 
     # The reference to the table data
@@ -173,12 +189,18 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
-      str << ('<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"  dataOnRows="1" applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">')
+
+      str << ('<pivotTableDefinition xmlns="' << XML_NS << '" name="' << name << '" cacheId="' << cache_definition.cache_id.to_s << '"' << (data.size <= 1 ? ' dataOnRows="1"' : '') << ' applyNumberFormats="0" applyBorderFormats="0" applyFontFormats="0" applyPatternFormats="0" applyAlignmentFormats="0" applyWidthHeightFormats="1" dataCaption="Data" showMultipleLabel="0" showMemberPropertyTips="0" useAutoFormatting="1" indent="0" compact="0" compactData="0" gridDropZones="1" multipleFieldFilters="0">')
+
       str << ('<location firstDataCol="1" firstDataRow="1" firstHeaderRow="1" ref="' << ref << '"/>')
       str << ('<pivotFields count="' << header_cells_count.to_s << '">')
+
       header_cell_values.each do |cell_value|
-        str << pivot_field_for(cell_value, !no_subtotals_on_headers.include?(cell_value))
+        subtotal = !no_subtotals_on_headers.include?(cell_value)
+        sorttype = sort_on_headers[cell_value]
+        str << pivot_field_for(cell_value, subtotal, sorttype)
       end
+
       str << '</pivotFields>'
       if rows.empty?
         str << '<rowFields count="1"><field x="-2"/></rowFields>'
@@ -196,7 +218,17 @@ module Axlsx
         str << '</rowItems>'
       end
       if columns.empty?
-        str << '<colItems count="1"><i/></colItems>'
+        if data.size > 1
+          str << '<colFields count="1"><field x="-2"/></colFields>'
+          str << "<colItems count=\"#{data.size}\">"
+          str << '<i><x/></i>'
+          data[1..-1].each_with_index do |datum_value,i|
+            str << "<i i=\"#{i + 1}\"><x v=\"#{i + 1}\"/></i>"
+          end
+          str << '</colItems>'
+        else
+          str << '<colItems count="1"><i/></colItems>'
+        end
       else
         str << ('<colFields count="' << columns.size.to_s << '">')
         columns.each do |column_value|
@@ -265,22 +297,31 @@ module Axlsx
 
     private
 
-    def pivot_field_for(cell_ref, subtotal=true)
+    def pivot_field_for(cell_ref, subtotal, sorttype)
+      attributes = %w[compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"]
+      items_tag = '<items count="1"><item t="default"/></items>'
+      include_items_tag = false
+
       if rows.include? cell_ref
+        attributes << 'axis="axisRow"'
+        attributes << "sortType=\"#{sorttype == :descending ? 'descending' : 'ascending'}\"" if sorttype
         if subtotal
-          '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
+          include_items_tag = true
         else
-          '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1" defaultSubtotal="0"></pivotField>'
+          attributes << 'defaultSubtotal="0"'
         end
       elsif columns.include? cell_ref
-        '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
+        attributes << 'axis="axisCol"'
+        attributes << "sortType=\"#{sorttype == :descending ? 'descending' : 'ascending'}\"" if sorttype
+        include_items_tag = true
       elsif pages.include? cell_ref
-        '<pivotField axis="axisPage" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"><items count="1"><item t="default"/></items></pivotField>'
+        attributes << 'axis="axisPage"'
+        include_items_tag = true
       elsif data_refs.include? cell_ref
-        '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"></pivotField>'
-      else
-        '<pivotField compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1"></pivotField>'
+        attributes << 'dataField="1"'
       end
+
+      "<pivotField #{attributes.join(' ')}>#{include_items_tag ? items_tag : nil}</pivotField>"
     end
 
     def data_refs

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

@@ -190,7 +190,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       valid = RichTextRun::INLINE_STYLES
-      data = Hash[self.instance_values.map{ |k, v| [k.to_sym, v] }]
+      data = Hash[Axlsx.instance_values_for(self).map{ |k, v| [k.to_sym, v] }]
       data = data.select { |key, value| valid.include?(key) && !value.nil? }
 
       str << '<r><rPr>'