axlsx 1.0.8 → 1.0.9

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; AXLSX
   
 </title>
 
@@ -94,9 +94,9 @@
 </div>
     
     <div id="footer">
-  Generated on Wed Nov 23 21:48:07 2011 by 
+  Generated on Sat Nov 26 13:16:40 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.8.7).
+  0.7.3 (ruby-1.9.3).
 </div>
 
   </body>

data/examples/example.rb

@@ -1,7 +1,11 @@
+# -*- coding: utf-8 -*-
+# encoding: utf-8
      require 'rubygems'
      require 'axlsx'
 
+
 #A Simple Workbook
+
       p = Axlsx::Package.new
       p.workbook.add_worksheet do |sheet|
         sheet.add_row ["First", "Second", "Third"]
@@ -10,6 +14,7 @@
       p.serialize("example1.xlsx")
 
 #Generating A Bar Chart
+
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
        sheet.add_row ["First", "Second", "Third"]
@@ -21,6 +26,7 @@
      p.serialize("example2.xlsx")
 
 #Generating A Pie Chart
+
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
        sheet.add_row ["First", "Second", "Third"]
@@ -90,10 +96,23 @@
 
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
-       sheet.add_image(:image_src => (File.dirname(__FILE__) + "/image1.png")) do |image|
+       img = File.expand_path('examples/image1.jpeg') 
+       sheet.add_image(:image_src => img) do |image|
          image.width=720
          image.height=666
          image.start_at 2, 2
        end
      end  
      p.serialize("example7.xlsx")
+
+
+#Asian Language Support
+
+     p = Axlsx::Package.new
+     p.workbook.add_worksheet do |sheet|
+       sheet.add_row ["日本語"]
+       sheet.add_row ["华语/華語"]
+       sheet.add_row ["한국어/조선말"]
+     end  
+     p.serialize("example8.xlsx")
+

data/lib/axlsx.rb

@@ -1,3 +1,7 @@
+
+Encoding::default_internal = 'UTF-8' unless RUBY_VERSION < '1.9'
+Encoding::default_external = 'UTF-8' unless RUBY_VERSION < '1.9'
+
 require 'axlsx/util/simple_typed_list.rb'
 require 'axlsx/util/constants.rb'
 require 'axlsx/util/validators.rb'
@@ -13,26 +17,27 @@ 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'
+#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'
+#core dependencies
+require 'bigdecimal'
+require 'time'
+require 'CGI'
 
+# 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          
-    "#{items.first.row.worksheet.name}!" +
-      "#{items.first.r_abs}:#{items.last.r_abs}"
+    ref = "#{items.first.row.worksheet.name}!" +
+      "#{items.first.r_abs}"
+    ref += ":#{items.last.r_abs}" if items.size > 1
+    ref
   end
-  
-  
 end

data/lib/axlsx/content_type/default.rb

@@ -4,10 +4,11 @@ module Axlsx
 
     # The extension of the content type.
     # @return [String]
-    attr_accessor :Extension
+    attr_reader :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
+    # The type of content.
+    # @return [String] 
+    attr_reader :ContentType
 
     #Creates a new Default object
     # @option options [String] Extension
@@ -19,7 +20,11 @@ module Axlsx
         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

data/lib/axlsx/content_type/override.rb

@@ -2,11 +2,13 @@ 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
+    # The type of content.
+    # @return [String] 
+    attr_reader :ContentType
 
-    # @return [String] PartName The name and location of the part.
-    attr_accessor :PartName
+    # The name and location of the part.
+    # @return [String] 
+    attr_reader :PartName
 
     #Creates a new Override object
     # @option options [String] PartName
@@ -18,7 +20,12 @@ module Axlsx
         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

data/lib/axlsx/doc_props/app.rb

@@ -11,73 +11,73 @@ module Axlsx
   class App
 
     # @return [String] The name of the document template.
-    attr_accessor :Template
+    attr_reader :Template
 
     # @return [String] The name of the manager for the document.
-    attr_accessor :Manager
+    attr_reader :Manager
 
     # @return [String] The name of the company generating the document.
-    attr_accessor :Company 
+    attr_reader :Company 
 
     # @return [Integer] The number of pages in the document.
-    attr_accessor :Pages
+    attr_reader :Pages
 
     # @return [Integer] The number of words in the document.
-    attr_accessor :Words
+    attr_reader :Words
 
     # @return [Integer] The number of characters in the document.
-    attr_accessor :Characters
+    attr_reader :Characters
 
     # @return [String] The intended format of the presentation.
-    attr_accessor :PresentationFormat
+    attr_reader :PresentationFormat
 
     # @return [Integer] The number of lines in the document.
-    attr_accessor :Lines
+    attr_reader :Lines
 
     # @return [Integer] The number of paragraphs in the document
-    attr_accessor :Paragraphs
+    attr_reader :Paragraphs
 
     # @return [Intger] The number of slides in the document.
-    attr_accessor :Slides
+    attr_reader :Slides
 
     # @return [Integer] The number of slides that have notes.
-    attr_accessor :Notes
+    attr_reader :Notes
 
     # @return [Integer] The total amount of time spent editing.   
-    attr_accessor :TotalTime
+    attr_reader :TotalTime
 
     # @return [Integer] The number of hidden slides.
-    attr_accessor :HiddenSlides
+    attr_reader :HiddenSlides
 
     # @return [Integer] The total number multimedia clips
-    attr_accessor :MMClips
+    attr_reader :MMClips
 
     # @return [Boolean] The display mode for the document thumbnail.
-    attr_accessor :ScaleCrop
+    attr_reader :ScaleCrop
 
     # @return [Boolean] The links in the document are up to date.
-    attr_accessor :LinksUpToDate
+    attr_reader :LinksUpToDate
 
     # @return [Integer] The number of characters in the document including spaces.
-    attr_accessor :CharactersWithSpaces
+    attr_reader :CharactersWithSpaces
     
     # @return [Boolean] Indicates if the document is shared.
-    attr_accessor :ShareDoc
+    attr_reader :ShareDoc
 
     # @return [String] The base for hyper links in the document. 
-    attr_accessor :HyperLinkBase
+    attr_reader :HyperLinkBase
 
     # @return [Boolean] Indicates that the hyper links in the document have been changed.
-    attr_accessor :HyperlinksChanged
+    attr_reader :HyperlinksChanged
 
     # @return [String] The name of the application
-    attr_accessor :Application
+    attr_reader :Application
 
     # @return [String] The version of the application.
-    attr_accessor :AppVersion
+    attr_reader :AppVersion
 
     # @return [Integer] Document security
-    attr_accessor :DocSecurity
+    attr_reader :DocSecurity
 
     # Creates an App object
     # @option options [String] Template
@@ -108,28 +108,58 @@ module Axlsx
       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

data/lib/axlsx/drawing/axis.rb

@@ -18,22 +18,22 @@ module Axlsx
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
     # @return [Symbol]
-    attr_accessor :axPos
+    attr_reader :axPos
 
     # the position of the tick labels
     # must be one of [:nextTo, :high, :low]
     # @return [Symbol]
-    attr_accessor :tickLblPos
+    attr_reader :tickLblPos
 
     # The number format format code for this axis
     # default :General
     # @return [String]
-    attr_accessor :format_code
+    attr_reader :format_code
 
     # specifies how the perpendicular axis is crossed
     # must be one of [:autoZero, :min, :max]
     # @return [Symbol]
-    attr_accessor :crosses 
+    attr_reader :crosses 
 
     # Creates an Axis object
     # @param [Integer] axId the id of this axis
@@ -47,6 +47,7 @@ module Axlsx
       Axlsx::validate_unsigned_int(crossAx)
       @axId = axId
       @crossAx = crossAx
+      @format_code = "General"
       @scaling = Scaling.new(:orientation=>:minMax)
       self.axPos = :l
       self.tickLblPos = :nextTo
@@ -56,10 +57,20 @@ module Axlsx
         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

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -18,25 +18,25 @@ module Axlsx
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
     # @return [Symbol]
-    attr_accessor :barDir
+    attr_reader :barDir
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_accessor :gapDepth
+    attr_reader :gapDepth
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_accessor :gapWidth
+    attr_reader :gapWidth
 
     #grouping for a column, line, or area chart.
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     # @return [Symbol]
-    attr_accessor :grouping
+    attr_reader :grouping
 
     # The shabe of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     # @return [Symbol]
-    attr_accessor :shape
+    attr_reader :shape
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
@@ -61,6 +61,7 @@ module Axlsx
     def initialize(frame, options={})
       @barDir = :bar
       @grouping = :clustered
+      @gapWidth, @gapDepth, @shape = nil, nil, nil
       @catAxId = rand(8 ** 8)
       @valAxId = rand(8 ** 8)
       @catAxis = CatAxis.new(@catAxId, @valAxId)
@@ -69,28 +70,35 @@ module Axlsx
       @series_type = BarSeries
       @view3D = View3D.new({:rAngAx=>1}.merge(options))
     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
     end
 
-
+    #grouping for a column, line, or area chart.
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     def grouping=(v)
       RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
       @grouping = v
     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)
     end
 
+    # 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)
     end
 
+    # The shabe of the bars or columns
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     def shape=(v) 
       RestrictionValidator.validate "Bar3DChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v