axlsx 1.1.4 → 1.2.0

data/lib/axlsx/package.rb

@@ -80,9 +80,8 @@ module Axlsx
 
     # Serialize your workbook to disk as an xlsx document.
     #
-    # @param [File] output The file you want to serialize your package to
+    # @param [String] output The name of the file you want to serialize your package to
     # @param [Boolean] confirm_valid Validate the package prior to serialization.
-    # @option options stream indicates if we should be writing to a stream or a file. True for stream, nil for file
     # @return [Boolean] False if confirm_valid and validation errors exist. True if the package was serialized
     # @note A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents.
     #   confirm_valid should be used in the rare case that you cannot open the serialized file.
@@ -90,10 +89,15 @@ module Axlsx
     # @example
     #   # This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.
     #   # Take a look at the README for an example of how to do it!
-    #   f = File.open('test.xlsx', 'w')
-    #   Package.new.serialize(f)
     #
-    #   # You will find a file called test.xlsx
+    #   #serialize to a file
+    #   p = Axlsx::Package.new
+    #   # ......add cool stuff to your workbook......
+    #   p.serialize("example.xlsx")
+    #
+    #   # Serialize to a stream
+    #   s = p.to_stream()
+    #   File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
     def serialize(output, confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
       Zip::ZipOutputStream.open(output) do |zip|
@@ -152,18 +156,18 @@ module Axlsx
     # @return [Zip::ZipOutputStream]
     def write_parts(zip)
       p = parts
-        p.each do |part|
-          unless part[:doc].nil?
-            zip.put_next_entry(part[:entry]);
-            entry = ['1.9.2', '1.9.3'].include?(RUBY_VERSION) ? part[:doc].force_encoding('BINARY') : part[:doc]
-            zip.puts(entry)
-          end
-          unless part[:path].nil?
-            zip.put_next_entry(part[:entry]);
-            # binread for 1.9.3
-            zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path])
-          end
+      p.each do |part|
+        unless part[:doc].nil?
+          zip.put_next_entry(part[:entry])
+          entry = ['1.9.2', '1.9.3'].include?(RUBY_VERSION) ? part[:doc].force_encoding('BINARY') : part[:doc]
+          zip.puts(entry)
+        end
+        unless part[:path].nil?
+          zip.put_next_entry(part[:entry]);
+          # binread for 1.9.3
+          zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path])
         end
+      end
       zip
     end
 
@@ -180,15 +184,24 @@ module Axlsx
        {:entry => CONTENT_TYPES_PN, :doc => content_types.to_xml_string, :schema => CONTENT_TYPES_XSD},
        {:entry => WORKBOOK_PN, :doc => workbook.to_xml_string, :schema => SML_XSD}
       ]
+
       workbook.drawings.each do |drawing|
         @parts << {:entry => "xl/#{drawing.rels_pn}", :doc => drawing.relationships.to_xml_string, :schema => RELS_XSD}
         @parts << {:entry => "xl/#{drawing.pn}", :doc => drawing.to_xml_string, :schema => DRAWING_XSD}
       end
 
+
       workbook.tables.each do |table|
         @parts << {:entry => "xl/#{table.pn}", :doc => table.to_xml_string, :schema => SML_XSD}
       end
 
+      workbook.comments.each do|comment|
+        if comment.size > 0
+          @parts << { :entry => "xl/#{comment.pn}", :doc => comment.to_xml_string, :schema => SML_XSD }
+          @parts << { :entry => "xl/#{comment.vml_drawing.pn}", :doc => comment.vml_drawing.to_xml_string, :schema => nil }
+        end
+      end
+
       workbook.charts.each do |chart|
         @parts << {:entry => "xl/#{chart.pn}", :doc => chart.to_xml_string, :schema => DRAWING_XSD}
       end
@@ -229,18 +242,33 @@ module Axlsx
     # @private
     def content_types
       c_types = base_content_types
+
       workbook.drawings.each do |drawing|
         c_types << Axlsx::Override.new(:PartName => "/xl/#{drawing.pn}",
                                        :ContentType => DRAWING_CT)
       end
+
       workbook.charts.each do |chart|
         c_types << Axlsx::Override.new(:PartName => "/xl/#{chart.pn}",
                                        :ContentType => CHART_CT)
       end
+
       workbook.tables.each do |table|
         c_types << Axlsx::Override.new(:PartName => "/xl/#{table.pn}",
                                        :ContentType => TABLE_CT)
       end
+
+      workbook.comments.each do |comment|
+        if comment.size > 0
+        c_types << Axlsx::Override.new(:PartName => "/xl/#{comment.pn}",
+                                       :ContentType => COMMENT_CT)
+        end
+      end
+
+      if workbook.comments.size > 0
+        c_types << Axlsx::Default.new(:Extension => "vml", :ContentType => VML_DRAWING_CT)
+      end
+
       workbook.worksheets.each do |sheet|
         c_types << Axlsx::Override.new(:PartName => "/xl/#{sheet.pn}",
                                          :ContentType => WORKSHEET_CT)

data/lib/axlsx/rels/relationship.rb

@@ -30,9 +30,9 @@ module Axlsx
     attr_reader :TargetMode
 
     # creates a new relationship
-    # @param [String] Type The type of the relationship
-    # @param [String] Target The target for the relationship
-    # @option [Symbol] target_mode only accepts :external.
+    # @param [String] type The type of the relationship
+    # @param [String] target The target for the relationship
+    # @option [Symbol] :target_mode only accepts :external.
     def initialize(type, target, options={})
       self.Target=target
       self.Type=type

data/lib/axlsx/rels/relationships.rb

@@ -10,23 +10,13 @@ require 'axlsx/rels/relationship.rb'
     def initialize
       super Relationship
     end
-
+    
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << '<Relationships xmlns="' << RELS_R << '">'
       each_with_index { |rel, index| rel.to_xml_string(index+1, str) }
       str << '</Relationships>'
     end
-    # Serializes the relationships document.
-    # @return [String]
-    def to_xml()
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.Relationships(:xmlns => Axlsx::RELS_R) {
-          each_with_index { |rel, index| rel.to_xml(xml, "rId#{index+1}") }
-        }
-      end
-      builder.to_xml(:save_with => 0)
-    end
 
   end
 end

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -68,7 +68,7 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<gradientFill'
+      str << '<gradientFill '
       h = self.instance_values.reject { |k,v| k.to_sym == :stop }
       str << h.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
       str << '>'

data/lib/axlsx/stylesheet/styles.rb

@@ -133,7 +133,7 @@ module Axlsx
     # @option options [Integer] family The font family to use.
     # @option options [String] font_name The name of the font to use
     # @option options [Integer] num_fmt The number format to apply
-    # @option options [String] format_code The formatting to apply. If this is specified, num_fmt is ignored.
+    # @option options [String] format_code The formatting to apply. 
     # @option options [Integer|Hash] border The border style to use.
     # @option options [String] bg_color The background color to apply to the cell
     # @option options [Boolean] hidden Indicates if the cell should be hidden

data/lib/axlsx/stylesheet/table_style.rb

@@ -40,10 +40,10 @@ module Axlsx
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      attr = self.instance_values.select { |k, v| [:name, :pivot, :table].include? k }
-      attr[:count] = self.size
+      attrs = instance_values.reject { |k, v| ![:name, :pivot, :table].include?(k) }
+      attrs[:count] = self.size
       str << '<tableStyle '
-      str << attr.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
+      str << attrs.map { |key, value| '' << key.to_s << '="' << value.to_s << '"' }.join(' ')
       str << '>'
       each { |table_style_el| table_style_el.to_xml_string(str) }
       str << '</tableStyle>'

data/lib/axlsx/util/constants.rb

@@ -79,6 +79,18 @@ module Axlsx
   # image rels namespace
   HYPERLINK_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
 
+  # comment rels namespace
+  COMMENT_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments"
+
+  # comment relation for nil target
+  COMMENT_R_NULL = "http://purl.oclc.org/ooxml/officeDocument/relationships/comments"
+
+  #vml drawing relation namespace
+  VML_DRAWING_R = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing'
+
+  # VML Drawing content type
+  VML_DRAWING_CT = "application/vnd.openxmlformats-officedocument.vmlDrawing"
+
   # table content type
   TABLE_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"
 
@@ -109,6 +121,9 @@ module Axlsx
   # chart content type
   CHART_CT = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml"
 
+  # comments content type
+  COMMENT_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml"
+
   # jpeg content type
   JPEG_CT = "image/jpeg"
 
@@ -172,6 +187,9 @@ module Axlsx
   # drawing rels part
   DRAWING_RELS_PN = "drawings/_rels/drawing%d.xml.rels"
 
+  # vml drawing part
+  VML_DRAWING_PN = "drawings/vmlDrawing%d.vml"
+
   # drawing part
   TABLE_PN = "tables/table%d.xml"
 
@@ -181,6 +199,9 @@ module Axlsx
   # chart part
   IMAGE_PN = "media/image%d.%s"
 
+  # comment part
+  COMMENT_PN = "comments%d.xml"
+
   # location of schema files for validation
   SCHEMA_BASE = File.dirname(__FILE__)+'/../../schema/'
 
@@ -228,6 +249,10 @@ module Axlsx
 
   # 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 duplicate sheet names
   ERR_DUPLICATE_SHEET_NAME = "There is already a worksheet in this workbook named '%s'. Please use a unique name"
@@ -240,4 +265,7 @@ module Axlsx
 
   # error message for invalid angles
   ERR_ANGLE = "Angles must be a value between -90 and 90. You provided: %s"
+
+  # error message for non 'integerish' value
+  ERR_INTEGERISH = "You value must be, or be castable via to_i, an Integer. You provided %s"
 end

data/lib/axlsx/util/simple_typed_list.rb

@@ -18,7 +18,7 @@ module Axlsx
 
     # Creats a new typed list
     # @param [Array, Class] type An array of Class objects or a single Class object
-    # @param [String] serialize The tag name to use in serialization
+    # @param [String] serialize_as The tag name to use in serialization
     # @raise [ArgumentError] if all members of type are not Class objects
     def initialize type, serialize_as=nil
       if type.is_a? Array
@@ -50,6 +50,18 @@ module Axlsx
       @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
+    # one of the allowed types
+    # @return [SimpleTypedList]
+    def +(v)
+      v.each do |item| 
+        DataTypeValidator.validate "SimpleTypedList.+", @allowed_types, item
+        @list << item 
+      end 
+    end
 
     # Concat operator
     # @param [Any] v the data to be added
@@ -60,12 +72,7 @@ module Axlsx
       @list << v
       @list.size - 1
     end
-
-    # alternate of << method
-    # @see <<
-    def push(v)
-      self.<< v
-    end
+    alias :push :<<
 
     # delete the item from the list
     # @param [Any] v The item to be deleted.
@@ -149,25 +156,12 @@ module Axlsx
 
     def to_xml_string(str = '')
       classname = @allowed_types[0].name.split('::').last
-      el_name = serialize_as || (classname[0,1].downcase + classname[1..-1])
+      el_name = serialize_as.to_s || (classname[0,1].downcase + classname[1..-1])
       str << '<' << el_name << ' count="' << @list.size.to_s << '">'
       @list.each { |item| item.to_xml_string(str) }
       str << '</' << el_name << '>'
     end
 
-    # Serializes the list
-    # If the serialize_as property is set, it is used as the parent node name.
-    # If the serialize_as property is nil, the first item in the list of allowed_types will be used, having the first letter of the class changed to lower case.
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
-    # @return [String]
-    def to_xml(xml)
-      classname = @allowed_types[0].name.split('::').last
-      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) }
-      }
-    end
-
   end
 
 

data/lib/axlsx/util/validators.rb

@@ -45,8 +45,20 @@ module Axlsx
     true
   end
 
+
+  # Requires that the value can be converted to an integer
+  # @para, [Any] v the value to validate
+  # @raise [ArgumentError] raised if the value cannot be converted to an integer
+  def self.validate_integerish(v)
+    raise ArgumentError, (ERR_INTEGERISH % v.inspect) unless (v.respond_to?(:to_i) && v.to_i.is_a?(Integer))
+  end
+
+  # Requires that the value is between -54000000 and 54000000
+  # @param [Any] v The value validated
+  # @raise [ArgumentError] raised if the value cannot be converted to an integer between the allowed angle values for chart label rotation.
+  # @return [Boolean] true if the data is valid
   def self.validate_angle(v)
-    raise ArgumentError, (ERR_ANGLE % v.inspect) unless (v >= -5400000 && v <= 5400000)
+    raise ArgumentError, (ERR_ANGLE % v.inspect) unless (v.to_i >= -5400000 && v.to_i <= 5400000)
   end
   # Requires that the value is a Fixnum or Integer and is greater or equal to 0
   # @param [Any] v The value validated
@@ -90,6 +102,27 @@ module Axlsx
     DataTypeValidator.validate :float, Float, v
   end
 
+  # Requires that the value is a string containing a positive decimal number followed by one of the following units:
+  # "mm", "cm", "in", "pt", "pc", "pi"
+  def self.validate_number_with_unit(v)
+    RegexValidator.validate "number_with_unit", /\A[0-9]+(\.[0-9]+)?(mm|cm|in|pt|pc|pi)\Z/, v
+  end
+
+  # Requires that the value is an integer ranging from 10 to 400.
+  def self.validate_scale_10_400(v)
+    DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg >= 10 && arg <= 400 }
+  end
+  
+  # Requires that the value is an integer ranging from 10 to 400 or 0.
+  def self.validate_scale_0_10_400(v)
+    DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| arg == 0 || (arg >= 10 && arg <= 400) }
+  end
+
+  # Requires that the value is one of :default, :landscape, or :portrait.
+  def self.validate_page_orientation(v)
+    RestrictionValidator.validate "page_orientation", [:default, :landscape, :portrait], v
+  end
+
   # Requires that the value is valid pattern type.
   # valid pattern types must be one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown,
   # :darkUp, :darkGrid, :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, :lightTrellis, :gray125, or :gray0625.
@@ -104,8 +137,6 @@ module Axlsx
   # thisMonth, lastMonth, nextMonth, thisWeek, lastWeek, nextWeek
   def self.validate_time_period_type(v)
     RestrictionValidator.validate :time_period_type, [:today, :yesterday, :tomorrow, :last7Days, :thisMonth, :lastMonth, :nextMonth, :thisWeek, :lastWeek, :nextWeek], v
-
-
   end
 
   # Requires that the value is one of the valid ST_IconSet types
@@ -150,7 +181,7 @@ module Axlsx
   # Requires that the value is a valid scatterStyle
   # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
   # must be one of "none" | "line" | "lineMarker" | "marker" | "smooth" | "smoothMarker"
-  # @param [Symbol|String] the value to validate
+  # @param [Symbol|String] v the value to validate
   def self.validate_scatter_style(v)
     Axlsx::RestrictionValidator.validate "ScatterChart.scatterStyle", [:none, :line, :lineMarker, :marker, :smooth, :smoothMarker], v.to_sym
   end
@@ -169,17 +200,17 @@ module Axlsx
   end
 
   # Requires that the value is a valid content_type
-  # TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, DRAWING_CT are allowed
+  # TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, DRAWING_CT, COMMENT_CT are allowed
   # @param [Any] v The value validated
   def self.validate_content_type(v)
-    RestrictionValidator.validate :content_type, [TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, JPEG_CT, GIF_CT, PNG_CT, DRAWING_CT], v
+    RestrictionValidator.validate :content_type, [TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, JPEG_CT, GIF_CT, PNG_CT, DRAWING_CT, COMMENT_CT, VML_DRAWING_CT], v
   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, 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, SHARED_STRINGS_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, COMMENT_R, VML_DRAWING_R, COMMENT_R_NULL], v
   end
 
   # Requires that the value is a valid table element type
@@ -189,4 +220,46 @@ module Axlsx
     RestrictionValidator.validate :table_element_type, [:wholeTable, :headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, :secondRowStripe, :firstColumnStripe, :secondColumnStripe, :firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, :firstSubtotalColumn, :secondSubtotalColumn, :thirdSubtotalColumn, :firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, :firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, :firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, :pageFieldLabels, :pageFieldValues], v
   end
 
+  # Requires that the value is a valid data_validation_error_style
+  # :information, :stop, :warning
+  # @param [Any] v The value validated
+  def self.validate_data_validation_error_style(v)
+    RestrictionValidator.validate :validate_data_validation_error_style, [:information, :stop, :warning], v
+  end
+  
+  # Requires that the value is valid data validation operator.
+  # valid operators must be one of lessThan, lessThanOrEqual, equal,
+  # notEqual, greaterThanOrEqual, greaterThan, between, notBetween
+  # @param [Any] v The value validated
+  def self.validate_data_validation_operator(v)
+    RestrictionValidator.validate :data_validation_operator, [:lessThan, :lessThanOrEqual, :equal, :notEqual, :greaterThanOrEqual, :greaterThan, :between, :notBetween], v
+  end
+  
+  # Requires that the value is valid data validation type.
+  # valid types must be one of custom, data, decimal, list, none, textLength, time, whole
+  # @param [Any] v The value validated
+  def self.validate_data_validation_type(v)
+    RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
+  end
+  
+  # Requires that the value is a valid sheet view type.
+  # valid types must be one of normal, page_break_preview, page_layout
+  # @param [Any] v The value validated
+  def self.validate_sheet_view_type(v)
+    RestrictionValidator.validate :sheet_view_type, [:normal, :page_break_preview, :page_layout], v
+  end
+  
+  # Requires that the value is a valid active pane type.
+  # valid types must be one of bottom_left, bottom_right, top_left, top_right
+  # @param [Any] v The value validated
+  def self.validate_pane_type(v)
+    RestrictionValidator.validate :active_pane_type, [:bottom_left, :bottom_right, :top_left, :top_right], v
+  end
+  
+  # Requires that the value is a valid split state type.
+  # valid types must be one of frozen, frozen_split, split
+  # @param [Any] v The value validated
+  def self.validate_split_state_type(v)
+    RestrictionValidator.validate :split_state_type, [:frozen, :frozen_split, :split], v
+  end
 end

data/lib/axlsx/version.rb

@@ -1,10 +1,5 @@
 # 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.1.4" unless defined? Axlsx::VERSION
-
+  # The current version
+  VERSION="1.2.0"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -0,0 +1,174 @@
+#  <definedNames>
+#    <definedName name="_xlnm.Print_Titles" localSheetId="0">Sheet1!$1:$1</definedName>
+#  </definedNames>
+
+#<xsd:complexType name="CT_DefinedName">
+# <xsd:simpleContent>
+# <xsd:extension base="ST_Formula">
+# <xsd:attribute name="name" type="s:ST_Xstring" use="required"/>
+# <xsd:attribute name="comment" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="customMenu" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="description" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="help" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="statusBar" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="localSheetId" type="xsd:unsignedInt" use="optional"/>
+# <xsd:attribute name="hidden" type="xsd:boolean" use="optional" default="false"/>
+# <xsd:attribute name="function" type="xsd:boolean" use="optional" default="false"/>
+# <xsd:attribute name="vbProcedure" type="xsd:boolean" use="optional" default="false"/>
+# <xsd:attribute name="xlm" type="xsd:boolean" use="optional" default="false"/>
+# <xsd:attribute name="functionGroupId" type="xsd:unsignedInt" use="optional"/>
+# <xsd:attribute name="shortcutKey" type="s:ST_Xstring" use="optional"/>
+# <xsd:attribute name="publishToServer" type="xsd:boolean" use="optional" default="false"/>
+# <xsd:attribute name="workbookParameter" type="xsd:boolean" use="optional" default="false"/>
+# </xsd:extenstion>
+# </xsd:simpleContent>
+
+module Axlsx
+  # This element defines the defined names that are defined within this workbook. 
+  # Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value.
+  # Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.
+  # A defined name in a formula can make it easier to understand the purpose of the formula. 
+  # @example
+  #     The formula =SUM(FirstQuarterSales) might be easier to identify than =SUM(C20:C30
+  #
+  # Names are available to any sheet.
+  # @example
+  #     If the name ProjectedSales refers to the range A20:A30 on the first worksheet in a workbook, 
+  #     you can use the name ProjectedSales on any other sheet in the same workbook to refer to range A20:A30 on the first worksheet.
+  # Names can also be used to represent formulas or values that do not change (constants).
+  #
+  # @example
+  #     The name SalesTax can be used to represent the sales tax amount (such as 6.2 percent) applied to sales transactions.
+  # You can also link to a defined name in another workbook, or define a name that refers to cells in another workbook.
+  #
+  # @example
+  #     The formula =SUM(Sales.xls!ProjectedSales) refers to the named range ProjectedSales in the workbook named Sales.
+  # A compliant producer or consumer considers a defined name in the range A1-XFD1048576 to be an error.
+  # All other names outside this range can be defined as names and overrides a cell reference if an ambiguity exists.
+  #
+  # @example
+  #     For clarification: LOG10 is always a cell reference, LOG10() is always formula, LOGO1000 can be a defined name that overrides a cell reference.
+  class DefinedName
+    # creates a new DefinedName.
+    # @param [String] formula - the formula the defined name references
+    # @param [Hash] options - A hash of key/value pairs that will be mapped to this instances attributes.
+    # 
+    # @option [String] name - Specifies the name that appears in the user interface for the defined name.
+    #                         This attribute is required. 
+    #                         The following built-in names are defined in this SpreadsheetML specification:
+    #                         Print
+    #                           _xlnm.Print_Area: this defined name specifies the workbook's print area.
+    #                           _xlnm.Print_Titles: this defined name specifies the row(s) or column(s) to repeat
+    #                                                the top of each printed page.
+    #                         Filter & Advanced Filter
+    #                           _xlnm.Criteria: this defined name refers to a range containing the criteria values
+    #                                  to be used in applying an advanced filter to a range of data.
+    #                           _xlnm._FilterDatabase: can be one of the following
+    #                                     a. this defined name refers to a range to which an advanced filter has been
+    #                                         applied. This represents the source data range, unfiltered.
+    #                                      b. This defined name refers to a range to which an AutoFilter has been
+    #                                         applied.
+    #                           _xlnm.Extract: this defined name refers to the range containing the filtered output 
+    #                                           values resulting from applying an advanced filter criteria to a source range.
+    #                         Miscellaneous
+    #                           _xlnm.Consolidate_Area: the defined name refers to a consolidation area.
+    #                           _xlnm.Database: the range specified in the defined name is from a database data source.
+    #                           _xlnm.Sheet_Title: the defined name refers to a sheet title.
+    # @option [String] comment - A comment to optionally associate with the name
+    # @option [String] custom_menu - The menu text for the defined name
+    # @option [String] description - An optional description for the defined name
+    # @option [String] help - The help topic to display for this defined name
+    # @option [String] status_bar - The text to display on the application status bar when this defined name has focus
+    # @option [String] local_sheet_id - Specifies the sheet index in this workbook where data from an external reference is displayed
+    # @option [Boolean] hidden - Specifies a boolean value that indicates whether the defined name is hidden in the user interface.
+    # @option [Boolean] function - Specifies a boolean value that indicates that the defined name refers to a user-defined function.
+    #                             This attribute is used when there is an add-in or other code project associated with the file.
+    # @option [Boolean] vb_proceedure - Specifies a boolean value that indicates whether the defined name is related to an external function, command, or other executable code.
+    # @option [Boolean] xlm - Specifies a boolean value that indicates whether the defined name is related to an external function, command, or other executable code.
+    # @option [Integer] function_group_id - Specifies the function group index if the defined name refers to a function. 
+    #                                       The function group defines the general category for the function.
+    #                                       This attribute is used when there is an add-in or other code project associated with the file.
+    #                                       See Open Office XML Part 1 for more info.
+    # @option [String] short_cut_key - Specifies the keyboard shortcut for the defined name.
+    # @option [Boolean] publish_to_server - Specifies a boolean value that indicates whether the defined name is included in the 
+    #                                       version of the workbook that is published to or rendered on a Web or application server.
+    # @option [Boolean] workbook_parameter - Specifies a boolean value that indicates that the name is used as a workbook parameter on a 
+    #                                        version of the workbook that is published to or rendered on a Web or application server.
+    def initialize(formula, options={})
+      @formula = formula
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    attr_reader :local_sheet_id
+
+    # The local sheet index (0-based)
+    # @param [Integer] value the unsinged integer index of the sheet this defined_name applies to.
+    def local_sheet_id=(value)
+      Axlsx::validate_unsigned_int(value)
+      @local_sheet_id = value
+    end
+
+    # string attributes that will be added when this class is evaluated
+    STRING_ATTRIBUTES = [:short_cut_key, :status_bar, :help, :description, :custom_menu, :comment]
+
+    # boolean attributes that will be added when this class is evaluated
+    BOOLEAN_ATTRIBUTES = [:workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden] 
+
+    # Dynamically create string attribute accessors
+    STRING_ATTRIBUTES.each do |attr|
+      class_eval %{
+        # The #{attr} attribute reader
+        # @return [String]
+        attr_reader :#{attr}
+
+        # The #{attr} writer
+        # @param [String] value The value to assign to #{attr}
+        # @return [String]
+        def #{attr}=(value)
+          Axlsx::validate_string(value)
+          @#{attr}= value
+        end
+      }
+    end
+
+    # Dynamically create boolean attribute accessors
+    BOOLEAN_ATTRIBUTES.each do |attr|
+      class_eval %{
+      # The #{attr} attribute reader
+      # @return [Boolean]
+      attr_reader :#{attr}
+
+      # The #{attr} writer
+      # @param [Boolean] value The value to assign to #{attr}
+      # @return [Boolean]
+      def #{attr}=(value)
+        Axlsx::validate_boolean(value)
+        @#{attr} = value
+      end
+      }
+    end
+   
+    attr_reader :name
+    # The name of this defined name. Please refer to the class documentation for more information
+    def name=(value)
+      Axlsx::RestrictionValidator.validate 'DefinedName.name', %w(_xlnm.Print_Area _xlnm.Print_Titles _xlnm.Criteria _xlnm._FilterDatabase _xlnm.Extract _xlnm.Consolidate_Area _xlnm.Database _xlnm.Sheet_Title), value
+      @name = value
+    end
+
+    # The formula this defined name references
+    attr_reader :formula
+
+    def to_xml_string(str='')
+      raise ArgumentError, 'you must specify the name for this defined name. Please read the documentation for Axlsx::DefinedName for more details' unless name 
+      str << '<definedName'
+      instance_values.each do |name, value| 
+        unless name == 'formula'
+          str << ' ' << Axlsx::camel(name, false) << "='#{value}'"
+        end
+      end
+      str << '>' << @formula
+      str << '</definedName>'
+    end
+  end
+end