axlsx 1.3.6 → 2.0.0

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -142,10 +142,10 @@ module Axlsx
     end
 
     # A hash of axes used by this chart. Bar charts have a value and
-    # category axes specified via axex[:val_axes] and axes[:cat_axis]
+    # category axes specified via axes[:val_axes] and axes[:cat_axis]
     # @return [Axes]
     def axes
-     @axes ||= Axes.new(:val_axis => ValAxis, :cat_axis => CatAxis)
+     @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
     end
   end
 end

data/lib/axlsx/drawing/chart.rb

@@ -20,6 +20,7 @@ module Axlsx
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
       @series = SimpleTypedList.new Series
       @show_legend = true
+      @display_blanks_as = :gap
       @series_type = Series
       @title = Title.new
       parse_options options
@@ -70,10 +71,19 @@ module Axlsx
     # @return [Boolean]
     attr_reader :show_legend
 
-    # returns a relationship object for the chart
-    # @return [Axlsx::Relationship]
+    # How to display blank values
+    # Options are
+    # * gap:  Display nothing
+    # * span: Not sure what this does
+    # * zero: Display as if the value were zero, not blank
+    # @return [Symbol]
+    # Default :gap (although this really should vary by chart type and grouping)
+    attr_reader :display_blanks_as
+
+    # The relationship object for this chart.
+    # @return [Relationship]
     def relationship
-      Relationship.new(CHART_R, "../#{pn}")
+      Relationship.new(self, CHART_R, "../#{pn}")
     end
 
     # The index of this chart in the workbooks charts collection
@@ -105,6 +115,12 @@ module Axlsx
     # @return [Boolean]
     def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
 
+    # How to display blank values
+    # @see display_blanks_as
+    # @param [Symbol] v
+    # @return [Symbol]
+    def display_blanks_as=(v) Axlsx::validate_display_blanks_as(v); @display_blanks_as = v; end
+
     # The style for the chart.
     # see ECMA Part 1 §21.2.2.196
     # @param [Integer] v must be between 1 and 48
@@ -157,7 +173,7 @@ module Axlsx
         str << '</c:legend>'
       end
       str << '<c:plotVisOnly val="1"/>'
-      str << '<c:dispBlanksAs val="zero"/>'
+      str << '<c:dispBlanksAs val="' << display_blanks_as.to_s << '"/>'
       str << '<c:showDLblsOverMax val="1"/>'
       str << '</c:chart>'
       str << '<c:printSettings>'

data/lib/axlsx/drawing/drawing.rb

@@ -82,7 +82,7 @@ module Axlsx
         TwoCellAnchor.new(self, options).add_pic(options)
       else
         OneCellAnchor.new(self, options)
-      end 
+      end
       @anchors.last.object
     end
 
@@ -121,12 +121,6 @@ module Axlsx
       @worksheet.workbook.drawings.index(self)
     end
 
-    # The relation reference id for this drawing
-    # @return [String]
-    def rId
-      "rId#{index+1}"
-    end
-
     # The part name for this drawing
     # @return [String]
     def pn
@@ -140,15 +134,7 @@ module Axlsx
       "#{DRAWING_RELS_PN % (index+1)}"
     end
 
-    # The index of a chart, image or hyperlink object this drawing contains
-    def index_of(object)
-      child_objects.index(object)
-    end
-
-
-    # An ordered list of objects this drawing holds
-    # It is important that the objects are returned in the same order each time for 
-    # releationship indexing in the package
+    # A list of objects this drawing holds.
     # @return [Array]
     def child_objects
       charts + images + hyperlinks
@@ -168,7 +154,6 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
       str << '<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '">'
-
       anchors.each { |anchor| anchor.to_xml_string(str) }
       str << '</xdr:wsDr>'
     end

data/lib/axlsx/drawing/graphic_frame.rb

@@ -22,15 +22,10 @@ module Axlsx
       @chart = chart_type.new(self, options)
     end
 
-    # The relationship id for this graphic
+    # The relationship id for this graphic frame.
     # @return [String]
-    #
-    # NOTE: Discontinued. This should not be part of GraphicFrame.
-    # The drawing object maintains relationships and needs to be queried to determine the relationship id of any given graphic data child object.
-    #
     def rId
-      warn('axlsx::DEPRECIATED: GraphicFrame#rId has been depreciated. relationship id is determed by the drawing object')
-      "rId#{@anchor.index+1}"
+      @anchor.drawing.relationships.for(chart).Id
     end
 
     # Serializes the object
@@ -49,7 +44,7 @@ module Axlsx
       str << '</xdr:xfrm>'
       str << '<a:graphic>'
       str << '<a:graphicData uri="' << XML_NS_C << '">'
-      str << '<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="rId' << (@anchor.drawing.index_of(@chart)+1).to_s << '"/>'
+      str << '<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="' << rId << '"/>'
       str << '</a:graphicData>'
       str << '</a:graphic>'
       str << '</xdr:graphicFrame>'

data/lib/axlsx/drawing/hyperlink.rb

@@ -83,27 +83,20 @@ module Axlsx
     # @return [String]
     attr_accessor :tooltip
 
-    # Returns a relationship object for this hyperlink
-    # @return [Axlsx::Relationship]
+    # The relationship object for this hyperlink.
+    # @return [Relationship]
     def relationship
-      Relationship.new(HYPERLINK_R, href, :target_mode => :External)
+      Relationship.new(self, HYPERLINK_R, href, :target_mode => :External)
     end
+
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
       str << '<a:hlinkClick '
-      serialized_attributes str, {:'r:id' => "rId#{id}", :'xmlns:r' => XML_NS_R }
+      serialized_attributes str, {:'r:id' => relationship.Id, :'xmlns:r' => XML_NS_R }
       str << '/>'
     end
 
-    private
-
-    # The relational ID for this hyperlink
-    # @return [Integer]
-    def id
-      @parent.anchor.drawing.index_of(self)+1
-    end
-
   end
 end

data/lib/axlsx/drawing/marker.rb

@@ -43,11 +43,14 @@ module Axlsx
     def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
 
     # shortcut to set the column, row position for this marker
-    # @param col the column for the marker
-    # @param row the row of the marker
-    def coord(col, row)
-      self.col = col
-      self.row = row
+    # @param col the column for the marker, a Cell object or a string reference like "B7"
+    # or an Array.
+    # @param row the row of the marker. This is ignored if the col parameter is a Cell or
+    # String or Array.
+    def coord(col, row=0)
+      coordinates = parse_coord_args(col, row)
+      self.col = coordinates[0]
+      self.row = coordinates[1]
     end
 
     # Serializes the object
@@ -58,6 +61,23 @@ module Axlsx
         str << '<xdr:' << k.to_s << '>' << self.send(k).to_s << '</xdr:' << k.to_s << '>'
       end
     end
+    private
+
+    # handles multiple inputs for setting the position of a marker
+    # @see Chart#start_at
+    def parse_coord_args(x, y=0)
+      if x.is_a?(String)
+        x, y = *Axlsx::name_to_indices(x)
+      end
+      if x.is_a?(Cell)
+        x, y = *x.pos
+      end
+      if x.is_a?(Array)
+        x, y = *x
+      end
+      [x, y]
+    end
+
 
   end
 

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -48,6 +48,15 @@ module Axlsx
     # @return [Integer]
     attr_reader :height
 
+    # sets the starting position for the anchor.
+    # You can provide a String like "A1", an array like [0,0] or a cell object for the x parameter.
+    # We just 'figure it out' for you.
+    # @param [Array, String, Cell, Integer] x Accepts many inputs for defining the starting position of the cell.
+    # @param [Integer] y When x is an integer, this value is used for the row index at which the anchor starts.
+    def start_at(x, y=0)
+      from.coord x, y
+    end
+    #
     # @see height
     def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
 

data/lib/axlsx/drawing/pic.rb

@@ -37,7 +37,7 @@ module Axlsx
     attr_reader :descr
 
     # The path to the image you want to include
-    # Only local images are supported at this time and only jpg support
+    # Only local images are supported at this time.
     # @return [String]
     attr_reader :image_src
 
@@ -67,7 +67,7 @@ module Axlsx
 
     def image_src=(v)
       Axlsx::validate_string(v)
-      RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v).delete('.')
+      RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v.downcase).delete('.')
       raise ArgumentError, "File does not exist" unless File.exist?(v)
       @image_src = v
     end
@@ -89,7 +89,8 @@ module Axlsx
     # @return [String]
     def extname
       File.extname(image_src).delete('.') unless image_src.nil?
-    end 
+    end
+
     # The index of this image in the workbooks images collections
     # @return [Index]
     def index
@@ -102,15 +103,10 @@ module Axlsx
       "#{IMAGE_PN % [(index+1), extname]}"
     end
 
-    # The relational id withing the drawing's relationships
-    def id
-      @anchor.drawing.charts.size + @anchor.drawing.images.index(self) + 1
-    end
-
-    # Returns a relationship object for this object
-    # @return Axlsx::Relationship
+    # The relationship object for this pic.
+    # @return [Relationship]
     def relationship
-      Relationship.new(IMAGE_R, "../#{pn}")
+      Relationship.new(self, IMAGE_R, "../#{pn}")
     end
 
     # providing access to the anchor's width attribute
@@ -148,9 +144,8 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def start_at(x, y)
-      @anchor.from.col = x
-      @anchor.from.row = y
+    def start_at(x, y=nil)
+      @anchor.start_at x, y
       @anchor.from
     end
 
@@ -158,10 +153,9 @@ module Axlsx
     # @param [Integer] x The column
     # @param [Integer] y The row
     # @return [Marker]
-    def end_at(x, y)
+    def end_at(x, y=nil)
       use_two_cell_anchor unless @anchor.is_a?(TwoCellAnchor)
-      @anchor.to.col = x
-      @anchor.to.row = y
+      @anchor.end_at x, y
       @anchor.to
     end
 
@@ -177,7 +171,7 @@ module Axlsx
       picture_locking.to_xml_string(str)
       str << '</xdr:cNvPicPr></xdr:nvPicPr>'
       str << '<xdr:blipFill>'
-      str << '<a:blip xmlns:r ="' << XML_NS_R << '" r:embed="rId' << id.to_s <<  '"/>'
+      str << '<a:blip xmlns:r ="' << XML_NS_R << '" r:embed="' << relationship.Id <<  '"/>'
       str << '<a:stretch><a:fillRect/></a:stretch></xdr:blipFill><xdr:spPr>'
       str << '<a:xfrm><a:off x="0" y="0"/><a:ext cx="2336800" cy="2161540"/></a:xfrm>'
       str << '<a:prstGeom prst="rect"><a:avLst/></a:prstGeom></xdr:spPr></xdr:pic>'
@@ -189,22 +183,22 @@ module Axlsx
     # Changes the anchor to a one cell anchor.
     def use_one_cell_anchor
       return if @anchor.is_a?(OneCellAnchor)
-      swap_anchor(OneCellAnchor.new(@anchor.drawing, :from => @anchor.from))
+      new_anchor = OneCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
     end
 
     #changes the anchor type to a two cell anchor
     def use_two_cell_anchor
       return if @anchor.is_a?(TwoCellAnchor)
-      swap_anchor(TwoCellAnchor.new(@anchor.drawing)).tap do |new_anchor|
-        new_anchor.from.col = @anchor.from.col
-        new_anchor.from.row = @anchor.from.row
-      end
+      new_anchor = TwoCellAnchor.new(@anchor.drawing, :start_at => [@anchor.from.col, @anchor.from.row])
+      swap_anchor(new_anchor)
     end
 
     # refactoring of swapping code, law of demeter be damned!
     def swap_anchor(new_anchor)
       new_anchor.drawing.anchors.delete(new_anchor)
       @anchor.drawing.anchors[@anchor.drawing.anchors.index(@anchor)] = new_anchor
+      new_anchor.instance_variable_set "@object", @anchor.object
       @anchor = new_anchor
     end
   end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -5,6 +5,8 @@ module Axlsx
   # @see Worksheet#add_chart
   class TwoCellAnchor
 
+    include Axlsx::OptionsParser
+
     # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
     # @return [Marker]
     attr_reader :from
@@ -34,22 +36,23 @@ module Axlsx
       @drawing = drawing
       drawing.anchors << self
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
+      parse_options options
     end
 
     # sets the col, row attributes for the from marker.
     # @note The recommended way to set the start position for graphical
     # objects is directly thru the object. 
     # @see Chart#start_at
-    def start_at(x, y)
-      set_marker_coords(x, y, from)
+    def start_at(x, y=nil)
+      from.coord x, y
     end
 
     # sets the col, row attributes for the to marker
     # @note the recommended way to set the to position for graphical
     # objects is directly thru the object
     # @see Char#end_at
-    def end_at(x, y)
-      set_marker_coords(x, y, to) 
+    def end_at(x, y=nil)
+      to.coord x, y
     end
 
     # Creates a graphic frame and chart object associated with this anchor
@@ -85,28 +88,5 @@ module Axlsx
       str << '<xdr:clientData/>'
       str << '</xdr:twoCellAnchor>'
     end
-    private 
-
-    # parses coordinates and sets up a marker's row/col propery
-    def set_marker_coords(x, y, marker)
-      marker.col, marker.row = *parse_coord_args(x, y)
-    end
-
-    # handles multiple inputs for setting the position of a marker
-    # @see Chart#start_at
-    def parse_coord_args(x, y=0)
-      if x.is_a?(String)
-        x, y = *Axlsx::name_to_indices(x)
-      end
-      if x.is_a?(Cell)
-        x, y = *x.pos
-      end
-      if x.is_a?(Array)
-        x, y = *x
-      end
-      [x, y]
-    end
-
-
   end
 end

data/lib/axlsx/package.rb

@@ -17,12 +17,14 @@ module Axlsx
     #
     # @param [Hash] options A hash that you can use to specify the author and workbook for this package.
     # @option options [String] :author The author of the document
+    # @option options [Time] :created_at Timestamp in the document properties (defaults to current time).
     # @option options [Boolean] :use_shared_strings This is passed to the workbook to specify that shared strings should be used when serializing the package.
     # @example Package.new :author => 'you!', :workbook => Workbook.new
     def initialize(options={})
       @workbook = nil
       @core, @app  =  Core.new, App.new
       @core.creator = options[:author] || @core.creator
+      @core.created = options[:created_at]
       parse_options options
       yield self if block_given?
     end
@@ -35,12 +37,6 @@ module Axlsx
     end
 
 
-    # Shortcut to specify that the workbook should use shared strings
-    # @see Workbook#use_shared_strings
-    def use_shared_strings=(v)
-      Axlsx::validate_boolean(v);
-      workbook.use_shared_strings = v
-    end
 
     # Shortcut to determine if the workbook is configured to use shared strings
     # @see Workbook#use_shared_strings
@@ -48,6 +44,12 @@ module Axlsx
       workbook.use_shared_strings
     end
 
+    # Shortcut to specify that the workbook should use shared strings
+    # @see Workbook#use_shared_strings
+    def use_shared_strings=(v)
+      Axlsx::validate_boolean(v);
+      workbook.use_shared_strings = v
+    end
     # The workbook this package will serialize or validate.
     # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned.
     # @raise ArgumentError if workbook parameter is not a Workbook instance.
@@ -98,6 +100,7 @@ module Axlsx
     #   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?
+      Relationship.clear_cached_instances
       Zip::ZipOutputStream.open(output) do |zip|
         write_parts(zip)
       end
@@ -110,6 +113,7 @@ module Axlsx
     # @return [StringIO|Boolean] False if confirm_valid and validation errors exist. rewound string IO if not.
     def to_stream(confirm_valid=false)
       return false unless !confirm_valid || self.validate.empty?
+      Relationship.clear_cached_instances
       zip = write_parts(Zip::ZipOutputStream.new("streamed", true))
       stream = zip.close_buffer
       stream.rewind
@@ -156,12 +160,12 @@ module Axlsx
       p = parts
       p.each do |part|
         unless part[:doc].nil?
-          zip.put_next_entry(part[:entry])
+          zip.put_next_entry(zip_entry_for_part(part))
           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]);
+          zip.put_next_entry(zip_entry_for_part(part))
           # binread for 1.9.3
           zip.write IO.respond_to?(:binread) ? IO.binread(part[:path]) : IO.read(part[:path])
         end
@@ -169,6 +173,22 @@ module Axlsx
       zip
     end
 
+    # Generate a ZipEntry for the given package part.
+    # The important part here is to explicitly set the timestamp for the zip entry: Serializing axlsx packages 
+    # with identical contents should result in identical zip files – however, the timestamp of a zip entry
+    # defaults to the time of serialization and therefore the zip file contents would be different every time
+    # the package is serialized.
+    #
+    # Note: {Core#created} also defaults to the current time – so to generate identical axlsx packages you have
+    # to set this explicitly, too (eg. with `Package.new(created_at: Time.local(2013, 1, 1))`).
+    #
+    # @param part A hash describing a part of this pacakge (see {#parts})
+    # @return [Zip::ZipEntry]
+    def zip_entry_for_part(part)
+      timestamp = Zip::DOSTime.at(@core.created.to_i)
+      Zip::ZipEntry.new("", part[:entry], "", "", 0, 0, Zip::ZipEntry::DEFLATED, 0, timestamp)
+    end
+    
     # The parts of a package
     # @return [Array] An array of hashes that define the entry, document and schema for each part of the package.
     # @private
@@ -321,9 +341,9 @@ module Axlsx
     # @private
     def relationships
       rels = Axlsx::Relationships.new
-      rels << Relationship.new(WORKBOOK_R, WORKBOOK_PN)
-      rels << Relationship.new(CORE_R, CORE_PN)
-      rels << Relationship.new(APP_R, APP_PN)
+      rels << Relationship.new(self, WORKBOOK_R, WORKBOOK_PN)
+      rels << Relationship.new(self, CORE_R, CORE_PN)
+      rels << Relationship.new(self, APP_R, APP_PN)
       rels.lock
       rels
     end