axlsx 1.1.4 → 1.2.0

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,166 +11,222 @@ 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
+    attr_reader :template
+    alias :Template :template
 
     # @return [String] The name of the manager for the document.
-    attr_reader :Manager
+    attr_reader :manager
+    alias :Manager :manager
 
     # @return [String] The name of the company generating the document.
-    attr_reader :Company
+    attr_reader :company
+    alias :Company :company
 
     # @return [Integer] The number of pages in the document.
-    attr_reader :Pages
+    attr_reader :pages
+    alias :Pages :pages
 
     # @return [Integer] The number of words in the document.
-    attr_reader :Words
+    attr_reader :words
+    alias :Words :words
 
     # @return [Integer] The number of characters in the document.
-    attr_reader :Characters
+    attr_reader :characters
+    alias :Characters :characters
 
     # @return [String] The intended format of the presentation.
-    attr_reader :PresentationFormat
+    attr_reader :presentation_format
+    alias :PresentationFormat :presentation_format
 
     # @return [Integer] The number of lines in the document.
-    attr_reader :Lines
+    attr_reader :lines
+    alias :Lines :lines
 
     # @return [Integer] The number of paragraphs in the document
-    attr_reader :Paragraphs
+    attr_reader :paragraphs
+    alias :Paragraphs :paragraphs
 
     # @return [Intger] The number of slides in the document.
-    attr_reader :Slides
+    attr_reader :slides
+    alias :Slides :slides
 
     # @return [Integer] The number of slides that have notes.
-    attr_reader :Notes
+    attr_reader :notes
+    alias :Notes :notes
 
     # @return [Integer] The total amount of time spent editing.
-    attr_reader :TotalTime
+    attr_reader :total_time
+    alias :TotalTime :total_time
 
     # @return [Integer] The number of hidden slides.
-    attr_reader :HiddenSlides
+    attr_reader :hidden_slides
+    alias :HiddenSlides :hidden_slides
 
     # @return [Integer] The total number multimedia clips
-    attr_reader :MMClips
+    attr_reader :m_m_clips
+    alias :MMClips :m_m_clips
 
     # @return [Boolean] The display mode for the document thumbnail.
-    attr_reader :ScaleCrop
+    attr_reader :scale_crop
+    alias :ScaleCrop :scale_crop
 
     # @return [Boolean] The links in the document are up to date.
-    attr_reader :LinksUpToDate
+    attr_reader :links_up_to_date
+    alias :LinksUpToDate :links_up_to_date
 
     # @return [Integer] The number of characters in the document including spaces.
-    attr_reader :CharactersWithSpaces
+    attr_reader :characters_with_spaces
+    alias :CharactersWithSpaces :characters_with_spaces
 
     # @return [Boolean] Indicates if the document is shared.
-    attr_reader :ShareDoc
+    attr_reader :shared_doc
+    alias :SharedDoc :shared_doc
 
     # @return [String] The base for hyper links in the document.
-    attr_reader :HyperLinkBase
+    attr_reader :hyperlink_base
+    alias :HyperlinkBase :hyperlink_base
 
     # @return [Boolean] Indicates that the hyper links in the document have been changed.
-    attr_reader :HyperlinksChanged
+    attr_reader :hyperlinks_changed
+    alias :HyperlinksChanged :hyperlinks_changed
 
     # @return [String] The name of the application
-    attr_reader :Application
+    attr_reader :application
+    alias :Applicatoin :application
 
     # @return [String] The version of the application.
-    attr_reader :AppVersion
+    attr_reader :app_version
+    alias :AppVersion :app_version
 
     # @return [Integer] Document security
-    attr_reader :DocSecurity
+    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] PresentationFormat
-    # @option options [Integer] Lines
-    # @option options [Integer] Paragraphs
-    # @option options [Integer] Slides
-    # @option options [Integer] Notes
-    # @option options [Integer] TotalTime
-    # @option options [Integer] HiddenSlides
-    # @option options [Integer] MMClips
-    # @option options [Boolean] ScaleCrop
-    # @option options [Boolean] LinksUpToDate
-    # @option options [Integer] CharactersWithSpaces
-    # @option options [Boolean] ShareDoc
-    # @option options [String] HyperLinkBase
-    # @option options [String] HyperlinksChanged
-    # @option options [String] Application
-    # @option options [String] AppVersion
-    # @option options [Integer] DocSecurity
-    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
+
+    # Sets the words property of your app.xml file
+    def words=(v) Axlsx::validate_int v; @words = v; end
+    alias :Words= :words=
+
+    # Sets the characters property of your app.xml file
+    def characters=(v) Axlsx::validate_int v; @characters = v; end
+    alias :Characters= :characters=
+
+    # Sets the presentation_format property of your app.xml file
+    def presentation_format=(v) Axlsx::validate_string v; @presentation_format = v; end
+    alias :PresentationFormat= :presentation_format=
+
+    # Sets the lines property of your app.xml file
+    def lines=(v) Axlsx::validate_int v; @lines = v; end
+    alias :Lines= :lines=
+
+    # Sets the paragraphs property of your app.xml file
+    def paragraphs=(v) Axlsx::validate_int v; @paragraphs = v; end
+    alias :Paragraphs= :paragraphs=
+
+    # sets the slides property of your app.xml file
+    def slides=(v) Axlsx::validate_int v; @slides = v; end
+    alias :Slides= :slides=
+
+    # sets the notes property of your app.xml file
+    def notes=(v) Axlsx::validate_int v; @notes = v; end
+    alias :Notes= :notes=
+
+    # Sets the total_time property of your app.xml file
+    def total_time=(v) Axlsx::validate_int v; @total_time = v; end
+    alias :TotalTime= :total_time=
+
+    # Sets the hidden_slides property of your app.xml file
+    def hidden_slides=(v) Axlsx::validate_int v; @hidden_slides = v; end
+    alias :HiddenSlides= :hidden_slides=
+
+    # Sets the m_m_clips property of your app.xml file
+    def m_m_clips=(v) Axlsx::validate_int v; @m_m_clips = v; end
+    alias :MMClips= :m_m_clips=
+
+    # Sets the scale_crop property of your app.xml file
+    def scale_crop=(v) Axlsx::validate_boolean v; @scale_crop = v; end
+    alias :ScaleCrop= :scale_crop=
+
+    # Sets the links_up_to_date property of your app.xml file
+    def links_up_to_date=(v) Axlsx::validate_boolean v; @links_up_to_date = v; end
+    alias :LinksUpToDate= :links_up_to_date=
+
+    # Sets the characters_with_spaces property of your app.xml file
+    def characters_with_spaces=(v) Axlsx::validate_int v; @characters_with_spaces = v; end
+    alias :CharactersWithSpaces= :characters_with_spaces=
+
+    # Sets the share_doc property of your app.xml file
+    def shared_doc=(v) Axlsx::validate_boolean v; @shared_doc = v; end
+    alias :SharedDoc= :shared_doc=
+
+    # Sets the hyperlink_base property of your app.xml file
+    def hyperlink_base=(v) Axlsx::validate_string v; @hyperlink_base = v; end
+    alias :HyperlinkBase= :hyperlink_base=
 
-    # Sets the Template property of your app.xml file
-    def Template=(v) Axlsx::validate_string v; @Template = v; end
-
-    # Sets the Manager property of your app.xml file
-    def Manager=(v) Axlsx::validate_string v; @Manager = v; end
-
-    # Sets the Company property of your app.xml file
-    def Company=(v) Axlsx::validate_string v; @Company = v; end
-
-    # Sets the Pages property of your app.xml file
-    def Pages=(v) Axlsx::validate_int v; @Pages = v; end
-
-    # Sets the Words property of your app.xml file
-    def Words=(v) Axlsx::validate_int v; @Words = v; end
-
-    # Sets the Characters property of your app.xml file
-    def Characters=(v) Axlsx::validate_int v; @Characters = v; end
-
-
-    # Sets the PresentationFormat property of your app.xml file
-    def PresentationFormat=(v) Axlsx::validate_string v; @PresentationFormat = v; end
-    # Sets the Lines property of your app.xml file
-    def Lines=(v) Axlsx::validate_int v; @Lines = v; end
-    # Sets the Paragraphs property of your app.xml file
-    def Paragraphs=(v) Axlsx::validate_int v; @Paragraphs = v; end
-    # Sets the Slides property of your app.xml file
-    def Slides=(v) Axlsx::validate_int v; @Slides = v; end
-    # Sets the Notes property of your app.xml file
-    def Notes=(v) Axlsx::validate_int v; @Notes = v; end
-    # Sets the TotalTime property of your app.xml file
-    def TotalTime=(v) Axlsx::validate_int v; @TotalTime = v; end
-    # Sets the HiddenSlides property of your app.xml file
-    def HiddenSlides=(v) Axlsx::validate_int v; @HiddenSlides = v; end
-    # Sets the MMClips property of your app.xml file
-    def MMClips=(v) Axlsx::validate_int v; @MMClips = v; end
-    # Sets the ScaleCrop property of your app.xml file
-    def ScaleCrop=(v) Axlsx::validate_boolean v; @ScaleCrop = v; end
-    # Sets the LinksUpToDate property of your app.xml file
-    def LinksUpToDate=(v) Axlsx::validate_boolean v; @LinksUpToDate = v; end
-    # Sets the CharactersWithSpaces property of your app.xml file
-    def CharactersWithSpaces=(v) Axlsx::validate_int v; @CharactersWithSpaces = v; end
-    # Sets the ShareDoc property of your app.xml file
-    def ShareDoc=(v) Axlsx::validate_boolean v; @ShareDoc = v; end
-    # Sets the HyperLinkBase property of your app.xml file
-    def HyperLinkBase=(v) Axlsx::validate_string v; @HyperLinkBase = v; end
     # Sets the HyperLinksChanged property of your app.xml file
-    def HyperlinksChanged=(v) Axlsx::validate_boolean v; @HyperlinksChanged = v; end
-    # Sets the Application property of your app.xml file
-    def Application=(v) Axlsx::validate_string v; @Application = v; end
-    # Sets the AppVersion property of your app.xml file
-    def AppVersion=(v) Axlsx::validate_string v; @AppVersion = v; end
-    # Sets the DocSecurity property of your app.xml file
-    def DocSecurity=(v) Axlsx::validate_int v; @DocSecurity = v; end
+    def hyperlinks_changed=(v) Axlsx::validate_boolean v; @hyperlinks_changed = v; end
+    alias :HyperLinksChanged= :hyperlinks_changed=
+
+    # Sets the app_version property of your app.xml file
+    def app_version=(v) Axlsx::validate_string v; @app_version = v; end
+    alias :AppVersion= :app_version=
+
+    # 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 = '')
       str << '<?xml version="1.0" encoding="UTF-8"?>'
       str << '<Properties xmlns="' << APP_NS << '" xmlns:vt="' << APP_NS_VT << '">'
-      str << instance_values.map { |key, value| '<' << key.to_s << '>' << value.to_s << '</' << key.to_s << '>' }.join
+      str << instance_values.map { |key, value| '<' << Axlsx.camel(key) << '>' << value.to_s << '</' << Axlsx.camel(key) << '>' }.join
       str << '</Properties>'
     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,15 +1,49 @@
 # 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 :axId
+    attr_reader :ax_id
+    alias :axID :ax_id
 
     # The perpendicular axis
     # @return [Integer]
-    attr_reader :crossAx
+    attr_reader :cross_ax
+    alias :crossAx :cross_ax
 
     # The scaling of the axis
     # @see Scaling
@@ -19,12 +53,14 @@ module Axlsx
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
     # @return [Symbol]
-    attr_reader :axPos
+    attr_reader :ax_pos
+    alias :axPos :ax_pos
 
     # the position of the tick labels
     # must be one of [:nextTo, :high, :low]
     # @return [Symbol]
-    attr_reader :tickLblPos
+    attr_reader :tick_lbl_pos
+    alias :tickLblPos :tick_lbl_pos
 
     # The number format format code for this axis
     # default :General
@@ -48,37 +84,26 @@ module Axlsx
     # @return [Boolean]
     attr_reader :delete
 
-    # Creates an Axis object
-    # @param [Integer] axId the id of this axis
-    # @param [Integer] crossAx the id of the perpendicular axis
-    # @option options [Symbol] axPos
-    # @option options [Symbol] crosses
-    # @option options [Symbol] tickLblPos
-    # @raise [ArgumentError] If axId or crossAx are not unsigned integers
-    def initialize(axId, crossAx, options={})
-      Axlsx::validate_unsigned_int(axId)
-      Axlsx::validate_unsigned_int(crossAx)
-      @axId = axId
-      @crossAx = crossAx
-      @format_code = "General"
-      @delete = @label_rotation = 0
-      @scaling = Scaling.new(:orientation=>:minMax)
-      self.axPos = :b
-      self.tickLblPos = :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 title for the axis. This can be a cell or a fixed string.
+    attr_reader :title
+
+    # 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
     # must be one of [:l, :r, :t, :b]
-    def axPos=(v) RestrictionValidator.validate "#{self.class}.axPos", [:l, :r, :b, :t], v; @axPos = v; end
+    def ax_pos=(v) RestrictionValidator.validate "#{self.class}.ax_pos", [:l, :r, :b, :t], v; @ax_pos = v; end
+    alias :axPos= :ax_pos=
 
     # the position of the tick labels
     # must be one of [:nextTo, :high, :low1]
-    def tickLblPos=(v) RestrictionValidator.validate "#{self.class}.tickLblPos", [:nextTo, :high, :low], v; @tickLblPos = v; end
+    def tick_lbl_pos=(v) RestrictionValidator.validate "#{self.class}.tick_lbl_pos", [:nextTo, :high, :low], v; @tick_lbl_pos = v; end
+    alias :tickLblPos= :tick_lbl_pos=
 
     # The number format format code for this axis
     # default :General
@@ -88,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
@@ -106,17 +130,30 @@ module Axlsx
       @label_rotation = adjusted
     end
 
+    # The title object for the chart.
+    # @param [String, Cell] v
+    # @return [Title]
+    def title=(v)
+      DataTypeValidator.validate "#{self.class}.title", [String, Cell], v
+      @title ||= Title.new
+      if v.is_a?(String)
+        @title.text = v
+      elsif v.is_a?(Cell)
+        @title.cell = v
+      end
+    end
 
     # Serializes the object
     # @param [String] str
     # @return [String]
     def to_xml_string(str = '')
-      str << '<c:axId val="' << @axId.to_s << '"/>'
+      str << '<c:axId val="' << @ax_id.to_s << '"/>'
       @scaling.to_xml_string str
       str << '<c:delete val="'<< @delete.to_s << '"/>'
-      str << '<c:axPos val="' << @axPos.to_s << '"/>'
+      str << '<c:axPos val="' << @ax_pos.to_s << '"/>'
       str << '<c:majorGridlines>'
-      if self.gridlines == false
+      # TODO shape properties need to be extracted into a class
+      if gridlines == false
         str << '<c:spPr>'
         str << '<a:ln>'
         str << '<a:noFill/>'
@@ -124,15 +161,24 @@ module Axlsx
         str << '</c:spPr>'
       end
       str << '</c:majorGridlines>'
+      @title.to_xml_string(str) unless @title == nil
       str << '<c:numFmt formatCode="' << @format_code << '" sourceLinked="1"/>'
       str << '<c:majorTickMark val="none"/>'
       str << '<c:minorTickMark val="none"/>'
-      str << '<c:tickLblPos val="' << @tickLblPos.to_s << '"/>'
+      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="' << @crossAx.to_s << '"/>'
+      str << '<c:crossAx val="' << @cross_ax.to_s << '"/>'
       str << '<c:crosses val="' << @crosses.to_s << '"/>'
     end
 
   end
+
 end