axlsx 1.3.4 → 1.3.5

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

@@ -0,0 +1,144 @@
+module Axlsx
+
+  # The Cell Serializer class contains the logic for serializing cells based on their type.
+  class CellSerializer
+    class << self
+
+
+      # Calls the proper serialization method based on type.
+      # @param [Integer] row_index The index of the cell's row
+      # @param [Integer] column_index The index of the cell's column
+      # @param [String] str The string to apend serialization to.
+      # @return [String]
+      def to_xml_string(row_index, column_index, cell, str='')
+        str << '<c r="' << Axlsx::cell_r(column_index, row_index) << '" s="' << cell.style.to_s << '" '
+        return str << '/>' if cell.value.nil?
+        method = (cell.type.to_s << '_type_serialization').to_sym
+        self.send(method, cell, str)
+        str << '</c>'
+      end 
+
+
+      # builds an xml text run based on this cells attributes.
+      # @param [String] str The string instance this run will be concated to.
+      # @return [String]
+      def run_xml_string(cell, str = '')
+        if cell.is_text_run?
+          data = cell.instance_values.reject{|key, value| value == nil || key == 'value' || key == 'type' }
+          keys = data.keys & Cell::INLINE_STYLES
+          str << "<r><rPr>"
+          keys.each do |key|
+            case key
+            when 'font_name'
+              str << "<rFont val='"<< cell.font_name << "'/>"
+            when 'color'
+              str << data[key].to_xml_string
+            else
+              str << "<" << key.to_s << " val='" << data[key].to_s << "'/>"
+            end
+          end
+          str << "</rPr>" << "<t>" << cell.value.to_s << "</t></r>"
+        else
+          str << "<t>" << cell.value.to_s << "</t>"
+        end
+        str
+      end
+
+      # serializes cells that are type iso_8601
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def iso_8601_type_serialization(cell, str='')
+        value_serialization 'd', cell.value, str
+      end
+
+
+      # serializes cells that are type date
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def date_type_serialization(cell, str='')
+        value_serialization false, DateTimeConverter::date_to_serial(cell.value).to_s, str
+      end
+
+      # Serializes cells that are type time
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def time_type_serialization(cell, str='')
+        value_serialization false, DateTimeConverter::time_to_serial(cell.value).to_s, str
+      end
+
+      # Serializes cells that are type boolean
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def boolean_type_serialization(cell, str='')
+        value_serialization 'b', cell.value.to_s, str
+      end
+
+      # Serializes cells that are type float
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def float_type_serialization(cell, str='')
+        numeric_type_serialization cell, str
+      end
+
+      # Serializes cells that are type integer
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def integer_type_serialization(cell, str = '')
+        numeric_type_serialization cell, str
+      end
+
+
+      # Serializes cells that are type formula
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def formula_serialization(cell, str='')
+        str << 't="str">' << '<f>' << cell.value.to_s.sub('=', '') << '</f>'
+        str << '<v>' << cell.formula_value.to_s << '</v>' unless cell.formula_value.nil?
+      end
+
+      # Serializes cells that are type inline_string
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def inline_string_serialization(cell, str = '')
+        str << 't="inlineStr">' << '<is>'
+        run_xml_string cell, str
+        str << '</is>'
+      end
+
+      # Serializes cells that are type string
+      # @param [Cell] cell The cell that is being serialized
+      # @param [String] str The string the serialized content will be appended to.
+      # @return [String]
+      def string_type_serialization(cell, str='')
+        if cell.is_formula?
+          formula_serialization cell, str
+        elsif !cell.ssti.nil?
+          value_serialization 's', cell.ssti.to_s, str
+        else
+          inline_string_serialization cell, str
+        end
+      end
+
+      private
+
+      def numeric_type_serialization(cell, str = '')
+        value_serialization 'n', cell.value.to_s, str
+      end
+
+      def value_serialization(serialization_type, serialization_value, str = '')
+        str << 't="' << serialization_type << '"' if serialization_type
+        str << '><v>' << serialization_value << '</v>'
+      end 
+
+
+    end
+  end
+end

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

@@ -104,7 +104,12 @@ module Axlsx
 
    # @see Col#width
     def width=(v)
-      Axlsx.validate_unsigned_numeric(v) unless v == nil
+      # Removing this validation make a 10% difference in performance
+      # as it is called EVERY TIME A CELL IS ADDED - the proper solution
+      # is to only set this if a calculated value is greated than the
+      # current @width value.
+      # TODO!!!
+      #Axlsx.validate_unsigned_numeric(v) unless v == nil
       @custom_width = @best_fit = v != nil
       @width = v
     end
@@ -120,7 +125,9 @@ module Axlsx
        if fixed_width.is_a? Numeric
          self.width = fixed_width
        elsif use_autowidth
-        self.width = [width || 0, cell.autowidth || 0].max
+         cell_width = cell.autowidth
+         self.width = cell_width unless (width || 0) > (cell_width || 0)
+         #self.width = [width || 0, cell.autowidth || 0].max
        end 
     end 
 

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

@@ -0,0 +1,259 @@
+# encoding: UTF-8
+module Axlsx
+  # Table
+  # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
+  # @see README for examples
+  class PivotTable
+
+    include Axlsx::OptionsParser
+
+    # Creates a new PivotTable object
+    # @param [String] ref The reference to where the pivot table lives like 'G4:L17'.
+    # @param [String] range The reference to the pivot table data like 'A1:D31'.
+    # @param [Worksheet] sheet The sheet containing the table data.
+    # @option options [Cell, String] name
+    # @option options [TableStyle] style
+    def initialize(ref, range, sheet, options={})
+      @ref = ref
+      self.range = range
+      @sheet = sheet
+      @sheet.workbook.pivot_tables << self
+      @name = "PivotTable#{index+1}"
+      @rows = []
+      @columns = []
+      @data = []
+      @pages = []
+      parse_options options
+      yield self if block_given?
+    end
+
+    # The reference to the table data
+    # @return [String]
+    attr_reader :ref
+
+    # The name of the table.
+    # @return [String]
+    attr_reader :name
+
+    # The name of the sheet.
+    # @return [String]
+    attr_reader :sheet
+
+    # The range where the data for this pivot table lives.
+    # @return [String]
+    attr_reader :range
+
+    # (see #range)
+    def range=(v)
+      DataTypeValidator.validate "#{self.class}.range", [String], v
+      if v.is_a?(String)
+        @range = v
+      end
+    end
+
+    # The rows
+    # @return [Array]
+    attr_reader :rows
+
+
+    # (see #rows)
+    def rows=(v)
+      DataTypeValidator.validate "#{self.class}.rows", [Array], v
+      v.each do |ref|
+        DataTypeValidator.validate "#{self.class}.rows[]", [String], ref
+      end
+      @rows = v
+    end
+
+    # The columns
+    # @return [Array]
+    attr_reader :columns
+
+    # (see #columns)
+    def columns=(v)
+      DataTypeValidator.validate "#{self.class}.columns", [Array], v
+      v.each do |ref|
+        DataTypeValidator.validate "#{self.class}.columns[]", [String], ref
+      end
+      @columns = v
+    end
+
+    # The data
+    # @return [Array]
+    attr_reader :data
+
+    # (see #data)
+    def data=(v)
+      DataTypeValidator.validate "#{self.class}.data", [Array], v
+      v.each do |ref|
+        DataTypeValidator.validate "#{self.class}.data[]", [String], ref
+      end
+      @data = v
+    end
+
+    # The pages
+    # @return [String]
+    attr_reader :pages
+
+    # (see #pages)
+    def pages=(v)
+      DataTypeValidator.validate "#{self.class}.pages", [Array], v
+      v.each do |ref|
+        DataTypeValidator.validate "#{self.class}.pages[]", [String], ref
+      end
+      @pages = v
+    end
+
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
+    def index
+      @sheet.workbook.pivot_tables.index(self)
+    end
+
+    # The part name for this table
+    # @return [String]
+    def pn
+      "#{PIVOT_TABLE_PN % (index+1)}"
+    end
+
+    # The relationship part name of this pivot table
+    # @return [String]
+    def rels_pn
+      "#{PIVOT_TABLE_RELS_PN % (index+1)}"
+    end
+
+    # The cache_definition for this pivot table
+    # @return [PivotTableCacheDefinition]
+    def cache_definition
+      @cache_definition ||= PivotTableCacheDefinition.new(self)
+    end
+
+    # The worksheet relationships. This is managed automatically by the worksheet
+    # @return [Relationships]
+    def relationships
+      r = Relationships.new
+      r << Relationship.new(PIVOT_TABLE_CACHE_DEFINITION_R, "../#{cache_definition.pn}")
+      r
+    end
+
+    # The relation reference id for this table
+    # @return [String]
+    def rId
+      "rId#{index+1}"
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @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 <<   '<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)
+      end
+      str <<   '</pivotFields>'
+      if rows.empty?
+        str << '<rowFields count="1"><field x="-2"/></rowFields>'
+        str << '<rowItems count="2"><i><x/></i> <i i="1"><x v="1"/></i></rowItems>'
+      else
+        str << '<rowFields count="' << rows.size.to_s << '">'
+        rows.each do |row_value|
+          str << '<field x="' << header_index_of(row_value).to_s << '"/>'
+        end
+        str << '</rowFields>'
+        str << '<rowItems count="' << rows.size.to_s << '">'
+        rows.size.times do |i|
+          str << '<i/>'
+        end
+        str << '</rowItems>'
+      end
+      if columns.empty?
+        str << '<colItems count="1"><i/></colItems>'
+      else
+        str << '<colFields count="' << columns.size.to_s << '">'
+        columns.each do |column_value|
+          str << '<field x="' << header_index_of(column_value).to_s << '"/>'
+        end
+        str << '</colFields>'
+      end
+      unless pages.empty?
+        str << '<pageFields count="' << pages.size.to_s << '">'
+        pages.each do |page_value|
+          str << '<pageField fld="' << header_index_of(page_value).to_s << '"/>'
+        end
+        str << '</pageFields>'
+      end
+      unless data.empty?
+        str << '<dataFields count="' << data.size.to_s << '">'
+        data.each do |datum_value|
+          str << '<dataField name="Sum of ' << datum_value << '" ' <<
+                            'fld="' << header_index_of(datum_value).to_s << '" ' <<
+                            'baseField="0" baseItem="0"/>'
+        end
+        str << '</dataFields>'
+      end
+      str << '</pivotTableDefinition>'
+    end
+
+    # References for header cells
+    # @return [Array]
+    def header_cell_refs
+      Axlsx::range_to_a(header_range).first
+    end
+
+    # The header cells for the pivot table
+    # @return [Array]
+    def header_cells
+      @sheet[header_range]
+    end
+
+    # The values in the header cells collection
+    # @return [Array]
+    def header_cell_values
+      header_cells.map(&:value)
+    end
+
+    # The number of cells in the header_cells collection
+    # @return [Integer]
+    def header_cells_count
+      header_cells.count
+    end
+
+    # The index of a given value in the header cells
+    # @return [Integer]
+    def header_index_of(value)
+      header_cell_values.index(value)
+    end
+
+    private
+
+    def pivot_field_for(cell_ref)
+      if rows.include? cell_ref
+        '<pivotField axis="axisRow" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
+          '<items count="1"><item t="default"/></items>' <<
+        '</pivotField>'
+      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>'
+      elsif pages.include? cell_ref
+        '<pivotField axis="axisCol" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
+          '<items count="1"><item t="default"/></items>' <<
+        '</pivotField>'
+      elsif data.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>'
+      end
+    end
+
+    def header_range
+      range.gsub(/^(\w+?)(\d+)\:(\w+?)\d+$/, '\1\2:\3\2')
+    end
+
+  end
+end

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

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+module Axlsx
+  # Table
+  # @note Worksheet#add_pivot_table is the recommended way to create tables for your worksheets.
+  # @see README for examples
+  class PivotTableCacheDefinition
+
+    include Axlsx::OptionsParser
+
+    # Creates a new PivotTable object
+    # @param [String] pivot_table The pivot table this cache definition is in
+    def initialize(pivot_table)
+      @pivot_table = pivot_table
+    end
+
+    # # The reference to the pivot table data
+    # # @return [PivotTable]
+    attr_reader :pivot_table
+
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
+    def index
+      pivot_table.sheet.workbook.pivot_tables.index(pivot_table)
+    end
+
+    # The part name for this table
+    # @return [String]
+    def pn
+      "#{PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1)}"
+    end
+
+    # The identifier for this cache
+    # @return [Integer]
+    def cache_id
+      index + 1
+    end
+
+    # The relation reference id for this table
+    # @return [String]
+    def rId
+      "rId#{index + 1}"
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<pivotCacheDefinition xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '" invalid="1" refreshOnLoad="1" recordCount="0">'
+      str <<   '<cacheSource type="worksheet">'
+      str <<     '<worksheetSource ref="' << pivot_table.range << '" sheet="Data Sheet"/>'
+      str <<   '</cacheSource>'
+      str <<   '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">'
+      pivot_table.header_cells.each do |cell|
+        str <<   '<cacheField name="' << cell.value << '" numFmtId="0">'
+        str <<     '<sharedItems count="0">'
+        str <<     '</sharedItems>'
+        str <<   '</cacheField>'
+      end
+      str <<   '</cacheFields>'
+      str << '</pivotCacheDefinition>'
+    end
+
+  end
+end