axlsx 1.1.4 → 1.1.5

data/lib/axlsx/drawing/vml_shape.rb~

@@ -0,0 +1,61 @@
+module Axlsx
+  class VmlShape
+
+    attr_reader :row
+
+    attr_reader :column
+
+    attr_reader :left_column
+    attr_reader :left_offset
+    attr_reader :top_row
+    attr_reader :top_offset
+    attr_reader :right_column
+    attr_reader :right_offset
+    attr_reader :bottom_row
+    attr_reader :bottom_offset
+
+    def initialize(comment, options={})
+      @row = @column = 0
+      @left_column = 0
+      @left_offset = 15
+      @top_row = 0
+      @top_offset = 2
+      @right_column = 0
+      @right_offset = 50
+      @bottom_row = 0
+      @bottom_offset = 5
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+
+
+    end
+
+    def xml_to_string(str ='')        str << <<SHAME_ON_YOU
+
+<v:shape id="_x0000_s#{@comments.worksheet.index+1}07#{index+1}" type="#_x0000_t202"
+style='position:absolute;margin-left:104pt;margin-top:2pt;width:800px;height:27pt;z-index:1;mso-wrap-style:tight'
+ fillcolor="#ffffa1 [80]" o:insetmode="auto">
+  <v:fill color2="#ffffa1 [80]"/>
+  <v:shadow on="t" obscured="t"/>
+  <v:path o:connecttype="none"/>
+  <v:textbox style='mso-fit-text-with-word-wrap:t'>
+   <div style='text-align:left'></div>
+  </v:textbox>
+
+  <x:ClientData ObjectType="Note">
+   <x:MoveWithCells/>
+   <x:SizeWithCells/>
+# LeftColumn, LeftOffset, TopRow, TopOffset, RightColumn, RightOffset, BottomRow, BottomOffset.
+   <x:Anchor>#{comment.comments.worksheet[comment.ref].index + 1}, 15, #{comment.comments.worksheet[comment.ref].row.index}, 2, #{comment.comments.worksheet[comment.ref].index + 5}, 50, #{comment.comments.worksheet[comment.ref].row.index + 5}, 5</x:Anchor>
+   <x:AutoFill>False</x:AutoFill>
+   <x:Row>#{comment.comments.worksheet[comment.ref].row.index}</x:Row>
+   <x:Column>#{comment.comments.worksheet[comment.ref].index}</x:Column>
+   <x:Visible/>
+  </x:ClientData>
+ </v:shape>
+SHAME_ON_YOU
+
+    end
+  end
+end

data/lib/axlsx/package.rb

@@ -180,15 +180,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 +238,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/relationships.rb

@@ -17,16 +17,6 @@ require 'axlsx/rels/relationship.rb'
       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/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/'
 
@@ -240,4 +261,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/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,22 @@ 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_page_scale(v)
+    DataTypeValidator.validate "page_scale", [Fixnum, Integer], v, lambda { |arg| 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.
@@ -169,17 +197,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

data/lib/axlsx/version.rb

@@ -5,6 +5,6 @@ module Axlsx
   # 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
+  VERSION="1.1.5" unless defined? Axlsx::VERSION
 
 end

data/lib/axlsx/workbook/workbook.rb

@@ -4,6 +4,8 @@ module Axlsx
 require 'axlsx/workbook/worksheet/date_time_converter.rb'
 require 'axlsx/workbook/worksheet/cell.rb'
 require 'axlsx/workbook/worksheet/page_margins.rb'
+require 'axlsx/workbook/worksheet/page_setup.rb'
+require 'axlsx/workbook/worksheet/print_options.rb'
 require 'axlsx/workbook/worksheet/cfvo.rb'
 require 'axlsx/workbook/worksheet/color_scale.rb'
 require 'axlsx/workbook/worksheet/data_bar.rb'
@@ -12,6 +14,8 @@ require 'axlsx/workbook/worksheet/conditional_formatting.rb'
 require 'axlsx/workbook/worksheet/conditional_formatting_rule.rb'
 require 'axlsx/workbook/worksheet/row.rb'
 require 'axlsx/workbook/worksheet/col.rb'
+require 'axlsx/workbook/worksheet/comments.rb'
+require 'axlsx/workbook/worksheet/comment.rb'
 require 'axlsx/workbook/worksheet/worksheet.rb'
 require 'axlsx/workbook/shared_strings_table.rb'
 require 'axlsx/workbook/worksheet/table.rb'
@@ -82,6 +86,9 @@ require 'axlsx/workbook/worksheet/table.rb'
     # @return [SimpleTypedList]
     attr_reader :drawings
 
+    # pretty sure this two are always empty and can be removed.
+
+
     # A colllection of tables associated with this workbook
     # @note The recommended way to manage drawings is Worksheet#add_table
     # @see Worksheet#add_table
@@ -90,6 +97,15 @@ require 'axlsx/workbook/worksheet/table.rb'
     attr_reader :tables
 
 
+    # A colllection of comments associated with this workbook
+    # @note The recommended way to manage comments is Worksheet#add_comment
+    # @see Worksheet#add_comment
+    # @see Comment
+    # @return [Comments]
+    def comments
+      self.worksheets.map { |ws| ws.comments }.compact
+    end
+
     # The styles associated with this workbook
     # @note The recommended way to manage styles is Styles#add_style
     # @see Style#add_style
@@ -123,7 +139,12 @@ require 'axlsx/workbook/worksheet/table.rb'
       @drawings = SimpleTypedList.new Drawing
       @charts = SimpleTypedList.new Chart
       @images = SimpleTypedList.new Pic
+
+      # Are these even used????? Check package serialization parts
       @tables = SimpleTypedList.new Table
+      @comments = SimpleTypedList.new Comments
+
+
       @use_autowidth = true
 
       self.date1904= !options[:date1904].nil? && options[:date1904]

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

@@ -288,13 +288,15 @@ module Axlsx
     # @param [String] str The string index the cell content will be appended to. Defaults to empty string.
     # @return [String] xml text for the cell
     def to_xml_string(r_index, c_index, str = '')
-      return str if @value.nil?
       str << '<c r="' << Axlsx::cell_r(c_index, r_index) << '" s="' << @style.to_s << '" '
+      return str << '/>' if @value.nil?
+
       case @type
+
       when :string
         #parse formula
         if @value.start_with?('=')
-          str  << 't="str"><f>' << @value.to_s.gsub('=', '') << '</f>'
+          str  << 't="str"><f>' << @value.to_s.sub('=', '') << '</f>'
         else
           #parse shared
           if @ssti

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

@@ -0,0 +1,107 @@
+module Axlsx
+
+  # A comment is the text data for a comment
+  class Comment
+
+    # The text to render
+    # @return [String]
+    attr_reader :text
+
+    # The author of this comment
+    # @see Comments
+    # @return [String]
+    attr_reader :author
+
+    # The owning Comments object
+    # @return [Comments]
+    attr_reader :comments
+
+
+    # The string based cell position reference (e.g. 'A1') that determines the positioning of this comment
+    # @return [String]
+    attr_reader :ref
+
+    # TODO
+    # r (Rich Text Run)
+    # rPh (Phonetic Text Run)
+    # phoneticPr (Phonetic Properties)
+
+    def initialize(comments, options={})
+      raise ArgumentError, "A comment needs a parent comments object" unless comments.is_a?(Comments)
+      @comments = comments
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      yield self if block_given?
+    end
+
+    # The vml shape that will render this comment
+    # @return [VmlShape]
+    def vml_shape
+      @vml_shape ||= initialize_vml_shape
+    end
+
+    # The index of this comment
+    # @return [Integer]
+    def index
+      @comments.index(self)
+    end
+
+    #
+    # The index of this author in a unique sorted list of all authors in
+    # the comment.
+    # @return [Integer]
+    def author_index
+      @comments.authors.index(author)
+    end
+
+    # @see ref
+    def ref=(v)
+      Axlsx::DataTypeValidator.validate "Comment.ref", [String, Cell], v
+      @ref = v if v.is_a?(String)
+      @ref = v.r if v.is_a?(Cell)
+    end
+
+    # @see text
+    def text=(v)
+      Axlsx::validate_string(v)
+      @text = v
+    end
+
+    # @see author
+    def author=(v)
+      @author = v
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    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 << '<r>'
+      str << '<rPr><color indexed="81"/></rPr>'
+      str << '<t>' << text << '</t></r></text>'
+      str << '</comment>'
+    end
+
+    private
+
+    # initialize the vml shape based on this comment's ref/position in the worksheet.
+    # by default, all columns are 5 columns wide and 5 rows high
+    def initialize_vml_shape
+      pos = Axlsx::name_to_indices(ref)
+      @vml_shape = VmlShape.new(:row => pos[1], :column => pos[0]) do |vml|
+        vml.left_column = vml.row + 1
+        vml.right_column = vml.column + 4
+        vml.top_row = vml.row
+        vml.bottom_row = vml.row + 4
+      end
+    end
+
+  end
+end