axlsx 1.2.0 → 2.0.0

data/lib/axlsx/stylesheet/xf.rb

@@ -5,6 +5,32 @@ module Axlsx
   class Xf
     #does not support extList (ExtensionList)
 
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    # Creates a new Xf object
+    # @option options [Integer] numFmtId
+    # @option options [Integer] fontId
+    # @option options [Integer] fillId
+    # @option options [Integer] borderId
+    # @option options [Integer] xfId
+    # @option options [Boolean] quotePrefix
+    # @option options [Boolean] pivotButton
+    # @option options [Boolean] applyNumberFormat
+    # @option options [Boolean] applyFont
+    # @option options [Boolean] applyFill
+    # @option options [Boolean] applyBorder
+    # @option options [Boolean] applyAlignment
+    # @option options [Boolean] applyProtection
+    # @option options [CellAlignment] alignment
+    # @option options [CellProtection] protection
+    def initialize(options={})
+      parse_options options
+    end
+
+    serializable_attributes :numFmtId, :fontId, :fillId, :borderId, :xfId, :quotePrefix,
+                            :pivotButton, :applyNumberFormat, :applyFont, :applyFill, :applyBorder, :applyAlignment,
+                            :applyProtection
+
     # The cell alignment for this style
     # @return [CellAlignment]
     # @see CellAlignment
@@ -67,30 +93,7 @@ module Axlsx
     # @return [Boolean]
     attr_reader :applyProtection
 
-    # Creates a new Xf object
-    # @option options [Integer] numFmtId
-    # @option options [Integer] fontId
-    # @option options [Integer] fillId
-    # @option options [Integer] borderId
-    # @option options [Integer] xfId
-    # @option options [Boolean] quotePrefix
-    # @option options [Boolean] pivotButton
-    # @option options [Boolean] applyNumberFormat
-    # @option options [Boolean] applyFont
-    # @option options [Boolean] applyFill
-    # @option options [Boolean] applyBorder
-    # @option options [Boolean] applyAlignment
-    # @option options [Boolean] applyProtection
-    # @option options [CellAlignment] alignment
-    # @option options [CellProtection] protection
-    def initialize(options={})
-      options.each do |o|
-        next if o[1].nil?
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
-    # @see Xf#alignment
+      # @see Xf#alignment
     def alignment=(v) DataTypeValidator.validate "Xf.alignment", CellAlignment, v; @alignment = v end
 
     # @see protection
@@ -132,8 +135,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<xf '
-      h = instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}
-      str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      serialized_attributes str
       str << '>'
       alignment.to_xml_string(str) if self.alignment
       protection.to_xml_string(str) if self.protection

data/lib/axlsx/util/accessors.rb

@@ -0,0 +1,64 @@
+module Axlsx
+  # This module defines some of the more common validating attribute
+  # accessors that we use in Axlsx
+  #
+  # When this module is included in your class you can simply call
+  #
+  # string_attr_access :foo
+  #
+  # To generate a new, validating set of accessors for foo.
+  module Accessors
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Defines the class level xxx_attr_accessor methods
+    module ClassMethods
+
+      # Creates one or more string validated attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class.
+      def string_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_string')
+      end
+
+
+      # Creates one or more usigned integer attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class
+      def unsigned_int_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_unsigned_int')
+      end
+
+      # Creates one or more float (double?) attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class
+      def float_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_float')
+      end
+
+      # Creates on or more boolean validated attr_accessors
+      # @param [Array] symbols An array of symbols representing the
+      # names of the attributes you will add to your class.
+      def boolean_attr_accessor(*symbols)
+        validated_attr_accessor(symbols, 'validate_boolean')
+      end
+
+      # Template for defining validated write accessors
+      SETTER = "def %s=(value) Axlsx::%s(value); @%s = value; end"
+
+      # Creates the reader and writer access methods
+      # @param [Array] symbols The names of the attributes to create
+      # @param [String] validator The axlsx validation method to use when
+      # validating assignation.
+      # @see lib/axlsx/util/validators.rb 
+      def validated_attr_accessor(symbols, validator)
+        symbols.each do |symbol|
+          attr_reader symbol
+          module_eval(SETTER % [symbol.to_s, validator, symbol.to_s], __FILE__, __LINE__)
+        end
+      end
+    end
+  end
+end
+

data/lib/axlsx/util/constants.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 module Axlsx
 
   # XML Encoding
@@ -31,6 +30,9 @@ module Axlsx
   # xml schema namespace
   CORE_NS_XSI = "http://www.w3.org/2001/XMLSchema-instance"
 
+  # Digital signature namespace
+  DIGITAL_SIGNATURE_NS = "http://schemas.openxmlformats.org/package/2006/digital-signature"
+
   # spreadsheet drawing namespace
   XML_NS_XDR = "http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"
 
@@ -49,6 +51,12 @@ module Axlsx
   # table rels namespace
   TABLE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/table"
 
+  # pivot table rels namespace
+  PIVOT_TABLE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotTable"
+
+  # pivot table cache definition namespace
+  PIVOT_TABLE_CACHE_DEFINITION_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheDefinition"
+
   # workbook rels namespace
   WORKBOOK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
 
@@ -61,6 +69,9 @@ module Axlsx
   # core rels namespace
   CORE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties"
 
+  # digital signature rels namespace
+  DIGITAL_SIGNATURE_R = "http://schemas.openxmlformats.org/package/2006/relationships/digital- signature/signature"
+
   # styles rels namespace
   STYLES_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"
 
@@ -76,7 +87,7 @@ module Axlsx
   # image rels namespace
   IMAGE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"
 
-  # image rels namespace
+  # hyperlink rels namespace
   HYPERLINK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
 
   # comment rels namespace
@@ -94,6 +105,12 @@ module Axlsx
   # table content type
   TABLE_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"
 
+  # pivot table content type
+  PIVOT_TABLE_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotTable+xml"
+
+  # pivot table cache definition content type
+  PIVOT_TABLE_CACHE_DEFINITION_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.pivotCacheDefinition+xml"
+
   # workbook content type
   WORKBOOK_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"
 
@@ -118,6 +135,15 @@ module Axlsx
   # core content type
   CORE_CT = "application/vnd.openxmlformats-package.core-properties+xml"
 
+  # digital signature xml content type
+  DIGITAL_SIGNATURE_XML_CT = "application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml"
+
+  # digital signature origin content type
+  DIGITAL_SIGNATURE_ORIGIN_CT = "application/vnd.openxmlformats-package.digital-signature-origin"
+
+  # digital signature certificate content type
+  DIGITAL_SIGNATURE_CERTIFICATE_CT = "application/vnd.openxmlformats-package.digital-signature-certificate"
+
   # chart content type
   CHART_CT = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml"
 
@@ -136,6 +162,7 @@ module Axlsx
   #drawing content type
   DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml"
 
+
   # xml content type extensions
   XML_EX = "xml"
 
@@ -193,6 +220,15 @@ module Axlsx
   # drawing part
   TABLE_PN = "tables/table%d.xml"
 
+  # pivot table parts
+  PIVOT_TABLE_PN = "pivotTables/pivotTable%d.xml"
+
+  # pivot table cache definition part name
+  PIVOT_TABLE_CACHE_DEFINITION_PN = "pivotCache/pivotCacheDefinition%d.xml"
+
+  # pivot table rels parts
+  PIVOT_TABLE_RELS_PN = "pivotTables/_rels/pivotTable%d.xml.rels"
+
   # chart part
   CHART_PN = "charts/chart%d.xml"
 
@@ -247,12 +283,14 @@ module Axlsx
   # error message for RegexValidator
   ERR_REGEX = "Invalid Data. %s does not match %s."
 
+  # error message for RangeValidator
+  ERR_RANGE = "Invalid Data. %s must be between %s and %s, (inclusive:%s) you gave: %s"
+
   # 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"
-  
-  # error message for sheets that use a name which includes a colon
-  
-  ERR_SHEET_NAME_COLON_FORBIDDEN = "Your worksheet name '%s' contains a colon, which is not allowed by MS Excel and will cause repair warnings. Please change the name of your sheet."
+
+  # 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."
 
   # error message for duplicate sheet names
   ERR_DUPLICATE_SHEET_NAME = "There is already a worksheet in this workbook named '%s'. Please use a unique name"
@@ -268,4 +306,87 @@ 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"
+
+  # Regex to match forbidden control characters
+  # The following will be automatically stripped from worksheets.
+  #
+  # x00 Null
+  # x01 Start Of Heading
+  # x02 Start Of Text
+  # x03End Of Text
+  # x04 End Of Transmission
+  # x05 Enquiry
+  # x06 Acknowledge
+  # x07 Bell
+  # x08 Backspace
+  # x0B Line Tabulation
+  # x0C Form Feed
+  # x0E Shift Out
+  # x0F Shift In
+  # x10 Data Link Escape
+  # x11 Device Control One
+  # x12 Device Control Two
+  # x13 Device Control Three
+  # x14 Device Control Four
+  # x15 Negative Acknowledge
+  # x16 Synchronous Idle
+  # x17 End Of Transmission Block
+  # x18 Cancel
+  # x19 End Of Medium
+  # x1A Substitute
+  # x1B Escape
+  # x1C Information Separator Four
+  # x1D Information Separator Three
+  # x1E Information Separator Two
+  # x1F Information Separator One
+  #
+  # The following are not dealt with.
+  # If you have this in your data, expect excel to blow up!
+  #
+  # x7F	Delete
+  # x80	Control 0080
+  # x81	Control 0081
+  # x82	Break Permitted Here
+  # x83	No Break Here
+  # x84	Control 0084
+  # x85	Next Line (Nel)
+  # x86	Start Of Selected Area
+  # x87	End Of Selected Area
+  # x88	Character Tabulation Set
+  # x89	Character Tabulation With Justification
+  # x8A	Line Tabulation Set
+  # x8B	Partial Line Forward
+  # x8C	Partial Line Backward
+  # x8D	Reverse Line Feed
+  # x8E	Single Shift Two
+  # x8F	Single Shift Three
+  # x90	Device Control String
+  # x91	Private Use One
+  # x92	Private Use Two
+  # x93	Set Transmit State
+  # x94	Cancel Character
+  # x95	Message Waiting
+  # x96	Start Of Guarded Area
+  # x97	End Of Guarded Area
+  # x98	Start Of String
+  # x99	Control 0099
+  # x9A	Single Character Introducer
+  # x9B	Control Sequence Introducer
+  # x9C	String Terminator
+  # x9D	Operating System Command
+  # x9E	Privacy Message
+  # x9F	Application Program Command
+  #
+  # The following are allowed:
+  #
+  # x0A Line Feed (Lf)
+  # x0D Carriage Return (Cr)
+  # x09 Character Tabulation
+  # @see http://www.codetable.net/asciikeycodes
+  pattern = "[\x0-\x08\x0B\x0C\x0E-\x1F]"
+  pattern= pattern.respond_to?(:encode) ? pattern.encode('UTF-8') : pattern
+
+  # The regular expression used to remove control characters from worksheets
+  CONTROL_CHAR_REGEX = Regexp.new(pattern, 'n')
+
 end

data/lib/axlsx/util/options_parser.rb

@@ -0,0 +1,15 @@
+module Axlsx
+  # This module defines a single method for parsing options in class
+  # initializers.
+  module OptionsParser
+
+    # Parses an options hash by calling any defined method by the same
+    # name of the key postfixed with an '='
+    # @param [Hash] options Options to parse.
+    def parse_options(options={})
+      options.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to?("#{key}=") && value != nil
+      end
+    end
+  end
+end

data/lib/axlsx/util/serialized_attributes.rb

@@ -0,0 +1,79 @@
+module Axlsx
+  # This module allows us to define a list of symbols defining which
+  # attributes will be serialized for a class.
+  module SerializedAttributes
+
+    # Extend with class methods
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # class methods applied to all includers
+    module ClassMethods
+
+      # This is the method to be used in inheriting classes to specify 
+      # which of the instance values are serializable
+      def serializable_attributes(*symbols)
+        @xml_attributes = symbols
+      end
+
+      # a reader for those attributes
+      def xml_attributes
+        @xml_attributes
+      end
+
+      # This helper registers the attributes that will be formatted as elements.
+      def serializable_element_attributes(*symbols)
+        @xml_element_attributes = symbols
+      end
+
+      # attr reader for element attributes
+      def xml_element_attributes
+        @xml_element_attributes
+      end
+    end
+
+    # serializes the instance values of the defining object based on the 
+    # list of serializable attributes.
+    # @param [String] str The string instance to append this
+    # serialization to.
+    # @param [Hash] additional_attributes An option key value hash for
+    # defining values that are not serializable attributes list.
+    def serialized_attributes(str = '', additional_attributes = {})
+      attributes = declared_attributes.merge! additional_attributes
+      attributes.each do |key, value|
+        str << "#{Axlsx.camel(key, false)}=\"#{Axlsx.camel(value, false)}\" "
+      end
+      str
+    end
+
+    # A hash of instance variables that have been declared with
+    # seraialized_attributes and are not nil.
+    # This requires ruby 1.9.3 or higher
+    def declared_attributes
+      instance_values.select do |key, value|
+        value != nil && self.class.xml_attributes.include?(key.to_sym)
+      end
+    end
+
+    # serialized instance values at text nodes on a camelized element of the
+    # attribute name. You may pass in a block for evaluation against non nil
+    # values. We use an array for element attributes becuase misordering will
+    # break the xml and 1.8.7 does not support ordered hashes.
+    # @param [String] str The string instance to which serialized data is appended
+    # @param [Array] additional_attributes An array of additional attribute names.
+    # @return [String] The serialized output.
+    def serialized_element_attributes(str='', additional_attributes=[], &block)
+      attrs = self.class.xml_element_attributes + additional_attributes
+      values = instance_values
+      attrs.each do |attribute_name|
+        value = values[attribute_name.to_s]
+        next if value.nil?
+        value = yield value if block_given?
+        element_name = Axlsx.camel(attribute_name, false)
+        str << "<#{element_name}>#{value}</#{element_name}>"
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/util/simple_typed_list.rb

@@ -1,21 +1,9 @@
 # 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
   class SimpleTypedList
-    # The class constants of allowed types
-    # @return [Array]
-    attr_reader :allowed_types
-
-    # The index below which items cannot be removed
-    # @return [Integer]
-    attr_reader :locked_at
-
-    # The tag name to use when serializing this object
-    # by default the parent node for all items in the list is the classname of the first allowed type with the first letter in lowercase.
-    # @return [String]
-    attr_reader :serialize_as
-
     # Creats a new typed list
     # @param [Array, Class] type An array of Class objects or a single Class object
     # @param [String] serialize_as The tag name to use in serialization
@@ -33,6 +21,39 @@ module Axlsx
       @serialize_as = serialize_as
     end
 
+    # The class constants of allowed types
+    # @return [Array]
+    attr_reader :allowed_types
+
+    # The index below which items cannot be removed
+    # @return [Integer]
+    attr_reader :locked_at
+
+    # The tag name to use when serializing this object
+    # by default the parent node for all items in the list is the classname of the first allowed type with the first letter in lowercase.
+    # @return [String]
+    attr_reader :serialize_as
+
+    # Transposes the list (without blowing up like ruby does)
+    # any non populated cell in the matrix will be a nil value
+    def transpose
+      return @list.clone if @list.size == 0
+      row_count = @list.size
+      max_column_count = @list.map{|row| row.cells.size}.max
+      result = Array.new(max_column_count) { Array.new(row_count) }
+      # yes, I know it is silly, but that warning is really annoying
+      row_count.times do |row_index|
+         max_column_count.times do |column_index|
+          datum = if @list[row_index].cells.size >= max_column_count
+                    @list[row_index].cells[column_index]
+                  elsif block_given?
+                    yield(column_index, row_index)
+                  end
+          result[column_index][row_index] = datum
+        end
+      end
+      result
+    end
     # Lock this list at the current size
     # @return [self]
     def lock
@@ -44,13 +65,15 @@ module Axlsx
       @list
     end
 
+    alias :to_a :to_ary
+
     # Unlock the list
     # @return [self]
     def unlock
       @locked_at = nil
       self
     end
-    
+
     # join operator
     # @param [Array] v the array to join
     # @raise [ArgumentError] if any of the values being joined are not
@@ -60,7 +83,7 @@ module Axlsx
       v.each do |item| 
         DataTypeValidator.validate "SimpleTypedList.+", @allowed_types, item
         @list << item 
-      end 
+      end
     end
 
     # Concat operator
@@ -105,6 +128,18 @@ module Axlsx
       v
     end
 
+    # inserts an item at the index specfied
+    # @param [Integer] index
+    # @param [Any] v
+    # @raise [ArgumentError] if the index is protected by locking
+    # @raise [ArgumentError] if the index is not one of the allowed types
+    def insert(index, v)
+      DataTypeValidator.validate "SimpleTypedList.<<", @allowed_types, v
+      raise ArgumentError, "Item is protected and cannot be changed" if protected? index
+      @list.insert(index, v)
+      v
+    end
+
     # determines if the index is protected
     # @param [Integer] index
     def protected? index