axlsx 1.1.7 → 1.2.0

data/lib/axlsx/content_type/default.rb

@@ -1,8 +1,23 @@
 # encoding: UTF-8
 module Axlsx
+
   # An default content part. These parts are automatically created by for you based on the content of your package.
   class Default
 
+    #Creates a new Default object
+    # @option options [String] extension
+    # @option options [String] content_type
+    # @raise [ArgumentError] An argument error is raised if both extension and content_type are not specified.
+    def initialize(options={})
+      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
+      end
+    end
+
+    # Error string for option validation
+    INVALID_ARGUMENTS = "extension and content_type are required"
+
     # The extension of the content type.
     # @return [String]
     attr_reader :extension
@@ -13,18 +28,6 @@ module Axlsx
     attr_reader :content_type
     alias :ContentType :content_type
 
-    #Creates a new Default object
-    # @option options [String] extension
-    # @option options [String] content_type
-    # @raise [ArgumentError] An argument error is raised if both extension and content_type are not specified.
-    def initialize(options={})
-      raise ArgumentError, "extension and content_type are required" unless (options[:Extension] || options[:extension]) && (options[:content_type] || options[:ContentType])
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
-
     # Sets the file extension for this content type.
     def extension=(v) Axlsx::validate_string v; @extension = v end
     alias :Extension= :extension=
@@ -43,5 +46,11 @@ module Axlsx
       str << '/>'
     end
 
+    private
+    def validate_options(options)
+      (options[:Extension] || options[:extension]) && (options[:content_type] || options[:ContentType])
+    end
+
   end
+
 end

data/lib/axlsx/content_type/override.rb

@@ -1,8 +1,23 @@
 # encoding: UTF-8
 module Axlsx
+
   # An override content part. These parts are automatically created by for you based on the content of your package.
   class Override
 
+    #Creates a new Override object
+    # @option options [String] PartName
+    # @option options [String] ContentType
+    # @raise [ArgumentError] An argument error is raised if both PartName and ContentType are not specified.
+    def initialize(options={})
+      raise ArgumentError, INVALID_ARGUMENTS unless validate_options(options)
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
+      end
+    end
+
+    # Error message for invalid options
+    INVALID_ARGUMENTS = 'part_name and content_type are required'
+
     # The type of content.
     # @return [String]
     attr_reader :content_type
@@ -13,17 +28,6 @@ module Axlsx
     attr_reader :part_name
     alias :PartName :part_name
 
-    #Creates a new Override object
-    # @option options [String] PartName
-    # @option options [String] ContentType
-    # @raise [ArgumentError] An argument error is raised if both PartName and ContentType are not specified.
-    def initialize(options={})
-      raise ArgumentError, "PartName and ContentType are required" unless (options[:PartName] || options[:part_name]) && (options[:ContentType] || options[:content_type])
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # The name and location of the part.
     def part_name=(v) Axlsx::validate_string v; @part_name = v end
     alias :PartName= :part_name=
@@ -42,5 +46,12 @@ module Axlsx
       str << '/>'
     end
 
+    private 
+
+    def validate_options(options)
+      (options[:PartName] || options[:part_name]) && (options[:ContentType] || options[:content_type])
+    end
+
   end
+
 end

data/lib/axlsx/doc_props/app.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 module Axlsx
+
   # App represents the app.xml document. The attributes for this object are primarily managed by the application the end user uses to edit the document. None of the attributes are required to serialize a valid xlsx object.
   # @see shared-documentPropertiesExtended.xsd
   # @note Support is not implemented for the following complex types:
@@ -10,6 +11,35 @@ module Axlsx
   #    DigSig (DigSigBlob)
   class App
 
+    # Creates an App object
+    # @option options [String] template
+    # @option options [String] manager
+    # @option options [Integer] pages
+    # @option options [Integer] words
+    # @option options [Integer] characters
+    # @option options [String] presentation_format
+    # @option options [Integer] lines
+    # @option options [Integer] paragraphs
+    # @option options [Integer] slides
+    # @option options [Integer] notes
+    # @option options [Integer] total_time
+    # @option options [Integer] hidden_slides
+    # @option options [Integer] m_m_clips
+    # @option options [Boolean] scale_crop
+    # @option options [Boolean] links_up_to_date
+    # @option options [Integer] characters_with_spaces
+    # @option options [Boolean] share_doc
+    # @option options [String] hyperlink_base
+    # @option options [String] hyperlinks_changed
+    # @option options [String] application
+    # @option options [String] app_version
+    # @option options [Integer] doc_security
+    def initialize(options={})
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
+      end
+    end
+
     # @return [String] The name of the document template.
     attr_reader :template
     alias :Template :template
@@ -89,7 +119,7 @@ module Axlsx
     # @return [Boolean] Indicates that the hyper links in the document have been changed.
     attr_reader :hyperlinks_changed
     alias :HyperlinksChanged :hyperlinks_changed
-    
+
     # @return [String] The name of the application
     attr_reader :application
     alias :Applicatoin :application
@@ -102,44 +132,17 @@ module Axlsx
     attr_reader :doc_security
     alias :DocSecurity :doc_security
 
-    # Creates an App object
-    # @option options [String] template
-    # @option options [String] manager
-    # @option options [Integer] pages
-    # @option options [Integer] words
-    # @option options [Integer] characters
-    # @option options [String] presentation_format
-    # @option options [Integer] lines
-    # @option options [Integer] paragraphs
-    # @option options [Integer] slides
-    # @option options [Integer] notes
-    # @option options [Integer] total_time
-    # @option options [Integer] hidden_slides
-    # @option options [Integer] m_m_clips
-    # @option options [Boolean] scale_crop
-    # @option options [Boolean] links_up_to_date
-    # @option options [Integer] characters_with_spaces
-    # @option options [Boolean] share_doc
-    # @option options [String] hyperlink_base
-    # @option options [String] hyperlinks_changed
-    # @option options [String] application
-    # @option options [String] app_version
-    # @option options [Integer] doc_security
-    def initialize(options={})
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-    end
-
     # Sets the template property of your app.xml file
     def template=(v) Axlsx::validate_string v; @template = v; end
+    alias :Template :template
 
     # Sets the manager property of your app.xml file
     def manager=(v) Axlsx::validate_string v; @manager = v; end
+    alias :Manager :manager
 
     # Sets the company property of your app.xml file
     def company=(v) Axlsx::validate_string v; @company = v; end
-
+    alias :Company :company
     # Sets the pages property of your app.xml file
     def pages=(v) Axlsx::validate_int v; @pages = v; end
 
@@ -214,7 +217,7 @@ module Axlsx
     # Sets the doc_security property of your app.xml file
     def doc_security=(v) Axlsx::validate_int v; @doc_security = v; end
     alias :DocSecurity= :doc_security=
-     
+
     # Serialize the app.xml document
     # @return [String]
     def to_xml_string(str = '')
@@ -225,4 +228,5 @@ module Axlsx
     end
 
   end
+
 end

data/lib/axlsx/doc_props/core.rb

@@ -1,19 +1,21 @@
 # encoding: UTF-8
 module Axlsx
+
   # The core object for the package.
   # @note Packages manage their own core object.
   # @see Package#core
   class Core
-    # The author of the document. By default this is 'axlsx'
-    # @return [String]
-    attr_accessor :creator
-
+ 
     # Creates a new Core object.
     # @option options [String] creator
     def initialize(options={})
       @creator = options[:creator] || 'axlsx'
     end
 
+    # The author of the document. By default this is 'axlsx'
+    # @return [String]
+    attr_accessor :creator
+
     # serializes the core.xml document
     # @return [String]
     def to_xml_string(str = '')
@@ -22,9 +24,11 @@ module Axlsx
       str << 'xmlns:dcmitype="' << CORE_NS_DCMIT << '" xmlns:dcterms="' << CORE_NS_DCT << '" '
       str << 'xmlns:xsi="' << CORE_NS_XSI << '">'
       str << '<dc:creator>' << self.creator << '</dc:creator>'
-      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << Time.now.strftime('%Y-%m-%dT%H:%M:%S') << '</dcterms:created>'
+      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << Time.now.strftime('%Y-%m-%dT%H:%M:%S') << 'Z</dcterms:created>'
       str << '<cp:revision>0</cp:revision>'
       str << '</cp:coreProperties>'
     end
+
   end
+
 end

data/lib/axlsx/drawing/ax_data_source.rb

@@ -1,14 +1,9 @@
 module Axlsx
+
   # An axis data source that can contain referenced or literal strings or numbers
   # @note only string data types are supported - mainly because we have not implemented a chart type that requires a numerical axis value
   class AxDataSource < NumDataSource
 
-    # allowed element tag names
-    # @return [Array]
-    def self.allowed_tag_names
-      [:xVal, :cat]
-    end
-
     # creates a new NumDataSource object
     # @option options [Array] data An array of Cells or Numeric objects
     # @option options [Symbol] tag_name see tag_name
@@ -19,6 +14,12 @@ module Axlsx
       super(options)
     end
 
+    # allowed element tag names for serialization
+    # @return [Array]
+    def self.allowed_tag_names
+      [:xVal, :cat]
+    end
+
   end
 
 end

data/lib/axlsx/drawing/axis.rb

@@ -1,8 +1,40 @@
 # encoding: UTF-8
 module Axlsx
- # the access class defines common properties and values for a chart axis.
+
+  # the access class defines common properties and values for a chart axis.
   class Axis
 
+    # Creates an Axis object
+    # @param [Integer] ax_id the id of this axis
+    # @param [Integer] cross_ax the id of the perpendicular axis
+    # @option options [Symbol] ax_pos
+    # @option options [Symbol] crosses
+    # @option options [Symbol] tick_lbl_pos
+    # @raise [ArgumentError] If axi_id or cross_ax are not unsigned integers
+    def initialize(ax_id, cross_ax, options={})
+      Axlsx::validate_unsigned_int(ax_id)
+      Axlsx::validate_unsigned_int(cross_ax)
+      @ax_id = ax_id
+      @cross_ax = cross_ax
+      @format_code = "General"
+      @delete = @label_rotation = 0
+      @scaling = Scaling.new(:orientation=>:minMax)
+      @title = @color = nil
+      self.ax_pos = :b
+      self.tick_lbl_pos = :nextTo
+      self.format_code = "General"
+      self.crosses = :autoZero
+      self.gridlines = true
+      options.each do |name, value|
+        self.send("#{name}=", value) if self.respond_to? "#{name}="
+      end
+    end
+
+    # the fill color to use in the axis shape properties. This should be a 6 character long hex string
+    # e.g. FF0000 for red
+    # @return [String]
+    attr_reader :color
+
     # the id of the axis.
     # @return [Integer]
     attr_reader :ax_id
@@ -55,30 +87,12 @@ module Axlsx
     # the title for the axis. This can be a cell or a fixed string.
     attr_reader :title
 
-    # Creates an Axis object
-    # @param [Integer] ax_id the id of this axis
-    # @param [Integer] cross_ax the id of the perpendicular axis
-    # @option options [Symbol] ax_pos
-    # @option options [Symbol] crosses
-    # @option options [Symbol] tick_lbl_pos
-    # @raise [ArgumentError] If axi_id or cross_ax are not unsigned integers
-    def initialize(ax_id, cross_ax, options={})
-      Axlsx::validate_unsigned_int(ax_id)
-      Axlsx::validate_unsigned_int(cross_ax)
-      @ax_id = ax_id
-      @cross_ax = cross_ax
-      @format_code = "General"
-      @delete = @label_rotation = 0
-      @scaling = Scaling.new(:orientation=>:minMax)
-      @title = nil
-      self.ax_pos = :b
-      self.tick_lbl_pos = :nextTo
-      self.format_code = "General"
-      self.crosses = :autoZero
-      self.gridlines = true
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+    # The color for this axis. This value is used when rendering the axis line in the chart. 
+    # colors should be in 6 character rbg format
+    # @return [String] the rbg color assinged.
+    # @see color
+    def color=(color_rgb)
+      @color = color_rgb
     end
 
     # The position of the axis
@@ -99,7 +113,6 @@ module Axlsx
     # default true
     def gridlines=(v) Axlsx::validate_boolean(v); @gridlines = v; end
 
-
     # Specify if axis should be removed from the chart
     # default false
     def delete=(v) Axlsx::validate_boolean(v); @delete = v; end
@@ -117,7 +130,6 @@ module Axlsx
       @label_rotation = adjusted
     end
 
-    
     # The title object for the chart.
     # @param [String, Cell] v
     # @return [Title]
@@ -140,6 +152,7 @@ module Axlsx
       str << '<c:delete val="'<< @delete.to_s << '"/>'
       str << '<c:axPos val="' << @ax_pos.to_s << '"/>'
       str << '<c:majorGridlines>'
+      # TODO shape properties need to be extracted into a class
       if gridlines == false
         str << '<c:spPr>'
         str << '<a:ln>'
@@ -153,6 +166,13 @@ module Axlsx
       str << '<c:majorTickMark val="none"/>'
       str << '<c:minorTickMark val="none"/>'
       str << '<c:tickLblPos val="' << @tick_lbl_pos.to_s << '"/>'
+      # TODO - this is also being used for series colors
+      # time to extract this into a class spPr - Shape Properties
+      if @color
+        str << '<c:spPr><a:ln><a:solidFill>'
+        str << '<a:srgbClr val="' << @color << '"/>'
+        str << '</a:solidFill></a:ln></c:spPr>'
+      end
       # some potential value in implementing this in full. Very detailed!
       str << '<c:txPr><a:bodyPr rot="' << @label_rotation.to_s << '"/><a:lstStyle/><a:p><a:pPr><a:defRPr/></a:pPr><a:endParaRPr/></a:p></c:txPr>'
       str << '<c:crossAx val="' << @cross_ax.to_s << '"/>'
@@ -160,4 +180,5 @@ module Axlsx
     end
 
   end
+
 end

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -10,24 +10,29 @@ module Axlsx
 
     # the category axis
     # @return [CatAxis]
-    attr_reader :catAxis
+    attr_reader :cat_axis
+    alias :catAxis :cat_axis
 
-    # the valueaxis
+    # the value axis
     # @return [ValAxis]
-    attr_reader :valAxis
+    attr_reader :val_axis
+    alias :valAxis :val_axis
 
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
     # @return [Symbol]
-    attr_reader :barDir
+    attr_reader :bar_dir
+    alias :barDir :bar_dir
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_reader :gapDepth
+    attr_reader :gap_depth
+    alias :gapDepth :gap_depth
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_reader :gapWidth
+    attr_reader :gap_width 
+    alias :gapWidth :gap_width
 
     #grouping for a column, line, or area chart.
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
@@ -46,38 +51,42 @@ module Axlsx
     # @param [GraphicFrame] frame The workbook that owns this chart.
     # @option options [Cell, String] title
     # @option options [Boolean] show_legend
-    # @option options [Symbol] barDir
+    # @option options [Symbol] bar_dir
     # @option options [Symbol] grouping
-    # @option options [String] gapWidth
-    # @option options [String] gapDepth
+    # @option options [String] gap_width
+    # @option options [String] gap_depth
     # @option options [Symbol] shape
-    # @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
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
-      @barDir = :bar
+      @bar_dir = :bar
       @grouping = :clustered
-      @gapWidth, @gapDepth, @shape = nil, nil, nil
-      @catAxId = rand(8 ** 8)
-      @valAxId = rand(8 ** 8)
-      @catAxis = CatAxis.new(@catAxId, @valAxId)
-      @valAxis = ValAxis.new(@valAxId, @catAxId, :tickLblPos => :low)
+      @shape = :box
+      @gap_width = 150
+      @gap_width, @gap_depth, @shape = nil, nil, nil
+      @cat_ax_id = rand(8 ** 8)
+      @val_ax_id = rand(8 ** 8)
+      @cat_axis = CatAxis.new(@cat_ax_id, @val_ax_id)
+      @val_axis = ValAxis.new(@val_ax_id, @cat_ax_id, :tick_lbl_pos => :low, :ax_pos => :l)
       super(frame, options)
       @series_type = BarSeries
-      @view3D = View3D.new({:rAngAx=>1}.merge(options))
+      @view_3D = View3D.new({:r_ang_ax=>1}.merge(options))
+      @d_lbls = nil
     end
 
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
-    def barDir=(v)
-      RestrictionValidator.validate "Bar3DChart.barDir", [:bar, :col], v
-      @barDir = v
+    def bar_dir=(v)
+      RestrictionValidator.validate "Bar3DChart.bar_dir", [:bar, :col], v
+      @bar_dir = v
     end
+    alias :barDir= :bar_dir=
 
     #grouping for a column, line, or area chart.
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
@@ -87,16 +96,18 @@ module Axlsx
     end
 
     # space between bar or column clusters, as a percentage of the bar or column width.
-    def gapWidth=(v)
-      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
-      @gapWidth=(v)
+    def gap_width=(v)
+      RegexValidator.validate "Bar3DChart.gap_width", GAP_AMOUNT_PERCENT, v
+      @gap_width=(v)
     end
+    alias :gapWidth= :gap_width=
 
     # space between bar or column clusters, as a percentage of the bar or column width.
-    def gapDepth=(v)
-      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
-      @gapDepth=(v)
+    def gap_depth=(v)
+      RegexValidator.validate "Bar3DChart.gap_didth", GAP_AMOUNT_PERCENT, v
+      @gap_depth=(v)
     end
+    alias :gapDepth= :gap_depth=
 
     # The shabe of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
@@ -111,27 +122,20 @@ module Axlsx
     def to_xml_string(str = '')
       super(str) do |str_inner|
         str_inner << '<c:bar3DChart>'
-        str_inner << '<c:barDir val="' << barDir.to_s << '"/>'
+        str_inner << '<c:barDir val="' << bar_dir.to_s << '"/>'
         str_inner << '<c:grouping val="' << grouping.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>'
-        str_inner << '<c:gapWidth val="' << @gapWidth.to_s << '"/>' unless @gapWidth.nil?
-        str_inner << '<c:gapDepth val="' << @gapDepth.to_s << '"/>' unless @gapDepth.nil?
+        @d_lbls.to_xml_string(str) if @d_lbls
+        str_inner << '<c:gapWidth val="' << @gap_width.to_s << '"/>' unless @gap_width.nil?
+        str_inner << '<c:gapDepth val="' << @gap_depth.to_s << '"/>' unless @gap_depth.nil?
         str_inner << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
-        str_inner << '<c:axId val="' << @catAxId.to_s << '"/>'
-        str_inner << '<c:axId val="' << @valAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @cat_ax_id.to_s << '"/>'
+        str_inner << '<c:axId val="' << @val_ax_id.to_s << '"/>'
         str_inner << '<c:axId val="0"/>'
         str_inner << '</c:bar3DChart>'
-        @catAxis.to_xml_string str_inner
-        @valAxis.to_xml_string str_inner
+        @cat_axis.to_xml_string str_inner
+        @val_axis.to_xml_string str_inner
       end
     end
   end

data/lib/axlsx/drawing/bar_series.rb

@@ -64,6 +64,7 @@ module Axlsx
 
         @labels.to_xml_string(str_inner) unless @labels.nil?
         @data.to_xml_string(str_inner) unless @data.nil?
+        # this is actually only required for shapes other than box 
         str_inner << '<c:shape val="' << shape.to_s << '"></c:shape>'
       end
     end