axlsx 1.3.6 → 2.0.1

data/lib/axlsx/workbook/shared_strings_table.rb

@@ -26,10 +26,16 @@ module Axlsx
     # @see Cell#sharable
     attr_reader :unique_cells
 
+    # The xml:space attribute
+    # @see Workbook#xml_space
+    attr_reader :xml_space
+
     # Creates a new Shared Strings Table agains an array of cells
     # @param [Array] cells This is an array of all of the cells in the workbook
-    def initialize(cells)
+    # @param [Symbol] xml_space The xml:space behavior for the shared string table.
+    def initialize(cells, xml_space=:preserve)
       @index = 0
+      @xml_space = xml_space
       @unique_cells = {}
       @shared_xml_string = ""
       shareable_cells = cells.flatten.select{ |cell| cell.plain_string? }
@@ -40,8 +46,11 @@ module Axlsx
     # Serializes the object
     # @param [String] str
     # @return [String]
-    def to_xml_string
-      '<?xml version="1.0" encoding="UTF-8"?><sst xmlns="' << XML_NS << '" count="' << @count.to_s << '" uniqueCount="' << unique_count.to_s << '">' << @shared_xml_string << '</sst>'
+    def to_xml_string(str='')
+      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>'
+      str = Axlsx::sanitize(str)
     end
 
     private

data/lib/axlsx/workbook/workbook.rb

@@ -34,6 +34,12 @@ 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/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
 require 'axlsx/workbook/defined_name.rb'
@@ -270,14 +276,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
     def relationships
       r = Relationships.new
       @worksheets.each do |sheet|
-        r << Relationship.new(WORKSHEET_R, WORKSHEET_PN % (r.size+1))
+        r << Relationship.new(sheet, WORKSHEET_R, WORKSHEET_PN % (r.size+1))
       end
       pivot_tables.each_with_index do |pivot_table, index|
-        r << Relationship.new(PIVOT_TABLE_CACHE_DEFINITION_R, PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1))
+        r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, PIVOT_TABLE_CACHE_DEFINITION_PN % (index+1))
       end
-      r << Relationship.new(STYLES_R,  STYLES_PN)
+      r << Relationship.new(self, STYLES_R,  STYLES_PN)
       if use_shared_strings
-          r << Relationship.new(SHARED_STRINGS_R,  SHARED_STRINGS_PN)
+          r << Relationship.new(self, SHARED_STRINGS_R,  SHARED_STRINGS_PN)
       end
       r
     end
@@ -285,7 +291,25 @@ 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 })
+      SharedStringsTable.new(worksheets.collect { |ws| ws.cells }, xml_space)
+    end
+
+    # The xml:space attribute for the worksheet.
+    # This determines how whitespace is handled withing the document.
+    # The most relevant part being whitespace in the cell text.
+    # allowed values are :preserve and :default. Axlsx uses :preserve unless
+    # you explicily set this to :default.
+    # @return Symbol
+    def xml_space
+      @xml_space ||= :preserve
+    end
+
+    # Sets the xml:space attribute for the worksheet
+    # @see Worksheet#xml_space
+    # @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;
     end
 
     # returns a range of cells in a worksheet
@@ -318,9 +342,8 @@ require 'axlsx/workbook/worksheet/selection.rb'
       defined_names.to_xml_string(str)
       unless pivot_tables.empty?
         str << '<pivotCaches>'
-        pivot_tables.each_with_index do |pivot_table, index|
-          rId = "rId#{@worksheets.size + index + 1  }"
-          str << '<pivotCache cacheId="' << pivot_table.cache_definition.cache_id.to_s << '" r:id="' << rId << '"/>'
+        pivot_tables.each do |pivot_table|
+          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/worksheet/break.rb

@@ -0,0 +1,37 @@
+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
+
+    # Creates a new Break object
+    # @param options A hash of attribute options for this break.
+    # @option options [Integer] id Zero-based row or column Id of the page break. Breaks occur above the specified row and left of the specified column.
+    # @option options [Integer] min Zero-based index of start row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index.
+    # @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={})
+      parse_options options
+      yield self if block_given?
+    end
+
+    unsigned_int_attr_accessor :id, :min, :max
+
+    boolean_attr_accessor :man, :pt
+
+    serializable_attributes :id, :min, :max, :man, :pt
+
+    # serializes the break to xml
+    def to_xml_string(str='')
+      str << '<brk '
+      serialized_attributes str
+      str << '></brk>'
+    end
+  end
+end
+

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

@@ -302,7 +302,7 @@ module Axlsx
     def to_xml_string(r_index, c_index, str = '')
       CellSerializer.to_xml_string r_index, c_index, self, str
     end
-   
+
     def is_formula?
       @type == :string && @value.to_s.start_with?('=')
     end
@@ -318,9 +318,9 @@ module Axlsx
     end
 
     # returns the absolute or relative string style reference for
-    # this cell. 
+    # this cell.
     # @param [Boolean] absolute -when false a relative reference will be
-    # returned. 
+    # returned.
     # @return [String]
     def reference(absolute=true)
       absolute ? r_abs : r
@@ -353,7 +353,7 @@ module Axlsx
 
     # assigns the owning row for this cell.
     def row=(v) @row=v end
-    
+
     # Determines the cell type based on the cell value.
     # @note This is only used when a cell is created but no :type option is specified, the following rules apply:
     #   1. If the value is an instance of Date, the type is set to :date
@@ -375,7 +375,7 @@ module Axlsx
         :float
         # \A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])
         # T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?
-        # (Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z 
+        # (Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z
       elsif v.to_s =~/\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z/
         :iso_8601
       else

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

@@ -136,7 +136,7 @@ module Axlsx
       def value_serialization(serialization_type, serialization_value, str = '')
         str << 't="' << serialization_type << '"' if serialization_type
         str << '><v>' << serialization_value << '</v>'
-      end 
+      end
 
 
     end

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

@@ -0,0 +1,35 @@
+module Axlsx
+
+  # A collection of Brake objects.
+  # Please do not use this class directly. Instead use 
+  # Worksheet#add_break
+  class ColBreaks < SimpleTypedList
+
+    # Instantiates a new list restricted to Break types
+    def initialize
+      super Break
+    end
+
+    # A column break specific helper for adding a break.
+    # @param [Hash] options A list of options to pass into the Break object
+    # The max and man options are fixed, however any other valid option for 
+    # Break will be passed to the created break object.
+    # @see Break
+    def add_break(options)
+      @list << Break.new(options.merge(:max => 1048575, :man => true))
+      last
+    end
+
+    # Serialize the collection to xml
+    # @param [String] str The string to append this lists xml to.
+    # <colBreaks count="1" manualBreakCount="1">
+    # <brk id="3" max="1048575" man="1"/>
+    # </colBreaks>
+    def to_xml_string(str='')
+      return if empty?
+      str << '<colBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
+      each { |brk| brk.to_xml_string(str) }
+      str << '</colBreaks>'
+    end
+  end
+end

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

@@ -64,13 +64,14 @@ module Axlsx
     def to_xml_string(str = "")
       author = @comments.authors[author_index]
       str << '<comment ref="' << ref << '" authorId="' << author_index.to_s << '">'
-      str << '<text><r>'
-      str << '<rPr> <b/><color indexed="81"/></rPr>'
-      str << '<t>' << author.to_s << ':
-</t></r>'
+      str << '<text>'
+      unless author.to_s == ""
+        str << '<r><rPr><b/><color indexed="81"/></rPr>'
+        str << "<t>" << ::CGI.escapeHTML(author.to_s) << ":\n</t></r>"
+      end
       str << '<r>'
       str << '<rPr><color indexed="81"/></rPr>'
-      str << '<t>' << text << '</t></r></text>'
+      str << '<t>' << ::CGI.escapeHTML(text) << '</t></r></text>'
       str << '</comment>'
     end
 

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

@@ -56,9 +56,9 @@ module Axlsx
     # The relationships required by this object
     # @return [Array]
     def relationships
-      [Relationship.new(VML_DRAWING_R, "../#{vml_drawing.pn}"),
-       Relationship.new(COMMENT_R, "../#{pn}"),
-       Relationship.new(COMMENT_R_NULL, "NULL")]
+      [Relationship.new(self, VML_DRAWING_R, "../#{vml_drawing.pn}"),
+       Relationship.new(self, COMMENT_R, "../#{pn}"),
+       Relationship.new(self, COMMENT_R_NULL, "NULL")]
     end
 
     # serialize the object

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

@@ -182,7 +182,7 @@ module Axlsx
     # @see timePeriod
     def timePeriod=(v); Axlsx::validate_time_period_type(v); @timePeriod = v end
     # @see formula
-    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = v end
+    def formula=(v); [*v].each {|x| Axlsx::validate_string(x) }; @formula = [*v].map { |form| ::CGI.escapeHTML(form) } end
 
     # @see color_scale
     def color_scale=(v)

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

@@ -10,7 +10,8 @@ module Axlsx
     # @return [Numeric]
     def self.date_to_serial(date)
       epoch = Axlsx::Workbook::date1904 ? Date.new(1904) : Date.new(1899, 12, 30)
-      (date - epoch).to_f
+      offset_date = date.respond_to?(:utc_offset) ? date + date.utc_offset.seconds : date
+      (offset_date - epoch).to_f
     end
 
     # The time_to_serial methond converts a Time object its excel serialized form.
@@ -19,11 +20,11 @@ module Axlsx
     def self.time_to_serial(time)
       # Using hardcoded offsets here as some operating systems will not except
       # a 'negative' offset from the ruby epoch.
-      epoch1900 = -2209161600 # Time.utc(1899, 12, 30).to_i
-      epoch1904 = -2082844800 # Time.utc(1904, 1, 1).to_i
-      seconds_per_day = 86400 # 60*60*24
+      epoch1900 = -2209161600.0 # Time.utc(1899, 12, 30).to_i
+      epoch1904 = -2082844800.0 # Time.utc(1904, 1, 1).to_i
+      seconds_per_day = 86400.0 # 60*60*24
       epoch = Axlsx::Workbook::date1904 ? epoch1904 : epoch1900
-      (time.to_f - epoch)/seconds_per_day
+      (time.utc_offset + time.to_f - epoch)/seconds_per_day
     end
   end
 end

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

@@ -19,10 +19,12 @@ module Axlsx
       @sheet = sheet
       @sheet.workbook.pivot_tables << self
       @name = "PivotTable#{index+1}"
+      @data_sheet = nil
       @rows = []
       @columns = []
       @data = []
       @pages = []
+      @subtotal = nil
       parse_options options
       yield self if block_given?
     end
@@ -39,6 +41,15 @@ module Axlsx
     # @return [String]
     attr_reader :sheet
 
+    # The sheet used as data source for the pivot table
+    # @return [Worksheet]
+    attr_writer :data_sheet
+
+    # @see #data_sheet
+    def data_sheet
+      @data_sheet || @sheet
+    end
+
     # The range where the data for this pivot table lives.
     # @return [String]
     attr_reader :range
@@ -85,10 +96,17 @@ module Axlsx
     # (see #data)
     def data=(v)
       DataTypeValidator.validate "#{self.class}.data", [Array], v
-      v.each do |ref|
-        DataTypeValidator.validate "#{self.class}.data[]", [String], ref
+      @data = []
+      v.each do |data_field|
+        if data_field.is_a? String
+          data_field = {:ref => data_field}
+        end
+        data_field.values.each do |value|
+          DataTypeValidator.validate "#{self.class}.data[]", [String], value
+        end
+        @data << data_field
       end
-      @data = v
+      @data
     end
 
     # The pages
@@ -128,20 +146,14 @@ module Axlsx
       @cache_definition ||= PivotTableCacheDefinition.new(self)
     end
 
-    # The worksheet relationships. This is managed automatically by the worksheet
+    # The relationships for this pivot table.
     # @return [Relationships]
     def relationships
       r = Relationships.new
-      r << Relationship.new(PIVOT_TABLE_CACHE_DEFINITION_R, "../#{cache_definition.pn}")
+      r << Relationship.new(cache_definition, 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]
@@ -186,11 +198,11 @@ module Axlsx
         str << '</pageFields>'
       end
       unless data.empty?
-        str << '<dataFields count="' << data.size.to_s << '">'
+        str << "<dataFields count=\"#{data.size}\">"
         data.each do |datum_value|
-          str << '<dataField name="Sum of ' << datum_value << '" ' <<
-                            'fld="' << header_index_of(datum_value).to_s << '" ' <<
-                            'baseField="0" baseItem="0"/>'
+          str << "<dataField name='#{@subtotal} of #{datum_value[:ref]}' fld='#{header_index_of(datum_value[:ref])}' baseField='0' baseItem='0'"
+          str << " subtotal='#{datum_value[:subtotal]}' " if datum_value[:subtotal]
+          str << "/>"
         end
         str << '</dataFields>'
       end
@@ -206,7 +218,7 @@ module Axlsx
     # The header cells for the pivot table
     # @return [Array]
     def header_cells
-      @sheet[header_range]
+      data_sheet[header_range]
     end
 
     # The values in the header cells collection
@@ -242,7 +254,7 @@ module Axlsx
         '<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
+      elsif data_refs.include? cell_ref
         '<pivotField dataField="1" compact="0" outline="0" subtotalTop="0" showAll="0" includeNewItemsInFilter="1">' <<
         '</pivotField>'
       else
@@ -250,7 +262,9 @@ module Axlsx
         '</pivotField>'
       end
     end
-
+    def data_refs
+      data.map { |hash| hash[:ref] }
+    end
     def header_range
       range.gsub(/^(\w+?)(\d+)\:(\w+?)\d+$/, '\1\2:\3\2')
     end

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

@@ -35,10 +35,11 @@ module Axlsx
       index + 1
     end
 
-    # The relation reference id for this table
+    # The relationship id for this pivot table cache definition.
+    # @see Relationship#Id
     # @return [String]
     def rId
-      "rId#{index + 1}"
+      pivot_table.relationships.for(self).Id
     end
 
     # Serializes the object
@@ -48,7 +49,7 @@ module Axlsx
       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 <<     '<worksheetSource ref="' << pivot_table.range << '" sheet="' << pivot_table.data_sheet.name << '"/>'
       str <<   '</cacheSource>'
       str <<   '<cacheFields count="' << pivot_table.header_cells_count.to_s << '">'
       pivot_table.header_cells.each do |cell|

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

@@ -17,7 +17,7 @@ module Axlsx
     # returns the relationships required by this collection
     def relationships
       return [] if empty?
-      map{ |pivot_table| Relationship.new(PIVOT_TABLE_R, "../#{pivot_table.pn}") }
+      map{ |pivot_table| Relationship.new(pivot_table, PIVOT_TABLE_R, "../#{pivot_table.pn}") }
     end
   end
 

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

@@ -97,7 +97,7 @@ module Axlsx
       str << '</row>'
     end
 
-    # Adds a singel sell to the row based on the data provided and updates the worksheet's autofit data.
+    # Adds a single sell to the row based on the data provided and updates the worksheet's autofit data.
     # @return [Cell]
     def add_cell(value="", options={})
       c = Cell.new(self, value, options)

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

@@ -0,0 +1,33 @@
+module Axlsx
+
+  # A collection of break objects that define row breaks (page breaks) for printing and preview
+
+  class RowBreaks < SimpleTypedList
+
+    def initialize
+      super Break
+    end
+
+    # Adds a row break
+    # @param [Hash] options The options for the break to be created.
+    # max and man values are fixed.
+    # @see Break
+    def add_break(options)
+      # force feed the excel default
+      @list << Break.new(options.merge(:max => 16383, :man => true))
+      last
+    end
+ 
+    # <rowBreaks count="3" manualBreakCount="3">
+    # <brk id="1" max="16383" man="1"/>
+    # <brk id="7" max="16383" man="1"/>
+    # <brk id="13" max="16383" man="1"/>
+    # </rowBreaks>
+    def to_xml_string(str='')
+      return if empty?
+      str << '<rowBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
+      each { |brk| brk.to_xml_string(str) }
+      str << '</rowBreaks>'
+    end
+  end
+end

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

@@ -47,10 +47,11 @@ module Axlsx
       "#{TABLE_PN % (index+1)}"
     end
 
-    # The relation reference id for this table
+    # The relationship id for this table.
+    # @see Relationship#Id
     # @return [String]
     def rId
-      "rId#{index+1}"
+      @sheet.relationships.for(self).Id
     end
 
     # The name of the Table.

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

@@ -17,7 +17,7 @@ module Axlsx
     # returns the relationships required by this collection
     def relationships
       return [] if empty?
-      map{ |table| Relationship.new(TABLE_R, "../#{table.pn}") }
+      map{ |table| Relationship.new(table, TABLE_R, "../#{table.pn}") }
     end
 
     def to_xml_string(str = "")