axlsx 1.0.16 → 1.0.17

data/lib/axlsx/rels/relationship.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A relationship defines a reference between package parts.
   # @note Packages automatcially manage relationships.

data/lib/axlsx/rels/relationships.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 require 'axlsx/rels/relationship.rb'
 

data/lib/axlsx/stylesheet/border.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # This class details a border used in Office Open XML spreadsheet styles.
   class Border

data/lib/axlsx/stylesheet/border_pr.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A border part. 
   class BorderPr

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # CellAlignment stores information about the cell alignment of a style Xf Object.
   # @note Using Styles#add_style is the recommended way to manage cell alignment. 

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # CellProtection stores information about locking or hiding cells in spreadsheet.
   # @note Using Styles#add_style is the recommended way to manage cell protection.

data/lib/axlsx/stylesheet/cell_style.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.
   # @note Using Styles#add_style is the recommended way to manage cell styling.

data/lib/axlsx/stylesheet/color.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The color class represents a color used for borders, fills an fonts
   class Color

data/lib/axlsx/stylesheet/fill.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The Fill is a formatting object that manages the background color, and pattern for cells.
   # @note The recommended way to manage styles in your workbook is to use Styles#add_style.

data/lib/axlsx/stylesheet/font.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The Font class details a font instance for use in styling cells.
   # @note The recommended way to manage fonts, and other styles is Styles#add_style

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   # A GradientFill defines the color and positioning for gradiant cell fill.
   # @see Open Office XML Part 1 §18.8.24  

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   # The GradientStop object represents a color point in a gradient.
   # @see Open Office XML Part 1 §18.8.24  

data/lib/axlsx/stylesheet/num_fmt.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A NumFmt object defines an identifier and formatting code for data in cells. 
   # @note The recommended way to manage styles is Styles#add_style

data/lib/axlsx/stylesheet/pattern_fill.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A PatternFill is the pattern and solid fill styling for a cell.
   # @note The recommended way to manage styles is with Styles#add_style

data/lib/axlsx/stylesheet/styles.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   require 'axlsx/stylesheet/border.rb'
   require 'axlsx/stylesheet/border_pr.rb'
@@ -253,22 +253,22 @@ module Axlsx
     # Creates the default set of styles the exel requires to be valid as well as setting up the 
     # Axlsx::STYLE_THIN_BORDER
     def load_default_styles
-      @numFmts = SimpleTypedList.new NumFmt
+      @numFmts = SimpleTypedList.new NumFmt, 'numFmts'
       @numFmts << NumFmt.new(:numFmtId => NUM_FMT_YYYYMMDD, :formatCode=> "yyyy/mm/dd")
       @numFmts << NumFmt.new(:numFmtId => NUM_FMT_YYYYMMDDHHMMSS, :formatCode=> "yyyy/mm/dd hh:mm:ss")
 
       @numFmts.lock
 
-      @fonts = SimpleTypedList.new Font
+      @fonts = SimpleTypedList.new Font, 'fonts'
       @fonts << Font.new(:name => "Arial", :sz => 11, :family=>1)
       @fonts.lock
 
-      @fills = SimpleTypedList.new Fill
+      @fills = SimpleTypedList.new Fill, 'fills'
       @fills << Fill.new(Axlsx::PatternFill.new(:patternType=>:none))
       @fills << Fill.new(Axlsx::PatternFill.new(:patternType=>:gray125))
       @fills.lock
 
-      @borders = SimpleTypedList.new Border
+      @borders = SimpleTypedList.new Border, 'borders'
       @borders << Border.new
       black_border = Border.new
       [:left, :right, :top, :bottom].each do |item| 
@@ -281,7 +281,7 @@ module Axlsx
       @cellStyleXfs << Xf.new(:borderId=>0, :numFmtId=>0, :fontId=>0, :fillId=>0)
       @cellStyleXfs.lock
 
-      @cellStyles = SimpleTypedList.new CellStyle
+      @cellStyles = SimpleTypedList.new CellStyle, 'cellStyles'
       @cellStyles << CellStyle.new(:name =>"Normal", :builtinId =>0, :xfId=>0)
       @cellStyles.lock
 

data/lib/axlsx/stylesheet/table_style.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A single table style definition and is a collection for tableStyleElements
   # @note Table are not supported in this version and only the defaults required for a valid workbook are created.

data/lib/axlsx/stylesheet/table_style_element.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # an element of style that belongs to a table style. 
   # @note tables and table styles are not supported in this version. This class exists in preparation for that support. 

data/lib/axlsx/stylesheet/table_styles.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # TableStyles represents a collection of style definitions for table styles and pivot table styles.
   # @note Support for custom table styles does not exist in this version. Many of the classes required are defined in preparation for future release. Please do not attempt to add custom table styles.

data/lib/axlsx/stylesheet/xf.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style
   # @see Styles#add_style

data/lib/axlsx/util/cbf.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 
   # The Cfb class is a MS-OFF-CRYPTOGRAPHY specific OLE (MS-CBF) writer implementation. No attempt is made to re-invent the wheel for read/write of compound binary files.

data/lib/axlsx/util/constants.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 
   # XML Encoding
@@ -64,6 +65,9 @@ module Axlsx
   # styles rels namespace
   STYLES_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"
 
+  # shared strings namespace
+  SHARED_STRINGS_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings"
+
   # drawing rels namespace
   DRAWING_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"
 
@@ -138,6 +142,9 @@ module Axlsx
 
   # styles part
   STYLES_PN = "styles.xml"
+
+  # shared_strings  part
+  SHARED_STRINGS_PN = "sharedStrings.xml"
   
   # app part
   APP_PN = "docProps/app.xml"

data/lib/axlsx/util/ms_off_crypto.rb

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 require 'digest'
 require 'base64'
 require 'openssl'

data/lib/axlsx/util/parser.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # The Parser module mixes in a number of methods to help in generating a model from xml
   # This module is not included in the axlsx library at this time. It is for future development only,

data/lib/axlsx/util/simple_typed_list.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A SimpleTypedList is a type restrictive collection that allows some of the methods from Array and supports basic xml serialization.  
   # @private
@@ -153,7 +154,7 @@ module Axlsx
     # @return [String]
     def to_xml(xml)
       classname = @allowed_types[0].name.split('::').last
-      el_name = serialize_as || (classname[0,1].downcase + classname[1..-1]).pluralize
+      el_name = serialize_as || (classname[0,1].downcase + classname[1..-1])
       xml.send(el_name, :count=>@list.size) {
         @list.each { |item| item.to_xml(xml) }
       }

data/lib/axlsx/util/storage.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
 
   # The Storage class represents a storage object or stream in a compound file.

data/lib/axlsx/util/validators.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # Validate a value against a specific list of allowed values.
   class RestrictionValidator
@@ -52,6 +53,14 @@ module Axlsx
     DataTypeValidator.validate(:unsigned_int, [Fixnum, Integer], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
   end
 
+  # Requires that the value is a Fixnum Integer or Float and is greater or equal to 0
+  # @param [Any] v The value validated
+  # @raise [ArgumentError] raised if the value is not a Fixnum or Integer value greater or equal to 0
+  # @return [Boolean] true if the data is valid
+  def self.validate_unsigned_numeric(v)
+    DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
+  end
+
   # Requires that the value is a Fixnum or Integer
   # @param [Any] v The value validated
   def self.validate_int(v)
@@ -116,10 +125,10 @@ module Axlsx
   end
 
   # Requires that the value is a valid relationship_type
-  # XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R are allowed
+  # XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R are allowed
   # @param [Any] v The value validated
   def self.validate_relationship_type(v)
-    RestrictionValidator.validate :relationship_type, [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R], v
+    RestrictionValidator.validate :relationship_type, [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R, HYPERLINK_R, SHARED_STRINGS_R], v
   end
 
   # Requires that the value is a valid table element type

data/lib/axlsx/version.rb

@@ -1,9 +1,10 @@
+# encoding: UTF-8
 module Axlsx
 
   # The version of the gem
   # When using bunle exec rake and referencing the gem on github or locally
   # it will use the gemspec, which preloads this constant for the gem's version.
   # We check to make sure that it has not already been loaded
-  VERSION="1.0.16" unless Axlsx.const_defined? :VERSION
+  VERSION="1.0.17" unless Axlsx.const_defined? :VERSION
 
 end

data/lib/axlsx/workbook/shared_strings_table.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The Shared String Table class is responsible for managing and serializing common strings in a workbook.
+  # While the ECMA-376 spec allows for both inline and shared strings it seems that at least some applications like iWorks Numbers
+  # and Google Docs require that the shared string table is populated in order to interoperate properly. 
+  # As a developer, you should never need to directly work against this class. Simply set 'use_shared_strings'
+  # on the package or workbook to generate a package that uses the shared strings table instead of inline strings.
+  # @note Serialization performance is affected by using this serialization method so if you do not need interoperability
+  # it is recomended that you use the default inline string method of serialization.
+  class SharedStringsTable
+
+    # The total number of strings in the workbook including duplicates
+    # Empty cells are treated as blank strings
+    # @return [Integer]
+    attr_reader :count
+
+    # The total number of unique strings in the workbook. 
+    # @return [Integer]
+    def unique_count
+      @unique_cells.size
+    end
+
+    # An array of unique cells. Multiple attributes of the cell are used in comparison
+    # each of these unique cells is parsed into the shared string table.     
+    # @see Cell#sharable
+    attr_reader :unique_cells
+
+    # 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)
+      cells = cells.flatten.reject { |c| c.type != :string || c.value.start_with?('=') }
+      @count = cells.size
+      @unique_cells = []
+      resolve(cells)
+    end
+
+
+    # Generate the xml document for the Shared Strings Table
+    # @return [String]
+    def to_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.sst(:xmlns => Axlsx::XML_NS, :count => count, :uniqueCount => unique_count) {
+          @unique_cells.each do |cell|
+            xml.si { cell.run_xml(xml) }
+          end
+        }
+      end
+      builder.to_xml(:save_with => 0)
+    end
+
+    private
+    
+    # Interate over all of the cells in the array. 
+    # if our unique cells array does not contain a sharable cell, 
+    # add the cell to our unique cells array and set the ssti attribute on the index of this cell in the shared strings table
+    # if a sharable cell already exists in our unique_cells array, set the ssti attribute of the cell and move on.
+    # @return [Array] unique cells
+    def resolve(cells)
+      cells.each do |cell|
+        index = @unique_cells.index { |item| item.shareable(cell) }
+        if index == nil
+          cell.send :ssti=, @unique_cells.size
+          @unique_cells << cell
+        else
+          cell.send :ssti=, index
+        end
+      end
+    end    
+  end
+end

data/lib/axlsx/workbook/shared_strings_table.rb~

@@ -0,0 +1,69 @@
+# encoding: UTF--8
+module Axlsx
+
+  # The Shared String Table class is responsible for managing and serializing common strings in a workbook.
+  # While the ECMA-376 spec allows for both inline and shared strings it seems that at least some applications like Numbers (Mac)
+  # and Google Docs require that the shared string table is populated in order to interoperate properly. 
+  # As a developer, you should never need to directly work against this class. Simply set 'use_shared_strings'
+  # on the package or workbook to generate a package that uses the shared strings table instead of inline strings.
+  # @note Serialization performance is affected by using this serialization method so if you do not need interoperability
+  # it is recomended that you use the default inline string method of serialization.
+  class SharedStringsTable
+
+    # The total number of strings in the workbook including duplicates
+    # Empty cells are treated as blank strings
+    # @return [Integer]
+    attr_reader :count
+
+    # The total number of unique strings in the workbook. 
+    # @return [Integer]
+    def unique_count
+      @unique_cells.size
+    end
+
+    # An array of unique cells. Multiple attributes of the cell are used in comparison
+    # each of these unique cells is parsed into the shared string table.     
+    # @see Cell#sharable
+    attr_reader :unique_cells
+
+    # 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)
+      cells = cells.reject { |c| c.type != :string }
+      @count = cells.size
+      @unique_cells = []
+      resolve cells
+    end
+
+    # Interate over all of the cells in the array. 
+    # if our unique cells array does not contain a sharable cell, 
+    # add the cell to our unique cells array and set the ssti attribute on the index of this cell in the shared strings table
+    # if a sharable cell already exists in our unique_cells array, set the ssti attribute of the cell and move on.
+    # @return [Array] unique cells
+    def resolve(cells)
+      cells.each do |cell|
+        index = @unique_cells.index { |item| item.sharable(cell) }
+        if index == nil
+          cell.ssti = @unique_cells.size
+          @unique_cells << cell
+        else
+          cell.ssti = index
+        end
+      end
+    end
+
+    # Generate the xml document for the Shared Strings Table
+    # @return [String]
+    def to_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.sst(:xmlns => Axlsx::XML_NS, :count => count, :uniqueCount => unique_count) {
+          @unique_cells.each do |cell|
+            xml.si { xml.t cell.value.to_s }
+          end
+        }
+      end
+      builder.to_xml(:save_with => 0)
+    end
+  end
+
+end

data/lib/axlsx/workbook/workbook.rb

@@ -4,6 +4,7 @@ module Axlsx
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/row.rb'
 require 'axlsx/workbook/worksheet/worksheet.rb'
+require 'axlsx/workbook/shared_strings_table.rb'
 
   # The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles.
   # The following parts of the Office Open XML spreadsheet specification are not implimented in this version.
@@ -30,6 +31,19 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
   #   *workbookPr is only supported to the extend of date1904
   class Workbook
 
+    # 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.
+    # @return [Boolean]
+    attr_reader :use_shared_strings
+
+    # @see use_shared_strings
+    def use_shared_strings=(v) 
+      Axlsx::validate_boolean(v)
+      @use_shared_strings = v
+    end
+
+
     # A collection of worksheets associated with this workbook. 
     # @note The recommended way to manage worksheets is add_worksheet
     # @see Workbook#add_worksheet
@@ -82,9 +96,8 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
     #end
 
     # Creates a new Workbook
-    #
-    # @option options [Boolean] date1904. If this is not specified, we try to determine if the platform is bsd/darwin and set date1904 to true automatically.
-    #
+    # The recomended way to work with workbooks is via Package#workbook
+    # @option options [Boolean] date1904. If this is not specified, we try to determine if the platform is bsd/darwin and set date1904 to true automatically.    
     def initialize(options={})
       @styles = Styles.new
       @worksheets = SimpleTypedList.new Worksheet
@@ -136,9 +149,18 @@ require 'axlsx/workbook/worksheet/worksheet.rb'
         r << Relationship.new(WORKSHEET_R, WORKSHEET_PN % (r.size+1))
       end 
       r << Relationship.new(STYLES_R,  STYLES_PN)
+      if use_shared_strings
+          r << Relationship.new(SHARED_STRINGS_R,  SHARED_STRINGS_PN)
+      end
       r
     end
 
+    # generates a shared string object against all cells in all worksheets.
+    # @return [SharedStringTable]
+    def shared_strings
+      SharedStringsTable.new(worksheets.collect { |ws| ws.cells })
+    end
+
     # returns a range of cells in a worksheet
     # @param [String] cell_def The excel style reference defining the worksheet and cells. The range must specify the sheet to 
     # retrieve the cells from. e.g. range('Sheet1!A1:B2') will return an array of four cells [A1, A2, B1, B2] while range('Sheet1!A1') will return a single Cell.