axlsx 1.3.6 → 2.0.1

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

@@ -37,6 +37,8 @@ module Axlsx
       @page_setup = PageSetup.new options[:page_setup]  if options[:page_setup]
       @print_options = PrintOptions.new options[:print_options] if options[:print_options]
       @header_footer = HeaderFooter.new options[:header_footer] if options[:header_footer]
+      @row_breaks = RowBreaks.new
+      @col_breaks = ColBreaks.new
     end
 
     # The name of the worksheet
@@ -94,6 +96,22 @@ module Axlsx
       @pivot_tables ||=  PivotTables.new self
     end
 
+    # A collection of column breaks added to this worksheet
+    # @note Please do not use this directly. Instead use
+    # add_page_break
+    # @see Worksheet#add_page_break
+    def col_breaks
+      @col_breaks ||= ColBreaks.new
+    end
+
+    # A collection of row breaks added to this worksheet
+    # @note Please do not use this directly. Instead use
+    # add_page_break
+    # @see Worksheet#add_page_break
+    def row_breaks
+      @row_breaks ||= RowBreaks.new
+    end
+
     # A typed collection of hyperlinks associated with this worksheet
     # @return [WorksheetHyperlinks]
     def hyperlinks
@@ -114,14 +132,19 @@ module Axlsx
       @rows ||=  SimpleTypedList.new Row
     end
 
-    # returns the sheet data as columnw
-    def cols
-      @rows.transpose
+    # returns the sheet data as columns
+    # If you pass a block, it will be evaluated whenever a row does not have a
+    # cell at a specific index. The block will be called with the row and column
+    # index in the missing cell was found.
+    # @example
+    #     cols { |row_index, column_index| p "warn - row #{row_index} is does not have a cell at #{column_index}
+    def cols(&block)
+      @rows.transpose(&block)
     end
 
-    # An range that excel will apply an autfilter to "A1:B3"
+    # An range that excel will apply an auto-filter to "A1:B3"
     # This will turn filtering on for the cells in the range.
-    # The first row is considered the header, while subsequent rows are considerd to be data.
+    # The first row is considered the header, while subsequent rows are considered to be data.
     # @return String
     def auto_filter
       @auto_filter ||= AutoFilter.new self
@@ -327,6 +350,10 @@ module Axlsx
       auto_filter.range = v
     end
 
+    # Accessor for controlling whether leading and trailing spaces in cells are
+    # preserved or ignored. The default is to preserve spaces.
+    attr_accessor :preserve_spaces
+
     # The part name of this worksheet
     # @return [String]
     def pn
@@ -339,10 +366,11 @@ module Axlsx
       "#{WORKSHEET_RELS_PN % (index+1)}"
     end
 
-    # The relationship Id of thiw worksheet
+    # The relationship id of this worksheet.
     # @return [String]
+    # @see Relationship#Id
     def rId
-      "rId#{index+1}"
+      @workbook.relationships.for(self).Id
     end
 
     # The index of this worksheet in the owning Workbook's worksheets list.
@@ -488,6 +516,24 @@ module Axlsx
       image
     end
 
+    # Adds a page break (row break) to the worksheet
+    # @param cell A Cell object or excel style string reference indicating where the break
+    # should be added to the sheet.
+    # @example
+    #   ws.add_page_break("A4")
+    def add_page_break(cell)
+      DataTypeValidator.validate "Worksheet#add_page_break cell", [String, Cell], cell
+      column_index, row_index = if cell.is_a?(String)
+          Axlsx.name_to_indices(cell)
+        else
+          cell.pos
+        end
+      if column_index > 0
+        col_breaks.add_break(:id => column_index)
+      end
+      row_breaks.add_break(:id => row_index)
+    end
+
     # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.
     # Axlsx is sparse, so if you have not set data for a column, you cannot set the width.
     # Setting a fixed column width to nil will revert the behaviour back to calculating the width for you on the next call to add_row.
@@ -542,15 +588,7 @@ module Axlsx
         item.to_xml_string(str) if item
       end
       str << '</worksheet>'
-      sanitize(str)
-    end
-
-    # returns the provided string with all invalid control charaters
-    # removed.
-    # @param [String] str The sting to process
-    # @return [String]
-    def sanitize(str)
-      str.gsub(CONTROL_CHAR_REGEX, '')
+      Axlsx::sanitize(str)
     end
 
     # The worksheet relationships. This is managed automatically by the worksheet
@@ -565,14 +603,6 @@ module Axlsx
       r
     end
 
-    # identifies the index of an object withing the collections used in generating relationships for the worksheet
-    # @param [Any] object the object to search for
-    # @return [Integer] The index of the object
-    def relationships_index_of(object)
-      objects = [tables.to_a, worksheet_comments.comments.to_a, hyperlinks.to_a, worksheet_drawing.drawing].flatten.compact || []
-      objects.index(object)
-    end
-
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String|Integer] cell_def the string defining the cell or range of cells, or the rownumber
     # @return [Cell, Array]
@@ -629,6 +659,11 @@ module Axlsx
     end
 
     private
+
+    def xml_space
+      workbook.xml_space
+    end
+
     def outline(collection, range, level = 1, collapsed = true)
        range.each do |index|
         unless (item = collection[index]).nil?
@@ -653,7 +688,7 @@ module Axlsx
        sheet_data, sheet_calc_pr, @sheet_protection, protected_ranges,
        auto_filter, merged_cells, conditional_formattings,
        data_validations, hyperlinks, print_options, page_margins,
-       page_setup, header_footer, worksheet_drawing, worksheet_comments,
+       page_setup, header_footer, row_breaks, col_breaks, worksheet_drawing, worksheet_comments,
        tables]
     end
 
@@ -699,7 +734,7 @@ module Axlsx
     # Helper method for parsingout the root node for worksheet
     # @return [String]
     def worksheet_node
-      "<worksheet xmlns=\"%s\" xmlns:r=\"%s\">" % [XML_NS, XML_NS_R]
+       "<worksheet xmlns=\"%s\" xmlns:r=\"%s\" xml:space=\"#{xml_space}\">" % [XML_NS, XML_NS_R]
     end
 
     def sheet_data

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

@@ -40,10 +40,11 @@ module Axlsx
       !comments.empty?
     end
 
-    # The index in the worksheet's relationships for the VML drawing that will render the comments
-    # @return [Integer]
-    def index
-      worksheet.relationships.index { |r| r.Type == VML_DRAWING_R } + 1
+    # The relationship id of the VML drawing that will render the comments.
+    # @see Relationship#Id
+    # @return [String]
+    def drawing_rId
+      comments.relationships.find{ |r| r.Type == VML_DRAWING_R }.Id
     end
 
     # Seraalize the object
@@ -51,7 +52,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       return unless has_comments?
-      str << "<legacyDrawing r:id='rId#{index}' />"
+      str << "<legacyDrawing r:id='#{drawing_rId}' />"
     end
   end
 end

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

@@ -41,24 +41,18 @@ module Axlsx
       @drawing.is_a? Drawing
     end
 
-    # The relationship required by this object
+    # The relationship instance for this drawing.
     # @return [Relationship]
     def relationship
       return unless has_drawing?
-      Relationship.new(DRAWING_R, "../#{drawing.pn}") 
-    end
-
-    # returns the index of the worksheet releationship that defines this drawing.
-    # @return [Integer]
-    def index
-       worksheet.relationships.index{ |r| r.Type == DRAWING_R } +1 
+      Relationship.new(self, DRAWING_R, "../#{drawing.pn}") 
     end
 
     # Serialize the drawing for the worksheet
     # @param [String] str
     def to_xml_string(str = '')
       return unless has_drawing? 
-      str << "<drawing r:id='rId#{index}'/>"
+      str << "<drawing r:id='#{relationship.Id}'/>"
     end
   end
 end

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

@@ -45,18 +45,13 @@ module Axlsx
       @ref = cell_reference
     end
 
-       # The relationship required by this hyperlink when the taget is :external
+    # The relationship instance for this hyperlink.
+    # A relationship is only required if `@target` is `:external`. If not, this method will simply return `nil`.
+    # @see #target=
     # @return [Relationship]
     def relationship
       return unless @target == :external
-      Relationship.new HYPERLINK_R, location, :target_mode => :External
-    end
-
-    # The id of the relationship for this object
-    # @return [String]
-    def id
-      return unless @target == :external
-      "rId#{(@worksheet.relationships_index_of(self)+1)}"
+      Relationship.new(self, HYPERLINK_R, location, :target_mode => :External)
     end
 
     # Seralize the object
@@ -73,7 +68,7 @@ module Axlsx
     # r:id should only be specified for external targets.
     # @return [Hash]
     def location_or_id
-      @target == :external ?  { :"r:id" => id } : { :location => Axlsx::coder.encode(location) }
+      @target == :external ?  { :"r:id" => relationship.Id } : { :location => Axlsx::coder.encode(location) }
     end
   end
 end

data/lib/axlsx.rb

@@ -23,7 +23,7 @@ require 'axlsx/workbook/workbook.rb'
 require 'axlsx/package.rb'
 #required gems
 require 'nokogiri'
-require 'zip/zip'
+require 'zip'
 
 #core dependencies
 require 'bigdecimal'
@@ -127,8 +127,16 @@ module Axlsx
     s.gsub(/_(.)/){ $1.upcase }
   end
 
+    # returns the provided string with all invalid control charaters
+    # removed.
+    # @param [String] str The sting to process
+    # @return [String]
+    def self.sanitize(str)
+      str.gsub(CONTROL_CHAR_REGEX, '')
+    end
+
 
-  # Instructs the serializer to not try to escape cell value input. 
+  # Instructs the serializer to not try to escape cell value input.
   # This will give you a huge speed bonus, but if you content has <, > or other xml character data
   # the workbook will be invalid and excel will complain.
   def self.trust_input

data/lib/schema/sml.xsd

@@ -13,6 +13,8 @@
   <xsd:import 
     namespace="http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"
     schemaLocation="dml-spreadsheetDrawing.xsd"/>
+  <xsd:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="xml.xsd"/>
+
   <xsd:complexType name="CT_AutoFilter">
     <xsd:sequence>
       <xsd:element name="filterColumn" minOccurs="0" maxOccurs="unbounded" type="CT_FilterColumn"/>
@@ -1797,6 +1799,7 @@
     </xsd:sequence>
     <xsd:attribute name="count" type="xsd:unsignedInt" use="optional"/>
     <xsd:attribute name="uniqueCount" type="xsd:unsignedInt" use="optional"/>
+    <xsd:attribute ref="xml:space"/>
   </xsd:complexType>
   <xsd:simpleType name="ST_PhoneticType">
     <xsd:restriction base="xsd:string">
@@ -2213,6 +2216,7 @@
       <xsd:element name="tableParts" type="CT_TableParts" minOccurs="0" maxOccurs="1"/>
       <xsd:element name="extLst" type="CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
     </xsd:sequence>
+    <xsd:attribute ref="xml:space"/>
   </xsd:complexType>
   <xsd:complexType name="CT_SheetData">
     <xsd:sequence>