axlsx 1.0.0

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+
+# gems not loading? try this
+#RUBYOPT="rubygems"
+#export RUBYOPT
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/tc_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/axlsx.rb

@@ -0,0 +1,38 @@
+require 'axlsx/util/simple_typed_list.rb'
+require 'axlsx/util/constants.rb'
+require 'axlsx/util/validators.rb'
+require 'axlsx/stylesheet/styles.rb'
+
+require 'axlsx/doc_props/app.rb'
+require 'axlsx/doc_props/core.rb'
+require 'axlsx/content_type/content_type.rb'
+require 'axlsx/rels/relationships.rb'
+
+require 'axlsx/drawing/drawing.rb'
+require 'axlsx/workbook/workbook.rb'
+require 'axlsx/package.rb'
+
+
+module Axlsx
+
+  #required gems
+  require 'Nokogiri'
+  require 'active_support/core_ext/object/instance_variables'
+  require 'active_support/inflector'
+  require 'rmagick'
+  require 'zip/zip'
+
+  #core dependencies
+  require 'bigdecimal'
+  require 'time'
+  require 'CGI'
+
+  # determines the cell range for the items provided
+  def self.cell_range(items)
+    return "" unless items.first.is_a? Cell          
+    "#{items.first.row.worksheet.name}!" +
+      "#{items.first.r_abs}:#{items.last.r_abs}"
+  end
+  
+  
+end

data/lib/axlsx/content_type/content_type.rb

@@ -0,0 +1,23 @@
+module Axlsx
+  require 'axlsx/content_type/default.rb'
+  require 'axlsx/content_type/override.rb'
+
+  # ContentTypes used in the package. This is automatcially managed by the package package.
+  class ContentType < SimpleTypedList
+    
+    def initialize
+      super [Override, Default]
+    end
+    
+    # Generates the xml document for [Content_Types].xml
+    # @return [String] The document as a string.
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.Types(:xmlns => Axlsx::XML_NS_T) {
+          each { |type| type.to_xml(xml) }
+        }
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/axlsx/content_type/default.rb

@@ -0,0 +1,32 @@
+module Axlsx
+  # An default content part. These parts are automatically created by for you based on the content of your package.
+  class Default
+
+    # The extension of the content type.
+    # @return [String]
+    attr_accessor :Extension
+
+    # @return [String] ContentType The type of content. 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
+    attr_accessor :ContentType
+
+    #Creates a new Default object
+    # @option options [String] Extension
+    # @option options [String] ContentType
+    # @raise [ArgumentError] An argument error is raised if both Extension and ContentType are not specified.
+    def initialize(options={})
+      raise ArgumentError, "Extension and ContentType are required" unless options[:Extension] && options[:ContentType]
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end      
+    end
+    def Extension=(v) Axlsx::validate_string v; @Extension = v end
+    def ContentType=(v) Axlsx::validate_content_type v; @ContentType = v end
+
+    # Serializes the object to xml
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.Default(self.instance_values)
+    end
+  end
+end

data/lib/axlsx/content_type/override.rb

@@ -0,0 +1,30 @@
+module Axlsx
+  # An override content part. These parts are automatically created by for you based on the content of your package.
+  class Override
+
+    # @return [String] ContentType The type of content. 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
+    attr_accessor :ContentType
+
+    # @return [String] PartName The name and location of the part.
+    attr_accessor :PartName
+
+    #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[:ContentType]
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end      
+    end
+    def PartName=(v) Axlsx::validate_string v; @PartName = v end
+    def ContentType=(v) Axlsx::validate_content_type v; @ContentType = v end
+
+    # Serializes the Override object to xml
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    def to_xml(xml)
+      xml.Override(self.instance_values)
+    end
+  end
+end

data/lib/axlsx/doc_props/app.rb

@@ -0,0 +1,148 @@
+# -*- coding: 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:
+  #
+  #    HeadingPairs (VectorVariant),
+  #    TitlesOfParts (VectorLpstr),
+  #    HLinks (VectorVariant),
+  #    DigSig (DigSigBlob)
+  class App
+
+    # @return [String] The name of the document template.
+    attr_accessor :Template
+
+    # @return [String] The name of the manager for the document.
+    attr_accessor :Manager
+
+    # @return [String] The name of the company generating the document.
+    attr_accessor :Company 
+
+    # @return [Integer] The number of pages in the document.
+    attr_accessor :Pages
+
+    # @return [Integer] The number of words in the document.
+    attr_accessor :Words
+
+    # @return [Integer] The number of characters in the document.
+    attr_accessor :Characters
+
+    # @return [String] The intended format of the presentation.
+    attr_accessor :PresentationFormat
+
+    # @return [Integer] The number of lines in the document.
+    attr_accessor :Lines
+
+    # @return [Integer] The number of paragraphs in the document
+    attr_accessor :Paragraphs
+
+    # @return [Intger] The number of slides in the document.
+    attr_accessor :Slides
+
+    # @return [Integer] The number of slides that have notes.
+    attr_accessor :Notes
+
+    # @return [Integer] The total amount of time spent editing.   
+    attr_accessor :TotalTime
+
+    # @return [Integer] The number of hidden slides.
+    attr_accessor :HiddenSlides
+
+    # @return [Integer] The total number multimedia clips
+    attr_accessor :MMClips
+
+    # @return [Boolean] The display mode for the document thumbnail.
+    attr_accessor :ScaleCrop
+
+    # @return [Boolean] The links in the document are up to date.
+    attr_accessor :LinksUpToDate
+
+    # @return [Integer] The number of characters in the document including spaces.
+    attr_accessor :CharactersWithSpaces
+    
+    # @return [Boolean] Indicates if the document is shared.
+    attr_accessor :ShareDoc
+
+    # @return [String] The base for hyper links in the document. 
+    attr_accessor :HyperLinkBase
+
+    # @return [Boolean] Indicates that the hyper links in the document have been changed.
+    attr_accessor :HyperlinksChanged
+
+    # @return [String] The name of the application
+    attr_accessor :Application
+
+    # @return [String] The version of the application.
+    attr_accessor :AppVersion
+
+    # @return [Integer] Document security
+    attr_accessor :DocSecurity
+
+    # 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 initalize(options={})
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+      end
+    end
+
+    def Template=(v) Axlsx::validate_string v; @Template = v; end 
+    def Manager=(v) Axlsx::validate_string v; @Manager = v; end 
+    def Company=(v) Axlsx::validate_string v; @Company = v; end 
+    def Pages=(v) Axlsx::validate_int v; @Pages = v; end 
+    def Words=(v) Axlsx::validate_int v; @Words = v; end 
+    def Characters=(v) Axlsx::validate_int v; @Characters = v; end 
+    def PresentationFormat=(v) Axlsx::validate_string v; @PresentationFormat = v; end 
+    def Lines=(v) Axlsx::validate_int v; @Lines = v; end 
+    def Paragraphs=(v) Axlsx::validate_int v; @Paragraphs = v; end 
+    def Slides=(v) Axlsx::validate_int v; @Slides = v; end 
+    def Notes=(v) Axlsx::validate_int v; @Notes = v; end 
+    def TotalTime=(v) Axlsx::validate_int v; @TotalTime = v; end 
+    def HiddenSlides=(v) Axlsx::validate_int v; @HiddenSlides = v; end 
+    def MMClips=(v) Axlsx::validate_int v; @MMClips = v; end 
+    def ScaleCrop=(v) Axlsx::validate_boolean v; @ScaleCrop = v; end 
+    def LinksUpToDate=(v) Axlsx::validate_boolean v; @LinksUpToDate = v; end 
+    def CharactersWithSpaces=(v) Axlsx::validate_int v; @CharactersWithSpaces = v; end 
+    def ShareDoc=(v) Axlsx::validate_boolean v; @ShareDoc = v; end 
+    def HyperLinkBase=(v) Axlsx::validate_string v; @HyperLinkBase = v; end 
+    def HyperlinksChanged=(v) Axlsx::validate_boolean v; @HyperlinksChanged = v; end 
+    def Application=(v) Axlsx::validate_string v; @Application = v; end 
+    def AppVersion=(v) Axlsx::validate_string v; @AppVersion = v; end 
+    def DocSecurity=(v) Axlsx::validate_int v; @DocSecurity = v; end 
+
+    # Generate an app.xml document
+    # @return [String] The document as a string
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.send(:Properties, :xmlns => APP_NS, :'xmlns:vt' => APP_NS_VT) {
+          self.instance_values.each do |name, value|
+            xml.send("ap:#{name}", value)
+          end
+        }
+      end      
+      builder.to_xml
+    end
+  end
+end

data/lib/axlsx/doc_props/core.rb

@@ -0,0 +1,34 @@
+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
+
+    # Serializes the core object. The created dcterms item is set to the current time when this method is called.
+    # @return [String]
+    def to_xml()
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.send('cp:coreProperties', 
+                 :"xmlns:cp" => CORE_NS, 
+                 :'xmlns:dc' => CORE_NS_DC, 
+                 :'xmlns:dcmitype'=>CORE_NS_DCMIT, 
+                 :'xmlns:dcterms'=>CORE_NS_DCT, 
+                 :'xmlns:xsi'=>CORE_NS_XSI) {
+          xml['dc'].creator self.creator
+          xml['dcterms'].created Time.now.strftime('%Y-%m-%dT%H:%M:%S'), :'xsi:type'=>"dcterms:W3CDTF"
+          xml['cp'].revision 0
+        }
+      end  
+      builder.to_xml
+    end
+  end
+end

data/lib/axlsx/drawing/axis.rb

@@ -0,0 +1,78 @@
+module Axlsx
+ # the access class defines common properties and values for chart axis
+  class Axis
+
+
+    # the id of the axis
+    # @return [Integer]
+    attr_reader :axId
+
+    # The perpendicular axis
+    # @return [Integer]
+    attr_reader :crossAx
+
+    # The scaling of the axis
+    # @return [Scaling]
+    attr_reader :scaling
+    
+    # The position of the axis
+    # must be one of [:l, :r, :t, :b]
+    # @return [Symbol]
+    attr_accessor :axPos
+
+    # the position of the tick labels
+    # must be one of [:nextTo, :high, :low]
+    # @return [Symbol]
+    attr_accessor :tickLblPos
+
+
+    # The number format format code for this axis
+    # @return [String]
+    attr_accessor :format_code
+
+    # specifies how the perpendicular axis is crossed
+    # must be one of [:autoZero, :min, :max]
+    # @return [Symbol]
+    attr_accessor :crosses 
+
+    # 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
+    def initialize(axId, crossAx, options={})
+      Axlsx::validate_unsigned_int(axId)
+      Axlsx::validate_unsigned_int(crossAx)
+      @axId = axId
+      @crossAx = crossAx
+      self.axPos = :l
+      self.tickLblPos = :nextTo
+      @scaling = Scaling.new(:orientation=>:minMax)
+      @formatCode = ""
+      self.crosses = :autoZero
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+
+    def axPos=(v) RestrictionValidator.validate "#{self.class}.axPos", [:l, :r, :b, :t], v; @axPos = v; end
+    def tickLblPos=(v) RestrictionValidator.validate "#{self.class}.tickLblPos", [:nextTo, :high, :low], v; @tickLblPos = v; end
+    def format_code=(v) Axlsx::validate_string(v); @formatCode = v; end
+    def crosses=(v) RestrictionValidator.validate "#{self.class}.crosses", [:autoZero, :min, :max], v; @crosses = v; end
+
+    # Serializes the common axis
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.send('c:axId', :val=>@axId)
+      @scaling.to_xml(xml)
+      xml.send('c:axPos', :val=>@axPos)
+      xml.send('c:majorGridlines')
+      xml.send('c:numFmt', :formatCode => @format_code, :sourceLinked=>"1")
+      xml.send('c:tickLblPos', :val=>@tickLblPos)
+      xml.send('c:crossAx', :val=>@crossAx)
+      xml.send('c:crosses', :val=>@crosses)
+    end    
+  end
+end

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -0,0 +1,138 @@
+module Axlsx
+
+  # The Bar3DChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates two charts in a single sheet.
+  #   # The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.
+  #
+  #   require "rubygems" # if that is your preferred way to manage gems!
+  #   require "axlsx"
+  #
+  #   p = Axlsx::Package.new
+  #   ws = p.workbook.add_worksheet
+  #   ws.add_row :values => ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::Bar3DChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
+  # 
+  #   ws.add_row :values => ["This chart uses the data below"]
+  #   title_row = ws.add_row :values => ["Least Popular Pets"]
+  #   label_row = ws.add_row :values => ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"]
+  #   data_row = ws.add_row :values => ["Votes", 6, 4, 1]
+  #   
+  #   chart = ws.add_chart(Axlsx::Pie3DChart, :start_at => [0,11], :end_at =>[0,16], :title => title_row.cells.last)
+  #   chart.add_series :data => data_row.cells[(1..-1)], :labels => label_row.cells  
+  #
+  #   f = File.open('example_pie_3d_chart.xlsx', 'w')
+  #   p.serialize(f)
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class Bar3DChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    attr_reader :catAxis
+
+    # the category axis
+    # @return [ValAxis]
+    attr_reader :valAxis
+
+    # The direction of the bars in the chart
+    # must be one of [:bar, :col]
+    # @return [Symbol]
+    attr_accessor :barDir
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_accessor :gapDepth
+
+    # space between bar or column clusters, as a percentage of the bar or column width.
+    # @return [String]
+    attr_accessor :gapWidth
+
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :grouping
+
+    # The shabe of the bars or columns
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :shape
+
+    # validation regex for gap amount percent
+    GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
+    
+    # Creates a new bar chart object
+    # @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] grouping
+    # @option options [String] gapWidth
+    # @option options [String] gapDepth
+    # @option options [Symbol] shape
+    def initialize(frame, options={})
+      super(frame, options)      
+      @series_type = BarSeries
+      @barDir = :bar
+      @grouping = :clustered
+      @catAxId = rand(8 ** 8)
+      @valAxId = rand(8 ** 8)
+      @catAxis = CatAxis.new(@catAxId, @valAxId)
+      @valAxis = ValAxis.new(@valAxId, @catAxId)
+      @view3D = View3D.new(:rAngAx=>1)
+    end
+    
+    def barDir=(v) 
+      RestrictionValidator.validate "Bar3DChart.barDir", [:bar, :col], v
+      @barDir = v
+    end
+
+
+    def grouping=(v)
+      RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
+      @grouping = v
+    end
+
+    def gapWidth=(v)
+      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gapWidth=(v)
+    end
+
+    def gapDepth=(v)
+      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gapDepth=(v)
+    end
+
+    def shape=(v) 
+      RestrictionValidator.validate "Bar3DChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+    
+    # Serializes the bar chart
+    # @return [String]
+    def to_xml
+      super() do |xml|
+        xml.send('c:bar3DChart') {
+          xml.send('c:barDir', :val => barDir)
+          xml.send('c:grouping', :val=>grouping)
+          xml.send('c:varyColors', :val=>1)
+          @series.each { |ser| ser.to_xml(xml) }
+          xml.send('c:gapWidth', :val=>@gapWidth) unless @gapWidth.nil?
+          xml.send('c:gapDepth', :val=>@gapDepth) unless @gapDepth.nil?
+          xml.send('c:shape', :val=>@shape) unless @shape.nil?
+          xml.send('c:axId', :val=>@catAxId)
+          xml.send('c:axId', :val=>@valAxId)
+          xml.send('c:axId', :val=>0)
+        }
+        @catAxis.to_xml(xml)
+        @valAxis.to_xml(xml)        
+      end
+    end    
+  end  
+end