axlsx 1.0.12 → 1.0.13

data/README.md

@@ -7,10 +7,10 @@ Axlsx: Office Open XML Spreadsheet Generation
 **Author**:       Randy Morgan   
 **Copyright**:    2011      
 **License**:      MIT License      
-**Latest Version**: 1.0.12   
+**Latest Version**: 1.0.13   
 **Ruby Version**: 1.8.7, 1.9.2, 1.9.3 
 
-**Release Date**: December 7th 2011     
+**Release Date**: December 8th 2011     
 
 Synopsis
 --------
@@ -244,8 +244,12 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem,
  
 Changelog
 ---------
+- **December.8.11**: 1.0.13 release
+    Fixing .gemspec errors that caused gem to miss the lib directory. Sorry about that.
+
 - **December.7.11**: 1.0.12 release
-  - changed dependency from 'zip' jem to 'rubyzip' and added conditional code to force binary encoding to resolve issue with excel 2011
+    DO NOT USE THIS VERSION = THE GEM IS BROKEN
+  - changed dependency from 'zip' gem to 'rubyzip' and added conditional code to force binary encoding to resolve issue with excel 2011
   - Patched bug in app.xml that would ignore user specified properties.
 - **December.5.11**: 1.0.11 release
   - Added [] methods to worksheet and workbook to provide name based access to cells.

data/lib/axlsx.rb

@@ -0,0 +1,57 @@
+Encoding::default_internal = 'UTF-8' unless RUBY_VERSION < '1.9'
+Encoding::default_external = 'UTF-8' unless RUBY_VERSION < '1.9'
+
+require 'axlsx/version.rb'
+
+require 'axlsx/util/simple_typed_list.rb'
+require 'axlsx/util/constants.rb'
+require 'axlsx/util/validators.rb'
+
+
+# to be included with parsable intitites.
+#require 'axlsx/util/parser.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'
+
+#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'
+
+
+# xlsx generation with charts, images, automated column width, customizable styles and full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification. Check out the README for some examples of how easy it is. Best of all, you can validate your xlsx file before serialization so you know for sure that anything generated is going to load on your client's machine.
+module Axlsx
+  # determines the cell range for the items provided
+  def self.cell_range(items)
+    return "" unless items.first.is_a? Cell          
+    ref = "#{items.first.row.worksheet.name}!" +
+      "#{items.first.r_abs}"
+    ref += ":#{items.last.r_abs}" if items.size > 1
+    ref
+  end
+
+  def self.name_to_indices(name)
+    raise ArgumentError, 'invalid cell name' unless name.size > 1
+    v = name[/[A-Z]+/].reverse.chars.reduce({:base=>1, :i=>0}) do  |v, c|        
+      v[:i] += ((c.bytes.first - 65) + v[:base]); v[:base] *= 26; v 
+    end
+
+    [v[:i]-1, ((name[/[1-9]+/]).to_i)-1]
+
+  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,37 @@
+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_reader :Extension
+
+    # The type of content.
+    # @return [String] 
+    attr_reader :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
+    # Sets the file extension for this content type.
+    def Extension=(v) Axlsx::validate_string v; @Extension = v end
+
+    # Sets the content type
+    # @see Axlsx#validate_content_type
+    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,37 @@
+module Axlsx
+  # An override content part. These parts are automatically created by for you based on the content of your package.
+  class Override
+
+    # The type of content.
+    # @return [String] 
+    attr_reader :ContentType
+
+    # The name and location of the part.
+    # @return [String] 
+    attr_reader :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
+
+    # The name and location of the part.
+    def PartName=(v) Axlsx::validate_string v; @PartName = v end
+
+    # The content type. 
+    # @see Axlsx#validate_content_type
+    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,178 @@
+# -*- 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_reader :Template
+
+    # @return [String] The name of the manager for the document.
+    attr_reader :Manager
+
+    # @return [String] The name of the company generating the document.
+    attr_reader :Company 
+
+    # @return [Integer] The number of pages in the document.
+    attr_reader :Pages
+
+    # @return [Integer] The number of words in the document.
+    attr_reader :Words
+
+    # @return [Integer] The number of characters in the document.
+    attr_reader :Characters
+
+    # @return [String] The intended format of the presentation.
+    attr_reader :PresentationFormat
+
+    # @return [Integer] The number of lines in the document.
+    attr_reader :Lines
+
+    # @return [Integer] The number of paragraphs in the document
+    attr_reader :Paragraphs
+
+    # @return [Intger] The number of slides in the document.
+    attr_reader :Slides
+
+    # @return [Integer] The number of slides that have notes.
+    attr_reader :Notes
+
+    # @return [Integer] The total amount of time spent editing.   
+    attr_reader :TotalTime
+
+    # @return [Integer] The number of hidden slides.
+    attr_reader :HiddenSlides
+
+    # @return [Integer] The total number multimedia clips
+    attr_reader :MMClips
+
+    # @return [Boolean] The display mode for the document thumbnail.
+    attr_reader :ScaleCrop
+
+    # @return [Boolean] The links in the document are up to date.
+    attr_reader :LinksUpToDate
+
+    # @return [Integer] The number of characters in the document including spaces.
+    attr_reader :CharactersWithSpaces
+    
+    # @return [Boolean] Indicates if the document is shared.
+    attr_reader :ShareDoc
+
+    # @return [String] The base for hyper links in the document. 
+    attr_reader :HyperLinkBase
+
+    # @return [Boolean] Indicates that the hyper links in the document have been changed.
+    attr_reader :HyperlinksChanged
+
+    # @return [String] The name of the application
+    attr_reader :Application
+
+    # @return [String] The version of the application.
+    attr_reader :AppVersion
+
+    # @return [Integer] Document security
+    attr_reader :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 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 
+
+    # 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 
+
+    # 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(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,90 @@
+module Axlsx
+ # the access class defines common properties and values for a 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
+    # @see Scaling
+    # @return [Scaling]
+    attr_reader :scaling
+    
+    # The position of the axis
+    # must be one of [:l, :r, :t, :b]
+    # @return [Symbol]
+    attr_reader :axPos
+
+    # the position of the tick labels
+    # must be one of [:nextTo, :high, :low]
+    # @return [Symbol]
+    attr_reader :tickLblPos
+
+    # The number format format code for this axis
+    # default :General
+    # @return [String]
+    attr_reader :format_code
+
+    # specifies how the perpendicular axis is crossed
+    # must be one of [:autoZero, :min, :max]
+    # @return [Symbol]
+    attr_reader :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
+    # @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"
+      @scaling = Scaling.new(:orientation=>:minMax)
+      self.axPos = :l
+      self.tickLblPos = :nextTo
+      self.format_code = "General"
+      self.crosses = :autoZero
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    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
+
+    # 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
+
+    # The number format format code for this axis
+    # default :General
+    def format_code=(v) Axlsx::validate_string(v); @formatCode = v; end
+
+    # specifies how the perpendicular axis is crossed
+    # must be one of [:autoZero, :min, :max]
+    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