axlsx 1.0.0 → 1.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Randy Morgan
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+Axlsx: Office Open XML Spreadsheet Generation
+====================================
+
+**IRC**:          [irc.freenode.net / #axlsx](irc://irc.freenode.net/axlsx)    
+**Git**:          [http://github.com/randym/axlsx](http://github.com/randym/axlsx)   
+**Author**:       Randy Morgan
+**Copyright**:    2011    
+**License**:      MIT License    
+**Latest Version**: 1.0.0
+**Release Date**: November 20th 2011    
+
+Synopsis
+--------
+
+Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language.
+It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features.
+
+Feature List
+------------
+                                                                              
+**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate profesional xlsx based reports that can be validated before serialiation.
+
+**2. Generate 3D Pie and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all.
+                                                                              
+**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.
+
+**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.
+
+Installing
+----------
+
+To install Axlsx, use the following command:
+
+    $ gem install axlsx
+    
+Usage
+-----
+
+Generating a workbook with styles and a chart:
+  p = Axlsx::Package.new do |package|
+    package.workbook.add_worksheet do |sheet|
+      sheet.add_row ["First", "Second", "Third"], :style => Axlsx::STYLE_THIN_BORDER
+      sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+      sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 1: Chart") do |chart|
+        chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
+      end
+    end
+    package.serialize("example1.xlsx")
+  end  
+
+
+### Documentation
+This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
+
+  yard server -g
+
+
+### Specs
+This gem has 100% test coverage. To execute tests for this gem, simply run rake in the gem directory.
+ 
+Changelog
+---------
+
+- **October.10.11**: 0.1.0 release
+
+Copyright
+---------
+
+Axlsx © 2011 by [Randy Morgan](mailto:digial.ipseity@gmail.com). Axlsx is 
+licensed under the MIT license. Please see the {file:LICENSE} document for more information.

data/lib/axlsx.rb~

@@ -0,0 +1,67 @@
+
+require 'axlsx/util/simple_typed_list.rb'
+require 'axlsx/util/constants.rb'
+require 'axlsx/util/validators.rb'
+
+require 'axlsx/stylesheet/border.rb'
+require 'axlsx/stylesheet/border_pr.rb'
+require 'axlsx/stylesheet/cell_alignment.rb'
+require 'axlsx/stylesheet/cell_style.rb'
+require 'axlsx/stylesheet/color.rb'
+require 'axlsx/stylesheet/fill.rb'
+require 'axlsx/stylesheet/font.rb'
+require 'axlsx/stylesheet/gradient_fill.rb'
+require 'axlsx/stylesheet/gradient_stop.rb'
+require 'axlsx/stylesheet/num_fmt.rb'
+require 'axlsx/stylesheet/pattern_fill.rb'
+require 'axlsx/stylesheet/styles.rb'
+require 'axlsx/stylesheet/table_style.rb'
+require 'axlsx/stylesheet/table_styles.rb'
+require 'axlsx/stylesheet/table_style_element.rb'
+require 'axlsx/stylesheet/xf.rb'
+require 'axlsx/stylesheet/cell_protection.rb'
+
+require 'axlsx/doc_props/app.rb'
+require 'axlsx/doc_props/core.rb'
+
+require 'axlsx/drawing/drawing.rb'
+require 'axlsx/drawing/graphic_frame.rb'
+require 'axlsx/drawing/marker.rb'
+require 'axlsx/drawing/pie_3D_chart.rb'
+require 'axlsx/drawing/series.rb'
+require 'axlsx/drawing/two_cell_anchor.rb'
+require 'axlsx/drawing/title.rb'
+
+require 'axlsx/content_type/content_type.rb'
+require 'axlsx/content_type/default.rb'
+require 'axlsx/content_type/override.rb'
+
+
+require 'axlsx/rels/relationship.rb'
+require 'axlsx/rels/relationships.rb'
+
+require 'axlsx/workbook/worksheet/row.rb'
+require 'axlsx/workbook/worksheet/cell.rb'
+require 'axlsx/workbook/workbook.rb'
+require 'axlsx/workbook/worksheet/worksheet.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'
+
+
+
+end

data/lib/axlsx/content_type/content_type.rb~

@@ -0,0 +1,20 @@
+module Axlsx
+  # 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 ArugumentError, "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 ArugumentError, "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,127 @@
+# -*- 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
+
+    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,25 @@
+module Axlsx
+
+  class Core
+    attr_accessor :creator
+    def initialize(options={})
+      @creator = options[:creator] || 'axlsx'
+      
+    end
+    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/bar_3D_chart.rb~

@@ -0,0 +1,64 @@
+
+  # The Pie3DChart is a three dimentional piechart (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::Pie3DChart, :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 Pie3DChart < Chart
+
+    # Serializes the pie chart
+    # @return [String]
+    def to_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+        xml.send('c:chartSpace',:'xmlns:c' => XML_NS_C,
+                 :'xmlns:a' => XML_NS_A) {
+          xml.send('c:chart') {
+            @title.to_xml(xml)            
+            xml.send('c:view3D') {
+              xml.send('c:rotX', :val=>30)
+              xml.send('c:perspective', :val=>30)
+            }
+            xml.send('c:plotArea') {
+              xml.send('c:layout')
+              xml.send('c:pie3DChart') {
+                xml.send('c:varyColors', :val=>1)
+                @series.each { |ser| ser.to_xml(xml) }
+              }              
+            }
+            xml.send('c:legend') {
+              xml.send('c:legendPos', :val => "r")
+              xml.send('c:layout')
+            }
+          }
+        }
+      end
+      builder.to_xml
+    end
+  end
+end