axlsx 1.1.6 → 1.2.0

data/lib/axlsx/drawing/num_data.rb

@@ -25,8 +25,8 @@ module Axlsx
     def data=(values=[])
       @tag_name = values.first.is_a?(Cell) ? :numCache : :numLit
       values.each do |value|
-        v = value.is_a?(Cell) ? value.value : value
-        @pt << NumVal.new(:v => v)
+        value = value.is_formula? ? 0 : value.value if value.is_a?(Cell)
+        @pt << NumVal.new(:v => value)
       end
     end
 

data/lib/axlsx/drawing/num_data_source.rb

@@ -36,7 +36,7 @@ module Axlsx
     end
 
     # sets the tag name for this data source
-    # @param [Symbol] One of the allowed_tag_names
+    # @param [Symbol] v One of the allowed_tag_names
     def tag_name=(v)
       Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
       @tag_name = v

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -13,19 +13,20 @@ module Axlsx
     # @option options [Cell, String] title
     # @option options [Boolean] show_legend
     # @option options [Symbol] grouping
-    # @option options [String] gapDepth
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
+    # @option options [String] gap_depth
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
       super(frame, options)
       @series_type = PieSeries
-      @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options))
+      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
+      @d_lbls = nil
     end
 
     # Serializes the object
@@ -33,9 +34,11 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       super(str) do |str_inner|
+
         str_inner << '<c:pie3DChart>'
         str_inner << '<c:varyColors val="1"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
+        d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '</c:pie3DChart>'
       end
     end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -29,6 +29,7 @@ module Axlsx
       @yValAxis = ValAxis.new(@yValAxId, @xValAxId)
       super(frame, options)
       @series_type = ScatterSeries
+      @d_lbls = nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
@@ -49,14 +50,7 @@ module Axlsx
         str_inner << '<c:scatterStyle val="' << scatterStyle.to_s << '"/>'
         str_inner << '<c:varyColors val="1"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
-        str_inner << '<c:dLbls>'
-        str_inner << '<c:showLegendKey val="0"/>'
-        str_inner << '<c:showVal val="0"/>'
-        str_inner << '<c:showCatName val="0"/>'
-        str_inner << '<c:showSerName val="0"/>'
-        str_inner << '<c:showPercent val="0"/>'
-        str_inner << '<c:showBubbleSize val="0"/>'
-        str_inner << '</c:dLbls>'
+        d_lbls.to_xml_string(str) if @d_lbls
         str_inner << '<c:axId val="' << @xValAxId.to_s << '"/>'
         str_inner << '<c:axId val="' << @yValAxId.to_s << '"/>'
         str_inner << '</c:scatterChart>'

data/lib/axlsx/drawing/title.rb

@@ -46,15 +46,27 @@ module Axlsx
       str << '<c:title>'
       unless @text.empty?
         str << '<c:tx>'
-        str << '<c:strRef>'
-        str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
-        str << '<c:strCache>'
-        str << '<c:ptCount val="1"/>'
-        str << '<c:pt idx="0">'
-        str << '<c:v>' << @text << '</c:v>'
-        str << '</c:pt>'
-        str << '</c:strCache>'
-        str << '</c:strRef>'
+        if @cell.is_a?(Cell)
+          str << '<c:strRef>'
+          str << '<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>'
+          str << '<c:strCache>'
+          str << '<c:ptCount val="1"/>'
+          str << '<c:pt idx="0">'
+          str << '<c:v>' << @text << '</c:v>'
+          str << '</c:pt>'
+          str << '</c:strCache>'
+          str << '</c:strRef>'
+        else
+          str << '<c:rich>'
+            str << '<a:bodyPr/>'
+            str << '<a:lstStyle/>'
+            str << '<a:p>'
+              str << '<a:r>'
+                str << '<a:t>' << @text.to_s << '</a:t>'
+              str << '</a:r>'
+            str << '</a:p>'
+          str << '</c:rich>'
+        end
         str << '</c:tx>'
       end
       str << '<c:layout/>'

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -25,23 +25,33 @@ module Axlsx
     # @return [Drawing]
     attr_reader :drawing
 
-
-    # Creates a new TwoCellAnchor object and sets up a reference to the from and to markers in the
-    # graphic_frame's chart. That means that you can do stuff like
-    # c = worksheet.add_chart Axlsx::Chart
+    # Creates a new TwoCellAnchor object
     # c.start_at 5, 9
-    # @note the chart_type parameter will be replaced with object in v. 2.0.0
     # @param [Drawing] drawing
-    # @param [Class] chart_type This is passed to the graphic frame for instantiation. must be Chart or a subclass of Chart
-    # @param object The object this anchor holds.
-    # @option options [Array] start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
-    # @option options [Array] end_at the col, row to end at
+    # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
+    # @option options [Array] :end_at the col, row to end at
     def initialize(drawing, options={})
       @drawing = drawing
       drawing.anchors << self
       @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
     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)
+    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) 
+    end
+
     # Creates a graphic frame and chart object associated with this anchor
     # @return [Chart]
     def add_chart(chart_type, options)
@@ -75,6 +85,28 @@ 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/drawing/view_3D.rb

@@ -12,63 +12,73 @@ module Axlsx
     # x rotation for the chart
     # must be between -90 and 90
     # @return [Integer]
-    attr_reader :rotX
-
+    attr_reader :rot_x
+    alias :rotX :rot_x
+    
     # height of chart as % of chart
     # must be between 5% and 500%
     # @return [String]
-    attr_reader :hPercent
+    attr_reader :h_percent
+    alias :hPercent :h_percent
 
     # y rotation for the chart
     # must be between 0 and 360
     # @return [Integer]
-    attr_reader :rotY
-
+    attr_reader :rot_y
+    alias :rotY :rot_y
+    
     # depth or chart as % of chart width
     # must be between 20% and 2000%
     # @return [String]
-    attr_reader :depthPercent
+    attr_reader :depth_percent
+    alias :depthPercent :depth_percent
 
     # Chart axis are at right angles
     # @return [Boolean]
-    attr_reader :rAngAx
+    attr_reader :r_ang_ax
+    alias :rAngAx :r_ang_ax
 
     # field of view angle
     # @return [Integer]
     attr_reader :perspective
 
     # Creates a new View3D for charts
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
     def initialize(options={})
-      @rotX, @hPercent, @rotY, @depthPercent, @rAngAx, @perspective  = nil, nil, nil, nil, nil, nil
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
 
-    # @see rotX
-    def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rotX = v; end
+    # @see rot_x
+    def rot_x=(v) DataTypeValidator.validate "#{self.class}.rot_x", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rot_x = v; end
+    alias :rotX= :rot_x=
 
-    # @see hPercent
-    def hPercent=(v)
-      RegexValidator.validate "#{self.class}.hPercent", H_PERCENT_REGEX, v
-      @hPercent = v
+    # @see h_percent
+    def h_percent=(v)
+      RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+      @h_percent = v
     end
+    alias :hPercent= :h_percent=
 
-    # @see rotY
-    def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rotY = v; end
-
-    # @see depthPercent
-    def depthPercent=(v) RegexValidator.validate "#{self.class}.depthPercent", DEPTH_PERCENT_REGEX, v; @depthPercent = v; end
+    # @see rot_y
+    def rot_y=(v) DataTypeValidator.validate "#{self.class}.rot_y", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rot_y = v; end
+    alias :rotY= :rot_y=
 
-    # @see rAngAx
-    def rAngAx=(v) Axlsx::validate_boolean(v); @rAngAx = v; end
+    # @see depth_percent
+    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    alias :depthPercent= :depth_percent=
 
+    # @see r_ang_ax
+    def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    alias :rAngAx= :r_ang_ax=
+     
     # @see perspective
     def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
@@ -78,11 +88,11 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<c:view3D>'
-      str << '<c:rotX val="' << @rotX.to_s << '"/>' unless @rotX.nil?
-      str << '<c:hPercent val="' << @hPercent.to_s << '"/>' unless @hPercent.nil?
-      str << '<c:rotY val="' << @rotY.to_s << '"/>' unless @rotY.nil?
-      str << '<c:depthPercent val="' << @depthPercent.to_s << '"/>' unless @depthPercent.nil?
-      str << '<c:rAngAx val="' << @rAngAx.to_s << '"/>' unless @rAngAx.nil?
+      str << '<c:rotX val="' << @rot_x.to_s << '"/>' unless @rot_x.nil?
+      str << '<c:hPercent val="' << @h_percent.to_s << '"/>' unless @h_percent.nil?
+      str << '<c:rotY val="' << @rot_y.to_s << '"/>' unless @rot_y.nil?
+      str << '<c:depthPercent val="' << @depth_percent.to_s << '"/>' unless @depth_percent.nil?
+      str << '<c:rAngAx val="' << @r_ang_ax.to_s << '"/>' unless @r_ang_ax.nil?
       str << '<c:perspective val="' << @perspective.to_s << '"/>' unless @perspective.nil?
       str << '</c:view3D>'
     end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -4,7 +4,7 @@ module Axlsx
   class VmlDrawing
 
     # creates a new Vml Drawing object.
-    # @param [Comments] the comments object this drawing is associated with
+    # @param [Comments] comments the comments object this drawing is associated with
     def initialize(comments)
       raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
       @comments = comments

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
 

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/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/util/constants.rb

@@ -249,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"

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,7 +156,7 @@ 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 << '>'

data/lib/axlsx/util/validators.rb

@@ -109,9 +109,14 @@ module Axlsx
   end
 
   # Requires that the value is an integer ranging from 10 to 400.
-  def self.validate_page_scale(v)
+  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)
@@ -132,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
@@ -178,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
@@ -238,4 +241,25 @@ module Axlsx
   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.6" unless defined? Axlsx::VERSION
-
+  # The current version
+  VERSION="1.2.0"
 end